@learncard/core 8.5.5 → 9.0.0

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 /// <reference types="types/global" />
 import './polyfills';
-export * from './wallet/init';
 export { LearnCard, Plugin } from './types/wallet';
 export * from './types/LearnCard';
 export * from './wallet/base';

package/dist/types/LearnCard.d.ts

@@ -1,61 +1,4 @@
-import { InitInput } from '../didkit/index';
-import { DIDKitPlugin, DidMethod } from '../wallet/plugins/didkit/types';
-import { DidKeyPlugin } from '../wallet/plugins/didkey/types';
-import { VCPlugin } from '../wallet/plugins/vc/types';
-import { VCTemplatePlugin } from '../wallet/plugins/vc-templates';
-import { VCResolutionPluginType } from '../wallet/plugins/vc-resolution';
-import { CeramicPlugin, CeramicArgs } from '../wallet/plugins/ceramic/types';
-import { IDXPlugin, IDXArgs } from '../wallet/plugins/idx/types';
-import { ExpirationPlugin } from '../wallet/plugins/expiration/types';
-import { EthereumPlugin, EthereumConfig } from '../wallet/plugins/EthereumPlugin/types';
-import { VpqrPlugin } from '../wallet/plugins/vpqr/types';
-import { CHAPIPlugin } from '../wallet/plugins/chapi';
-import { VCAPIPlugin } from '../wallet/plugins/vc-api/types';
-import { LearnCardPlugin } from '../wallet/plugins/learn-card';
-import { InitFunction, GenericInitFunction } from './helpers';
 import { LearnCard, Plugin } from './wallet';
-/** @group LearnCard */
-export type LearnCardConfig = {
-    ceramicIdx: CeramicArgs & IDXArgs;
-    didkit: InitInput | Promise<InitInput>;
-    ethereumConfig: EthereumConfig;
-    debug?: typeof console.log;
-};
-/** @group Init Functions */
-export type EmptyLearnCard = InitFunction<{}, 'didkit' | 'debug', LearnCard<[DIDKitPlugin, ExpirationPlugin, VCTemplatePlugin, CHAPIPlugin, LearnCardPlugin]>>;
-/** @group Init Functions */
-export type LearnCardFromSeed = InitFunction<{
-    seed: string;
-}, keyof LearnCardConfig, LearnCard<[
-    DIDKitPlugin,
-    DidKeyPlugin<DidMethod>,
-    VCPlugin,
-    VCTemplatePlugin,
-    VCResolutionPluginType,
-    CeramicPlugin,
-    IDXPlugin,
-    ExpirationPlugin,
-    EthereumPlugin,
-    VpqrPlugin,
-    CHAPIPlugin,
-    LearnCardPlugin
-]>>;
-/** @group Init Functions */
-export type LearnCardFromVcApi = InitFunction<{
-    vcApi: true | string;
-    did?: string;
-}, 'debug', LearnCard<[VCAPIPlugin, ExpirationPlugin, VCTemplatePlugin, CHAPIPlugin, LearnCardPlugin]>>;
-/** @group Init Functions */
-export type CustomLearnCard = InitFunction<{
-    custom: true;
-}, 'debug', LearnCard<[]>>;
-/** @group Init Functions */
-export type InitLearnCard = GenericInitFunction<[
-    EmptyLearnCard,
-    LearnCardFromSeed,
-    LearnCardFromVcApi,
-    CustomLearnCard
-]>;
 export type GetPlugins<LC extends LearnCard<any, any, any>> = LC['plugins'];
 export type AddPlugin<LC extends LearnCard<any, any, any>, P extends Plugin> = LearnCard<[
     ...GetPlugins<LC>,

package/dist/types/helpers.d.ts

@@ -1,18 +1,3 @@
-import { LearnCardConfig } from './LearnCard';
-import { LearnCard } from './wallet';
-export type InitFunction<Args extends Record<string, any> = Record<string, any>, Config extends keyof LearnCardConfig | undefined = keyof LearnCardConfig, ReturnValue extends LearnCard<any, any> = LearnCard<any, any>> = {
-    args: Args & (undefined extends Config ? {} : Partial<Pick<LearnCardConfig, NonNullable<Config>>>);
-    returnValue: ReturnValue;
-};
-export type GenericInitFunction<InitFunctions extends InitFunction<any, any, any>[]> = {
-    args: InitFunctions[number]['args'];
-    returnValue: Promise<InitFunctions[number]['returnValue']>;
-};
-export type DiscriminatedUnionize<T extends object = {}, K extends string = 'type'> = {
-    [Key in keyof T]: {
-        [Key2 in K]: Key;
-    } & T[Key];
-}[keyof T];
 export 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

@@ -1,12 +1,16 @@
 import { CredentialRecord, VC, VP, JWK } from '@learncard/types';
+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 = {
     cache?: CacheStrategy;
 };
 export type ControlPlane = 'read' | 'store' | 'index' | 'cache' | 'id';
-export type FilterForPlane<Plugins extends Plugin[], Plane extends ControlPlane> = {
+export 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 : {
@@ -43,10 +47,19 @@ export type LearnCardStorePlane<Plugins extends Plugin[]> = Record<FilterForPlan
     providers: GetPlaneProviders<Plugins, 'store'>;
 };
 export type IndexPlane = {
-    get: <Metadata extends Record<string, any> = Record<never, never>>(query?: Record<string, any>, options?: PlaneOptions) => Promise<CredentialRecord<Metadata>[]>;
+    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;
+        cursor?: string;
+    }, options?: PlaneOptions) => Promise<{
+        records: CredentialRecord<Metadata>[];
+        hasMore: boolean;
+        cursor?: string;
+    }>;
+    getCount?: <Metadata extends Record<string, any> = Record<never, never>>(query?: Partial<Query<CredentialRecord<Metadata>>>, options?: PlaneOptions) => Promise<number>;
     add: <Metadata extends Record<string, any> = Record<never, never>>(record: CredentialRecord<Metadata>, options?: PlaneOptions) => Promise<boolean>;
     addMany?: <Metadata extends Record<string, any> = Record<never, never>>(records: CredentialRecord<Metadata>[], options?: PlaneOptions) => Promise<boolean>;
-    update: (id: string, updates: Record<string, any>, options?: PlaneOptions) => Promise<boolean>;
+    update: <Metadata extends Record<string, any> = Record<never, never>>(id: string, updates: DeepPartial<CredentialRecord<Metadata>>, options?: PlaneOptions) => Promise<boolean>;
     remove: (id: string, options?: PlaneOptions) => Promise<boolean>;
     removeAll?: (options?: PlaneOptions) => Promise<boolean>;
 };
@@ -56,8 +69,26 @@ export type LearnCardIndexPlane<Plugins extends Plugin[]> = {
     providers: GetPlaneProviders<Plugins, 'index'>;
 } & Record<FilterForPlane<Plugins, 'index'>, IndexPlane>;
 export type CachePlane = {
-    getIndex: <Metadata extends Record<string, any> = Record<never, never>>(name: string, query: Record<string, any>) => Promise<CredentialRecord<Metadata>[] | undefined>;
-    setIndex: <Metadata extends Record<string, any> = Record<never, never>>(name: string, query: Record<string, any>, value: CredentialRecord<Metadata>[]) => Promise<boolean>;
+    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?: {
+        limit?: number;
+        cursor?: string;
+    }) => Promise<{
+        records: CredentialRecord<Metadata>[];
+        hasMore: boolean;
+        cursor?: string;
+    } | undefined>;
+    setIndexPage: <Metadata extends Record<string, any> = Record<never, never>>(name: string, query: Partial<Query<CredentialRecord<Metadata>>>, value: {
+        records: CredentialRecord<Metadata>[];
+        hasMore: boolean;
+        cursor?: string;
+    }, paginationOptions?: {
+        limit?: number;
+        cursor?: string;
+    }) => Promise<boolean>;
+    getIndexCount?: <Metadata extends Record<string, any> = Record<never, never>>(name: string, query: Partial<Query<CredentialRecord<Metadata>>>) => Promise<number | undefined>;
+    setIndexCount?: <Metadata extends Record<string, any> = Record<never, never>>(name: string, query: Partial<Query<CredentialRecord<Metadata>>>, value: number) => Promise<boolean>;
     flushIndex: () => Promise<boolean>;
     getVc: (uri: string) => Promise<VC | VP | undefined>;
     setVc: (uri: string, value: VC | VP | undefined) => Promise<boolean>;

package/dist/types/utilities.d.ts

@@ -12,3 +12,7 @@ export type RemoveLastArg<T extends (...args: any[]) => any> = (args: RemoveLast
 export 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>;
+/** @group Utility Types */
+export type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;

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

@@ -1,15 +1,3 @@
-export * from './ceramic';
-export * from './chapi';
-export * from './didkey';
-export * from './didkit';
-export * from './EthereumPlugin';
-export * from './expiration';
-export * from './idx';
-export * from './learn-card';
 export * from './test-cache';
+export * from './test-index';
 export * from './test-storage';
-export * from './vc';
-export * from './vc-api';
-export * from './vc-resolution';
-export * from './vc-templates';
-export * from './vpqr';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@learncard/core",
-  "version": "8.5.5",
+  "version": "9.0.0",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/core.esm.js",
@@ -18,49 +18,29 @@
     "url": "https://github.com/WeLibraryOS/LearnCard/issues"
   },
   "devDependencies": {
-    "@glazed/types": "^0.2.0",
     "@types/jest": "^29.2.2",
     "@types/node": "^17.0.31",
     "aqu": "0.4.3",
     "esbuild": "^0.14.38",
     "esbuild-jest": "^0.5.0",
-    "esbuild-plugin-copy": "^1.3.0",
     "jest": "^29.3.0",
     "jest-resolver-enhanced": "^1.1.0",
-    "jimp": "^0.16.1",
-    "multiformats": "^11.0.1",
-    "qrcode-reader": "^1.0.4",
     "shx": "^0.3.4",
+    "sift": "^17.0.1",
     "ts-jest": "^29.0.3",
     "tsc-alias": "^1.6.9",
     "typescript": "^4.6.4",
-    "@learncard/types": "5.2.7"
+    "@learncard/types": "5.3.0"
   },
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "@ceramicnetwork/common": "2.13.0",
-    "@ceramicnetwork/http-client": "2.7.0",
-    "@ceramicnetwork/stream-tile": "2.9.0",
-    "@ceramicnetwork/streamid": "2.7.0",
-    "@digitalbazaar/vpqr": "^3.0.0",
-    "@glazed/did-datastore": "0.3.2",
-    "@glazed/tile-loader": "0.2.1",
-    "@uniswap/default-token-list": "^4.1.0",
     "abort-controller": "^3.0.0",
     "core-js": "^3.25.5",
-    "credential-handler-polyfill": "^3.0.0",
     "cross-fetch": "^3.1.5",
-    "date-fns": "^2.28.0",
-    "dids": "3.4.0",
-    "ethers": "^5.6.9",
-    "hex-lite": "^1.5.0",
     "isomorphic-fetch": "^3.0.0",
     "isomorphic-webcrypto": "^2.3.8",
-    "key-did-provider-ed25519": "^2.0.0",
-    "key-did-resolver": "2.3.0",
-    "web-credential-handler": "^2.0.0",
     "zod": "^3.20.2",
-    "@learncard/helpers": "1.0.3"
+    "@learncard/helpers": "1.0.4"
   },
   "scripts": {
     "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.js && tsc --p tsconfig.build.json && tsc-alias",

package/dist/didkit/didkit_wasm.d.ts

@@ -1,251 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
-* @returns {string}
-*/
-export function getVersion(): string;
-/**
-* @param {string} did
-* @param {string} input_metadata
-* @returns {Promise<any>}
-*/
-export function didResolver(did: string, input_metadata: string): Promise<any>;
-/**
-* @param {string} did
-* @param {string} input_metadata
-* @returns {Promise<any>}
-*/
-export function resolveDID(did: string, input_metadata: string): Promise<any>;
-/**
-* @returns {string}
-*/
-export function generateEd25519Key(): string;
-/**
-* @param {Uint8Array} bytes
-* @returns {string}
-*/
-export function generateEd25519KeyFromBytes(bytes: Uint8Array): string;
-/**
-* @returns {string}
-*/
-export function generateSecp256k1Key(): string;
-/**
-* @param {Uint8Array} bytes
-* @returns {string}
-*/
-export function generateSecp256k1KeyFromBytes(bytes: Uint8Array): string;
-/**
-* @param {string} method_pattern
-* @param {string} jwk
-* @returns {string}
-*/
-export function keyToDID(method_pattern: string, jwk: string): string;
-/**
-* @param {string} method_pattern
-* @param {string} jwk
-* @returns {Promise<any>}
-*/
-export function keyToVerificationMethod(method_pattern: string, jwk: string): Promise<any>;
-/**
-* @param {string} did
-* @returns {Promise<any>}
-*/
-export function didToVerificationMethod(did: string): Promise<any>;
-/**
-* @param {string} credential
-* @param {string} proof_options
-* @param {string} key
-* @returns {Promise<any>}
-*/
-export function issueCredential(credential: string, proof_options: string, key: string): Promise<any>;
-/**
-* @param {string} credential
-* @param {string} linked_data_proof_options
-* @param {string} public_key
-* @returns {Promise<any>}
-*/
-export function prepareIssueCredential(credential: string, linked_data_proof_options: string, public_key: string): Promise<any>;
-/**
-* @param {string} credential
-* @param {string} preparation
-* @param {string} signature
-* @returns {Promise<any>}
-*/
-export function completeIssueCredential(credential: string, preparation: string, signature: string): Promise<any>;
-/**
-* @param {string} vc
-* @param {string} proof_options
-* @returns {Promise<any>}
-*/
-export function verifyCredential(vc: string, proof_options: string): Promise<any>;
-/**
-* @param {string} presentation
-* @param {string} proof_options
-* @param {string} key
-* @returns {Promise<any>}
-*/
-export function issuePresentation(presentation: string, proof_options: string, key: string): Promise<any>;
-/**
-* @param {string} presentation
-* @param {string} linked_data_proof_options
-* @param {string} public_key
-* @returns {Promise<any>}
-*/
-export function prepareIssuePresentation(presentation: string, linked_data_proof_options: string, public_key: string): Promise<any>;
-/**
-* @param {string} presentation
-* @param {string} preparation
-* @param {string} signature
-* @returns {Promise<any>}
-*/
-export function completeIssuePresentation(presentation: string, preparation: string, signature: string): Promise<any>;
-/**
-* @param {string} vp
-* @param {string} proof_options
-* @returns {Promise<any>}
-*/
-export function verifyPresentation(vp: string, proof_options: string): Promise<any>;
-/**
-* @param {string} holder
-* @param {string} linked_data_proof_options
-* @param {string} key
-* @returns {Promise<any>}
-*/
-export function DIDAuth(holder: string, linked_data_proof_options: string, key: string): Promise<any>;
-/**
-* @param {string} tz
-* @returns {Promise<any>}
-*/
-export function JWKFromTezos(tz: string): Promise<any>;
-/**
-* @param {string} capability
-* @param {string} linked_data_proof_options
-* @param {string} parents
-* @param {string} key
-* @returns {Promise<any>}
-*/
-export function delegateCapability(capability: string, linked_data_proof_options: string, parents: string, key: string): Promise<any>;
-/**
-* @param {string} capability
-* @param {string} linked_data_proof_options
-* @param {string} parents
-* @param {string} public_key
-* @returns {Promise<any>}
-*/
-export function prepareDelegateCapability(capability: string, linked_data_proof_options: string, parents: string, public_key: string): Promise<any>;
-/**
-* @param {string} capability
-* @param {string} preparation
-* @param {string} signature
-* @returns {Promise<any>}
-*/
-export function completeDelegateCapability(capability: string, preparation: string, signature: string): Promise<any>;
-/**
-* @param {string} delegation
-* @returns {Promise<any>}
-*/
-export function verifyDelegation(delegation: string): Promise<any>;
-/**
-* @param {string} invocation
-* @param {string} target_id
-* @param {string} linked_data_proof_options
-* @param {string} key
-* @returns {Promise<any>}
-*/
-export function invokeCapability(invocation: string, target_id: string, linked_data_proof_options: string, key: string): Promise<any>;
-/**
-* @param {string} invocation
-* @param {string} target_id
-* @param {string} linked_data_proof_options
-* @param {string} public_key
-* @returns {Promise<any>}
-*/
-export function prepareInvokeCapability(invocation: string, target_id: string, linked_data_proof_options: string, public_key: string): Promise<any>;
-/**
-* @param {string} invocation
-* @param {string} preparation
-* @param {string} signature
-* @returns {Promise<any>}
-*/
-export function completeInvokeCapability(invocation: string, preparation: string, signature: string): Promise<any>;
-/**
-* @param {string} invocation
-* @returns {Promise<any>}
-*/
-export function verifyInvocationSignature(invocation: string): Promise<any>;
-/**
-* @param {string} invocation
-* @param {string} delegation
-* @returns {Promise<any>}
-*/
-export function verifyInvocation(invocation: string, delegation: string): Promise<any>;
-/**
-* @param {string} url
-* @returns {Promise<any>}
-*/
-export function contextLoader(url: string): Promise<any>;
-
-export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
-
-export interface InitOutput {
-  readonly memory: WebAssembly.Memory;
-  readonly getVersion: (a: number) => void;
-  readonly didResolver: (a: number, b: number, c: number, d: number) => number;
-  readonly resolveDID: (a: number, b: number, c: number, d: number) => number;
-  readonly generateEd25519Key: (a: number) => void;
-  readonly generateEd25519KeyFromBytes: (a: number, b: number, c: number) => void;
-  readonly generateSecp256k1Key: (a: number) => void;
-  readonly generateSecp256k1KeyFromBytes: (a: number, b: number, c: number) => void;
-  readonly keyToDID: (a: number, b: number, c: number, d: number, e: number) => void;
-  readonly keyToVerificationMethod: (a: number, b: number, c: number, d: number) => number;
-  readonly didToVerificationMethod: (a: number, b: number) => number;
-  readonly issueCredential: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
-  readonly prepareIssueCredential: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
-  readonly completeIssueCredential: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
-  readonly verifyCredential: (a: number, b: number, c: number, d: number) => number;
-  readonly issuePresentation: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
-  readonly prepareIssuePresentation: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
-  readonly completeIssuePresentation: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
-  readonly verifyPresentation: (a: number, b: number, c: number, d: number) => number;
-  readonly DIDAuth: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
-  readonly JWKFromTezos: (a: number, b: number) => number;
-  readonly delegateCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
-  readonly prepareDelegateCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
-  readonly completeDelegateCapability: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
-  readonly verifyDelegation: (a: number, b: number) => number;
-  readonly invokeCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
-  readonly prepareInvokeCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
-  readonly completeInvokeCapability: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
-  readonly verifyInvocationSignature: (a: number, b: number) => number;
-  readonly verifyInvocation: (a: number, b: number, c: number, d: number) => number;
-  readonly contextLoader: (a: number, b: number) => number;
-  readonly didkit_error_message: () => number;
-  readonly didkit_error_code: () => number;
-  readonly __wbindgen_malloc: (a: number) => number;
-  readonly __wbindgen_realloc: (a: number, b: number, c: number) => number;
-  readonly __wbindgen_export_2: WebAssembly.Table;
-  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__hf6251ee6687a20b8: (a: number, b: number, c: number) => void;
-  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
-  readonly __wbindgen_free: (a: number, b: number) => void;
-  readonly __wbindgen_exn_store: (a: number) => void;
-  readonly wasm_bindgen__convert__closures__invoke2_mut__h63ffd509f6690aab: (a: number, b: number, c: number, d: number) => void;
-}
-
-/**
-* Synchronously compiles the given `bytes` and instantiates the WebAssembly module.
-*
-* @param {BufferSource} bytes
-*
-* @returns {InitOutput}
-*/
-export function initSync(bytes: BufferSource): InitOutput;
-
-/**
-* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
-* for everything else, calls `WebAssembly.instantiate` directly.
-*
-* @param {InitInput | Promise<InitInput>} module_or_path
-*
-* @returns {Promise<InitOutput>}
-*/
-export default function init (module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>;