@miroir-framework/jzod-ts 0.5.3 → 0.6.0

package/src/index.ts

@@ -1,60 +1,60 @@
-export {
-  jzodToTsCode,
-  jzodToTsTypeAliasesAndZodText,
-  TsTypeAliasesAndZodText as JzodTypeAliasesAndZodText,
-  TsTypeAliases,
-} from "./JzodToTs";
-export { printTsTypeAlias, printTsTypeAliases } from "./tools";
-
-export {
-  // SCHEMAS (const)
-  jzodArray,
-  jzodAttribute,
-  jzodAttributeDateValidations,
-  jzodAttributeDateWithValidations,
-  jzodAttributeNumberValidations,
-  jzodAttributeNumberWithValidations,
-  jzodAttributeStringValidations,
-  jzodAttributeStringWithValidations,
-  jzodElement,
-  jzodEnumAttributeTypes,
-  jzodEnumElementTypes,
-  jzodEnum,
-  jzodFunction,
-  jzodIntersection,
-  jzodLazy,
-  jzodLiteral,
-  jzodMapSchema,
-  jzodObject,
-  jzodPromise,
-  jzodRecord,
-  jzodReference,
-  jzodSet,
-  jzodTuple,
-  jzodUnion,
-  // TYPES
-  JzodArray,
-  JzodAttribute,
-  JzodAttributeDateValidations,
-  JzodAttributeDateWithValidations,
-  JzodAttributeNumberValidations,
-  JzodAttributeNumberWithValidations,
-  JzodAttributeStringValidations,
-  JzodAttributeStringWithValidations,
-  JzodElement,
-  JzodEnum,
-  JzodEnumTypes,
-  JzodFunction,
-  JzodEnumElementTypes,
-  JzodIntersection,
-  JzodLazy,
-  JzodLiteral,
-  JzodMap,
-  JzodObject,
-  JzodPromise,
-  JzodRecord,
-  JzodReference,
-  JzodSet,
-  JzodUnion,
-  JzodTuple,
-} from "./JzodTsInterface";
+export {
+  jzodToTsCode,
+  jzodToTsTypeAliasesAndZodText,
+  TsTypeAliasesAndZodText as JzodTypeAliasesAndZodText,
+  TsTypeAliases,
+} from "./JzodToTs";
+export { printTsTypeAlias, printTsTypeAliases } from "./tools";
+
+export {
+  // SCHEMAS (const)
+  jzodArray,
+  jzodAttribute,
+  jzodAttributeDateValidations,
+  jzodAttributeDateWithValidations,
+  jzodAttributeNumberValidations,
+  jzodAttributeNumberWithValidations,
+  jzodAttributeStringValidations,
+  jzodAttributeStringWithValidations,
+  jzodElement,
+  jzodEnumAttributeTypes,
+  jzodEnumElementTypes,
+  jzodEnum,
+  jzodFunction,
+  jzodIntersection,
+  jzodLazy,
+  jzodLiteral,
+  jzodMap,
+  jzodObject,
+  jzodPromise,
+  jzodRecord,
+  jzodReference,
+  jzodSet,
+  jzodTuple,
+  jzodUnion,
+  // TYPES
+  JzodArray,
+  JzodAttribute,
+  JzodAttributeDateValidations,
+  JzodAttributeDateWithValidations,
+  JzodAttributeNumberValidations,
+  JzodAttributeNumberWithValidations,
+  JzodAttributeStringValidations,
+  JzodAttributeStringWithValidations,
+  JzodElement,
+  JzodEnum,
+  JzodEnumAttributeTypes,
+  JzodFunction,
+  JzodEnumElementTypes,
+  JzodIntersection,
+  JzodLazy,
+  JzodLiteral,
+  JzodMap,
+  JzodObject,
+  JzodPromise,
+  JzodRecord,
+  JzodReference,
+  JzodSet,
+  JzodUnion,
+  JzodTuple,
+} from "./generated_jzodBootstrapElementSchema";

package/src/preBuild.ts

@@ -0,0 +1,58 @@
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import { jzodBootstrapElementSchema } from '@miroir-framework/jzod';
+
+import { jzodToTsCode } from './JzodToTs';
+
+export function generateZodSchemaFileFromJzodSchema(
+  // jzodElement,
+  // targetFileName,
+  // jzodSchemaVariableName,
+  jzodElement: any, //JzodElement,
+  targetFileName: string,
+  jzodSchemaVariableName:string,
+) {
+  // console.log("generateZodSchemaFileFromJzodSchema called!");
+ 
+  const newFileContentsNotFormated = jzodToTsCode(jzodElement, true, jzodSchemaVariableName,true)
+  // const newFileContents = `import { JzodObject, jzodObject } from "@miroir-framework/jzod-ts";
+  const newFileContents = `${newFileContentsNotFormated}
+`;
+
+  if (targetFileName && existsSync(targetFileName)) {
+    const oldFileContents = readFileSync(targetFileName).toString()
+    if (newFileContents != oldFileContents)  {
+      // console.log("generateZodSchemaFileFromJzodSchema newFileContents",newFileContents);
+      writeFileSync(targetFileName,newFileContents);
+    } else {
+      console.log("generateZodSchemaFileFromJzodSchema entityDefinitionReport old contents equal new contents, no file generation needed.");
+    }
+  } else {
+    writeFileSync(targetFileName,newFileContents);
+  }
+}
+
+// ################################################################################################
+const jzodSchemaConversion
+: {
+  jzodElement: any,
+  targetFileName: string,
+  jzodSchemaVariableName:string,
+}[]
+= [
+  {
+    jzodElement: jzodBootstrapElementSchema,
+    targetFileName: "./src/generated_jzodBootstrapElementSchema.ts",
+    jzodSchemaVariableName: "jzodBootstrapElementSchema",
+  },
+];
+
+try {
+  for (const schema of jzodSchemaConversion) {
+    generateZodSchemaFileFromJzodSchema(schema.jzodElement,schema.targetFileName,schema.jzodSchemaVariableName)
+    console.info("GENERATED",schema.targetFileName);
+  }
+  
+} catch (error) {
+  console.error("could not generate TS files from Jzod schemas", error);
+  
+}

package/tests/jzod-ts.test.ts

@@ -1,108 +1,108 @@
-import * as fs from "fs";
-import * as path from "path";
-
-import { jzodBootstrapElementSchema } from "@miroir-framework/jzod";
-import { jzodToTsCode } from "../src/JzodToTs";
-import { JzodElement, jzodElement } from "../src/JzodTsInterface";
-
-const refsPath = "./tests/resources"
-const tmpPath = "./tests/tmp";
-
-
-const testJzodToTs = (
-  // testDirectory: string,
-  referenceFileName: string,
-  testFileName: string,
-  testJzodSchema:JzodElement,
-  exportPrefix: boolean,
-  typeName: string
-) => {
-  console.log("testJzodToTs:", typeName);
-  
-  const testResultSchemaFilePath = path.join(tmpPath,testFileName);
-  const expectedSchemaFilePath = path.join(refsPath,referenceFileName);
-
-  const result = jzodToTsCode(testJzodSchema,exportPrefix,typeName)
-  fs.writeFileSync(testResultSchemaFilePath,result);
-
-  const resultContents = result.replace(/(\r\n|\n|\r)/gm, "");
-  // console.log("ts Type generation resultContents", resultContents);
-
-  const expectedFileContents = fs.readFileSync(expectedSchemaFilePath).toString().replace(/(\r\n|\n|\r)/gm, "")
-  expect(resultContents).toEqual(expectedFileContents);
-}
-
-
-describe(
-  'Jzod-Ts',
-  () => {
-    // ############################################################################################
-    it(
-      "Jzod to TS Type",
-      async() => {
-
-
-        // ########################################################################################
-        const testJzodSchema1: JzodElement = { type: "simpleType", definition: "string" };
-
-        testJzodToTs(
-          "tsTypeGeneration-testJzodSchema1 - reference.ts",
-          "tsTypeGeneration-testJzodSchema1.ts",
-          testJzodSchema1,
-          true,
-          "testJzodSchema1"
-        );
-
-        // ########################################################################################
-        const testJzodSchema2: JzodElement = {
-          type: "schemaReference",
-          context: {
-            a: { type: "simpleType", definition: "string" },
-            b: {
-              type: "object",
-              definition: {
-                test: { type: "schemaReference", definition: { relativePath: "a" } }
-              },
-            },
-          },
-          definition: { relativePath: "b" },
-        };
-
-        testJzodToTs(
-          "tsTypeGeneration-testJzodSchema2 - reference.ts",
-          "tsTypeGeneration-testJzodSchema2.ts",
-          testJzodSchema2,
-          true,
-          "testJzodSchema2"
-        );
-
-        // ########################################################################################
-        const testJzodSchema4:JzodElement = 
-        {
-          type: "schemaReference", 
-          context: {
-            ...jzodBootstrapElementSchema.context,
-            a: {
-              type: "array",
-              definition: { type: "schemaReference", definition: {relativePath: "jzodArray"} }
-            }
-          },
-          definition: {
-            relativePath: "a"
-          },
-        }
-
-        testJzodToTs(
-          "tsTypeGeneration-testJzodSchema4 - reference.ts",
-          "tsTypeGeneration-testJzodSchema4.ts",
-          testJzodSchema4,
-          true,
-          "testJzodSchema4"
-        );
-      }
-    )
-  }
-)
-
-
-
+import * as fs from "fs";
+import * as path from "path";
+
+import { jzodBootstrapElementSchema } from "@miroir-framework/jzod";
+import { jzodToTsCode } from "../src/JzodToTs";
+import { JzodElement, jzodElement } from "../src/JzodTsInterface";
+
+const refsPath = "./tests/resources"
+const tmpPath = "./tests/tmp";
+
+
+const testJzodToTs = (
+  // testDirectory: string,
+  referenceFileName: string,
+  testFileName: string,
+  testJzodSchema:JzodElement,
+  exportPrefix: boolean,
+  typeName: string
+) => {
+  console.log("testJzodToTs:", typeName);
+  
+  const testResultSchemaFilePath = path.join(tmpPath,testFileName);
+  const expectedSchemaFilePath = path.join(refsPath,referenceFileName);
+
+  const result = jzodToTsCode(testJzodSchema,exportPrefix,typeName)
+  fs.writeFileSync(testResultSchemaFilePath,result);
+
+  const resultContents = result.replace(/(\r\n|\n|\r)/gm, "");
+  // console.log("ts Type generation resultContents", resultContents);
+
+  const expectedFileContents = fs.readFileSync(expectedSchemaFilePath).toString().replace(/(\r\n|\n|\r)/gm, "")
+  expect(resultContents).toEqual(expectedFileContents);
+}
+
+
+describe(
+  'Jzod-Ts',
+  () => {
+    // ############################################################################################
+    it(
+      "Jzod to TS Type",
+      async() => {
+
+
+        // ########################################################################################
+        const testJzodSchema1: JzodElement = { type: "simpleType", definition: "string" };
+
+        testJzodToTs(
+          "tsTypeGeneration-testJzodSchema1 - reference.ts",
+          "tsTypeGeneration-testJzodSchema1.ts",
+          testJzodSchema1,
+          true,
+          "testJzodSchema1"
+        );
+
+        // ########################################################################################
+        const testJzodSchema2: JzodElement = {
+          type: "schemaReference",
+          context: {
+            a: { type: "simpleType", definition: "string" },
+            b: {
+              type: "object",
+              definition: {
+                test: { type: "schemaReference", definition: { relativePath: "a" } }
+              },
+            },
+          },
+          definition: { relativePath: "b" },
+        };
+
+        testJzodToTs(
+          "tsTypeGeneration-testJzodSchema2 - reference.ts",
+          "tsTypeGeneration-testJzodSchema2.ts",
+          testJzodSchema2,
+          true,
+          "testJzodSchema2"
+        );
+
+        // ########################################################################################
+        const testJzodSchema4:JzodElement = 
+        {
+          type: "schemaReference", 
+          context: {
+            ...jzodBootstrapElementSchema.context,
+            a: {
+              type: "array",
+              definition: { type: "schemaReference", definition: {relativePath: "jzodArray"} }
+            }
+          },
+          definition: {
+            relativePath: "a"
+          },
+        }
+
+        testJzodToTs(
+          "tsTypeGeneration-testJzodSchema4 - reference.ts",
+          "tsTypeGeneration-testJzodSchema4.ts",
+          testJzodSchema4,
+          true,
+          "testJzodSchema4"
+        );
+      }
+    )
+  }
+)
+
+
+

package/tests/resources/tsTypeGeneration-testJzodSchema1 - reference.ts

@@ -1,5 +1,5 @@
-import { ZodType, ZodTypeAny, z } from "zod";
-
-export type TestJzodSchema1 = string;
-
-export const testJzodSchema1: z.ZodType<TestJzodSchema1> = z.string();
+import { ZodType, ZodTypeAny, z } from "zod";
+
+export type TestJzodSchema1 = string;
+
+export const testJzodSchema1 = z.string();

package/tests/resources/tsTypeGeneration-testJzodSchema2 - reference.ts

@@ -1,11 +1,11 @@
-import { ZodType, ZodTypeAny, z } from "zod";
-
-export type A = string;
-export type B = {
-    test?: A;
-};
-export type TestJzodSchema2 = B;
-
-export const a:z.ZodType<A> = z.string();
-export const b:z.ZodType<B> = z.object({test:z.lazy(() =>a),}).strict();
-export const testJzodSchema2: z.ZodType<TestJzodSchema2> = z.lazy(() =>b);
+import { ZodType, ZodTypeAny, z } from "zod";
+
+export type A = string;
+export type B = {
+    test: A;
+};
+export type TestJzodSchema2 = B;
+
+export const a = z.string();
+export const b = z.object({test:z.lazy(() =>a)}).strict();
+export const testJzodSchema2 = z.lazy(() =>b);

package/tests/resources/tsTypeGeneration-testJzodSchema3 - reference.ts

@@ -1,19 +1,19 @@
-import { ZodType, ZodTypeAny, z } from "zod";
-
-
-type jzodLiteral = {
-    optional?: boolean | undefined;
-    extra?: {
-        [x: string]: any;
-    } | undefined;
-    type: "literal";
-    definition: string;
-};
-type jzodElement = jzodLiteral;
-type testJzodSchema3 = {
-    b: jzodElement[];
-};
-
-export const jzodLiteral=z.object({optional:z.boolean().optional(),extra:z.record(z.string(),z.any()).optional(),type:z.literal("literal"),definition:z.string(),}).strict();
-export const jzodElement=z.union([z.lazy(() =>jzodLiteral),]);
-export const testJzodSchema3 = z.object({b:z.array(z.lazy(() =>jzodElement)),}).strict();
+import { ZodType, ZodTypeAny, z } from "zod";
+
+
+type jzodLiteral = {
+    optional?: boolean | undefined;
+    extra?: {
+        [x: string]: any;
+    } | undefined;
+    type: "literal";
+    definition: string;
+};
+type jzodElement = jzodLiteral;
+type testJzodSchema3 = {
+    b: jzodElement[];
+};
+
+export const jzodLiteral=z.object({optional:z.boolean().optional(),extra:z.record(z.string(),z.any()).optional(),type:z.literal("literal"),definition:z.string(),}).strict();
+export const jzodElement=z.union([z.lazy(() =>jzodLiteral),]);
+export const testJzodSchema3 = z.object({b:z.array(z.lazy(() =>jzodElement)),}).strict();