@learncard/core 1.1.1 → 1.1.4

package/dist/didkit/index.d.ts

@@ -0,0 +1,4 @@
+import { InitInput } from './pkg/didkit_wasm';
+export * from './pkg/didkit_wasm';
+export declare const init: (arg?: InitInput | Promise<InitInput>) => Promise<import("./pkg/didkit_wasm").InitOutput | undefined>;
+export default init;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="types/global" />
+export { walletFromKey } from './wallet/init';
+export { Wallet, UnlockedWallet, LockedWallet, Plugin } from './types/wallet';

package/dist/types/LearnCard.d.ts

@@ -0,0 +1,77 @@
+import { ModelAliases } from '@glazed/types';
+import { VerificationItem, UnsignedVC, VC, VP } from '@learncard/types';
+import { DidKeyPluginMethods } from '../wallet/plugins/didkey/types';
+import { IDXCredential, IDXPluginMethods } from '../wallet/plugins/idx/types';
+import { VCPluginMethods, VerificationCheck } from '../wallet/plugins/vc/types';
+import { InitInput } from '../didkit';
+import { UnlockedWallet } from './wallet';
+export * from '@learncard/types';
+export declare type LearnCardRawWallet = UnlockedWallet<'DID Key' | 'VC' | 'IDX' | 'Expiration', DidKeyPluginMethods & VCPluginMethods & IDXPluginMethods>;
+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>;
+    defaultContents: any[];
+};

package/dist/types/wallet.d.ts

@@ -0,0 +1,27 @@
+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]>;
+    };
+};
+export declare type PublicFieldsObj<PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
+    pluginMethods: PluginMethods;
+};
+export 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> & {
+    contents: any[];
+    plugins: Plugin<PluginNames, Record<string, (...args: any[]) => any>>[];
+};
+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>;

package/dist/wallet/base/crypto.d.ts

@@ -0,0 +1,3 @@
+import { Crypto } from '@peculiar/webcrypto';
+declare let crypto: Crypto;
+export default crypto;

package/dist/wallet/base/functions/index.d.ts

@@ -0,0 +1,2 @@
+export * from './passwordToKey';
+export * from './seedToId';

package/dist/wallet/base/functions/passwordToKey.d.ts

@@ -0,0 +1 @@
+export declare const passwordToKey: (password: string, salt?: string, iterations?: number, digest?: string) => Promise<Uint8Array>;

package/dist/wallet/base/functions/seedToId.d.ts

@@ -0,0 +1 @@
+export declare const seedToId: (seed: Uint8Array) => Promise<string>;

package/dist/wallet/base/index.d.ts

@@ -0,0 +1,2 @@
+export * from './functions';
+export * from './wallet';

package/dist/wallet/base/wallet.d.ts

@@ -0,0 +1,2 @@
+import { UnlockedWallet } from '../../types/wallet';
+export declare const generateWallet: <PluginNames extends string, PluginMethods extends Record<string, (...args: any[]) => any> = Record<never, never>>(contents?: any[], _wallet?: Partial<UnlockedWallet<any, PluginMethods>>) => Promise<UnlockedWallet<PluginNames, PluginMethods>>;

package/dist/wallet/defaults.d.ts

@@ -0,0 +1,2 @@
+import { CeramicIDXArgs } from '../types/LearnCard';
+export declare const defaultCeramicIDXArgs: CeramicIDXArgs;

package/dist/wallet/init.d.ts

@@ -0,0 +1,3 @@
+import { LearnCardConfig, LearnCardWallet } from '../types/LearnCard';
+/** Generates a LearnCard Wallet from a 64 character seed string */
+export declare const walletFromKey: (key: string, { ceramicIdx, didkit, defaultContents, }?: Partial<LearnCardConfig>) => Promise<LearnCardWallet>;

package/dist/wallet/plugins/didkey/index.d.ts

@@ -0,0 +1,3 @@
+import { DidKeyPluginMethods } from './types';
+import { Plugin } from '../../../types/wallet';
+export declare const getDidKeyPlugin: (key: string) => Promise<Plugin<'DID Key', DidKeyPluginMethods>>;

package/dist/wallet/plugins/didkey/types.d.ts

@@ -0,0 +1,19 @@
+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>;
+    getKey: () => string;
+};

package/dist/wallet/plugins/expiration/index.d.ts

@@ -0,0 +1,3 @@
+import { VerifyExtension } from '../vc/types';
+import { Plugin, UnlockedWallet } from '../../../types/wallet';
+export declare const ExpirationPlugin: (wallet: UnlockedWallet<any, VerifyExtension>) => Plugin<'Expiration', VerifyExtension>;

package/dist/wallet/plugins/idx/idx.d.ts

@@ -0,0 +1,6 @@
+import { IDXPluginMethods } from './types';
+import { Plugin, UnlockedWallet } from '../../../types/wallet';
+import { CeramicIDXArgs } from '../../../types/LearnCard';
+export declare const getIDXPlugin: (wallet: UnlockedWallet<any, {
+    getKey: () => string;
+}>, { modelData, credentialAlias, ceramicEndpoint, defaultContentFamily }: CeramicIDXArgs) => Promise<Plugin<'IDX', IDXPluginMethods>>;

package/dist/wallet/plugins/idx/index.d.ts

@@ -0,0 +1,4 @@
+import { getIDXPlugin } from './idx';
+export { getIDXPlugin } from './idx';
+export * from './types';
+export default getIDXPlugin;

package/dist/wallet/plugins/idx/types.d.ts

@@ -0,0 +1,20 @@
+import { StreamID } from '@ceramicnetwork/streamid';
+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>;
+};
+export declare enum StorageType {
+    ceramic = "ceramic"
+}
+export declare type IDXCredential = {
+    id: string;
+    title: string;
+    storageType?: StorageType;
+};
+export declare type CredentialsList = {
+    credentials: IDXCredential[];
+};

package/dist/wallet/plugins/vc/index.d.ts

@@ -0,0 +1,2 @@
+export { getVCPlugin } from './vc';
+export * from './types';

package/dist/wallet/plugins/vc/issueCredential.d.ts

@@ -0,0 +1,5 @@
+import { UnsignedVC } from '@learncard/types';
+import { UnlockedWallet } from '../../../types/wallet';
+export declare const issueCredential: (wallet: UnlockedWallet<any, {
+    getSubjectKeypair: () => Record<string, string>;
+}>, credential: UnsignedVC) => Promise<any>;

package/dist/wallet/plugins/vc/issuePresentation.d.ts

@@ -0,0 +1,6 @@
+import { VC } from '@learncard/types';
+import { UnlockedWallet } from '../../../types/wallet';
+export declare const issuePresentation: (wallet: UnlockedWallet<any, {
+    getSubjectDid: () => string;
+    getSubjectKeypair: () => Record<string, string>;
+}>, credential: VC) => Promise<any>;

package/dist/wallet/plugins/vc/types.d.ts

@@ -0,0 +1,18 @@
+import { UnsignedVC, VC, VP } from '@learncard/types';
+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 declare type VerifyExtension = {
+    verifyCredential: (credential: VC) => Promise<VerificationCheck>;
+};

package/dist/wallet/plugins/vc/vc.d.ts

@@ -0,0 +1,6 @@
+import { VCPluginMethods } from './types';
+import { Plugin, UnlockedWallet } from '../../../types/wallet';
+export declare const getVCPlugin: (wallet: UnlockedWallet<any, {
+    getSubjectDid: () => string;
+    getSubjectKeypair: () => Record<string, string>;
+}>) => Promise<Plugin<'VC', VCPluginMethods>>;

package/dist/wallet/plugins/vc/verifyCredential.d.ts

@@ -0,0 +1,2 @@
+import { VC } from '@learncard/types';
+export declare const verifyCredential: (credential: VC) => Promise<any>;

package/dist/wallet/plugins/vc/verifyPresentation.d.ts

@@ -0,0 +1,2 @@
+import { VP } from '@learncard/types';
+export declare const verifyPresentation: (presentation: VP) => Promise<any>;

package/dist/wallet/verify.d.ts

@@ -0,0 +1,3 @@
+import { VC, VerificationItem } from '@learncard/types';
+import { LearnCardRawWallet } from '../types/LearnCard';
+export declare const verifyCredential: (wallet: LearnCardRawWallet) => (credential: VC) => Promise<VerificationItem[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@learncard/core",
-  "version": "1.1.1",
+  "version": "1.1.4",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/core.esm.js",
@@ -19,14 +19,15 @@
   },
   "devDependencies": {
     "@glazed/types": "^0.2.0",
-    "@learncard/types": "2.0.1",
+    "@learncard/types": "2.1.1",
     "@types/node": "^17.0.31",
     "aqu": "0.3.2",
     "esbuild": "^0.14.38",
     "esbuild-plugin-copy": "^1.3.0",
+    "tsc-alias": "^1.6.9",
     "typescript": "^4.6.4"
   },
-  "types": "./dist/core.d.ts",
+  "types": "./dist/index.d.ts",
   "dependencies": {
     "@ceramicnetwork/common": "^2.0.4",
     "@ceramicnetwork/http-client": "2.0.4",
@@ -42,7 +43,7 @@
     "key-did-resolver": "1.2.1"
   },
   "scripts": {
-    "build": "aqu build",
+    "build": "aqu build && tsc-alias",
     "start": "aqu watch",
     "lint": "aqu lint",
     "lint:fix": "aqu lint --fix",

package/dist/core.d.ts

@@ -1,212 +0,0 @@
-// 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 DidKeyPluginMethods = {
-	getSubjectDid: () => string;
-	getSubjectKeypair: () => Record<string, string>;
-	getKey: () => string;
-};
-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>> = {
-	name?: Name;
-	pluginMethods: {
-		[Key in keyof PublicMethods]: <T extends UnlockedWallet<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> & {
-	contents: any[];
-	plugins: Plugin<PluginNames, Record<string, (...args: any[]) => any>>[];
-};
-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<"DID Key" | "VC" | "IDX" | "Expiration", DidKeyPluginMethods & VCPluginMethods & IDXPluginMethods>;
-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>;
-	defaultContents: any[];
-};
-/** Generates a LearnCard Wallet from a 64 character seed string */
-export declare const walletFromKey: (key: string, { ceramicIdx, didkit, defaultContents, }?: Partial<LearnCardConfig>) => Promise<LearnCardWallet>;
-export { walletFromKey } from "@wallet/init";
-export { Wallet, UnlockedWallet, LockedWallet, Plugin } from "types/wallet";
-
-export {};