@learncard/core 6.1.0 → 6.2.0

package/dist/core.d.ts

@@ -5,6 +5,7 @@
 import { StreamID } from '@ceramicnetwork/streamid';
 import { ModelAliases } from '@glazed/types';
 
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 declare const UnsignedVCValidator: z.ZodObject<{
 	"@context": z.ZodArray<z.ZodString, "many">;
 	id: z.ZodOptional<z.ZodString>;
@@ -4673,8 +4674,20 @@ export declare type KeyPair = {
 };
 /** @group DIDKit Plugin */
 export declare type ProofOptions = {
-	verificationMethod: string;
-	proofPurpose: string;
+	type?: string;
+	verificationMethod?: string;
+	proofPurpose?: string;
+	created?: string;
+	challenge?: string;
+	domain?: string;
+	checks?: ("Proof" | "JWS" | "CredentialStatus")[];
+};
+/** @group DIDKit Plugin */
+export declare type InputMetadata = {
+	accept?: string;
+	versionId?: string;
+	versionTime?: string;
+	noCache?: boolean;
 };
 /** @group DIDKit Plugin */
 export declare type DidkitPluginMethods = {
@@ -4683,11 +4696,11 @@ export declare type DidkitPluginMethods = {
 	keyToDid: (type: DidMethod, keypair: KeyPair) => string;
 	keyToVerificationMethod: (type: string, keypair: KeyPair) => Promise<string>;
 	issueCredential: (credential: UnsignedVC, options: ProofOptions, keypair: KeyPair) => Promise<VC>;
-	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
+	verifyCredential: (credential: VC, options?: ProofOptions) => Promise<VerificationCheck>;
 	issuePresentation: (presentation: UnsignedVP, options: ProofOptions, keypair: KeyPair) => Promise<VP>;
-	verifyPresentation: (presentation: VP) => Promise<VerificationCheck>;
+	verifyPresentation: (presentation: VP, options?: ProofOptions) => Promise<VerificationCheck>;
 	contextLoader: (url: string) => Promise<Record<string, any>>;
-	resolveDid: (did: string) => Promise<Record<string, any>>;
+	resolveDid: (did: string, inputMetadata?: InputMetadata) => Promise<Record<string, any>>;
 };
 /** @group DidKey Plugin */
 export declare type Algorithm = "ed25519" | "secp256k1";
@@ -4802,26 +4815,61 @@ export declare const CredentialsListValidator: z.ZodObject<{
 }>;
 /** @group IDXPlugin */
 export declare type CredentialsList = z.infer<typeof CredentialsListValidator>;
+export declare type Last<T extends any[]> = T extends [
+	...any[],
+	infer R
+] ? R : never;
+export declare type RemoveLast<T extends any[]> = T extends [
+	...infer R,
+	any
+] ? R : [
+];
+/** @group Utility Types */
+export declare type MergeObjects<Objects extends Record<string, any>[]> = undefined extends Objects[2] ? Omit<Objects[0], keyof Objects[1]> & Objects[1] : Omit<MergeObjects<RemoveLast<Objects>>, keyof Last<Objects>> & Last<Objects>;
+/** @group Universal Wallets */
+export declare type Plugin<Name extends string, PublicMethods extends Record<string, (...args: any[]) => any> = Record<never, never>, DependentMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
+	name?: Name;
+	pluginMethods: {
+		[Key in keyof PublicMethods]: <T extends Wallet<any, PublicMethods & DependentMethods>>(wallet: T, ...args: Parameters<PublicMethods[Key]>) => ReturnType<PublicMethods[Key]>;
+	};
+};
+/** @group Universal Wallets */
+export declare type PublicFieldsObj<PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
+	pluginMethods: PluginMethods;
+};
+/** @group Universal Wallets */
+export declare type Wallet<PluginNames extends string = "", PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = PublicFieldsObj<PluginMethods> & {
+	contents: any[];
+	plugins: Plugin<PluginNames, Record<string, (...args: any[]) => any>>[];
+	add: (content: any) => Promise<Wallet<PluginNames, PluginMethods>>;
+	remove: (contentId: string) => Promise<Wallet<PluginNames, PluginMethods>>;
+	addPlugin: <Name extends string, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>>(plugin: Plugin<Name, Methods>) => Promise<Wallet<"" extends PluginNames ? Name : PluginNames | Name, Record<never, never> extends PluginMethods ? Methods : MergeObjects<[
+		PluginMethods,
+		Methods
+	]>>>;
+};
 /** @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>;
-	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
+	verifyCredential: (credential: VC, options?: ProofOptions) => Promise<VerificationCheck>;
 	issuePresentation: (presentation: UnsignedVP, options: ProofOptions, keypair: KeyPair) => Promise<VP>;
-	verifyPresentation: (presentation: VP) => Promise<VerificationCheck>;
+	verifyPresentation: (presentation: VP, options?: ProofOptions) => Promise<VerificationCheck>;
 };
 /** @group VC Plugin */
-export declare type VCPluginMethods = VCPluginDependentMethods & {
-	issueCredential: (credential: UnsignedVC) => Promise<VC>;
-	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
-	issuePresentation: (credential: UnsignedVP) => Promise<VP>;
-	verifyPresentation: (presentation: VP) => Promise<VerificationCheck>;
+export declare 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, options?: Partial<ProofOptions>) => Promise<VerificationCheck>;
 	getTestVc: (subject?: string) => UnsignedVC;
 	getTestVp: (credential?: VC) => Promise<UnsignedVP>;
 };
 /** @group VC Plugin */
+export declare type VCImplicitWallet = Wallet<string, VCPluginMethods & VCPluginDependentMethods>;
+/** @group VC Plugin */
 export declare type VerifyExtension = {
 	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
 };
@@ -4834,7 +4882,93 @@ export declare type VpqrPluginMethods = {
 export declare type VpqrPluginDependentMethods = {
 	contextLoader: (url: string) => Promise<Record<string, any>>;
 };
-export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+/** @group CHAPI Plugin */
+export declare type WebCredential = {
+	new (dataType: string, data: VP, options?: {
+		recommendedHandlerOrigins: string[];
+	}): WebCredential;
+	type: string;
+	dataType: string;
+	data: VP;
+	options: {
+		recommendedHandlerOrigins: string[];
+	};
+};
+/** @group CHAPI Plugin */
+export declare type CredentialRequestEvent = {
+	new (args: {
+		credentialHandler: any;
+		credentialRequestOrigin: string;
+		credentialRequestOptions: any;
+		hintKey: string;
+	}): CredentialRequestEvent;
+	type: string;
+	_credentialHandler: any;
+	credentialRequestOrigin: string;
+	credentialRequestOptions: any;
+	hintKey: string;
+	openWindow: (url: string) => Promise<any>;
+	respondWith: (handlerResponse: Promise<null | {
+		dataType: string;
+		data: any;
+	}>) => void;
+};
+/** @group CHAPI Plugin */
+export declare type CredentialStoreEvent = {
+	new (args: {
+		credentialHandler: any;
+		credentialRequestOrigin: string;
+		credential: WebCredential;
+		hintKey: string;
+	}): CredentialStoreEvent;
+	type: string;
+	_credentialHandler: any;
+	credentialRequestOrigin: string;
+	credential: WebCredential;
+	hintKey: string;
+	openWindow: (url: string) => Promise<any>;
+	respondWith: (handlerResponse: Promise<null | {
+		dataType: string;
+		data: any;
+	}>) => void;
+};
+/** @group CHAPI Plugin */
+export declare type HandlerResponse = {
+	type: "redirect";
+	url: string;
+} | {
+	type: "response";
+	dataType: string;
+	data: any;
+};
+/** @group CHAPI Plugin */
+export declare type CHAPIPluginDependentMethods = {
+	issueCredential: (credential: UnsignedVC, signingOptions?: Partial<ProofOptions>) => Promise<VC>;
+	issuePresentation: (credential: UnsignedVP, signingOptions?: Partial<ProofOptions>) => Promise<VP>;
+	verifyPresentation: (presentation: VP, options?: Partial<ProofOptions>) => Promise<VerificationCheck>;
+	getTestVp: (credential?: VC) => Promise<UnsignedVP>;
+};
+/** @group CHAPI Plugin */
+export declare type CHAPIPluginMethods = {
+	installChapiHandler: () => Promise<void>;
+	activateChapiHandler: (args: {
+		mediatorOrigin?: string;
+		get?: (event: CredentialRequestEvent) => Promise<HandlerResponse>;
+		store?: (event: CredentialStoreEvent) => Promise<HandlerResponse>;
+	}) => Promise<void>;
+	receiveChapiEvent: () => Promise<CredentialRequestEvent | CredentialStoreEvent>;
+	storeCredentialViaChapiDidAuth: (credential: UnsignedVC) => Promise<{
+		success: true;
+	} | {
+		success: false;
+		reason: "did not auth" | "auth failed verification" | "did not store";
+	}>;
+	storePresentationViaChapi: (presentation: 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>>;
 	returnValue: ReturnValue;
@@ -4848,25 +4982,6 @@ export declare type DiscriminatedUnionize<T extends object = {}, K extends strin
 		[Key2 in K]: Key;
 	} & T[Key];
 }[keyof T];
-/** @group Universal Wallets */
-export declare type Plugin<Name extends string, PublicMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
-	name?: Name;
-	pluginMethods: {
-		[Key in keyof PublicMethods]: <T extends Wallet<any, PublicMethods>>(wallet: T, ...args: Parameters<PublicMethods[Key]>) => ReturnType<PublicMethods[Key]>;
-	};
-};
-/** @group Universal Wallets */
-export declare type PublicFieldsObj<PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
-	pluginMethods: PluginMethods;
-};
-/** @group Universal Wallets */
-export declare type Wallet<PluginNames extends string = "", PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = PublicFieldsObj<PluginMethods> & {
-	contents: any[];
-	plugins: Plugin<PluginNames, Record<string, (...args: any[]) => any>>[];
-	add: (content: any) => Promise<Wallet<PluginNames, PluginMethods>>;
-	remove: (contentId: string) => Promise<Wallet<PluginNames, PluginMethods>>;
-	addPlugin: <Name extends string, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>>(plugin: Plugin<Name, Methods>) => Promise<Wallet<"" extends PluginNames ? Name : PluginNames | Name, Record<never, never> extends PluginMethods ? Methods : PluginMethods & Methods>>;
-};
 /** @group VC Templates Plugin */
 export declare type VcTemplates = {
 	basic: {
@@ -4888,7 +5003,6 @@ export declare type VcTemplates = {
 export declare type NewCredentialFunction = (args?: DiscriminatedUnionize<VcTemplates>) => UnsignedVC;
 /** @group VC Templates Plugin */
 export declare type VCTemplatePluginMethods = {
-	getSubjectDid?: (type: "key") => string;
 	newCredential: NewCredentialFunction;
 	newPresentation: (credential: VC, args?: {
 		did?: string;
@@ -4931,7 +5045,7 @@ export declare type NewPresentation = (credential: VC, args?: {
  *
  * @group LearnCard Methods
  */
-export declare type IssueCredential = (credential: UnsignedVC) => Promise<VC>;
+export declare type IssueCredential = (credential: UnsignedVC, signingOptions?: Partial<ProofOptions>) => Promise<VC>;
 /**
  * Verifies a signed Verifiable Credential
  *
@@ -4939,13 +5053,13 @@ export declare type IssueCredential = (credential: UnsignedVC) => Promise<VC>;
  *
  * @group LearnCard Methods
  */
-export declare type VerifyCredential = (credential: VC) => Promise<VerificationItem[]>;
+export declare type VerifyCredential = (credential: VC, options?: Partial<ProofOptions>) => Promise<VerificationItem[]>;
 /**
  * Signs an unsigned Verifiable Presentation, returning the signed VP
  *
  * @group LearnCard Methods
  */
-export declare type IssuePresentation = (presentation: UnsignedVP) => Promise<VP>;
+export declare type IssuePresentation = (presentation: UnsignedVP, signingOptions?: Partial<ProofOptions>) => Promise<VP>;
 /**
  * Verifies a signed Verifiable Presentation
  *
@@ -4953,7 +5067,7 @@ export declare type IssuePresentation = (presentation: UnsignedVP) => Promise<VP
  *
  * @group LearnCard Methods
  */
-export declare type VerifyPresentation = (presentation: VP) => Promise<VerificationCheck>;
+export declare type VerifyPresentation = (presentation: VP, options?: Partial<ProofOptions>) => Promise<VerificationCheck>;
 /**
  * Returns the credential marked with `title` from IDX
  *
@@ -5007,7 +5121,7 @@ export declare type RemoveCredential = (title: string) => Promise<void>;
  *
  * @group LearnCard Methods
  */
-export declare type ResolveDid = (did: string) => Promise<Record<string, any>>;
+export declare type ResolveDid = (did: string, inputMetadata?: InputMetadata) => Promise<Record<string, any>>;
 /**
  * Resolves a stream ID, returning its contents
  *
@@ -5091,6 +5205,45 @@ export declare type VpFromQrCode = (text: string) => Promise<VP>;
  * @group LearnCard Methods
  */
 export declare type VpToQrCode = (vp: VP) => Promise<string>;
+/**
+ * Sets up CHAPI
+ *
+ * @group LearnCard Methods
+ */
+export declare type InstallChapiHandler = () => Promise<void>;
+/**
+ * Activates CHAPI
+ *
+ * @group LearnCard Methods
+ */
+export declare type ActivateChapiHandler = (args: {
+	mediatorOrigin?: string;
+	get?: (event: CredentialRequestEvent) => Promise<HandlerResponse>;
+	store?: (event: CredentialStoreEvent) => Promise<HandlerResponse>;
+}) => Promise<void>;
+/**
+ * Receives a CHAPI Event
+ *
+ * @group LearnCard Methods
+ */
+export declare type ReceiveChapiEvent = () => Promise<CredentialRequestEvent | CredentialStoreEvent>;
+/**
+ * Stores a VP via CHAPI
+ *
+ * @group LearnCard Methods
+ */
+export declare type StorePresentationViaChapi = (presentation: VP) => Promise<Credential | undefined>;
+/**
+ * Stores a Credential via CHAPI using DIDAuth
+ *
+ * @group LearnCard Methods
+ */
+export declare type StoreCredentialViaChapiDidAuth = (credential: UnsignedVC) => Promise<{
+	success: true;
+} | {
+	success: false;
+	reason: "did not auth" | "auth failed verification" | "did not store";
+}>;
 /**
  * @group LearnCard Methods
  */
@@ -5122,9 +5275,22 @@ export declare type AllLearnCardMethods = {
 	addInfuraProjectId: AddInfuraProjectId;
 	vpFromQrCode: VpFromQrCode;
 	vpToQrCode: VpToQrCode;
+	installChapiHandler: InstallChapiHandler;
+	activateChapiHandler: ActivateChapiHandler;
+	receiveChapiEvent: ReceiveChapiEvent;
+	storePresentationViaChapi: StorePresentationViaChapi;
+	storeCredentialViaChapiDidAuth: StoreCredentialViaChapiDidAuth;
 };
 /** @group Universal Wallets */
-export declare type LearnCardRawWallet = Wallet<"DIDKit" | "DID Key" | "VC" | "VC Templates" | "IDX" | "Expiration" | "Ethereum" | "Vpqr", DidKeyPluginMethods<DidMethod> & VCPluginMethods & VCTemplatePluginMethods & IDXPluginMethods & EthereumPluginMethods & VpqrPluginMethods>;
+export declare type LearnCardRawWallet = Wallet<"DIDKit" | "DID Key" | "VC" | "VC Templates" | "IDX" | "Expiration" | "Ethereum" | "Vpqr" | "CHAPI", MergeObjects<[
+	DidKeyPluginMethods<DidMethod>,
+	VCPluginMethods,
+	VCTemplatePluginMethods,
+	IDXPluginMethods,
+	EthereumPluginMethods,
+	VpqrPluginMethods,
+	CHAPIPluginMethods
+]>>;
 /**
  * @group LearnCard
  */
@@ -5135,7 +5301,12 @@ export declare type LearnCard<Methods extends keyof AllLearnCardMethods = keyof
 /**
  * @group LearnCard
  */
-export declare type EmptyLearnCard = LearnCard<"newCredential" | "newPresentation" | "verifyCredential" | "verifyPresentation" | "resolveDid", Wallet<"DIDKit" | "Expiration" | "VC Templates", DidkitPluginMethods & VerifyExtension & VCTemplatePluginMethods>>;
+export declare type EmptyLearnCard = LearnCard<"newCredential" | "newPresentation" | "verifyCredential" | "verifyPresentation" | "resolveDid" | "installChapiHandler" | "activateChapiHandler" | "receiveChapiEvent" | "storePresentationViaChapi" | "storeCredentialViaChapiDidAuth", Wallet<"DIDKit" | "Expiration" | "VC Templates" | "CHAPI", MergeObjects<[
+	DidkitPluginMethods,
+	VerifyExtension,
+	VCTemplatePluginMethods,
+	CHAPIPluginMethods
+]>>>;
 /** @group LearnCard */
 export declare type LearnCardConfig = {
 	ceramicIdx: CeramicIDXArgs;
@@ -5191,11 +5362,11 @@ export declare const getDidKitPlugin: (input?: InitInput | Promise<InitInput>) =
  *
  * @group Plugins
  */
-export declare const getDidKeyPlugin: <DidMethod extends string>(wallet: Wallet<string, DependentMethods<DidMethod>>, key: string) => Promise<Plugin<"DID Key", DidKeyPluginMethods<DidMethod>>>;
+export declare const getDidKeyPlugin: <DidMethod extends string>(wallet: Wallet<string, DependentMethods<DidMethod>>, key: string) => Promise<Plugin<"DID Key", DidKeyPluginMethods<DidMethod>, Record<never, never>>>;
 /**
  * @group Plugins
  */
-export declare const getVCPlugin: (wallet: Wallet<string, VCPluginDependentMethods>) => Plugin<"VC", VCPluginMethods>;
+export declare const getVCPlugin: (wallet: Wallet<string, VCPluginDependentMethods>) => Plugin<"VC", VCPluginMethods, VCPluginDependentMethods>;
 /**
  * @group Plugins
  */