@jskit-ai/realtime 0.1.64 → 0.1.66

package/package.descriptor.mjs

@@ -1,7 +1,7 @@
 export default Object.freeze({
   packageVersion: 1,
   packageId: "@jskit-ai/realtime",
-  version: "0.1.64",
+  version: "0.1.66",
   kind: "runtime",
   description: "Thin, generic realtime runtime wrappers for socket.io server and client.",
   options: {
@@ -81,7 +81,8 @@ export default Object.freeze({
         contributions: [
           {
             id: "realtime.connection.indicator",
-            target: "shell-layout:top-right",
+            target: "shell.status",
+            kind: "component",
             surfaces: ["*"],
             order: 950,
             componentToken: "realtime.web.connection.indicator",
@@ -94,7 +95,7 @@ export default Object.freeze({
   mutations: {
     dependencies: {
       runtime: {
-        "@jskit-ai/kernel": "0.1.65",
+        "@jskit-ai/kernel": "0.1.67",
         "@socket.io/redis-adapter": "^8.3.0",
         "redis": "^5.8.2",
         "socket.io": "^4.8.3",
@@ -133,7 +134,7 @@ export default Object.freeze({
         position: "bottom",
         skipIfContains: "id: \"realtime.connection.indicator\"",
         value:
-          "\naddPlacement({\n  id: \"realtime.connection.indicator\",\n  target: \"shell-layout:top-right\",\n  surfaces: [\"*\"],\n  order: 950,\n  componentToken: \"realtime.web.connection.indicator\"\n});\n",
+          "\naddPlacement({\n  id: \"realtime.connection.indicator\",\n  target: \"shell.status\",\n  kind: \"component\",\n  surfaces: [\"*\"],\n  order: 950,\n  componentToken: \"realtime.web.connection.indicator\"\n});\n",
         reason: "Append realtime connection indicator placement into app-owned placement registry.",
         category: "realtime-web",
         id: "realtime-placement-indicator"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/realtime",
-  "version": "0.1.64",
+  "version": "0.1.66",
   "type": "module",
   "scripts": {
     "test": "node --test"
@@ -16,7 +16,7 @@
   },
   "dependencies": {
     "@socket.io/redis-adapter": "^8.3.0",
-    "@jskit-ai/kernel": "0.1.65",
+    "@jskit-ai/kernel": "0.1.67",
     "redis": "^5.8.2",
     "socket.io": "^4.8.3",
     "socket.io-client": "^4.8.3"

package/src/client/RealtimeClientProvider.js

@@ -10,6 +10,18 @@ const REALTIME_RUNTIME_CLIENT_API = Object.freeze({
   disconnectSocketIoClient
 });
 
+function isCapacitorRuntimeAvailable(app) {
+  if (!app || typeof app.has !== "function" || typeof app.make !== "function") {
+    return false;
+  }
+  if (app.has("mobile.capacitor.adapter.client") !== true) {
+    return false;
+  }
+
+  const adapter = app.make("mobile.capacitor.adapter.client");
+  return adapter?.available === true;
+}
+
 function resolveRealtimeClientConfig(app) {
   const appConfig = normalizeObject(getClientAppConfig());
   const env = app && typeof app.has === "function" && app.has("jskit.client.env") ? normalizeObject(app.make("jskit.client.env")) : {};
@@ -18,7 +30,9 @@ function resolveRealtimeClientConfig(app) {
   const mobileConfig = resolveMobileConfig({
     mobile: normalizeObject(appConfig.mobile)
   });
-  const url = normalizeText(realtimeClient.url || (mobileConfig.enabled === true ? mobileConfig.apiBaseUrl : ""));
+  const url = normalizeText(
+    realtimeClient.url || (mobileConfig.enabled === true && isCapacitorRuntimeAvailable(app) ? mobileConfig.apiBaseUrl : "")
+  );
   const options = normalizeObject(realtimeClient.options);
   const explicitDebugEnabled =
     typeof realtimeClient.debug === "boolean"

package/test/providerRuntime.test.js

@@ -248,7 +248,7 @@ test("RealtimeClientProvider registers runtime realtime client api", () => {
   assert.equal(typeof api.disconnectSocketIoClient, "function");
 });
 
-test("RealtimeClientProvider uses mobile.apiBaseUrl when realtimeClient.url is unset", () => {
+test("RealtimeClientProvider uses mobile.apiBaseUrl only inside the Capacitor runtime", () => {
   const previousAppConfig = globalThis[CLIENT_APP_CONFIG_GLOBAL_KEY];
   const calls = [];
   const socket = {
@@ -265,6 +265,9 @@ test("RealtimeClientProvider uses mobile.apiBaseUrl when realtimeClient.url is u
     });
 
     const app = createSingletonApp();
+    app.instance("mobile.capacitor.adapter.client", {
+      available: true
+    });
     app.instance("runtime.realtime.client", {
       createSocketIoClient(input = {}) {
         calls.push(input);
@@ -292,6 +295,53 @@ test("RealtimeClientProvider uses mobile.apiBaseUrl when realtimeClient.url is u
   }
 });
 
+test("RealtimeClientProvider keeps web socket connections URL-less when mobile is installed outside Capacitor", () => {
+  const previousAppConfig = globalThis[CLIENT_APP_CONFIG_GLOBAL_KEY];
+  const calls = [];
+  const socket = {
+    on() {},
+    off() {},
+    disconnect() {}
+  };
+  try {
+    setClientAppConfig({
+      mobile: {
+        enabled: true,
+        apiBaseUrl: "http://127.0.0.1:3000"
+      }
+    });
+
+    const app = createSingletonApp();
+    app.instance("mobile.capacitor.adapter.client", {
+      available: false
+    });
+    app.instance("runtime.realtime.client", {
+      createSocketIoClient(input = {}) {
+        calls.push(input);
+        return socket;
+      },
+      disconnectSocketIoClient() {}
+    });
+
+    const provider = new RealtimeClientProvider();
+    provider.register(app);
+
+    assert.equal(app.make("runtime.realtime.client.socket"), socket);
+    assert.deepEqual(calls, [
+      {
+        url: "",
+        options: {}
+      }
+    ]);
+  } finally {
+    if (previousAppConfig === undefined) {
+      delete globalThis[CLIENT_APP_CONFIG_GLOBAL_KEY];
+    } else {
+      globalThis[CLIENT_APP_CONFIG_GLOBAL_KEY] = previousAppConfig;
+    }
+  }
+});
+
 test("RealtimeClientProvider boots socket listeners and disconnects on shutdown", async () => {
   const app = createSingletonApp();
   const provider = new RealtimeClientProvider();