@learncard/core 8.4.2 → 8.5.0

package/dist/wallet/plugins/test-storage/index.d.ts

@@ -0,0 +1,2 @@
+import { TestStoragePlugin } from './types';
+export declare const getTestStorage: () => TestStoragePlugin;

package/dist/wallet/plugins/test-storage/types.d.ts

@@ -0,0 +1,2 @@
+import { Plugin } from '../../../types/wallet';
+export type TestStoragePlugin = Plugin<'Test Storage', 'read' | 'store' | 'index'>;

package/dist/wallet/plugins/vc/index.d.ts

@@ -0,0 +1,2 @@
+export { getVCPlugin } from './vc';
+export * from './types';

package/dist/wallet/plugins/vc/issueCredential.d.ts

@@ -0,0 +1,98 @@
+import { UnsignedVC } from '@learncard/types';
+import { ProofOptions } from '../../plugins/didkit/types';
+import { VCDependentLearnCard, VCImplicitLearnCard } from './types';
+export declare const issueCredential: (initLearnCard: VCDependentLearnCard) => (learnCard: VCImplicitLearnCard, credential: UnsignedVC, signingOptions?: Partial<ProofOptions>) => Promise<{
+    [x: string]: any;
+    id?: string | undefined;
+    expirationDate?: string | undefined;
+    credentialStatus?: {
+        type: string;
+        id: string;
+    } | undefined;
+    credentialSchema?: {
+        type: string;
+        id: string;
+    }[] | undefined;
+    refreshService?: {
+        [x: string]: any;
+        type: string;
+        id: string;
+    } | undefined;
+    type: [string, ...string[]];
+    '@context': (string | Record<string, any>)[];
+    issuer: string | {
+        [x: string]: any;
+        type?: string | [string, ...string[]] | undefined;
+        id?: string | undefined;
+        name?: string | undefined;
+        url?: string | undefined;
+        phone?: string | undefined;
+        description?: string | undefined;
+        endorsement?: any[] | undefined;
+        image?: string | {
+            caption?: string | undefined;
+            type: string;
+            id: string;
+        } | undefined;
+        email?: string | undefined;
+        address?: {
+            addressCountry?: string | undefined;
+            addressCountryCode?: string | undefined;
+            addressRegion?: string | undefined;
+            addressLocality?: string | undefined;
+            streetAddress?: string | undefined;
+            postOfficeBoxNumber?: string | undefined;
+            postalCode?: string | undefined;
+            geo?: {
+                type: string | [string, ...string[]];
+                latitude: number;
+                longitude: number;
+            } | undefined;
+            type: string | [string, ...string[]];
+        } | undefined;
+        otherIdentifier?: {
+            type: string | [string, ...string[]];
+            identifier: string;
+            identifierType: string;
+        }[] | undefined;
+        official?: string | undefined;
+        parentOrg?: any;
+        familyName?: string | undefined;
+        givenName?: string | undefined;
+        additionalName?: string | undefined;
+        patronymicName?: string | undefined;
+        honorificPrefix?: string | undefined;
+        honorificSuffix?: string | undefined;
+        familyNamePrefix?: string | undefined;
+        dateOfBirth?: string | undefined;
+    };
+    issuanceDate: string;
+    credentialSubject: {
+        [x: string]: any;
+        id?: string | undefined;
+    } | {
+        [x: string]: any;
+        id?: string | undefined;
+    }[];
+    proof: {
+        [x: string]: any;
+        challenge?: string | undefined;
+        domain?: string | undefined;
+        nonce?: string | undefined;
+        jws?: string | undefined;
+        type: string;
+        created: string;
+        proofPurpose: string;
+        verificationMethod: string;
+    } | {
+        [x: string]: any;
+        challenge?: string | undefined;
+        domain?: string | undefined;
+        nonce?: string | undefined;
+        jws?: string | undefined;
+        type: string;
+        created: string;
+        proofPurpose: string;
+        verificationMethod: string;
+    }[];
+}>;

package/dist/wallet/plugins/vc/issuePresentation.d.ts

@@ -0,0 +1,220 @@
+import { UnsignedVP } from '@learncard/types';
+import { ProofOptions } from '../../plugins/didkit/types';
+import { VCDependentLearnCard, VCImplicitLearnCard } from './types';
+export declare const issuePresentation: (initLearnCard: VCDependentLearnCard) => (learnCard: VCImplicitLearnCard, presentation: UnsignedVP, signingOptions?: Partial<ProofOptions>) => Promise<{
+    [x: string]: any;
+    id?: string | undefined;
+    verifiableCredential?: {
+        [x: string]: any;
+        id?: string | undefined;
+        expirationDate?: string | undefined;
+        credentialStatus?: {
+            type: string;
+            id: string;
+        } | undefined;
+        credentialSchema?: {
+            type: string;
+            id: string;
+        }[] | undefined;
+        refreshService?: {
+            [x: string]: any;
+            type: string;
+            id: string;
+        } | undefined;
+        type: [string, ...string[]];
+        '@context': (string | Record<string, any>)[];
+        issuer: string | {
+            [x: string]: any;
+            type?: string | [string, ...string[]] | undefined;
+            id?: string | undefined;
+            name?: string | undefined;
+            url?: string | undefined;
+            phone?: string | undefined;
+            description?: string | undefined;
+            endorsement?: any[] | undefined;
+            image?: string | {
+                caption?: string | undefined;
+                type: string;
+                id: string;
+            } | undefined;
+            email?: string | undefined;
+            address?: {
+                addressCountry?: string | undefined;
+                addressCountryCode?: string | undefined;
+                addressRegion?: string | undefined;
+                addressLocality?: string | undefined;
+                streetAddress?: string | undefined;
+                postOfficeBoxNumber?: string | undefined;
+                postalCode?: string | undefined;
+                geo?: {
+                    type: string | [string, ...string[]];
+                    latitude: number;
+                    longitude: number;
+                } | undefined;
+                type: string | [string, ...string[]];
+            } | undefined;
+            otherIdentifier?: {
+                type: string | [string, ...string[]];
+                identifier: string;
+                identifierType: string;
+            }[] | undefined;
+            official?: string | undefined;
+            parentOrg?: any;
+            familyName?: string | undefined;
+            givenName?: string | undefined;
+            additionalName?: string | undefined;
+            patronymicName?: string | undefined;
+            honorificPrefix?: string | undefined;
+            honorificSuffix?: string | undefined;
+            familyNamePrefix?: string | undefined;
+            dateOfBirth?: string | undefined;
+        };
+        issuanceDate: string;
+        credentialSubject: {
+            [x: string]: any;
+            id?: string | undefined;
+        } | {
+            [x: string]: any;
+            id?: string | undefined;
+        }[];
+        proof: {
+            [x: string]: any;
+            challenge?: string | undefined;
+            domain?: string | undefined;
+            nonce?: string | undefined;
+            jws?: string | undefined;
+            type: string;
+            created: string;
+            proofPurpose: string;
+            verificationMethod: string;
+        } | {
+            [x: string]: any;
+            challenge?: string | undefined;
+            domain?: string | undefined;
+            nonce?: string | undefined;
+            jws?: string | undefined;
+            type: string;
+            created: string;
+            proofPurpose: string;
+            verificationMethod: string;
+        }[];
+    } | {
+        [x: string]: any;
+        id?: string | undefined;
+        expirationDate?: string | undefined;
+        credentialStatus?: {
+            type: string;
+            id: string;
+        } | undefined;
+        credentialSchema?: {
+            type: string;
+            id: string;
+        }[] | undefined;
+        refreshService?: {
+            [x: string]: any;
+            type: string;
+            id: string;
+        } | undefined;
+        type: [string, ...string[]];
+        '@context': (string | Record<string, any>)[];
+        issuer: string | {
+            [x: string]: any;
+            type?: string | [string, ...string[]] | undefined;
+            id?: string | undefined;
+            name?: string | undefined;
+            url?: string | undefined;
+            phone?: string | undefined;
+            description?: string | undefined;
+            endorsement?: any[] | undefined;
+            image?: string | {
+                caption?: string | undefined;
+                type: string;
+                id: string;
+            } | undefined;
+            email?: string | undefined;
+            address?: {
+                addressCountry?: string | undefined;
+                addressCountryCode?: string | undefined;
+                addressRegion?: string | undefined;
+                addressLocality?: string | undefined;
+                streetAddress?: string | undefined;
+                postOfficeBoxNumber?: string | undefined;
+                postalCode?: string | undefined;
+                geo?: {
+                    type: string | [string, ...string[]];
+                    latitude: number;
+                    longitude: number;
+                } | undefined;
+                type: string | [string, ...string[]];
+            } | undefined;
+            otherIdentifier?: {
+                type: string | [string, ...string[]];
+                identifier: string;
+                identifierType: string;
+            }[] | undefined;
+            official?: string | undefined;
+            parentOrg?: any;
+            familyName?: string | undefined;
+            givenName?: string | undefined;
+            additionalName?: string | undefined;
+            patronymicName?: string | undefined;
+            honorificPrefix?: string | undefined;
+            honorificSuffix?: string | undefined;
+            familyNamePrefix?: string | undefined;
+            dateOfBirth?: string | undefined;
+        };
+        issuanceDate: string;
+        credentialSubject: {
+            [x: string]: any;
+            id?: string | undefined;
+        } | {
+            [x: string]: any;
+            id?: string | undefined;
+        }[];
+        proof: {
+            [x: string]: any;
+            challenge?: string | undefined;
+            domain?: string | undefined;
+            nonce?: string | undefined;
+            jws?: string | undefined;
+            type: string;
+            created: string;
+            proofPurpose: string;
+            verificationMethod: string;
+        } | {
+            [x: string]: any;
+            challenge?: string | undefined;
+            domain?: string | undefined;
+            nonce?: string | undefined;
+            jws?: string | undefined;
+            type: string;
+            created: string;
+            proofPurpose: string;
+            verificationMethod: string;
+        }[];
+    }[] | undefined;
+    holder?: string | undefined;
+    type: [string, ...string[]];
+    '@context': (string | Record<string, any>)[];
+    proof: {
+        [x: string]: any;
+        challenge?: string | undefined;
+        domain?: string | undefined;
+        nonce?: string | undefined;
+        jws?: string | undefined;
+        type: string;
+        created: string;
+        proofPurpose: string;
+        verificationMethod: string;
+    } | {
+        [x: string]: any;
+        challenge?: string | undefined;
+        domain?: string | undefined;
+        nonce?: string | undefined;
+        jws?: string | undefined;
+        type: string;
+        created: string;
+        proofPurpose: string;
+        verificationMethod: string;
+    }[];
+}>;

package/dist/wallet/plugins/vc/types.d.ts

@@ -0,0 +1,35 @@
+import { JWK, UnsignedVC, VC, UnsignedVP, VP, VerificationCheck } from '@learncard/types';
+import { Plugin, LearnCard } from '../../../types/wallet';
+import { ProofOptions, InputMetadata } from '../didkit/types';
+/** @group VC Plugin */
+export type VCPluginDependentMethods = {
+    getSubjectDid: (type: 'key') => string;
+    getSubjectKeypair: () => JWK;
+    keyToVerificationMethod: (type: string, keypair: JWK) => Promise<string>;
+    didToVerificationMethod: (did: string) => Promise<string>;
+    issueCredential: (credential: UnsignedVC, options: ProofOptions, keypair: JWK) => Promise<VC>;
+    verifyCredential: (credential: VC, options?: ProofOptions) => Promise<VerificationCheck>;
+    issuePresentation: (presentation: UnsignedVP, options: ProofOptions, keypair: JWK) => Promise<VP>;
+    verifyPresentation: (presentation: VP | string, options?: ProofOptions) => Promise<VerificationCheck>;
+    resolveDid: (did: string, inputMetadata?: InputMetadata) => Promise<Record<string, any>>;
+};
+/** @group VC Plugin */
+export type VCPluginMethods = {
+    issueCredential: (credential: UnsignedVC, signingOptions?: Partial<ProofOptions>) => Promise<VC>;
+    verifyCredential: (credential: VC, options?: Partial<ProofOptions>) => Promise<VerificationCheck>;
+    issuePresentation: (credential: UnsignedVP, signingOptions?: Partial<ProofOptions>) => Promise<VP>;
+    verifyPresentation: (presentation: VP | string, options?: Partial<ProofOptions>) => Promise<VerificationCheck>;
+    getTestVc: (subject?: string) => UnsignedVC;
+    getTestVp: (credential?: VC) => Promise<UnsignedVP>;
+    getDidAuthVp: (options?: ProofOptions) => Promise<VP | string>;
+};
+/** @group VC Plugin */
+export type VCDependentLearnCard = LearnCard<any, 'id', VCPluginDependentMethods>;
+/** @group VC Plugin */
+export type VCImplicitLearnCard = LearnCard<any, 'id', VCPluginMethods & VCPluginDependentMethods>;
+/** @group VC Plugin */
+export type VerifyExtension = {
+    verifyCredential: (credential: VC) => Promise<VerificationCheck>;
+};
+/** @group VC Plugin */
+export type VCPlugin = Plugin<'VC', any, VCPluginMethods, 'id', VCPluginDependentMethods>;

package/dist/wallet/plugins/vc/vc.d.ts

@@ -0,0 +1,5 @@
+import { VCDependentLearnCard, VCPlugin } from './types';
+/**
+ * @group Plugins
+ */
+export declare const getVCPlugin: (learnCard: VCDependentLearnCard) => VCPlugin;

package/dist/wallet/plugins/vc/verifyCredential.d.ts

@@ -0,0 +1,8 @@
+import { VC } from '@learncard/types';
+import { ProofOptions } from '../../plugins/didkit/types';
+import { VCDependentLearnCard, VCImplicitLearnCard } from './types';
+export declare const verifyCredential: (initLearnCard: VCDependentLearnCard) => (_learnCard: VCImplicitLearnCard, credential: VC, options?: Partial<ProofOptions>) => Promise<{
+    checks: string[];
+    warnings: string[];
+    errors: string[];
+}>;

package/dist/wallet/plugins/vc/verifyPresentation.d.ts

@@ -0,0 +1,8 @@
+import { VP } from '@learncard/types';
+import { ProofOptions } from '../../plugins/didkit/types';
+import { VCDependentLearnCard, VCImplicitLearnCard } from './types';
+export declare const verifyPresentation: (initLearnCard: VCDependentLearnCard) => (_learnCard: VCImplicitLearnCard, presentation: VP | string, options?: Partial<ProofOptions>) => Promise<{
+    checks: string[];
+    warnings: string[];
+    errors: string[];
+}>;

package/dist/wallet/plugins/vc-api/helpers.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Sends a POST request via fetch
+ */
+export declare const post: (url: string, data: Record<string, any>) => Promise<Response>;
+/**
+ * Returns whether or not an HTTP status code is successful
+ */
+export declare const isSuccessful: (status: number) => boolean;

package/dist/wallet/plugins/vc-api/index.d.ts

@@ -0,0 +1,8 @@
+import { VCAPIPlugin } from './types';
+/**
+ * @group Plugins
+ */
+export declare const getVCAPIPlugin: ({ url: _url, did: _did, }: {
+    url: string;
+    did?: string;
+}) => Promise<VCAPIPlugin>;

package/dist/wallet/plugins/vc-api/types.d.ts

@@ -0,0 +1,20 @@
+import { UnsignedVC, UnsignedVP, VC, VP, VerificationCheck } from '@learncard/types';
+import { Plugin } from '../../../types/wallet';
+/** @group VC-API Plugin */
+export type APIOptions = {
+    created?: string;
+    challenge?: string;
+    domain?: string;
+};
+/** @group VC-API Plugin */
+export type VCAPIPluginMethods = {
+    getSubjectDid: (type: string) => string;
+    issueCredential: (credential: UnsignedVC, signingOptions?: APIOptions) => Promise<VC>;
+    verifyCredential: (credential: VC, options?: Omit<APIOptions, 'created'>) => Promise<VerificationCheck>;
+    issuePresentation: (presentation: UnsignedVP, signingOptions?: APIOptions) => Promise<VP>;
+    verifyPresentation: (presentation: VP, options?: Omit<APIOptions, 'created'>) => Promise<VerificationCheck>;
+    getTestVc: (subject?: string) => UnsignedVC;
+    getTestVp: (credential?: VC) => Promise<UnsignedVP>;
+};
+/** @group VC-API Plugin */
+export type VCAPIPlugin = Plugin<'VC API', 'id', VCAPIPluginMethods>;

package/dist/wallet/plugins/vc-resolution/index.d.ts

@@ -0,0 +1,6 @@
+import { VCResolutionPluginType } from './types';
+export * from './types';
+/**
+ * @group Plugins
+ */
+export declare const VCResolutionPlugin: VCResolutionPluginType;

package/dist/wallet/plugins/vc-resolution/types.d.ts

@@ -0,0 +1,13 @@
+import { VC } from '@learncard/types';
+import { Plugin } from '../../../types/wallet';
+/** @group VC Resolution Plugin */
+export type LC_URI<URI extends string = ''> = string | URI;
+/** @group VC Resolution Plugin */
+export type VCResolutionPluginMethods = {
+    resolveCredential: (uri?: LC_URI) => Promise<VC | undefined>;
+};
+/** @group VC Resolution Plugin */
+export type ResolutionExtension<URI extends string> = {
+    resolveCredential: (uri?: LC_URI<URI>) => Promise<VC | undefined>;
+};
+export type VCResolutionPluginType = Plugin<'VC Resolution', any, VCResolutionPluginMethods>;

package/dist/wallet/plugins/vc-templates/index.d.ts

@@ -0,0 +1,2 @@
+export { getVCTemplatesPlugin } from './vc-templates';
+export * from './types';

package/dist/wallet/plugins/vc-templates/templates.d.ts

@@ -0,0 +1,6 @@
+import { UnsignedVC } from '@learncard/types';
+import { VcTemplates } from './types';
+/** @group VC Templates Plugin */
+export declare const VC_TEMPLATES: {
+    [Key in keyof VcTemplates]: (args: VcTemplates[Key]) => UnsignedVC;
+};

package/dist/wallet/plugins/vc-templates/types.d.ts

@@ -0,0 +1,40 @@
+import { UnsignedVC, VC, UnsignedVP } from '@learncard/types';
+import { DiscriminatedUnionize } from '../../../types/helpers';
+import { Plugin } from '../../../types/wallet';
+/** @group VC Templates Plugin */
+export type VcTemplates = {
+    basic: {
+        did?: string;
+        subject?: string;
+        issuanceDate?: string;
+    };
+    achievement: {
+        did?: string;
+        subject?: string;
+        name?: string;
+        achievementName?: string;
+        description?: string;
+        criteriaNarrative?: string;
+        issuanceDate?: string;
+    };
+    jff2: {
+        did?: string;
+        subject?: string;
+        issuanceDate?: string;
+    };
+};
+/** @group VC Templates Plugin */
+export type NewCredentialFunction = (args?: DiscriminatedUnionize<VcTemplates>) => UnsignedVC;
+/** @group VC Templates Plugin */
+export type VCTemplatePluginDependentMethods = {
+    getSubjectDid?: (type: 'key') => string;
+};
+/** @group VC Templates Plugin */
+export type VCTemplatePluginMethods = {
+    newCredential: NewCredentialFunction;
+    newPresentation: (credential: VC, args?: {
+        did?: string;
+    }) => Promise<UnsignedVP>;
+};
+/** @group VC Templates Plugin */
+export type VCTemplatePlugin = Plugin<'VC Templates', any, VCTemplatePluginMethods, 'id', VCTemplatePluginDependentMethods>;

package/dist/wallet/plugins/vc-templates/vc-templates.d.ts

@@ -0,0 +1,5 @@
+import { VCTemplatePlugin } from './types';
+/**
+ * @group Plugins
+ */
+export declare const getVCTemplatesPlugin: () => VCTemplatePlugin;

package/dist/wallet/plugins/vpqr/index.d.ts

@@ -0,0 +1,7 @@
+import { VpqrPlugin, VpqrPluginDependentMethods } from './types';
+import { LearnCard } from '../../../types/wallet';
+export * from './types';
+/**
+ * @group Plugins
+ */
+export declare const getVpqrPlugin: (learnCard: LearnCard<any, any, VpqrPluginDependentMethods>) => VpqrPlugin;

package/dist/wallet/plugins/vpqr/types.d.ts

@@ -0,0 +1,12 @@
+import { VP } from '@learncard/types';
+import { Plugin } from '../../../types/wallet';
+/** @group VPQR Plugin */
+export type VpqrPluginMethods = {
+    vpFromQrCode: (text: string) => Promise<VP>;
+    vpToQrCode: (vp: VP) => Promise<string>;
+};
+/** @group VPQR Plugin */
+export type VpqrPluginDependentMethods = {
+    contextLoader: (url: string) => Promise<Record<string, any>>;
+};
+export type VpqrPlugin = Plugin<'Vpqr', any, VpqrPluginMethods, any, VpqrPluginDependentMethods>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@learncard/core",
-  "version": "8.4.2",
+  "version": "8.5.0",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/core.esm.js",
@@ -26,30 +26,32 @@
     "esbuild-jest": "^0.5.0",
     "esbuild-plugin-copy": "^1.3.0",
     "jest": "^29.3.0",
+    "jest-resolver-enhanced": "^1.1.0",
     "jimp": "^0.16.1",
+    "multiformats": "^11.0.1",
     "qrcode-reader": "^1.0.4",
     "shx": "^0.3.4",
     "ts-jest": "^29.0.3",
     "tsc-alias": "^1.6.9",
     "typescript": "^4.6.4",
-    "@learncard/types": "5.1.1"
+    "@learncard/types": "5.2.0"
   },
-  "types": "./dist/core.d.ts",
+  "types": "./dist/index.d.ts",
   "dependencies": {
-    "@ceramicnetwork/common": "^2.2.1",
+    "@ceramicnetwork/common": "2.13.0",
     "@ceramicnetwork/http-client": "2.7.0",
-    "@ceramicnetwork/stream-tile": "^2.2.2",
-    "@ceramicnetwork/streamid": "^2.1.0",
+    "@ceramicnetwork/stream-tile": "2.9.0",
+    "@ceramicnetwork/streamid": "2.7.0",
     "@digitalbazaar/vpqr": "^3.0.0",
-    "@glazed/did-datastore": "^0.3.2",
-    "@glazed/tile-loader": "^0.2.1",
+    "@glazed/did-datastore": "0.3.2",
+    "@glazed/tile-loader": "0.2.1",
     "@uniswap/default-token-list": "^4.1.0",
     "abort-controller": "^3.0.0",
     "core-js": "^3.25.5",
     "credential-handler-polyfill": "^3.0.0",
     "cross-fetch": "^3.1.5",
     "date-fns": "^2.28.0",
-    "dids": "^3.2.0",
+    "dids": "3.4.0",
     "ethers": "^5.6.9",
     "hex-lite": "^1.5.0",
     "isomorphic-fetch": "^3.0.0",
@@ -57,11 +59,11 @@
     "key-did-provider-ed25519": "^2.0.0",
     "key-did-resolver": "2.3.0",
     "web-credential-handler": "^2.0.0",
-    "zod": "^3.17.3",
+    "zod": "^3.20.2",
     "@learncard/helpers": "1.0.1"
   },
   "scripts": {
-    "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.js && dts-bundle-generator src/index.ts -o dist/core.d.ts --no-check && tsc-alias && shx  sed -i \"s/import\\(\\\\\\\"\\.\\\\\\\"\\)\\.//g\" dist/core.d.ts",
+    "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.js && tsc --p tsconfig.build.json && tsc-alias",
     "start": "aqu watch",
     "lint": "aqu lint",
     "lint:fix": "aqu lint --fix",