@defold-typescript/types 0.35.0 → 0.37.0

package/generated/versions/defold-1.13.0/zlib.d.ts

@@ -28,7 +28,8 @@ declare global {
      * @returns inflated buffer
      * @example
      * ```ts
-     * const data = "\120\94\11\201\200\44\86\0\162\68\133\226\146\162\204\188\116\133\242\204\146\12\133\210\188\228\252\220\130\162\212\226\226\212\20\133\148\196\146\68\61\0\44\67\14\201";
+     * const data =
+     *   "\x78\x5e\x0b\xc9\xc8\x2c\x56\x00\xa2\x44\x85\xe2\x92\xa2\xcc\xbc\x74\x85\xf2\xcc\x92\x0c\x85\xd2\xbc\xe4\xfc\xdc\x82\xa2\xd4\xe2\xe2\xd4\x14\x85\x94\xc4\x92\x44\x3d\x00\x2c\x43\x0e\xc9";
      * const uncompressed_data = zlib.inflate(data);
      * print(uncompressed_data); //> This is a string with uncompressed data.
      * ```

package/generated/window.d.ts

@@ -95,7 +95,7 @@ declare global {
      *
      * - number `inset_bottom`
      */
-    function get_safe_area(): { safe_area: { x: number; y: number; width: number; height: number; inset_left: number; inset_top: number; inset_right: number; inset_bottom: number } };
+    function get_safe_area(): { x: number; y: number; width: number; height: number; inset_left: number; inset_top: number; inset_right: number; inset_bottom: number };
     /**
      * This returns the current window size (width and height).
      */

package/generated/zlib.d.ts

@@ -28,7 +28,8 @@ declare global {
      * @returns inflated buffer
      * @example
      * ```ts
-     * const data = "\120\94\11\201\200\44\86\0\162\68\133\226\146\162\204\188\116\133\242\204\146\12\133\210\188\228\252\220\130\162\212\226\226\212\20\133\148\196\146\68\61\0\44\67\14\201";
+     * const data =
+     *   "\x78\x5e\x0b\xc9\xc8\x2c\x56\x00\xa2\x44\x85\xe2\x92\xa2\xcc\xbc\x74\x85\xf2\xcc\x92\x0c\x85\xd2\xbc\xe4\xfc\xdc\x82\xa2\xd4\xe2\xe2\xd4\x14\x85\x94\xc4\x92\x44\x3d\x00\x2c\x43\x0e\xc9";
      * const uncompressed_data = zlib.inflate(data);
      * print(uncompressed_data); //> This is a string with uncompressed data.
      * ```

package/index.d.ts

@@ -22,6 +22,7 @@ import "./generated/collectionproxy";
 import "./generated/compute";
 import "./generated/crash";
 import "./generated/factory";
+import "./generated/font";
 import "./generated/go";
 import "./src/go-overloads";
 import "./generated/graphics";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defold-typescript/types",
-  "version": "0.35.0",
+  "version": "0.37.0",
   "description": "TypeScript types for the Defold engine's Lua APIs.",
   "license": "MIT",
   "repository": {
@@ -68,7 +68,10 @@
     "!src/**/__snapshots__",
     "!scripts/lua-types-signature-index.ts",
     "!scripts/fidelity-audit.ts",
-    "!scripts/augmentation-namespaces.ts"
+    "!scripts/augmentation-namespaces.ts",
+    "!scripts/example-pins.ts",
+    "!scripts/example-surfaces.ts",
+    "!scripts/example-typecheck.ts"
   ],
   "publishConfig": {
     "access": "public"

package/scripts/generate-api-signatures.ts

@@ -1,5 +1,6 @@
 import { resolve } from "node:path";
 import { symbolIdentityKey } from "../src/api-availability";
+import type { SlotTypes } from "../src/emit-dts";
 import { selectCompleteVersionSurfaces, versionOf } from "./generate-api-availability";
 import {
   generateModuleSignatures,
@@ -15,6 +16,11 @@ const SIGNATURES_PATH = resolve(PACKAGE_ROOT, "api-signatures.json");
 export interface SignaturesArtifact {
   // version -> symbolIdentityKey -> authoritative TS signature text
   readonly versions: Record<string, Record<string, string>>;
+  // The same axis and keys, carrying each documented slot's rendered type. Kept
+  // parallel rather than folded into `versions` because three consumers
+  // (`api-surface-loader`, `combined-surface`, `version-window`) type that map's
+  // value as a string; a symbol documenting no slot is absent here.
+  readonly slotTypes: Record<string, Record<string, SlotTypes>>;
 }
 
 export interface BuildSignaturesOptions {
@@ -51,9 +57,9 @@ export function withheldSymbols(entry: ModuleManifestEntry): { key: string; fqn:
   return withheld;
 }
 
-function sortObjectKeys(record: Record<string, string>): Record<string, string> {
-  const sorted: Record<string, string> = {};
-  for (const key of Object.keys(record).sort()) sorted[key] = record[key] as string;
+function sortObjectKeys<T>(record: Record<string, T>): Record<string, T> {
+  const sorted: Record<string, T> = {};
+  for (const key of Object.keys(record).sort()) sorted[key] = record[key] as T;
   return sorted;
 }
 
@@ -62,21 +68,33 @@ export function buildSignaturesArtifact(options: BuildSignaturesOptions = {}): S
   const registryPath = options.registryPath ?? resolve(packageRoot, "api-targets.json");
   const targets = selectCompleteVersionSurfaces(loadApiTargets(registryPath));
   const versions: Record<string, Record<string, string>> = {};
+  const slotTypes: Record<string, Record<string, SlotTypes>> = {};
   for (const target of targets) {
     const version = versionOf(target);
     const perSymbol: Record<string, string> = {};
+    const perSymbolSlots: Record<string, SlotTypes> = {};
     for (const entry of loadTargetModules(target, packageRoot)) {
-      for (const { identity, tsSignature } of generateModuleSignatures(entry)) {
-        perSymbol[symbolIdentityKey(identity)] = tsSignature;
+      for (const signature of generateModuleSignatures(entry)) {
+        const key = symbolIdentityKey(signature.identity);
+        perSymbol[key] = signature.tsSignature;
+        if (Object.keys(signature.slotTypes).length > 0) {
+          perSymbolSlots[key] = sortObjectKeys({ ...signature.slotTypes });
+        }
       }
+      // An authored fold replaces the declaration text wholesale, so whatever
+      // slots the generated emit had recorded no longer describe it.
       for (const { key, fqn } of withheldSymbols(entry)) {
         const authored = authoredSignature(packageRoot, entry.namespace, fqn);
-        if (authored !== null) perSymbol[key] = authored;
+        if (authored !== null) {
+          perSymbol[key] = authored;
+          delete perSymbolSlots[key];
+        }
       }
     }
     versions[version] = sortObjectKeys(perSymbol);
+    slotTypes[version] = sortObjectKeys(perSymbolSlots);
   }
-  return { versions };
+  return { versions, slotTypes };
 }
 
 function biomeFormatJson(raw: string): string {
@@ -86,7 +104,14 @@ function biomeFormatJson(raw: string): string {
   if (out.exitCode !== 0) {
     throw new Error(`biome format failed: ${out.stderr.toString()}`);
   }
-  return out.stdout.toString();
+  const formatted = out.stdout.toString();
+  // Biome exits 0 and emits nothing for input it declined to read (a payload over
+  // `files.maxSize` is reported only on stderr), which would otherwise serialize
+  // the artifact as an empty file.
+  if (formatted.length === 0) {
+    throw new Error(`biome format produced no output: ${out.stderr.toString()}`);
+  }
+  return formatted;
 }
 
 export function serializeSignaturesArtifact(artifact: SignaturesArtifact): string {