@learncard/core 6.2.0 → 6.3.1

package/dist/core.d.ts

@@ -4662,16 +4662,28 @@ declare const IDXCredentialValidator: z.ZodObject<{
 }>;
 /** @group IDXPlugin */
 export declare type IDXCredential = z.infer<typeof IDXCredentialValidator>;
-/** @group DIDKit Plugin */
-export declare type DidMethod = "key" | "tz" | "ethr" | `pkh:${"tz" | "tezos" | "sol" | "solana" | "eth" | "celo" | "poly" | "btc" | "doge" | "eip155" | "bip122"}` | `pkh:eip155:${string}` | `pkh:bip122:${string}`;
-/** @group DIDKit Plugin */
-export declare type KeyPair = {
+declare const JWKValidator: z.ZodObject<{
+	kty: z.ZodString;
+	crv: z.ZodString;
+	x: z.ZodString;
+	y: z.ZodOptional<z.ZodString>;
+	d: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+	y?: string | undefined;
 	kty: string;
 	crv: string;
 	x: string;
-	y?: string;
 	d: string;
-};
+}, {
+	y?: string | undefined;
+	kty: string;
+	crv: string;
+	x: string;
+	d: string;
+}>;
+export declare type JWK = z.infer<typeof JWKValidator>;
+/** @group DIDKit Plugin */
+export declare type DidMethod = "key" | "tz" | "ethr" | `pkh:${"tz" | "tezos" | "sol" | "solana" | "eth" | "celo" | "poly" | "btc" | "doge" | "eip155" | "bip122"}` | `pkh:eip155:${string}` | `pkh:bip122:${string}`;
 /** @group DIDKit Plugin */
 export declare type ProofOptions = {
 	type?: string;
@@ -4691,13 +4703,13 @@ export declare type InputMetadata = {
 };
 /** @group DIDKit Plugin */
 export declare type DidkitPluginMethods = {
-	generateEd25519KeyFromBytes: (bytes: Uint8Array) => KeyPair;
-	generateSecp256k1KeyFromBytes: (bytes: Uint8Array) => KeyPair;
-	keyToDid: (type: DidMethod, keypair: KeyPair) => string;
-	keyToVerificationMethod: (type: string, keypair: KeyPair) => Promise<string>;
-	issueCredential: (credential: UnsignedVC, options: ProofOptions, keypair: KeyPair) => Promise<VC>;
+	generateEd25519KeyFromBytes: (bytes: Uint8Array) => JWK;
+	generateSecp256k1KeyFromBytes: (bytes: Uint8Array) => JWK;
+	keyToDid: (type: DidMethod, keypair: JWK) => string;
+	keyToVerificationMethod: (type: string, keypair: JWK) => Promise<string>;
+	issueCredential: (credential: UnsignedVC, options: ProofOptions, keypair: JWK) => Promise<VC>;
 	verifyCredential: (credential: VC, options?: ProofOptions) => Promise<VerificationCheck>;
-	issuePresentation: (presentation: UnsignedVP, options: ProofOptions, keypair: KeyPair) => Promise<VP>;
+	issuePresentation: (presentation: UnsignedVP, options: ProofOptions, keypair: JWK) => Promise<VP>;
 	verifyPresentation: (presentation: VP, options?: ProofOptions) => Promise<VerificationCheck>;
 	contextLoader: (url: string) => Promise<Record<string, any>>;
 	resolveDid: (did: string, inputMetadata?: InputMetadata) => Promise<Record<string, any>>;
@@ -4706,37 +4718,14 @@ export declare type DidkitPluginMethods = {
 export declare type Algorithm = "ed25519" | "secp256k1";
 /** @group DidKey Plugin */
 export declare type DependentMethods<T extends string> = {
-	generateEd25519KeyFromBytes: (bytes: Uint8Array) => KeyPair;
-	generateSecp256k1KeyFromBytes: (bytes: Uint8Array) => KeyPair;
-	keyToDid: (type: T, keypair: KeyPair) => string;
-};
-/** @group DidKey Plugin */
-export declare type JWK = {
-	id: string;
-	type: string | string[];
-	controller?: string;
-	publicKeyJwk?: any;
-	privateKeyJwk?: any;
-	"@context": string[];
-	name: string;
-	image: string;
-	description: string;
-	tags: string[];
-	value?: string;
-	generatedFrom?: [
-		string
-	];
+	generateEd25519KeyFromBytes: (bytes: Uint8Array) => JWK;
+	generateSecp256k1KeyFromBytes: (bytes: Uint8Array) => JWK;
+	keyToDid: (type: T, keypair: JWK) => string;
 };
 /** @group DidKey Plugin */
 export declare type DidKeyPluginMethods<DidMethod extends string> = {
 	getSubjectDid: (type: DidMethod) => string;
-	getSubjectKeypair: (type?: Algorithm) => {
-		kty: string;
-		crv: string;
-		x: string;
-		y?: string;
-		d: string;
-	};
+	getSubjectKeypair: (type?: Algorithm) => JWK;
 	getKey: () => string;
 };
 /** @group Ethereum Plugin */
@@ -4851,11 +4840,11 @@ export declare type Wallet<PluginNames extends string = "", PluginMethods extend
 /** @group VC Plugin */
 export declare type VCPluginDependentMethods = {
 	getSubjectDid: (type: "key") => string;
-	getSubjectKeypair: () => KeyPair;
-	keyToVerificationMethod: (type: string, keypair: KeyPair) => Promise<string>;
-	issueCredential: (credential: UnsignedVC, options: ProofOptions, keypair: KeyPair) => Promise<VC>;
+	getSubjectKeypair: () => JWK;
+	keyToVerificationMethod: (type: string, keypair: JWK) => Promise<string>;
+	issueCredential: (credential: UnsignedVC, options: ProofOptions, keypair: JWK) => Promise<VC>;
 	verifyCredential: (credential: VC, options?: ProofOptions) => Promise<VerificationCheck>;
-	issuePresentation: (presentation: UnsignedVP, options: ProofOptions, keypair: KeyPair) => Promise<VP>;
+	issuePresentation: (presentation: UnsignedVP, options: ProofOptions, keypair: JWK) => Promise<VP>;
 	verifyPresentation: (presentation: VP, options?: ProofOptions) => Promise<VerificationCheck>;
 };
 /** @group VC Plugin */
@@ -4963,14 +4952,14 @@ export declare type CHAPIPluginMethods = {
 		success: false;
 		reason: "did not auth" | "auth failed verification" | "did not store";
 	}>;
-	storePresentationViaChapi: (presentation: VP) => Promise<Credential | undefined>;
+	storePresentationViaChapi: (presentation: UnsignedVP | VP) => Promise<Credential | undefined>;
 };
 /**
  * @group Plugins
  */
 export declare const getCHAPIPlugin: () => Promise<Plugin<"CHAPI", CHAPIPluginMethods, CHAPIPluginDependentMethods>>;
-export declare type InitFunction<Args extends Record<string, any> | undefined = Record<string, any>, Config extends keyof LearnCardConfig = keyof LearnCardConfig, ReturnValue extends LearnCard<any, any> = LearnCard<any, any>> = {
-	args: undefined extends Args ? Partial<Pick<LearnCardConfig, Config>> : Args & Partial<Pick<LearnCardConfig, Config>>;
+export declare type InitFunction<Args extends Record<string, any> = Record<string, any>, Config extends keyof LearnCardConfig = keyof LearnCardConfig, ReturnValue extends LearnCard<any, any> = LearnCard<any, any>> = {
+	args: Args & Partial<Pick<LearnCardConfig, Config>>;
 	returnValue: ReturnValue;
 };
 export declare type GenericInitFunction<InitFunctions extends InitFunction<any, any, any>[]> = {
@@ -5008,6 +4997,22 @@ export declare type VCTemplatePluginMethods = {
 		did?: string;
 	}) => Promise<UnsignedVP>;
 };
+/** @group VC-API Plugin */
+export declare type APIOptions = {
+	created?: string;
+	challenge?: string;
+	domain?: string;
+};
+/** @group VC-API Plugin */
+export declare 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>;
+};
 /**
  * Wallet holder's did
  *
@@ -5307,6 +5312,15 @@ export declare type EmptyLearnCard = LearnCard<"newCredential" | "newPresentatio
 	VCTemplatePluginMethods,
 	CHAPIPluginMethods
 ]>>>;
+/**
+ * @group LearnCard
+ */
+export declare type VCAPILearnCard = LearnCard<"did" | "newCredential" | "newPresentation" | "issueCredential" | "verifyCredential" | "issuePresentation" | "verifyPresentation" | "getTestVc" | "getTestVp" | "installChapiHandler" | "activateChapiHandler" | "receiveChapiEvent" | "storePresentationViaChapi" | "storeCredentialViaChapiDidAuth", Wallet<"VC API" | "Expiration" | "VC Templates" | "CHAPI", MergeObjects<[
+	VCAPIPluginMethods,
+	VerifyExtension,
+	VCTemplatePluginMethods,
+	CHAPIPluginMethods
+]>>>;
 /** @group LearnCard */
 export declare type LearnCardConfig = {
 	ceramicIdx: CeramicIDXArgs;
@@ -5315,15 +5329,21 @@ export declare type LearnCardConfig = {
 	ethereumConfig: EthereumConfig;
 };
 /** @group Init Functions */
-export declare type EmptyWallet = InitFunction<undefined, "didkit", EmptyLearnCard>;
+export declare type EmptyWallet = InitFunction<{}, "didkit", EmptyLearnCard>;
 /** @group Init Functions */
 export declare type WalletFromKey = InitFunction<{
 	seed: string;
 }, keyof LearnCardConfig, LearnCard>;
 /** @group Init Functions */
+export declare type WalletFromVcApi = InitFunction<{
+	vcApi: true | string;
+	did?: string;
+}, "defaultContents", VCAPILearnCard>;
+/** @group Init Functions */
 export declare type InitLearnCard = GenericInitFunction<[
 	EmptyWallet,
-	WalletFromKey
+	WalletFromKey,
+	WalletFromVcApi
 ]>;
 /**
  * Generates an empty wallet with no key material
@@ -5337,6 +5357,12 @@ export declare const emptyWallet: ({ didkit }?: EmptyWallet["args"]) => Promise<
  * @group Init Functions
  */
 export declare const walletFromKey: (key: string, { ceramicIdx, didkit, defaultContents, ethereumConfig, }?: Partial<LearnCardConfig>) => Promise<LearnCard>;
+/**
+ * Generates a LearnCard Wallet from a 64 character seed string
+ *
+ * @group Init Functions
+ */
+export declare const walletFromApiUrl: (url: string, did?: string, { defaultContents }?: Partial<LearnCardConfig>) => Promise<WalletFromVcApi["returnValue"]>;
 /**
  * Generates an Empty Wallet
  *
@@ -5349,8 +5375,12 @@ export declare function initLearnCard(config?: EmptyWallet["args"]): Promise<Emp
  * @group Init Functions
  */
 export declare function initLearnCard(config: WalletFromKey["args"]): Promise<WalletFromKey["returnValue"]>;
-export declare const passwordToKey: (password: string, salt?: string, iterations?: number, digest?: string) => Promise<Uint8Array>;
-export declare const seedToId: (seed: Uint8Array) => Promise<string>;
+/**
+ * Generates a wallet that can sign VCs/VPs from a VC API
+ *
+ * @group Init Functions
+ */
+export declare function initLearnCard(config: WalletFromVcApi["args"]): Promise<WalletFromVcApi["returnValue"]>;
 /** @group Universal Wallets */
 export declare const generateWallet: <PluginNames extends string, PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>>(contents?: any[], _wallet?: Partial<Wallet<any, PluginMethods>>) => Promise<Wallet<PluginNames, PluginMethods>>;
 /**
@@ -5382,7 +5412,7 @@ export declare const ExpirationPlugin: (wallet: Wallet<any, VerifyExtension>) =>
  */
 export declare const getEthereumPlugin: (initWallet: Wallet<string, {
 	getSubjectDid: (type: DidMethod) => string;
-	getSubjectKeypair: (type?: Algorithm) => KeyPair;
+	getSubjectKeypair: (type?: Algorithm) => JWK;
 }>, config: EthereumConfig) => Plugin<"Ethereum", EthereumPluginMethods>;
 /**
  * @group Plugins

package/dist/core.esm.js

@@ -36939,34 +36939,6 @@ import "abort-controller/polyfill";
 import crypto2 from "isomorphic-webcrypto";
 if (typeof window === "undefined" && !globalThis.crypto)
   globalThis.crypto = crypto2;
-var crypto_default = crypto2;
-
-// src/wallet/base/functions/passwordToKey.ts
-var passwordToKey = /* @__PURE__ */ __name((password, salt = "salt", iterations = 1e5, digest2 = "SHA-256") => __async(void 0, null, function* () {
-  var saltBuffer = Buffer.from(salt);
-  var passphraseKey = Buffer.from(password);
-  return crypto_default.subtle.importKey("raw", passphraseKey, { name: "PBKDF2" }, false, [
-    "deriveBits",
-    "deriveKey"
-  ]).then(function(key2) {
-    return crypto_default.subtle.deriveKey({
-      name: "PBKDF2",
-      salt: saltBuffer,
-      iterations,
-      hash: digest2
-    }, key2, { name: "AES-CBC", length: 256 }, true, ["encrypt", "decrypt"]);
-  }).then((webKey) => {
-    return crypto_default.subtle.exportKey("raw", webKey);
-  }).then((buffer2) => {
-    return new Uint8Array(buffer2);
-  });
-}), "passwordToKey");
-
-// src/wallet/base/functions/seedToId.ts
-var seedToId = /* @__PURE__ */ __name((seed) => __async(void 0, null, function* () {
-  const buffer2 = yield crypto_default.subtle.digest("SHA-256", seed);
-  return `urn:digest:${Buffer.from(new Int8Array(buffer2)).toString("hex")}`;
-}), "seedToId");
 
 // src/wallet/base/wallet.ts
 var addPluginToWallet = /* @__PURE__ */ __name((wallet, plugin) => __async(void 0, null, function* () {
@@ -39240,7 +39212,8 @@ var getCHAPIPlugin = /* @__PURE__ */ __name(() => __async(void 0, null, function
           return { success: false, reason: "did not auth" };
         const verification = yield wallet.pluginMethods.verifyPresentation(res.data, {
           challenge,
-          domain
+          domain,
+          proofPurpose: "authentication"
         });
         if (verification.warnings.length > 0 || verification.errors.length > 0) {
           return { success: false, reason: "auth failed verification" };
@@ -39249,7 +39222,7 @@ var getCHAPIPlugin = /* @__PURE__ */ __name(() => __async(void 0, null, function
         if (!Array.isArray(credential.credentialSubject)) {
           credential.credentialSubject.id = subject;
         }
-        const vp = yield wallet.pluginMethods.issuePresentation(yield wallet.pluginMethods.getTestVp(yield wallet.pluginMethods.issueCredential(credential)));
+        const vp = yield wallet.pluginMethods.getTestVp(yield wallet.pluginMethods.issueCredential(credential));
         const success = yield wallet.pluginMethods.storePresentationViaChapi(vp);
         if (success)
           return { success: true };
@@ -42400,6 +42373,13 @@ var IDXCredentialValidator = mod.object({
   title: mod.string(),
   storageType: StorageTypeValidator.optional()
 });
+var JWKValidator = mod.object({
+  kty: mod.string(),
+  crv: mod.string(),
+  x: mod.string(),
+  y: mod.string().optional(),
+  d: mod.string()
+});
 
 // ../../node_modules/.pnpm/date-fns@2.28.0/node_modules/date-fns/esm/_lib/toInteger/index.js
 function toInteger(dirtyNumber) {
@@ -60375,11 +60355,131 @@ var walletFromKey = /* @__PURE__ */ __name((_0, ..._1) => __async(void 0, [_0, .
   };
 }), "walletFromKey");
 
+// src/wallet/plugins/vc-api/helpers.ts
+var post = /* @__PURE__ */ __name((url, data) => __async(void 0, null, function* () {
+  return fetch(url, {
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    body: JSON.stringify(data)
+  });
+}), "post");
+var isSuccessful = /* @__PURE__ */ __name((status) => status.toString().startsWith("2"), "isSuccessful");
+
+// src/wallet/plugins/vc-api/index.ts
+var getVCAPIPlugin = /* @__PURE__ */ __name((_0) => __async(void 0, [_0], function* ({
+  url: _url,
+  did: _did
+}) {
+  const url = _url.endsWith("/") ? _url.slice(0, -1) : _url;
+  let did = _did;
+  if (!did) {
+    const res = yield fetch(`${url}/did`);
+    if (res.status === 200)
+      did = yield res.text();
+  }
+  if (!did)
+    throw new Error("Could not retrieve did from VC API! Please suppy a did.");
+  return {
+    pluginMethods: {
+      getSubjectDid: () => did,
+      issueCredential: (_wallet, credential, options) => __async(void 0, null, function* () {
+        yield UnsignedVCValidator.parseAsync(credential);
+        const response = yield post(`${url}/credentials/issue`, { credential, options });
+        if (!isSuccessful(response.status)) {
+          throw new Error(`API Error: ${response.status} ${response.statusText}`);
+        }
+        return VCValidator.parseAsync(yield response.json());
+      }),
+      verifyCredential: (_wallet, verifiableCredential, options) => __async(void 0, null, function* () {
+        yield VCValidator.parseAsync(verifiableCredential);
+        const response = yield post(`${url}/credentials/verify`, {
+          verifiableCredential,
+          options
+        });
+        if (!isSuccessful(response.status)) {
+          throw new Error(`API Error: ${response.status} ${response.statusText}`);
+        }
+        return VerificationCheckValidator.parseAsync(yield response.json());
+      }),
+      issuePresentation: (_wallet, presentation, options) => __async(void 0, null, function* () {
+        yield UnsignedVPValidator.parseAsync(presentation);
+        const response = yield post(`${url}/presentations/issue`, {
+          presentation,
+          options
+        });
+        if (!isSuccessful(response.status)) {
+          throw new Error(`API Error: ${response.status} ${response.statusText}`);
+        }
+        return VPValidator.parseAsync(yield response.json());
+      }),
+      verifyPresentation: (_wallet, verifiablePresentation, options) => __async(void 0, null, function* () {
+        yield VPValidator.parseAsync(verifiablePresentation);
+        const response = yield post(`${url}/presentations/verify`, {
+          verifiablePresentation,
+          options
+        });
+        if (!isSuccessful(response.status)) {
+          throw new Error(`API Error: ${response.status} ${response.statusText}`);
+        }
+        return VerificationCheckValidator.parseAsync(yield response.json());
+      }),
+      getTestVc: (_wallet, subject = "did:example:d23dd687a7dc6787646f2eb98d0") => {
+        return {
+          "@context": ["https://www.w3.org/2018/credentials/v1"],
+          id: "http://example.org/credentials/3731",
+          type: ["VerifiableCredential"],
+          issuer: did,
+          issuanceDate: "2020-08-19T21:41:50Z",
+          credentialSubject: { id: subject }
+        };
+      },
+      getTestVp: (_wallet, _credential) => __async(void 0, null, function* () {
+        const credential = _credential || (yield _wallet.pluginMethods.issueCredential(_wallet.pluginMethods.getTestVc()));
+        return {
+          "@context": ["https://www.w3.org/2018/credentials/v1"],
+          type: ["VerifiablePresentation"],
+          holder: did,
+          verifiableCredential: credential
+        };
+      })
+    }
+  };
+}), "getVCAPIPlugin");
+
+// src/wallet/initializers/apiWallet.ts
+var walletFromApiUrl = /* @__PURE__ */ __name((_0, _1, ..._2) => __async(void 0, [_0, _1, ..._2], function* (url, did, { defaultContents = [] } = {}) {
+  const apiWallet = yield (yield generateWallet(defaultContents)).addPlugin(yield getVCAPIPlugin({ url, did }));
+  const expirationWallet = yield apiWallet.addPlugin(ExpirationPlugin(apiWallet));
+  const templateWallet = yield expirationWallet.addPlugin(getVCTemplatesPlugin());
+  const wallet = yield templateWallet.addPlugin(yield getCHAPIPlugin());
+  return {
+    _wallet: wallet,
+    did: (type = "key") => wallet.pluginMethods.getSubjectDid(type),
+    newCredential: wallet.pluginMethods.newCredential,
+    newPresentation: wallet.pluginMethods.newPresentation,
+    issueCredential: wallet.pluginMethods.issueCredential,
+    verifyCredential: verifyCredential2(wallet),
+    issuePresentation: wallet.pluginMethods.issuePresentation,
+    verifyPresentation: wallet.pluginMethods.verifyPresentation,
+    getTestVc: wallet.pluginMethods.getTestVc,
+    getTestVp: wallet.pluginMethods.getTestVp,
+    installChapiHandler: wallet.pluginMethods.installChapiHandler,
+    activateChapiHandler: wallet.pluginMethods.activateChapiHandler,
+    receiveChapiEvent: wallet.pluginMethods.receiveChapiEvent,
+    storePresentationViaChapi: wallet.pluginMethods.storePresentationViaChapi,
+    storeCredentialViaChapiDidAuth: wallet.pluginMethods.storeCredentialViaChapiDidAuth
+  };
+}), "walletFromApiUrl");
+
 // src/wallet/init.ts
 function initLearnCard() {
   return __async(this, arguments, function* (config2 = {}) {
+    if ("vcApi" in config2) {
+      const _a = config2, { vcApi, did } = _a, apiConfig = __objRest(_a, ["vcApi", "did"]);
+      return walletFromApiUrl(typeof vcApi === "string" ? vcApi : "https://bridge.learncard.com", vcApi === true ? "did:key:z6MkjSz4mYqcn7dePGuktJ5PxecMkXQQHWRg8Lm6okATyFVh" : did, apiConfig);
+    }
     if ("seed" in config2) {
-      const _a = config2, { seed } = _a, keyConfig = __objRest(_a, ["seed"]);
+      const _b = config2, { seed } = _b, keyConfig = __objRest(_b, ["seed"]);
       return walletFromKey(seed, keyConfig);
     }
     return emptyWallet(config2);
@@ -60399,8 +60499,7 @@ export {
   getVCPlugin,
   getVpqrPlugin,
   initLearnCard,
-  passwordToKey,
-  seedToId,
+  walletFromApiUrl,
   walletFromKey
 };
 /*!