@learncard/ceramic-plugin 1.0.0

package/dist/ceramic.d.ts

@@ -0,0 +1,6 @@
+import { LearnCard } from '@learncard/core';
+import type { CeramicPlugin, CeramicPluginDependentMethods, CeramicArgs } from './types';
+/**
+ * @group Plugins
+ */
+export declare const getCeramicPlugin: (learnCard: LearnCard<any, any, CeramicPluginDependentMethods>, { ceramicEndpoint, defaultContentFamily }: CeramicArgs) => Promise<CeramicPlugin>;

package/dist/helpers.d.ts

@@ -0,0 +1,3 @@
+import { StreamID } from '@ceramicnetwork/streamid';
+import { CeramicURI } from './types';
+export declare const streamIdToCeramicURI: (id: string | StreamID) => CeramicURI;

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { getCeramicPlugin } from './ceramic';
+export { getCeramicPlugin } from './ceramic';
+export * from './types';
+export * from './helpers';
+export default getCeramicPlugin;

package/dist/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === 'production') {
+    module.exports = require('./ceramic-plugin.cjs.production.min.js');
+} else {
+    module.exports = require('./ceramic-plugin.cjs.development.js');
+}

package/dist/types.d.ts

@@ -0,0 +1,42 @@
+import type { DID, CreateJWEOptions, DIDResolutionResult } from 'dids';
+import { z } from 'zod';
+import { CeramicClient } from '@ceramicnetwork/http-client';
+import { Plugin } from '@learncard/core';
+import { InputMetadata } from '@learncard/didkit-plugin';
+/** @group CeramicPlugin */
+export type CeramicArgs = {
+    ceramicEndpoint: string;
+    defaultContentFamily: string;
+};
+/** @group CeramicPlugin */
+export type CeramicURI = `lc:ceramic:${string}`;
+/** @group CeramicPlugin */
+export declare const CeramicURIValidator: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
+/**
+ * Settings for toggling JWE Encryption before uploading to Ceramic.
+ * @group CeramicPlugin
+ * @param encrypt enable JWE encryption on upload.
+ * @param controllersCanDecrypt helper to add Ceramic controller DIDs to recipients who can decrypt the JWE credential.
+ * @param recipients DIDs who can decrypt the JWE credential.
+ * @param options additional CreateJWEOptions for encryption.
+ */
+export type CeramicEncryptionParams = {
+    encrypt: boolean;
+    controllersCanDecrypt?: boolean;
+    recipients?: string[] | undefined;
+    options?: CreateJWEOptions | undefined;
+};
+/** @group CeramicPlugin */
+export type CeramicPluginMethods = {
+    publishContentToCeramic: (cred: any, encryption: CeramicEncryptionParams | undefined) => Promise<CeramicURI>;
+    readContentFromCeramic: (streamId: string) => Promise<any>;
+    getCeramicClient: () => CeramicClient;
+    getDIDObject: () => DID;
+};
+/** @group CeramicPlugin */
+export type CeramicPluginDependentMethods = {
+    getKey: () => string;
+    didResolver: (did: string, inputMetadata?: InputMetadata) => Promise<DIDResolutionResult>;
+};
+/** @group CeramicPlugin */
+export type CeramicPlugin = Plugin<'Ceramic', 'read' | 'store', CeramicPluginMethods>;

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@learncard/ceramic-plugin",
+  "version": "1.0.0",
+  "description": "",
+  "main": "./dist/index.js",
+  "module": "./dist/ceramic-plugin.esm.js",
+  "private": false,
+  "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/lodash": "^4.14.191",
+    "@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",
+    "shx": "^0.3.4",
+    "ts-jest": "^29.0.3",
+    "@learncard/didkit-plugin": "1.0.0"
+  },
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@ceramicnetwork/common": "2.13.0",
+    "@ceramicnetwork/http-client": "2.7.0",
+    "@ceramicnetwork/stream-tile": "2.9.0",
+    "@glazed/tile-loader": "0.2.1",
+    "did-jwt": "5.9.0",
+    "dids": "^3.2.0",
+    "hex-lite": "^1.5.0",
+    "key-did-provider-ed25519": "^2.0.0",
+    "key-did-resolver": "2.3.0",
+    "lodash": "^4.17.21",
+    "@learncard/types": "5.3.0",
+    "@learncard/core": "9.0.0"
+  },
+  "scripts": {
+    "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.js && tsc --p tsconfig.json",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --silent --ci --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\""
+  }
+}