feat: enhance getTypeSchema to handle TypeScript type expressions and update documentation

Author: nicosammito

src/schema/getTypeSchema.ts

@@ -4,13 +4,12 @@ import {getSchema, Schema} from "../util/schema.util"
 import {createCompilerHost, getSharedTypeDeclarations} from "../utils"
 
 /**
- * Generates a schema for a given TypeScript type string.
+ * Generates a schema for a given TypeScript type expression string.
  *
- * This function creates a virtual TypeScript environment, parses the provided type string
- * (along with any provided data type definitions), and extracts the schema for the last
- * type-related statement (TypeAlias, Interface, or Class) found in the string.
+ * This function creates a virtual TypeScript environment, wraps the provided type expression
+ * into a type alias 'T', and extracts the schema for it.
  *
- * @param typeString - The TypeScript code containing the type definition (e.g., "type MyType = { a: string }").
+ * @param typeString - The TypeScript type expression (e.g., "string | number" or "{ a: string }").
  * @param dataTypes - An optional array of additional data type definitions to be included in the environment.
  * @returns The generated Schema for the identified type, or undefined if no valid type was found or an error occurred.
  */
@@ -20,7 +19,7 @@ export const getTypeSchema = (
 ): Schema | undefined => {
     const fileName = "index.ts"
     const typeDefs = getSharedTypeDeclarations(dataTypes)
-    const sourceCode = `${typeDefs}\n${typeString}`
+    const sourceCode = `${typeDefs}\ntype MyType = ${typeString}`
 
     const host = createCompilerHost(fileName, sourceCode)
     const program = host.languageService.getProgram()

test/schema/schema.test.ts

@@ -1,6 +1,6 @@
 import {describe, expect, it} from "vitest";
 import {Flow} from "@code0-tech/sagittarius-graphql-types";
-import {getFlowValidation, getSignatureSchema} from "../../src";
+import {getFlowValidation, getSignatureSchema, getTypeSchema} from "../../src";
 import {DATA_TYPES, FUNCTION_SIGNATURES} from "../data";
 
 describe("Schema", () => {
@@ -116,4 +116,10 @@ describe("Schema", () => {
 
     });
 
+    it('3', () => {
+        const result = getTypeSchema("{text: NUMBER, bla?: LIST<TEXT>}", DATA_TYPES);
+
+        //console.dir(result, {depth: null})
+    });
+
 })