@snap-rail/protocol 0.0.0-stage → 0.1.3

package/lib/types/surfaces.js

@@ -0,0 +1,43 @@
+/**
+ * The surface vocabulary: one renderer window role. `main` is the operator
+ * window (the app's only always-present surface); `ball` is the auxiliary
+ * always-on-top surface a plugin drives through the Shell seam — the floating
+ * ball.
+ *
+ * A surface is an identity, not a layout. Every surface boots the same
+ * renderer with its own client entry (`snapRail.client.surfaces`) and its own
+ * seed set; a plugin face binds to exactly one surface and reads
+ * `ctx.client.surface` to know which. Auxiliary surfaces never subscribe to
+ * equipment points directly — they consume host-aggregated frames, because a
+ * hidden surface must not keep a data path alive and a shown one must not
+ * need a second subscription graph.
+ *
+ * The whitelist is closed on purpose: a plugin may not name an arbitrary URL
+ * or spawn an arbitrary window — the Shell owns every window and only these
+ * two roles exist.
+ *
+ * @module @snap-rail/protocol/surfaces
+ */
+/** Every surface id, in boot order (`main` first). */
+export const SURFACE_IDS = ['main', 'ball'];
+/** The always-on-top auxiliary surfaces: windows the Shell creates lazily. */
+export const AUX_SURFACE_IDS = ['ball'];
+/**
+ * Whether a wire value names a surface.
+ *
+ * @param value - the candidate (any wire value).
+ * @returns true when the value is a {@link SurfaceId}.
+ */
+export function isSurfaceId(value) {
+    return typeof value === 'string' && SURFACE_IDS.includes(value);
+}
+/**
+ * Whether a wire value names an auxiliary surface.
+ *
+ * @param value - the candidate (any wire value).
+ * @returns true when the value is an {@link AuxSurfaceId}.
+ */
+export function isAuxSurfaceId(value) {
+    return typeof value === 'string' && AUX_SURFACE_IDS.includes(value);
+}
+//# sourceMappingURL=surfaces.js.map

package/package.json

@@ -1,6 +1,28 @@
 {
   "name": "@snap-rail/protocol",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "description": "Channel-independent four-quadrant RPC contract between host and clients",
+  "version": "0.1.3",
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./src/*": "./src/*",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib/**/*.js",
+    "lib/types/**/*.d.ts"
+  ],
+  "license": "Apache-2.0",
+  "dependencies": {
+    "zod": "^4.4.3",
+    "@snap-rail/util": "^0.1.2"
+  },
+  "snapRail": {
+    "layer": "base"
+  }
 }

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.