@postxl/generator 0.14.0 → 0.15.1

package/dist/lib/meta.d.ts

@@ -5,6 +5,14 @@ import * as Types from './schema/types';
  */
 export type SchemaMetaData = {
     data: {
+        /**
+         * The name of the Module class
+         */
+        moduleName: Types.ClassName;
+        /**
+         * Path that may be used to import from the data module.
+         */
+        importPath: Types.Path;
         /**
          * Path to the file containing the data module class definition.
          */
@@ -34,6 +42,32 @@ export type SchemaMetaData = {
          */
         stubIndexFilePath: Types.Path;
     };
+    businessLogic: {
+        /**
+         * The name of the Module class
+         */
+        moduleName: Types.ClassName;
+        /**
+         * Path that may be used to import from the business logic module.
+         */
+        importPath: Types.Path;
+        /**
+         * Path to the file containing the business logic index.
+         */
+        indexFilePath: Types.Path;
+        /**
+         * Path to the file containing the business logic module definition.
+         */
+        moduleFilePath: Types.Path;
+        /**
+         * The name of the business logic service class.
+         */
+        serviceClassName: Types.ClassName;
+        /**
+         * Path to the file containing the business logic service class definition.
+         */
+        serviceFilePath: Types.Path;
+    };
     seed: {
         /**
          * Path to the index file for the seed package.
@@ -104,6 +138,25 @@ export type ModelMetaData = {
      *       use a more specific name for your purposes (e.g. `reactCreateModalComponentName`).
      */
     userFriendlyName: string;
+    /**
+     * The name of the model in singular form.
+     *
+     * NOTE: This name is meant to be used in internal variables only.
+     *       For any variables, class names, etc. that are exposed, please use a more specific name.
+     *      (e.g. `reactCreateModalComponentName`)
+     */
+    internalSingularName: Types.VariableName;
+    /**
+     * The name of the model in plural form.
+     *
+     * NOTE: This name is meant to be used in internal variables only.
+     *       For any variables, class names, etc. that are exposed, please use a more specific name.
+     *      (e.g. `reactCreateModalComponentName`)
+     */
+    internalPluralName: Types.VariableName;
+    /**
+     * Properties provided by the `data` generators.
+     */
     data: {
         /**
          * Path that may be used to import definitions of this model.
@@ -168,6 +221,34 @@ export type ModelMetaData = {
             getMethodFnName: Types.Fnction;
         };
     };
+    /**
+     * Properties provided by the `business logic` generator.
+     */
+    businessLogic: {
+        /**
+         * Path that may be used to import definitions of this model.
+         */
+        importPath: Types.Path;
+        /**
+         * The name by which the model's class is exposed in the businessLogicService/context. (e.g. aggregations)
+         */
+        serviceClassName: Types.ClassName;
+        /**
+         * The name by which the model's class is exposed in the businessLogicService/context. (e.g. aggregations)
+         */
+        serviceVariableName: Types.VariableName;
+        /**
+         * Name of the file containing the service for this model.
+         */
+        serviceFileName: Types.FileName;
+        /**
+         * Path to the file containing the service.
+         */
+        serviceFilePath: Types.Path;
+    };
+    /**
+     * Properties provided by the `seed` generators.
+     */
     seed: {
         /**
          * The name of the constant containing seed data of this model (e.g. `aggregations`).
@@ -206,6 +287,9 @@ export type ModelMetaData = {
             dataName: Types.VariableName;
         };
     };
+    /**
+     * Properties provided by the `react` generators.
+     */
     react: {
         /**
          * Name of the folder that contains React components for this model.
@@ -264,6 +348,9 @@ export type ModelMetaData = {
             cardComponentName: Types.VariableName;
         };
     };
+    /**
+     * Properties provided by the `trpc` generators.
+     */
     trpc: {
         /**
          * The path to the file that contains the router definition for this model.
@@ -299,7 +386,7 @@ export type ModelMetaData = {
         };
         update: {
             /**
-             * The name of the TRPC udpate method (e.g. `udpate` or `udpateAggregation`).
+             * The name of the TRPC update method (e.g. `update` or `updateAggregation`).
              */
             methodName: Types.VariableName;
             /**
@@ -318,6 +405,9 @@ export type ModelMetaData = {
             reactQueryMethod: Types.Fnction;
         };
     };
+    /**
+     * Properties provided by the `types` generators.
+     */
     types: {
         /**
          * The absolute path of the file that contains the type definition for this model.
@@ -344,6 +434,16 @@ export type ModelMetaData = {
          * The name of the file containing type definitions (e.g. `aggregation.type`).
          */
         typeDefFileName: Types.FileName;
+        /**
+         * The name of the type that represents a fully typed, flat object, e.g. `Aggregation`.
+         * This type only refers to related types by their branded ID.
+         */
+        typeName: Types.TypeName;
+        /**
+         * The name of the type that represents a fully typed object, e.g. `AggregationFull`.
+         * This type refers to relations by linking to the (flat) types.
+         */
+        linkedTypeName: Types.TypeName;
         /**
          * The name of the type that represents a source (i.e. database) object, e.g. `Aggregation`.
          */

package/dist/lib/meta.js

@@ -32,6 +32,8 @@ const string_1 = require("./utils/string");
 function getSchemaMetadata({ config }) {
     return {
         data: {
+            moduleName: Types.toClassName(`DataModule`),
+            importPath: Types.toPath(`@${config.project}/data`),
             dataModuleFilePath: Types.toPath(`${config.paths.dataLibPath}data.module`),
             dataMockModuleFilePath: Types.toPath(`${config.paths.dataLibPath}data.mock.module`),
             testDataServiceFilePath: Types.toPath(`${config.paths.dataLibPath}test-data.service`),
@@ -40,6 +42,14 @@ function getSchemaMetadata({ config }) {
             repositoriesIndexFilePath: Types.toPath(`${config.paths.dataLibPath}repositories/index`),
             stubIndexFilePath: Types.toPath(`${config.paths.dataLibPath}stubs/index`),
         },
+        businessLogic: {
+            moduleName: Types.toClassName(`BusinessLogicModule`),
+            importPath: Types.toPath(`@${config.project}/business-logic`),
+            indexFilePath: Types.toPath(`${config.paths.businessLogicPath}index`),
+            moduleFilePath: Types.toPath(`${config.paths.businessLogicPath}business-logic.module`),
+            serviceClassName: Types.toClassName(`BusinessLogicService`),
+            serviceFilePath: Types.toPath(`${config.paths.businessLogicPath}business-logic.service`),
+        },
         trpc: {
             routesFilePath: Types.toPath(`${config.paths.trpcRoutesFolderPath}index`),
             importPath: Types.toPath(`@${config.project}/trpc`),
@@ -68,6 +78,8 @@ function getModelMetadata({ model }) {
     const { PascalCase, camelCase, pluralized, uncapitalizedPlural, capitalizedPlural } = (0, string_1.conjugateNames)(name);
     return {
         userFriendlyName: PascalCase,
+        internalSingularName: Types.toVariableName(camelCase),
+        internalPluralName: Types.toVariableName(uncapitalizedPlural),
         data: {
             mockDataPropertyName: Types.toVariableName(`${uncapitalizedPlural}`),
             defaultStubConstantName: Types.toVariableName(`${camelCase}DefaultStub`),
@@ -87,6 +99,13 @@ function getModelMetadata({ model }) {
                 getMethodFnName: Types.toFunction(`${camelCase}`),
             },
         },
+        businessLogic: {
+            importPath: Types.toPath(`@${config.project}/businessLogic`),
+            serviceClassName: Types.toClassName(`${PascalCase}Service`),
+            serviceVariableName: Types.toVariableName(`${uncapitalizedPlural}`),
+            serviceFileName: Types.toFileName(`${camelCase}.service`),
+            serviceFilePath: Types.toPath(`${config.paths.businessLogicPath}${camelCase}.service`),
+        },
         seed: {
             filePath: Types.toPath(`${config.paths.seedPath}${uncapitalizedPlural}`),
             constantName: Types.toVariableName(`${uncapitalizedPlural}`),
@@ -157,6 +176,8 @@ function getModelMetadata({ model }) {
             brandedIdType: Types.toTypeName(`${PascalCase}Id`),
             toBrandedIdTypeFnName: Types.toFunction(`to${PascalCase}Id`),
             zodDecoderFnName: Types.toFunction(`${camelCase}Decoder`),
+            typeName: Types.toTypeName(`${PascalCase}`),
+            linkedTypeName: Types.toTypeName(`${PascalCase}Linked`),
             typeDefFileName: Types.toFileName(`${camelCase}.type`),
             sourceType: Types.toTypeName(`${PascalCase}`),
         },

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

@@ -36,4 +36,8 @@ export declare const isUniqueStringField: (f: Field) => boolean;
 /**
  * Returns true if the given field has a maxLength attribute.
  */
-export declare const isMaxLengthStringField: (f: Field) => boolean;
+export declare const isMaxLengthStringField: (f: Field) => f is Field & {
+    attributes: {
+        maxLength: number;
+    };
+};

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

@@ -23,6 +23,10 @@ export type SchemaConfig = {
          * If true, data module will not be generated.
          */
         data: boolean;
+        /**
+         * If true, business logic module will not be generated.
+         */
+        businessLogic: boolean;
         /**
          * If true, seed data will not be generated.
          */
@@ -51,6 +55,13 @@ export type SchemaConfig = {
          * may reference data library using `@project/data` import.
          */
         dataLibPath: Types.Path;
+        /**
+         * Path to the directory containing business logic.
+         *
+         * NOTE: Metadata assumes that project is set up so that certain parts of the code
+         * may reference mock data using `@project/business-logic` import.
+         */
+        businessLogicPath: Types.Path;
         /**
          * Path to the directory containing mock data samples.
          *
@@ -285,6 +296,13 @@ export type FieldRelation = Prettify<Omit<FieldCore, 'name'> & {
      * Name of the field and variable (e.g. aggregationId)
      */
     name: string;
+    /**
+     * Name of the field in the related model that references this model (e.g. `aggregation`).
+     *
+     * NOTE: This does not reference the database column name, but the field name
+     *  in the model (e.g. not `aggregationId`, but `aggregation`).
+     */
+    relatedModelBacklinkFieldName: string;
     /**
      * Name of the unbranded TypeScript type of the field, e.g. string
      *
@@ -308,6 +326,13 @@ export declare const isFieldRelation: (field: Field) => field is Prettify<Omit<F
      * Name of the field and variable (e.g. aggregationId)
      */
     name: string;
+    /**
+     * Name of the field in the related model that references this model (e.g. `aggregation`).
+     *
+     * NOTE: This does not reference the database column name, but the field name
+     *  in the model (e.g. not `aggregationId`, but `aggregation`).
+     */
+    relatedModelBacklinkFieldName: string;
     /**
      * Name of the unbranded TypeScript type of the field, e.g. string
      *
@@ -341,7 +366,7 @@ export type FieldEnum = Prettify<Omit<FieldCore, 'name'> & {
     enumerator: Enum;
 }>;
 /**
- * Utility function to check if a field is an enumid field.
+ * Utility function to check if a field is an enum field.
  */
 export declare const isFieldEnum: (field: Field) => field is Prettify<Omit<FieldCore, "name"> & {
     kind: 'enum';

package/dist/lib/schema/schema.js

@@ -12,7 +12,7 @@ exports.isFieldId = isFieldId;
 const isFieldRelation = (field) => field.kind === 'relation';
 exports.isFieldRelation = isFieldRelation;
 /**
- * Utility function to check if a field is an enumid field.
+ * Utility function to check if a field is an enum field.
  */
 const isFieldEnum = (field) => field.kind === 'enum';
 exports.isFieldEnum = isFieldEnum;

package/dist/prisma/parse.js

@@ -84,9 +84,17 @@ function parseModel({ dmmfModel, enums, models, config, }) {
         }
         relations[dmmfField.relationFromFields[0]] = referencedModel;
     }
+    const relationFields = dmmfModel.fields
+        .filter((f) => f.kind === 'object' && f.relationToFields && f.relationToFields.length === 1)
+        .reduce((acc, f) => {
+        if (f.relationFromFields && f.relationFromFields[0]) {
+            acc[f.relationFromFields[0]] = f;
+        }
+        return acc;
+    }, {});
     const fields = dmmfModel.fields
         .filter((dmmfField) => 
-    // if field is a "backlink", i.e. the reciever of a relation, we ignore it
+    // if field is a "backlink", i.e. the receiver of a relation, we ignore it
     dmmfField.kind !== 'object')
         .map((dmmfField) => {
         const attributes = (0, attributes_1.getFieldAttributes)(dmmfField);
@@ -101,7 +109,11 @@ function parseModel({ dmmfModel, enums, models, config, }) {
         // NOTE: We mark scalar fields which are used in relations as relation fields by Purple Schema standards.
         if (dmmfField.name in relations) {
             const refModel = relations[dmmfField.name];
-            return Object.assign(Object.assign({ kind: 'relation' }, shared), { typeName: Types.toTypeName(dmmfField.type), unbrandedTypeName: getTsTypeForId(dmmfField), relationToModel: refModel });
+            const refField = relationFields[dmmfField.name];
+            if (!refField) {
+                (0, error_1.throwError)(`Investigate: Relation field ${dmmfField.name} not found.`);
+            }
+            return Object.assign(Object.assign({ kind: 'relation' }, shared), { relatedModelBacklinkFieldName: refField.name, typeName: Types.toTypeName(dmmfField.type), unbrandedTypeName: getTsTypeForId(dmmfField), relationToModel: refModel });
         }
         if (dmmfField.isId) {
             return Object.assign(Object.assign({ kind: 'id' }, shared), { isUnique: isUniqueField(dmmfField), isGenerated: isAutoIncrementField(dmmfField), unbrandedTypeName: getTsTypeForId(dmmfField), model: core });
@@ -117,7 +129,7 @@ function parseModel({ dmmfModel, enums, models, config, }) {
             if (dmmfField.type === 'Float') {
                 validation = { type: 'float' };
             }
-            return Object.assign(Object.assign({ kind: 'scalar' }, shared), { isUnique: isUniqueField(dmmfField), isGenerated: isAutoIncrementField(dmmfField), typeName: getTsTypeForScalar(dmmfField) });
+            return Object.assign(Object.assign({ kind: 'scalar', validation }, shared), { isUnique: isUniqueField(dmmfField), isGenerated: isAutoIncrementField(dmmfField), typeName: getTsTypeForScalar(dmmfField) });
         }
         if (dmmfField.kind === 'enum') {
             const fieldEnumDef = enums.find((e) => e.sourceName === dmmfField.type);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postxl/generator",
-  "version": "0.14.0",
+  "version": "0.15.1",
   "main": "./dist/generator.js",
   "typings": "./dist/generator.d.ts",
   "bin": {
@@ -22,7 +22,7 @@
     "prettier": "^2.8.7",
     "remeda": "1.9.4",
     "zod": "3.21.4",
-    "@postxl/lock": "0.3.2"
+    "@postxl/lock": "0.4.1"
   },
   "devDependencies": {
     "@prisma/client": "4.12.0",