@dreamcomposer/engine-types 0.0.71 → 0.0.72

package/from-engine/AckMessage.d.ts

@@ -0,0 +1,21 @@
+import { FromEngineMessage } from "../post-messages";
+
+/**
+ * Sent as a response for every message to the engine,
+ */
+export interface AckMessage extends FromEngineMessage<"ack"> {
+  payload: {
+    /**
+     * The nonce that was sent with the message to the engine.
+     *
+     * Used to identify to what message the ack belongs.
+     */
+    nonce: string;
+    /**
+     * An error if the message to the engine could not be processed by the engine.
+     */
+    error?: {
+      message?: string;
+    };
+  };
+}

package/package.json

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

package/post-messages.d.ts

@@ -1,3 +1,4 @@
+import { AckMessage } from "./from-engine/AckMessage";
 import { CanvasImageUrlMessage } from "./from-engine/CanvasImageUrlMessage";
 import { EngineReadyMessage } from "./from-engine/EngineReadyMessage";
 import { KeyDownMessage } from "./from-engine/KeyDownMessage";
@@ -61,10 +62,16 @@ export interface FromEngineMessage<Channel> {
  */
 export interface ToEngineMessage<Channel> {
   channel: Channel;
+  /**
+   * The nonce is a randomly generated string that is re-send by the engine in
+   * the ack message.
+   */
+  nonce: string;
   payload?: unknown;
 }
 
 export type FromEnginePostMessage =
+  | AckMessage
   | CanvasImageUrlMessage
   | DisplayLoadingUiMessage
   | EngineReadyMessage

package/EngineState.d.ts

@@ -1,4 +0,0 @@
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface EngineState {
-  // TODO Add content
-}