@postxl/generator 0.37.0 → 0.38.1

package/dist/generator.js

@@ -34,20 +34,36 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generate = void 0;
-const lock_1 = require("@postxl/lock");
 const generator_helper_1 = require("@prisma/generator-helper");
 const internals_1 = require("@prisma/internals");
 const prettier = __importStar(require("prettier"));
 const zod_1 = require("zod");
+const lock_1 = require("@postxl/lock");
 const react_generator_1 = require("./generators/enums/react.generator");
 const types_generator_1 = require("./generators/enums/types.generator");
+const businesslogic_actiontypes_generator_1 = require("./generators/indices/businesslogic-actiontypes.generator");
+const businesslogic_update_index_generator_1 = require("./generators/indices/businesslogic-update-index.generator");
+const businesslogic_update_module_generator_1 = require("./generators/indices/businesslogic-update-module.generator");
+const businesslogic_update_service_generator_1 = require("./generators/indices/businesslogic-update-service.generator");
+const businesslogic_view_index_generator_1 = require("./generators/indices/businesslogic-view-index.generator");
+const businesslogic_view_module_generator_1 = require("./generators/indices/businesslogic-view-module.generator");
+const businesslogic_view_service_generator_1 = require("./generators/indices/businesslogic-view-service.generator");
 const datamock_module_generator_1 = require("./generators/indices/datamock-module.generator");
+const datamocker_generator_1 = require("./generators/indices/datamocker.generator");
 const datamodule_generator_1 = require("./generators/indices/datamodule.generator");
 const dataservice_generator_1 = require("./generators/indices/dataservice.generator");
+const dispatcher_service_generator_1 = require("./generators/indices/dispatcher-service.generator");
 const emptydatabasemigration_generator_1 = require("./generators/indices/emptydatabasemigration.generator");
 const repositories_generator_1 = require("./generators/indices/repositories.generator");
+const seed_migration_generator_1 = require("./generators/indices/seed-migration.generator");
+const seed_service_generator_1 = require("./generators/indices/seed-service.generator");
+const seed_template_generator_1 = require("./generators/indices/seed-template.generator");
+const seed_template_decoder_generator_1 = require("./generators/indices/seed-template-decoder.generator");
+const seeddata_type_generator_1 = require("./generators/indices/seeddata-type.generator");
 const stubs_generator_1 = require("./generators/indices/stubs.generator");
 const types_generator_2 = require("./generators/indices/types.generator");
+const businesslogic_update_generator_1 = require("./generators/models/businesslogic-update.generator");
+const businesslogic_view_generator_1 = require("./generators/models/businesslogic-view.generator");
 const react_generator_2 = require("./generators/models/react.generator");
 const repository_generator_1 = require("./generators/models/repository.generator");
 const route_generator_1 = require("./generators/models/route.generator");
@@ -57,22 +73,6 @@ const types_generator_3 = require("./generators/models/types.generator");
 const meta_1 = require("./lib/meta");
 const types_1 = require("./lib/schema/types");
 const vfs_1 = require("./lib/vfs");
-const businesslogic_actiontypes_generator_1 = require("./generators/indices/businesslogic-actiontypes.generator");
-const businesslogic_update_index_generator_1 = require("./generators/indices/businesslogic-update-index.generator");
-const businesslogic_update_module_generator_1 = require("./generators/indices/businesslogic-update-module.generator");
-const businesslogic_update_service_generator_1 = require("./generators/indices/businesslogic-update-service.generator");
-const businesslogic_view_index_generator_1 = require("./generators/indices/businesslogic-view-index.generator");
-const businesslogic_view_module_generator_1 = require("./generators/indices/businesslogic-view-module.generator");
-const businesslogic_view_service_generator_1 = require("./generators/indices/businesslogic-view-service.generator");
-const datamocker_generator_1 = require("./generators/indices/datamocker.generator");
-const dispatcher_service_generator_1 = require("./generators/indices/dispatcher-service.generator");
-const seed_migration_generator_1 = require("./generators/indices/seed-migration.generator");
-const seed_service_generator_1 = require("./generators/indices/seed-service.generator");
-const seed_template_decoder_generator_1 = require("./generators/indices/seed-template-decoder.generator");
-const seed_template_generator_1 = require("./generators/indices/seed-template.generator");
-const seeddata_type_generator_1 = require("./generators/indices/seeddata-type.generator");
-const businesslogic_update_generator_1 = require("./generators/models/businesslogic-update.generator");
-const businesslogic_view_generator_1 = require("./generators/models/businesslogic-view.generator");
 const client_path_1 = require("./prisma/client-path");
 const parse_1 = require("./prisma/parse");
 const CONFIG_SCHEMA = zod_1.z
@@ -249,9 +249,7 @@ function generate({ models, enums, config, prismaClientPath, logger, }) {
         }
         // -------------------------------------------------------------------------
         // Add disclaimer and format.
-        const prettierConfig = yield prettier.resolveConfig(process.cwd());
         yield generated.transformUTF8Files((path, content) => `${DISCLAIMER}\n${content}`);
-        yield generated.formatUTF8Files(prettierConfig);
         const lintResult = yield generated.lintUTF8Files({
             fix: true,
             useEslintrc: false,
@@ -260,7 +258,7 @@ function generate({ models, enums, config, prismaClientPath, logger, }) {
             overrideConfig: {
                 parser: '@typescript-eslint/parser',
                 extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
-                plugins: ['@typescript-eslint'],
+                plugins: ['@typescript-eslint', 'simple-import-sort'],
                 parserOptions: {
                     sourceType: 'module',
                     ecmaVersion: 'latest',
@@ -273,6 +271,31 @@ function generate({ models, enums, config, prismaClientPath, logger, }) {
                     // The "curly" rule ensures that all if, else if, else, for, while, or do blocks are followed by a block in braces, even if it is only a single line.
                     // This will flag `if(condition) return x` and expect it to be written as `if (condition) { return x }`
                     curly: ['error', 'all'],
+                    // NOTE: Make sure this matches the definition in the template root .eslintrc.cjs file!
+                    'simple-import-sort/imports': [
+                        'error',
+                        {
+                            groups: [
+                                // Node.js builtins. You could also generate this regex if you use a `.js` config
+                                //  (e.g. `^(${require("module").builtinModules.join("|")})(/|$)`)
+                                [
+                                    '^(assert|buffer|child_process|cluster|console|constants|crypto|dgram|dns|domain|events|fs|http|https|module|net|os|path|punycode|querystring|readline|repl|stream|string_decoder|sys|timers|tls|tty|url|util|vm|zlib|freelist|v8|process|async_hooks|http2|perf_hooks)(/.*|$)',
+                                ],
+                                // Side effect imports.
+                                ['^\\u0000'],
+                                // Any packages that starts with an @ but not libraries we defined in tsconfig.json:
+                                ['^@(?!(pxl|postxl|assets|hooks|components|i18n|lib))'],
+                                // Any other package.
+                                ['^'],
+                                // Internal PXL packages.
+                                ['^(@pxl|@postxl|@assets|@hooks|@components|@i18n|@lib)(/.*|$)'],
+                                // Parent imports. Put `..` last.
+                                ['^\\.\\.(?!/?$)', '^\\.\\./?$'],
+                                // Other relative imports. Put same-folder imports and `.` last.
+                                ['^\\./(?=.*/)(?!/?$)', '^\\.(?!/?$)', '^\\./?$'],
+                            ],
+                        },
+                    ],
                 },
             },
         });
@@ -292,6 +315,8 @@ function generate({ models, enums, config, prismaClientPath, logger, }) {
         if (unfixedWarningCount === 0 && unfixableErrorCount === 0) {
             console.log(`LINT: All files linted successfully without warnings and errors!`);
         }
+        const prettierConfig = yield prettier.resolveConfig(process.cwd());
+        yield generated.formatUTF8Files(prettierConfig);
         // -------------------------------------------------------------------------
         // Merge with existing files.
         yield vfs.copy(generated, './');

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

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateDataMocker = void 0;
+const imports_1 = require("../../lib/imports");
 const meta_1 = require("../../lib/meta");
 const schema_1 = require("../../lib/schema/schema");
-const imports_1 = require("../../lib/imports");
 /**
  * Generates a generic data mocker class.
  */

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

@@ -20,11 +20,12 @@ function generateDataService({ models, meta }) {
         .join(',\n');
     const initializer = mm.map(({ meta }) => `await this.${meta.data.dataServiceName}.init()`).join('\n');
     const excelExports = mm
-        .map(({ meta }) => `${meta.data.excelExportTableName}: mapValues(this.${meta.data.dataServiceName}.getAll()),`)
+        .map(({ meta }) => `${meta.data.excelExportTableName}: mapValues(await this.${meta.data.dataServiceName}.getAll()),`)
         .join('\n');
-    const isEmptyChecks = mm.map(({ meta }) => `this.${meta.data.dataServiceName}.count() === 0`).join(' &&');
+    const isEmptyChecks = mm.map(({ meta }) => `(await this.${meta.data.dataServiceName}.count()) === 0`).join(' &&');
     return `
 import { Injectable } from '@nestjs/common'
+
 import { mapValues } from '@pxl/common'
 
 ${imports.generate()}
@@ -33,7 +34,7 @@ ${imports.generate()}
 export class DataService {
   constructor(${constructor}) {}
 
-  public prepareExcelExport() {
+  public async prepareExcelExport() {
     return {
       ${excelExports}
     }
@@ -43,7 +44,7 @@ export class DataService {
     ${initializer}
   }
 
-  public isEmpty(): boolean {
+  public async isEmpty(): Promise<boolean> {
     return (
       ${isEmptyChecks}
     )

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

@@ -41,7 +41,7 @@ function generateModelBusinessLogicView({ model, meta }) {
     for (const relation of (0, fields_1.getRelationFields)(model)) {
         const refModel = relation.relationToModel;
         const refMeta = (0, meta_1.getModelMetadata)({ model: refModel });
-        const variableGetter = `this.${viewServiceClassName}.${refMeta.businessLogic.view.serviceVariableName}.get(itemRaw.${relation.name})`;
+        const variableGetter = `await this.${viewServiceClassName}.${refMeta.businessLogic.view.serviceVariableName}.get(itemRaw.${relation.name})`;
         const variablePresenceCheck = `
       if (!${relation.relatedModelBacklinkFieldName}) {
         throw new Error(\`Could not find ${refMeta.types.typeName} with id \${itemRaw.${relation.name}} for ${model.typeName}.${relation.name}!\`)
@@ -66,8 +66,8 @@ function generateModelBusinessLogicView({ model, meta }) {
      * 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 getLinkedItem(id: ${model.brandedIdType}): ${meta.types.linkedTypeName} | null {
-      const itemRaw = this.${modelRepositoryVariableName}.get(id)
+    public async getLinkedItem(id: ${model.brandedIdType}): Promise<${meta.types.linkedTypeName} | null> {
+      const itemRaw = await this.${modelRepositoryVariableName}.get(id)
       if (!itemRaw) {
         return null
       }
@@ -107,7 +107,7 @@ export class ${meta.businessLogic.view.serviceClassName} {
    * Returns the raw ${meta.userFriendlyName} with the given id or null if it does not exist.
    * Raw: The ${meta.userFriendlyName} only contains linked Ids, not the linked items themselves.
    */
-  public get(id: ${model.brandedIdType}): ${meta.types.typeName} | null {
+  public async get(id: ${model.brandedIdType}): Promise<${meta.types.typeName} | null> {
     return this.${modelRepositoryVariableName}.get(id)
   }
 
@@ -116,14 +116,14 @@ export class ${meta.businessLogic.view.serviceClassName} {
   /**
    * Returns a map of all ${meta.userFriendlyNamePlural}.
    */
-  public getAll(): Map<${meta.types.brandedIdType}, ${model.typeName}> {
+  public async getAll(): Promise<Map<${meta.types.brandedIdType}, ${model.typeName}>> {
     return this.${modelRepositoryVariableName}.getAll()
   }
 
   /**
    * Returns a list of filtered, sorted and paginated ${meta.userFriendlyNamePlural}.
    */
-  public getList({
+  public async getList({
     filter,
     sort,
     cursor,
@@ -132,7 +132,7 @@ export class ${meta.businessLogic.view.serviceClassName} {
     sort?: { field: keyof ${model.typeName}; ascending: boolean }
     cursor?: { startRow: number; endRow: number }
   }) {
-    const items = this.data.getAllAsArray()
+    const items = await this.data.getAllAsArray()
     const filtered = !filter
       ? items
       : items.filter((item) => filterFn(item, filter.field, filter.operator, filter.value))

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

@@ -109,33 +109,33 @@ export class ${meta.data.repositoryClassName} implements Repository<${model.type
 
   ${mainBlocks.deleteAllCode}
 
-  public get(id: ${model.brandedIdType} | null): ${model.typeName} | null {
+  public async get(id: ${model.brandedIdType} | null): Promise<${model.typeName} | null> {
     if (id === null) { 
-      return null
+      return Promise.resolve(null)
     }
-    return this.data.get(id) ?? null
+    return Promise.resolve(this.data.get(id) ?? null)
   }
 
-  public getAll(): Map<${model.brandedIdType}, ${model.typeName}> {
-    return new Map(this.data)
+  public async getAll(): Promise<Map<${model.brandedIdType}, ${model.typeName}>> {
+    return Promise.resolve(new Map(this.data))
   }
 
-  public getAllAsArray(): ${model.typeName}[] {
-    return Array.from(this.data.values())
+  public async getAllAsArray(): Promise<${model.typeName}[]> {
+    return Promise.resolve(Array.from(this.data.values()))
   }
 
   ${indexBlocks.getterFunctions.join('\n')}
   
-  public filter(predicate: (item: ${model.typeName}) => boolean): ${model.typeName}[] {
-    return this.getAllAsArray().filter(predicate)
+  public async filter(predicate: (item: ${model.typeName}) => boolean): Promise<${model.typeName}[]> {
+    return (await this.getAllAsArray()).filter(predicate)
   }
 
-  public findFirst(predicate: (item: ${model.typeName}) => boolean): ${model.typeName} | null {
-    return this.getAllAsArray().find(predicate) ?? null
+  public async findFirst(predicate: (item: ${model.typeName}) => boolean): Promise<${model.typeName} | null> {
+    return (await this.getAllAsArray()).find(predicate) ?? null
   }
 
-  public count(): number {
-    return this.data.size
+  public async count(): Promise<number> {
+    return Promise.resolve(this.data.size)
   }
   
   ${mainBlocks.createCode}
@@ -313,7 +313,7 @@ function _generateMainBuildingBlocks_InMemoryOnly({ model, meta, blocks, }) {
       public async update(
         { item, execution }: ${methodTypeSignatures.update.parameters[0]}
       ): ${methodTypeSignatures.update.returnType} {
-        const existingItem = this.get(item.id)
+        const existingItem = await this.get(item.id)
     
         if (!existingItem) {
           throw new Error(\`Could not update ${meta.userFriendlyName} with id \${item.id}. Not found!\`)
@@ -363,7 +363,7 @@ function _generateMainBuildingBlocks_InMemoryOnly({ model, meta, blocks, }) {
       public async upsert(
         { item, execution }: ${methodTypeSignatures.upsert.parameters[0]}
       ): ${methodTypeSignatures.upsert.returnType} {
-        const existingItem = item.${model.idField.name} ? this.get(item.${model.idField.name}) : null
+        const existingItem = item.${model.idField.name} ? (await this.get(item.${model.idField.name})) : null
         if (existingItem) {
           return this.update({ item: item as ${meta.types.dto.update}, execution })
         } else {
@@ -391,7 +391,7 @@ function _generateMainBuildingBlocks_InMemoryOnly({ model, meta, blocks, }) {
       public async delete(
         { id, execution }: ${methodTypeSignatures.delete.parameters[0]}
       ): ${methodTypeSignatures.delete.returnType} {
-        const existingItem = this.get(id)
+        const existingItem = await this.get(id)
         if (!existingItem) {
           throw new Error(\`Could not delete ${model.typeName} with id \${id}. Not found!\`)
         }
@@ -599,7 +599,7 @@ function generateMainBuildingBlocks_InDatabase({ model, meta, imports, blocks, }
       public async update(
         { item, execution }: ${methodTypeSignatures.update.parameters[0]}
       ): ${methodTypeSignatures.update.returnType} {
-        const existingItem = this.get(item.${idField.name})
+        const existingItem = await this.get(item.${idField.name})
         if (!existingItem) {
           throw new Error(\`Could not update ${meta.userFriendlyName} with id \${item.id}. Not found!\`)
         }
@@ -662,7 +662,7 @@ function generateMainBuildingBlocks_InDatabase({ model, meta, imports, blocks, }
       public async upsert(
         { item, execution }: ${methodTypeSignatures.upsert.parameters[0]}
       ): ${methodTypeSignatures.upsert.returnType} {
-        const existingItem = item.${model.idField.name} ? this.get(item.${model.idField.name}) : null
+        const existingItem = item.${model.idField.name} ? (await this.get(item.${model.idField.name})) : null
         if (existingItem) {
           return this.update({ item: item as ${meta.types.dto.update}, execution })
         } else {
@@ -690,7 +690,7 @@ function generateMainBuildingBlocks_InDatabase({ model, meta, imports, blocks, }
       public async delete(
         { id, execution }: ${methodTypeSignatures.delete.parameters[0]}
       ): ${methodTypeSignatures.delete.returnType} {
-        const existingItem = this.get(id)
+        const existingItem = await this.get(id)
         if (!existingItem) {
           throw new Error(\`Could not delete ${model.typeName} with id \${id}. Not found!\`)
         }
@@ -1098,28 +1098,28 @@ function generateRelationsBlocks({ model, imports, }) {
       /** 
        * Function to retrieve all ${(0, string_1.pluralize)(model.name)} that are related to a ${r.name}
        */
-      public ${fieldMeta.getByForeignKeyMethodFnName}(
+      public async ${fieldMeta.getByForeignKeyMethodFnName}(
         id: ${relationModelMeta.types.brandedIdType}
-      ): Map<${model.brandedIdType}, ${model.typeName}> {
+      ): Promise<Map<${model.brandedIdType}, ${model.typeName}>> {
         const result = this.${r.name}Map.get(id)
         if (!result) {
-          return new Map()
+          return Promise.resolve(new Map<${model.brandedIdType}, ${model.typeName}>())
         }
-        return new Map(result)
+        return Promise.resolve(new Map(result))
       }
 
       /** 
        * Function to retrieve all ${model.brandedIdType}s that are related to a ${r.name}
        */
-      public ${fieldMeta.getByForeignKeyIdsMethodFnName}(
+      public async ${fieldMeta.getByForeignKeyIdsMethodFnName}(
         id: ${relationModelMeta.types.brandedIdType}
-      ): ${model.brandedIdType}[] {
+      ): Promise<${model.brandedIdType}[]> {
         const s = this.${r.name}Map.get(id)
         if (!s) {
-          return []
+          return Promise.resolve([])
         }
         
-        return Array.from(s.keys())
+        return Promise.resolve(Array.from(s.keys()))
       }`);
         result.setCode.push(`
       ${!r.isRequired ? `if (item.${r.name}) {` : ''}

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

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateRoutesIndex = exports.generateRoute = void 0;
-const meta_1 = require("../../lib/meta");
 const imports_1 = require("../../lib/imports");
+const meta_1 = require("../../lib/meta");
 /**
  * Generates TRPC route for a given model.
  */

package/dist/lib/vfs.d.ts

@@ -1,6 +1,6 @@
 import { ESLint } from 'eslint';
 import * as prettier from 'prettier';
-import { VirtualFS as BaseVirtualFS, PathUtils } from '@postxl/lock';
+import { PathUtils, VirtualFS as BaseVirtualFS } from '@postxl/lock';
 type FileLintResult = {
     fixableErrorCount: number;
     errorCount: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postxl/generator",
-  "version": "0.37.0",
+  "version": "0.38.1",
   "main": "./dist/generator.js",
   "typings": "./dist/generator.d.ts",
   "bin": {
@@ -21,6 +21,7 @@
     "@typescript-eslint/parser": "^6.10.0",
     "@typescript-eslint/utils": "^6.10.0",
     "eslint": "^8.53.0",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
     "exceljs": "^4.3.0",
     "fast-glob": "^3.2.12",
     "prettier": "^3.0.3",