@defold-typescript/types 0.35.0 → 0.36.0

package/src/emit-dts.ts

@@ -222,7 +222,9 @@ export const OVERLOAD_COVERED_SKIPS = new Set([
 // is the TSTL non-string-key Lua-table idiom and resolves the same way the
 // already-emitted `LuaMultiReturn` does. The audit consults this map too, so the
 // gate and the emitted surface stay coupled; a slot not curated here still
-// surfaces under `recordTables` until a human adds it.
+// surfaces under `recordTables` until a human adds it. Key and value are both
+// `A | B` union tokens split per token, so a key whose doc names constants
+// brands each of them rather than widening to `number`.
 export const MAPPING_TABLE_SLOTS: ReadonlyMap<string, { key: string; value: string }> = new Map([
   ["gui.clone_tree", { key: "hash", value: "node" }],
   ["gui.get_tree", { key: "hash", value: "node" }],
@@ -408,6 +410,18 @@ export function documentedConstantTokens(text: string, universe: ReadonlySet<str
   return [...out];
 }
 
+// The constants a `table` slot's doc names as the table's *keys*, as opposed to
+// the far commoner shape where a field's *value* is a constant
+// (`physics.get_shape`'s `type`, `resource.create_texture`'s `format`). Upstream
+// marks the difference in prose — render.clear reads "table with keys specifying
+// which buffers to clear ... Available keys are:" — so a key mention alongside a
+// named constant is the discriminator. Empty means the slot has no documented
+// constant keys, which is true of every `table` slot but one today.
+export function documentedConstantKeyTokens(doc: string, universe: ReadonlySet<string>): string[] {
+  if (!/\bkeys?\b/i.test(doc.replace(/<[^>]*>/g, ""))) return [];
+  return documentedConstantTokens(doc, universe);
+}
+
 type SlotDocLookup = (slotKey: string) => string | undefined;
 
 function constantSlotTokens(
@@ -830,11 +844,20 @@ export const TABLE_SLOT_CURATIONS: ReadonlyMap<string, TableSlotCuration> = new
   // render.predicate's `tags` is "table of tags ... can be of either hash or
   // string type", a homogeneous array whose element is the string|hash union.
   ["render.predicate:param:tags", { kind: "array", element: ["string", "hash"] }],
-  // render.clear's `buffers` maps the numeric graphics.BUFFER_* constants to
-  // their clear value: vector4 for the color buffer, number for depth/stencil.
-  // The mapping value is the `number | vector4` union; the mapping string branch
-  // splits the union token, so the value emits `number | Vector4`.
-  ["render.clear:param:buffers", { kind: "mapping", key: "number", value: "number | vector4" }],
+  // render.clear's `buffers` maps the graphics.BUFFER_TYPE_* constants its doc
+  // names as keys to their clear value: vector4 for the color buffer, number for
+  // depth/stencil. Both sides are union tokens the mapping string branch splits,
+  // so the key emits the three branded constants and the value `number | Vector4`.
+  // The key is branded rather than `number`, which is the narrowing users migrate
+  // to via the authored `render.ClearBufferKey` alias.
+  [
+    "render.clear:param:buffers",
+    {
+      kind: "mapping",
+      key: "graphics.BUFFER_TYPE_COLOR0_BIT | graphics.BUFFER_TYPE_DEPTH_BIT | graphics.BUFFER_TYPE_STENCIL_BIT",
+      value: "number | vector4",
+    },
+  ],
   // go.on_input and gui.on_input share the same well-known InputAction shape
   // (the on_input function description lists the well-known fields: value,
   // pressed, released, repeated, x/y/screen_x/screen_y/dx/dy/screen_dx/screen_dy,
@@ -1883,10 +1906,25 @@ export function emitDeclarations(module: ApiModule, options?: EmitOptions): stri
   return `${lines.join("\n")}\n`;
 }
 
+/**
+ * Every documented slot's rendered TS type, keyed `param|return:<position>:<raw
+ * ref-doc name>`. The position is part of the key because a multi-return can
+ * carry several unnamed slots (`push.schedule` renders two), which a name-only
+ * key would collapse into one. Each value appears verbatim inside the symbol's
+ * own `tsSignature`, so a consumer rendering a slot's type beside that signature
+ * cannot contradict it.
+ */
+export type SlotTypes = Readonly<Record<string, string>>;
+
+function slotKey(kind: "param" | "return", position: number, name: string): string {
+  return `${kind}:${position}:${name}`;
+}
+
 /** One emitted symbol's identity paired with its rendered TS signature text. */
 export interface SymbolSignature {
   readonly identity: ApiSymbolIdentity;
   readonly tsSignature: string;
+  readonly slotTypes: SlotTypes;
 }
 
 /**
@@ -1931,9 +1969,14 @@ export function emitSymbolSignatures(module: ApiModule, options?: EmitOptions):
   });
   const emitName = (name: string): string => (TS_RESERVED_NAMES.has(name) ? `_${name}` : name);
 
+  // A member with no call list (constant, variable, property, typedef) documents
+  // no slot, so it reports an empty map rather than being absent from the ledger.
+  const NO_SLOTS: SlotTypes = {};
+
   for (const fn of module.functions) {
     const prepared = prepareFunction(fn, prefix);
     if (prepared === null) continue;
+    const slotTypes: Record<string, string> = {};
     out.push({
       identity: fnIdentity(fn),
       tsSignature: emitFunction(
@@ -1943,7 +1986,9 @@ export function emitSymbolSignatures(module: ApiModule, options?: EmitOptions):
         resolver,
         constantTokens,
         urlParameters,
+        slotTypes,
       ),
+      slotTypes,
     });
   }
 
@@ -1957,9 +2002,11 @@ export function emitSymbolSignatures(module: ApiModule, options?: EmitOptions):
         signature: "",
       },
       tsSignature: emitVariable(v, emitName(v.name), mapType),
+      slotTypes: NO_SLOTS,
     });
   }
   for (const fn of nested.functions) {
+    const slotTypes: Record<string, string> = {};
     out.push({
       identity: fnIdentity(fn.original),
       tsSignature: emitFunction(
@@ -1969,16 +2016,27 @@ export function emitSymbolSignatures(module: ApiModule, options?: EmitOptions):
         resolver,
         constantTokens,
         urlParameters,
+        slotTypes,
       ),
+      slotTypes,
     });
   }
 
   const handleGroups = collectHandleMethodGroups(module);
   for (const group of handleGroups.values()) {
     for (const prepared of group) {
+      const slotTypes: Record<string, string> = {};
       out.push({
         identity: fnIdentity(prepared.original),
-        tsSignature: emitMethod(prepared, mapType, resolver, constantTokens, urlParameters),
+        tsSignature: emitMethod(
+          prepared,
+          mapType,
+          resolver,
+          constantTokens,
+          urlParameters,
+          slotTypes,
+        ),
+        slotTypes,
       });
     }
   }
@@ -1989,6 +2047,7 @@ export function emitSymbolSignatures(module: ApiModule, options?: EmitOptions):
     out.push({
       identity: { namespace: module.namespace, kind: "CONSTANT", name: c.name, signature: "" },
       tsSignature: `const ${prepared.name}: ${brandType(prepared.fqn)};`,
+      slotTypes: NO_SLOTS,
     });
   }
 
@@ -1998,6 +2057,7 @@ export function emitSymbolSignatures(module: ApiModule, options?: EmitOptions):
     out.push({
       identity: { namespace: module.namespace, kind: "VARIABLE", name: v.name, signature: "" },
       tsSignature: emitVariable(prepared, emitName(prepared.name), mapType),
+      slotTypes: NO_SLOTS,
     });
   }
 
@@ -2005,6 +2065,7 @@ export function emitSymbolSignatures(module: ApiModule, options?: EmitOptions):
     out.push({
       identity: { namespace: module.namespace, kind: "PROPERTY", name: p.name, signature: "" },
       tsSignature: emitPropertyMember(p, mapType, module.namespace),
+      slotTypes: NO_SLOTS,
     });
   }
 
@@ -2013,6 +2074,7 @@ export function emitSymbolSignatures(module: ApiModule, options?: EmitOptions):
     out.push({
       identity: { namespace: module.namespace, kind: "TYPEDEF", name: t.name, signature: "" },
       tsSignature: `type ${t.name} = Opaque<"${t.name}">;`,
+      slotTypes: NO_SLOTS,
     });
   }
 
@@ -2208,6 +2270,7 @@ function memberSignature(
   resolver: TableDocResolver,
   constantTokens: ConstantSlotTokens,
   urlParameters: UrlParameterTable,
+  slotSink?: Record<string, string>,
 ): string {
   const original = prepared.original.parameters;
   const elementName = prepared.original.name;
@@ -2216,22 +2279,19 @@ function memberSignature(
   const positional = (varargIndex === -1 ? original : original.slice(0, varargIndex)).map((p, i) =>
     emitParameter(p, i, i >= cutoff, mapType, resolver, constantTokens, elementName, urlParameters),
   );
-  const params = (
+  const rest =
     varargIndex === -1
-      ? positional
-      : [
-          ...positional,
-          emitRestParameter(
-            original,
-            varargIndex,
-            mapType,
-            resolver,
-            constantTokens,
-            elementName,
-            urlParameters,
-          ),
-        ]
-  ).join(", ");
+      ? null
+      : emitRestParameter(
+          original,
+          varargIndex,
+          mapType,
+          resolver,
+          constantTokens,
+          elementName,
+          urlParameters,
+        );
+  const params = [...positional.map((p) => p.text), ...(rest ? [rest.text] : [])].join(", ");
   const ret = emitReturn(
     prepared.original.returnValues,
     mapType,
@@ -2241,12 +2301,28 @@ function memberSignature(
   );
   const predicateToken = TYPE_PREDICATES.get(elementName);
   const soleParam = original[0];
-  if (
+  const isPredicate =
     predicateToken !== undefined &&
     soleParam !== undefined &&
     original.length === 1 &&
-    ret.type === "boolean"
-  ) {
+    ret.type === "boolean";
+  if (slotSink !== undefined) {
+    for (const [i, p] of positional.entries()) {
+      const raw = original[i];
+      if (raw) slotSink[slotKey("param", i, raw.name)] = p.ts;
+    }
+    for (const slot of rest?.slots ?? []) {
+      slotSink[slotKey("param", slot.position, slot.name)] = slot.ts;
+    }
+    // A predicate renders `arg is T` in place of the mapped `boolean`, so its
+    // return slot has no text in the signature to stand on and is not reported.
+    if (!isPredicate) {
+      for (const slot of ret.slots) {
+        slotSink[slotKey("return", slot.position, slot.name)] = slot.ts;
+      }
+    }
+  }
+  if (isPredicate && soleParam !== undefined && predicateToken !== undefined) {
     return `${name}(${params}): ${safeParamName(soleParam.name, 0)} is ${mapType(predicateToken)};`;
   }
   return `${name}(${params}): ${ret.type};${ret.trailing}`;
@@ -2259,8 +2335,9 @@ function emitFunction(
   resolver: TableDocResolver,
   constantTokens: ConstantSlotTokens,
   urlParameters: UrlParameterTable,
+  slotSink?: Record<string, string>,
 ): string {
-  return `function ${memberSignature(prepared, name, mapType, resolver, constantTokens, urlParameters)}`;
+  return `function ${memberSignature(prepared, name, mapType, resolver, constantTokens, urlParameters, slotSink)}`;
 }
 
 // A colon-method member of a handle interface: identical signature machinery to a
@@ -2272,8 +2349,17 @@ function emitMethod(
   resolver: TableDocResolver,
   constantTokens: ConstantSlotTokens,
   urlParameters: UrlParameterTable,
+  slotSink?: Record<string, string>,
 ): string {
-  return memberSignature(prepared, prepared.name, mapType, resolver, constantTokens, urlParameters);
+  return memberSignature(
+    prepared,
+    prepared.name,
+    mapType,
+    resolver,
+    constantTokens,
+    urlParameters,
+    slotSink,
+  );
 }
 
 // Build the indented JSDoc lines for a function from its ref-doc prose. The
@@ -2444,21 +2530,29 @@ function emitRestParameter(
   constantTokens: ConstantSlotTokens,
   elementName: string,
   urlParameters: UrlParameterTable,
-): string {
+): { text: string; slots: EmittedSlot[] } {
   const vararg = params[varargIndex];
-  if (vararg === undefined) return "";
-  const members = [
-    ...new Set(
-      params
-        .slice(varargIndex)
-        .map((p) =>
-          parameterType(p, mapType, resolver, constantTokens, elementName, urlParameters),
-        ),
-    ),
-  ];
+  if (vararg === undefined) return { text: "", slots: [] };
+  const folded = params.slice(varargIndex).map((p, offset) => ({
+    position: varargIndex + offset,
+    name: p.name,
+    ts: parameterType(p, mapType, resolver, constantTokens, elementName, urlParameters),
+  }));
+  const members = [...new Set(folded.map((slot) => slot.ts))];
   const first = members[0] ?? "unknown";
   const element = members.length > 1 ? `(${members.join(" | ")})` : first;
-  return `...${varargParamName(vararg.name, varargIndex)}: ${element}[]`;
+  return {
+    text: `...${varargParamName(vararg.name, varargIndex)}: ${element}[]`,
+    slots: folded,
+  };
+}
+
+// A slot's rendered type paired with the position and raw ref-doc name that
+// identify it, so the signature text and the per-slot map come out of one call.
+interface EmittedSlot {
+  readonly position: number;
+  readonly name: string;
+  readonly ts: string;
 }
 
 function emitParameter(
@@ -2470,7 +2564,7 @@ function emitParameter(
   constantTokens: ConstantSlotTokens,
   elementName: string,
   urlParameters: UrlParameterTable,
-): string {
+): { text: string; ts: string } {
   const name = safeParamName(p.name, index);
   const ts = parameterType(p, mapType, resolver, constantTokens, elementName, urlParameters);
   // An interior doc-optional param (a required param follows, so the trailing-`?`
@@ -2478,7 +2572,7 @@ function emitParameter(
   // lowers `undefined` to `nil`, the faithful call. Trailing optionals keep the
   // `?` form; required params are untouched.
   const interiorOptional = !optional && isDocOptional(p, elementName) ? " | undefined" : "";
-  return `${name}${optional ? "?" : ""}: ${ts}${interiorOptional}`;
+  return { text: `${name}${optional ? "?" : ""}: ${ts}${interiorOptional}`, ts };
 }
 
 function emitReturn(
@@ -2487,33 +2581,42 @@ function emitReturn(
   resolver: TableDocResolver,
   constantTokens: ConstantSlotTokens,
   elementName: string,
-): { type: string; trailing: string } {
+): { type: string; trailing: string; slots: EmittedSlot[] } {
+  // An authored whole-return override is not a per-slot render, so it reports no
+  // slots and leaves the consumer on its token-derived fallback.
   const override = RETURN_TYPE_OVERRIDES.get(elementName);
-  if (override !== undefined) return { type: override, trailing: "" };
-  if (returnValues.length === 0) return { type: "void", trailing: "" };
+  if (override !== undefined) return { type: override, trailing: "", slots: [] };
+  if (returnValues.length === 0) return { type: "void", trailing: "", slots: [] };
   if (returnValues.length > 1) {
     // Defold multi-returns are positional and always present; each slot maps
     // straight through (unknown when the doc lists no type) into a tuple that
     // typescript-to-lua erases to `local a, b = fn()`.
-    const slots = returnValues.map((rv) =>
-      rv.types.length > 0
-        ? mapSlotUnion(
-            rv.types,
-            rv.doc,
-            mapType,
-            false,
-            resolver,
-            constantTokens,
-            elementName,
-            "return",
-            rv.name,
-          )
-        : "unknown",
-    );
-    return { type: `LuaMultiReturn<[${slots.join(", ")}]>`, trailing: "" };
+    const emitted = returnValues.map((rv, index) => ({
+      position: index,
+      name: rv.name,
+      ts:
+        rv.types.length > 0
+          ? mapSlotUnion(
+              rv.types,
+              rv.doc,
+              mapType,
+              false,
+              resolver,
+              constantTokens,
+              elementName,
+              "return",
+              rv.name,
+            )
+          : "unknown",
+    }));
+    return {
+      type: `LuaMultiReturn<[${emitted.map((slot) => slot.ts).join(", ")}]>`,
+      trailing: "",
+      slots: emitted,
+    };
   }
   const first = returnValues[0];
-  if (!first) return { type: "void", trailing: "" };
+  if (!first) return { type: "void", trailing: "", slots: [] };
   const ts =
     first.types.length > 0
       ? mapSlotUnion(
@@ -2528,7 +2631,7 @@ function emitReturn(
           first.name,
         )
       : "unknown";
-  return { type: ts, trailing: "" };
+  return { type: ts, trailing: "", slots: [{ position: 0, name: first.name, ts }] };
 }
 
 function emitPropertyMember(
@@ -2606,7 +2709,14 @@ function mapSlotUnion(
           const nested = mapping.value as NestedMapping;
           value = `LuaMap<${mapType(nested.key)}, ${mapType(nested.value)}>`;
         }
-        ts = `LuaMap<${mapType(mapping.key)}, ${value}>`;
+        // A mapping key may be a `A | B` union token too (render.clear's three
+        // documented graphics.BUFFER_TYPE_* constants); split it the same way
+        // the value above is split. A single-token key (no `|`) is unaffected.
+        const key = unionFromTokens(
+          mapping.key.split("|").map((token) => token.trim()),
+          mapType,
+        );
+        ts = `LuaMap<${key}, ${value}>`;
       } else if (element !== undefined) {
         ts = arrayTypeFromTokens(element, mapType);
       } else if (curation?.kind === "object" || curation?.kind === "array-object") {

package/src/index.ts

@@ -49,6 +49,7 @@ export {
   type EmitOptions,
   emitDeclarations,
   emitSymbolSignatures,
+  type SlotTypes,
   type SymbolSignature,
   TS_IDENTIFIER,
   TS_RESERVED_NAMES,

package/src/render-overloads.d.ts

@@ -4,6 +4,23 @@ import type { Opaque } from "./core-types";
 
 declare global {
   namespace render {
+    /**
+     * The buffer keys `render.clear` accepts: the three `graphics.BUFFER_TYPE_*`
+     * constants the reference names. Declare the clear table with this alias —
+     * `LuaMap`'s iterator makes its key parameter invariant, so a
+     * `LuaMap<number, ...>` is not assignable however its entries were set.
+     *
+     * @example
+     * ```ts
+     * const buffers = new LuaMap<render.ClearBufferKey, number | Vector4>();
+     * buffers.set(graphics.BUFFER_TYPE_COLOR0_BIT, vmath.vector4(0, 0, 0, 0));
+     * render.clear(buffers);
+     * ```
+     */
+    type ClearBufferKey =
+      | typeof graphics.BUFFER_TYPE_COLOR0_BIT
+      | typeof graphics.BUFFER_TYPE_DEPTH_BIT
+      | typeof graphics.BUFFER_TYPE_STENCIL_BIT;
     /**
      * Creates a new render target according to the supplied specification table.
      * The parameter table is keyed by buffer type, with one parameter table per