@learncard/lca-api-plugin 1.2.23 → 2.0.0

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>;
@@ -800,5 +800,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.0",
     "description": "",
     "type": "module",
     "main": "./dist/index.cjs",
@@ -52,10 +52,10 @@
     },
     "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/core": "9.4.30",
+        "@learncard/didkit-plugin": "1.9.10",
+        "@learncard/init": "2.4.11",
+        "@learncard/lca-api-client": "1.2.4",
         "@learncard/types": "5.18.1",
         "hex-lite": "^1.5.0",
         "isomorphic-fetch": "^3.0.0",

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: {
@@ -548,6 +549,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,40 @@
+import { getClient } from '@learncard/lca-api-client';
+
+import { getLCAPlugin } from '../plugin';
+
+jest.mock('@learncard/lca-api-client', () => ({ getClient: jest.fn() }), { virtual: true });
+
+const mockedGetClient = jest.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 = jest.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 */
@@ -396,4 +396,7 @@ export type LCAPlugin = Plugin<
     LCAPluginMethods,
     'id',
     LCAPluginDependentMethods
->;
+> & {
+    /** Whether the plugin fell back because its initial LCA API setup failed. */
+    isOffline: boolean;
+};