@learncard/lca-api-plugin 1.2.23 → 2.0.1

package/dist/test/plugin-mode.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types.d.ts

@@ -72,8 +72,8 @@ export declare const SigningAuthorityValidator: z.ZodObject<{
     _id: z.ZodOptional<z.ZodString>;
     ownerDid: z.ZodString;
     name: z.ZodString;
-    did: z.ZodOptional<z.ZodString>;
-    endpoint: z.ZodOptional<z.ZodString>;
+    did: z.ZodString;
+    endpoint: z.ZodString;
 }, z.core.$strip>;
 /** @group LCA API Plugin */
 export type SigningAuthorityType = z.infer<typeof SigningAuthorityValidator>;
@@ -346,7 +346,12 @@ export declare const NotificationValidator: z.ZodObject<{
             }, z.core.$strip>;
             timestamp: z.ZodOptional<z.ZodISODateTime>;
         }, z.core.$strip>>;
-        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        metadata: z.ZodOptional<z.ZodObject<{
+            connectionPrompt: z.ZodOptional<z.ZodObject<{
+                promptId: z.ZodString;
+                counterpartProfileId: z.ZodString;
+            }, z.core.$strip>>;
+        }, z.core.$catchall<z.ZodUnknown>>>;
     }, z.core.$loose>>;
     sent: z.ZodOptional<z.ZodISODateTime>;
     webhookUrl: z.ZodOptional<z.ZodString>;
@@ -547,7 +552,12 @@ export declare const PaginatedNotificationsValidator: z.ZodObject<{
                 }, z.core.$strip>;
                 timestamp: z.ZodOptional<z.ZodISODateTime>;
             }, z.core.$strip>>;
-            metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            metadata: z.ZodOptional<z.ZodObject<{
+                connectionPrompt: z.ZodOptional<z.ZodObject<{
+                    promptId: z.ZodString;
+                    counterpartProfileId: z.ZodString;
+                }, z.core.$strip>>;
+            }, z.core.$catchall<z.ZodUnknown>>>;
         }, z.core.$loose>>;
         sent: z.ZodOptional<z.ZodISODateTime>;
         webhookUrl: z.ZodOptional<z.ZodString>;
@@ -727,7 +737,7 @@ export type LCAPluginMethods = {
     getSigningAuthorities: () => Promise<SigningAuthorityType[] | false>;
     authorizeSigningAuthority: (name: string, authorization: SigningAuthorityAuthorization) => Promise<boolean>;
     resetLCAClient: () => Promise<void>;
-    generateBoostInfo: (description: string) => Promise<{
+    generateBoostInfo: (description: string, locale?: string) => Promise<{
         title: string;
         description: string;
         category: string;
@@ -800,5 +810,8 @@ export type LCAPluginMethods = {
     }>;
 };
 /** @group LearnCardNetwork Plugin */
-export type LCAPlugin = Plugin<'LearnCard App', never, LCAPluginMethods, 'id', LCAPluginDependentMethods>;
+export type LCAPlugin = Plugin<'LearnCard App', never, LCAPluginMethods, 'id', LCAPluginDependentMethods> & {
+    /** Whether the plugin fell back because its initial LCA API setup failed. */
+    isOffline: boolean;
+};
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@learncard/lca-api-plugin",
-    "version": "1.2.23",
+    "version": "2.0.1",
     "description": "",
     "type": "module",
     "main": "./dist/index.cjs",
@@ -24,9 +24,9 @@
     ],
     "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",
-        "test:watch": "jest --watch",
-        "test:coverage": "jest --silent --ci --coverage --coverageReporters=\"text\" --coverageReporters=\"text-summary\""
+        "test": "vitest run",
+        "test:watch": "vitest",
+        "test:coverage": "vitest run --coverage"
     },
     "author": "WeLibrary, LLC (www.welibrary.io)",
     "license": "MIT",
@@ -39,24 +39,20 @@
         "url": "https://github.com/learningeconomy/LearnCard/issues"
     },
     "devDependencies": {
-        "@types/jest": "^29.2.2",
         "@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",
         "rimraf": "^3.0.2",
-        "shx": "^0.3.4",
-        "ts-jest": "^29.0.3"
+        "shx": "^0.3.4"
     },
     "types": "./dist/index.d.ts",
     "dependencies": {
-        "@learncard/core": "9.4.29",
-        "@learncard/didkit-plugin": "1.9.9",
-        "@learncard/init": "2.4.10",
-        "@learncard/lca-api-client": "1.2.3",
-        "@learncard/types": "5.18.1",
+        "@learncard/core": "9.4.31",
+        "@learncard/didkit-plugin": "1.9.11",
+        "@learncard/init": "2.4.12",
+        "@learncard/lca-api-client": "1.2.4",
+        "@learncard/types": "5.18.2",
         "hex-lite": "^1.5.0",
         "isomorphic-fetch": "^3.0.0",
         "isomorphic-webcrypto": "^2.3.8",

package/src/plugin.ts

@@ -114,6 +114,7 @@ export const getLCAPlugin = async (
 
         return {
             name: 'LearnCard App',
+            isOffline: false,
             displayName: 'LearnCard App Plugin',
             description: 'Adds bespoke logic to the LearnCard App.',
             methods: {
@@ -199,11 +200,14 @@ export const getLCAPlugin = async (
                     client = await getNewClient(url, _learnCard);
                     learnCard = _learnCard;
                 },
-                generateBoostInfo: async (_learnCard, description) => {
+                generateBoostInfo: async (_learnCard, description, locale) => {
                     await initialized;
                     await updateLearnCard(_learnCard);
 
-                    const result = await client.ai.generateBoostInfo.query({ description });
+                    const result = await client.ai.generateBoostInfo.query({
+                        description,
+                        locale,
+                    });
 
                     return {
                         title: result.title,
@@ -548,6 +552,7 @@ export const getLCAPlugin = async (
         );
         return {
             name: 'LearnCard App',
+            isOffline: true,
             displayName: 'LearnCard App Plugin (Offline)',
             description: 'Adds bespoke logic to the LearnCard App. (Unable to connect to LCA API)',
             methods: {

package/src/test/plugin-mode.test.ts

@@ -0,0 +1,41 @@
+import { vi } from 'vitest';
+import { getClient } from '@learncard/lca-api-client';
+
+import { getLCAPlugin } from '../plugin';
+
+vi.mock('@learncard/lca-api-client', () => ({ getClient: vi.fn() }));
+
+const mockedGetClient = vi.mocked(getClient);
+
+const learnCard = {
+    id: { did: () => 'did:key:z6MkTest' },
+    invoke: { getProfile: () => new Promise<never>(() => undefined) },
+};
+
+describe('getLCAPlugin', () => {
+    beforeEach(() => {
+        mockedGetClient.mockReset();
+    });
+
+    it('reports when initial setup falls back to offline mode', async () => {
+        const consoleError = vi.spyOn(console, 'error').mockImplementation(() => undefined);
+
+        try {
+            mockedGetClient.mockRejectedValueOnce(new Error('connection failed'));
+
+            const plugin = await getLCAPlugin(learnCard as never, 'https://example.com/trpc');
+
+            expect(plugin.isOffline).toBe(true);
+        } finally {
+            consoleError.mockRestore();
+        }
+    });
+
+    it('reports when initial setup remains online', async () => {
+        mockedGetClient.mockResolvedValueOnce({} as never);
+
+        const plugin = await getLCAPlugin(learnCard as never, 'https://example.com/trpc');
+
+        expect(plugin.isOffline).toBe(false);
+    });
+});

package/src/types.ts

@@ -92,8 +92,8 @@ export const SigningAuthorityValidator = z.object({
     _id: z.string().optional(),
     ownerDid: z.string(),
     name: z.string(),
-    did: z.string().optional(),
-    endpoint: z.string().optional(),
+    did: z.string(),
+    endpoint: z.string(),
 });
 
 /** @group LCA API Plugin */
@@ -293,7 +293,10 @@ export type LCAPluginMethods = {
         authorization: SigningAuthorityAuthorization
     ) => Promise<boolean>;
     resetLCAClient: () => Promise<void>;
-    generateBoostInfo: (description: string) => Promise<{
+    generateBoostInfo: (
+        description: string,
+        locale?: string
+    ) => Promise<{
         title: string;
         description: string;
         category: string;
@@ -396,4 +399,7 @@ export type LCAPlugin = Plugin<
     LCAPluginMethods,
     'id',
     LCAPluginDependentMethods
->;
+> & {
+    /** Whether the plugin fell back because its initial LCA API setup failed. */
+    isOffline: boolean;
+};