zod-to-x 2.4.0 → 2.6.0

package/README.md

@@ -601,6 +601,21 @@ readonly DiscriminantDataRetrieve = z.lazy(() =>  // Lazy the zod type itself
 //   | HttpSuccessfulResponse<SomeDtoResult>
 //   | HttpUnsuccessfulResponse;
 ```
+4) A default type can be provided as the second argument of `createGenericType`. It can be any supported type: a basic type, an array, a named type, ... Templates with a default type can be omitted in `useGenericType`, and the default type is used instead. The default is applied when the generic type is instantiated, so the output is valid for all supported languages, including the ones without default type parameters (Go, Dart):
+```ts
+// inside GenericsInfrastructure class
+readonly Page = z.object({
+  cursor: createGenericType("TCursor", z.string()),
+  content: createGenericType("TContent", this.SomeDtoResult),
+});
+
+readonly DefaultPage = useGenericType(this.Page, {});
+readonly PageOfIds = useGenericType(this.Page, { content: z.array(z.string()) });
+
+// Output
+// export interface DefaultPage extends Page<string, SomeDtoResult> {}
+// export interface PageOfIds extends Page<string, string[]> {}
+```
 
 Complete definition examples can be found [here](https://github.com/rroumenov/zod-to-x/blob/main/test/common/layered_generics.ts).
 

package/dist/core/ast-types/ast_common.d.ts

@@ -29,22 +29,39 @@ export type ASTNode = Simple.ASTString | Simple.ASTNumber | Simple.ASTBoolean |
  * Nodes that are always transpiled to a type alias.
  */
 export type ASTAliasedTypes = Simple.ASTString | Simple.ASTNumber | Simple.ASTBoolean | Simple.ASTLiteral | Simple.ASTDate | Simple.ASTAny | Complex.ASTMap | Complex.ASTSet | Complex.ASTTuple | Complex.ASTArray;
+/**
+ * Translation of a generic template of a generic type instance. Named types are referenced by
+ * name (and file, if external), and the rest of types (basic types, arrays, ...) by their AST.
+ */
+export type ASTTemplateTranslation = Pick<ASTCommon, "parentFile" | "parentNamespace" | "aliasOf"> & {
+    type?: ASTType;
+};
 /**
  * Represents a usage of any existing ASTNode. Used to reduce node size.
  */
 export declare class ASTDefinition extends ASTCommon {
+    static readonly kind = "ASTDefinition";
     name: string;
+    /**
+     * Kind of the referenced AST node (e.g. "ASTObject"). See `getASTKind`.
+     */
     instanceType: string;
     constraints?: Record<string, any>;
-    templatesTranslation: Pick<ASTCommon, "parentFile" | "parentNamespace" | "aliasOf">[];
+    templatesTranslation: ASTTemplateTranslation[];
     constructor(data: ASTDefinition & ASTCommon);
 }
 export type ASTType = ASTNode | ASTDefinition;
+/**
+ * Returns the kind of an AST node, which is the name of its class (e.g. "ASTObject"). Unlike
+ * `constructor.name`, it is not modified by minifiers.
+ */
+export declare function getASTKind(node: unknown): string | undefined;
 export type ASTNodes = {
     nodes: Map<string, ASTNode>;
     warnings: string[];
 };
 export declare class ASTGenericType {
+    static readonly kind = "ASTGenericType";
     name: string;
     constructor(name: string);
 }

package/dist/core/ast-types/ast_common.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ASTGenericType = exports.ASTDefinition = exports.ASTCommon = void 0;
+exports.getASTKind = getASTKind;
 /**
  * Shared properties for all AST node types.
  */
@@ -29,9 +30,19 @@ class ASTDefinition extends ASTCommon {
     }
 }
 exports.ASTDefinition = ASTDefinition;
+ASTDefinition.kind = "ASTDefinition";
+/**
+ * Returns the kind of an AST node, which is the name of its class (e.g. "ASTObject"). Unlike
+ * `constructor.name`, it is not modified by minifiers.
+ */
+function getASTKind(node) {
+    var _a;
+    return (_a = node === null || node === void 0 ? void 0 : node.constructor) === null || _a === void 0 ? void 0 : _a.kind;
+}
 class ASTGenericType {
     constructor(name) {
         this.name = name;
     }
 }
 exports.ASTGenericType = ASTGenericType;
+ASTGenericType.kind = "ASTGenericType";

package/dist/core/ast-types/ast_complex.d.ts

@@ -1,8 +1,9 @@
-import { ASTCommon, ASTType } from "./ast_common";
+import { ASTCommon, ASTTemplateTranslation, ASTType } from "./ast_common";
 /**
  * Handle ZodEnum
  */
 export declare class ASTEnum extends ASTCommon {
+    static readonly kind = "ASTEnum";
     name: string;
     values: [string, string | number][];
     /**
@@ -15,16 +16,19 @@ export declare class ASTEnum extends ASTCommon {
  * Handle ZodObject
  */
 export declare class ASTObject extends ASTCommon {
+    static readonly kind = "ASTObject";
     name: string;
     properties: Record<string, ASTType>;
     templates: Set<string>;
-    templatesTranslation: Pick<ASTCommon, "parentFile" | "parentNamespace" | "aliasOf">[];
+    templatesTranslation: ASTTemplateTranslation[];
+    genericOf?: string;
     constructor(data: ASTObject & ASTCommon);
 }
 /**
  * Handle ZodUnion and ZodDiscriminatedUnion
  */
 export declare class ASTUnion extends ASTCommon {
+    static readonly kind = "ASTUnion";
     name: string;
     options: ASTType[];
     areAllObjects: boolean;
@@ -40,6 +44,7 @@ export declare class ASTUnion extends ASTCommon {
  * Handle ZodIntersection
  */
 export declare class ASTIntersection extends ASTCommon {
+    static readonly kind = "ASTIntersection";
     name: string;
     left: ASTType;
     right: ASTType;
@@ -55,6 +60,7 @@ export declare class ASTIntersection extends ASTCommon {
  * Handle ZodRecord and ZodMap
  */
 export declare class ASTMap extends ASTCommon {
+    static readonly kind = "ASTMap";
     name?: string;
     key: ASTType;
     value: ASTType;
@@ -65,6 +71,7 @@ export declare class ASTMap extends ASTCommon {
  * Handle ZodSet
  */
 export declare class ASTSet extends ASTCommon {
+    static readonly kind = "ASTSet";
     name?: string;
     value: ASTType;
     constructor(data: ASTSet & ASTCommon);
@@ -73,6 +80,7 @@ export declare class ASTSet extends ASTCommon {
  * Handle ZodTuple
  */
 export declare class ASTTuple extends ASTCommon {
+    static readonly kind = "ASTTuple";
     name?: string;
     items: ASTType[];
     constructor(data: ASTTuple & ASTCommon);
@@ -81,6 +89,7 @@ export declare class ASTTuple extends ASTCommon {
  * Handle ZodArray. Only used for type aliases.
  */
 export declare class ASTArray extends ASTCommon {
+    static readonly kind = "ASTArray";
     name: string;
     item: ASTType;
     constructor(data: ASTArray & ASTCommon);

package/dist/core/ast-types/ast_complex.js

@@ -14,6 +14,7 @@ class ASTEnum extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTEnum = ASTEnum;
+ASTEnum.kind = "ASTEnum";
 /**
  * Handle ZodObject
  */
@@ -24,9 +25,11 @@ class ASTObject extends ast_common_1.ASTCommon {
         this.properties = data.properties;
         this.templates = data.templates;
         this.templatesTranslation = data.templatesTranslation;
+        this.genericOf = data.genericOf;
     }
 }
 exports.ASTObject = ASTObject;
+ASTObject.kind = "ASTObject";
 /**
  * Handle ZodUnion and ZodDiscriminatedUnion
  */
@@ -41,6 +44,7 @@ class ASTUnion extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTUnion = ASTUnion;
+ASTUnion.kind = "ASTUnion";
 /**
  * Handle ZodIntersection
  */
@@ -55,6 +59,7 @@ class ASTIntersection extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTIntersection = ASTIntersection;
+ASTIntersection.kind = "ASTIntersection";
 /**
  * Handle ZodRecord and ZodMap
  */
@@ -68,6 +73,7 @@ class ASTMap extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTMap = ASTMap;
+ASTMap.kind = "ASTMap";
 /**
  * Handle ZodSet
  */
@@ -79,6 +85,7 @@ class ASTSet extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTSet = ASTSet;
+ASTSet.kind = "ASTSet";
 /**
  * Handle ZodTuple
  */
@@ -90,6 +97,7 @@ class ASTTuple extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTTuple = ASTTuple;
+ASTTuple.kind = "ASTTuple";
 /**
  * Handle ZodArray. Only used for type aliases.
  */
@@ -101,3 +109,4 @@ class ASTArray extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTArray = ASTArray;
+ASTArray.kind = "ASTArray";

package/dist/core/ast-types/ast_simple.d.ts

@@ -3,6 +3,7 @@ import { ASTCommon, ASTDefinition } from "./ast_common";
  * Handle ZodString
  */
 export declare class ASTString extends ASTCommon {
+    static readonly kind = "ASTString";
     name?: string;
     constraints?: {
         min?: number;
@@ -15,6 +16,7 @@ export declare class ASTString extends ASTCommon {
  * Handle ZodNumber and ZodBigInt
  */
 export declare class ASTNumber extends ASTCommon {
+    static readonly kind = "ASTNumber";
     name?: string;
     constraints?: {
         min?: number;
@@ -27,6 +29,7 @@ export declare class ASTNumber extends ASTCommon {
  * Handle ZodLiteral
  */
 export declare class ASTLiteral extends ASTCommon {
+    static readonly kind = "ASTLiteral";
     name?: string;
     value: string | number | boolean;
     parentEnum?: ASTDefinition;
@@ -37,6 +40,7 @@ export declare class ASTLiteral extends ASTCommon {
  * Handle ZodBoolean
  */
 export declare class ASTBoolean extends ASTCommon {
+    static readonly kind = "ASTBoolean";
     name?: string;
     constructor(data: ASTBoolean & ASTCommon);
 }
@@ -44,6 +48,7 @@ export declare class ASTBoolean extends ASTCommon {
  * Handle ZodDate
  */
 export declare class ASTDate extends ASTCommon {
+    static readonly kind = "ASTDate";
     name?: string;
     constructor(data: ASTDate & ASTCommon);
 }
@@ -51,6 +56,7 @@ export declare class ASTDate extends ASTCommon {
  * Handle ZodAny
  */
 export declare class ASTAny extends ASTCommon {
+    static readonly kind = "ASTAny";
     name?: string;
     constructor(data: ASTAny & ASTCommon);
 }

package/dist/core/ast-types/ast_simple.js

@@ -13,6 +13,7 @@ class ASTString extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTString = ASTString;
+ASTString.kind = "ASTString";
 /**
  * Handle ZodNumber and ZodBigInt
  */
@@ -24,6 +25,7 @@ class ASTNumber extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTNumber = ASTNumber;
+ASTNumber.kind = "ASTNumber";
 /**
  * Handle ZodLiteral
  */
@@ -37,6 +39,7 @@ class ASTLiteral extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTLiteral = ASTLiteral;
+ASTLiteral.kind = "ASTLiteral";
 /**
  * Handle ZodBoolean
  */
@@ -47,6 +50,7 @@ class ASTBoolean extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTBoolean = ASTBoolean;
+ASTBoolean.kind = "ASTBoolean";
 /**
  * Handle ZodDate
  */
@@ -57,6 +61,7 @@ class ASTDate extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTDate = ASTDate;
+ASTDate.kind = "ASTDate";
 /**
  * Handle ZodAny
  */
@@ -67,3 +72,4 @@ class ASTAny extends ast_common_1.ASTCommon {
     }
 }
 exports.ASTAny = ASTAny;
+ASTAny.kind = "ASTAny";

package/dist/core/ast_node.d.ts

@@ -30,6 +30,11 @@ export declare class Zod2Ast {
      * Transpilerable nodes of current data model
      */
     private nodes;
+    /**
+     * Source schema of each transpilerable node. Used to detect different schemas sharing the
+     * same type name.
+     */
+    private nodeSchemas;
     /**
      * Lazy schemas for further analysis
      */
@@ -47,6 +52,26 @@ export declare class Zod2Ast {
      * @returns `true` if the node is an "own property"; otherwise, `false`.
      */
     private _isOwnProperty;
+    /**
+     * Returns the key used to store a transpilerable node. Types imported from other files are
+     * namespaced by their file, so they do not clash with local types that share the same name.
+     * Aliases of external types are local definitions.
+     */
+    private _getNodeKey;
+    /**
+     * Determines if two schemas that share the same type name represent the same definition.
+     * Schemas created from the same definition (`.zod2x()`, `.describe()`, `.meta()`, layer
+     * aliases) and instances of the same generic type are considered equal. Otherwise, a shallow
+     * structural comparison is performed.
+     */
+    private _isSameDefinition;
+    /**
+     * Checks if a transpilerable node is already registered.
+     *
+     * @throws AstTypeNameDefinitionError - If the node key is used by a different schema.
+     */
+    private _hasNode;
+    private _setNode;
     /**
      * Check if the layer of the item is compatible with the layer of the schema. If does and the
      * transpilerable item is in a different file, it returns the file name.