@idos-network/credentials 1.5.0 → 2.2.0

package/dist/types/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../../src/types/credentials.ts"],"sourcesContent":["import * as z from \"zod\";\n\nexport type idOSCredential = {\n  id: string;\n  user_id: string;\n  public_notes: string;\n  content: string;\n  encryptor_public_key: string;\n  issuer_auth_public_key: string;\n  original_id?: string | null;\n};\n\nexport type InsertableIDOSCredential = Omit<idOSCredential, \"id\" | \"original_id\"> & {\n  id?: idOSCredential[\"id\"];\n  content_hash?: string;\n  public_notes_signature: string;\n  broader_signature: string;\n};\n\n// https://github.com/colinhacks/zod/issues/3751\nexport const CredentialFieldsSchema: z.ZodObject<{\n  id: z.ZodString;\n  level: z.ZodString;\n  issued: z.ZodOptional<z.ZodDate>;\n  approvedAt: z.ZodOptional<z.ZodDate>;\n  expirationDate: z.ZodOptional<z.ZodDate>;\n}> = z.object({\n  id: z.string(),\n\n  /* Level of KYC verification performed (e.g., basic, intermediate, advanced). */\n  level: z.string(),\n\n  /* @default Date.now() */\n  issued: z.date().optional(),\n\n  /* Date the credential was approved. */\n  approvedAt: z.date().optional(),\n\n  /* Date the credential was revoked. */\n  expirationDate: z.date().optional(),\n});\n\nexport type CredentialFields = z.infer<typeof CredentialFieldsSchema>;\n\n// https://github.com/colinhacks/zod/issues/3751\nexport const CredentialResidentialAddressSchema: z.ZodObject<{\n  street: z.ZodString;\n  houseNumber: z.ZodOptional<z.ZodString>;\n  additionalAddressInfo: z.ZodOptional<z.ZodString>;\n  region: z.ZodOptional<z.ZodString>;\n  city: z.ZodString;\n  postalCode: z.ZodOptional<z.ZodString>;\n  country: z.ZodString;\n  proofCategory: z.ZodString;\n  proofDateOfIssue: z.ZodOptional<z.ZodDate>;\n  proofFile: z.ZodType<Buffer<ArrayBufferLike>>;\n}> = z.object({\n  /* Street address. */\n  street: z.string(),\n\n  /* House number. */\n  houseNumber: z.string().optional(),\n\n  /* Additional address information (e.g., apartment number). */\n  additionalAddressInfo: z.string().optional(),\n\n  /* Region (e.g., state, province). */\n  region: z.string().optional(),\n\n  /* Locality (e.g., city, town). */\n  city: z.string(),\n\n  /* Postal code. */\n  postalCode: z.string().optional(),\n\n  /* Country (ISO 3166-1 alpha-2). */\n  country: z.string().min(2).max(2),\n\n  /* Residential Address Proof Category\tType of document provided to verify the address(e.g., utility bill, bank statement). */\n  proofCategory: z.string(),\n\n  /* Residential Address Proof Date Of Issue\tDate the address proof document was issued. */\n  proofDateOfIssue: z.date().optional(),\n\n  /* Residential Address Proof File or URL of the document provided as address proof. */\n  proofFile: z.instanceof(Buffer),\n});\n\nexport type CredentialResidentialAddress = z.infer<typeof CredentialResidentialAddressSchema>;\n\nexport const IDDocumentTypeSchema: z.ZodEnum<{\n  PASSPORT: \"PASSPORT\";\n  DRIVERS: \"DRIVERS\";\n  ID_CARD: \"ID_CARD\";\n  VOTING_CARD: \"VOTING_CARD\";\n  PAN_CARD: \"PAN_CARD\";\n  INTERNAL_PASSPORT: \"INTERNAL_PASSPORT\";\n  RESIDENCE_PERMIT: \"RESIDENCE_PERMIT\";\n}> = z.enum([\n  \"PASSPORT\",\n  \"DRIVERS\",\n  \"ID_CARD\",\n  \"VOTING_CARD\",\n  \"PAN_CARD\",\n  \"INTERNAL_PASSPORT\",\n  \"RESIDENCE_PERMIT\",\n]);\nexport type IDDocumentType = z.infer<typeof IDDocumentTypeSchema>;\n\nexport const GenderSchema: z.ZodEnum<{\n  M: \"M\";\n  F: \"F\";\n  OTHER: \"OTHER\";\n}> = z.enum([\"M\", \"F\", \"OTHER\"]);\nexport type Gender = z.infer<typeof GenderSchema>;\n\n// https://github.com/colinhacks/zod/issues/3751\nexport const CredentialSubjectSchema: z.ZodObject<{\n  id: z.ZodString;\n  // Indonesian and Indian did not always have first name\n  firstName: z.ZodOptional<z.ZodString>;\n  middleName: z.ZodOptional<z.ZodString>;\n  ssn: z.ZodOptional<z.ZodString>;\n  gender: z.ZodOptional<typeof GenderSchema>;\n  nationality: z.ZodOptional<z.ZodString>;\n  // Indonesian and Indian did not always have family name\n  familyName: z.ZodOptional<z.ZodString>;\n  maidenName: z.ZodOptional<z.ZodString>;\n  email: z.ZodOptional<z.ZodEmail>;\n  phoneNumber: z.ZodOptional<z.ZodString>;\n  dateOfBirth: z.ZodDate;\n  placeOfBirth: z.ZodOptional<z.ZodString>;\n  idDocumentCountry: z.ZodString;\n  idDocumentNumber: z.ZodString;\n  idDocumentType: typeof IDDocumentTypeSchema;\n  idDocumentDateOfIssue: z.ZodOptional<z.ZodDate>;\n  idDocumentDateOfExpiry: z.ZodOptional<z.ZodDate>;\n  idDocumentFrontFile: z.ZodType<Buffer<ArrayBufferLike>>;\n  idDocumentBackFile: z.ZodOptional<z.ZodType<Buffer<ArrayBufferLike>>>;\n  selfieFile: z.ZodType<Buffer<ArrayBufferLike>>;\n  residentialAddress: z.ZodOptional<typeof CredentialResidentialAddressSchema>;\n}> = z\n  .object({\n    /* ID(unique credential)\tUnique identifier for the credential itself. */\n    id: z.string(),\n\n    /* First name. */\n    firstName: z.string().optional(),\n\n    /* Middle name. */\n    middleName: z.string().optional(),\n\n    /* Social-security-number (without dashes) */\n    ssn: z.string().min(9).max(9).optional(),\n\n    /* Nationality (ISO 3166-1 alpha-2). */\n    nationality: z.string().min(2).max(2).optional(),\n\n    /* Gender (M or F, empty if not provided). */\n    gender: GenderSchema.optional(),\n\n    /* Family name. */\n    familyName: z.string().optional(),\n\n    /* Maiden name. */\n    maidenName: z.string().optional(),\n\n    /* Date of birth. */\n    dateOfBirth: z.date(),\n\n    /* Place of birth. */\n    placeOfBirth: z.string().optional(),\n\n    /* Email. */\n    email: z.email().optional(),\n\n    /* Phone number. */\n    phoneNumber: z.string().optional(),\n\n    /* Country that issued the identity document (ISO 3166-1 alpha-2). */\n    idDocumentCountry: z.string().min(2).max(2),\n\n    /* ID Document Number\tUnique number on the identity document. */\n    idDocumentNumber: z.string(),\n\n    /* ID Document Type\tType of identity document(e.g., Passport, Driver's License, National ID). */\n    idDocumentType: IDDocumentTypeSchema,\n\n    /* ID Document Date of Issue\tDate the identity document was issued. */\n    idDocumentDateOfIssue: z.date().optional(),\n\n    /* ID Document Date of Expiry\tExpiration date of the identity document - if applicable. */\n    idDocumentDateOfExpiry: z.date().optional(),\n\n    /* ID Document Front File\tBuffer with file representing the front of the identity document. */\n    idDocumentFrontFile: z.instanceof(Buffer),\n\n    /* ID Document Back File\tBuffer with file representing the back of the identity document - if applicable. */\n    idDocumentBackFile: z.instanceof(Buffer).optional(),\n\n    /* (ID Document) Selfie File\tBuffer with selfie with the identity document for verification purposes. */\n    selfieFile: z.instanceof(Buffer),\n\n    /* Residential Address Full residential address of the individual - if applicable. */\n    residentialAddress: CredentialResidentialAddressSchema.optional(),\n  })\n  .refine(\n    // At least one of firstName or familyName must be present,\n    (data) => data.firstName || data.familyName,\n    { message: \"At least one of firstName or familyName must be provided\" },\n  );\n\nexport type CredentialSubject = z.infer<typeof CredentialSubjectSchema>;\n\nexport interface VerifiableCredentialSubject extends Omit<\n  CredentialSubject,\n  | \"residentialAddress\"\n  | \"idDocumentBackFile\"\n  | \"idDocumentFrontFile\"\n  | \"selfieFile\"\n  | \"idDocumentDateOfIssue\"\n  | \"idDocumentDateOfExpiry\"\n  | \"dateOfBirth\"\n> {\n  \"@context\": string;\n  // Files are strings in verifiable credentials, but as an input they should be buffers\n  idDocumentFrontFile?: string;\n  idDocumentBackFile?: string;\n  selfieFile?: string;\n  // Dates are strings in verifiable credentials\n  dateOfBirth?: string;\n  idDocumentDateOfIssue?: string;\n  idDocumentDateOfExpiry?: string;\n  // This is the residential address flattened fields\n  residentialAddressStreet?: string;\n  residentialAddressHouseNumber?: string;\n  residentialAddressAdditionalAddressInfo?: string;\n  residentialAddressRegion?: string;\n  residentialAddressCity?: string;\n  residentialAddressPostalCode?: string;\n  residentialAddressCountry?: string;\n  residentialAddressProofCategory?: string;\n  // Dates are strings in verifiable credentials\n  residentialAddressProofDateOfIssue?: string;\n  // Files are strings in verifiable credentials, but as an input they should be buffers\n  residentialAddressProofFile?: string;\n}\n\n// TODO: This is a stub of the types for @digitalbazaar/vc\n// when they introduce TypeScript support we should remove this\n// The copy is here because `types.d.ts` file is not bundled.\nexport interface VerifiedCredentialsProof {\n  type: string;\n  created: string;\n  verificationMethod: string;\n  proofValue: string;\n  proofPurpose: string;\n}\n\nexport const CredentialSubjectFaceIdSchema: z.ZodObject<{\n  faceSignUserId: z.ZodString;\n}> = z.object({\n  faceSignUserId: z.string(),\n});\n\nexport type CredentialSubjectFaceId = z.infer<typeof CredentialSubjectFaceIdSchema>;\n\nexport interface VerifiedCredentials<K> {\n  \"@context\": string[];\n  type: string[];\n  issuer: string;\n  id: string;\n  level: string;\n  issued: string;\n  approvedAt: string;\n  expirationDate: string;\n  credentialSubject: K;\n  issuanceDate: string;\n  proof: VerifiedCredentialsProof;\n}\n\nexport type VerifiableCredential<K> = VerifiedCredentials<K>;\n"],"mappings":";;AAoBA,MAAa,yBAMR,EAAE,OAAO;CACZ,IAAI,EAAE,OAAO;CAGb,OAAO,EAAE,OAAO;CAGhB,QAAQ,EAAE,KAAK,CAAC,CAAC,SAAS;CAG1B,YAAY,EAAE,KAAK,CAAC,CAAC,SAAS;CAG9B,gBAAgB,EAAE,KAAK,CAAC,CAAC,SAAS;AACpC,CAAC;AAKD,MAAa,qCAWR,EAAE,OAAO;CAEZ,QAAQ,EAAE,OAAO;CAGjB,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;CAGjC,uBAAuB,EAAE,OAAO,CAAC,CAAC,SAAS;CAG3C,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS;CAG5B,MAAM,EAAE,OAAO;CAGf,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS;CAGhC,SAAS,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;CAGhC,eAAe,EAAE,OAAO;CAGxB,kBAAkB,EAAE,KAAK,CAAC,CAAC,SAAS;CAGpC,WAAW,EAAE,WAAW,MAAM;AAChC,CAAC;AAID,MAAa,uBAQR,EAAE,KAAK;CACV;CACA;CACA;CACA;CACA;CACA;CACA;AACF,CAAC;AAGD,MAAa,eAIR,EAAE,KAAK;CAAC;CAAK;CAAK;AAAO,CAAC;AAI/B,MAAa,0BAwBR,EACF,OAAO;CAEN,IAAI,EAAE,OAAO;CAGb,WAAW,EAAE,OAAO,CAAC,CAAC,SAAS;CAG/B,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS;CAGhC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;CAGvC,aAAa,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;CAG/C,QAAQ,aAAa,SAAS;CAG9B,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS;CAGhC,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS;CAGhC,aAAa,EAAE,KAAK;CAGpB,cAAc,EAAE,OAAO,CAAC,CAAC,SAAS;CAGlC,OAAO,EAAE,MAAM,CAAC,CAAC,SAAS;CAG1B,aAAa,EAAE,OAAO,CAAC,CAAC,SAAS;CAGjC,mBAAmB,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;CAG1C,kBAAkB,EAAE,OAAO;CAG3B,gBAAgB;CAGhB,uBAAuB,EAAE,KAAK,CAAC,CAAC,SAAS;CAGzC,wBAAwB,EAAE,KAAK,CAAC,CAAC,SAAS;CAG1C,qBAAqB,EAAE,WAAW,MAAM;CAGxC,oBAAoB,EAAE,WAAW,MAAM,CAAC,CAAC,SAAS;CAGlD,YAAY,EAAE,WAAW,MAAM;CAG/B,oBAAoB,mCAAmC,SAAS;AAClE,CAAC,CAAC,CACD,QAEE,SAAS,KAAK,aAAa,KAAK,YACjC,EAAE,SAAS,2DAA2D,CACxE;AAiDF,MAAa,gCAER,EAAE,OAAO,EACZ,gBAAgB,EAAE,OAAO,EAC3B,CAAC"}

package/src/builder/builder.test.ts

@@ -1,407 +0,0 @@
-import { Ed25519VerificationKey2020 } from "@digitalbazaar/ed25519-verification-key-2020";
-import { fileToBase85 } from "@idos-network/utils/codecs";
-import crypto from "node:crypto";
-import { describe, expect, it } from "vitest";
-import { ZodError } from "zod";
-
-import { buildCredential, buildFaceIdCredential } from ".";
-import { verifyCredential } from "./verifier";
-
-describe("verifiableCredentials", () => {
-  describe("face-scan-id", () => {
-    it("should raise an error if the fields are invalid", async () => {
-      expect.assertions(4); // catch
-
-      const id = "z6MkszZtxCmA2Ce4vUV132PCuLQmwnaDD5mw2L23fGNnsiX3";
-      const issuer = "https://vc-issuers.cool.id/idos";
-
-      const validKey = await Ed25519VerificationKey2020.generate({
-        id: `${issuer}/keys/1`,
-        controller: `${issuer}/issuers/1`,
-      });
-
-      try {
-        await buildFaceIdCredential(
-          {
-            id: `${issuer}/credentials/${id}`,
-            level: "human",
-            issued: new Date("2022-01-01"),
-            approvedAt: new Date("2022-01-01"),
-            expirationDate: new Date("2030-01-01"),
-          },
-          {
-            // @ts-expect-error
-            id: `uuid:${id}`,
-          },
-          validKey,
-        );
-      } catch (error) {
-        expect(error).toBeInstanceOf(ZodError);
-        const zodError = error as ZodError;
-        expect(zodError.issues).toHaveLength(1);
-
-        const faceSignUserId = zodError.issues.find((error) => error.path[0] === "faceSignUserId");
-        expect(faceSignUserId).toBeDefined();
-        expect(faceSignUserId?.message).toContain(
-          "Invalid input: expected string, received undefined",
-        );
-      }
-    });
-
-    it("should create and verify a verifiable vc", async () => {
-      const id = "z6MkszZtxCmA2Ce4vUV132PCuLQmwnaDD5mw2L23fGNnsiX3";
-      const issuer = "https://vc-issuers.cool.id/idos";
-      const issuer2 = "https://vc-issuers.cool.id/idos2";
-
-      const validKey = await Ed25519VerificationKey2020.generate({
-        id: `${issuer}/keys/1`,
-        controller: `${issuer}/issuers/1`,
-      });
-
-      const anotherKey = await Ed25519VerificationKey2020.generate({
-        id: `${issuer2}/keys/1`,
-        controller: `${issuer2}/issuers/1`,
-      });
-
-      const faceSignUserId = crypto.randomUUID();
-
-      const data = await buildFaceIdCredential(
-        {
-          id: `${issuer}/credentials/${id}`,
-          level: "human",
-          issued: new Date("2022-01-01"),
-          approvedAt: new Date("2022-01-01"),
-          expirationDate: new Date("2030-01-01"),
-        },
-        {
-          faceSignUserId,
-        },
-        validKey,
-      );
-
-      // Check if residential address is properly prefixed
-      expect(data.credentialSubject.faceSignUserId).toBe(faceSignUserId);
-
-      // Check if proof is properly constructed
-      expect(data.proof.proofPurpose).toBe("assertionMethod");
-      expect(data.proof.type).toBe("Ed25519Signature2020");
-      expect(data.proof.verificationMethod).toBe("https://vc-issuers.cool.id/idos/keys/1");
-
-      const allowedIssuers = [anotherKey, validKey];
-
-      const [verified, validResults] = await verifyCredential(data, allowedIssuers);
-      expect(verified).toBe(true);
-
-      const validResultsArray = validResults.values().toArray();
-      expect(validResultsArray).toHaveLength(2);
-      expect(validResultsArray[0].verified).toBe(false);
-      expect(validResultsArray[1].verified).toBe(true);
-    });
-
-    it("tempered VCs will be rejected", async () => {
-      const id = "z6MkszZtxCmA2Ce4vUV132PCuLQmwnaDD5mw2L23fGNnsiX3";
-      const issuer = "https://vc-issuers.cool.id/idos";
-
-      const validKey = await Ed25519VerificationKey2020.generate({
-        id: `${issuer}/keys/1`,
-        controller: `${issuer}/issuers/1`,
-      });
-
-      const faceSignUserId = crypto.randomUUID();
-      const faceSignUserId2 = crypto.randomUUID();
-
-      const data = await buildFaceIdCredential(
-        {
-          id: `${issuer}/credentials/${id}`,
-          level: "human",
-          issued: new Date("2022-01-01"),
-          approvedAt: new Date("2022-01-01"),
-          expirationDate: new Date("2030-01-01"),
-        },
-        {
-          faceSignUserId,
-        },
-        validKey,
-      );
-
-      // Check validity
-      const allowedIssuers = [validKey];
-      const [verified] = await verifyCredential(data, allowedIssuers);
-      expect(verified).toBe(true);
-
-      // Modify data
-      data.credentialSubject.faceSignUserId = faceSignUserId2;
-      const [verified2] = await verifyCredential(data, allowedIssuers);
-      expect(verified2).toBe(false);
-    });
-  });
-
-  describe("credentials", () => {
-    it("should raise an error if the fields are invalid", async () => {
-      expect.assertions(12); // catch
-
-      const id = "z6MkszZtxCmA2Ce4vUV132PCuLQmwnaDD5mw2L23fGNnsiX3";
-      const issuer = "https://vc-issuers.cool.id/idos";
-
-      const validKey = await Ed25519VerificationKey2020.generate({
-        id: `${issuer}/keys/1`,
-        controller: `${issuer}/issuers/1`,
-      });
-
-      try {
-        await buildCredential(
-          {
-            id: `${issuer}/credentials/${id}`,
-            level: "human",
-            issued: new Date("2022-01-01"),
-            approvedAt: new Date("2022-01-01"),
-            expirationDate: new Date("2030-01-01"),
-          },
-          {
-            id: `uuid:${id}`,
-            firstName: "John",
-            familyName: "Lennon",
-            // @ts-expect-error - This is a test, so the error is expected, since data is invalid
-            gender: "MALE",
-            email: "john.lennon@example.com",
-            phoneNumber: "+1234567890",
-            ssn: "203-456",
-            dateOfBirth: new Date("2025-02-30"),
-            placeOfBirth: "New York, NY",
-            idDocumentCountry: "DEU",
-            idDocumentNumber: "123456789",
-            idDocumentType: "PASSPORT",
-            idDocumentDateOfIssue: new Date("2022-01-01"),
-            idDocumentDateOfExpiry: new Date("2025-01-01"),
-            idDocumentFrontFile: Buffer.from("Front of ID document"),
-            residentialAddress: {
-              street: "Main St",
-              houseNumber: "123",
-              additionalAddressInfo: "Apt 1",
-              city: "New York",
-              postalCode: "10001",
-              country: "USA",
-              proofCategory: "Utility Bill",
-              proofDateOfIssue: new Date("2022-01-01"),
-              proofFile: Buffer.from("Proof of address"),
-            },
-          },
-          validKey,
-        );
-      } catch (error) {
-        expect(error).toBeInstanceOf(ZodError);
-        const zodError = error as ZodError;
-        expect(zodError.issues).toHaveLength(5);
-
-        // idDocumentCountry
-        const idDocumentCountryError = zodError.issues.find(
-          (error) => error.path[0] === "idDocumentCountry",
-        );
-        expect(idDocumentCountryError).toBeDefined();
-        expect(idDocumentCountryError?.message).toContain(
-          "Too big: expected string to have <=2 characters",
-        );
-
-        // selfieFile
-        const selfieFileError = zodError.issues.find((error) => error.path[0] === "selfieFile");
-        expect(selfieFileError).toBeDefined();
-        expect(selfieFileError?.message).toContain("expected Buffer, received undefined");
-
-        // residentialAddress country
-        const residentialAddressCountryError = zodError.issues.find(
-          (error) => error.path[0] === "residentialAddress",
-        );
-        expect(residentialAddressCountryError).toBeDefined();
-        expect(residentialAddressCountryError?.message).toContain(
-          "Too big: expected string to have <=2 characters",
-        );
-
-        // gender
-        const genderError = zodError.issues.find((error) => error.path[0] === "gender");
-        expect(genderError).toBeDefined();
-        expect(genderError?.message).toContain('Invalid option: expected one of "M"|"F"|"OTHER"');
-
-        // ssn
-        const ssnError = zodError.issues.find((error) => error.path[0] === "ssn");
-        expect(ssnError).toBeDefined();
-        expect(ssnError?.message).toContain("Too small: expected string to have >=9 characters");
-      }
-    });
-
-    it("test refinement (at least one of firstName or familyName must be provided)", async () => {
-      const id = "z6MkszZtxCmA2Ce4vUV132PCuLQmwnaDD5mw2L23fGNnsiX3";
-      const issuer = "https://vc-issuers.cool.id/idos";
-
-      const validKey = await Ed25519VerificationKey2020.generate({
-        id: `${issuer}/keys/1`,
-        controller: `${issuer}/issuers/1`,
-      });
-
-      expect.assertions(3); // catch
-
-      try {
-        await buildCredential(
-          {
-            id: `${issuer}/credentials/${id}`,
-            level: "human",
-            issued: new Date("2022-01-01"),
-            approvedAt: new Date("2022-01-01"),
-            expirationDate: new Date("2030-01-01"),
-          },
-          {
-            id: `uuid:${id}`,
-            ssn: "123456789",
-            firstName: "",
-            familyName: undefined,
-            gender: "M",
-            nationality: "US",
-            email: "john.lennon@example.com",
-            phoneNumber: "+1234567890",
-            dateOfBirth: new Date("1980-01-01"),
-            placeOfBirth: "New York, NY",
-            idDocumentCountry: "US",
-            idDocumentNumber: "123456789",
-            idDocumentType: "PASSPORT",
-            idDocumentDateOfIssue: new Date("2022-01-01"),
-            idDocumentDateOfExpiry: new Date("2025-01-01"),
-            idDocumentFrontFile: Buffer.from("Front of ID document"),
-            idDocumentBackFile: Buffer.from("Back of ID document"),
-            selfieFile: Buffer.from("Selfie"),
-          },
-          validKey,
-        );
-      } catch (error) {
-        expect(error).toBeInstanceOf(ZodError);
-        const zodError = error as ZodError;
-        expect(zodError.issues).toHaveLength(1);
-
-        const refinementError = zodError.issues.find(
-          (error) => error.message === "At least one of firstName or familyName must be provided",
-        );
-        expect(refinementError).toBeDefined();
-      }
-    });
-
-    it("should create and verify a verifiable vc", async () => {
-      const id = "z6MkszZtxCmA2Ce4vUV132PCuLQmwnaDD5mw2L23fGNnsiX3";
-      const issuer = "https://vc-issuers.cool.id/idos";
-      const issuer2 = "https://vc-issuers.cool.id/idos2";
-
-      const validKey = await Ed25519VerificationKey2020.generate({
-        id: `${issuer}/keys/1`,
-        controller: `${issuer}/issuers/1`,
-      });
-
-      const anotherKey = await Ed25519VerificationKey2020.generate({
-        id: `${issuer2}/keys/1`,
-        controller: `${issuer2}/issuers/1`,
-      });
-
-      const data = await buildCredential(
-        {
-          id: `${issuer}/credentials/${id}`,
-          level: "human",
-          issued: new Date("2022-01-01"),
-          approvedAt: new Date("2022-01-01"),
-          expirationDate: new Date("2030-01-01"),
-        },
-        {
-          id: `uuid:${id}`,
-          firstName: "John",
-          middleName: "Paul",
-          familyName: "Lennon",
-          ssn: "123456789",
-          gender: "M",
-          nationality: "US",
-          email: "john.lennon@example.com",
-          phoneNumber: "+1234567890",
-          dateOfBirth: new Date("1980-01-01"),
-          placeOfBirth: "New York, NY",
-          idDocumentCountry: "US",
-          idDocumentNumber: "123456789",
-          idDocumentType: "PASSPORT",
-          idDocumentDateOfIssue: new Date("2022-01-01"),
-          idDocumentDateOfExpiry: new Date("2025-01-01"),
-          idDocumentFrontFile: Buffer.from("Front of ID document"),
-          idDocumentBackFile: Buffer.from("Back of ID document"),
-          selfieFile: Buffer.from("Selfie"),
-          residentialAddress: {
-            street: "Main St",
-            houseNumber: "123",
-            additionalAddressInfo: "Apt 1",
-            region: "NY",
-            city: "New York",
-            postalCode: "10001",
-            country: "US",
-            proofCategory: "Utility Bill",
-            proofDateOfIssue: new Date("2022-01-01"),
-            proofFile: Buffer.from("Proof of address"),
-          },
-        },
-        validKey,
-      );
-
-      // Check if residential address is properly prefixed
-      expect(data.credentialSubject.residentialAddressStreet).toBe("Main St");
-      expect(data.credentialSubject.residentialAddressHouseNumber).toBe("123");
-      expect(data.credentialSubject.residentialAddressAdditionalAddressInfo).toBe("Apt 1");
-      expect(data.credentialSubject.residentialAddressCity).toBe("New York");
-      expect(data.credentialSubject.residentialAddressPostalCode).toBe("10001");
-      expect(data.credentialSubject.residentialAddressCountry).toBe("US");
-      expect(data.credentialSubject.residentialAddressRegion).toBe("NY");
-      expect(data.credentialSubject.residentialAddressProofCategory).toBe("Utility Bill");
-      expect(data.credentialSubject.residentialAddressProofDateOfIssue).toEqual(
-        new Date("2022-01-01").toISOString(),
-      );
-      expect(data.credentialSubject.residentialAddressProofFile).toEqual(
-        fileToBase85(Buffer.from("Proof of address")),
-      );
-
-      expect(data.credentialSubject.email).toBe("john.lennon@example.com");
-      expect(data.credentialSubject.phoneNumber).toBe("+1234567890");
-
-      // Check if proof is properly constructed
-      expect(data.proof.proofPurpose).toBe("assertionMethod");
-      expect(data.proof.type).toBe("Ed25519Signature2020");
-      expect(data.proof.verificationMethod).toBe("https://vc-issuers.cool.id/idos/keys/1");
-
-      const allowedIssuers = [anotherKey, validKey];
-
-      const [verified, validResults] = await verifyCredential(data, allowedIssuers);
-      expect(verified).toBe(true);
-
-      const validResultsArray = validResults.values().toArray();
-      expect(validResultsArray).toHaveLength(2);
-      expect(validResultsArray[0].verified).toBe(false);
-      expect(validResultsArray[1].verified).toBe(true);
-
-      // Invalid issuer
-      const invalidIssuers = [
-        {
-          // Just the wrong issuer
-          issuer: issuer2,
-          publicKeyMultibase: anotherKey.publicKeyMultibase,
-        },
-      ];
-
-      const [invalidVerified, invalidResults] = await verifyCredential(data, invalidIssuers);
-      expect(invalidVerified).toBe(false);
-
-      const invalidResultsArray = invalidResults.values().toArray();
-      expect(invalidResultsArray).toHaveLength(1);
-      expect(invalidResultsArray[0].verified).toBe(false);
-      expect(invalidResultsArray[0].error?.errors?.[0]?.message).toContain("not verify any proofs");
-
-      // Accepts issuer as issuer object
-      const validIssuer = [
-        {
-          issuer,
-          publicKeyMultibase: validKey.publicKeyMultibase,
-        },
-      ];
-
-      const [validIssuerVerified] = await verifyCredential(data, validIssuer);
-      expect(validIssuerVerified).toBe(true);
-    });
-  });
-});

package/src/builder/index.ts

@@ -1,122 +0,0 @@
-import { Ed25519Signature2020 } from "@digitalbazaar/ed25519-signature-2020";
-import * as vc from "@digitalbazaar/vc";
-
-import type { VerifyCredentialResult } from "./verifier";
-
-import {
-  type AvailableIssuerType,
-  type CredentialFields,
-  CredentialFieldsSchema,
-  type CredentialSubject,
-  type CredentialSubjectFaceId,
-  CredentialSubjectFaceIdSchema,
-  CredentialSubjectSchema,
-  type VerifiableCredential,
-  type VerifiableCredentialSubject,
-} from "../types";
-import { convertValues, issuerToKey } from "../utils";
-import {
-  CONTEXT_IDOS_CREDENTIAL,
-  CONTEXT_IDOS_CREDENTIAL_FACE_ID,
-  CONTEXT_IDOS_CREDENTIAL_SUBJECT,
-  CONTEXT_IDOS_SIGNATURE,
-  CONTEXT_V1,
-  defaultDocumentLoader,
-} from "./loader";
-import { verifyCredential } from "./verifier";
-
-export type Credential = VerifiableCredential<VerifiableCredentialSubject>;
-export type FaceIdCredential = VerifiableCredential<CredentialSubjectFaceId>;
-
-export type CredentialBuilder<TInput, TOutput = TInput> = (
-  fields: CredentialFields,
-  subject: TInput,
-  issuer: AvailableIssuerType,
-  validate?: boolean,
-) => Promise<VerifiableCredential<TOutput>>;
-
-export type CredentialConverter<TInput> = (
-  subject: TInput,
-  validate: boolean,
-  // oxlint-disable-next-line typescript/no-explicit-any -- any is needed here
-) => Record<string, any>;
-
-function genericCredentialBuilder<TInput, TOutput = TInput>(
-  credentialConverter: CredentialConverter<TInput>,
-): CredentialBuilder<TInput, TOutput> {
-  async function builder(
-    fields: CredentialFields,
-    subject: TInput,
-    issuer: AvailableIssuerType,
-    validate = true,
-  ) {
-    if (validate) {
-      // This raises an z.ZodError exception if the fields are invalid
-      CredentialFieldsSchema.parse(fields);
-    }
-
-    const credentialSubject = credentialConverter(subject, validate);
-
-    const key = await issuerToKey(issuer);
-
-    // Create credentials container
-    const credential = {
-      "@context": [CONTEXT_V1, CONTEXT_IDOS_CREDENTIAL, CONTEXT_IDOS_SIGNATURE],
-      type: ["VerifiableCredential"],
-      issuer: key.controller,
-      ...convertValues(fields),
-      credentialSubject,
-    };
-
-    const suite = new Ed25519Signature2020({ key });
-
-    return vc.issue<TOutput>({
-      credential,
-      suite,
-      documentLoader: defaultDocumentLoader,
-    });
-  }
-
-  return builder;
-}
-
-export const credentialSubjectConverter: CredentialConverter<CredentialSubject> = (
-  subject,
-  validate,
-) => {
-  if (validate) {
-    CredentialSubjectSchema.parse(subject);
-  }
-
-  const { residentialAddress, ...subjectData } = subject;
-  return {
-    "@context": CONTEXT_IDOS_CREDENTIAL_SUBJECT,
-    ...convertValues(subjectData),
-    ...(residentialAddress ? convertValues(residentialAddress, "residentialAddress") : {}),
-  };
-};
-
-export const credentialFaceIdSubjectConverter: CredentialConverter<CredentialSubjectFaceId> = (
-  subject,
-  validate,
-) => {
-  if (validate) {
-    CredentialSubjectFaceIdSchema.parse(subject);
-  }
-
-  return {
-    "@context": CONTEXT_IDOS_CREDENTIAL_FACE_ID,
-    ...convertValues(subject),
-  };
-};
-
-export const buildCredential: CredentialBuilder<CredentialSubject, VerifiableCredentialSubject> =
-  genericCredentialBuilder<CredentialSubject, VerifiableCredentialSubject>(
-    credentialSubjectConverter,
-  );
-
-export const buildFaceIdCredential: CredentialBuilder<CredentialSubjectFaceId> =
-  genericCredentialBuilder<CredentialSubjectFaceId>(credentialFaceIdSubjectConverter);
-
-export type { VerifyCredentialResult };
-export { verifyCredential };