@defold-typescript/library-types 0.23.0 → 0.25.0

package/scripts/__snapshots__/parse-luals.test.ts.snap

@@ -4140,6 +4140,7 @@ Create text node with druid: \`text = druid:new_text(node_name, [initial_value],
         },
         {
           "brief": "Set text to text field",
+          "deprecated": "",
           "generics": [],
           "name": "set_to",
           "params": [
@@ -9461,7 +9462,16 @@ Create layout component with druid: \`layout = druid:new_layout(node, layout_typ
               "isVararg": false,
               "name": "",
               "types": [
-                "number, number",
+                "number",
+              ],
+            },
+            {
+              "doc": "",
+              "isOptional": false,
+              "isVararg": false,
+              "name": "",
+              "types": [
+                "number",
               ],
             },
           ],
@@ -13118,7 +13128,25 @@ If color_id is not found in palette and not a hex string, returns white."
           "isVararg": false,
           "name": "",
           "types": [
-            "number, number, number",
+            "number",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "number",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "number",
           ],
         },
       ],
@@ -13210,7 +13238,34 @@ If color_id is not found in palette and not a hex string, returns white."
           "isVararg": false,
           "name": "",
           "types": [
-            "number, number, number, number",
+            "number",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "number",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "number",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "number",
           ],
         },
       ],
@@ -13265,7 +13320,34 @@ If color_id is not found in palette and not a hex string, returns white."
           "isVararg": false,
           "name": "",
           "types": [
-            "number, number, number, number|nil",
+            "number",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "number",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "number",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "number|nil",
           ],
         },
       ],
@@ -14354,7 +14436,16 @@ Only one widget can be set per game object."
           "isVararg": false,
           "name": "",
           "types": [
-            "table|nil, string|nil",
+            "table|nil",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "string|nil",
           ],
         },
       ],
@@ -14393,7 +14484,16 @@ The path file extension will be used to determine the Defold format (*.atlas, *.
           "isVararg": false,
           "name": "",
           "types": [
-            "boolean, string|nil",
+            "boolean",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "string|nil",
           ],
         },
       ],
@@ -14664,13 +14764,22 @@ The path file extension will be used to determine the Defold format (*.atlas, *.
         },
       ],
       "returns": [
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "string|nil",
+          ],
+        },
         {
           "doc": "@success, reason",
           "isOptional": false,
           "isVararg": false,
           "name": "",
           "types": [
-            "string|nil, string|nil",
+            "string|nil",
           ],
         },
       ],
@@ -14700,13 +14809,22 @@ The path file extension will be used to determine the Defold format (*.atlas, *.
         },
       ],
       "returns": [
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "boolean",
+          ],
+        },
         {
           "doc": "@success, reason",
           "isOptional": false,
           "isVararg": false,
           "name": "",
           "types": [
-            "boolean, string|nil",
+            "string|nil",
           ],
         },
       ],
@@ -14744,13 +14862,40 @@ The path file extension will be used to determine the Defold format (*.atlas, *.
         },
       ],
       "returns": [
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "string",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "string",
+          ],
+        },
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "string",
+          ],
+        },
         {
           "doc": "@new_object_name, name, value, end_struct_flag",
           "isOptional": false,
           "isVararg": false,
           "name": "",
           "types": [
-            "string, string, string, boolean",
+            "boolean",
           ],
         },
       ],
@@ -15705,13 +15850,22 @@ Offset shown in [-0.5 .. 0.5] range, where -0.5 is left or bottom, 0.5 is right
         },
       ],
       "returns": [
+        {
+          "doc": "",
+          "isOptional": false,
+          "isVararg": false,
+          "name": "",
+          "types": [
+            "string",
+          ],
+        },
         {
           "doc": "String representation of table, Is max string length reached",
           "isOptional": false,
           "isVararg": false,
           "name": "result",
           "types": [
-            "string, boolean",
+            "boolean",
           ],
         },
       ],

package/scripts/apply-luals-overrides.ts

@@ -2,19 +2,29 @@
  * Per-target corrections applied to a parsed `LibraryModel` after the merge, for the
  * cases where upstream LuaLS annotations diverge from the library's runtime and the
  * fixtures freeze the annotation verbatim (so it is not hand-patchable in the fixture
- * or the emitted `.d.ts`). The two shapes covered are a module function whose trailing
- * parameter is runtime-optional despite a non-`|nil` `@param`, and an interface method
- * whose `@return` omits an alternative arm. Every named target must exist — a missing
- * function, param, interface, or method throws naming the absent key, mirroring
- * `buildTargetModel`'s loud-fail on an absent `ownFile`, so a stale override never
- * degrades into a silent no-op.
+ * or the emitted `.d.ts`). The five shapes covered are a module function whose trailing
+ * parameter is runtime-optional despite a non-`|nil` `@param`, an interface method
+ * whose `@return` omits an alternative arm, an interface field whose type token is
+ * wrong or underspecified (a stray character, or an untyped `fun(...)` callback), an
+ * interface method parameter with the same underspecification, and an interface field
+ * that only restates a member inherited from a parent, incompatibly enough that the
+ * emitted redeclaration would not type-check (`drop`). Every named target
+ * must exist — a missing function, param, interface, field, or method throws naming the
+ * absent key, mirroring `buildTargetModel`'s loud-fail on an absent `ownFile`, so a
+ * stale override never degrades into a silent no-op.
  */
 
 import type { LibraryModel } from "./parse-luals";
 
 export interface AnnotationOverrides {
   moduleFunctions?: Record<string, { params?: Record<string, { optional?: boolean }> }>;
-  interfaces?: Record<string, { methods?: Record<string, { return?: string }> }>;
+  interfaces?: Record<
+    string,
+    {
+      fields?: Record<string, { type?: string; drop?: boolean }>;
+      methods?: Record<string, { return?: string; params?: Record<string, { type?: string }> }>;
+    }
+  >;
 }
 
 export function applyAnnotationOverrides(
@@ -45,6 +55,19 @@ export function applyAnnotationOverrides(
         `applyAnnotationOverrides: interface "${ifaceName}" is absent from the model.`,
       );
     }
+    for (const [fieldName, fieldOverride] of Object.entries(ifaceOverride.fields ?? {})) {
+      const field = iface.fields.find((f) => f.name === fieldName);
+      if (!field) {
+        throw new Error(
+          `applyAnnotationOverrides: field "${fieldName}" of interface "${ifaceName}" is absent from the model.`,
+        );
+      }
+      if (fieldOverride.drop) {
+        iface.fields.splice(iface.fields.indexOf(field), 1);
+        continue;
+      }
+      if (fieldOverride.type !== undefined) field.types = [fieldOverride.type];
+    }
     for (const [methodName, methodOverride] of Object.entries(ifaceOverride.methods ?? {})) {
       const method = iface.methods.find((m) => m.name === methodName);
       if (!method) {
@@ -57,6 +80,15 @@ export function applyAnnotationOverrides(
           { name: "", types: [methodOverride.return], doc: "", isOptional: false, isVararg: false },
         ];
       }
+      for (const [paramName, paramOverride] of Object.entries(methodOverride.params ?? {})) {
+        const param = method.params.find((p) => p.name === paramName);
+        if (!param) {
+          throw new Error(
+            `applyAnnotationOverrides: param "${paramName}" of method "${methodName}" of interface "${ifaceName}" is absent from the model.`,
+          );
+        }
+        if (paramOverride.type !== undefined) param.types = [paramOverride.type];
+      }
     }
   }
   return model;