@postxl/schema 1.4.0 → 1.5.0

package/dist/enum/enum.d.ts

@@ -1,4 +1,4 @@
-export declare const zEnum: import("zod").ZodPipe<import("zod").ZodObject<{
+export declare const zEnum: import("zod").ZodPipe<import("zod").ZodPipe<import("zod").ZodTransform<unknown, unknown>, import("zod").ZodObject<{
     name: import("zod").ZodString;
     description: import("zod").ZodDefault<import("zod").ZodOptional<import("zod").ZodString>>;
     schema: import("zod").ZodOptional<import("zod").ZodString>;
@@ -7,7 +7,7 @@ export declare const zEnum: import("zod").ZodPipe<import("zod").ZodObject<{
         value: import("zod").ZodString;
         description: import("zod").ZodOptional<import("zod").ZodString>;
     }, import("zod/v4/core").$strip>, import("zod").ZodString]>>;
-}, import("zod/v4/core").$strip>, import("zod").ZodTransform<{
+}, import("zod/v4/core").$strip>>, import("zod").ZodTransform<{
     name: string & import("zod").$brand<"PXL.EnumName">;
     description: string;
     members: Map<string & import("zod").$brand<"PXL.EnumValue">, import("./enum.types").EnumMember>;

package/dist/enum/enum.json-decoder.d.ts

@@ -12,7 +12,7 @@ export declare const zEnumMemberJSON: z.ZodUnion<readonly [z.ZodObject<{
 }, z.core.$strip>, z.ZodString]>;
 export type EnumMemberJSON = z.infer<typeof zEnumMemberJSON>;
 export declare const zEnumNameJSON: z.ZodString;
-export declare const zEnumJSON: z.ZodObject<{
+export declare const zEnumJSON: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
     name: z.ZodString;
     description: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     schema: z.ZodOptional<z.ZodString>;
@@ -21,5 +21,5 @@ export declare const zEnumJSON: z.ZodObject<{
         value: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>, z.ZodString]>>;
-}, z.core.$strip>;
+}, z.core.$strip>>;
 export type EnumJSON = z.infer<typeof zEnumJSON>;

package/dist/enum/enum.json-decoder.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.zEnumJSON = exports.zEnumNameJSON = exports.zEnumMemberJSON = exports.zEnumMemberCompact = exports.zEnumMemberJSONDetailed = exports.zEnumMemberDescriptionJSON = exports.zEnumMemberNameJSON = void 0;
 const zod_1 = require("zod");
 const utils_1 = require("@postxl/utils");
+const normalize_named_collection_1 = require("../normalize-named-collection");
 exports.zEnumMemberNameJSON = zod_1.z
     //
     .string()
@@ -30,7 +31,16 @@ exports.zEnumNameJSON = zod_1.z
     },
 })
     .describe('Name of the enum.');
-exports.zEnumJSON = zod_1.z.object({
+exports.zEnumJSON = zod_1.z.preprocess((input) => {
+    if (typeof input === 'object' && input !== null) {
+        const original = input;
+        return {
+            ...original,
+            members: (0, normalize_named_collection_1.normalizeEnumMembers)(original.members),
+        };
+    }
+    return input;
+}, zod_1.z.object({
     name: exports.zEnumNameJSON,
     description: zod_1.z
         //
@@ -51,4 +61,4 @@ exports.zEnumJSON = zod_1.z.object({
         //
         .array(exports.zEnumMemberJSON)
         .min(1, { error: 'Enum must have at least one member.' }),
-});
+}));

package/dist/field/discriminated-union.d.ts

@@ -52,7 +52,7 @@ export declare const zField: z.ZodRecord<z.ZodString, z.ZodAny>;
 /**
  * JSON Schema for an Discriminated Union field
  */
-export declare const zFieldDiscriminatedUnionJSON: z.ZodObject<{
+export declare const zFieldDiscriminatedUnionJSON: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
     name: z.ZodString;
     type: z.ZodUnion<[z.ZodLiteral<"DiscriminatedUnion">, z.ZodLiteral<"DiscriminatedUnion?">]>;
     label: z.ZodOptional<z.ZodString>;
@@ -66,7 +66,7 @@ export declare const zFieldDiscriminatedUnionJSON: z.ZodObject<{
     }, z.core.$strip>>;
     commonFields: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>>>;
     isReadonly: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>;
+}, z.core.$strip>>;
 export type FieldDiscriminatedUnionJSON = z.infer<typeof zFieldDiscriminatedUnionJSON>;
 export declare function fieldDiscriminatedUnionJSONTransformer(fieldInput: FieldDiscriminatedUnionJSON): {
     kind: "discriminatedUnion";

package/dist/field/discriminated-union.js

@@ -41,6 +41,7 @@ const zod_1 = require("zod");
 const utils_1 = require("@postxl/utils");
 const enum_1 = require("../enum");
 const model_1 = require("../model");
+const normalize_named_collection_1 = require("../normalize-named-collection");
 const Branded = __importStar(require("./shared/brands"));
 const Decoders = __importStar(require("./shared/decoders"));
 const utils_2 = require("./shared/utils");
@@ -60,7 +61,26 @@ exports.zField = zod_1.z.record(zod_1.z.string(), zod_1.z.any());
 /**
  * JSON Schema for an Discriminated Union field
  */
-exports.zFieldDiscriminatedUnionJSON = zod_1.z.object({
+exports.zFieldDiscriminatedUnionJSON = zod_1.z.preprocess((input) => {
+    if (typeof input === 'object' && input !== null) {
+        const original = input;
+        return {
+            ...original,
+            ...(original.commonFields !== undefined
+                ? { commonFields: (0, normalize_named_collection_1.normalizeNamedCollection)(original.commonFields) }
+                : {}),
+            members: Array.isArray(original.members)
+                ? original.members.map((member) => {
+                    if (typeof member === 'object' && member !== null && 'fields' in member) {
+                        return { ...member, fields: (0, normalize_named_collection_1.normalizeNamedCollection)(member.fields) };
+                    }
+                    return member;
+                })
+                : original.members,
+        };
+    }
+    return input;
+}, zod_1.z.object({
     name: Decoders.zFieldPropertyName,
     type: zod_1.z //
         .literal('DiscriminatedUnion')
@@ -82,7 +102,7 @@ exports.zFieldDiscriminatedUnionJSON = zod_1.z.object({
     })),
     commonFields: zod_1.z.array(exports.zField).optional(),
     isReadonly: Decoders.zFieldPropertyIsReadonly,
-});
+}));
 function fieldDiscriminatedUnionJSONTransformer(fieldInput) {
     const { isRequired } = (0, utils_2.isFieldRequired)(fieldInput.type);
     return {
@@ -128,7 +148,7 @@ const fieldDiscriminatedUnionTransformer = ({ fieldInput, model, projectSchema }
         }
         const decodedField = decodedFieldResult.data;
         const transformedField = Fields.fieldTransformer(decodedField, model, projectSchema, ctx);
-        commonFields.set(transformedField.name, addDiscriminatedUnionParent(transformedField, fieldInput.name));
+        commonFields.set(transformedField.name, addDiscriminatedUnionParent(transformedField, fieldInput.name, fieldInput.excelName));
     }
     const members = new Map();
     for (const memberInput of fieldInput.members) {
@@ -153,7 +173,7 @@ const fieldDiscriminatedUnionTransformer = ({ fieldInput, model, projectSchema }
                 return zod_1.z.NEVER;
             }
             const transformedField = Fields.fieldTransformer(decodedField, model, projectSchema, ctx);
-            memberFields.set(transformedField.name, addDiscriminatedUnionParentMember(transformedField, fieldInput.name, discriminator));
+            memberFields.set(transformedField.name, addDiscriminatedUnionParentMember(transformedField, fieldInput.name, fieldInput.excelName, discriminator));
         }
         members.set(discriminator, {
             type: discriminator,
@@ -174,7 +194,7 @@ const fieldDiscriminatedUnionTransformer = ({ fieldInput, model, projectSchema }
     return result;
 };
 exports.fieldDiscriminatedUnionTransformer = fieldDiscriminatedUnionTransformer;
-function addDiscriminatedUnionParent(field, duFieldName) {
+function addDiscriminatedUnionParent(field, duFieldName, duExcelName) {
     const result = {
         ...field,
         discriminatedUnionFieldName: duFieldName,
@@ -183,10 +203,16 @@ function addDiscriminatedUnionParent(field, duFieldName) {
             databaseName: field.databaseName,
             newName: `${duFieldName}${(0, utils_1.toPascalCase)(field.name)}`,
         }),
+        excelName: ensureCustomExcelName({
+            name: field.name,
+            label: field.label,
+            excelName: field.excelName,
+            newName: `${duExcelName} ${field.excelName}`,
+        }),
     };
     return result;
 }
-function addDiscriminatedUnionParentMember(field, duFieldName, duMemberType) {
+function addDiscriminatedUnionParentMember(field, duFieldName, duExcelName, duMemberType) {
     const result = {
         ...field,
         discriminatedUnionFieldName: duFieldName,
@@ -196,9 +222,22 @@ function addDiscriminatedUnionParentMember(field, duFieldName, duMemberType) {
             databaseName: field.databaseName,
             newName: `${duFieldName}${(0, utils_1.toPascalCase)(duMemberType)}${(0, utils_1.toPascalCase)(field.name)}`,
         }),
+        excelName: ensureCustomExcelName({
+            name: field.name,
+            label: field.label,
+            excelName: field.excelName,
+            newName: `${duExcelName} ${(0, utils_1.toPascalCase)(duMemberType)} ${field.excelName}`,
+        }),
     };
     return result;
 }
+function ensureCustomExcelName({ excelName, name, label, newName, }) {
+    // If the user explicitly set a custom excelName (different from the defaults), keep it
+    if (excelName !== name && excelName !== label && excelName !== (0, utils_1.toHumanReadable)(name)) {
+        return excelName;
+    }
+    return Branded.toExcelColumnName(newName);
+}
 function ensureCustomDatabaseName({ databaseName, name, newName, }) {
     if (databaseName !== name && databaseName !== (0, utils_1.toSnakeCase)(name)) {
         return databaseName;

package/dist/field/field.d.ts

@@ -81,7 +81,7 @@ export declare const createFieldJSONDecoder: (params: {
     faker?: string | undefined;
     seed?: string | number | boolean | Date | (string | number | boolean | Date)[] | undefined;
     placeholder?: string | undefined;
-}>>, z.ZodPipe<z.ZodObject<{
+}>>, z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
     name: z.ZodString;
     type: z.ZodUnion<[z.ZodLiteral<"DiscriminatedUnion">, z.ZodLiteral<"DiscriminatedUnion?">]>;
     label: z.ZodOptional<z.ZodString>;
@@ -95,7 +95,7 @@ export declare const createFieldJSONDecoder: (params: {
     }, z.core.$strip>>;
     commonFields: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodAny>>>;
     isReadonly: z.ZodOptional<z.ZodBoolean>;
-}, z.core.$strip>, z.ZodTransform<{
+}, z.core.$strip>>, z.ZodTransform<{
     kind: "discriminatedUnion";
     name: string & z.core.$brand<"PXL.FieldName">;
     discriminatorFieldName: string & z.core.$brand<"PXL.FieldName">;

package/dist/model/model.json-decoder.js

@@ -4,6 +4,7 @@ exports.zModelJSON = exports.zModelNameJSON = void 0;
 const zod_1 = require("zod");
 const utils_1 = require("@postxl/utils");
 const brands_1 = require("../field/shared/brands");
+const normalize_named_collection_1 = require("../normalize-named-collection");
 exports.zModelNameJSON = zod_1.z
     //
     .string()
@@ -18,7 +19,11 @@ exports.zModelNameJSON = zod_1.z
 exports.zModelJSON = zod_1.z.preprocess((input) => {
     if (typeof input === 'object' && input !== null) {
         const original = input;
-        const result = { ...original, source: { ...original } };
+        const result = {
+            ...original,
+            source: { ...original },
+            fields: (0, normalize_named_collection_1.normalizeNamedCollection)(original.fields),
+        };
         return result;
     }
     return input;

package/dist/normalize-named-collection.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Normalizes a collection that can be either an array of named objects or an object keyed by name.
+ *
+ * Array format (existing):
+ *   [{ name: "User", ... }, { name: "Post", ... }]
+ *
+ * Object format (new):
+ *   { "User": { ... }, "Post": { ... } }
+ *
+ * When given an object, converts it to an array by injecting the key as the specified name property.
+ * Arrays and undefined/null values are passed through unchanged.
+ *
+ * @param input - The collection input (array or object)
+ * @param nameKey - The property name to inject the key as (default: 'name')
+ * @returns The normalized array, or the input unchanged if already an array or undefined/null
+ */
+export declare function normalizeNamedCollection(input: unknown, nameKey?: string): unknown;
+/**
+ * Normalizes enum members that can be either an array or an object keyed by member value.
+ *
+ * Array format (existing):
+ *   ["Draft", { value: "Published", description: "..." }]
+ *
+ * Object format (new):
+ *   { "Draft": { description: "..." }, "Published": { description: "..." } }
+ *   { "Draft": "description text", "Published": "description text" }
+ *
+ * When given an object, converts it to an array of enum member entries.
+ * String values are treated as descriptions.
+ * Object values get the key injected as the `value` property.
+ *
+ * @param input - The members input (array or object)
+ * @returns The normalized array, or the input unchanged if already an array or undefined/null
+ */
+export declare function normalizeEnumMembers(input: unknown): unknown;

package/dist/normalize-named-collection.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeNamedCollection = normalizeNamedCollection;
+exports.normalizeEnumMembers = normalizeEnumMembers;
+/**
+ * Normalizes a collection that can be either an array of named objects or an object keyed by name.
+ *
+ * Array format (existing):
+ *   [{ name: "User", ... }, { name: "Post", ... }]
+ *
+ * Object format (new):
+ *   { "User": { ... }, "Post": { ... } }
+ *
+ * When given an object, converts it to an array by injecting the key as the specified name property.
+ * Arrays and undefined/null values are passed through unchanged.
+ *
+ * @param input - The collection input (array or object)
+ * @param nameKey - The property name to inject the key as (default: 'name')
+ * @returns The normalized array, or the input unchanged if already an array or undefined/null
+ */
+function normalizeNamedCollection(input, nameKey = 'name') {
+    if (input === undefined || input === null || Array.isArray(input)) {
+        return input;
+    }
+    if (typeof input === 'object') {
+        return Object.entries(input).map(([key, value]) => {
+            if (typeof value === 'object' && value !== null) {
+                return { ...value, [nameKey]: key };
+            }
+            return value;
+        });
+    }
+    return input;
+}
+/**
+ * Normalizes enum members that can be either an array or an object keyed by member value.
+ *
+ * Array format (existing):
+ *   ["Draft", { value: "Published", description: "..." }]
+ *
+ * Object format (new):
+ *   { "Draft": { description: "..." }, "Published": { description: "..." } }
+ *   { "Draft": "description text", "Published": "description text" }
+ *
+ * When given an object, converts it to an array of enum member entries.
+ * String values are treated as descriptions.
+ * Object values get the key injected as the `value` property.
+ *
+ * @param input - The members input (array or object)
+ * @returns The normalized array, or the input unchanged if already an array or undefined/null
+ */
+function normalizeEnumMembers(input) {
+    if (input === undefined || input === null || Array.isArray(input)) {
+        return input;
+    }
+    if (typeof input === 'object') {
+        return Object.entries(input).map(([key, value]) => {
+            if (typeof value === 'string') {
+                // { "Draft": "description text" } → { value: "Draft", description: "description text" }
+                return { value: key, description: value };
+            }
+            if (typeof value === 'object' && value !== null) {
+                // { "Draft": { description: "..." } } → { value: "Draft", description: "..." }
+                return { ...value, value: key };
+            }
+            // { "Draft": null } or other → just the value name
+            return key;
+        });
+    }
+    return input;
+}

package/dist/project-schema/project-schema.json-decoder.d.ts

@@ -33,7 +33,7 @@ export declare const zProjectSchemaJSON: z.ZodPipe<z.ZodTransform<unknown, unkno
         }, z.core.$strip>>;
     }, z.core.$strip>>>>;
     standardEnums: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    enums: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    enums: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
         name: z.ZodString;
         description: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         schema: z.ZodOptional<z.ZodString>;
@@ -42,7 +42,7 @@ export declare const zProjectSchemaJSON: z.ZodPipe<z.ZodTransform<unknown, unkno
             value: z.ZodString;
             description: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>, z.ZodString]>>;
-    }, z.core.$strip>>>;
+    }, z.core.$strip>>>>;
     source: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 }, z.core.$strip>>;
 /**

package/dist/project-schema/project-schema.json-decoder.js

@@ -38,6 +38,7 @@ const zod_1 = require("zod");
 const utils_1 = require("@postxl/utils");
 const Enum = __importStar(require("../enum"));
 const Model = __importStar(require("../model"));
+const normalize_named_collection_1 = require("../normalize-named-collection");
 exports.zSchemaName = zod_1.z
     //
     .string()
@@ -55,6 +56,8 @@ exports.zProjectSchemaJSON = zod_1.z
         const original = input;
         return {
             ...original,
+            models: (0, normalize_named_collection_1.normalizeNamedCollection)(original.models),
+            enums: (0, normalize_named_collection_1.normalizeNamedCollection)(original.enums),
             // We omit models from the source fields as we keep the original input in model.source
             // as part of the model schema.
             source: (0, utils_1.omit)(original, 'models'),

package/dist/project-schema/project-schema.transformer.d.ts

@@ -38,7 +38,7 @@ export declare const zProjectSchema: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown,
         }, z.core.$strip>>;
     }, z.core.$strip>>>>;
     standardEnums: z.ZodOptional<z.ZodArray<z.ZodString>>;
-    enums: z.ZodOptional<z.ZodArray<z.ZodObject<{
+    enums: z.ZodOptional<z.ZodArray<z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodObject<{
         name: z.ZodString;
         description: z.ZodDefault<z.ZodOptional<z.ZodString>>;
         schema: z.ZodOptional<z.ZodString>;
@@ -47,7 +47,7 @@ export declare const zProjectSchema: z.ZodPipe<z.ZodPipe<z.ZodTransform<unknown,
             value: z.ZodString;
             description: z.ZodOptional<z.ZodString>;
         }, z.core.$strip>, z.ZodString]>>;
-    }, z.core.$strip>>>;
+    }, z.core.$strip>>>>;
     source: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 }, z.core.$strip>>, z.ZodTransform<ProjectSchema, {
     name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postxl/schema",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Decoders for PXL Schema definitions and validation for PXL code generation framework",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -36,7 +36,7 @@
     "directory": "packages/schema"
   },
   "dependencies": {
-    "@postxl/utils": "^1.3.1"
+    "@postxl/utils": "^1.3.3"
   },
   "devDependencies": {},
   "wallaby": {