@defold-typescript/types 0.17.1 → 0.18.0

package/package.json

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

package/src/api-doc.ts

@@ -18,6 +18,8 @@ export interface ApiProperty {
 
 export interface ApiTypedef {
   name: string;
+  functions?: ApiFunction[];
+  properties?: ApiVariable[];
 }
 
 export interface ApiConstant {
@@ -40,6 +42,11 @@ export interface ApiParameter {
   doc: string;
   types: string[];
   isOptional: boolean;
+  /**
+   * Per-member docs for an object-literal type, extracted as a tree alongside
+   * the flat `types` token (never inside it). Absent for plain-typed params.
+   */
+  fields?: ApiParameter[];
 }
 
 export interface ApiVariable {
@@ -85,13 +92,23 @@ export function parseDefoldApiDoc(input: unknown): ApiModule {
     } else if (type === "PROPERTY") {
       properties.push(parseProperty(element));
     } else if (type === "TYPEDEF") {
-      typedefs.push({ name: stringOr(element.name, "") });
+      typedefs.push(parseTypedef(element));
     }
   }
 
   return { namespace, brief, description, functions, variables, constants, properties, typedefs };
 }
 
+function parseTypedef(element: Record<string, unknown>): ApiTypedef {
+  const functions = parseFunctionList(element.functions);
+  const properties = parseVariableList(element.properties);
+  return {
+    name: stringOr(element.name, ""),
+    ...(functions.length > 0 ? { functions } : {}),
+    ...(properties.length > 0 ? { properties } : {}),
+  };
+}
+
 function parseProperty(element: Record<string, unknown>): ApiProperty {
   const brief = stringOr(element.brief, "");
   const span = /<span class="type">([^<]+)<\/span>/.exec(brief);
@@ -138,6 +155,24 @@ function parseVariable(element: Record<string, unknown>): ApiVariable {
   };
 }
 
+function parseFunctionList(raw: unknown): ApiFunction[] {
+  if (!Array.isArray(raw)) return [];
+  const out: ApiFunction[] = [];
+  for (const item of raw) {
+    if (isRecord(item)) out.push(parseFunction(item));
+  }
+  return out;
+}
+
+function parseVariableList(raw: unknown): ApiVariable[] {
+  if (!Array.isArray(raw)) return [];
+  const out: ApiVariable[] = [];
+  for (const item of raw) {
+    if (isRecord(item)) out.push(parseVariable(item));
+  }
+  return out;
+}
+
 function parseParameterList(raw: unknown): ApiParameter[] {
   if (!Array.isArray(raw)) return [];
   const out: ApiParameter[] = [];
@@ -148,6 +183,7 @@ function parseParameterList(raw: unknown): ApiParameter[] {
       doc: stringOr(item.doc, ""),
       types: parseStringArray(item.types),
       isOptional: item.is_optional === "True",
+      ...(Array.isArray(item.fields) ? { fields: parseParameterList(item.fields) } : {}),
     });
   }
   return out;