New method of generative types???

Author: Knerio

actions/gls-action/package.json

@@ -11,5 +11,8 @@
     "test": "vitest run",
     "start": "node dist/main.js",
     "docs:generate": "npm run build && node dist/generateTypes.js > ../../docs/Actions/GLS/types.mdx"
+  },
+  "dependencies": {
+    "ts-morph": "^27.0.2"
   }
 }

actions/gls-action/scripts/generateTypes.ts

@@ -3,6 +3,7 @@ import {
     HerculesActionConfigurationDefinition,
     HerculesDataType, HerculesFlowType, HerculesRegisterFunctionParameter,
 } from "@code0-tech/hercules";
+import {Project, SymbolFlags, Type} from "ts-morph";
 
 
 const state = {
@@ -60,77 +61,162 @@ async function run() {
 }
 
 run().then(async () => {
-    let typeContent = `---
+    console.log(`---
 title: Datatypes
 description: All data types registered by the GLS Action — field references and descriptions.
 ---
+import {TypeTable} from "fumadocs-ui/components/type-table";
 
 # GLS Action Types
 
 The GLS Action registers the following data types with the Hercules platform. These types are used as inputs and outputs
 of the GLS functions and can be referenced in your flows.
 
 --- 
-    `
-
+    `)
     state.dataTypes.forEach(value => {
         value.type = `export type ${value.identifier} = ${value.type}`
             .replace(/ \| undefined/g, "")
-            .replace(/\/\*\*/g, "/**\n")
-            .replace(/\*\//g, "\n**/")
-            .replace(
-                /(\w+)(\?)?:\s*(GLS_\w+);/g,
-                (match, name, optionalMark, gls) => {
-                    if (optionalMark) {
-                        return `/**
- Optional.
- @fumadocsHref #type-table-temp.ts-${gls}
-**/
-${name}: ${gls}`;
+
+
+        function breakDown(
+            typeName: string,
+            code: string
+        ): Record<string, string> {
+            const map: Record<string, string> = {};
+
+            const project = new Project({useInMemoryFileSystem: true});
+            const sourceFile = project.createSourceFile("example.ts", code);
+
+            const typeAlias = sourceFile.getTypeAliasOrThrow(typeName);
+            let rootType = typeAlias.getType();
+
+            if (rootType.isArray()) {
+                rootType = rootType.getArrayElementTypeOrThrow();
+            }
+
+            function buildType(type: Type, currentName: string): string {
+                const props = type.getProperties();
+
+                const lines: string[] = [];
+
+                props.forEach(symbol => {
+                    const name = symbol.getName();
+                    const decl = symbol.getDeclarations()[0];
+                    if (!decl) return;
+
+
+                    let propType = symbol.getTypeAtLocation(decl);
+
+                    // unwrap arrays
+                    let isArray = false;
+                    if (propType.isArray()) {
+                        propType = propType.getArrayElementTypeOrThrow();
+                        isArray = true;
                     }
 
-                    return `/**
- @fumadocsHref #type-table-temp.ts-${gls}
-**/
-${name}: ${gls}`;
-                }
-            );
+                    let typeText: string;
 
-        let array = false
-        if (value.type.endsWith("[];")) {
-            value.type = value.type.slice(0, -3) + ";"
-            array = true
-        }
+                    if (propType.getText().startsWith("{")) {
+                        const newName = `${currentName}$${name}`;
 
-        typeContent += `
-# ${value.identifier}${array ? " (array)" : ""}
-        
-<AutoTypeTable type={\`
-        
-${value.type}
-        
-\`} name="${value.identifier}"/>
+                        // recurse first
+                        const nestedType = buildType(propType, newName);
 
-`
-    })
-    typeContent = typeContent.replace(" | undefined", "")
+                        map[newName] = `export type ${newName} = ${nestedType};`;
+
+                        typeText = isArray ? `${newName}[]` : newName;
+                    } else {
+                        typeText = propType.getText(decl);
+                    }
+
+                    // JSDoc
+                    const jsDocs = (decl as any).getJsDocs?.()
+                        ?.map(d => d.getText())
+                        .join("\n");
+
+                    const docPrefix = jsDocs ? `${jsDocs}\n` : "";
 
-    console.log(typeContent)
-})
+                    lines.push(
+                        `${docPrefix}${name}${symbol.hasFlags(SymbolFlags.Optional) ? "?" : ""}: ${typeText};`
+                    );
+                });
 
+                return `{\n${lines.map(l => "    " + l).join("\n")}\n}`;
+            }
 
+            const finalType = buildType(rootType, typeName);
 
+            map[typeName] = `export type ${typeName} = ${finalType};`;
+
+            return map;
+        }
 
 
+        const broke = breakDown(value.identifier, value.type)
+        const entries = Object.entries(broke).reverse();
 
+        for (const [key, val] of entries) {
+            let typeString = `
+            `
 
+            const project = new Project({useInMemoryFileSystem: true});
+            const sourceFile = project.createSourceFile("example.ts", val);
 
 
+            const typeAlias = sourceFile.getTypeAliasOrThrow(key);
 
 
+            let type = typeAlias.getType()
+            const array = typeAlias.getType().isArray()
+            if (array) {
+                type = type.getArrayElementTypeOrThrow()
+            }
 
+            type.getProperties().forEach(property => {
+                const name = property.getName();
 
+                const currType = property.getTypeAtLocation(typeAlias);
+                const currTypeText = currType.getText();
 
+                const docs = {
+                    description: "No description set",
+                    deprecated: false,
+                    default: undefined,
+                    link: undefined
+                }
 
 
+                property.getJsDocTags().forEach(info => {
+                    info.getText().forEach(part => {
+                        docs[info.getName()] = part.text.trim()
+                    })
+                })
+                if (currTypeText.startsWith("GLS_")) {
+                    docs.link = currTypeText.toLowerCase()
+                        .replace(/-/g, "_")
+                        .replace(/\$/g, "")
+                        .replace("[]", "")
+                }
+                typeString += `${name}: {
+                description: '${docs.description}',
+                deprecated: ${docs.deprecated},
+                required: ${!property.isOptional()}, ${docs.link ? `\ntypeDescriptionLink: '#${docs.link}',` : ""}
+                type: '${currTypeText}', ${docs.default ? `\ndefault: ${docs.default}` : ""} 
+            },
+            `
+
+            })
+
+            const table = `<TypeTable type={{${typeString}}}
+/>`
+            console.log(`# ${key}`)
+            console.log(table)
+        }
+        // console.log(`
+// # ${value.identifier} ${array ? "[]" : ""}
+//         `)
+//         console.log(table)
+    })
 
+})

actions/gls-action/src/types/glsAddress.ts

@@ -4,60 +4,42 @@ import {singleZodSchemaToTypescriptDef} from "../helpers";
 
 export const AddressSchema = z.object({
     Name1: z.string().max(40).describe(`
-    Primary name line (person or company).
-    Max 40 characters.
+    @description Primary name line (person or company). Max 40 characters.
     `),
     Name2: z.string().max(40).optional().describe(`
-    Optional second name line (e.g., department or additional identifier).
-    Max 40 characters.
+    @description Optional second name line (e.g., department or additional identifier). Max 40 characters.
     `),    Name3: z.string().max(40).optional().describe(`
-    Optional third name line for extended address details.
-    Max 40 characters.
+    @description Optional third name line for extended address details. Max 40 characters.
     `),
     CountryCode: z.string().max(2).describe(`
-    Two-letter ISO country code (e.g., DE, US).
+    @description Two-letter ISO country code (e.g., DE, US).
     `),
     Province: z.string().max(40).optional().describe(`
-    State, province, or region.
-    Optional field.
-    Max 40 characters.
+    @description State, province, or region. Optional field. Max 40 characters.
     `),
     City: z.string().max(40).describe(`
-    City or locality name.
-    Max 40 characters.
+    @description City or locality name. Max 40 characters.
     `),
     Street: z.string().min(4).describe(`
-    Street name.
-    Minimum 4 characters required.
+    @description Street name. Minimum 4 characters required.
     `),
     StreetNumber: z.string().max(40).optional().describe(`
-    House or building number.
-    Optional field.
-    Max 40 characters.
+    @description House or building number. Optional field. Max 40 characters.
     `),
     ContactPerson: z.string().max(40).min(6).optional().describe(`
-    Full name of a contact person.
-    Optional field.
-    Must be between 6 and 40 characters.
+    @description Full name of a contact person. Optional field. Must be between 6 and 40 characters.
     `),
     FixedLinePhonenumber: z.string().max(35).min(4).optional().describe(`
-    Landline phone number.
-    Optional field.
-    Must be between 4 and 35 characters.
+    @description Landline phone number. Optional field. Must be between 4 and 35 characters.
     `),
     MobilePhonenumber: z.string().max(35).min(4).optional().describe(`
-    Mobile phone number.
-    Optional field.
-    Must be between 4 and 35 characters.
+    @description Mobile phone number. Optional field. Must be between 4 and 35 characters.
     `),
     eMail: z.string().max(80).optional().describe(`
-    Email address.
-    Optional field.
-    Max 80 characters.
+    @description Email address. Optional field. Max 80 characters.
     `),
     ZIPCode: z.string().max(10).describe(`
-    Postal or ZIP code.
-    Max 10 characters.
+    @description Postal or ZIP code. Max 10 characters.
     `),
 })
 export type AddressSchema = z.infer<typeof AddressSchema>

actions/gls-action/src/types/glsUnitService.ts

@@ -5,7 +5,7 @@ import {ActionSdk} from "@code0-tech/hercules";
 
 export const UnitServiceSchema = z.array(z.object({
     Cash: z.object({
-        Reason: z.string().max(160),
+        Reason: z.string().max(160).describe("@description Test"),
         Amount: z.number().min(1),
         Currency: z.string().max(3).min(3)
     }).optional(),