@defold-typescript/types 0.8.3 → 0.8.4

package/generated/kinds/gui-script.d.ts

@@ -39,6 +39,7 @@ import "../../src/engine-globals";
 import "../../src/go-overloads";
 import "../../src/message-guard";
 import "../../src/msg-overloads";
+import "../../src/window-event-guard";
 import "../builtin-messages";
 import "../gui";
 

package/generated/kinds/render-script.d.ts

@@ -39,6 +39,7 @@ import "../../src/engine-globals";
 import "../../src/go-overloads";
 import "../../src/message-guard";
 import "../../src/msg-overloads";
+import "../../src/window-event-guard";
 import "../builtin-messages";
 import "../render";
 

package/generated/kinds/script.d.ts

@@ -39,6 +39,7 @@ import "../../src/engine-globals";
 import "../../src/go-overloads";
 import "../../src/message-guard";
 import "../../src/msg-overloads";
+import "../../src/window-event-guard";
 import "../builtin-messages";
 
 export { defineScript } from "../../src/lifecycle";

package/generated/window.d.ts

@@ -140,7 +140,7 @@ declare global {
      * });
      * ```
      */
-    function set_listener(callback?: (self: unknown, event: unknown, data: unknown) => void): void;
+    function set_listener(callback?: (self: unknown, event: typeof WINDOW_EVENT_FOCUS_LOST | typeof WINDOW_EVENT_FOCUS_GAINED | typeof WINDOW_EVENT_RESIZED | typeof WINDOW_EVENT_ICONFIED | typeof WINDOW_EVENT_DEICONIFIED, data: Record<string | number, unknown>) => void): void;
     /**
      * Set the locking state for current mouse cursor on a PC platform.
      * This function locks or unlocks the mouse cursor to the center point of the window. While the cursor is locked,

package/index.d.ts

@@ -3,6 +3,7 @@
 import "./generated/builtin-messages";
 import "./src/msg-overloads";
 import "./src/message-guard";
+import "./src/window-event-guard";
 import "./src/message-dispatch";
 import "./src/engine-globals";
 import "./generated/b2d";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defold-typescript/types",
-  "version": "0.8.3",
+  "version": "0.8.4",
   "description": "TypeScript types for the Defold engine's Lua APIs.",
   "license": "MIT",
   "repository": {

package/scripts/regen.ts

@@ -234,6 +234,7 @@ const UNIVERSAL_EXTRA_IMPORTS: readonly string[] = [
   "../../src/engine-globals",
   "../../src/msg-overloads",
   "../../src/message-guard",
+  "../../src/window-event-guard",
   "../../src/go-overloads",
 ];
 

package/src/emit-dts.ts

@@ -499,6 +499,21 @@ export const TABLE_SLOT_CURATIONS: ReadonlyMap<string, TableSlotCuration> = new
   ],
 ]);
 
+// Slot-keyed (`element:param:name`, mirroring TABLE_SLOT_CURATIONS) replacements
+// for a callback parameter's recovered signature, used where the generic
+// `recoverCallbackSignature` `unknown`-everywhere form leaves real engine type
+// information on the table. The value is the full emitted function type. Honest
+// only: `window.set_listener` discriminates `event` by a known constant union and
+// its `data` is a bare record (only resize carries fields — `isWindowEvent` is the
+// path to typed `data`), mirroring the `msg.post` (send, typed) / `isMessage`
+// (receive, narrow) split.
+export const CALLBACK_SIGNATURE_CURATIONS: ReadonlyMap<string, string> = new Map([
+  [
+    "window.set_listener:param:callback",
+    "(self: unknown, event: typeof WINDOW_EVENT_FOCUS_LOST | typeof WINDOW_EVENT_FOCUS_GAINED | typeof WINDOW_EVENT_RESIZED | typeof WINDOW_EVENT_ICONFIED | typeof WINDOW_EVENT_DEICONIFIED, data: Record<string | number, unknown>) => void",
+  ],
+]);
+
 // resource.set_atlas's `table` param and resource.get_atlas's `data` return are
 // flattened `<li><dl>` field lists whose `geometries` header is followed by the
 // `table`-typed siblings `vertices`/`uvs`/`indices` — the grouping heuristic
@@ -1200,7 +1215,11 @@ function mapSlotUnion(
         }
       }
     } else {
-      ts = mapType(token);
+      const curated =
+        slotKind !== undefined && slotName !== undefined
+          ? CALLBACK_SIGNATURE_CURATIONS.get(tableSlotKey(elementName, slotKind, slotName))
+          : undefined;
+      ts = curated ?? mapType(token);
     }
     if (seen.has(ts)) continue;
     seen.add(ts);

package/src/window-event-guard.d.ts

@@ -0,0 +1,52 @@
+/** @noSelfInFile */
+
+// `window.set_listener` hands the callback `event` and `data` as two *separate*
+// params, and the `WINDOW_EVENT_*` constants are branded numbers — so TS can
+// neither correlate the two params nor use a branded number as a discriminant.
+// This guard re-introduces the discriminant at the use site, narrowing the
+// untyped `data` payload (only `WINDOW_EVENT_RESIZED` carries fields). It mirrors
+// `isMessage` for `on_message`; the transpiler lowers the call to a bare
+// `event == window.WINDOW_EVENT_*` (window-event-guard-lowering.ts), so this
+// package emits no runtime Lua.
+type WindowEventKind =
+  | typeof window.WINDOW_EVENT_FOCUS_LOST
+  | typeof window.WINDOW_EVENT_FOCUS_GAINED
+  | typeof window.WINDOW_EVENT_RESIZED
+  | typeof window.WINDOW_EVENT_ICONFIED
+  | typeof window.WINDOW_EVENT_DEICONIFIED;
+
+type WindowEventData<K extends WindowEventKind> = K extends typeof window.WINDOW_EVENT_RESIZED
+  ? { width: number; height: number }
+  : undefined;
+
+declare global {
+  /**
+   * Type guard for a `window.set_listener` callback: narrows the untyped `data`
+   * payload to its event-specific shape when `event` matches a known
+   * `WINDOW_EVENT_*` constant. The engine hands `event` and `data` as separate
+   * params and the constants are branded numbers, so TS cannot auto-narrow `data`
+   * from an `event === window.WINDOW_EVENT_RESIZED` check — this guard
+   * re-introduces the discriminant. Only `WINDOW_EVENT_RESIZED` carries fields
+   * (`{ width, height }`); every other event narrows `data` to `undefined`.
+   *
+   * @param event - the event constant the callback received.
+   * @param data - the untyped data payload the callback received.
+   * @param expected - the window event constant to test against (e.g. `window.WINDOW_EVENT_RESIZED`).
+   * @returns `true` when `event` matches `expected`, narrowing `data` to that event's payload.
+   * @example
+   * ```ts
+   * window.set_listener((self, event, data) => {
+   *   if (isWindowEvent(event, data, window.WINDOW_EVENT_RESIZED)) {
+   *     print("resized:", data.width, data.height);
+   *   }
+   * });
+   * ```
+   */
+  function isWindowEvent<K extends WindowEventKind>(
+    event: unknown,
+    data: unknown,
+    expected: K,
+  ): data is WindowEventData<K>;
+}
+
+export {};