@learncard/core 1.0.0

package/dist/core.d.ts

@@ -0,0 +1,232 @@
+// Generated by dts-bundle-generator v5.9.0
+
+/// <reference types="node" />
+
+import { StreamID } from '@ceramicnetwork/streamid';
+import { ModelAliases } from '@glazed/types';
+
+declare enum VerificationStatus {
+	Success = "Success",
+	Failed = "Failed",
+	Error = "Error"
+}
+export declare type VerificationItem = {
+	check: string;
+	status: VerificationStatus;
+	message?: string;
+	details?: string;
+};
+export declare type AchievementCriteria = {
+	type?: string;
+	narrative?: string;
+};
+export declare type CredentialSubjectAchievement = {
+	type?: string;
+	name?: string;
+	description?: string;
+	criteria?: AchievementCriteria;
+	image?: string;
+};
+export declare type CredentialSubject = {
+	type?: string;
+	id?: string;
+	achievement?: CredentialSubjectAchievement;
+};
+export declare type Issuer = string | {
+	type?: string;
+	id?: string;
+	name?: string;
+	url?: string;
+	image?: string;
+};
+export declare type Proof = {
+	type: string;
+	proofPurpose: string;
+	verificationMethod: string;
+	jws: string;
+	created: string;
+};
+export declare type UnsignedVC = {
+	[key: string]: any;
+	"@context": string | string[];
+	credentialSubject: CredentialSubject;
+	id: string;
+	issuanceDate: string;
+	expirationDate?: string;
+	issuer: Issuer;
+	type: string[];
+};
+export declare type VC = UnsignedVC & {
+	proof: Proof;
+};
+export declare type UnsignedVP = {
+	[key: string]: any;
+	"@context": string | string[];
+	holder: string;
+	type: string[];
+	verifiableCredential: VC;
+};
+export declare type VP = UnsignedVP & {
+	proof: Proof;
+};
+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
+	];
+};
+export declare type DidKeyPluginMethods = {
+	getSubjectDid: () => string;
+	getSubjectKeypair: () => Record<string, string>;
+};
+export declare type DidKeyPluginConstants = {
+	generateContentFromSeed: (seed: Uint8Array) => Promise<JWK[]>;
+};
+export declare type IDXPluginMethods = {
+	getCredentialsListFromIndex: (alias?: string) => Promise<CredentialsList>;
+	publishContentToCeramic: (cred: any) => Promise<string>;
+	readContentFromCeramic: (streamId: string) => Promise<any>;
+	getVerifiableCredentialFromIndex: (title: string) => Promise<any>;
+	getVerifiableCredentialsFromIndex: () => Promise<any>;
+	addVerifiableCredentialInIdx: (cred: IDXCredential) => Promise<StreamID>;
+};
+declare enum StorageType {
+	ceramic = "ceramic"
+}
+export declare type IDXCredential = {
+	id: string;
+	title: string;
+	storageType?: StorageType;
+};
+export declare type CredentialsList = {
+	credentials: IDXCredential[];
+};
+export declare type VerificationCheck = {
+	checks: string[];
+	warnings: string[];
+	errors: string[];
+};
+export declare type VCPluginMethods = {
+	issueCredential: (credential: UnsignedVC) => Promise<VC>;
+	verifyCredential: (credential: VC) => Promise<VerificationCheck>;
+	issuePresentation: (credential: VC) => Promise<VP>;
+	verifyPresentation: (presentation: VP) => Promise<VerificationCheck>;
+	getTestVc: (subject?: string) => UnsignedVC;
+	getSubjectDid: () => string;
+	getSubjectKeypair: () => Record<string, string>;
+};
+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>, PublicConstants extends Record<string, any> = Record<never, never>> = {
+	name?: Name;
+	pluginMethods: {
+		[Key in keyof PublicMethods]: <T extends UnlockedWallet<any, PublicMethods, PublicConstants>>(wallet: T, ...args: Parameters<PublicMethods[Key]>) => ReturnType<PublicMethods[Key]>;
+	};
+	pluginConstants: PublicConstants;
+};
+export declare type PublicFieldsObj<PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>, PluginConstants extends Record<string, any> = Record<never, never>> = {
+	pluginMethods: PluginMethods;
+	pluginConstants: PluginConstants;
+};
+declare enum WalletStatus {
+	Locked = "LOCKED",
+	Unlocked = "UNLOCKED"
+}
+export declare type BaseWallet<PluginNames extends string = "", PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>, PluginConstants extends Record<string, any> = Record<never, never>> = PublicFieldsObj<PluginMethods, PluginConstants> & {
+	contents: any[];
+	plugins: Plugin<PluginNames, Record<string, (...args: any[]) => any>, Record<string, any>>[];
+};
+export declare type LockedWallet<PluginNames extends string = "", PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>, PluginConstants extends Record<string, any> = Record<never, never>> = BaseWallet<PluginNames, PluginMethods, PluginConstants> & {
+	status: WalletStatus.Locked;
+};
+export declare type UnlockedWallet<PluginNames extends string = "", PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>, PluginConstants extends Record<string, any> = Record<never, never>> = BaseWallet<PluginNames, PluginMethods, PluginConstants> & {
+	status: WalletStatus.Unlocked;
+	add: (content: any) => Promise<UnlockedWallet<PluginNames, PluginMethods, PluginConstants>>;
+	remove: (contentId: string) => Promise<UnlockedWallet<PluginNames, PluginMethods, PluginConstants>>;
+	addPlugin: <Name extends string, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>, Constants extends Record<string, any> = Record<never, never>>(plugin: Plugin<Name, Methods, Constants>) => Promise<UnlockedWallet<"" extends PluginNames ? Name : PluginNames | Name, Record<never, never> extends PluginMethods ? Methods : PluginMethods & Methods, Record<never, never> extends PluginConstants ? Constants : PluginConstants & Constants>>;
+};
+export declare type Wallet<PluginNames extends string = "", PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>, PluginConstants extends Record<string, any> = Record<never, never>> = LockedWallet<PluginNames, PluginMethods, PluginConstants> | UnlockedWallet<PluginNames, PluginMethods, PluginConstants>;
+export declare type LearnCardRawWallet = UnlockedWallet<"DID Key" | "VC" | "IDX" | "Expiration", DidKeyPluginMethods & VCPluginMethods & IDXPluginMethods, DidKeyPluginConstants>;
+export declare type LearnCardWallet = {
+	/** Raw IoE wallet instance. You shouldn't need to drop down to this level! */
+	_wallet: LearnCardRawWallet;
+	/** Wallet holder's did */
+	did: string;
+	/** Wallet holder's ed25519 key pair */
+	keypair: Record<string, string>;
+	/** Signs an unsigned Verifiable Credential, returning the signed VC */
+	issueCredential: (credential: UnsignedVC) => Promise<VC>;
+	/**
+	 * Verifies a signed Verifiable Credential
+	 *
+	 * Empty error/warnings arrays means verification was successful
+	 */
+	verifyCredential: (credential: VC) => Promise<VerificationItem[]>;
+	/** Creates a signed Verifiable Presentation from a signed Verifiable Credential */
+	issuePresentation: (credential: VC) => Promise<VP>;
+	/**
+	 * Verifies a signed Verifiable Presentation
+	 *
+	 * Empry error/warnings arrays means verification was successful
+	 */
+	verifyPresentation: (presentation: VP) => Promise<VerificationCheck>;
+	/** Returns the credential marked with `title` from IDX */
+	getCredential: (title: string) => Promise<any>;
+	/** Returns all credentials from IDX */
+	getCredentials: () => Promise<any[]>;
+	/**
+	 * Publishes a credential to Ceramic, returning the credential's stream ID
+	 *
+	 * This stream ID may then be shared/persisted/resolved to gain access to the credential
+	 *
+	 * Resolving a stream ID can be done by passing the stream ID to `readFromCeramic`
+	 */
+	publishCredential: (credential: any) => Promise<string>;
+	/**
+	 * 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
+	 */
+	addCredential: (credential: IDXCredential) => Promise<void>;
+	/**
+	 * Resolves a stream ID, returning its contents
+	 *
+	 * This can be given the return value of `publishCredential` to gain access to the credential
+	 * that was published
+	 */
+	readFromCeramic: (streamId: string) => Promise<any>;
+	/**
+	 * Returns an example credential, optionally allowing a subject's did to be passed in
+	 *
+	 * You can use this to test out implementations that use this library!
+	 */
+	getTestVc: (subject?: string) => UnsignedVC;
+};
+export declare type CeramicIDXArgs = {
+	modelData: ModelAliases;
+	credentialAlias: string;
+	ceramicEndpoint: string;
+	defaultContentFamily: string;
+};
+export declare type LearnCardConfig = {
+	ceramicIdx: CeramicIDXArgs;
+	didkit: InitInput | Promise<InitInput>;
+};
+export declare const createWallet: (defaultContents: any[], { ceramicIdx, didkit }?: Partial<LearnCardConfig>) => Promise<LearnCardWallet>;
+/** Generates did documents from key and returns default wallet */
+export declare const walletFromKey: (key: string, { ceramicIdx, didkit }?: Partial<LearnCardConfig>) => Promise<LearnCardWallet>;
+export { createWallet, walletFromKey } from "@wallet/init";
+export { Wallet, UnlockedWallet, LockedWallet, Plugin } from "types/wallet";
+
+export {};