@learncard/idx-plugin 1.0.0

package/dist/idx.d.ts

@@ -0,0 +1,6 @@
+import { LearnCard } from '@learncard/core';
+import { IDXPlugin, IDXPluginDependentMethods, IDXArgs } from './types';
+/**
+ * @group Plugins
+ */
+export declare const getIDXPlugin: (learnCard: LearnCard<any, 'read', IDXPluginDependentMethods>, { modelData, credentialAlias }: IDXArgs) => Promise<IDXPlugin>;

package/dist/index.d.ts

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

package/dist/index.js

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

package/dist/types.d.ts

@@ -0,0 +1,53 @@
+import { ModelAliases } from '@glazed/types';
+import { z } from 'zod';
+import { StreamID } from '@ceramicnetwork/streamid';
+import { Plugin } from '@learncard/core';
+import { VC, CredentialRecord } from '@learncard/types';
+import { CeramicClient } from '@ceramicnetwork/http-client';
+/** @group IDXPlugin */
+export type IDXIndexObject<IDXMetadata extends Record<string, any>, Metadata extends Record<string, any>> = {
+    credentials: CredentialRecord<Metadata>[];
+} & IDXMetadata;
+/** @group IDXPlugin */
+export type IDXArgs = {
+    modelData: ModelAliases;
+    credentialAlias: string;
+};
+/** @group IDXPlugin */
+export type IDXPluginMethods = {
+    getCredentialsListFromIdx: <Metadata extends Record<string, any> = Record<never, never>>(alias?: string) => Promise<CredentialRecord<Metadata>[]>;
+    getVerifiableCredentialFromIdx: (id: string) => Promise<VC | undefined>;
+    getVerifiableCredentialsFromIdx: () => Promise<VC[]>;
+    addVerifiableCredentialInIdx: <Metadata extends Record<string, any> = Record<never, never>>(cred: CredentialRecord<Metadata>) => Promise<string>;
+    removeVerifiableCredentialInIdx: (title: string) => Promise<StreamID>;
+    removeAllVerifiableCredentialsInIdx: () => Promise<StreamID>;
+    getIDXIndex: <IDXMetadata extends Record<string, any>, Metadata extends Record<string, any>>() => Promise<IDXIndexObject<IDXMetadata, Metadata> | null>;
+    setIDXIndex: <IDXMetadata extends Record<string, any>, Metadata extends Record<string, any>>(index: IDXIndexObject<IDXMetadata, Metadata>) => Promise<StreamID>;
+};
+/** @group IDXPlugin */
+export type IDXPluginDependentMethods = {
+    getCeramicClient: () => CeramicClient;
+};
+/** @group IDXPlugin */
+export type CredentialsList<Metadata extends Record<string, any> = Record<never, never>> = {
+    credentials: Array<CredentialRecord<Metadata>>;
+};
+/** @group IDXPlugin */
+export declare const CredentialsListValidator: z.ZodType<CredentialsList>;
+/** @group IDXPlugin */
+export type IDXPlugin = Plugin<'IDX', 'index', IDXPluginMethods, 'read', IDXPluginDependentMethods>;
+/** @group IDXPlugin */
+export type BackwardsCompatIDXCredential<Metadata extends Record<string, any> = Record<never, never>> = {
+    [key: string]: any;
+    id: string;
+    title: string;
+    storageType?: 'ceramic';
+} & Metadata;
+/** @group IDXPlugin */
+export declare const BackwardsCompatIDXCredentialValidator: z.ZodType<BackwardsCompatIDXCredential>;
+/** @group IDXPlugin */
+export type BackwardsCompatCredentialsList<Metadata extends Record<string, any> = Record<never, never>> = {
+    credentials: Array<CredentialRecord<Metadata> | BackwardsCompatIDXCredential<Metadata>>;
+};
+/** @group IDXPlugin */
+export declare const BackwardsCompatCredentialsListValidator: z.ZodType<BackwardsCompatCredentialsList>;

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@learncard/idx-plugin",
+  "version": "1.0.0",
+  "description": "",
+  "main": "./dist/index.js",
+  "module": "./dist/idx-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": {
+    "@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",
+    "shx": "^0.3.4",
+    "ts-jest": "^29.0.3"
+  },
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "@ceramicnetwork/http-client": "2.7.0",
+    "@ceramicnetwork/streamid": "2.7.0",
+    "@glazed/did-datastore": "0.3.2",
+    "@learncard/core": "9.0.0",
+    "@learncard/ceramic-plugin": "^1.0.0",
+    "@learncard/types": "5.3.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\""
+  }
+}