@learncard/core 9.0.2 → 9.1.0

package/dist/types/LearnCard.d.ts

@@ -1,6 +1,6 @@
 import { LearnCard, Plugin } from './wallet';
-export type GetPlugins<LC extends LearnCard<any, any, any>> = LC['plugins'];
-export type AddPlugin<LC extends LearnCard<any, any, any>, P extends Plugin> = LearnCard<[
+export declare type GetPlugins<LC extends LearnCard<any, any, any>> = LC['plugins'];
+export declare type AddPlugin<LC extends LearnCard<any, any, any>, P extends Plugin> = LearnCard<[
     ...GetPlugins<LC>,
     P
 ]>;

package/dist/types/helpers.d.ts

@@ -1,3 +1,3 @@
-export type OmitNevers<T extends Record<string, any>> = Omit<T, {
+export declare type OmitNevers<T extends Record<string, any>> = Omit<T, {
     [Index in keyof T]: [T[Index]] extends [never] ? Index : never;
 }[keyof T]>;

package/dist/types/planes.d.ts

@@ -3,22 +3,22 @@ import { Query } from 'sift';
 import { Plugin } from './wallet';
 import { OmitNevers } from './helpers';
 import { DeepPartial } from './utilities';
-export type CacheStrategy = 'cache-only' | 'cache-first' | 'skip-cache';
-export type PlaneOptions = {
+export declare type CacheStrategy = 'cache-only' | 'cache-first' | 'skip-cache';
+export declare type PlaneOptions = {
     cache?: CacheStrategy;
 };
-export type ControlPlane = 'read' | 'store' | 'index' | 'cache' | 'id';
-export type FilterForPlane<Plugins extends Plugin[], Plane extends ControlPlane> = [
+export declare type ControlPlane = 'read' | 'store' | 'index' | 'cache' | 'id' | 'context';
+export declare type FilterForPlane<Plugins extends Plugin[], Plane extends ControlPlane> = [
     Plugins
 ] extends [1 & Plugins] ? any : {
     [Index in keyof Plugins]: undefined extends Plugins[Index][Plane] ? never : Plugins[Index]['name'];
 }[number];
-export type GetPlanesForPlugins<Plugins extends Plugin[]> = any[] extends Plugins ? never : {
+export declare type GetPlanesForPlugins<Plugins extends Plugin[]> = any[] extends Plugins ? never : {
     [Index in keyof Plugins]: {
         [Key in ControlPlane]: undefined extends Plugins[Index][Key] ? never : Key;
     }[ControlPlane];
 }[number];
-export type GetPlaneProviders<Plugins extends Plugin[], Plane extends ControlPlane> = any[] extends Plugins ? any : {
+export declare type GetPlaneProviders<Plugins extends Plugin[], Plane extends ControlPlane> = any[] extends Plugins ? any : {
     [Index in keyof Plugins]: undefined extends Plugins[Index][Plane] ? never : OmitNevers<{
         [Name in Plugins[number]['name']]: Name extends Plugins[Index]['name'] ? {
             name: Name;
@@ -27,26 +27,26 @@ export type GetPlaneProviders<Plugins extends Plugin[], Plane extends ControlPla
         } : never;
     }>;
 }[number];
-export type ReadPlane = {
+export declare type ReadPlane = {
     get: (uri?: string, options?: PlaneOptions) => Promise<VC | VP | undefined>;
 };
-export type PluginReadPlane = ReadPlane;
-export type LearnCardReadPlane<Plugins extends Plugin[]> = ReadPlane & {
+export declare type PluginReadPlane = ReadPlane;
+export declare type LearnCardReadPlane<Plugins extends Plugin[]> = ReadPlane & {
     providers: GetPlaneProviders<Plugins, 'read'>;
 };
-export type EncryptionParams = {
+export declare type EncryptionParams = {
     recipients: string[];
 };
-export type StorePlane = {
+export declare type StorePlane = {
     upload: (vc: VC | VP, options?: PlaneOptions) => Promise<string>;
     uploadMany?: (vcs: (VC | VP)[], options?: PlaneOptions) => Promise<string[]>;
     uploadEncrypted?: (vc: VC | VP, params?: EncryptionParams, options?: PlaneOptions) => Promise<string>;
 };
-export type PluginStorePlane = StorePlane;
-export type LearnCardStorePlane<Plugins extends Plugin[]> = Record<FilterForPlane<Plugins, 'store'>, StorePlane> & {
+export declare type PluginStorePlane = StorePlane;
+export declare type LearnCardStorePlane<Plugins extends Plugin[]> = Record<FilterForPlane<Plugins, 'store'>, StorePlane> & {
     providers: GetPlaneProviders<Plugins, 'store'>;
 };
-export type IndexPlane = {
+export declare type IndexPlane = {
     get: <Metadata extends Record<string, any> = Record<never, never>>(query?: Partial<Query<CredentialRecord<Metadata>>>, options?: PlaneOptions) => Promise<CredentialRecord<Metadata>[]>;
     getPage?: <Metadata extends Record<string, any> = Record<never, never>>(query?: Partial<Query<CredentialRecord<Metadata>>>, paginationOptions?: {
         limit?: number;
@@ -63,12 +63,12 @@ export type IndexPlane = {
     remove: (id: string, options?: PlaneOptions) => Promise<boolean>;
     removeAll?: (options?: PlaneOptions) => Promise<boolean>;
 };
-export type PluginIndexPlane = IndexPlane;
-export type LearnCardIndexPlane<Plugins extends Plugin[]> = {
+export declare type PluginIndexPlane = IndexPlane;
+export declare type LearnCardIndexPlane<Plugins extends Plugin[]> = {
     all: Pick<IndexPlane, 'get'>;
     providers: GetPlaneProviders<Plugins, 'index'>;
 } & Record<FilterForPlane<Plugins, 'index'>, IndexPlane>;
-export type CachePlane = {
+export declare type CachePlane = {
     getIndex: <Metadata extends Record<string, any> = Record<never, never>>(name: string, query: Partial<Query<CredentialRecord<Metadata>>>) => Promise<CredentialRecord<Metadata>[] | undefined>;
     setIndex: <Metadata extends Record<string, any> = Record<never, never>>(name: string, query: Partial<Query<CredentialRecord<Metadata>>>, value: CredentialRecord<Metadata>[]) => Promise<boolean>;
     getIndexPage: <Metadata extends Record<string, any> = Record<never, never>>(name: string, query: Partial<Query<CredentialRecord<Metadata>>>, paginationOptions?: {
@@ -94,15 +94,25 @@ export type CachePlane = {
     setVc: (uri: string, value: VC | VP | undefined) => Promise<boolean>;
     flushVc: () => Promise<boolean>;
 };
-export type PluginCachePlane = CachePlane;
-export type LearnCardCachePlane<Plugins extends Plugin[]> = CachePlane & {
+export declare type PluginCachePlane = CachePlane;
+export declare type LearnCardCachePlane<Plugins extends Plugin[]> = CachePlane & {
     providers: GetPlaneProviders<Plugins, 'cache'>;
 };
-export type IdPlane = {
+export declare type IdPlane = {
     did: (method?: string, options?: PlaneOptions) => string;
     keypair: (algorithm?: string, options?: PlaneOptions) => JWK;
 };
-export type PluginIdPlane = IdPlane;
-export type LearnCardIdPlane<Plugins extends Plugin[]> = IdPlane & {
+export declare type PluginIdPlane = IdPlane;
+export declare type LearnCardIdPlane<Plugins extends Plugin[]> = IdPlane & {
     providers: GetPlaneProviders<Plugins, 'id'>;
 };
+export declare type ContextPlane = {
+    resolveDocument: (uri: string, allowRemote?: boolean) => Promise<Record<string, any> | undefined>;
+};
+export declare type PluginContextPlane = {
+    resolveStaticDocument: (uri: string) => Promise<Record<string, any> | undefined>;
+    resolveRemoteDocument?: (uri: string) => Promise<Record<string, any> | undefined>;
+};
+export declare type LearnCardContextPlane<Plugins extends Plugin[]> = ContextPlane & {
+    providers: GetPlaneProviders<Plugins, 'context'>;
+};

package/dist/types/utilities.d.ts

@@ -1,18 +1,18 @@
 /** @group Utility Types */
-export type Tail<T extends any[]> = T extends [any, ...infer R] ? R : never;
+export declare type Tail<T extends any[]> = T extends [any, ...infer R] ? R : never;
 /** @group Utility Types */
-export type Last<T extends any[]> = T extends [...any[], infer R] ? R : never;
+export declare type Last<T extends any[]> = T extends [...any[], infer R] ? R : never;
 /** @group Utility Types */
-export type RemoveLast<T extends any[]> = T extends [...infer R, any] ? R : [];
+export declare type RemoveLast<T extends any[]> = T extends [...infer R, any] ? R : [];
 /** @group Utility Types */
-export type RemoveFirstArg<T extends (...args: any[]) => any> = (args: Tail<Parameters<T>>) => ReturnType<T>;
+export declare type RemoveFirstArg<T extends (...args: any[]) => any> = (args: Tail<Parameters<T>>) => ReturnType<T>;
 /** @group Utility Types */
-export type RemoveLastArg<T extends (...args: any[]) => any> = (args: RemoveLast<Parameters<T>>) => ReturnType<T>;
+export declare type RemoveLastArg<T extends (...args: any[]) => any> = (args: RemoveLast<Parameters<T>>) => ReturnType<T>;
 /** @group Utility Types */
-export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
 /** @group Utility Types */
-export type MergeObjects<Objects extends Record<string, any>[]> = undefined extends Objects[2] ? Omit<Objects[0], keyof Objects[1]> & Objects[1] : Omit<MergeObjects<RemoveLast<Objects>>, keyof Last<Objects>> & Last<Objects>;
+export declare type MergeObjects<Objects extends Record<string, any>[]> = undefined extends Objects[2] ? Omit<Objects[0], keyof Objects[1]> & Objects[1] : Omit<MergeObjects<RemoveLast<Objects>>, keyof Last<Objects>> & Last<Objects>;
 /** @group Utility Types */
-export type DeepPartial<T> = T extends object ? {
+export declare type DeepPartial<T> = T extends object ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;

package/dist/types/wallet.d.ts

@@ -1,17 +1,17 @@
-import { ControlPlane, GetPlanesForPlugins, PluginReadPlane, PluginStorePlane, PluginIndexPlane, PluginCachePlane, PluginIdPlane, LearnCardReadPlane, LearnCardStorePlane, LearnCardIndexPlane, LearnCardCachePlane, LearnCardIdPlane } from './planes';
+import { ControlPlane, GetPlanesForPlugins, PluginReadPlane, PluginStorePlane, PluginIndexPlane, PluginCachePlane, PluginIdPlane, PluginContextPlane, LearnCardReadPlane, LearnCardStorePlane, LearnCardIndexPlane, LearnCardCachePlane, LearnCardIdPlane, LearnCardContextPlane } from './planes';
 import { UnionToIntersection, MergeObjects } from './utilities';
-export type GenerateLearnCard<NewControlPlanes extends ControlPlane = never, NewMethods extends Record<string, (...args: any[]) => any> = Record<never, never>, ControlPlanes extends ControlPlane = never, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>> = LearnCard<any, [
+export declare type GenerateLearnCard<NewControlPlanes extends ControlPlane = never, NewMethods extends Record<string, (...args: any[]) => any> = Record<never, never>, ControlPlanes extends ControlPlane = never, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>> = LearnCard<any, [
     ControlPlanes
 ] extends [1 & ControlPlanes] ? NewControlPlanes : [NewControlPlanes] extends [1 & NewControlPlanes] ? ControlPlanes : ControlPlanes | NewControlPlanes, NewMethods & Methods>;
-export type AddImplicitLearnCardArgument<Functions extends Record<string, (...args: any[]) => any> = Record<never, never>, ControlPlanes extends ControlPlane = never, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>, DependentControlPlanes extends ControlPlane = never, DependentMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
+export declare type AddImplicitLearnCardArgument<Functions extends Record<string, (...args: any[]) => any> = Record<never, never>, ControlPlanes extends ControlPlane = never, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>, DependentControlPlanes extends ControlPlane = never, DependentMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
     [Key in keyof Functions]: <T extends GenerateLearnCard<ControlPlanes, Methods, DependentControlPlanes, DependentMethods>>(learnCard: T, ...args: Parameters<Functions[Key]>) => ReturnType<Functions[Key]>;
 };
 /** @group Universal Wallets */
-export type GetPluginMethods<Plugins extends Plugin[]> = undefined extends Plugins[1] ? NonNullable<Plugins[0]['_methods']> : UnionToIntersection<NonNullable<MergeObjects<{
+export declare type GetPluginMethods<Plugins extends Plugin[]> = undefined extends Plugins[1] ? NonNullable<Plugins[0]['_methods']> : UnionToIntersection<NonNullable<MergeObjects<{
     [Key in keyof Plugins]: NonNullable<Plugins[Key]['_methods']>;
 }>>>;
 /** @group Universal Wallets */
-export type Plugin<Name extends string = string, ControlPlanes extends ControlPlane = any, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>, DependentControlPlanes extends ControlPlane = never, DependentMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
+export declare type Plugin<Name extends string = string, ControlPlanes extends ControlPlane = any, Methods extends Record<string, (...args: any[]) => any> = Record<never, never>, DependentControlPlanes extends ControlPlane = never, DependentMethods extends Record<string, (...args: any[]) => any> = Record<never, never>> = {
     name: Name;
     displayName?: string;
     description?: string;
@@ -22,6 +22,7 @@ export type Plugin<Name extends string = string, ControlPlanes extends ControlPl
     index?: {};
     cache?: {};
     id?: {};
+    context?: {};
 } & ([ControlPlanes] extends [1 & ControlPlanes] ? {} : ('read' extends ControlPlanes ? {
     read: AddImplicitLearnCardArgument<PluginReadPlane, ControlPlanes, Methods, DependentControlPlanes, DependentMethods>;
 } : {}) & ('store' extends ControlPlanes ? {
@@ -32,9 +33,11 @@ export type Plugin<Name extends string = string, ControlPlanes extends ControlPl
     cache: AddImplicitLearnCardArgument<PluginCachePlane, ControlPlanes, Methods, DependentControlPlanes, DependentMethods>;
 } : {}) & ('id' extends ControlPlanes ? {
     id: AddImplicitLearnCardArgument<PluginIdPlane, ControlPlanes, Methods, DependentControlPlanes, DependentMethods>;
+} : {}) & ('context' extends ControlPlanes ? {
+    context: AddImplicitLearnCardArgument<PluginContextPlane, ControlPlanes, Methods, DependentControlPlanes, DependentMethods>;
 } : {}));
 /** @group Universal Wallets */
-export type LearnCard<Plugins extends Plugin[] = [], ControlPlanes extends ControlPlane = GetPlanesForPlugins<Plugins>, PluginMethods = GetPluginMethods<Plugins>> = {
+export declare type LearnCard<Plugins extends Plugin[] = [], ControlPlanes extends ControlPlane = GetPlanesForPlugins<Plugins>, PluginMethods = GetPluginMethods<Plugins>> = {
     plugins: Plugins;
     invoke: PluginMethods;
     addPlugin: <NewPlugin extends Plugin>(plugin: NewPlugin) => Promise<LearnCard<[...Plugins, NewPlugin]>>;
@@ -49,4 +52,6 @@ export type LearnCard<Plugins extends Plugin[] = [], ControlPlanes extends Contr
     cache: LearnCardCachePlane<Plugins>;
 } : {}) & ('id' extends ControlPlanes ? {
     id: LearnCardIdPlane<Plugins>;
+} : {}) & ('context' extends ControlPlanes ? {
+    context: LearnCardContextPlane<Plugins>;
 } : {}));

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

@@ -12,4 +12,5 @@ export declare const generateLearnCard: <Plugins extends {
     index?: {} | undefined;
     cache?: {} | undefined;
     id?: {} | undefined;
+    context?: {} | undefined;
 }[] = [], ControlPlanes extends GetPlanesForPlugins<Plugins> = GetPlanesForPlugins<Plugins>, PluginMethods extends GetPluginMethods<Plugins> = GetPluginMethods<Plugins>>(_learnCard?: Partial<LearnCard<Plugins, ControlPlanes, PluginMethods>>) => Promise<LearnCard<Plugins, ControlPlanes, PluginMethods>>;

package/dist/wallet/plugins/test-cache/types.d.ts

@@ -1,2 +1,2 @@
 import { Plugin } from '../../../types/wallet';
-export type TestCachePlugin = Plugin<'Test Cache', 'cache'>;
+export declare type TestCachePlugin = Plugin<'Test Cache', 'cache'>;

package/dist/wallet/plugins/test-index/types.d.ts

@@ -1,2 +1,2 @@
 import { Plugin } from '../../../types/wallet';
-export type TestIndexPlugin = Plugin<'Test Index', 'index'>;
+export declare type TestIndexPlugin = Plugin<'Test Index', 'index'>;

package/dist/wallet/plugins/test-storage/types.d.ts

@@ -1,2 +1,2 @@
 import { Plugin } from '../../../types/wallet';
-export type TestStoragePlugin = Plugin<'Test Storage', 'read' | 'store' | 'index'>;
+export declare type TestStoragePlugin = Plugin<'Test Storage', 'read' | 'store' | 'index'>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@learncard/core",
-  "version": "9.0.2",
+  "version": "9.1.0",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/core.esm.js",
@@ -40,7 +40,7 @@
     "isomorphic-fetch": "^3.0.0",
     "isomorphic-webcrypto": "^2.3.8",
     "zod": "^3.20.2",
-    "@learncard/helpers": "1.0.6"
+    "@learncard/helpers": "1.0.7"
   },
   "scripts": {
     "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.js && tsc --p tsconfig.build.json && tsc-alias",