@learncard/network-plugin 1.0.0

package/dist/learnCard.d.ts

@@ -0,0 +1,6 @@
+import { LearnCardFromSeed, AddPlugin } from '@learncard/core';
+import { LearnCardNetworkPlugin } from './types';
+export type NetworkLearnCard = AddPlugin<LearnCardFromSeed['returnValue'], LearnCardNetworkPlugin>;
+export declare const initNetworkLearnCard: (_config: LearnCardFromSeed['args'] & {
+    network?: string;
+}) => Promise<NetworkLearnCard>;

package/dist/plugin.d.ts

@@ -0,0 +1,7 @@
+import { LearnCard } from '@learncard/core';
+import { LearnCardNetworkPluginDependentMethods, LearnCardNetworkPlugin } from './types';
+export * from './types';
+/**
+ * @group Plugins
+ */
+export declare const getLearnCardNetworkPlugin: (learnCard: LearnCard<any, 'id', LearnCardNetworkPluginDependentMethods>, url: string) => Promise<LearnCardNetworkPlugin>;

package/dist/types.d.ts

@@ -0,0 +1,57 @@
+import type { DID } from 'dids';
+import { LCNProfile, UnsignedVC, VC, VP, SentCredentialInfo, JWE, Boost } from '@learncard/types';
+import { Plugin, ProofOptions } from '@learncard/core';
+/** @group LearnCardNetwork Plugin */
+export type LearnCardNetworkPluginDependentMethods = {
+    getDIDObject: () => DID;
+    getDidAuthVp: (options?: ProofOptions) => Promise<VP | string>;
+    issueCredential: (credential: UnsignedVC, signingOptions?: Partial<ProofOptions>) => Promise<VC>;
+};
+/** @group LearnCardNetwork Plugin */
+export type LearnCardNetworkPluginMethods = {
+    createProfile: (profile: Omit<LCNProfile, 'did' | 'isServiceProfile'>) => Promise<string>;
+    createServiceProfile: (profile: Omit<LCNProfile, 'did' | 'isServiceProfile'>) => Promise<string>;
+    updateProfile: (profile: Partial<Omit<LCNProfile, 'did' | 'isServiceProfile'>>) => Promise<boolean>;
+    deleteProfile: () => Promise<boolean>;
+    getProfile: (profileId?: string) => Promise<LCNProfile | undefined>;
+    searchProfiles: (profileId?: string, options?: {
+        limit?: number;
+        includeSelf?: boolean;
+    }) => Promise<LCNProfile[]>;
+    connectWith: (profileId: string) => Promise<boolean>;
+    connectWithInvite: (profileId: string, challenge: string) => Promise<boolean>;
+    cancelConnectionRequest: (profileId: string) => Promise<boolean>;
+    disconnectWith: (profileId: string) => Promise<boolean>;
+    acceptConnectionRequest: (id: string) => Promise<boolean>;
+    getConnections: () => Promise<LCNProfile[]>;
+    getPendingConnections: () => Promise<LCNProfile[]>;
+    getConnectionRequests: () => Promise<LCNProfile[]>;
+    generateInvite: (challenge?: string) => Promise<{
+        profileId: string;
+        challenge: string;
+    }>;
+    sendCredential: (profileId: string, vc: UnsignedVC | VC, encrypt?: boolean) => Promise<string>;
+    acceptCredential: (uri: string) => Promise<boolean>;
+    getReceivedCredentials: (from?: string) => Promise<SentCredentialInfo[]>;
+    getSentCredentials: (to?: string) => Promise<SentCredentialInfo[]>;
+    getIncomingCredentials: (from?: string) => Promise<SentCredentialInfo[]>;
+    deleteCredential: (uri: string) => Promise<boolean>;
+    sendPresentation: (profileId: string, vp: VP, encrypt?: boolean) => Promise<string>;
+    acceptPresentation: (uri: string) => Promise<boolean>;
+    getReceivedPresentations: (from?: string) => Promise<SentCredentialInfo[]>;
+    getSentPresentations: (to?: string) => Promise<SentCredentialInfo[]>;
+    getIncomingPresentations: (from?: string) => Promise<SentCredentialInfo[]>;
+    deletePresentation: (uri: string) => Promise<boolean>;
+    createBoost: (credential: VC | UnsignedVC, metadata?: Partial<Omit<Boost, 'uri'>>) => Promise<string>;
+    getBoosts: () => Promise<{
+        name?: string;
+        uri: string;
+    }[]>;
+    updateBoost: (uri: string, updates: Partial<Omit<Boost, 'uri'>>) => Promise<boolean>;
+    deleteBoost: (uri: string) => Promise<boolean>;
+    sendBoost: (profileId: string, boostUri: string, encrypt?: boolean) => Promise<string>;
+    registerSigningAuthority: (uri: string) => Promise<boolean>;
+    resolveFromLCN: (uri: string) => Promise<VC | UnsignedVC | VP | JWE>;
+};
+/** @group LearnCardNetwork Plugin */
+export type LearnCardNetworkPlugin = Plugin<'LearnCard Network', 'id' | 'read' | 'store', LearnCardNetworkPluginMethods, 'id', LearnCardNetworkPluginDependentMethods>;

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@learncard/network-plugin",
+  "version": "1.0.0",
+  "description": "",
+  "main": "./dist/index.js",
+  "module": "./dist/lcn-plugin.esm.js",
+  "files": [
+    "dist"
+  ],
+  "author": "Learning Economy Foundation (www.learningeconomy.io)",
+  "license": "MIT",
+  "homepage": "https://github.com/WeLibraryOS/LearnCard#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/WeLibraryOS/LearnCard.git"
+  },
+  "bugs": {
+    "url": "https://github.com/WeLibraryOS/LearnCard/issues"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.2.2",
+    "@types/node": "^17.0.31",
+    "aqu": "0.4.3",
+    "dids": "^3.2.0",
+    "esbuild": "^0.14.38",
+    "esbuild-jest": "^0.5.0",
+    "esbuild-plugin-copy": "^1.3.0",
+    "jest": "^29.3.0",
+    "shx": "^0.3.4",
+    "ts-jest": "^29.0.3",
+    "@learncard/types": "5.2.0"
+  },
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@learncard/network-brain-client": "1.0.0",
+    "@learncard/core": "8.5.0"
+  },
+  "scripts": {
+    "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.js && tsc --p tsconfig.json"
+  }
+}