@postxl/generator 0.73.0 → 0.73.1

package/dist/generator.js

@@ -404,6 +404,20 @@ function generate(_a) {
             }
         }
         yield lock.writeToProjectRoot(root, { dryRun: false });
+        // NOTE: Detached mode tells whether any of the UTF-8 files were detached.
+        //       We use this in CI template tests.
+        const isNoDetachedMode = process.env.POSTXL_NO_DETACHED_MODE === 'true';
+        if (isNoDetachedMode) {
+            console.log(`No detached mode enabled. Checking that all files are managed!`);
+            return;
+        }
+        if (isNoDetachedMode) {
+            const detachedFiles = results.filter((result) => { var _a; return result.status === 'skip' && !Buffer.isBuffer((_a = result.disk) === null || _a === void 0 ? void 0 : _a.content); });
+            if (detachedFiles.length > 0) {
+                console.log(`Detached files found: ${detachedFiles.map((f) => f.path).join(', ')}`);
+            }
+            process.exit(1);
+        }
         // NOTE: Lastly we generate the log of the changes.
         const log = lock_1.ConsoleUtils.getFilesChangelog(results.map((result) => {
             if (result.status === 'write') {

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

@@ -2,23 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateModelContext = void 0;
 const imports_1 = require("../../../lib/imports");
-const string_1 = require("../../../lib/utils/string");
 /**
  * Utility component that generates the definition of the React context for a given model.
  */
 function generateModelContext({ model, meta }) {
-    const queryName = (0, string_1.toCamelCase)(model.name);
     const imports = imports_1.ImportsGenerator.from(meta.react.folderPath).addTypeImport({
-        items: [model.typeName, model.brandedIdType],
         from: meta.types.importPath,
+        items: [model.typeName, model.brandedIdType],
     });
     const resultMapTypeDefinition = `Map<${model.brandedIdType}, ${model.typeName}>`;
     return `
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import React, { useMemo } from 'react'
+import { useMemo } from 'react'
 
 import { trpc } from '@lib/trpc'
-import { filterMap, mapMap } from '@postxl/runtime'
 
 ${imports.generate()}
 
@@ -32,17 +28,17 @@ type ProviderHookType = {
  * A React utility hook to access the model data in the generated forms.
  */
 export const ${meta.react.context.hookFnName} = (): ProviderHookType => {
-	const ${queryName} = trpc.${meta.trpc.getMap.reactQueryMethod}.useQuery()
+	const dataQuery = trpc.${meta.trpc.getMap.reactQueryMethod}.useQuery()
 
 	const value = useMemo<ProviderHookType>(() => {
-		const data: ${resultMapTypeDefinition} = ${queryName}.data ?? new ${resultMapTypeDefinition}()
+		const data: ${resultMapTypeDefinition} = dataQuery.data ?? new ${resultMapTypeDefinition}()
 
 		return {
-			ready: ${queryName}.isLoading === false,
+			ready: dataQuery.isLoading === false,
 			map: data,
 			list: Array.from(data.values())
 		}
-	}, [${queryName}.isLoading, ${queryName}.data])
+	}, [dataQuery.isLoading, dataQuery.data])
 
 	return value
 }

package/dist/generators/models/view/service.generator.js

@@ -5,9 +5,7 @@ const imports_1 = require("../../../lib/imports");
 const meta_1 = require("../../../lib/meta");
 const fields_1 = require("../../../lib/schema/fields");
 const types_1 = require("../../../lib/schema/types");
-const types_2 = require("../../../lib/types");
 const ast_1 = require("../../../lib/utils/ast");
-const jsdoc_1 = require("../../../lib/utils/jsdoc");
 /**
  * Generates view business logic for a given model.
  * The view  logic exposes all information and links of a model. See template's readme for more info.
@@ -20,91 +18,64 @@ function generateModelBusinessLogicView({ model, meta }) {
         [meta.types.importPath]: [(0, types_1.toAnnotatedTypeName)(model.brandedIdType), (0, types_1.toAnnotatedTypeName)(meta.types.typeName)],
         [schemaMeta.view.serviceLocation.path]: schemaMeta.view.serviceClassName,
     });
-    /**
-     * 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 viewServiceClassName = 'viewService';
-    const constructorParameters = [
-        `public readonly data: ${meta.data.repository.className}`,
-        `@Inject(forwardRef(() => ${schemaMeta.view.serviceClassName})) private readonly ${viewServiceClassName}: ${schemaMeta.view.serviceClassName}`,
-    ];
-    /**
-     * Variable names and their definitions indexed by the name of the relation they represent.
-     */
-    const variables = new Map();
-    for (const relation of (0, fields_1.getRelationFields)(model)) {
-        const refModel = relation.relationToModel;
-        const refMeta = (0, meta_1.getModelMetadata)({ model: refModel });
-        const variableGetter = `await this.${viewServiceClassName}.${refMeta.view.serviceVariableName}.get(itemRaw.${relation.name})`;
-        const variablePresenceCheck = `
-      if (!${relation.relationFieldName}) {
-        throw new Error(\`Could not find ${refMeta.types.typeName} with id \${itemRaw.${relation.name}} for ${model.typeName}.${relation.name}!\`)
-      }
-      `;
-        const relationVariableName = relation.relationFieldName;
-        const relationVariableDefinition = relation.isRequired
-            ? `${variableGetter};${variablePresenceCheck}`
-            : `itemRaw.${relation.name} !== null ? ${variableGetter} : null`;
-        variables.set(relation.name, {
-            variableName: relationVariableName,
-            variableDefinition: `const ${relationVariableName} = ${relationVariableDefinition}`,
-        });
-        if (relation.relationToModel.typeName !== model.typeName) {
-            imports.addImport({ from: refMeta.types.importPath, items: [refMeta.types.toBrandedIdTypeFnName] });
-            imports.addTypeImport({ from: refMeta.types.importPath, items: [refModel.brandedIdType, refMeta.types.typeName] });
-        }
-    }
-    const hasLinkedItems = variables.size > 0;
-    if (hasLinkedItems) {
-        // NOTE: If we need to generate the linked item type, we need to import the enum types.
-        for (const enumField of (0, fields_1.getEnumFields)(model)) {
-            const enumMeta = (0, meta_1.getEnumMetadata)(enumField);
-            imports.addTypeImport({ from: enumMeta.types.importPath, items: [enumField.typeName] });
+    const compareFnBlock = (0, ast_1.createSwitchStatement)({
+        field: 'field',
+        cases: (0, fields_1.getScalarFields)({ fields: model.fields, tsTypeName: 'string' }).map((f) => ({
+            match: `"${f.name}"`,
+            block: `return (a[field] || '').localeCompare(b[field] || '')`,
+        })),
+        defaultBlock: 'return 0',
+    });
+    const stringFieldFilters = (0, fields_1.getScalarFields)({ fields: model.fields, tsTypeName: 'string' }).map((f) => {
+        return {
+            match: `"${f.name}"`,
+            block: `
+        if (typeof value !== 'string') {
+          return false
         }
-    }
-    const linkedItemsGetterFn = `
-    /**
-     * Returns the linked ${meta.userFriendlyName} with the given id or null if it does not exist.
-     * Linked: The ${meta.userFriendlyName} contains the linked (raw) items themselves, not only the ids.
-     */
-    public async getLinkedItem(id: ${model.brandedIdType}): Promise<${meta.types.linkedTypeName} | null> {
-      const itemRaw = await this.data.get(id)
-      if (!itemRaw) {
-        return null
-      }
 
-      ${[...variables.values()].map((r) => r.variableDefinition).join('\n')}
-      
-      const item: ${meta.types.linkedTypeName} = {
-        ${model.fields
-        .map((f) => {
-        if (f.kind !== 'relation') {
-            return `${f.name}: itemRaw.${f.name}`;
+        switch (operator) {
+          case 'contains': {
+            return (item[field] || '').toLowerCase().includes(value.toLowerCase())
+          }
+          default: {
+            return false
+          }
         }
-        const linkedRel = variables.get(f.name);
-        if (!linkedRel) {
-            throw new Error(`Could not find linked item for ${model.typeName}.${f.name}`);
+      `,
+        };
+    });
+    const numberFieldsFilters = (0, fields_1.getScalarFields)({ fields: model.fields, tsTypeName: 'number' }).map((f) => {
+        return {
+            match: `"${f.name}"`,
+            block: `
+        const toCompare = item[field]
+        if (typeof value !== 'number' || toCompare === null) {
+          return false
         }
-        return `${linkedRel.variableName}`;
-    })
-        .join(',\n')}
-      }
 
-      return item
-    }
-  `;
-    const linkedTypeDefinition = `
-    export type ${meta.types.linkedTypeName} = { 
-      ${model.fields
-        .map((f) => `
-            ${(0, jsdoc_1.getFieldComment)(f)}
-            ${getLinkedFieldType(f)}${f.isRequired ? '' : ' | null'}
-          `)
-        .join('\n')}
-    }
-  `;
+        switch (operator) {
+          case 'eq': {
+            return item[field] === value
+          }
+          case 'gt': {
+            return toCompare > value
+          }
+          case 'lt': {
+            return toCompare < value
+          }
+          default: {
+            return false
+          }
+        }
+      `,
+        };
+    });
+    const filterFnBlock = (0, ast_1.createSwitchStatement)({
+        field: 'field',
+        cases: [...stringFieldFilters, ...numberFieldsFilters],
+        defaultBlock: 'return false',
+    });
     return /* ts */ `
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import z from 'zod'
@@ -113,8 +84,6 @@ import { Inject, Injectable, forwardRef } from '@nestjs/common'
 
 ${imports.generate()}
 
-${hasLinkedItems ? linkedTypeDefinition : ''}
-
 /**
  * Cursor decoder.
  */
@@ -144,7 +113,11 @@ type FilterOperator = z.infer<typeof ${meta.view.filterOperatorDecoder}>
 
 @Injectable()
 export class ${meta.view.serviceClassName} {
-  constructor(${constructorParameters.join(',\n')}) {}
+  constructor(
+    public readonly data: ${meta.data.repository.className},
+    @Inject(forwardRef(() => ${schemaMeta.view.serviceClassName})) 
+        private readonly viewService: ${schemaMeta.view.serviceClassName}
+  ) {}
 
   /**
    * Returns the raw ${meta.userFriendlyName} with the given id or null if it does not exist.
@@ -154,8 +127,6 @@ export class ${meta.view.serviceClassName} {
     return this.data.get(id)
   }
 
-  ${hasLinkedItems ? linkedItemsGetterFn : ''}
-
   /**
    * Returns a map of all ${meta.userFriendlyNamePlural}.
    */
@@ -192,68 +163,13 @@ export class ${meta.view.serviceClassName} {
 
 // Utility Functions
 
-${_createModelCompareFn({ model })}
-
-${_createModelFilterFn({ model })}
-`;
-}
-exports.generateModelBusinessLogicView = generateModelBusinessLogicView;
 /**
- * Generates a utility filter function for the given model that can be used to filter out instances
- * of a model using a given operator on a given field.
+ * Compares two ${model.typeName} instances by the given field.
  */
-function _createModelFilterFn({ model }) {
-    const stringFieldFilters = (0, fields_1.getScalarFields)({ fields: model.fields, tsTypeName: 'string' }).map((f) => {
-        return {
-            match: `"${f.name}"`,
-            block: `
-        if (typeof value !== 'string') {
-          return false
-        }
-
-        switch (operator) {
-          case 'contains': {
-            return (item[field] || '').toLowerCase().includes(value.toLowerCase())
-          }
-          default: {
-            return false
-          }
-        }
-      `,
-        };
-    });
-    const numberFieldsFilters = (0, fields_1.getScalarFields)({ fields: model.fields, tsTypeName: 'number' }).map((f) => {
-        return {
-            match: `"${f.name}"`,
-            block: `
-        const toCompare = item[field]
-        if (typeof value !== 'number' || toCompare === null) {
-          return false
-        }
+function compare(a: ${model.typeName}, b: ${model.typeName}, field: keyof ${model.typeName}) {
+  ${compareFnBlock}
+}
 
-        switch (operator) {
-          case 'eq': {
-            return item[field] === value
-          }
-          case 'gt': {
-            return toCompare > value
-          }
-          case 'lt': {
-            return toCompare < value
-          }
-          default: {
-            return false
-          }
-        }
-      `,
-        };
-    });
-    const fnBlock = (0, ast_1.createSwitchStatement)({
-        field: 'field',
-        cases: [...stringFieldFilters, ...numberFieldsFilters],
-        defaultBlock: 'return false',
-    });
-    return `
 /**
  * Filters the given ${model.typeName} by the given field, using provided operator and value.
  */
@@ -263,52 +179,8 @@ function filterFn(
   operator: FilterOperator, 
   value: string | number
 ): boolean {
-  ${fnBlock}
+  ${filterFnBlock}
 }
 `;
 }
-/**
- * Returns a utility compare function that lets you compare two instances of a given model
- * by a given field.
- */
-function _createModelCompareFn({ model }) {
-    const stringFieldComparators = (0, fields_1.getScalarFields)({ fields: model.fields, tsTypeName: 'string' }).map((f) => {
-        return {
-            match: `"${f.name}"`,
-            block: `
-        return (a[field] || '').localeCompare(b[field] || '')
-      `,
-        };
-    });
-    const fnBlock = (0, ast_1.createSwitchStatement)({
-        field: 'field',
-        cases: [...stringFieldComparators],
-        defaultBlock: 'return 0',
-    });
-    return `
-/**
- * Compares two ${model.typeName} instances by the given field.
- */
-function compare(a: ${model.typeName}, b: ${model.typeName}, field: keyof ${model.typeName}) {
-  ${fnBlock}
-}
-
-  `;
-}
-/**
- * Converts a field to a TypeScript type definition with linked fields.
- */
-function getLinkedFieldType(f) {
-    switch (f.kind) {
-        case 'enum':
-            return `${f.name}: ${f.typeName}`;
-        case 'relation':
-            return `${f.relationFieldName}: ${f.relationToModel.typeName}`;
-        case 'id':
-            return `${f.name}: ${f.model.brandedIdType}`;
-        case 'scalar':
-            return `${f.name}: ${f.tsTypeName}`;
-        default:
-            throw new types_2.ExhaustiveSwitchCheck(f);
-    }
-}
+exports.generateModelBusinessLogicView = generateModelBusinessLogicView;

package/dist/prisma/parse.js

@@ -257,7 +257,7 @@ function parseModel({ dmmfModel, enums, models, config, }) {
         (0, error_1.throwError)(`${fieldName} is not scalar, enum nor relation.`);
     })
         .filter((field) => !isFieldIgnored({ field }));
-    const { idField, defaultField, nameField, createdAtField, updatedAtField } = validateFields({ fields, model: core });
+    const { idField, defaultField, nameField, createdAtField, updatedAtField } = getTaggedFields({ fields, model: core });
     return Object.assign(Object.assign({}, core), { idField,
         defaultField,
         nameField,
@@ -268,67 +268,60 @@ function parseModel({ dmmfModel, enums, models, config, }) {
         references: [] });
 }
 /**
- * Checks that there is exactly one id field and that there is at most one default field.
+ * Returns special fields that are tagged with special attributes.
  */
-function validateFields({ fields, model: { name } }) {
+function getTaggedFields({ fields, model: { name }, }) {
     var _a;
     let idField = undefined;
     let createdAtField = undefined;
     let updatedAtField = undefined;
-    let labelField = undefined;
     let nameField = undefined;
+    let isNameField = undefined;
     let defaultField = undefined;
     for (const field of fields) {
         const fieldName = (0, logger_1.highlight)(`${name}.${field.name}`);
         switch (field.kind) {
+            case 'id': {
+                if (idField) {
+                    (0, error_1.throwError)(`${fieldName} has multiple id fields - ${idField.name} and ${field.name}`);
+                }
+                idField = field;
+                break;
+            }
             case 'scalar':
-                if (field.name === 'name' && nameField === undefined) {
+                if (field.name === 'name') {
                     nameField = field;
                 }
+                if (field.attributes.isNameField) {
+                    if (isNameField != null) {
+                        (0, error_1.throwError)(`${fieldName} has multiple name fields - ${isNameField.name} and ${field.name}`);
+                    }
+                    isNameField = field;
+                }
                 if (field.attributes.isCreatedAt) {
-                    if (createdAtField) {
+                    if (createdAtField != null) {
                         (0, error_1.throwError)(`${fieldName} has multiple createdAt fields - ${createdAtField.name} and ${field.name}`);
                     }
                     createdAtField = field;
                 }
                 if (field.attributes.isUpdatedAt) {
-                    if (updatedAtField) {
+                    if (updatedAtField != null) {
                         (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 - ${idField.name} and ${field.name}`);
+                if (field.attributes.isDefaultField) {
+                    if (defaultField != null) {
+                        (0, error_1.throwError)(`${fieldName} has multiple default fields - ${defaultField.name} and ${field.name}`);
+                    }
+                    defaultField = field;
                 }
-                idField = field;
                 break;
             case 'relation':
                 break;
             case 'enum':
                 break;
         }
-        //handle default case
-        if (field.attributes.isDefaultField && field.kind === 'scalar') {
-            if (defaultField !== undefined) {
-                (0, error_1.throwError)(`${fieldName} has multiple default fields - ${defaultField.name} and ${field.name}`);
-            }
-            defaultField = field;
-        }
-        //handle name field
-        if (field.attributes.isNameField) {
-            if (labelField !== undefined) {
-                // 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;
-        }
     }
     if (!idField) {
         (0, error_1.throwError)(`Model ${(0, logger_1.highlight)(name)} does not have an id field`);
@@ -336,7 +329,7 @@ function validateFields({ fields, model: { name } }) {
     return {
         idField,
         defaultField,
-        nameField: (_a = labelField !== null && labelField !== void 0 ? labelField : nameField) !== null && _a !== void 0 ? _a : idField,
+        nameField: (_a = isNameField !== null && isNameField !== void 0 ? isNameField : nameField) !== null && _a !== void 0 ? _a : idField,
         createdAtField,
         updatedAtField,
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postxl/generator",
-  "version": "0.73.0",
+  "version": "0.73.1",
   "main": "./dist/generator.js",
   "typings": "./dist/generator.d.ts",
   "bin": {
@@ -41,7 +41,6 @@
     "prisma": "5.8.1"
   },
   "scripts": {
-    "test:generators": "./scripts/test-generators.sh",
     "test:setup": "./scripts/test-setup.sh",
     "test:jest": "jest",
     "test:watch": "jest --watch",