@learncard/core 5.0.0 → 5.1.1

package/dist/core.d.ts

@@ -4590,6 +4590,22 @@ declare const VerificationItemValidator: z.ZodObject<{
 	check: string;
 }>;
 export declare type VerificationItem = z.infer<typeof VerificationItemValidator>;
+declare const IDXCredentialValidator: z.ZodObject<{
+	id: z.ZodString;
+	title: z.ZodString;
+	storageType: z.ZodOptional<z.ZodEnum<[
+		"ceramic"
+	]>>;
+}, "strip", z.ZodTypeAny, {
+	storageType?: "ceramic" | undefined;
+	id: string;
+	title: string;
+}, {
+	storageType?: "ceramic" | undefined;
+	id: string;
+	title: string;
+}>;
+export declare type IDXCredential = z.infer<typeof IDXCredentialValidator>;
 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}`;
 export declare type KeyPair = {
 	kty: string;
@@ -4612,6 +4628,7 @@ export declare type DidkitPluginMethods = {
 	issuePresentation: (presentation: UnsignedVP, options: ProofOptions, keypair: KeyPair) => Promise<VP>;
 	verifyPresentation: (presentation: VP) => Promise<VerificationCheck>;
 	contextLoader: (url: string) => Promise<Record<string, any>>;
+	resolveDid: (did: string) => Promise<Record<string, any>>;
 };
 export declare type Algorithm = "ed25519" | "secp256k1";
 export declare type DidKeyPluginMethods<DidMethod extends string> = {
@@ -4647,17 +4664,106 @@ export declare type IDXPluginMethods = {
 	addVerifiableCredentialInIdx: (cred: IDXCredential) => Promise<StreamID>;
 	removeVerifiableCredentialInIdx: (title: string) => Promise<StreamID>;
 };
-declare enum StorageType {
-	ceramic = "ceramic"
-}
-export declare type IDXCredential = {
+declare const IDXCredentialValidator: z.ZodObject<{
+	id: z.ZodString;
+	title: z.ZodString;
+	storageType: z.ZodOptional<z.ZodEnum<[
+		"ceramic"
+	]>>;
+	metadata: z.ZodOptional<z.ZodObject<{
+		name: z.ZodOptional<z.ZodString>;
+		image: z.ZodOptional<z.ZodString>;
+	}, "strip", z.ZodAny, {
+		[x: string]: any;
+		name?: string | undefined;
+		image?: string | undefined;
+	}, {
+		[x: string]: any;
+		name?: string | undefined;
+		image?: string | undefined;
+	}>>;
+}, "strict", z.ZodTypeAny, {
+	storageType?: "ceramic" | undefined;
+	metadata?: {
+		[x: string]: any;
+		name?: string | undefined;
+		image?: string | undefined;
+	} | undefined;
 	id: string;
 	title: string;
-	storageType?: StorageType;
-};
-export declare type CredentialsList = {
-	credentials: IDXCredential[];
-};
+}, {
+	storageType?: "ceramic" | undefined;
+	metadata?: {
+		[x: string]: any;
+		name?: string | undefined;
+		image?: string | undefined;
+	} | undefined;
+	id: string;
+	title: string;
+}>;
+export declare type IDXCredential = z.infer<typeof IDXCredentialValidator>;
+declare const CredentialsListValidator: z.ZodObject<{
+	credentials: z.ZodArray<z.ZodObject<{
+		id: z.ZodString;
+		title: z.ZodString;
+		storageType: z.ZodOptional<z.ZodEnum<[
+			"ceramic"
+		]>>;
+		metadata: z.ZodOptional<z.ZodObject<{
+			name: z.ZodOptional<z.ZodString>;
+			image: z.ZodOptional<z.ZodString>;
+		}, "strip", z.ZodAny, {
+			[x: string]: any;
+			name?: string | undefined;
+			image?: string | undefined;
+		}, {
+			[x: string]: any;
+			name?: string | undefined;
+			image?: string | undefined;
+		}>>;
+	}, "strict", z.ZodTypeAny, {
+		storageType?: "ceramic" | undefined;
+		metadata?: {
+			[x: string]: any;
+			name?: string | undefined;
+			image?: string | undefined;
+		} | undefined;
+		id: string;
+		title: string;
+	}, {
+		storageType?: "ceramic" | undefined;
+		metadata?: {
+			[x: string]: any;
+			name?: string | undefined;
+			image?: string | undefined;
+		} | undefined;
+		id: string;
+		title: string;
+	}>, "many">;
+}, "strict", z.ZodTypeAny, {
+	credentials: {
+		storageType?: "ceramic" | undefined;
+		metadata?: {
+			[x: string]: any;
+			name?: string | undefined;
+			image?: string | undefined;
+		} | undefined;
+		id: string;
+		title: string;
+	}[];
+}, {
+	credentials: {
+		storageType?: "ceramic" | undefined;
+		metadata?: {
+			[x: string]: any;
+			name?: string | undefined;
+			image?: string | undefined;
+		} | undefined;
+		id: string;
+		title: string;
+	}[];
+}>;
+export declare type CredentialsList = z.infer<typeof CredentialsListValidator>;
 export declare type DependentMethods = {
 	getSubjectDid: (type: "key") => string;
 	getSubjectKeypair: () => KeyPair;
@@ -4678,6 +4784,10 @@ export declare type VCPluginMethods = DependentMethods & {
 export declare type VerifyExtension = {
 	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
 };
+export declare type VpqrPluginMethods = {
+	vpFromQrCode: (text: string) => Promise<VP>;
+	vpToQrCode: (vp: VP) => Promise<string>;
+};
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 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>>;
@@ -4699,7 +4809,7 @@ export declare type Wallet<PluginNames extends string = "", PluginMethods extend
 	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>>;
 };
-export declare type LearnCardRawWallet = Wallet<"DIDKit" | "DID Key" | "VC" | "IDX" | "Expiration" | "Ethereum", DidKeyPluginMethods<DidMethod> & VCPluginMethods & IDXPluginMethods & EthereumPluginMethods>;
+export declare type LearnCardRawWallet = Wallet<"DIDKit" | "DID Key" | "VC" | "IDX" | "Expiration" | "Ethereum" | "Vpqr", DidKeyPluginMethods<DidMethod> & VCPluginMethods & IDXPluginMethods & EthereumPluginMethods & VpqrPluginMethods>;
 export declare type AllLearnCardMethods = {
 	/** Wallet holder's did */
 	did: (type?: DidMethod) => string;
@@ -4719,7 +4829,7 @@ export declare type AllLearnCardMethods = {
 	 * Empty error/warnings arrays means verification was successful
 	 */
 	verifyCredential: (credential: VC) => Promise<VerificationItem[]>;
-	/** Creates a signed Verifiable Presentation from a signed Verifiable Credential */
+	/** Signs an unsigned Verifiable Presentation, returning the signed VP */
 	issuePresentation: (presentation: UnsignedVP) => Promise<VP>;
 	/**
 	 * Verifies a signed Verifiable Presentation
@@ -4757,6 +4867,7 @@ export declare type AllLearnCardMethods = {
 	 * or by using `getCredentials` to get a list of all credentials that have been added to IDX
 	 */
 	removeCredential: (title: string) => Promise<void>;
+	resolveDid: (did: string) => Promise<Record<string, any>>;
 	/**
 	 * Resolves a stream ID, returning its contents
 	 *
@@ -4808,12 +4919,20 @@ export declare type AllLearnCardMethods = {
 	 * Really only useful for testing with the CLI right now...
 	 */
 	addInfuraProjectId: (infuraProjectIdToAdd: string) => void;
+	/**
+	 * Returns a Verifiable Presentation (VP) from a QR code base-64 image data string containing a VP compressed by CBOR-LD.
+	 */
+	vpFromQrCode: (text: string) => Promise<VP>;
+	/**
+	 * Returns a QR-embeddable base-64 image data string from a Verifiable Presentation, compressed using CBOR-LD.
+	 */
+	vpToQrCode: (vp: VP) => Promise<string>;
 };
 export declare type LearnCard<Methods extends keyof AllLearnCardMethods = keyof AllLearnCardMethods, RawWallet extends Wallet<any, any> = LearnCardRawWallet> = {
 	/** Raw IoE wallet instance. You shouldn't need to drop down to this level! */
 	_wallet: RawWallet;
 } & Pick<AllLearnCardMethods, Methods>;
-export declare type EmptyLearnCard = LearnCard<"verifyCredential" | "verifyPresentation", Wallet<"DIDKit" | "Expiration", DidkitPluginMethods & VerifyExtension>>;
+export declare type EmptyLearnCard = LearnCard<"verifyCredential" | "verifyPresentation" | "resolveDid", Wallet<"DIDKit" | "Expiration", DidkitPluginMethods & VerifyExtension>>;
 export declare type CeramicIDXArgs = {
 	modelData: ModelAliases;
 	credentialAlias: string;