feat: enhance getSignatureSchema to handle flow signatures and improve ID sanitization

Author: nicosammito

src/schema/getSignatureSchema.ts

@@ -25,6 +25,8 @@ interface ParameterDependency {
     dependsOnIndex: number
 }
 
+//TODO: Need to work also for flow signature
+//TODO: needs a way to declare custom datatypes with there schema
 /**
  * Generates node schemas for all parameters of a specified function node.
  *
@@ -63,8 +65,8 @@ export const getSignatureSchema = (
 
     // Retrieve and identify the target node
     const targetNode = flow.nodes?.nodes?.find((n) => n?.id === nodeId)
-    const functionId = `fn_${targetNode?.functionDefinition?.identifier?.replace(/::/g, "_")}`
-    const realNodeId = `node_${sanitizeId(nodeId || "")}`
+    const functionId = nodeId ? `fn_${targetNode?.functionDefinition?.identifier?.replace(/::/g, "_")}` : `flow`
+    const realNodeId = nodeId ? `node_${sanitizeId(nodeId)}` : `flow_${sanitizeId(flow.id!)}`
 
     // Build map of declared functions for easy lookup
     const declaredFunctionsMap = createFunctionMap(sourceFile)
@@ -98,8 +100,8 @@ export const getSignatureSchema = (
         node!,
         combinedParameterTypes,
         funktionDependencies,
-        declaredFunctionsMap,
-        functions,
+        nodeId ? declaredFunctionsMap : new Map(),
+        nodeId ? functions : [],
     )
 }
 

src/utils.ts

@@ -96,7 +96,7 @@ export function getSharedTypeDeclarations(dataTypes?: DataType[], genericType: s
 /**
  * Sanitizes an ID for use as a TypeScript variable name.
  */
-export const sanitizeId = (id: string) => id.replace(/[^a-zA-Z0-9]/g, '_');
+export const sanitizeId = (id: string) => id?.replace(/[^a-zA-Z0-9]/g, '_');
 
 /**
  * Generates TypeScript source code for a flow, suitable for validation and type inference.

test/schema/schema.test.ts

@@ -0,0 +1,119 @@
+import {describe, expect, it} from "vitest";
+import {Flow} from "@code0-tech/sagittarius-graphql-types";
+import {getFlowValidation, getSignatureSchema} from "../../src";
+import {DATA_TYPES, FUNCTION_SIGNATURES} from "../data";
+
+describe("Schema", () => {
+
+    it('1', () => {
+
+        const flow: Flow = {
+            id: "gid://sagittarius/Flow/1",
+            startingNodeId: "gid://sagittarius/NodeFunction/1",
+            nodes: {
+                nodes: [
+                    {
+                        id: "gid://sagittarius/NodeFunction/1",
+                        functionDefinition: {identifier: "std::number::add"},
+                        parameters: {
+                            nodes: [
+                                {value: {__typename: "LiteralValue", value: 1}},
+                                {value: {__typename: "LiteralValue", value: 0}}
+                            ]
+                        },
+                        nextNodeId: "gid://sagittarius/NodeFunction/2"
+                    },
+                    {
+                        id: "gid://sagittarius/NodeFunction/2",
+                        functionDefinition: {identifier: "std::list::for_each"},
+                        parameters: {
+                            nodes: [
+                                {
+                                    value: {
+                                        __typename: "LiteralValue",
+                                        value: [{test: 1}]
+                                    }
+                                },
+                                {
+                                    value: {
+                                        __typename: "NodeFunctionIdWrapper",
+                                        id: "gid://sagittarius/NodeFunction/3"
+                                    }
+                                }
+                            ]
+                        }
+                    },
+                    {
+                        id: "gid://sagittarius/NodeFunction/3",
+                        functionDefinition: {identifier: "std::number::add"},
+                        parameters: {
+                            nodes: [
+                                {
+                                    value: {
+                                        __typename: "ReferenceValue",
+                                        nodeFunctionId: "gid://sagittarius/NodeFunction/2",
+                                        parameterIndex: 1,
+                                        inputIndex: 0,
+                                        referencePath: [{path: "test"}]
+                                    }
+                                },
+                                {
+                                    value: {__typename: "LiteralValue", value: 10}
+                                }
+                            ]
+                        }
+                    }
+                ]
+            },
+            signature: "(test: HTTP_METHOD): void"
+        };
+
+        const result = getSignatureSchema(flow, DATA_TYPES, FUNCTION_SIGNATURES);
+
+        //console.dir(result, {depth: null})
+    });
+
+    it('2', () => {
+
+        const flow: Flow = {
+            nodes: {
+                nodes: [
+                    {
+                        id: "gid://sagittarius/NodeFunction/1",
+                        functionDefinition: {identifier: "std::list::at"},
+                        parameters: {
+                            nodes: [
+                                {value: null},
+                                {value: {__typename: "LiteralValue", value: 0}}
+                            ]
+                        },
+                        nextNodeId: "gid://sagittarius/NodeFunction/2"
+                    },
+                    {
+                        id: "gid://sagittarius/NodeFunction/2",
+                        functionDefinition: {identifier: "std::number::add"},
+                        parameters: {
+                            nodes: [
+                                {
+                                    value: {
+                                        __typename: "ReferenceValue",
+                                        nodeFunctionId: "gid://sagittarius/NodeFunction/1"
+                                    }
+                                },
+                                {
+                                    value: null
+                                }
+                            ]
+                        }
+                    }
+                ]
+            }
+        };
+
+        const result = getSignatureSchema(flow, DATA_TYPES, FUNCTION_SIGNATURES, "gid://sagittarius/NodeFunction/2");
+
+        //console.dir(result, {depth: null})
+
+    });
+
+})