start with offer-edit

2024-08-16 15:58:54 -06:00
parent 7df6668dc6
commit 73c82aefe2
3 changed files with 748 additions and 45 deletions
--- a/src/libs/endorserServer.ts
+++ b/src/libs/endorserServer.ts
@@ -48,7 +48,7 @@ export interface ClaimResult {
 }

 export interface GenericVerifiableCredential {
-  "@context"?: string;
+  "@context"?: string; // optional when embedded, eg. in an Agree
  "@type": string;
  [key: string]: any; // eslint-disable-line @typescript-eslint/no-explicit-any
 }
@@ -139,13 +139,13 @@ export interface GiveVerifiableCredential extends GenericVerifiableCredential {

 // Note that previous VCs may have additional fields.
 // https://endorser.ch/doc/html/transactions.html#id8
-export interface OfferVerifiableCredential {
-  "@context"?: string; // optional when embedded, eg. in an Agree
+export interface OfferVerifiableCredential extends GenericVerifiableCredential {
+  "@context"?: string; // optional when embedded... though it doesn't make sense to agree to an offer
  "@type": "Offer";
-  description?: string;
+  description?: string; // conditions for the offer
  includesObject?: { amountOfThisGood: number; unitCode: string };
  itemOffered?: {
-    description?: string;
+    description?: string; // description of the item
    isPartOf?: { identifier?: string; lastClaimId?: string; "@type"?: string };
  };
  offeredBy?: { identifier: string };
@@ -155,7 +155,7 @@ export interface OfferVerifiableCredential {

 // Note that previous VCs may have additional fields.
 // https://endorser.ch/doc/html/transactions.html#id7
-export interface PlanVerifiableCredential {
+export interface PlanVerifiableCredential extends GenericVerifiableCredential {
  "@context": "https://schema.org";
  "@type": "PlanAction";
  name: string;
@@ -563,6 +563,8 @@ export async function setPlanInCache(

 /**
 * Construct GiveAction VC for submission to server
+ *
+ * @param lastClaimId supplied when editing a previous claim
 */
 export function hydrateGive(
  vcClaimOrig?: GiveVerifiableCredential,
@@ -587,6 +589,7 @@ export function hydrateGive(
      };

  if (lastClaimId) {
+    // this is an edit
    vcClaim.lastClaimId = lastClaimId;
    delete vcClaim.identifier;
  }
@@ -594,16 +597,17 @@ export function hydrateGive(
  vcClaim.agent = fromDid ? { identifier: fromDid } : undefined;
  vcClaim.recipient = toDid ? { identifier: toDid } : undefined;
  vcClaim.description = description || undefined;
-  vcClaim.object = amount
-    ? { amountOfThisGood: amount, unitCode: unitCode || "HUR" }
-    : undefined;
+  vcClaim.object =
+    amount && !isNaN(amount)
+      ? { amountOfThisGood: amount, unitCode: unitCode || "HUR" }
+      : undefined;

  // ensure fulfills is an array
  if (!Array.isArray(vcClaim.fulfills)) {
    vcClaim.fulfills = vcClaim.fulfills ? [vcClaim.fulfills] : [];
  }
  // ... and replace or add each element, ending with Trade or Donate
-  // I realize this doesn't change any elements that are not PlanAction or Offer or Trade/Action.
+  // I realize the following doesn't change any elements that are not PlanAction or Offer or Trade/Action.
  vcClaim.fulfills = vcClaim.fulfills.filter(
    (elem) => elem["@type"] !== "PlanAction",
  );
@@ -639,8 +643,8 @@ export function hydrateGive(
 *
 * @param fromDid may be null
 * @param toDid
- * @param description may be null; should have this or amount
- * @param amount may be null; should have this or description
+ * @param description may be null
+ * @param amount may be null
 */
 export async function createAndSubmitGive(
  axios: Axios,
@@ -667,6 +671,7 @@ export async function createAndSubmitGive(
    fulfillsOfferHandleId,
    isTrade,
    imageUrl,
+    undefined,
  );
  return createAndSubmitClaim(
    vcClaim as GenericVerifiableCredential,
@@ -680,9 +685,9 @@ export async function createAndSubmitGive(
 * For result, see https://api.endorser.ch/api-docs/#/claims/post_api_v2_claim
 *
 * @param fromDid may be null
- * @param toDid
- * @param description may be null; should have this or amount
- * @param amount may be null; should have this or description
+ * @param toDid may be null if project is provided
+ * @param description may be null
+ * @param amount may be null
 */
 export async function editAndSubmitGive(
  axios: Axios,
@@ -720,13 +725,69 @@ export async function editAndSubmitGive(
  );
 }

+/**
+ * Construct Offer VC for submission to server
+ *
+ * @param lastClaimId supplied when editing a previous claim
+ */
+export function hydrateOffer(
+  vcClaimOrig?: OfferVerifiableCredential,
+  fromDid?: string,
+  toDid?: string,
+  conditionDescription?: string,
+  amount?: number,
+  unitCode?: string,
+  offeringDescription?: string,
+  fulfillsProjectHandleId?: string,
+  validThrough?: string,
+  lastClaimId?: string,
+): OfferVerifiableCredential {
+  // Remember: replace values or erase if it's null
+
+  const vcClaim: OfferVerifiableCredential = vcClaimOrig
+    ? R.clone(vcClaimOrig)
+    : {
+        "@context": SCHEMA_ORG_CONTEXT,
+        "@type": "Offer",
+      };
+
+  if (lastClaimId) {
+    // this is an edit
+    vcClaim.lastClaimId = lastClaimId;
+    delete vcClaim.identifier;
+  }
+
+  vcClaim.offeredBy = fromDid ? { identifier: fromDid } : undefined;
+  vcClaim.recipient = toDid ? { identifier: toDid } : undefined;
+  vcClaim.description = conditionDescription || undefined;
+
+  vcClaim.includesObject =
+    amount && !isNaN(amount)
+      ? { amountOfThisGood: amount, unitCode: unitCode || "HUR" }
+      : undefined;
+
+  if (offeringDescription || fulfillsProjectHandleId) {
+    vcClaim.itemOffered = vcClaim.itemOffered || {};
+    vcClaim.itemOffered.description = offeringDescription || undefined;
+    if (fulfillsProjectHandleId) {
+      vcClaim.itemOffered.isPartOf = {
+        "@type": "PlanAction",
+        identifier: fulfillsProjectHandleId,
+      };
+    }
+  }
+  vcClaim.validThrough = validThrough || undefined;
+
+  return vcClaim;
+}
+
 /**
 * For result, see https://api.endorser.ch/api-docs/#/claims/post_api_v2_claim
 *
 * @param identity
- * @param description may be null; should have this or amount
- * @param amount may be null; should have this or description
- * @param expirationDate ISO 8601 date string YYYY-MM-DD (may be null)
+ * @param description may be null
+ * @param amount may be null
+ * @param validThrough ISO 8601 date string YYYY-MM-DD (may be null)
 * @param fulfillsProjectHandleId ID of project to which this contributes (may be null)
 */
 export async function createAndSubmitOffer(
@@ -736,35 +797,54 @@ export async function createAndSubmitOffer(
  description?: string,
  amount?: number,
  unitCode?: string,
-  expirationDate?: string,
+  validThrough?: string,
  recipientDid?: string,
  fulfillsProjectHandleId?: string,
 ): Promise<CreateAndSubmitClaimResult> {
-  const vcClaim: OfferVerifiableCredential = {
-    "@context": SCHEMA_ORG_CONTEXT,
-    "@type": "Offer",
-    offeredBy: { identifier: issuerDid },
-    validThrough: expirationDate || undefined,
-  };
-  if (amount) {
-    vcClaim.includesObject = {
-      amountOfThisGood: amount,
-      unitCode: unitCode || "HUR",
-    };
-  }
-  if (description) {
-    vcClaim.itemOffered = { description };
-  }
-  if (recipientDid) {
-    vcClaim.recipient = { identifier: recipientDid };
-  }
-  if (fulfillsProjectHandleId) {
-    vcClaim.itemOffered = vcClaim.itemOffered || {};
-    vcClaim.itemOffered.isPartOf = {
-      "@type": "PlanAction",
-      identifier: fulfillsProjectHandleId,
-    };
-  }
+  const vcClaim = hydrateOffer(
+    undefined,
+    issuerDid,
+    recipientDid,
+    description,
+    amount,
+    unitCode,
+    description,
+    fulfillsProjectHandleId,
+    validThrough,
+    undefined,
+  );
+  return createAndSubmitClaim(
+    vcClaim as OfferVerifiableCredential,
+    issuerDid,
+    apiServer,
+    axios,
+  );
+}
+
+export async function editAndSubmitOffer(
+  axios: Axios,
+  apiServer: string,
+  fullClaim: GenericCredWrapper<OfferVerifiableCredential>,
+  issuerDid: string,
+  description?: string,
+  amount?: number,
+  unitCode?: string,
+  validThrough?: string,
+  recipientDid?: string,
+  fulfillsProjectHandleId?: string,
+): Promise<CreateAndSubmitClaimResult> {
+  const vcClaim = hydrateOffer(
+    fullClaim.claim,
+    issuerDid,
+    recipientDid,
+    description,
+    amount,
+    unitCode,
+    description,
+    fulfillsProjectHandleId,
+    validThrough,
+    fullClaim.id,
+  );
  return createAndSubmitClaim(
    vcClaim as OfferVerifiableCredential,
    issuerDid,