@learncard/learn-cloud-plugin 2.3.29 → 2.3.31

package/package.json

@@ -1,64 +1,66 @@
 {
-  "name": "@learncard/learn-cloud-plugin",
-  "version": "2.3.29",
-  "description": "",
-  "type": "module",
-  "main": "./dist/index.cjs",
-  "module": "./dist/learn-cloud-plugin.esm.js",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/learn-cloud-plugin.esm.js"
-      },
-      "require": {
-        "types": "./dist/index.d.cts",
-        "default": "./dist/index.cjs"
-      }
-    }
-  },
-  "files": [
-    "dist"
-  ],
-  "author": "Learning Economy Foundation (www.learningeconomy.io)",
-  "license": "MIT",
-  "homepage": "https://github.com/learningeconomy/LearnCard/tree/main/packages/plugins/learn-cloud/README.md",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/learningeconomy/LearnCard"
-  },
-  "bugs": {
-    "url": "https://github.com/learningeconomy/LearnCard/issues"
-  },
-  "devDependencies": {
-    "@types/jest": "^29.2.2",
-    "@types/lodash": "^4.14.191",
-    "@types/node": "^17.0.31",
-    "aqu": "0.4.3",
-    "esbuild": "^0.27.1",
-    "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/learn-cloud-service": "^2.5.22",
-    "@learncard/types": "5.17.4"
-  },
-  "types": "./dist/index.d.ts",
-  "dependencies": {
-    "json-stringify-deterministic": "^1.0.8",
-    "lodash": "^4.17.21",
-    "pbkdf2-hmac": "^1.2.1",
-    "@learncard/core": "9.4.24",
-    "@learncard/helpers": "^1.3.6",
-    "@learncard/didkit-plugin": "1.9.4",
-    "@learncard/learn-cloud-client": "1.6.29"
-  },
-  "sideEffects": false,
-  "scripts": {
-    "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.cjs && tsc --p tsconfig.json && shx cp ./dist/index.d.ts ./dist/index.d.cts",
-    "test": "jest --passWithNoTests",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --silent --ci --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\""
-  }
-}
+    "name": "@learncard/learn-cloud-plugin",
+    "version": "2.3.31",
+    "description": "",
+    "type": "module",
+    "main": "./dist/index.cjs",
+    "module": "./dist/learn-cloud-plugin.esm.js",
+    "exports": {
+        ".": {
+            "development": "./src/index.ts",
+            "import": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/learn-cloud-plugin.esm.js"
+            },
+            "require": {
+                "types": "./dist/index.d.cts",
+                "default": "./dist/index.cjs"
+            }
+        }
+    },
+    "files": [
+        "dist",
+        "src"
+    ],
+    "scripts": {
+        "build": "node ./scripts/build.mjs && shx cp ./scripts/mixedEntypoint.js ./dist/index.cjs && tsc --p tsconfig.json && shx cp ./dist/index.d.ts ./dist/index.d.cts",
+        "test": "jest --passWithNoTests",
+        "test:watch": "jest --watch",
+        "test:coverage": "jest --silent --ci --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\""
+    },
+    "author": "Learning Economy Foundation (www.learningeconomy.io)",
+    "license": "MIT",
+    "homepage": "https://github.com/learningeconomy/LearnCard/tree/main/packages/plugins/learn-cloud/README.md",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/learningeconomy/LearnCard"
+    },
+    "bugs": {
+        "url": "https://github.com/learningeconomy/LearnCard/issues"
+    },
+    "devDependencies": {
+        "@learncard/learn-cloud-service": "^2.5.24",
+        "@learncard/types": "5.17.5",
+        "@types/jest": "^29.2.2",
+        "@types/lodash": "^4.14.191",
+        "@types/node": "^17.0.31",
+        "aqu": "0.4.3",
+        "esbuild": "^0.27.1",
+        "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": {
+        "@learncard/core": "9.4.26",
+        "@learncard/didkit-plugin": "1.9.6",
+        "@learncard/helpers": "^1.3.8",
+        "@learncard/learn-cloud-client": "1.6.31",
+        "json-stringify-deterministic": "^1.0.8",
+        "lodash": "^4.17.21",
+        "pbkdf2-hmac": "^1.2.1"
+    },
+    "sideEffects": false
+}

package/src/helpers.ts

@@ -0,0 +1,87 @@
+import { JWE, EncryptedRecord } from '@learncard/types';
+import stringify from 'json-stringify-deterministic';
+import pbkdf2Hmac from 'pbkdf2-hmac';
+
+import { LearnCloudDependentLearnCard } from './types';
+
+export const hash = async (
+    learnCard: LearnCloudDependentLearnCard,
+    message: string
+): Promise<string> => {
+    const lcHash = await learnCard.invoke.hash?.(message, 'PBKDF2-HMAC-SHA256');
+
+    if (lcHash) return lcHash;
+
+    const crypto = learnCard.invoke.crypto();
+
+    const uint8Message = new TextEncoder().encode(message);
+
+    const pk = learnCard.id.keypair('secp256k1').d;
+    const hmacKey = await pbkdf2Hmac(pk, 'salt', 1000, 32);
+    const cryptoKey = await crypto.subtle.importKey(
+        'raw',
+        hmacKey,
+        { name: 'HMAC', hash: 'SHA-256' },
+        false,
+        ['sign']
+    );
+
+    const digestBuffer = await crypto.subtle.sign('HMAC', cryptoKey, uint8Message);
+
+    const digestArray = Array.from(new Uint8Array(digestBuffer));
+
+    return digestArray.map(byte => (byte as any).toString(16).padStart(2, '0')).join('');
+};
+
+export const generateJWE = async (
+    learnCard: LearnCloudDependentLearnCard,
+    learnCloudDid: string,
+    item: any
+): Promise<JWE> => {
+    return learnCard.invoke.createDagJwe(item, [learnCloudDid]);
+};
+
+export const decryptJWE = async <T>(
+    learnCard: LearnCloudDependentLearnCard,
+    jwe: JWE
+): Promise<T> => {
+    return learnCard.invoke.decryptDagJwe<T>(jwe);
+};
+
+export const generateEncryptedFieldsArray = async (
+    learnCard: LearnCloudDependentLearnCard,
+    record: Record<string, any>,
+    unencryptedFields: string[] = []
+): Promise<string[]> => {
+    const entries = Object.entries(record);
+
+    return (
+        await Promise.all(
+            entries.map(async ([key, value]) => {
+                if (!unencryptedFields.includes(key)) {
+                    const result = await hash(learnCard, `${key}:${stringify(value)}`);
+
+                    return result;
+                }
+
+                return '';
+            })
+        )
+    ).filter(Boolean);
+};
+
+export const generateEncryptedRecord = async (
+    learnCard: LearnCloudDependentLearnCard,
+    record: Record<string, any>,
+    unencryptedFields: string[] = []
+): Promise<EncryptedRecord> => {
+    const encryptedRecord = await learnCard.invoke.createDagJwe(record);
+
+    const fields = await generateEncryptedFieldsArray(learnCard, record, unencryptedFields);
+
+    const unencryptedEntries = Object.fromEntries(
+        Object.entries(record).filter(([key]) => unencryptedFields.includes(key))
+    );
+
+    return { ...unencryptedEntries, encryptedRecord, fields };
+};

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export * from './plugin';