@postxl/generator 0.54.0 → 0.56.0

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

@@ -11,26 +11,9 @@ const jsdoc_1 = require("../../lib/utils/jsdoc");
  * Generates types for a given model.
  */
 function generateModelTypes({ model, meta }) {
-    var _a, _b;
+    var _a;
     const idField = model.idField;
     const imports = imports_1.ImportsGenerator.from(meta.types.filePath);
-    let hasLinkedItems = false;
-    for (const relation of (0, fields_1.getRelationFields)(model)) {
-        if (relation.relationToModel.typeName === model.typeName) {
-            continue;
-        }
-        const refModel = relation.relationToModel;
-        const refMeta = (0, meta_1.getModelMetadata)({ model: refModel });
-        imports.addImport({
-            items: [refMeta.types.toBrandedIdTypeFnName],
-            from: refMeta.types.filePath,
-        });
-        imports.addTypeImport({
-            items: [refModel.brandedIdType, refMeta.types.typeName],
-            from: refMeta.types.filePath,
-        });
-        hasLinkedItems = true;
-    }
     for (const f of (0, fields_1.getEnumFields)(model)) {
         const refEnumMeta = (0, meta_1.getEnumMetadata)({ enumerator: f.enumerator });
         imports.addTypeImport({
@@ -44,30 +27,33 @@ function generateModelTypes({ model, meta }) {
         from: schemaMeta.types.dto.path,
     });
     const decoderNames = meta.types.zodDecoderFnNames;
+    for (const relation of (0, fields_1.getRelationFields)(model)) {
+        if (relation.relationToModel.typeName === model.typeName) {
+            // NOTE: All type definitions are already present in this file for this model.
+            continue;
+        }
+        const refMeta = (0, meta_1.getModelMetadata)({ model: relation.relationToModel });
+        imports.addImport({ from: refMeta.types.filePath, items: [refMeta.types.toBrandedIdTypeFnName] });
+        imports.addTypeImport({ from: refMeta.types.filePath, items: [relation.relationToModel.brandedIdType] });
+    }
     return /* ts */ `
 import { z } from 'zod'
 
 ${imports.generate()}
 
-${(0, jsdoc_1.toJsDocComment)((_b = (_a = model.description) === null || _a === void 0 ? void 0 : _a.split('\n')) !== null && _b !== void 0 ? _b : [])}
+${(0, jsdoc_1.toJsDocComment)((_a = model.description) === null || _a === void 0 ? void 0 : _a.split('\n'))}
 export type ${meta.types.typeName} = { 
   ${model.fields
-        .map((f) => `
-      ${getFieldComment(f)}
-      ${f.name}: ${getFieldType(f)}${f.isRequired ? '' : ' | null'}`)
+        .map((f) => {
+        return `
+        ${(0, jsdoc_1.getFieldComment)(f)}
+        ${f.name}: ${getFieldType(f)}${f.isRequired ? '' : ' | null'}
+      `;
+    })
         .join('\n')}
 }
 
-${!hasLinkedItems
-        ? ``
-        : `
-export type ${meta.types.linkedTypeName} = { 
-  ${model.fields
-            .map((f) => `
-${getFieldComment(f)}
-${getLinkedFieldType(f)}${f.isRequired ? '' : ' | null'}`)
-            .join('\n')}
-}`}
+
 
 /**
  * Branded Id type that should be used to identify an instance of a ${meta.userFriendlyName}.
@@ -95,31 +81,6 @@ export const ${decoderNames.fromDatabase} = z.object({
   ${model.fields.map((field) => `${field.name}: z.${(0, zod_1.getZodDecoderDefinition)({ field })}`).join(',')}
 })
 
-/**
- * Zod decoder for validating the create input of a ${meta.userFriendlyName}.
- */
-export const ${decoderNames.createObject} = z.object({
-  ${model.fields
-        .filter((f) => !f.attributes.isReadonly)
-        .map((field) => `${field.name}: z.${(0, zod_1.getZodDecoderDefinition)({ field })}`)
-        .join(',')}
-})
-
-/**
- * Zod decoder for validating the update input of a ${meta.userFriendlyName} .
- */
-export const ${decoderNames.updateObject} = z.object({
-  ${model.fields
-        .filter((f) => !f.attributes.isReadonly || f.kind === 'id')
-        .map((field) => `${field.name}: z.${(0, zod_1.getZodDecoderDefinition)({ field, allowAnyOptionalField: field.kind !== 'id' })}`)
-        .join(',')}
-})
-
-/**
- * Zod decoder for validating the upsert input of a ${meta.userFriendlyName} .
- */
-export const ${decoderNames.upsertObject} = z.union([${decoderNames.updateObject}, ${decoderNames.createObject}])
-
 /**
  * Data transfer object for creating a new ${meta.userFriendlyName} instance.
  */
@@ -137,31 +98,6 @@ export type ${meta.types.dto.upsert} = ${schemaMeta.types.dto.upsert}<${meta.typ
 `;
 }
 exports.generateModelTypes = generateModelTypes;
-function getFieldComment(f) {
-    const examples = getFieldExamples(f);
-    let comment = '';
-    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`;
-    }
-    if (comment === '') {
-        return '';
-    }
-    return `
-/**
-${comment}*/`;
-}
-function getFieldExamples(f) {
-    if (!f.attributes.examples) {
-        return undefined;
-    }
-    return `Examples: ${f.attributes.examples.map((e) => `"${e}"`).join(', ')}`;
-}
 /**
  * Converts a field to a TypeScript type definition.
  */
@@ -179,20 +115,3 @@ function getFieldType(f) {
             throw new types_1.ExhaustiveSwitchCheck(f);
     }
 }
-/**
- * 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.relatedModelBacklinkFieldName}: ${f.relationToModel.typeName}`;
-        case 'id':
-            return `${f.name}: ${f.model.brandedIdType}`;
-        case 'scalar':
-            return `${f.name}: ${f.tsTypeName}`;
-        default:
-            throw new types_1.ExhaustiveSwitchCheck(f);
-    }
-}

package/dist/lib/exports.d.ts

@@ -34,6 +34,10 @@ export declare class ExportsGenerator {
      * NOTE: This should only be used when the generator is a root generator.
      */
     exportEverythingFromFile(file: string): ExportsGenerator;
+    /**
+     * Adds a given file to the collection of files we're exporting a selection from.
+     */
+    exportSelectionFromPath(from: Types.FilePath, elements: Types.ImportableTypes[]): ExportsGenerator;
     /**
      * Returns the TypeScript export statements.
      */

package/dist/lib/exports.js

@@ -8,7 +8,7 @@ const file_1 = require("./utils/file");
 class ExportsGenerator {
     constructor({ path, isRoot }) {
         this._path = path;
-        this._exports = new Set();
+        this._exports = new Map();
         this.isRoot = isRoot !== null && isRoot !== void 0 ? isRoot : false;
     }
     /**
@@ -31,7 +31,7 @@ class ExportsGenerator {
             throw new Error(`Cannot use "exportEverythingFromPath" on a root generator.`);
         }
         const resolvedPath = (0, file_1.getRelativePath)({ from: this._path, to: from });
-        this._exports.add(resolvedPath);
+        this._exports.set(resolvedPath, { kind: 'wildcard' });
         return this;
     }
     /**
@@ -43,18 +43,48 @@ class ExportsGenerator {
         if (!this.isRoot) {
             throw new Error(`Cannot use "exportEverythingFromFile" on a non-root generator.`);
         }
-        this._exports.add(file);
+        this._exports.set(file, { kind: 'wildcard' });
+        return this;
+    }
+    /**
+     * Adds a given file to the collection of files we're exporting a selection from.
+     */
+    exportSelectionFromPath(from, elements) {
+        if (this.isRoot) {
+            throw new Error(`Cannot use "exportSelectionFromPath" on a root generator.`);
+        }
+        const resolvedPath = (0, file_1.getRelativePath)({ from: this._path, to: from });
+        const _existing = this._exports.get(resolvedPath);
+        // NOTE: If we already export everything, we don't need to do anything.
+        if ((_existing === null || _existing === void 0 ? void 0 : _existing.kind) === 'wildcard') {
+            return this;
+        }
+        if ((_existing === null || _existing === void 0 ? void 0 : _existing.kind) === 'selection') {
+            for (const element of elements) {
+                _existing.elements.add(element);
+            }
+            return this;
+        }
+        this._exports.set(resolvedPath, { kind: 'selection', elements: new Set(elements) });
         return this;
     }
     /**
      * Returns the TypeScript export statements.
      */
     generate() {
-        const stetements = [...this._exports.values()]
-            .sort((a, b) => a.localeCompare(b))
-            .map((path) => `export * from '${path}'`)
-            .join('\n');
-        return stetements;
+        const statements = [];
+        const exports = Array.from(this._exports.entries()).sort((a, b) => a[0].localeCompare(b[0]));
+        for (const [_path, _export] of exports) {
+            switch (_export.kind) {
+                case 'wildcard':
+                    statements.push(`export * from '${_path}'`);
+                    break;
+                case 'selection':
+                    statements.push(`export { ${Array.from(_export.elements).join(', ')} } from '${_path}'`);
+                    break;
+            }
+        }
+        return statements.join('\n');
     }
 }
 exports.ExportsGenerator = ExportsGenerator;

package/dist/lib/meta.d.ts

@@ -107,7 +107,7 @@ export type SchemaMetaData = {
              */
             mock: Types.ClassName;
         };
-        dispatcherService: {
+        dispatcher: {
             /**
              * Path to the file containing the dispatcher service class definition.
              */
@@ -116,6 +116,14 @@ export type SchemaMetaData = {
              * The name of the dispatcher service class.
              */
             class: Types.ClassName;
+            /**
+             * The name of the interface that indicates a service can dispatch actions.
+             */
+            interface: Types.ClassName;
+            /**
+             * The name of a util type that is used to create a dictionary of action payloads and results from the action descriptions.
+             */
+            actionMethod: Types.TypeName;
         };
     };
     /**
@@ -917,50 +925,17 @@ export type ModelMetaData = {
              */
             actionModelDiscriminantName: Types.VariableName;
             /**
-             * Name of the model's aggregated action type. (e.g. `Action_Aggregation`)
-             */
-            actionName: Types.VariableName;
-            /**
-             * Name of the model's aggregated action result type. (e.g. `ActionResult_Aggregation`)
-             */
-            actionResultName: Types.VariableName;
-            /**
-             * The model's name that is used to build the different action types.
-             * (e.g. `Aggregation` which will be used to build `Action_Aggregation_Create`)
-             */
-            actionNameModelPart: Types.VariableName;
-            /**
-             * Name of the function that creates a `create` action for the model (e.g. `createActionAggregationCreate`)
-             */
-            createActionFunctionNameCreate: Types.FunctionName;
-            /**
-             * Name of the function that creates a `createMany` action for the model (e.g. `createActionAggregationCreateMany`)
-             */
-            createActionFunctionNameCreateMany: Types.FunctionName;
-            /**
-             * Name of the function that creates a `update` action for the model (e.g. `createActionAggregationUpdate`)
-             */
-            createActionFunctionNameUpdate: Types.FunctionName;
-            /**
-             * Name of the function that creates a `updateMany` action for the model (e.g. `createActionAggregationUpdateMany`)
-             */
-            createActionFunctionNameUpdateMany: Types.FunctionName;
-            /**
-             * Name of the function that creates a `upsert` action for the model (e.g. `createActionAggregationUpsert`)
-             */
-            createActionFunctionNameUpsert: Types.FunctionName;
-            /**
-             * Name of the function that creates a `upsertMany` action for the model (e.g. `createActionAggregationUpsertMany`)
+             * The name of the function that decodes a Create object to a fully typed object, e.g. `aggregationCreateDecoder`.
              */
-            createActionFunctionNameUpsertMany: Types.FunctionName;
+            zodCreateObject: Types.FunctionName;
             /**
-             * Name of the function that creates a `delete` action for the model (e.g. `createActionAggregationDelete`)
+             * The name of the function that decodes an Update object to a fully typed object, e.g. `aggregationUpdateDecoder`.
              */
-            createActionFunctionNameDelete: Types.FunctionName;
+            zodUpdateObject: Types.FunctionName;
             /**
-             * Name of the function that creates a `deleteMany` action for the model (e.g. `createActionAggregationDeleteMany`)
+             * The name of the function that decodes an Upsert object to a fully typed object, e.g. `aggregationUpsertDecoder`.
              */
-            createActionFunctionNameDeleteMany: Types.FunctionName;
+            zodUpsertObject: Types.FunctionName;
         };
         /**
          * Name by which the business logic service exposes the data service.
@@ -1120,18 +1095,6 @@ export type ModelMetaData = {
              * The name of the function that decodes a source (database) object to a fully typed object, e.g. `aggregationDatabaseDecoder`.
              */
             fromDatabase: Types.FunctionName;
-            /**
-             * The name of the function that decodes a Create object to a fully typed object, e.g. `aggregationCreateDecoder`.
-             */
-            createObject: Types.FunctionName;
-            /**
-             * The name of the function that decodes an Update object to a fully typed object, e.g. `aggregationUpdateDecoder`.
-             */
-            updateObject: Types.FunctionName;
-            /**
-             * The name of the function that decodes an Upsert object to a fully typed object, e.g. `aggregationUpsertDecoder`.
-             */
-            upsertObject: Types.FunctionName;
         };
         /**
          * Type definitions for the different Data Transfer Objects (DTOs).

package/dist/lib/meta.js

@@ -86,9 +86,11 @@ function getSchemaMetadata({ config }) {
                 class: Types.toClassName(`ActionExecution`),
                 mock: Types.toClassName(`MockActionExecution`),
             },
-            dispatcherService: {
+            dispatcher: {
                 filePath: Types.toPath(`${config.paths.actionsPath}dispatcher.service`),
                 class: Types.toClassName(`DispatcherService`),
+                interface: Types.toClassName(`IDispatcher`),
+                actionMethod: Types.toTypeName(`ActionMethod`),
             },
         },
         businessLogic: {
@@ -335,17 +337,9 @@ function getModelMetadata({ model }) {
                 serviceFileName: Types.toFileName(`${camelCase}.update.service`),
                 serviceFilePath: Types.toPath(`${config.paths.businessLogicPath}update/${camelCase}.update.service`),
                 actionModelDiscriminantName: Types.toVariableName(`${camelCase}`),
-                actionName: Types.toVariableName(`Action_${PascalCase}`),
-                actionNameModelPart: Types.toVariableName(`${PascalCase}`),
-                actionResultName: Types.toVariableName(`ActionResult_${PascalCase}`),
-                createActionFunctionNameCreate: Types.toFunctionName(`createAction${PascalCase}Create`),
-                createActionFunctionNameCreateMany: Types.toFunctionName(`createAction${PascalCase}CreateMany`),
-                createActionFunctionNameUpdate: Types.toFunctionName(`createAction${PascalCase}Update`),
-                createActionFunctionNameUpdateMany: Types.toFunctionName(`createAction${PascalCase}UpdateMany`),
-                createActionFunctionNameUpsert: Types.toFunctionName(`createAction${PascalCase}Upsert`),
-                createActionFunctionNameUpsertMany: Types.toFunctionName(`createAction${PascalCase}UpsertMany`),
-                createActionFunctionNameDelete: Types.toFunctionName(`createAction${PascalCase}Delete`),
-                createActionFunctionNameDeleteMany: Types.toFunctionName(`createAction${PascalCase}DeleteMany`),
+                zodCreateObject: Types.toFunctionName(`${camelCase}CreateDecoder`),
+                zodUpdateObject: Types.toFunctionName(`${camelCase}UpdateDecoder`),
+                zodUpsertObject: Types.toFunctionName(`${camelCase}UpsertDecoder`),
             },
             dataRepositoryVariableName: Types.toVariableName(`data`),
         },
@@ -409,9 +403,6 @@ function getModelMetadata({ model }) {
             zodDecoderFnNames: {
                 id: Types.toFunctionName(`${camelCase}IdDecoder`),
                 fromDatabase: Types.toFunctionName(`${camelCase}DatabaseDecoder`),
-                createObject: Types.toFunctionName(`${camelCase}CreateDecoder`),
-                updateObject: Types.toFunctionName(`${camelCase}UpdateDecoder`),
-                upsertObject: Types.toFunctionName(`${camelCase}UpsertDecoder`),
             },
             dto: {
                 create: Types.toTypeName(`${PascalCase}CreateDTO`),

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

@@ -170,6 +170,10 @@ export type ModelFields = {
      * All fields of the model
      */
     fields: Field[];
+    /**
+     * A list of models that reference this model in their relations.
+     */
+    relatedModels: ModelCore[];
 };
 /**
  * A field of a model.
@@ -313,12 +317,12 @@ export type FieldRelation = Prettify<Omit<FieldCore, 'name'> & {
      */
     name: Types.FieldName;
     /**
-     * Name of the field in the related model that references this model (e.g. `aggregation`).
+     * Name of the relation field in the model.
      *
      * NOTE: This does not reference the database column name, but the field name
      *  in the model (e.g. not `aggregationId`, but `aggregation`).
      */
-    relatedModelBacklinkFieldName: Types.FieldName;
+    relationFieldName: Types.FieldName;
     /**
      * Name of the unbranded TypeScript type of the field, e.g. string
      *
@@ -329,7 +333,7 @@ export type FieldRelation = Prettify<Omit<FieldCore, 'name'> & {
      */
     unbrandedTypeName: Types.TypeName;
     /**
-     * The referenced model
+     * The referenced model.
      */
     relationToModel: ModelCore;
 }>;
@@ -343,12 +347,12 @@ export declare const isFieldRelation: (field: Field) => field is Prettify<Omit<F
      */
     name: Types.FieldName;
     /**
-     * Name of the field in the related model that references this model (e.g. `aggregation`).
+     * Name of the relation field in the model.
      *
      * NOTE: This does not reference the database column name, but the field name
      *  in the model (e.g. not `aggregationId`, but `aggregation`).
      */
-    relatedModelBacklinkFieldName: Types.FieldName;
+    relationFieldName: Types.FieldName;
     /**
      * Name of the unbranded TypeScript type of the field, e.g. string
      *
@@ -359,7 +363,7 @@ export declare const isFieldRelation: (field: Field) => field is Prettify<Omit<F
      */
     unbrandedTypeName: Types.TypeName;
     /**
-     * The referenced model
+     * The referenced model.
      */
     relationToModel: ModelCore;
 }>;

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

@@ -31,7 +31,7 @@ export type DiscriminantName = string & {
 export declare const toDiscriminantName: (t: string) => DiscriminantName;
 /**
  * The name of a model, e.g. "Aggregation".
-*/
+ */
 export type ModelName = string & {
     readonly ___type: 'ModelName';
 };
@@ -67,7 +67,7 @@ export declare const toAnnotatedTypeName: (name: TypeName) => AnnotatedTypeName;
 export declare const isAnnotatedTypeName: (t: string | AnnotatedTypeName) => t is AnnotatedTypeName;
 /**
  * The name of a model field, e.g. "name".
-*/
+ */
 export type FieldName = string & {
     readonly ___type: 'FieldName';
 };
@@ -77,7 +77,7 @@ export type FieldName = string & {
 export declare const toFieldName: (t: string) => FieldName;
 /**
  * The name of an Enum, e.g. "Language".
-*/
+ */
 export type EnumName = string & {
     readonly ___type: 'EnumName';
 };
@@ -87,7 +87,7 @@ export type EnumName = string & {
 export declare const toEnumName: (t: string) => EnumName;
 /**
  * The name of a function (e.g. "toAggregation").
-*/
+ */
 export type FunctionName = string & {
     readonly ___type: 'FunctionName';
 };
@@ -150,7 +150,7 @@ export declare const toPath: (t: string) => FilePath;
 /**
  * Branded string values that can be used as import statement values in the generators
  */
-export type ImportableTypes = FunctionName | ClassName | AnnotatedTypeName | VariableName | EnumName;
+export type ImportableTypes = FunctionName | ClassName | TypeName | AnnotatedTypeName | VariableName | EnumName;
 /**
  * Branded string values that can be used as paths in import statements
  */

package/dist/lib/utils/jsdoc.d.ts

@@ -1,4 +1,9 @@
+import type { Field } from '../schema/schema';
 /**
  * Returns a string of JSDoc comments from an array of lines.
  */
 export declare function toJsDocComment(comments: string[] | undefined): string;
+/**
+ * Returns a JSDoc comment for a field.
+ */
+export declare function getFieldComment(f: Field): string;

package/dist/lib/utils/jsdoc.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toJsDocComment = void 0;
+exports.getFieldComment = exports.toJsDocComment = void 0;
 /**
  * Returns a string of JSDoc comments from an array of lines.
  */
@@ -14,3 +14,24 @@ function toJsDocComment(comments) {
         .join('')} \n   */`;
 }
 exports.toJsDocComment = toJsDocComment;
+/**
+ * Returns a JSDoc comment for a field.
+ */
+function getFieldComment(f) {
+    const lines = [];
+    if (f.description) {
+        lines.push(...f.description.split('\n'));
+    }
+    else if (f.kind === 'enum' && f.enumerator.description) {
+        lines.push(...f.enumerator.description.split('\n'));
+    }
+    const _examples = f.attributes.examples;
+    if (_examples) {
+        lines.push(`Examples: ${_examples.map((e) => `"${e}"`).join(', ')}`);
+    }
+    if (lines.length === 0) {
+        return '';
+    }
+    return toJsDocComment(lines);
+}
+exports.getFieldComment = getFieldComment;