@postxl/generator 0.27.2 → 0.27.3

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

@@ -6,6 +6,7 @@ const meta_1 = require("../../lib/meta");
 /**
  * Generates a business Logic module class.
  */
+// TODO: https://github.com/PostXL/PostXL/issues/347
 function generateBusinessLogicModule({ models, meta }) {
     const mm = models
         .map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }))

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

@@ -6,6 +6,7 @@ const meta_1 = require("../../lib/meta");
 /**
  * Generates the business logic service class.
  */
+// TODO: https://github.com/PostXL/PostXL/issues/347
 function generateBusinessLogicService({ models, meta }) {
     const mm = models
         .map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }))
@@ -23,12 +24,12 @@ function generateBusinessLogicService({ models, meta }) {
     return `
   import { Inject, Injectable, forwardRef } from '@nestjs/common'
 
-${imports.generate()}
+  ${imports.generate()}
 
-@Injectable()
-export class ${meta.businessLogic.serviceClassName} {
-  constructor(${constructor}) {}
-}
-`;
+  @Injectable()
+  export class ${meta.businessLogic.serviceClassName} {
+    constructor(${constructor}) {}
+  }
+  `;
 }
 exports.generateBusinessLogicService = generateBusinessLogicService;

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

@@ -30,6 +30,7 @@ const Types = __importStar(require("../../lib/schema/types"));
 /**
  * Generates a mocking class
  */
+// TODO: https://github.com/PostXL/PostXL/issues/347
 function generateDataMockModule({ models, meta }) {
     const mm = models.map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }));
     const imports = imports_1.ImportsGenerator.from(meta.data.dataMockModuleFilePath)

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

@@ -30,6 +30,7 @@ const Types = __importStar(require("../../lib/schema/types"));
 /**
  * Generates a data module class.
  */
+// TODO: https://github.com/PostXL/PostXL/issues/347
 function generateDataModule({ models, meta }) {
     const mm = models.map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }));
     const imports = imports_1.ImportsGenerator.from(meta.data.dataModuleFilePath)

package/dist/generators/indices/repositories.generator.d.ts

@@ -1,7 +1,7 @@
 import { SchemaMetaData } from '../../lib/meta';
 import { Model } from '../../lib/schema/schema';
 /**
- * Generates an index file that exports all stubs.
+ * Generates an index file that exports all repository stubs.
  */
 export declare function generateRepositoriesIndex({ models, meta }: {
     models: Model[];

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

@@ -5,7 +5,7 @@ const exports_1 = require("../../lib/exports");
 const imports_1 = require("../../lib/imports");
 const meta_1 = require("../../lib/meta");
 /**
- * Generates an index file that exports all stubs.
+ * Generates an index file that exports all repository stubs.
  */
 function generateRepositoriesIndex({ models, meta }) {
     const exports = exports_1.ExportsGenerator.from(meta.data.repositoriesIndexFilePath);

package/dist/generators/indices/seed-template-decoder.generator.d.ts

@@ -1,7 +1,7 @@
 import { SchemaMetaData } from '../../lib/meta';
 import { Model } from '../../lib/schema/schema';
 /**
- * Creates a decoder for the Seed Excel template
+ * Creates a decoder for the Seed Excel template.
  */
 export declare function generateSeedTemplateDecoder({ models, meta }: {
     models: Model[];

package/dist/generators/indices/seed-template-decoder.generator.js

@@ -8,7 +8,7 @@ const types_2 = require("../../lib/types");
 // TODO: Remove hardcoded path that seems to be reused in multiple places!
 const PXL_COMMON = (0, types_1.toPath)('@pxl/common');
 /**
- * Creates a decoder for the Seed Excel template
+ * Creates a decoder for the Seed Excel template.
  */
 function generateSeedTemplateDecoder({ models, meta }) {
     const imports = imports_1.ImportsGenerator.from(meta.seed.templateDecoderFilePath);

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

@@ -28,9 +28,11 @@ const imports_1 = require("../../lib/imports");
 const meta_1 = require("../../lib/meta");
 const fields_1 = require("../../lib/schema/fields");
 const Types = __importStar(require("../../lib/schema/types"));
+const repository_generator_1 = require("./repository.generator");
 /**
  * Generates business logic for a given model.
  */
+// TODO: https://github.com/PostXL/PostXL/issues/347
 function generateModelBusinessLogic({ model, meta }) {
     const schemaMeta = (0, meta_1.getSchemaMetadata)({ config: model.schemaConfig });
     const imports = imports_1.ImportsGenerator.from(meta.businessLogic.serviceFilePath);
@@ -114,6 +116,7 @@ function generateModelBusinessLogic({ model, meta }) {
       return item
     }
   `;
+    const methodTypeSignatures = (0, repository_generator_1.getRepositoryMethodsTypeSignatures)({ model, meta });
     // prettier-ignore
     return `
 import { Inject, Injectable, forwardRef } from '@nestjs/common'
@@ -170,14 +173,14 @@ export class ${meta.businessLogic.serviceClassName} {
   /**
    * Creates a new ${meta.userFriendlyName}.
    */
-  public async create(item: Omit<${model.typeName}, '${model.idField.name}'> & Partial<{${model.idField.name}: ${model.idField.unbrandedTypeName}}>): Promise<${model.typeName}> {
+  public async create(item: ${methodTypeSignatures.create.parameters[0]}): ${methodTypeSignatures.create.returnType} {
     return this.${modelRepositoryVariableName}.create(item)
   }
 
   /**
    * Updates the given ${meta.userFriendlyName}.
    */
-  public async update(item: Partial<${model.typeName}> & {id: ${model.brandedIdType}}): Promise<${model.typeName}> {
+  public async update(item: ${methodTypeSignatures.update.parameters[0]}): ${methodTypeSignatures.update.returnType} {
     return this.${modelRepositoryVariableName}.update(item)
   }
 
@@ -187,7 +190,7 @@ export class ${meta.businessLogic.serviceClassName} {
    * Note: This does NOT delete any linked items. 
    * If the items is a dependency of another item, the deletion will fail!
    */
-  public async delete(id: ${model.brandedIdType}): Promise<void> {
+  public async delete(id: ${methodTypeSignatures.delete.parameters[0]}): ${methodTypeSignatures.delete.returnType} {
     return this.${modelRepositoryVariableName}.delete(id)
   }
 }

package/dist/generators/models/repository.generator.d.ts

@@ -8,9 +8,39 @@ export declare function generateRepository({ model, meta }: {
     meta: ModelMetaData;
 }): string;
 /**
- * Generates a mock repository data structure for a given model: same a repository, but in memory only
+ * Generates a mock repository data structure for a given model: same a repository, but in memory only.
  */
 export declare function generateMockRepository({ model: modelSource, meta: metaSource, }: {
     model: Model;
     meta: ModelMetaData;
 }): string;
+type FnSignature = {
+    /**
+     * A list of ordered TypeScript types where the first type in the list corresponds to the type of the
+     * first parameter and so on. Note that the parameters don't contain names, only types.
+     *
+     * @example
+     *
+     * ```
+     * function foo(a: string, b: number, c: boolean) {}
+     * // ['string', 'number', 'boolean']
+     * ```
+     */
+    parameters: string[];
+    /**
+     * The return type of the function.
+     */
+    returnType: string;
+};
+/**
+ * Returns a collection of type signatures for the repository methods of a given model.
+ */
+export declare function getRepositoryMethodsTypeSignatures({ model, meta }: {
+    model: Model;
+    meta: ModelMetaData;
+}): {
+    create: FnSignature;
+    update: FnSignature;
+    delete: FnSignature;
+};
+export {};

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateMockRepository = exports.generateRepository = void 0;
+exports.getRepositoryMethodsTypeSignatures = exports.generateMockRepository = exports.generateRepository = void 0;
 const imports_1 = require("../../lib/imports");
 const meta_1 = require("../../lib/meta");
 const fields_1 = require("../../lib/schema/fields");
@@ -210,7 +210,7 @@ export class ${meta.data.repositoryClassName} implements Repository<${model.type
 }
 exports.generateRepository = generateRepository;
 /**
- * Generates a mock repository data structure for a given model: same a repository, but in memory only
+ * Generates a mock repository data structure for a given model: same a repository, but in memory only.
  */
 function generateMockRepository({ model: modelSource, meta: metaSource, }) {
     // We re-use the repository block, but we change the meta data to use the mock repository name and the model to be in memory only
@@ -223,6 +223,7 @@ exports.generateMockRepository = generateMockRepository;
  * Generates the main building blocks of the repository for in-memory model.
  */
 function _generateMainBuildingBlocks_InMemoryOnly({ model, meta, blocks, }) {
+    const methodTypeSignatures = getRepositoryMethodsTypeSignatures({ model, meta });
     return {
         constructorCode: '',
         initCode: `
@@ -248,7 +249,7 @@ function _generateMainBuildingBlocks_InMemoryOnly({ model, meta, blocks, }) {
         createCode: `  
       // Non-mocked version is async - so we keep type-compatible signatures for create() and createWithId() 
       // eslint-disable-next-line @typescript-eslint/require-await, @typescript-eslint/no-unused-vars
-      public async create(item: ${blocks.idBlocks.verifyFunctionParameterType}): Promise<${model.typeName}> {    
+      public async create(item: ${methodTypeSignatures.create.parameters[0]}): ${methodTypeSignatures.create.returnType} {  
         const newItem = await Promise.resolve(this.verifyItem(item))
     
         this.set(newItem)
@@ -266,10 +267,9 @@ function _generateMainBuildingBlocks_InMemoryOnly({ model, meta, blocks, }) {
         
         return newItems
       }`,
+        // prettier-ignore
         updateCode: `
-      public async update(item: Partial<${model.typeName}> & { 
-        id: ${model.brandedIdType}
-      }): Promise<${model.typeName}> {
+      public async update(item: ${methodTypeSignatures.update.parameters[0]}): ${methodTypeSignatures.update.returnType} {
         const existingItem = this.get(item.id)
     
         if (!existingItem) {
@@ -289,7 +289,7 @@ function _generateMainBuildingBlocks_InMemoryOnly({ model, meta, blocks, }) {
         return newItem
       }`,
         deleteCode: `
-      public async delete(id: ${model.brandedIdType}): Promise<void> {
+      public async delete(id: ${methodTypeSignatures.delete.parameters[0]}): ${methodTypeSignatures.delete.returnType} {
         const existingItem = this.get(id)
         if (!existingItem) {
           throw new Error(\`Could not delete ${model.typeName} with id \${id}. Not found!\`)
@@ -322,6 +322,7 @@ function generateMainBuildingBlocks_InDatabase({ model, meta, imports, blocks, }
         .filter((s) => s != null)
         .map((part) => `"${part}"`)
         .join('.');
+    const methodTypeSignatures = getRepositoryMethodsTypeSignatures({ model, meta });
     return {
         constructorCode: `constructor(protected db: DbService) {}`,
         initCode: `
@@ -371,7 +372,7 @@ function generateMainBuildingBlocks_InDatabase({ model, meta, imports, blocks, }
       }
     `,
         createCode: `
-      public async create(item: ${blocks.idBlocks.verifyFunctionParameterType}): Promise<${model.typeName}> {    
+      public async create(item: ${methodTypeSignatures.create.parameters[0]}): ${methodTypeSignatures.create.returnType} {    
         const newItem = this.${decoderFunctionName}(
           await this.db.${meta.data.repository.getMethodFnName}.create({
             data: this.toCreateItem(this.verifyItem(item)),
@@ -395,7 +396,7 @@ function generateMainBuildingBlocks_InDatabase({ model, meta, imports, blocks, }
       }`,
         // prettier-ignore
         updateCode: `
-      public async update(item: Partial<${model.typeName}> & { ${idField.name}: ${model.brandedIdType} }): Promise<${model.typeName}> {
+      public async update(item: ${methodTypeSignatures.update.parameters[0]}): ${methodTypeSignatures.update.returnType} {
         const existingItem = this.get(item.${idField.name})
         if (!existingItem) {
           throw new Error(\`Could not update ${meta.userFriendlyName} with id \${item.id}. Not found!\`)
@@ -427,7 +428,7 @@ function generateMainBuildingBlocks_InDatabase({ model, meta, imports, blocks, }
         return newItem
       }`,
         deleteCode: `
-      public async delete(id: ${model.brandedIdType}): Promise<void> {
+      public async delete(id: ${methodTypeSignatures.delete.parameters[0]}): ${methodTypeSignatures.delete.returnType} {
         const existingItem = this.get(id)
         if (!existingItem) {
           throw new Error(\`Could not delete ${model.typeName} with id \${id}. Not found!\`)
@@ -449,6 +450,10 @@ function generateMainBuildingBlocks_InDatabase({ model, meta, imports, blocks, }
       }`,
     };
 }
+/**
+ * Generates code chunks responsible for verifying the ID validity of a model instance and generating the id
+ * value of a model with auto-generated id.
+ */
 function generateIdBlocks({ model, meta }) {
     const idField = model.idField;
     if (!idField.isGenerated) {
@@ -462,6 +467,29 @@ function generateIdBlocks({ model, meta }) {
     }
     throw new Error(`Repository block only supports Id generation for number and strings! Found ${idField.schemaType} for model ${model.name} instead!`);
 }
+/**
+ * Returns a collection of type signatures for the repository methods of a given model.
+ */
+// NOTE: We export this function as an interface simplification to the repository generator. Internally, we
+//   use the same functions as the ones used in this function which we don't want to expose.
+function getRepositoryMethodsTypeSignatures({ model, meta }) {
+    const { verifyFunctionParameterType } = generateIdBlocks({ model, meta });
+    return {
+        create: {
+            parameters: [verifyFunctionParameterType],
+            returnType: `Promise<${model.typeName}>`,
+        },
+        update: {
+            parameters: [`Partial<${model.typeName}> & { ${model.idField.name}: ${model.brandedIdType} }`],
+            returnType: `Promise<${model.typeName}>`,
+        },
+        delete: {
+            parameters: [model.brandedIdType],
+            returnType: `Promise<void>`,
+        },
+    };
+}
+exports.getRepositoryMethodsTypeSignatures = getRepositoryMethodsTypeSignatures;
 /**
  * Generates the id block code chunks for a model that requires an ID field to be manually
  * supplied to the create function.

package/package.json

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