Merge branch 'master' into other-units

src/libs/endorserServer.ts

@@ -12,6 +12,8 @@ export const SERVICE_ID = "endorser.ch";
 export const CONTACT_URL_PREFIX = "https://endorser.ch";
 // the suffix for the contact URL
 export const ENDORSER_JWT_URL_LOCATION = "/contact?jwt=";
+// the prefix for handle IDs, the permanent ID for claims on Endorser
+export const ENDORSER_CH_HANDLE_PREFIX = "https://endorser.ch/entity/";
 
 export interface AgreeVerifiableCredential {
   "@context": string;
@@ -38,14 +40,24 @@ export interface ClaimResult {
   error: { code: string; message: string };
 }
 
-export interface GenericClaim {
+export interface GenericVerifiableCredential {
   "@context": string;
   "@type": string;
-  issuedAt: string;
-  // "any" because arbitrary objects can be subject of agreement
+}
+
+export interface GenericServerRecord extends GenericVerifiableCredential {
+  handleId?: string;
+  id?: string;
+  issuedAt?: string;
+  issuer?: string;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   claim: Record<any, any>;
 }
+export const BLANK_GENERIC_SERVER_RECORD: GenericServerRecord = {
+  "@context": SCHEMA_ORG_CONTEXT,
+  "@type": "",
+  claim: {},
+};
 
 export interface GiveServerRecord {
   agentDid: string;
@@ -143,6 +155,104 @@ export function isHiddenDid(did: string) {
   return did === HIDDEN_DID;
 }
 
+/**
+ * @return true for any nested string where func(input) === true
+ *
+ * Similar logic is found in endorser-mobile.
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function testRecursivelyOnString(func: (arg0: any) => boolean, input: any) {
+  if (Object.prototype.toString.call(input) === "[object String]") {
+    return func(input);
+  } else if (input instanceof Object) {
+    if (!Array.isArray(input)) {
+      // it's an object
+      for (const key in input) {
+        if (testRecursivelyOnString(func, input[key])) {
+          return true;
+        }
+      }
+    } else {
+      // it's an array
+      for (const value of input) {
+        if (testRecursivelyOnString(func, value)) {
+          return true;
+        }
+      }
+    }
+    return false;
+  } else {
+    return false;
+  }
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function containsHiddenDid(obj: any) {
+  return testRecursivelyOnString(isHiddenDid, obj);
+}
+
+export function stripEndorserPrefix(claimId: string) {
+  if (claimId && claimId.startsWith(ENDORSER_CH_HANDLE_PREFIX)) {
+    return claimId.substring(ENDORSER_CH_HANDLE_PREFIX.length);
+  } else {
+    return claimId;
+  }
+}
+
+// similar logic is found in endorser-mobile
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function removeSchemaContext(obj: any) {
+  return obj["@context"] === SCHEMA_ORG_CONTEXT
+    ? R.omit(["@context"], obj)
+    : obj;
+}
+
+// similar logic is found in endorser-mobile
+export function addLastClaimOrHandleAsIdIfMissing(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  obj: any,
+  lastClaimId?: string,
+  handleId?: string,
+) {
+  if (!obj.identifier && lastClaimId) {
+    const result = R.clone(obj);
+    result.lastClaimId = lastClaimId;
+    return result;
+  } else if (!obj.identifier && handleId) {
+    const result = R.clone(obj);
+    result.identifier = handleId;
+    return result;
+  } else {
+    return obj;
+  }
+}
+
+// return clone of object without any nested *VisibleToDids keys
+// similar logic is found in endorser-mobile
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function removeVisibleToDids(input: any): any {
+  if (input instanceof Object) {
+    if (!Array.isArray(input)) {
+      // it's an object
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      const result: Record<string, any> = {};
+      for (const key in input) {
+        if (!key.endsWith("VisibleToDids")) {
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+          result[key] = removeVisibleToDids(R.clone(input[key]));
+        }
+      }
+      return result;
+    } else {
+      // it's an array
+      return R.map(removeVisibleToDids, input);
+    }
+    return false;
+  } else {
+    return input;
+  }
+}
+
 /**
  always returns text, maybe UNNAMED_VISIBLE or UNKNOWN_ENTITY
 
@@ -163,8 +273,8 @@ export function didInfo(
   return contact
     ? contact.name || "Contact With No Name"
     : isHiddenDid(did)
-    ? "Someone Not In Network"
-    : "Someone Not In Contacts";
+      ? "Someone Not In Network"
+      : "Someone Not In Contacts";
 }
 
 export interface ResultWithType {
@@ -217,7 +327,7 @@ export async function createAndSubmitGive(
       : undefined,
   };
   return createAndSubmitClaim(
-    vcClaim as GenericClaim,
+    vcClaim as GenericServerRecord,
     identity,
     apiServer,
     axios,
@@ -265,7 +375,7 @@ export async function createAndSubmitOffer(
     };
   }
   return createAndSubmitClaim(
-    vcClaim as GenericClaim,
+    vcClaim as GenericServerRecord,
     identity,
     apiServer,
     axios,
@@ -273,7 +383,7 @@ export async function createAndSubmitOffer(
 }
 
 export async function createAndSubmitClaim(
-  vcClaim: GenericClaim,
+  vcClaim: GenericVerifiableCredential,
   identity: IIdentifier,
   apiServer: string,
   axios: Axios,