@learncard/core 2.0.0 → 4.0.0

package/dist/core.d.ts

@@ -4602,6 +4602,16 @@ export declare type ProofOptions = {
 	verificationMethod: string;
 	proofPurpose: string;
 };
+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>;
+	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
+	issuePresentation: (presentation: UnsignedVP, options: ProofOptions, keypair: KeyPair) => Promise<VP>;
+	verifyPresentation: (presentation: VP) => Promise<VerificationCheck>;
+};
 export declare type Algorithm = "ed25519" | "secp256k1";
 export declare type DidKeyPluginMethods<DidMethod extends string> = {
 	getSubjectDid: (type: DidMethod) => string;
@@ -4625,12 +4635,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,9 +4666,13 @@ 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 declare type VerifyExtension = {
+	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
 };
 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>> = {
@@ -4677,9 +4692,7 @@ export declare type Wallet<PluginNames extends string = "", PluginMethods extend
 	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 LearnCardWallet = {
-	/** Raw IoE wallet instance. You shouldn't need to drop down to this level! */
-	_wallet: LearnCardRawWallet;
+export declare type AllLearnCardMethods = {
 	/** Wallet holder's did */
 	did: (type?: DidMethod) => string;
 	/** Wallet holder's ed25519 key pair */
@@ -4699,7 +4712,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
 	 *
@@ -4707,9 +4720,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<any[]>;
+	getCredentials: () => Promise<VC[]>;
+	/** Returns all credentials from IDX */
+	getCredentialsList: () => Promise<IDXCredential[]>;
 	/**
 	 * Publishes a credential to Ceramic, returning the credential's stream ID
 	 *
@@ -4717,7 +4732,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
@@ -4726,6 +4741,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
 	 *
@@ -4739,6 +4762,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
 	 */
@@ -4752,6 +4782,11 @@ export declare type LearnCardWallet = {
 	 */
 	checkMyUsdc: () => 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 CeramicIDXArgs = {
 	modelData: ModelAliases;
 	credentialAlias: string;
@@ -4764,9 +4799,11 @@ export declare type LearnCardConfig = {
 	defaultContents: any[];
 	ethereumConfig: EthereumConfig;
 };
+/** Generates an empty wallet with no key material */
+export declare const emptyWallet: ({ didkit, }?: Partial<Pick<LearnCardConfig, "didkit">>) => Promise<EmptyLearnCard>;
 /** 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 declare const walletFromKey: (key: string, { ceramicIdx, didkit, defaultContents, ethereumConfig, }?: Partial<LearnCardConfig>) => Promise<LearnCard>;
+export * from "@wallet/init";
 export { Wallet, Plugin } from "types/wallet";
 
 export {};