@postxl/generator 0.15.7 → 0.16.0

package/dist/generators/enums/types.generator.js

@@ -10,8 +10,26 @@ function generateEnumType({ enumerator, meta, prismaClientPath, }) {
 
     export type ${enumerator.typeName} = Prisma.${enumerator.sourceName}
     export const ${enumerator.typeName} = Prisma.${enumerator.sourceName}
+    ${enumerator.description
+        ? `/**
+      * ${enumerator.description.split('\n').join('\n * ')} 
+      */
+     `
+        : ''}
     export const ${meta.types.membersList}: ${enumerator.typeName}[] = [
-      ${enumerator.values.map((v) => `'${v}'`).join(', ')}
+      ${enumerator.values
+        .map((v) => {
+        var _a;
+        const description = (_a = enumerator.attributes.valueDescription) === null || _a === void 0 ? void 0 : _a[v];
+        if (description) {
+            return `
+            /** ${description} */
+            '${v}'
+            `;
+        }
+        return `'${v}'`;
+    })
+        .join(', ')}
     ]
   `;
 }

package/dist/generators/indices/businesslogicmodule.generator.js

@@ -7,7 +7,9 @@ const meta_1 = require("../../lib/meta");
  * Generates a business Logic module class.
  */
 function generateBusinessLogicModule({ models, meta }) {
-    const mm = models.map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }));
+    const mm = models
+        .map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }))
+        .sort((a, b) => a.meta.businessLogic.serviceClassName.localeCompare(b.meta.businessLogic.serviceClassName));
     const imports = imports_1.ImportsGenerator.from(meta.businessLogic.moduleFilePath)
         .addImport({
         items: [meta.data.moduleName],

package/dist/generators/indices/businesslogicservice.generator.js

@@ -7,7 +7,9 @@ const meta_1 = require("../../lib/meta");
  * Generates the business logic service class.
  */
 function generateBusinessLogicService({ models, meta }) {
-    const mm = models.map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }));
+    const mm = models
+        .map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }))
+        .sort((a, b) => a.meta.businessLogic.serviceClassName.localeCompare(b.meta.businessLogic.serviceClassName));
     const imports = imports_1.ImportsGenerator.from(meta.businessLogic.serviceFilePath);
     for (const { meta } of mm) {
         imports.addImport({
@@ -16,10 +18,10 @@ function generateBusinessLogicService({ models, meta }) {
         });
     }
     const constructor = mm
-        .map(({ meta }) => `public ${meta.businessLogic.serviceVariableName} :${meta.businessLogic.serviceClassName}`)
+        .map(({ meta }) => `@Inject(forwardRef(() => ${meta.businessLogic.serviceClassName}))  public ${meta.businessLogic.serviceVariableName} :${meta.businessLogic.serviceClassName}`)
         .join(',\n');
     return `
-import { Injectable } from '@nestjs/common'
+  import { Inject, Injectable, forwardRef } from '@nestjs/common'
 
 ${imports.generate()}
 

package/dist/generators/models/businesslogic.generator.js

@@ -32,6 +32,7 @@ const Types = __importStar(require("../../lib/schema/types"));
  * Generates business logic for a given model.
  */
 function generateModelBusinessLogic({ model, meta }) {
+    const schemaMeta = (0, meta_1.getSchemaMetadata)({ config: model.schemaConfig });
     const imports = imports_1.ImportsGenerator.from(meta.businessLogic.serviceFilePath);
     imports.addImport({ from: meta.data.importPath, items: [meta.data.repositoryClassName] });
     imports.addImport({ from: meta.types.importPath, items: [model.brandedIdType, meta.types.typeName] });
@@ -42,9 +43,20 @@ function generateModelBusinessLogic({ model, meta }) {
      */
     const modelRepositoryVariableName = Types.toVariableName('data');
     /**
-     * A map of referenced models indexed by the name of model's repository class.
+     * The name of the variable that holds the central business logic service instance.
+     * Instead of injecting a repository instance for each model, we inject this single instance
+     * which then provides access to all models' business logic.
      */
-    const dependencies = new Map();
+    const businessLogicServiceClassName = Types.toVariableName('businessLogic');
+    const constructorParameters = [
+        `public readonly ${modelRepositoryVariableName}: ${meta.data.repositoryClassName}`,
+        `@Inject(forwardRef(() => ${schemaMeta.businessLogic.serviceClassName})) private readonly ${businessLogicServiceClassName}: ${schemaMeta.businessLogic.serviceClassName}`,
+    ];
+    imports.addImport({
+        from: schemaMeta.businessLogic.serviceFilePath,
+        items: [schemaMeta.businessLogic.serviceClassName],
+    });
+    imports.addImport({ from: meta.data.importPath, items: [meta.data.repositoryClassName] });
     /**
      * Variable names and their definitions indexed by the name of the relation they represent.
      */
@@ -52,47 +64,26 @@ function generateModelBusinessLogic({ model, meta }) {
     for (const relation of (0, fields_1.getRelationFields)(model)) {
         const refModel = relation.relationToModel;
         const refMeta = (0, meta_1.getModelMetadata)({ model: refModel });
-        imports.addImport({ from: refMeta.data.importPath, items: [refMeta.data.repositoryClassName] });
+        const variableGetter = `this.${businessLogicServiceClassName}.${refMeta.businessLogic.serviceVariableName}.get(itemRaw.${relation.name})`;
         const variablePresenceCheck = `
-      if (!${relation.relatedModelBacklinkFieldName}) {
+    if (!${relation.relatedModelBacklinkFieldName}) {
         throw new Error(\`Could not find ${refMeta.types.typeName} with id \${itemRaw.${relation.name}} for ${model.typeName}.${relation.name}!\`)
       }
-    `;
+      `;
         const relationVariableName = relation.relatedModelBacklinkFieldName;
-        if (relation.relationToModel.typeName === model.typeName) {
-            // NOTE: If the referenced model is a self-relation, we want to reuse the instance of the repository
-            //      that is already injected into the constructor meaning that we don't need to set up a dependency and a local variable.
-            variables.set(relation.name, {
-                variableName: relationVariableName,
-                variableDefinition: `
-          const ${relationVariableName} = this.data.get(itemRaw.${relation.name})
-          ${relation.isRequired ? variablePresenceCheck : ``}      
-        `,
-            });
-        }
-        else {
-            const refRepoVariableName = refMeta.internalPluralName;
-            dependencies.set(refMeta.data.repositoryClassName, {
-                localRepositoryVariableName: refRepoVariableName,
-                repositoryClassName: refMeta.data.repositoryClassName,
-            });
-            variables.set(relation.name, {
-                variableName: relationVariableName,
-                variableDefinition: `
-          const ${relationVariableName} = this.${refRepoVariableName}.get(itemRaw.${relation.name})
-          ${relation.isRequired ? variablePresenceCheck : ``}      
-        `,
-            });
-        }
+        variables.set(relation.name, {
+            variableName: relationVariableName,
+            variableDefinition: `
+      const ${relationVariableName} = ${relation.isRequired
+                ? `${variableGetter};${variablePresenceCheck}`
+                : `itemRaw.${relation.name} !== null ? ${variableGetter} : null`} 
+      `,
+        });
     }
     const hasLinkedItems = variables.size > 0;
     if (hasLinkedItems) {
         imports.addImport({ from: meta.types.importPath, items: [meta.types.linkedTypeName] });
     }
-    const constructorParameters = [`public readonly ${modelRepositoryVariableName}: ${meta.data.repositoryClassName}`];
-    for (const [, { localRepositoryVariableName, repositoryClassName }] of dependencies) {
-        constructorParameters.push(`private readonly ${localRepositoryVariableName}: ${repositoryClassName}`);
-    }
     const linkedItemsGetterFn = `
     /**
      * Returns the linked ${meta.userFriendlyName} with the given id or null if it does not exist.
@@ -124,7 +115,7 @@ function generateModelBusinessLogic({ model, meta }) {
     }
   `;
     return `
-import { Injectable } from '@nestjs/common'
+import { Inject, Injectable, forwardRef } from '@nestjs/common'
 
 ${imports.generate()}
 

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

@@ -96,7 +96,7 @@ export const ${modals.createComponentName} = ({ show, onHide }: { show: boolean;
           }
         }}
       >
-        {({ isSubmitting, submitForm, isValid }) => (
+        {({ isSubmitting, submitForm }) => (
           <ModalWithActions actions={
             <ConfirmButton
               color="primary"

package/dist/generators/models/repository.generator.js

@@ -79,7 +79,9 @@ function generateRepository({ model, meta }) {
     return `
 import { Injectable, Logger } from '@nestjs/common'
 ${model.attributes.inMemoryOnly
-        ? ''
+        ? `
+  import { ${indexes.length === 0 ? '' : 'NestedMap'} } from '@pxl/common'
+  `
         : `
 import { DbService, ${model.sourceName} as DbType } from '@${model.schemaConfig.project}/db'
 import { format, pluralize ${indexes.length === 0 ? '' : ', NestedMap'} } from '@pxl/common'

package/dist/generators/models/types.generator.js

@@ -93,6 +93,9 @@ function getFieldComment(f) {
     if (f.description) {
         comment = ` * ${f.description.split('\n').join('\n * ')}\n`;
     }
+    else if (f.kind === 'enum' && f.enumerator.description) {
+        comment = ` * ${f.enumerator.description.split('\n').join('\n * ')}\n`;
+    }
     if (examples) {
         comment += ` * ${examples}\n`;
     }

package/dist/lib/attributes.d.ts

@@ -68,3 +68,18 @@ export type FieldAttributes = {
      */
     isLabel?: boolean;
 };
+export type EnumAttributes = {
+    /**
+     * The description of the enum.
+     * Schema tag: ´@@Description("Description of the model")`
+     */
+    description?: string;
+    /**
+     * A dictionary of value descriptions.
+     *
+     * Note: Unfortunately, the DMMF does not support attributes for Enum values. So we use an attribute on the enum itself to define the descriptions.
+     *
+     * Schema tag: ´@@Schema("ValueDescription")`
+     */
+    valueDescription?: Record<string, string>;
+};

package/dist/lib/meta.d.ts

@@ -143,7 +143,7 @@ export type ModelMetaData = {
      *
      * 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`)
+     *       (e.g. `reactCreateModalComponentName`)
      */
     internalSingularName: Types.VariableName;
     /**
@@ -151,7 +151,7 @@ export type ModelMetaData = {
      *
      * 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`)
+     *       (e.g. `reactCreateModalComponentName`)
      */
     internalPluralName: Types.VariableName;
     /**

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

@@ -1,4 +1,4 @@
-import { FieldAttributes, ModelAttributes } from '../attributes';
+import { EnumAttributes, FieldAttributes, ModelAttributes } from '../attributes';
 import { Prettify } from '../utils/types';
 import * as Types from './types';
 /**
@@ -388,10 +388,18 @@ export declare const isFieldEnum: (field: Field) => field is Prettify<Omit<Field
  */
 export type Enum = {
     name: string;
+    /**
+     * Description of the enum, ideally providing business background and detailed information
+     */
+    description?: string;
     /**
      * TypeScript type that should be used to reference an enumerator.
      */
     typeName: Types.TypeName;
+    /**
+     * Object containing all optional attributes of the enum.
+     */
+    attributes: EnumAttributes;
     /**
      * Name of the enum as it appears in the source (e.g. in the Prisma file).
      */

package/dist/prisma/attributes.d.ts

@@ -1,5 +1,5 @@
 import { DMMF } from '@prisma/generator-helper';
-import type { Attributes, AttributeValue, FieldAttributes, ModelAttributes } from '../lib/attributes';
+import type { Attributes, AttributeValue, EnumAttributes, FieldAttributes, ModelAttributes } from '../lib/attributes';
 /**
  * Parses attributes from a given string using provided prefix.
  */
@@ -11,6 +11,10 @@ export declare function parseArgumentToStringOrStringArray(str: string): Attribu
  * Returns attribute information for a given model.
  */
 export declare function getModelAttributes(model: DMMF.Model): ModelAttributes;
+/**
+ * Returns attribute information for a given enum.
+ */
+export declare function getEnumAttributes(model: DMMF.DatamodelEnum): EnumAttributes;
 /**
  * Returns all attributes assigned to a field
  */

package/dist/prisma/attributes.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFieldAttributes = exports.getModelAttributes = exports.parseArgumentToStringOrStringArray = exports.parseAttributesFromDocumentation = void 0;
+exports.getFieldAttributes = exports.getEnumAttributes = exports.getModelAttributes = exports.parseArgumentToStringOrStringArray = exports.parseAttributesFromDocumentation = void 0;
 const remeda_1 = require("remeda");
 const string_1 = require("../lib/utils/string");
 const zod_1 = __importDefault(require("zod"));
@@ -93,12 +93,30 @@ function getModelAttributes(model) {
     if (!result.success) {
         throw new Error(`Model ${model.name} has invalid model attributes: ${result.error.toString()}`);
     }
-    if (result.data.description === 'The calculated metric value for a dataset.') {
-        // TODO: What is this supposed to do?
-    }
     return result.data;
 }
 exports.getModelAttributes = getModelAttributes;
+/**
+ * Returns attribute information for a given enum.
+ */
+function getEnumAttributes(model) {
+    const attributes = parseAttributesFromDocumentation(model);
+    const decoder = zod_1.default
+        .object({
+        description: zod_1.default.string().optional(),
+        valueDescription: zod_1.default.record(zod_1.default.string()).optional(),
+    })
+        .transform((obj) => ({
+        description: obj.description,
+        valueDescription: obj.valueDescription,
+    }));
+    const result = decoder.safeParse(attributes);
+    if (!result.success) {
+        throw new Error(`Model ${model.name} has invalid model attributes: ${result.error.toString()}`);
+    }
+    return result.data;
+}
+exports.getEnumAttributes = getEnumAttributes;
 /**
  * Returns all attributes assigned to a field
  */

package/dist/prisma/parse.js

@@ -222,8 +222,11 @@ function isFieldIgnored({ field }) {
  * Parses a given enumerator type.
  */
 function parseEnum({ dmmfEnum, config }) {
+    const attributes = (0, attributes_1.getEnumAttributes)(dmmfEnum);
     return {
         name: dmmfEnum.name,
+        description: attributes.description,
+        attributes,
         typeName: Types.toTypeName((0, string_1.toPascalCase)(dmmfEnum.name)),
         sourceName: dmmfEnum.name,
         values: dmmfEnum.values.map((v) => v.name),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postxl/generator",
-  "version": "0.15.7",
+  "version": "0.16.0",
   "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.4.1"
+    "@postxl/lock": "0.4.2"
   },
   "devDependencies": {
     "@prisma/client": "4.12.0",