@learncard/didkit-plugin 1.9.3 → 1.9.5

package/README.md

@@ -9,25 +9,26 @@
 The LearnCard Core is a pluggable, open-source, universal digital wallet to enable any individual or organization to seamlessly **issue, earn, store, share, and spend currency and credentials** built for the future of education and work.
 
 ## Documentation
+
 All LearnCard documentation can be found at:
 https://docs.learncard.com
 
 ## Install
 
 ```bash
-pnpm i @learncard/core
+bun add @learncard/core
 ```
 
 ## Usage
 
 ### Instantiation
 
-Instantiate a wallet using `initLearnCard`. This method accepts a unique identifier string that is 
+Instantiate a wallet using `initLearnCard`. This method accepts a unique identifier string that is
 up to 64 characters long. If it is less than 64 characters, `initLearnCard` will pad the start of
 the string with 0's until it is 64 characters long.
 
 ```js
-import { initLearnCard } from "@learncard/core";
+import { initLearnCard } from '@learncard/core';
 
 const wallet = await initLearnCard({ seed: 'a'.repeat(64) });
 ```
@@ -35,6 +36,7 @@ const wallet = await initLearnCard({ seed: 'a'.repeat(64) });
 ### Issuing/Verifying Credentials and Presentations
 
 #### Issue a credential
+
 ```js
 // Grab a test VC, or create your own!
 const unsignedVc = await wallet.invoke.getTestVc();
@@ -43,6 +45,7 @@ const vc = await wallet.invoke.issueCredential(unsignedVc);
 ```
 
 #### Verify a credential
+
 ```js
 const result = await wallet.invoke.verifyCredential(vc, {}, true);
 
@@ -53,11 +56,13 @@ else console.log('This credential is valid!');
 ```
 
 #### Issue a presentation
+
 ```js
 const vp = await wallet.invoke.issuePresentation(vc);
 ```
 
 #### Verify a presentation
+
 ```js
 const result = await wallet.invoke.verifyPresentation(vp);
 
@@ -74,14 +79,14 @@ else console.log('This presentation is valid!');
 To maintain co-ownership of credentials, it is best to store credentials in a public place, and then
 store references to that public place. While this is not the only way to store credentials (and is
 also definitely not a silver bullet! E.g. credentials containing private data), it is the opinion of
-this library that it should be used by default. As a result, instantiating a wallet, will 
-automatically connect you to WeLibrary's ceramic node, and allow you to publish and retrieve 
+this library that it should be used by default. As a result, instantiating a wallet, will
+automatically connect you to WeLibrary's ceramic node, and allow you to publish and retrieve
 credentials there using IDX.
 
 #### Publish Credential
 
 After signing a VC, you may choose to publish that credential to Ceramic. Doing so will return a
-stream ID, which you may share to the recipient. That stream ID can then be used to resolve the 
+stream ID, which you may share to the recipient. That stream ID can then be used to resolve the
 issued credential. This means both the issuer and recipient may store the _stream ID_ instead of the
 credential itself.
 
@@ -126,6 +131,7 @@ const vcs = await Promise.all(uris.map(async uri => wallet.read.get(uri)));
 ```
 
 ## Contributing
+
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
 
 Please make sure to update tests as appropriate.
@@ -134,7 +140,6 @@ Please make sure to update tests as appropriate.
 
 **[Learning Economy Foundation (LEF)](https://www.learningeconomy.io)** is a 501(c)(3) non-profit organization leveraging global standards and web3 protocols to bring quality skills and equal opportunity to every human on earth, and address the persistent inequities that exist around the globe in education and employment. We help you build the future of education and work with:
 
-
 ## License
 
 MIT © [Learning Economy Foundation](https://github.com/Learning-Economy-Foundation)

package/package.json

@@ -1,59 +1,67 @@
 {
-  "name": "@learncard/didkit-plugin",
-  "version": "1.9.3",
-  "description": "",
-  "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/didkit-plugin.esm.js",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/didkit-plugin.esm.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
+    "name": "@learncard/didkit-plugin",
+    "version": "1.9.5",
+    "description": "",
+    "type": "module",
+    "main": "./dist/index.cjs",
+    "module": "./dist/didkit-plugin.esm.js",
+    "exports": {
+        ".": {
+            "development": "./src/index.ts",
+            "import": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/didkit-plugin.esm.js"
+            },
+            "require": {
+                "types": "./dist/index.d.cts",
+                "default": "./dist/index.cjs"
+            }
+        },
+        "./dist/didkit_wasm_bg.wasm": {
+            "development": "./src/didkit/pkg/didkit_wasm_bg.wasm",
+            "default": "./dist/didkit_wasm_bg.wasm"
+        },
+        "./dist/didkit/didkit_wasm_bg.wasm": {
+            "development": "./src/didkit/pkg/didkit_wasm_bg.wasm",
+            "default": "./dist/didkit/didkit_wasm_bg.wasm"
+        }
     },
-    "./dist/didkit_wasm_bg.wasm": "./dist/didkit_wasm_bg.wasm",
-    "./dist/didkit/didkit_wasm_bg.wasm": "./dist/didkit/didkit_wasm_bg.wasm"
-  },
-  "files": [
-    "dist"
-  ],
-  "author": "Learning Economy Foundation (www.learningeconomy.io)",
-  "license": "MIT",
-  "homepage": "https://github.com/learningeconomy/LearnCard/tree/main/packages/plugins/didkit/README.md",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/learningeconomy/LearnCard"
-  },
-  "bugs": {
-    "url": "https://github.com/learningeconomy/LearnCard/issues"
-  },
-  "devDependencies": {
-    "@types/jest": "^29.2.2",
-    "@types/node": "^17.0.31",
-    "aqu": "0.4.3",
-    "dids": "^3.2.0",
-    "esbuild": "^0.27.1",
-    "esbuild-jest": "^0.5.0",
-    "esbuild-plugin-copy": "^1.6.0",
-    "jest": "^29.3.0",
-    "shx": "^0.3.4",
-    "ts-jest": "^29.0.3"
-  },
-  "types": "./dist/index.d.ts",
-  "dependencies": {
-    "@learncard/core": "9.4.23",
-    "@learncard/types": "5.17.3"
-  },
-  "sideEffects": false,
-  "scripts": {
-    "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.cjs && tsc --p tsconfig.json && shx cp ./dist/index.d.ts ./dist/index.d.cts",
-    "test": "jest --passWithNoTests",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --silent --ci --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\""
-  }
-}
+    "files": [
+        "dist",
+        "src"
+    ],
+    "scripts": {
+        "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.cjs && tsc --p tsconfig.json && shx cp ./dist/index.d.ts ./dist/index.d.cts",
+        "test": "jest --passWithNoTests",
+        "test:watch": "jest --watch",
+        "test:coverage": "jest --silent --ci --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\""
+    },
+    "author": "Learning Economy Foundation (www.learningeconomy.io)",
+    "license": "MIT",
+    "homepage": "https://github.com/learningeconomy/LearnCard/tree/main/packages/plugins/didkit/README.md",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/learningeconomy/LearnCard"
+    },
+    "bugs": {
+        "url": "https://github.com/learningeconomy/LearnCard/issues"
+    },
+    "devDependencies": {
+        "@types/jest": "^29.2.2",
+        "@types/node": "^17.0.31",
+        "aqu": "0.4.3",
+        "dids": "^3.2.0",
+        "esbuild": "^0.27.1",
+        "esbuild-jest": "^0.5.0",
+        "esbuild-plugin-copy": "^1.6.0",
+        "jest": "^29.3.0",
+        "shx": "^0.3.4",
+        "ts-jest": "^29.0.3"
+    },
+    "types": "./dist/index.d.ts",
+    "dependencies": {
+        "@learncard/core": "workspace:*",
+        "@learncard/types": "workspace:*"
+    },
+    "sideEffects": false
+}

package/src/didkit/index.ts

@@ -0,0 +1,31 @@
+import _init, { InitInput } from './pkg/didkit_wasm';
+
+export * from './pkg/didkit_wasm';
+
+let initialized = false;
+let generating = false; // Mutex flag to allow first init call to acquire a lock
+
+export const init = async (
+    arg: InitInput | Promise<InitInput> = 'https://cdn.filestackcontent.com/6v059q3KQlmXd6XoVPyC'
+) => {
+    // Do not return until we are done generating!
+    while (generating) await new Promise(res => setTimeout(res, 250));
+
+    // allow calling multiple times without reinitializing
+    if (initialized) return;
+
+    try {
+        generating = true;
+
+        await _init({ module_or_path: arg });
+
+        generating = false;
+        initialized = true;
+    } catch (error) {
+        generating = false;
+
+        throw error;
+    }
+};
+
+export default init;

package/src/didkit/pkg/didkit_wasm.d.ts

@@ -0,0 +1,112 @@
+/* tslint:disable */
+/* eslint-disable */
+export function verifyInvocationSignature(invocation: string): Promise<any>;
+export function keyToDID(method_pattern: string, jwk: string): string;
+export function completeDelegateCapability(capability: string, preparation: string, signature: string): Promise<any>;
+export function keyToVerificationMethod(method_pattern: string, jwk: string): Promise<any>;
+export function prepareIssueCredential(credential: string, linked_data_proof_options: string, public_key: string): Promise<any>;
+export function invokeCapability(invocation: string, target_id: string, linked_data_proof_options: string, key: string): Promise<any>;
+export function generateSecp256k1KeyFromBytes(bytes: Uint8Array): string;
+export function completeIssueCredential(credential: string, preparation: string, signature: string): Promise<any>;
+export function generateSecp256k1Key(): string;
+export function delegateCapability(capability: string, linked_data_proof_options: string, parents: string, key: string): Promise<any>;
+export function prepareDelegateCapability(capability: string, linked_data_proof_options: string, parents: string, public_key: string): Promise<any>;
+export function createDagJwe(cleartext: any, recipients: string[]): Promise<any>;
+export function completeInvokeCapability(invocation: string, preparation: string, signature: string): Promise<any>;
+export function verifyDelegation(delegation: string): Promise<any>;
+export function didToVerificationMethod(did: string): Promise<any>;
+export function verifyPresentation(vp: string, proof_options: string, context_map: string): Promise<any>;
+export function prepareIssuePresentation(presentation: string, linked_data_proof_options: string, public_key: string): Promise<any>;
+export function issueCredential(credential: string, proof_options: string, key: string, context_map: string): Promise<any>;
+export function didResolver(did: string, input_metadata: string): Promise<any>;
+export function createJwe(cleartext: string, recipients: string[]): Promise<any>;
+export function prepareInvokeCapability(invocation: string, target_id: string, linked_data_proof_options: string, public_key: string): Promise<any>;
+export function decryptJwe(jwe: string, jwks: string[]): Promise<any>;
+export function JWKFromTezos(tz: string): Promise<any>;
+export function generateEd25519Key(): string;
+export function issuePresentation(presentation: string, proof_options: string, key: string, context_map: string): Promise<any>;
+export function clearCache(): Promise<any>;
+export function verifyCredential(vc: string, proof_options: string, context_map: string): Promise<any>;
+export function resolveDID(did: string, input_metadata: string): Promise<any>;
+export function contextLoader(url: string): Promise<any>;
+export function verifyInvocation(invocation: string, delegation: string): Promise<any>;
+export function generateEd25519KeyFromBytes(bytes: Uint8Array): string;
+export function decryptDagJwe(jwe: string, jwks: string[]): Promise<any>;
+export function DIDAuth(holder: string, linked_data_proof_options: string, key: string, context_map: string): Promise<any>;
+export function completeIssuePresentation(presentation: string, preparation: string, signature: string): Promise<any>;
+export function getVersion(): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly DIDAuth: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => any;
+  readonly JWKFromTezos: (a: number, b: number) => any;
+  readonly clearCache: () => any;
+  readonly completeDelegateCapability: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
+  readonly completeInvokeCapability: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
+  readonly completeIssueCredential: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
+  readonly completeIssuePresentation: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
+  readonly contextLoader: (a: number, b: number) => any;
+  readonly createDagJwe: (a: any, b: number, c: number) => any;
+  readonly createJwe: (a: number, b: number, c: number, d: number) => any;
+  readonly decryptDagJwe: (a: number, b: number, c: number, d: number) => any;
+  readonly decryptJwe: (a: number, b: number, c: number, d: number) => any;
+  readonly delegateCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => any;
+  readonly didResolver: (a: number, b: number, c: number, d: number) => any;
+  readonly didToVerificationMethod: (a: number, b: number) => any;
+  readonly generateEd25519Key: () => [number, number, number, number];
+  readonly generateEd25519KeyFromBytes: (a: number, b: number) => [number, number, number, number];
+  readonly generateSecp256k1Key: () => [number, number, number, number];
+  readonly generateSecp256k1KeyFromBytes: (a: number, b: number) => [number, number, number, number];
+  readonly getVersion: () => [number, number];
+  readonly invokeCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => any;
+  readonly issueCredential: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => any;
+  readonly issuePresentation: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => any;
+  readonly keyToDID: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+  readonly keyToVerificationMethod: (a: number, b: number, c: number, d: number) => any;
+  readonly prepareDelegateCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => any;
+  readonly prepareInvokeCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => any;
+  readonly prepareIssueCredential: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
+  readonly prepareIssuePresentation: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
+  readonly resolveDID: (a: number, b: number, c: number, d: number) => any;
+  readonly verifyCredential: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
+  readonly verifyDelegation: (a: number, b: number) => any;
+  readonly verifyInvocation: (a: number, b: number, c: number, d: number) => any;
+  readonly verifyInvocationSignature: (a: number, b: number) => any;
+  readonly verifyPresentation: (a: number, b: number, c: number, d: number, e: number, f: number) => any;
+  readonly didkit_error_code: () => number;
+  readonly didkit_error_message: () => number;
+  readonly __wbindgen_malloc: (a: number, b: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly __externref_table_alloc: () => number;
+  readonly __wbindgen_export_4: WebAssembly.Table;
+  readonly __wbindgen_export_5: WebAssembly.Table;
+  readonly __externref_table_dealloc: (a: number) => void;
+  readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+  readonly closure4149_externref_shim: (a: number, b: number, c: any) => void;
+  readonly closure4546_externref_shim: (a: number, b: number, c: any, d: any) => void;
+  readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+/**
+* Instantiates the given `module`, which can either be bytes or
+* a precompiled `WebAssembly.Module`.
+*
+* @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+*
+* @returns {InitOutput}
+*/
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;