@dreamcomposer/engine-types 2.1.1 → 2.2.0

package/from-engine/EngineAliveMessage.d.ts

@@ -0,0 +1,11 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Sent as the very first thing when the engine page starts, before any of
+ * its scripts are loaded. It only tells the embedder that the engine is
+ * reachable; it is still not allowed to send commands until it receives the
+ * `engine-ready` message.
+ */
+export interface EngineAliveMessage extends FromEngineMessage<"engine-alive"> {
+  payload: true;
+}

package/from-engine/EngineErrorMessage.d.ts

@@ -0,0 +1,16 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Sent when the engine fails in a way it cannot recover from on its own.
+ *
+ * `startup` errors happen before `engine-ready` was sent, i.e. the engine will
+ * never become ready. `runtime` errors happen afterwards and leave the engine
+ * unusable, e.g. a lost WebGL context that is not restored.
+ */
+export interface EngineErrorMessage extends FromEngineMessage<"engine-error"> {
+  payload: {
+    phase: "startup" | "runtime";
+    /** A technical description for logs, not meant to be shown to users. */
+    message: string;
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dreamcomposer/engine-types",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "The type definitions for messages from and to the engine",
   "license": "UNLICENSED",
   "private": false,

package/post-messages.d.ts

@@ -1,5 +1,7 @@
 import { AckMessage } from "./from-engine/AckMessage";
 import { CanvasImageUrlMessage } from "./from-engine/CanvasImageUrlMessage";
+import { EngineAliveMessage } from "./from-engine/EngineAliveMessage";
+import { EngineErrorMessage } from "./from-engine/EngineErrorMessage";
 import { EngineReadyMessage } from "./from-engine/EngineReadyMessage";
 import { KeyDownMessage } from "./from-engine/KeyDownMessage";
 import { SetLoadingProgressMessage } from "./from-engine/SetLoadingProgressMessage";
@@ -82,6 +84,8 @@ export type FromEnginePostMessage =
   | AckMessage
   | CanvasImageUrlMessage
   | DisplayLoadingUiMessage
+  | EngineAliveMessage
+  | EngineErrorMessage
   | EngineReadyMessage
   | HideGuiMessage
   | HideLoadingUiMessage