@immediately-run/sandbox-protocol 0.4.0 → 0.6.0

package/dist/sandbox.js

@@ -1,7 +1,7 @@
 "use strict";
 // GENERATED by scripts/generate.mjs — DO NOT EDIT.
 // Source of truth: src/descriptors.protocol.mjs (@immediately-run/sandbox-protocol)
-// descriptorsHash: 4ce0c4b1d3f460e9
+// descriptorsHash: 82fbfbaeb58cdadd
 //
 // The sandbox↔SDK wire vocabulary (PLATFORM_LAYERING_SPEC §2 / S1). Import the
 // constants instead of writing the string: a rename then has ONE edit site and

package/dist/sdk.d.ts

@@ -1,11 +1,14 @@
 /** Every wire name this side speaks, as a union. */
-export type WireName = 'api-catalog' | 'auth-state' | 'compile' | 'debug-enabled' | 'debug-log' | 'debug-query' | 'debug-query-result' | 'diagnostics' | 'dnd-cancel' | 'dropped-item' | 'editor-context' | 'form-factor' | 'fs-change' | 'host-attention' | 'invitations' | 'launch-dismiss' | 'launch-ended' | 'llm-provider' | 'metadata-update' | 'mount-add' | 'mount-remove' | 'protocol-contribute' | 'protocol-dnd' | 'protocol-editor' | 'protocol-fetch' | 'protocol-ipc' | 'protocol-launch' | 'protocol-llm' | 'protocol-secrets' | 'protocol-settings' | 'protocol-spaces' | 'protocol-task' | 'protocol-theme' | 'protocol-vcs' | 'region-message' | 'request-api-catalog' | 'request-auth-state' | 'request-debug-enabled' | 'request-diagnostics' | 'request-editor-context' | 'request-form-factor' | 'request-handshake' | 'request-host-attention' | 'request-invitations' | 'request-llm-provider' | 'request-mounts' | 'request-secrets-metadata' | 'request-session-mounts' | 'request-theme' | 'request-vcs-state' | 'sdk-handshake' | 'secrets-metadata' | 'session-mounts' | 'task-cancel' | 'task-complete' | 'task-input' | 'theme' | 'urlchange' | 'vcs-state';
+export type WireName = 'api-catalog' | 'auth-state' | 'chrome-state' | 'compile' | 'debug-enabled' | 'debug-log' | 'debug-query' | 'debug-query-result' | 'diagnostics' | 'dnd-cancel' | 'dropped-item' | 'editor-context' | 'form-factor' | 'fs-change' | 'host-attention' | 'invitations' | 'launch-dismiss' | 'launch-ended' | 'llm-provider' | 'metadata-update' | 'mount-add' | 'mount-remove' | 'protocol-analytics' | 'protocol-contribute' | 'protocol-dnd' | 'protocol-editor' | 'protocol-fetch' | 'protocol-ipc' | 'protocol-launch' | 'protocol-llm' | 'protocol-secrets' | 'protocol-settings' | 'protocol-spaces' | 'protocol-task' | 'protocol-theme' | 'protocol-vcs' | 'region-message' | 'request-api-catalog' | 'request-auth-state' | 'request-chrome-state' | 'request-debug-enabled' | 'request-diagnostics' | 'request-editor-context' | 'request-form-factor' | 'request-handshake' | 'request-host-attention' | 'request-invitations' | 'request-llm-provider' | 'request-mounts' | 'request-secrets-metadata' | 'request-session-mounts' | 'request-theme' | 'request-vcs-state' | 'sdk-handshake' | 'secrets-metadata' | 'session-mounts' | 'task-cancel' | 'task-complete' | 'task-input' | 'theme' | 'urlchange' | 'vcs-state';
 /** `api-catalog` — push · host->app. polled with `request-api-catalog`. */
 export declare const API_CATALOG = "api-catalog";
 /** Read off this message today: `methods`. */
 /** `auth-state` — push · host->app. polled with `request-auth-state`. */
 export declare const AUTH_STATE = "auth-state";
 /** Read off this message today: `state`. */
+/** `chrome-state` — push · host->app. polled with `request-chrome-state`. */
+export declare const CHROME_STATE = "chrome-state";
+/** Read off this message today: `chromeState`. */
 /** `compile` — message · host->app. */
 export declare const COMPILE = "compile";
 /** `debug-enabled` — push · host->app. polled with `request-debug-enabled`. */
@@ -91,6 +94,17 @@ export declare const MOUNT_ADD = "mount-add";
 /** `mount-remove` — message · host->app. */
 export declare const MOUNT_REMOVE = "mount-remove";
 /** Read off this message today: `id`, `path`, `reason`. */
+/** `protocol-analytics` — request · app->host. */
+export declare const PROTOCOL_ANALYTICS = "protocol-analytics";
+/** Params of `protocol-analytics` method `emit`. */
+export interface ProtocolAnalyticsEmitParams {
+    name: string;
+    props?: unknown | undefined;
+}
+/** Params of `protocol-analytics` method `route`. */
+export interface ProtocolAnalyticsRouteParams {
+    path: string;
+}
 /** `protocol-contribute` — stream · app->host. */
 export declare const PROTOCOL_CONTRIBUTE = "protocol-contribute";
 /** Params of `protocol-contribute` method `run`. */
@@ -262,6 +276,8 @@ export interface RegionMessagePayload {
 export declare const REQUEST_API_CATALOG = "request-api-catalog";
 /** `request-auth-state` — poll · app->host. */
 export declare const REQUEST_AUTH_STATE = "request-auth-state";
+/** `request-chrome-state` — poll · app->host. */
+export declare const REQUEST_CHROME_STATE = "request-chrome-state";
 /** `request-debug-enabled` — poll · app->host. */
 export declare const REQUEST_DEBUG_ENABLED = "request-debug-enabled";
 /** `request-diagnostics` — poll · app->host. */
@@ -326,6 +342,7 @@ export declare const VCS_STATE = "vcs-state";
 export declare const WIRE_NAMES: {
     readonly API_CATALOG: "api-catalog";
     readonly AUTH_STATE: "auth-state";
+    readonly CHROME_STATE: "chrome-state";
     readonly COMPILE: "compile";
     readonly DEBUG_ENABLED: "debug-enabled";
     readonly DEBUG_LOG: "debug-log";
@@ -345,6 +362,7 @@ export declare const WIRE_NAMES: {
     readonly METADATA_UPDATE: "metadata-update";
     readonly MOUNT_ADD: "mount-add";
     readonly MOUNT_REMOVE: "mount-remove";
+    readonly PROTOCOL_ANALYTICS: "protocol-analytics";
     readonly PROTOCOL_CONTRIBUTE: "protocol-contribute";
     readonly PROTOCOL_DND: "protocol-dnd";
     readonly PROTOCOL_EDITOR: "protocol-editor";
@@ -361,6 +379,7 @@ export declare const WIRE_NAMES: {
     readonly REGION_MESSAGE: "region-message";
     readonly REQUEST_API_CATALOG: "request-api-catalog";
     readonly REQUEST_AUTH_STATE: "request-auth-state";
+    readonly REQUEST_CHROME_STATE: "request-chrome-state";
     readonly REQUEST_DEBUG_ENABLED: "request-debug-enabled";
     readonly REQUEST_DIAGNOSTICS: "request-diagnostics";
     readonly REQUEST_EDITOR_CONTEXT: "request-editor-context";

package/dist/sdk.js

@@ -1,7 +1,7 @@
 "use strict";
 // GENERATED by scripts/generate.mjs — DO NOT EDIT.
 // Source of truth: src/descriptors.protocol.mjs (@immediately-run/sandbox-protocol)
-// descriptorsHash: 4ce0c4b1d3f460e9
+// descriptorsHash: 82fbfbaeb58cdadd
 //
 // The sandbox↔SDK wire vocabulary (PLATFORM_LAYERING_SPEC §2 / S1). Import the
 // constants instead of writing the string: a rename then has ONE edit site and
@@ -9,14 +9,17 @@
 // that has a declared shape; a name handled as `any` today gets its read field
 // list in the doc comment instead (R3-274e is where those grow real types).
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REQUEST_VCS_STATE = exports.REQUEST_THEME = exports.REQUEST_SESSION_MOUNTS = exports.REQUEST_SECRETS_METADATA = exports.REQUEST_MOUNTS = exports.REQUEST_LLM_PROVIDER = exports.REQUEST_INVITATIONS = exports.REQUEST_HOST_ATTENTION = exports.REQUEST_HANDSHAKE = exports.REQUEST_FORM_FACTOR = exports.REQUEST_EDITOR_CONTEXT = exports.REQUEST_DIAGNOSTICS = exports.REQUEST_DEBUG_ENABLED = exports.REQUEST_AUTH_STATE = exports.REQUEST_API_CATALOG = exports.REGION_MESSAGE = exports.PROTOCOL_VCS = exports.PROTOCOL_THEME = exports.PROTOCOL_TASK = exports.PROTOCOL_SPACES = exports.PROTOCOL_SETTINGS = exports.PROTOCOL_SECRETS = exports.PROTOCOL_LLM = exports.PROTOCOL_LAUNCH = exports.PROTOCOL_IPC = exports.PROTOCOL_FETCH = exports.PROTOCOL_EDITOR = exports.PROTOCOL_DND = exports.PROTOCOL_CONTRIBUTE = exports.MOUNT_REMOVE = exports.MOUNT_ADD = exports.METADATA_UPDATE = exports.LLM_PROVIDER = exports.LAUNCH_ENDED = exports.LAUNCH_DISMISS = exports.INVITATIONS = exports.HOST_ATTENTION = exports.FS_CHANGE = exports.FORM_FACTOR = exports.EDITOR_CONTEXT = exports.DROPPED_ITEM = exports.DND_CANCEL = exports.DIAGNOSTICS = exports.DEBUG_QUERY_RESULT = exports.DEBUG_QUERY = exports.DEBUG_LOG = exports.DEBUG_ENABLED = exports.COMPILE = exports.AUTH_STATE = exports.API_CATALOG = void 0;
-exports.WIRE_NAMES = exports.VCS_STATE = exports.URLCHANGE = exports.THEME = exports.TASK_INPUT = exports.TASK_COMPLETE = exports.TASK_CANCEL = exports.SESSION_MOUNTS = exports.SECRETS_METADATA = exports.SDK_HANDSHAKE = void 0;
+exports.REQUEST_SECRETS_METADATA = exports.REQUEST_MOUNTS = exports.REQUEST_LLM_PROVIDER = exports.REQUEST_INVITATIONS = exports.REQUEST_HOST_ATTENTION = exports.REQUEST_HANDSHAKE = exports.REQUEST_FORM_FACTOR = exports.REQUEST_EDITOR_CONTEXT = exports.REQUEST_DIAGNOSTICS = exports.REQUEST_DEBUG_ENABLED = exports.REQUEST_CHROME_STATE = exports.REQUEST_AUTH_STATE = exports.REQUEST_API_CATALOG = exports.REGION_MESSAGE = exports.PROTOCOL_VCS = exports.PROTOCOL_THEME = exports.PROTOCOL_TASK = exports.PROTOCOL_SPACES = exports.PROTOCOL_SETTINGS = exports.PROTOCOL_SECRETS = exports.PROTOCOL_LLM = exports.PROTOCOL_LAUNCH = exports.PROTOCOL_IPC = exports.PROTOCOL_FETCH = exports.PROTOCOL_EDITOR = exports.PROTOCOL_DND = exports.PROTOCOL_CONTRIBUTE = exports.PROTOCOL_ANALYTICS = exports.MOUNT_REMOVE = exports.MOUNT_ADD = exports.METADATA_UPDATE = exports.LLM_PROVIDER = exports.LAUNCH_ENDED = exports.LAUNCH_DISMISS = exports.INVITATIONS = exports.HOST_ATTENTION = exports.FS_CHANGE = exports.FORM_FACTOR = exports.EDITOR_CONTEXT = exports.DROPPED_ITEM = exports.DND_CANCEL = exports.DIAGNOSTICS = exports.DEBUG_QUERY_RESULT = exports.DEBUG_QUERY = exports.DEBUG_LOG = exports.DEBUG_ENABLED = exports.COMPILE = exports.CHROME_STATE = exports.AUTH_STATE = exports.API_CATALOG = void 0;
+exports.WIRE_NAMES = exports.VCS_STATE = exports.URLCHANGE = exports.THEME = exports.TASK_INPUT = exports.TASK_COMPLETE = exports.TASK_CANCEL = exports.SESSION_MOUNTS = exports.SECRETS_METADATA = exports.SDK_HANDSHAKE = exports.REQUEST_VCS_STATE = exports.REQUEST_THEME = exports.REQUEST_SESSION_MOUNTS = void 0;
 /** `api-catalog` — push · host->app. polled with `request-api-catalog`. */
 exports.API_CATALOG = 'api-catalog';
 /** Read off this message today: `methods`. */
 /** `auth-state` — push · host->app. polled with `request-auth-state`. */
 exports.AUTH_STATE = 'auth-state';
 /** Read off this message today: `state`. */
+/** `chrome-state` — push · host->app. polled with `request-chrome-state`. */
+exports.CHROME_STATE = 'chrome-state';
+/** Read off this message today: `chromeState`. */
 /** `compile` — message · host->app. */
 exports.COMPILE = 'compile';
 /** `debug-enabled` — push · host->app. polled with `request-debug-enabled`. */
@@ -65,6 +68,8 @@ exports.MOUNT_ADD = 'mount-add';
 /** `mount-remove` — message · host->app. */
 exports.MOUNT_REMOVE = 'mount-remove';
 /** Read off this message today: `id`, `path`, `reason`. */
+/** `protocol-analytics` — request · app->host. */
+exports.PROTOCOL_ANALYTICS = 'protocol-analytics';
 /** `protocol-contribute` — stream · app->host. */
 exports.PROTOCOL_CONTRIBUTE = 'protocol-contribute';
 /** `protocol-dnd` — request · app->host. */
@@ -97,6 +102,8 @@ exports.REGION_MESSAGE = 'region-message';
 exports.REQUEST_API_CATALOG = 'request-api-catalog';
 /** `request-auth-state` — poll · app->host. */
 exports.REQUEST_AUTH_STATE = 'request-auth-state';
+/** `request-chrome-state` — poll · app->host. */
+exports.REQUEST_CHROME_STATE = 'request-chrome-state';
 /** `request-debug-enabled` — poll · app->host. */
 exports.REQUEST_DEBUG_ENABLED = 'request-debug-enabled';
 /** `request-diagnostics` — poll · app->host. */
@@ -149,6 +156,7 @@ exports.VCS_STATE = 'vcs-state';
 exports.WIRE_NAMES = {
     API_CATALOG: exports.API_CATALOG,
     AUTH_STATE: exports.AUTH_STATE,
+    CHROME_STATE: exports.CHROME_STATE,
     COMPILE: exports.COMPILE,
     DEBUG_ENABLED: exports.DEBUG_ENABLED,
     DEBUG_LOG: exports.DEBUG_LOG,
@@ -168,6 +176,7 @@ exports.WIRE_NAMES = {
     METADATA_UPDATE: exports.METADATA_UPDATE,
     MOUNT_ADD: exports.MOUNT_ADD,
     MOUNT_REMOVE: exports.MOUNT_REMOVE,
+    PROTOCOL_ANALYTICS: exports.PROTOCOL_ANALYTICS,
     PROTOCOL_CONTRIBUTE: exports.PROTOCOL_CONTRIBUTE,
     PROTOCOL_DND: exports.PROTOCOL_DND,
     PROTOCOL_EDITOR: exports.PROTOCOL_EDITOR,
@@ -184,6 +193,7 @@ exports.WIRE_NAMES = {
     REGION_MESSAGE: exports.REGION_MESSAGE,
     REQUEST_API_CATALOG: exports.REQUEST_API_CATALOG,
     REQUEST_AUTH_STATE: exports.REQUEST_AUTH_STATE,
+    REQUEST_CHROME_STATE: exports.REQUEST_CHROME_STATE,
     REQUEST_DEBUG_ENABLED: exports.REQUEST_DEBUG_ENABLED,
     REQUEST_DIAGNOSTICS: exports.REQUEST_DIAGNOSTICS,
     REQUEST_EDITOR_CONTEXT: exports.REQUEST_EDITOR_CONTEXT,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immediately-run/sandbox-protocol",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "description": "The sandbox<->SDK wire protocol: ONE descriptor set, projected into the wire-name constants, the payload types, and the per-side snapshots both repos gate against (PLATFORM_LAYERING_SPEC S1). Consumed by sandbox and immediately-run-sdk so a wire change is a version bump, not a hand-copied file.",
   "license": "UNLICENSED",
   "repository": {
@@ -55,7 +55,8 @@
     "lint": "eslint src test",
     "check:drift": "node scripts/verify-drift.mjs --self-test && node scripts/verify-drift.mjs",
     "check:dependency-free": "node scripts/check-dependency-free.mjs --self-test && node scripts/check-dependency-free.mjs",
-    "verify": "npm run build && npm test && npm run lint && npm run check:drift && npm run check:dependency-free",
+    "check:publish-version": "node scripts/check-publish-version.mjs --self-test && node scripts/check-publish-version.mjs",
+    "verify": "npm run check:publish-version && npm run build && npm test && npm run lint && npm run check:drift && npm run check:dependency-free",
     "prepare": "npm run build"
   },
   "devDependencies": {

package/snapshots/sdk.json

@@ -87,6 +87,47 @@
         "src/auth.ts"
       ]
     },
+    "chrome-state": {
+      "kind": "push",
+      "direction": "host->app",
+      "poll": "request-chrome-state",
+      "payload": {
+        "reads": [
+          "chromeState"
+        ]
+      },
+      "value": {
+        "fields": [
+          {
+            "name": "overlay",
+            "optional": false,
+            "union": [
+              {
+                "type": "\"menu\""
+              },
+              {
+                "type": "\"none\""
+              }
+            ]
+          },
+          {
+            "name": "tab",
+            "optional": false,
+            "fields": [
+              {
+                "name": "edge",
+                "optional": false,
+                "type": "\"top-right\""
+              }
+            ]
+          }
+        ],
+        "type": "ChromeState"
+      },
+      "sites": [
+        "src/chromeState.ts"
+      ]
+    },
     "compile": {
       "kind": "message",
       "direction": "host->app",
@@ -753,6 +794,49 @@
         "src/mounts.ts"
       ]
     },
+    "protocol-analytics": {
+      "kind": "request",
+      "direction": "app->host",
+      "methods": {
+        "emit": {
+          "payload": {
+            "fields": [
+              {
+                "name": "name",
+                "optional": false,
+                "type": "string"
+              },
+              {
+                "name": "props",
+                "optional": true,
+                "union": [
+                  {
+                    "type": "Record<string, AnalyticsPropValue>"
+                  },
+                  {
+                    "type": "undefined"
+                  }
+                ]
+              }
+            ]
+          }
+        },
+        "route": {
+          "payload": {
+            "fields": [
+              {
+                "name": "path",
+                "optional": false,
+                "type": "string"
+              }
+            ]
+          }
+        }
+      },
+      "sites": [
+        "src/analytics.ts"
+      ]
+    },
     "protocol-contribute": {
       "kind": "stream",
       "direction": "app->host",
@@ -1640,6 +1724,16 @@
         "src/auth.ts"
       ]
     },
+    "request-chrome-state": {
+      "kind": "poll",
+      "direction": "app->host",
+      "payload": {
+        "fields": []
+      },
+      "sites": [
+        "src/chromeState.ts"
+      ]
+    },
     "request-debug-enabled": {
       "kind": "poll",
       "direction": "app->host",
@@ -2071,6 +2165,7 @@
   "dynamicFamilies": {
     "protocol-<scheme>": {
       "schemes": [
+        "analytics",
         "contribute",
         "dnd",
         "editor",