@hydranium/protocol 1.0.0-next.298 → 1.0.0-next.299

package/lib/client/worker-handshake.d.ts

@@ -18,9 +18,9 @@
  * handshake through the global `postMessage` regardless of the connection it
  * was configured with, a plain string no JSON-RPC reader can parse.
  *
- * The global therefore carries the host protocol: the bootstrap in, failure
- * reports out, and whatever else the host adds for itself. A message that
- * belongs to a head belongs on that head's port.
+ * The global therefore carries the host protocol: the bootstrap in, the ready
+ * message and failure reports out, and whatever else the host adds for
+ * itself. A message that belongs to a head belongs on that head's port.
  *
  * The ports are {@link TransferredMessagePort}s, because this package compiles
  * without the DOM lib and the structural type is also what rejects a `Worker`
@@ -41,13 +41,23 @@ export interface WorkerBootstrapMessage {
     readonly ports: HeadPorts;
 }
 export declare function isWorkerBootstrapMessage(value: unknown): value is WorkerBootstrapMessage;
+/**
+ * Discriminator of the message the worker posts on the global once every head
+ * is up. Until it arrives, the page takes the `Worker`'s `error` event as a
+ * worker that never started and ends the heads; after it, as an uncaught error
+ * the worker runs on from, which it reports and keeps the heads through.
+ */
+export declare const WORKER_READY_MESSAGE_TYPE = "hydranium/ready";
+export interface WorkerReadyMessage {
+    readonly type: typeof WORKER_READY_MESSAGE_TYPE;
+}
+export declare function isWorkerReadyMessage(value: unknown): value is WorkerReadyMessage;
 /**
  * Discriminator of a failure report the worker posts on the global.
  *
  * A worker has no console anyone is looking at, and the failures that matter
- * most reach nobody by default: an LSP notification handler that rejects has
- * no reply to reject, so a workspace walk that throws looks exactly like a
- * workspace with no documents in it.
+ * most reach nobody by default: a workspace walk that throws has no reply to
+ * reject, so it looks exactly like a workspace with no documents in it.
  */
 export declare const WORKER_ERROR_MESSAGE_TYPE = "hydranium/worker-error";
 /** The phase a failed bootstrap reports under; no head answers after it. */

package/lib/client/worker-handshake.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"worker-handshake.d.ts","sourceRoot":"","sources":["../../src/client/worker-handshake.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,gFAAgF;AAChF,eAAO,MAAM,6BAA6B,wBAAwB,CAAC;AAEnE,qCAAqC;AACrC,MAAM,WAAW,SAAS;IACvB,QAAQ,CAAC,GAAG,EAAE,sBAAsB,CAAC;IACrC,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;CACxC;AAED,8EAA8E;AAC9E,MAAM,WAAW,sBAAsB;IACpC,QAAQ,CAAC,IAAI,EAAE,OAAO,6BAA6B,CAAC;IACpD,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC5B;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,sBAAsB,CAMxF;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB,2BAA2B,CAAC;AAElE,4EAA4E;AAC5E,eAAO,MAAM,sBAAsB,cAAc,CAAC;AAElD,MAAM,WAAW,kBAAkB;IAChC,QAAQ,CAAC,IAAI,EAAE,OAAO,yBAAyB,CAAC;IAChD,wFAAwF;IACxF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC3B;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,kBAAkB,CAMhF"}
+{"version":3,"file":"worker-handshake.d.ts","sourceRoot":"","sources":["../../src/client/worker-handshake.ts"],"names":[],"mappings":"AAAA;;;;;;;kFAOkF;AAElF;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,gFAAgF;AAChF,eAAO,MAAM,6BAA6B,wBAAwB,CAAC;AAEnE,qCAAqC;AACrC,MAAM,WAAW,SAAS;IACvB,QAAQ,CAAC,GAAG,EAAE,sBAAsB,CAAC;IACrC,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;IACtC,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;CACxC;AAED,8EAA8E;AAC9E,MAAM,WAAW,sBAAsB;IACpC,QAAQ,CAAC,IAAI,EAAE,OAAO,6BAA6B,CAAC;IACpD,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;CAC5B;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,sBAAsB,CAMxF;AAED;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB,oBAAoB,CAAC;AAE3D,MAAM,WAAW,kBAAkB;IAChC,QAAQ,CAAC,IAAI,EAAE,OAAO,yBAAyB,CAAC;CAClD;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,kBAAkB,CAEhF;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,2BAA2B,CAAC;AAElE,4EAA4E;AAC5E,eAAO,MAAM,sBAAsB,cAAc,CAAC;AAElD,MAAM,WAAW,kBAAkB;IAChC,QAAQ,CAAC,IAAI,EAAE,OAAO,yBAAyB,CAAC;IAChD,wFAAwF;IACxF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC3B;AAED,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,kBAAkB,CAMhF"}

package/lib/client/worker-handshake.js

@@ -8,8 +8,9 @@
  * SPDX-License-Identifier: MIT
  ********************************************************************************/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WORKER_BOOTSTRAP_PHASE = exports.WORKER_ERROR_MESSAGE_TYPE = exports.WORKER_BOOTSTRAP_MESSAGE_TYPE = void 0;
+exports.WORKER_BOOTSTRAP_PHASE = exports.WORKER_ERROR_MESSAGE_TYPE = exports.WORKER_READY_MESSAGE_TYPE = exports.WORKER_BOOTSTRAP_MESSAGE_TYPE = void 0;
 exports.isWorkerBootstrapMessage = isWorkerBootstrapMessage;
+exports.isWorkerReadyMessage = isWorkerReadyMessage;
 exports.isWorkerErrorMessage = isWorkerErrorMessage;
 /** Discriminator of the bootstrap message a page posts on the worker global. */
 exports.WORKER_BOOTSTRAP_MESSAGE_TYPE = 'hydranium/bootstrap';
@@ -20,13 +21,22 @@ function isWorkerBootstrapMessage(value) {
     const candidate = value;
     return candidate.type === exports.WORKER_BOOTSTRAP_MESSAGE_TYPE && typeof candidate.ports === 'object' && candidate.ports !== null;
 }
+/**
+ * Discriminator of the message the worker posts on the global once every head
+ * is up. Until it arrives, the page takes the `Worker`'s `error` event as a
+ * worker that never started and ends the heads; after it, as an uncaught error
+ * the worker runs on from, which it reports and keeps the heads through.
+ */
+exports.WORKER_READY_MESSAGE_TYPE = 'hydranium/ready';
+function isWorkerReadyMessage(value) {
+    return typeof value === 'object' && value !== null && value.type === exports.WORKER_READY_MESSAGE_TYPE;
+}
 /**
  * Discriminator of a failure report the worker posts on the global.
  *
  * A worker has no console anyone is looking at, and the failures that matter
- * most reach nobody by default: an LSP notification handler that rejects has
- * no reply to reject, so a workspace walk that throws looks exactly like a
- * workspace with no documents in it.
+ * most reach nobody by default: a workspace walk that throws has no reply to
+ * reject, so it looks exactly like a workspace with no documents in it.
  */
 exports.WORKER_ERROR_MESSAGE_TYPE = 'hydranium/worker-error';
 /** The phase a failed bootstrap reports under; no head answers after it. */

package/lib/client/worker-handshake.js.map

@@ -1 +1 @@
-{"version":3,"file":"worker-handshake.js","sourceRoot":"","sources":["../../src/client/worker-handshake.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;;;AAyBlF,gFAAgF;AACnE,QAAA,6BAA6B,GAAG,qBAAqB,CAAC;AAenE,kCAAyC,KAAc;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,MAAM,SAAS,GAAG,KAAwC,CAAC;IAC3D,OAAO,SAAS,CAAC,IAAI,KAAK,QAAA,6BAA6B,IAAI,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,IAAI,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC;AAC9H,CAAC;AAED;;;;;;;GAOG;AACU,QAAA,yBAAyB,GAAG,wBAAwB,CAAC;AAElE,4EAA4E;AAC/D,QAAA,sBAAsB,GAAG,WAAW,CAAC;AASlD,8BAAqC,KAAc;IAChD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,MAAM,SAAS,GAAG,KAAoC,CAAC;IACvD,OAAO,SAAS,CAAC,IAAI,KAAK,QAAA,yBAAyB,IAAI,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,SAAS,CAAC,OAAO,KAAK,QAAQ,CAAC;AACvI,CAAC"}
+{"version":3,"file":"worker-handshake.js","sourceRoot":"","sources":["../../src/client/worker-handshake.ts"],"names":[],"mappings":";AAAA;;;;;;;kFAOkF;;;;;;AAyBlF,gFAAgF;AACnE,QAAA,6BAA6B,GAAG,qBAAqB,CAAC;AAenE,kCAAyC,KAAc;IACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,MAAM,SAAS,GAAG,KAAwC,CAAC;IAC3D,OAAO,SAAS,CAAC,IAAI,KAAK,QAAA,6BAA6B,IAAI,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,IAAI,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC;AAC9H,CAAC;AAED;;;;;GAKG;AACU,QAAA,yBAAyB,GAAG,iBAAiB,CAAC;AAM3D,8BAAqC,KAAc;IAChD,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAK,KAAqC,CAAC,IAAI,KAAK,QAAA,yBAAyB,CAAC;AACnI,CAAC;AAED;;;;;;GAMG;AACU,QAAA,yBAAyB,GAAG,wBAAwB,CAAC;AAElE,4EAA4E;AAC/D,QAAA,sBAAsB,GAAG,WAAW,CAAC;AASlD,8BAAqC,KAAc;IAChD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IAChB,CAAC;IACD,MAAM,SAAS,GAAG,KAAoC,CAAC;IACvD,OAAO,SAAS,CAAC,IAAI,KAAK,QAAA,yBAAyB,IAAI,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,IAAI,OAAO,SAAS,CAAC,OAAO,KAAK,QAAQ,CAAC;AACvI,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hydranium/protocol",
-  "version": "1.0.0-next.298",
+  "version": "1.0.0-next.299",
   "description": "Generic, language-agnostic types, constants, and pure utilities for the hydranium framework.",
   "keywords": [
     "hydranium",

package/src/client/worker-handshake.ts

@@ -19,9 +19,9 @@
  * handshake through the global `postMessage` regardless of the connection it
  * was configured with, a plain string no JSON-RPC reader can parse.
  *
- * The global therefore carries the host protocol: the bootstrap in, failure
- * reports out, and whatever else the host adds for itself. A message that
- * belongs to a head belongs on that head's port.
+ * The global therefore carries the host protocol: the bootstrap in, the ready
+ * message and failure reports out, and whatever else the host adds for
+ * itself. A message that belongs to a head belongs on that head's port.
  *
  * The ports are {@link TransferredMessagePort}s, because this package compiles
  * without the DOM lib and the structural type is also what rejects a `Worker`
@@ -54,13 +54,28 @@ export function isWorkerBootstrapMessage(value: unknown): value is WorkerBootstr
    return candidate.type === WORKER_BOOTSTRAP_MESSAGE_TYPE && typeof candidate.ports === 'object' && candidate.ports !== null;
 }
 
+/**
+ * Discriminator of the message the worker posts on the global once every head
+ * is up. Until it arrives, the page takes the `Worker`'s `error` event as a
+ * worker that never started and ends the heads; after it, as an uncaught error
+ * the worker runs on from, which it reports and keeps the heads through.
+ */
+export const WORKER_READY_MESSAGE_TYPE = 'hydranium/ready';
+
+export interface WorkerReadyMessage {
+   readonly type: typeof WORKER_READY_MESSAGE_TYPE;
+}
+
+export function isWorkerReadyMessage(value: unknown): value is WorkerReadyMessage {
+   return typeof value === 'object' && value !== null && (value as Partial<WorkerReadyMessage>).type === WORKER_READY_MESSAGE_TYPE;
+}
+
 /**
  * Discriminator of a failure report the worker posts on the global.
  *
  * A worker has no console anyone is looking at, and the failures that matter
- * most reach nobody by default: an LSP notification handler that rejects has
- * no reply to reject, so a workspace walk that throws looks exactly like a
- * workspace with no documents in it.
+ * most reach nobody by default: a workspace walk that throws has no reply to
+ * reject, so it looks exactly like a workspace with no documents in it.
  */
 export const WORKER_ERROR_MESSAGE_TYPE = 'hydranium/worker-error';