@postxl/generator 0.72.0 → 0.73.0

package/dist/generators/models/export/encoder.generator.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateModelExportEncoder = void 0;
 const imports_1 = require("../../../lib/imports");
+const meta_1 = require("../../../lib/meta");
 const types_1 = require("../../../lib/schema/types");
 /**
  * Creates an encoder for the Seed Excel template.
@@ -13,15 +14,13 @@ function generateModelExportEncoder({ model, meta }) {
         [meta.import.decoder.location.import]: [meta.import.decoder.rowDecoderName],
     });
     const { userFriendlyName: userFriendly, userFriendlyNamePlural: userFriendlyPlural } = meta;
+    const fieldEncoders = generateFieldEncoders({ model });
     /* prettier-ignore */
     return `
     import * as z from 'zod'
 
-    import { capitalizeKeys } from '@postxl/runtime'
-
     ${imports.generate()}
 
-
     /**
      * The type for rows in the ${userFriendly} table
      */
@@ -31,7 +30,9 @@ function generateModelExportEncoder({ model, meta }) {
     /**
      * Converts a ${userFriendly} to an Excel row
      */
-    export const ${itemEncoderFunctionName} = (item: ${model.typeName}): ${encodedExcelType} => capitalizeKeys(item)
+    export const ${itemEncoderFunctionName} = (item: ${model.typeName}): ${encodedExcelType} => ({
+      ${fieldEncoders.join(',\n')}
+    })
 
     /**
      * Converts a list of ${userFriendlyPlural} to an Excel table
@@ -40,3 +41,11 @@ function generateModelExportEncoder({ model, meta }) {
   `;
 }
 exports.generateModelExportEncoder = generateModelExportEncoder;
+function generateFieldEncoders({ model }) {
+    const fieldEncoders = [];
+    for (const field of model.fields) {
+        const fieldMeta = (0, meta_1.getFieldMetadata)({ field });
+        fieldEncoders.push(`"${fieldMeta.excelColumnName}": item.${field.name}`);
+    }
+    return fieldEncoders;
+}

package/dist/generators/models/import/decoder.generator.js

@@ -17,11 +17,10 @@ function generateModelImportDecoder({ model, meta }) {
     });
     const { userFriendlyName: userFriendly, internalSingularNameCapitalized: singularCapitalized } = meta;
     const { fieldDecoders, blankFieldDecoders } = generateFieldDecoders({ model, meta, imports });
+    const fieldTransformers = generateFieldTransformers({ model });
     return `
 import * as z from 'zod'
 
-import { uncapitalizeKeys } from '@postxl/runtime'
-
 ${imports.generate()}
 
 /**
@@ -52,7 +51,10 @@ const blank${singularCapitalized}RowDecoder = z
 export const ${tableImportDecoder} = z
   .array(
     blank${singularCapitalized}RowDecoder
-    .or(${meta.import.decoder.rowDecoderName}.transform(uncapitalizeKeys))
+    .or(${meta.import.decoder.rowDecoderName}
+      .transform(item => ({
+        ${fieldTransformers.join(',\n')}
+      })))
   )
   .transform((items) => items.filter(Boolean) as ${model.typeName}[])`;
 }
@@ -63,11 +65,11 @@ function generateFieldDecoders({ model, meta, imports, }) {
     for (const field of model.fields) {
         const fieldMeta = (0, meta_1.getFieldMetadata)({ field });
         const optionalModifier = field.attributes.isUpdatedAt || field.attributes.isCreatedAt ? '.optional()' : '';
-        blankFieldDecoders.push(`${fieldMeta.excelColumnName}: excelNullOrBlankDecoder${optionalModifier}`);
+        blankFieldDecoders.push(`'${fieldMeta.excelColumnName}': excelNullOrBlankDecoder${optionalModifier}`);
         switch (field.kind) {
             case 'id': {
                 imports.addImport({ items: [meta.types.toBrandedIdTypeFnName], from: meta.types.importPath });
-                fieldDecoders.push(`${fieldMeta.excelColumnName}: ${toExcelDecoder({
+                fieldDecoders.push(`'${fieldMeta.excelColumnName}': ${toExcelDecoder({
                     tsTypeName: field.unbrandedTypeName,
                     nullable: false,
                     imports,
@@ -75,7 +77,7 @@ function generateFieldDecoders({ model, meta, imports, }) {
                 break;
             }
             case 'scalar': {
-                fieldDecoders.push(`${fieldMeta.excelColumnName}: ${toExcelDecoder({
+                fieldDecoders.push(`'${fieldMeta.excelColumnName}': ${toExcelDecoder({
                     tsTypeName: field.tsTypeName,
                     nullable: !field.isRequired,
                     imports,
@@ -86,7 +88,7 @@ function generateFieldDecoders({ model, meta, imports, }) {
                 const refModel = field.relationToModel;
                 const refMeta = (0, meta_1.getModelMetadata)({ model: refModel });
                 imports.addImport({ items: [refMeta.types.toBrandedIdTypeFnName], from: refMeta.types.importPath });
-                fieldDecoders.push(`${fieldMeta.excelColumnName}: ${toExcelDecoder({
+                fieldDecoders.push(`'${fieldMeta.excelColumnName}': ${toExcelDecoder({
                     tsTypeName: field.unbrandedTypeName,
                     nullable: !field.isRequired,
                     imports,
@@ -98,7 +100,7 @@ function generateFieldDecoders({ model, meta, imports, }) {
                 break;
             }
             case 'enum': {
-                fieldDecoders.push(`${fieldMeta.excelColumnName}: z.enum([
+                fieldDecoders.push(`'${fieldMeta.excelColumnName}': z.enum([
             ${field.enumerator.values.map((v) => `'${v}'`).join(', ')}
           ])${field.isRequired ? '' : '.nullable()'}${optionalModifier}`);
                 break;
@@ -136,3 +138,11 @@ function toExcelDecoder({ tsTypeName, nullable, imports, }) {
             throw new Error('Unknown type');
     }
 }
+function generateFieldTransformers({ model }) {
+    const fieldTransformers = [];
+    for (const field of model.fields) {
+        const fieldMeta = (0, meta_1.getFieldMetadata)({ field });
+        fieldTransformers.push(`${field.name}: item['${fieldMeta.excelColumnName}']`);
+    }
+    return fieldTransformers;
+}

package/dist/generators/models/react/modals.generator.js

@@ -574,7 +574,7 @@ function getFormFieldComponents({ model, testIdCollector, }) {
             continue;
         }
         const formikFieldName = getFormikFieldName(field.name);
-        const label = StringUtils.toPascalCase(field.name);
+        const label = field.attributes.label;
         switch (field.kind) {
             case 'id': {
                 // NOTE: We never show the ID field in the form even if it's in the type signature of the form input.

package/dist/lib/attributes.d.ts

@@ -81,10 +81,21 @@ export type FieldAttributes = {
      */
     maxLength?: number;
     /**
-     * Schema tag: `@@Label()`
+     * Schema tag: `@@IsNameField()`
      * The field that should be used as the default label for the model.
+     *
+     * If this is set, the repository will verify that exactly one record has this field set to true - and use it as the default label.
+     *
+     * If this attribute is set, this field will be used in the code/UI as the field that specifies the model's name. If not provided, we check for the existence of the`name` field. If that is not found, we use the `id` field as the name field.
+     */
+    isNameField?: boolean;
+    /**
+     * Schema tag: `@@Label("Label")`
+     * The human readable label/name of the field.
+     *
+     * If not provided, we use the field name.
      */
-    isLabel?: boolean;
+    label: string;
 };
 export type EnumAttributes = {
     /**

package/dist/lib/meta.js

@@ -402,7 +402,7 @@ function getFieldMetadata({ field }) {
         tsFieldName: Types.toVariableName((0, string_1.toCamelCase)(field.name)),
         getByForeignKeyMethodFnName: Types.toFunctionName(`getItemsFor${PascalCase}`),
         getByForeignKeyIdsMethodFnName: Types.toFunctionName(`getIdsFor${PascalCase}`),
-        excelColumnName: (0, string_1.toPascalCase)(field.name),
+        excelColumnName: field.attributes.label,
     };
 }
 exports.getFieldMetadata = getFieldMetadata;

package/dist/lib/schema/schema.d.ts

@@ -284,9 +284,9 @@ export type FieldScalar = Prettify<Omit<FieldCore, 'name'> & {
 export type FieldId = Prettify<Omit<FieldCore, 'name'> & {
     kind: 'id';
     /**
-     * Name of the field and variable (e.g. id)
+     * Name of the field and variable (must be `id`)
      */
-    name: Types.FieldName;
+    name: Types.IdFieldName;
     /**
      * Model that this ID field identifies.
      */
@@ -314,9 +314,9 @@ export type FieldId = Prettify<Omit<FieldCore, 'name'> & {
 export declare const isFieldId: (field: Field) => field is Prettify<Omit<FieldCore, "name"> & {
     kind: 'id';
     /**
-     * Name of the field and variable (e.g. id)
+     * Name of the field and variable (must be `id`)
      */
-    name: Types.FieldName;
+    name: Types.IdFieldName;
     /**
      * Model that this ID field identifies.
      */

package/dist/lib/schema/types.d.ts

@@ -71,6 +71,16 @@ export declare const isAnnotatedTypeName: (t: string | AnnotatedTypeName) => t i
 export type FieldName = string & {
     readonly ___type: 'FieldName';
 };
+/**
+ * Brands a raw string to an IdFieldName identifier.
+ */
+export declare const ID_FIELD_NAME: IdFieldName;
+/**
+ * The name of the id field. Must be `id`.
+ */
+export type IdFieldName = 'id' & {
+    readonly ___type: 'FieldName';
+};
 /**
  * Brands a raw string to a FieldName identifier.
  */

package/dist/lib/schema/types.js

@@ -1,7 +1,7 @@
 "use strict";
 // MARK: - Generated content related types
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toPackageName = exports.toPath = exports.toBackendModulePath = exports.toModuleLocation = exports.toFolderName = exports.toFileName = exports.toVariableName = exports.toFunctionName = exports.toEnumName = exports.toFieldName = exports.isAnnotatedTypeName = exports.toAnnotatedTypeName = exports.toTypeName = exports.toModelName = exports.toDiscriminantName = exports.toClassName = void 0;
+exports.toPackageName = exports.toPath = exports.toBackendModulePath = exports.toModuleLocation = exports.toFolderName = exports.toFileName = exports.toVariableName = exports.toFunctionName = exports.toEnumName = exports.toFieldName = exports.ID_FIELD_NAME = exports.isAnnotatedTypeName = exports.toAnnotatedTypeName = exports.toTypeName = exports.toModelName = exports.toDiscriminantName = exports.toClassName = void 0;
 /**
  * Converts a raw string to a branded ClassName.
  */
@@ -35,6 +35,10 @@ exports.toAnnotatedTypeName = toAnnotatedTypeName;
  */
 const isAnnotatedTypeName = (t) => typeof t === 'object' && t.kind === 'TypeName';
 exports.isAnnotatedTypeName = isAnnotatedTypeName;
+/**
+ * Brands a raw string to an IdFieldName identifier.
+ */
+exports.ID_FIELD_NAME = 'id';
 /**
  * Brands a raw string to a FieldName identifier.
  */

package/dist/lib/utils/error.js

@@ -34,7 +34,6 @@ function extractNestedErrors(value) {
  * As a fallback, it returns a JSON string representation of the error.
  */
 function formatZodError(e) {
-    console.log(e);
     const formatted = e.format();
     if (typeof formatted === 'string') {
         return formatted;

package/dist/prisma/attributes.js

@@ -138,7 +138,8 @@ function getFieldAttributes(field) {
         ignore: blankStringBooleanDecoder,
         description: zod_1.default.string().optional(),
         isDefault: blankStringBooleanDecoder,
-        label: blankStringBooleanDecoder,
+        isNameField: blankStringBooleanDecoder,
+        label: zod_1.default.string().optional(),
         example: examplesDecoder,
         examples: examplesDecoder,
         maxLength: zod_1.default
@@ -148,7 +149,7 @@ function getFieldAttributes(field) {
         readonly: blankStringBooleanDecoder,
     })
         .transform((obj) => {
-        var _a;
+        var _a, _b;
         if (isPrismaIgnored && !obj.ignore) {
             throw new Error(`Field ${field.name} is ignored by Prisma, but is missing the "ignore" PostXL attribute!`);
         }
@@ -156,11 +157,12 @@ function getFieldAttributes(field) {
             ignore: obj.ignore,
             description: obj.description,
             isDefaultField: obj.isDefault,
-            isLabel: obj.label,
+            isNameField: obj.isNameField,
+            label: (_a = obj.label) !== null && _a !== void 0 ? _a : (0, string_1.toPascalCase)(field.name),
             examples: obj.examples || obj.example,
             maxLength: obj.maxLength,
             isReadonly: obj.readonly || field.isGenerated || field.isUpdatedAt || field.name === 'createdAt' || field.isId,
-            isUpdatedAt: (_a = field.isUpdatedAt) !== null && _a !== void 0 ? _a : false,
+            isUpdatedAt: (_b = field.isUpdatedAt) !== null && _b !== void 0 ? _b : false,
             isCreatedAt: field.name === 'createdAt',
         };
     });

package/dist/prisma/parse.js

@@ -226,7 +226,7 @@ function parseModel({ dmmfModel, enums, models, config, }) {
         }
         if (dmmfField.isId) {
             const isGeneratedField = isAutoIncrementField(dmmfField) || isUUIDField(dmmfField);
-            const _field = Object.assign(Object.assign({ kind: 'id' }, shared), { isUnique: isUniqueField(dmmfField), isGenerated: isGeneratedField, unbrandedTypeName: getTsTypeForId(dmmfField), model: core });
+            const _field = Object.assign(Object.assign({ kind: 'id' }, shared), { name: Types.ID_FIELD_NAME, isUnique: isUniqueField(dmmfField), isGenerated: isGeneratedField, unbrandedTypeName: getTsTypeForId(dmmfField), model: core });
             return _field;
         }
         if (dmmfField.kind === 'scalar') {
@@ -282,25 +282,25 @@ function validateFields({ fields, model: { name } }) {
         const fieldName = (0, logger_1.highlight)(`${name}.${field.name}`);
         switch (field.kind) {
             case 'scalar':
-                if (field.name === 'name') {
+                if (field.name === 'name' && nameField === undefined) {
                     nameField = field;
                 }
                 if (field.attributes.isCreatedAt) {
                     if (createdAtField) {
-                        (0, error_1.throwError)(`${fieldName} has multiple createdAt fields`);
+                        (0, error_1.throwError)(`${fieldName} has multiple createdAt fields - ${createdAtField.name} and ${field.name}`);
                     }
                     createdAtField = field;
                 }
                 if (field.attributes.isUpdatedAt) {
                     if (updatedAtField) {
-                        (0, error_1.throwError)(`${fieldName} has multiple updatedAt fields`);
+                        (0, error_1.throwError)(`${fieldName} has multiple updatedAt fields - ${updatedAtField.name} and ${field.name}`);
                     }
                     updatedAtField = field;
                 }
                 break;
             case 'id':
                 if (idField) {
-                    (0, error_1.throwError)(`${fieldName} has multiple id fields`);
+                    (0, error_1.throwError)(`${fieldName} has multiple id fields - ${idField.name} and ${field.name}`);
                 }
                 idField = field;
                 break;
@@ -312,14 +312,20 @@ function validateFields({ fields, model: { name } }) {
         //handle default case
         if (field.attributes.isDefaultField && field.kind === 'scalar') {
             if (defaultField !== undefined) {
-                (0, error_1.throwError)(`${fieldName} has multiple default fields`);
+                (0, error_1.throwError)(`${fieldName} has multiple default fields - ${defaultField.name} and ${field.name}`);
             }
             defaultField = field;
         }
         //handle name field
-        if (field.attributes.isLabel) {
+        if (field.attributes.isNameField) {
             if (labelField !== undefined) {
-                (0, error_1.throwError)(`${fieldName} has multiple name fields`);
+                // Note: In case we have a field called "name" but assign the "@@Label" attribute to another field, we ignore the "name" field.
+                if (labelField.name === 'name') {
+                    labelField = field;
+                }
+                else {
+                    (0, error_1.throwError)(`${fieldName} has multiple name fields - ${labelField.name} and ${field.name}`);
+                }
             }
             labelField = field;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postxl/generator",
-  "version": "0.72.0",
+  "version": "0.73.0",
   "main": "./dist/generator.js",
   "typings": "./dist/generator.d.ts",
   "bin": {