@immediately-run/sandbox-protocol 0.9.0 → 0.10.0

package/README.md

@@ -31,11 +31,16 @@ dependency bump.
 | `@immediately-run/sandbox-protocol` | the format version + the snapshot types. **No constants** — importing the root must not be a way to reach the other side's vocabulary |
 
 **Two modules, not a union.** The sides speak overlapping but different subsets — 34
-wire names in the frame, 57 in the SDK, 18 shared. 39 are SDK-only because the frame
+wire names in the frame, 71 in the SDK, 18 shared. 53 are SDK-only because the frame
 merely *relays* them and the host is the other end (the R3-274a cross-repo audit). Each
 repo's own gate asserts its module covers *exactly* its extracted wire surface, so a
 union module would fail there, far from its cause.
 
+*(Those four numbers are asserted against the descriptors by `test/protocol.test.ts`, in
+this file and in `src/index.ts`. They had drifted — the SDK counts above were wrong —
+because prose counts in a comment are believed by the next reader and checked by
+nobody.)*
+
 ## Changing the wire
 
 Edit **`src/descriptors.protocol.mjs`** — never a generated file — then:

package/dist/index.js

@@ -12,8 +12,11 @@
 //                                               repo's own gate compares against
 //
 // The two sides speak overlapping but DIFFERENT subsets — 34 wire names in the frame,
-// 57 in the SDK, 18 shared; 39 are SDK-only because the frame merely relays them and
-// the host is the other end. Hence a module per side: a union module would hand each
+// 71 in the SDK, 18 shared; 53 are SDK-only because the frame merely relays them and
+// the host is the other end. (These four counts are ASSERTED against the descriptors by
+// `test/protocol.test.ts` — they are shipped in `dist/index.d.ts`, so a reader downloads
+// them, and they had drifted to 57/39 because nothing checked.) Hence a module per side:
+// a union module would hand each
 // repo constants it does not speak, and each repo's gate asserts its module covers
 // EXACTLY its own wire surface.
 //

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: 5150c9ae680eb1cc
+// descriptorsHash: 1d323f9bbbe8f104
 //
 // 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,5 +1,5 @@
 /** Every wire name this side speaks, as a union. */
-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-feed' | 'protocol-fetch' | 'protocol-ipc' | 'protocol-launch' | 'protocol-llm' | 'protocol-recents' | '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-theme-catalog' | 'request-vcs-state' | 'request-workspace' | 'sdk-handshake' | 'secrets-metadata' | 'session-mounts' | 'task-cancel' | 'task-complete' | 'task-input' | 'theme' | 'theme-catalog' | 'urlchange' | 'vcs-state' | 'workspace';
+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-feed' | 'protocol-fetch' | 'protocol-ipc' | 'protocol-launch' | 'protocol-llm' | 'protocol-openrepo' | 'protocol-recents' | 'protocol-secrets' | 'protocol-settings' | 'protocol-spaces' | 'protocol-task' | 'protocol-theme' | 'protocol-vcs' | 'region-message' | 'region-visibility' | '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-region-visibility' | 'request-secrets-metadata' | 'request-session-mounts' | 'request-theme' | 'request-theme-catalog' | 'request-vcs-state' | 'request-workspace' | 'sdk-handshake' | 'secrets-metadata' | 'session-mounts' | 'task-cancel' | 'task-complete' | 'task-input' | 'theme' | 'theme-catalog' | 'urlchange' | 'vcs-state' | 'workspace';
 /** `api-catalog` — push · host->app. polled with `request-api-catalog`. */
 export declare const API_CATALOG = "api-catalog";
 /** Read off this message today: `methods`. */
@@ -218,6 +218,14 @@ export interface ProtocolLlmChatParams {
     responseFormat?: "json" | "text" | undefined;
     tools?: Array<unknown> | undefined;
 }
+/** `protocol-openrepo` — request · app->host. */
+export declare const PROTOCOL_OPENREPO = "protocol-openrepo";
+/** Params of `protocol-openrepo` method `open`. */
+export interface ProtocolOpenrepoOpenParams {
+    namespace: string;
+    provider: string;
+    repository: string;
+}
 /** `protocol-recents` — request · app->host. */
 export declare const PROTOCOL_RECENTS = "protocol-recents";
 /** Params of `protocol-recents` method `list`. */
@@ -286,6 +294,9 @@ export interface RegionMessagePayload {
     data: unknown;
     from: string;
 }
+/** `region-visibility` — push · host->app. polled with `request-region-visibility`. */
+export declare const REGION_VISIBILITY = "region-visibility";
+/** Read off this message today: `hidden`. */
 /** `request-api-catalog` — poll · app->host. */
 export declare const REQUEST_API_CATALOG = "request-api-catalog";
 /** `request-auth-state` — poll · app->host. */
@@ -310,6 +321,8 @@ export declare const REQUEST_INVITATIONS = "request-invitations";
 export declare const REQUEST_LLM_PROVIDER = "request-llm-provider";
 /** `request-mounts` — message · app->host. */
 export declare const REQUEST_MOUNTS = "request-mounts";
+/** `request-region-visibility` — poll · app->host. */
+export declare const REQUEST_REGION_VISIBILITY = "request-region-visibility";
 /** `request-secrets-metadata` — poll · app->host. */
 export declare const REQUEST_SECRETS_METADATA = "request-secrets-metadata";
 /** `request-session-mounts` — poll · app->host. */
@@ -395,6 +408,7 @@ export declare const WIRE_NAMES: {
     readonly PROTOCOL_IPC: "protocol-ipc";
     readonly PROTOCOL_LAUNCH: "protocol-launch";
     readonly PROTOCOL_LLM: "protocol-llm";
+    readonly PROTOCOL_OPENREPO: "protocol-openrepo";
     readonly PROTOCOL_RECENTS: "protocol-recents";
     readonly PROTOCOL_SECRETS: "protocol-secrets";
     readonly PROTOCOL_SETTINGS: "protocol-settings";
@@ -403,6 +417,7 @@ export declare const WIRE_NAMES: {
     readonly PROTOCOL_THEME: "protocol-theme";
     readonly PROTOCOL_VCS: "protocol-vcs";
     readonly REGION_MESSAGE: "region-message";
+    readonly REGION_VISIBILITY: "region-visibility";
     readonly REQUEST_API_CATALOG: "request-api-catalog";
     readonly REQUEST_AUTH_STATE: "request-auth-state";
     readonly REQUEST_CHROME_STATE: "request-chrome-state";
@@ -415,6 +430,7 @@ export declare const WIRE_NAMES: {
     readonly REQUEST_INVITATIONS: "request-invitations";
     readonly REQUEST_LLM_PROVIDER: "request-llm-provider";
     readonly REQUEST_MOUNTS: "request-mounts";
+    readonly REQUEST_REGION_VISIBILITY: "request-region-visibility";
     readonly REQUEST_SECRETS_METADATA: "request-secrets-metadata";
     readonly REQUEST_SESSION_MOUNTS: "request-session-mounts";
     readonly REQUEST_THEME: "request-theme";

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: 5150c9ae680eb1cc
+// descriptorsHash: 1d323f9bbbe8f104
 //
 // 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,8 +9,8 @@
 // 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_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_RECENTS = exports.PROTOCOL_LLM = exports.PROTOCOL_LAUNCH = exports.PROTOCOL_IPC = exports.PROTOCOL_FETCH = exports.PROTOCOL_FEED = 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.WORKSPACE = exports.VCS_STATE = exports.URLCHANGE = exports.THEME_CATALOG = exports.THEME = exports.TASK_INPUT = exports.TASK_COMPLETE = exports.TASK_CANCEL = exports.SESSION_MOUNTS = exports.SECRETS_METADATA = exports.SDK_HANDSHAKE = exports.REQUEST_WORKSPACE = exports.REQUEST_VCS_STATE = exports.REQUEST_THEME_CATALOG = exports.REQUEST_THEME = exports.REQUEST_SESSION_MOUNTS = exports.REQUEST_SECRETS_METADATA = exports.REQUEST_MOUNTS = void 0;
+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_VISIBILITY = exports.REGION_MESSAGE = exports.PROTOCOL_VCS = exports.PROTOCOL_THEME = exports.PROTOCOL_TASK = exports.PROTOCOL_SPACES = exports.PROTOCOL_SETTINGS = exports.PROTOCOL_SECRETS = exports.PROTOCOL_RECENTS = exports.PROTOCOL_OPENREPO = exports.PROTOCOL_LLM = exports.PROTOCOL_LAUNCH = exports.PROTOCOL_IPC = exports.PROTOCOL_FETCH = exports.PROTOCOL_FEED = 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.WORKSPACE = exports.VCS_STATE = exports.URLCHANGE = exports.THEME_CATALOG = exports.THEME = exports.TASK_INPUT = exports.TASK_COMPLETE = exports.TASK_CANCEL = exports.SESSION_MOUNTS = exports.SECRETS_METADATA = exports.SDK_HANDSHAKE = exports.REQUEST_WORKSPACE = exports.REQUEST_VCS_STATE = exports.REQUEST_THEME_CATALOG = exports.REQUEST_THEME = exports.REQUEST_SESSION_MOUNTS = exports.REQUEST_SECRETS_METADATA = exports.REQUEST_REGION_VISIBILITY = exports.REQUEST_MOUNTS = exports.REQUEST_LLM_PROVIDER = exports.REQUEST_INVITATIONS = void 0;
 /** `api-catalog` — push · host->app. polled with `request-api-catalog`. */
 exports.API_CATALOG = 'api-catalog';
 /** Read off this message today: `methods`. */
@@ -86,6 +86,8 @@ exports.PROTOCOL_IPC = 'protocol-ipc';
 exports.PROTOCOL_LAUNCH = 'protocol-launch';
 /** `protocol-llm` — stream · app->host. */
 exports.PROTOCOL_LLM = 'protocol-llm';
+/** `protocol-openrepo` — request · app->host. */
+exports.PROTOCOL_OPENREPO = 'protocol-openrepo';
 /** `protocol-recents` — request · app->host. */
 exports.PROTOCOL_RECENTS = 'protocol-recents';
 /** `protocol-secrets` — request · app->host. */
@@ -102,6 +104,9 @@ exports.PROTOCOL_THEME = 'protocol-theme';
 exports.PROTOCOL_VCS = 'protocol-vcs';
 /** `region-message` — message · host->app. */
 exports.REGION_MESSAGE = 'region-message';
+/** `region-visibility` — push · host->app. polled with `request-region-visibility`. */
+exports.REGION_VISIBILITY = 'region-visibility';
+/** Read off this message today: `hidden`. */
 /** `request-api-catalog` — poll · app->host. */
 exports.REQUEST_API_CATALOG = 'request-api-catalog';
 /** `request-auth-state` — poll · app->host. */
@@ -126,6 +131,8 @@ exports.REQUEST_INVITATIONS = 'request-invitations';
 exports.REQUEST_LLM_PROVIDER = 'request-llm-provider';
 /** `request-mounts` — message · app->host. */
 exports.REQUEST_MOUNTS = 'request-mounts';
+/** `request-region-visibility` — poll · app->host. */
+exports.REQUEST_REGION_VISIBILITY = 'request-region-visibility';
 /** `request-secrets-metadata` — poll · app->host. */
 exports.REQUEST_SECRETS_METADATA = 'request-secrets-metadata';
 /** `request-session-mounts` — poll · app->host. */
@@ -199,6 +206,7 @@ exports.WIRE_NAMES = {
     PROTOCOL_IPC: exports.PROTOCOL_IPC,
     PROTOCOL_LAUNCH: exports.PROTOCOL_LAUNCH,
     PROTOCOL_LLM: exports.PROTOCOL_LLM,
+    PROTOCOL_OPENREPO: exports.PROTOCOL_OPENREPO,
     PROTOCOL_RECENTS: exports.PROTOCOL_RECENTS,
     PROTOCOL_SECRETS: exports.PROTOCOL_SECRETS,
     PROTOCOL_SETTINGS: exports.PROTOCOL_SETTINGS,
@@ -207,6 +215,7 @@ exports.WIRE_NAMES = {
     PROTOCOL_THEME: exports.PROTOCOL_THEME,
     PROTOCOL_VCS: exports.PROTOCOL_VCS,
     REGION_MESSAGE: exports.REGION_MESSAGE,
+    REGION_VISIBILITY: exports.REGION_VISIBILITY,
     REQUEST_API_CATALOG: exports.REQUEST_API_CATALOG,
     REQUEST_AUTH_STATE: exports.REQUEST_AUTH_STATE,
     REQUEST_CHROME_STATE: exports.REQUEST_CHROME_STATE,
@@ -219,6 +228,7 @@ exports.WIRE_NAMES = {
     REQUEST_INVITATIONS: exports.REQUEST_INVITATIONS,
     REQUEST_LLM_PROVIDER: exports.REQUEST_LLM_PROVIDER,
     REQUEST_MOUNTS: exports.REQUEST_MOUNTS,
+    REQUEST_REGION_VISIBILITY: exports.REQUEST_REGION_VISIBILITY,
     REQUEST_SECRETS_METADATA: exports.REQUEST_SECRETS_METADATA,
     REQUEST_SESSION_MOUNTS: exports.REQUEST_SESSION_MOUNTS,
     REQUEST_THEME: exports.REQUEST_THEME,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immediately-run/sandbox-protocol",
-  "version": "0.9.0",
+  "version": "0.10.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": {

package/snapshots/sdk.json

@@ -1476,6 +1476,36 @@
         "src/llm.ts"
       ]
     },
+    "protocol-openrepo": {
+      "kind": "request",
+      "direction": "app->host",
+      "methods": {
+        "open": {
+          "payload": {
+            "fields": [
+              {
+                "name": "namespace",
+                "optional": false,
+                "type": "string"
+              },
+              {
+                "name": "provider",
+                "optional": false,
+                "type": "string"
+              },
+              {
+                "name": "repository",
+                "optional": false,
+                "type": "string"
+              }
+            ]
+          }
+        }
+      },
+      "sites": [
+        "src/openRepository.ts"
+      ]
+    },
     "protocol-recents": {
       "kind": "request",
       "direction": "app->host",
@@ -1858,6 +1888,22 @@
         "src/ipc.ts"
       ]
     },
+    "region-visibility": {
+      "kind": "push",
+      "direction": "host->app",
+      "poll": "request-region-visibility",
+      "payload": {
+        "reads": [
+          "hidden"
+        ]
+      },
+      "value": {
+        "type": "boolean"
+      },
+      "sites": [
+        "src/region.ts"
+      ]
+    },
     "request-api-catalog": {
       "kind": "poll",
       "direction": "app->host",
@@ -1978,6 +2024,16 @@
         "src/mounts.ts"
       ]
     },
+    "request-region-visibility": {
+      "kind": "poll",
+      "direction": "app->host",
+      "payload": {
+        "fields": []
+      },
+      "sites": [
+        "src/region.ts"
+      ]
+    },
     "request-secrets-metadata": {
       "kind": "poll",
       "direction": "app->host",
@@ -2440,6 +2496,7 @@
         "ipc",
         "launch",
         "llm",
+        "openrepo",
         "recents",
         "secrets",
         "settings",