@learncard/core 1.5.1 → 3.0.0

package/dist/core.d.ts

@@ -4625,12 +4625,13 @@ export declare type EthereumConfig = {
 	network?: providers.Networkish;
 };
 export declare type IDXPluginMethods = {
-	getCredentialsListFromIndex: (alias?: string) => Promise<CredentialsList>;
+	getCredentialsListFromIdx: (alias?: string) => Promise<CredentialsList>;
 	publishContentToCeramic: (cred: any) => Promise<string>;
 	readContentFromCeramic: (streamId: string) => Promise<any>;
-	getVerifiableCredentialFromIndex: (title: string) => Promise<any>;
-	getVerifiableCredentialsFromIndex: () => Promise<any>;
+	getVerifiableCredentialFromIdx: (title: string) => Promise<VC>;
+	getVerifiableCredentialsFromIdx: () => Promise<VC[]>;
 	addVerifiableCredentialInIdx: (cred: IDXCredential) => Promise<StreamID>;
+	removeVerifiableCredentialInIdx: (title: string) => Promise<StreamID>;
 };
 declare enum StorageType {
 	ceramic = "ceramic"
@@ -4655,39 +4656,29 @@ export declare type DependentMethods = {
 export declare type VCPluginMethods = DependentMethods & {
 	issueCredential: (credential: UnsignedVC) => Promise<VC>;
 	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
-	issuePresentation: (credential: VC) => Promise<VP>;
+	issuePresentation: (credential: UnsignedVP) => Promise<VP>;
 	verifyPresentation: (presentation: VP) => Promise<VerificationCheck>;
 	getTestVc: (subject?: string) => UnsignedVC;
+	getTestVp: (credential?: VC) => Promise<UnsignedVP>;
 };
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 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 UnlockedWallet<any, PublicMethods>>(wallet: T, ...args: Parameters<PublicMethods[Key]>) => ReturnType<PublicMethods[Key]>;
+		[Key in keyof PublicMethods]: <T extends Wallet<any, PublicMethods>>(wallet: T, ...args: Parameters<PublicMethods[Key]>) => ReturnType<PublicMethods[Key]>;
 	};
 };
 export declare type PublicFieldsObj<PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
 	pluginMethods: PluginMethods;
 };
-declare enum WalletStatus {
-	Locked = "LOCKED",
-	Unlocked = "UNLOCKED"
-}
-export declare type BaseWallet<PluginNames extends string = "", PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = PublicFieldsObj<PluginMethods> & {
+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>>;
 };
-export declare type LockedWallet<PluginNames extends string = "", PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = BaseWallet<PluginNames, PluginMethods> & {
-	status: WalletStatus.Locked;
-};
-export declare type UnlockedWallet<PluginNames extends string = "", PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = BaseWallet<PluginNames, PluginMethods> & {
-	status: WalletStatus.Unlocked;
-	add: (content: any) => Promise<UnlockedWallet<PluginNames, PluginMethods>>;
-	remove: (contentId: string) => Promise<UnlockedWallet<PluginNames, PluginMethods>>;
-	addPlugin: <Name extends string, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>>(plugin: Plugin<Name, Methods>) => Promise<UnlockedWallet<"" extends PluginNames ? Name : PluginNames | Name, Record<never, never> extends PluginMethods ? Methods : PluginMethods & Methods>>;
-};
-export declare type Wallet<PluginNames extends string = "", PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = LockedWallet<PluginNames, PluginMethods> | UnlockedWallet<PluginNames, PluginMethods>;
-export declare type LearnCardRawWallet = UnlockedWallet<"DIDKit" | "DID Key" | "VC" | "IDX" | "Expiration" | "Ethereum", DidKeyPluginMethods<DidMethod> & VCPluginMethods & IDXPluginMethods & EthereumPluginMethods>;
+export declare type LearnCardRawWallet = Wallet<"DIDKit" | "DID Key" | "VC" | "IDX" | "Expiration" | "Ethereum", DidKeyPluginMethods<DidMethod> & VCPluginMethods & IDXPluginMethods & EthereumPluginMethods>;
 export declare type LearnCardWallet = {
 	/** Raw IoE wallet instance. You shouldn't need to drop down to this level! */
 	_wallet: LearnCardRawWallet;
@@ -4710,7 +4701,7 @@ export declare type LearnCardWallet = {
 	 */
 	verifyCredential: (credential: VC) => Promise<VerificationItem[]>;
 	/** Creates a signed Verifiable Presentation from a signed Verifiable Credential */
-	issuePresentation: (credential: VC) => Promise<VP>;
+	issuePresentation: (presentation: UnsignedVP) => Promise<VP>;
 	/**
 	 * Verifies a signed Verifiable Presentation
 	 *
@@ -4718,9 +4709,11 @@ export declare type LearnCardWallet = {
 	 */
 	verifyPresentation: (presentation: VP) => Promise<VerificationCheck>;
 	/** Returns the credential marked with `title` from IDX */
-	getCredential: (title: string) => Promise<any>;
+	getCredential: (title: string) => Promise<VC>;
+	/** Returns all credentials from IDX */
+	getCredentials: () => Promise<VC[]>;
 	/** Returns all credentials from IDX */
-	getCredentials: () => Promise<any[]>;
+	getCredentialsList: () => Promise<IDXCredential[]>;
 	/**
 	 * Publishes a credential to Ceramic, returning the credential's stream ID
 	 *
@@ -4728,7 +4721,7 @@ export declare type LearnCardWallet = {
 	 *
 	 * Resolving a stream ID can be done by passing the stream ID to `readFromCeramic`
 	 */
-	publishCredential: (credential: any) => Promise<string>;
+	publishCredential: (credential: VC) => Promise<string>;
 	/**
 	 * Adds a stream ID  pointing to a credential (such as the one returned by `publishCredential`)
 	 * to IDX with a bespoke title
@@ -4737,6 +4730,14 @@ export declare type LearnCardWallet = {
 	 * or by using `getCredentials` to get a list of all credentials that have been added to IDX
 	 */
 	addCredential: (credential: IDXCredential) => Promise<void>;
+	/**
+	 * Adds a stream ID  pointing to a credential (such as the one returned by `publishCredential`)
+	 * to IDX with a bespoke title
+	 *
+	 * The credential may then be retrieved using `getCredential` and passing in that bespoke title,
+	 * or by using `getCredentials` to get a list of all credentials that have been added to IDX
+	 */
+	removeCredential: (title: string) => Promise<void>;
 	/**
 	 * Resolves a stream ID, returning its contents
 	 *
@@ -4750,6 +4751,13 @@ export declare type LearnCardWallet = {
 	 * You can use this to test out implementations that use this library!
 	 */
 	getTestVc: (subject?: string) => UnsignedVC;
+	/**
+	 * Wraps a crednetial in an exmaple presentaion. If no credential is provided, a new one will be
+	 * generated using getTestVc
+	 *
+	 * You can use this to test out implementations that use this library!
+	 */
+	getTestVp: (credential?: VC) => Promise<UnsignedVP>;
 	/**
 	 * Returns your ETH balance
 	 */
@@ -4778,6 +4786,6 @@ export declare type LearnCardConfig = {
 /** Generates a LearnCard Wallet from a 64 character seed string */
 export declare const walletFromKey: (key: string, { ceramicIdx, didkit, defaultContents, ethereumConfig, }?: Partial<LearnCardConfig>) => Promise<LearnCardWallet>;
 export { walletFromKey } from "@wallet/init";
-export { Wallet, UnlockedWallet, LockedWallet, Plugin } from "types/wallet";
+export { Wallet, Plugin } from "types/wallet";
 
 export {};