@jskit-ai/shell-web 0.1.86 → 0.1.87

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/shell-web",
-  version: "0.1.86",
+  version: "0.1.87",
   kind: "runtime",
   description: "Web shell layout runtime with outlet-based placement contributions.",
   dependsOn: [],
@@ -294,7 +294,7 @@ export default Object.freeze({
     dependencies: {
       runtime: {
         "@mdi/js": "^7.4.47",
-        "@jskit-ai/kernel": "0.1.87"
+        "@jskit-ai/kernel": "0.1.88"
       },
       dev: {}
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/shell-web",
-  "version": "0.1.86",
+  "version": "0.1.87",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -9,6 +9,7 @@
     "./client": "./src/client/index.js",
     "./client/error": "./src/client/error/index.js",
     "./client/placement": "./src/client/placement/index.js",
+    "./client/asyncModuleRecovery": "./src/client/asyncModuleRecovery/index.js",
     "./client/bootstrap": "./src/client/bootstrap/index.js",
     "./server/support/localLinkItemScaffolds": "./src/server/support/localLinkItemScaffolds.js",
     "./client/navigation/linkResolver": "./src/client/navigation/linkResolver.js",
@@ -26,7 +27,7 @@
   },
   "dependencies": {
     "@mdi/js": "^7.4.47",
-    "@jskit-ai/kernel": "0.1.87"
+    "@jskit-ai/kernel": "0.1.88"
   },
   "peerDependencies": {
     "pinia": "^3.0.4",

package/src/client/asyncModuleRecovery/index.js

@@ -0,0 +1,4 @@
+export {
+  SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY,
+  useShellAsyncModuleRecoveryRuntime
+} from "./inject.js";

package/src/client/asyncModuleRecovery/inject.js

@@ -0,0 +1,30 @@
+import {
+  hasInjectionContext,
+  inject
+} from "vue";
+
+const SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY =
+  "jskit.shell-web.runtime.web-async-module-recovery.client";
+
+function isShellAsyncModuleRecoveryRuntime(value) {
+  return Boolean(
+    value &&
+      typeof value.notify === "function" &&
+      typeof value.reload === "function"
+  );
+}
+
+function useShellAsyncModuleRecoveryRuntime() {
+  if (!hasInjectionContext()) {
+    return null;
+  }
+
+  const runtime = inject(SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY, null);
+  return isShellAsyncModuleRecoveryRuntime(runtime) ? runtime : null;
+}
+
+export {
+  SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY,
+  isShellAsyncModuleRecoveryRuntime,
+  useShellAsyncModuleRecoveryRuntime
+};

package/src/client/index.js

@@ -17,6 +17,10 @@ export { default as ShellTabLinkItem } from "./components/ShellTabLinkItem.vue";
 export { useShellLayoutState } from "./composables/useShellLayoutState.js";
 export { useShellLayoutStore } from "./stores/useShellLayoutStore.js";
 export { useShellErrorPresentationStore } from "./stores/useShellErrorPresentationStore.js";
+export {
+  SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY,
+  useShellAsyncModuleRecoveryRuntime
+} from "./asyncModuleRecovery/index.js";
 export {
   BOOTSTRAP_PAYLOAD_HANDLER_TAG,
   registerBootstrapPayloadHandler,

package/src/client/providers/ShellWebClientProvider.js

@@ -10,6 +10,9 @@ import {
   isMissingDynamicModule,
   notifyDynamicImportFailure
 } from "./appModuleLoadFailure.js";
+import {
+  SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY
+} from "../asyncModuleRecovery/inject.js";
 import {
   isRecord
 } from "@jskit-ai/kernel/shared/support";
@@ -654,7 +657,7 @@ class ShellWebClientProvider {
     vueApp.provide("jskit.shell-web.runtime.web-placement.client", placementRuntime);
     vueApp.provide("jskit.shell-web.runtime.web-refresh.client", refreshRuntime);
     vueApp.provide("jskit.shell-web.runtime.web-error.client", errorRuntime);
-    vueApp.provide("jskit.shell-web.runtime.web-async-module-recovery.client", asyncModuleRecoveryRuntime);
+    vueApp.provide(SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY, asyncModuleRecoveryRuntime);
     vueApp.provide(
       "jskit.shell-web.runtime.web-error.presentation-store.client",
       errorPresentationStore

package/test/asyncModuleRecoveryInject.test.js

@@ -0,0 +1,49 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+import { createApp } from "vue";
+import {
+  SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY,
+  useShellAsyncModuleRecoveryRuntime
+} from "../src/client/asyncModuleRecovery/index.js";
+
+test("shell async module recovery runtime composable returns null outside Vue injection context", () => {
+  assert.equal(useShellAsyncModuleRecoveryRuntime(), null);
+});
+
+test("shell async module recovery runtime composable resolves the provided public runtime", async () => {
+  const runtime = {
+    notify(error, options) {
+      return { error, options };
+    },
+    async reload() {
+      return true;
+    }
+  };
+  const app = createApp({
+    render() {
+      return null;
+    }
+  });
+  app.provide(SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY, runtime);
+
+  assert.equal(
+    app.runWithContext(() => useShellAsyncModuleRecoveryRuntime()),
+    runtime
+  );
+});
+
+test("shell async module recovery runtime composable rejects incomplete runtimes", () => {
+  const app = createApp({
+    render() {
+      return null;
+    }
+  });
+  app.provide(SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY, {
+    notify() {}
+  });
+
+  assert.equal(
+    app.runWithContext(() => useShellAsyncModuleRecoveryRuntime()),
+    null
+  );
+});

package/test/provider.test.js

@@ -8,6 +8,9 @@ import {
 import {
   isMissingDynamicModule
 } from "../src/client/providers/appModuleLoadFailure.js";
+import {
+  SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY
+} from "../src/client/asyncModuleRecovery/index.js";
 import { useShellErrorPresentationStore } from "../src/client/stores/useShellErrorPresentationStore.js";
 const CLIENT_APP_CONFIG_GLOBAL_KEY = "__JSKIT_CLIENT_APP_CONFIG__";
 
@@ -229,7 +232,7 @@ test("shell web client provider binds runtime and injects it into Vue app", asyn
     assert.equal(providedByKey.has("jskit.shell-web.runtime.web-placement.client"), true);
     assert.equal(providedByKey.has("jskit.shell-web.runtime.web-refresh.client"), true);
     assert.equal(providedByKey.has("jskit.shell-web.runtime.web-error.client"), true);
-    assert.equal(providedByKey.has("jskit.shell-web.runtime.web-async-module-recovery.client"), true);
+    assert.equal(providedByKey.has(SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY), true);
     assert.equal(providedByKey.has("jskit.shell-web.runtime.web-error.presentation-store.client"), true);
 
     const placementRuntime = providedByKey.get("jskit.shell-web.runtime.web-placement.client");
@@ -245,7 +248,7 @@ test("shell web client provider binds runtime and injects it into Vue app", asyn
     const refreshRuntime = providedByKey.get("jskit.shell-web.runtime.web-refresh.client");
     assert.equal(typeof refreshRuntime.refresh, "function");
 
-    const asyncModuleRecoveryRuntime = providedByKey.get("jskit.shell-web.runtime.web-async-module-recovery.client");
+    const asyncModuleRecoveryRuntime = providedByKey.get(SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY);
     assert.equal(typeof asyncModuleRecoveryRuntime.install, "function");
     assert.equal(typeof asyncModuleRecoveryRuntime.notify, "function");
     assert.equal(typeof asyncModuleRecoveryRuntime.reload, "function");

package/test/settingsPlacementContract.test.js

@@ -148,6 +148,29 @@ test("shell-web installs generated adaptive shell Playwright smoke coverage", as
   assert.equal(packageJson?.exports?.["./test/adaptiveShellSmoke"], "./src/test/adaptiveShellSmoke.js");
 });
 
+test("shell-web exports async module recovery runtime access as a public client API", async () => {
+  const packageJson = JSON.parse(await readFile(path.join(PACKAGE_DIR, "package.json"), "utf8"));
+  const clientIndex = await readFile(path.join(PACKAGE_DIR, "src", "client", "index.js"), "utf8");
+  const recoveryIndex = await readFile(
+    path.join(PACKAGE_DIR, "src", "client", "asyncModuleRecovery", "index.js"),
+    "utf8"
+  );
+  const providerSource = await readFile(
+    path.join(PACKAGE_DIR, "src", "client", "providers", "ShellWebClientProvider.js"),
+    "utf8"
+  );
+
+  assert.equal(
+    packageJson?.exports?.["./client/asyncModuleRecovery"],
+    "./src/client/asyncModuleRecovery/index.js"
+  );
+  assert.match(clientIndex, /useShellAsyncModuleRecoveryRuntime/);
+  assert.match(clientIndex, /SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY/);
+  assert.match(recoveryIndex, /useShellAsyncModuleRecoveryRuntime/);
+  assert.match(recoveryIndex, /SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY/);
+  assert.match(providerSource, /SHELL_ASYNC_MODULE_RECOVERY_RUNTIME_KEY/);
+});
+
 test("shell-web route transition keeps mobile route motion placement-driven", async () => {
   const source = await readFile(
     path.join(PACKAGE_DIR, "src", "client", "components", "ShellRouteTransition.vue"),