@postxl/generator 0.44.2 → 0.44.4

package/dist/lib/meta.js

@@ -31,11 +31,51 @@ const string_1 = require("./utils/string");
  */
 function getSchemaMetadata({ config }) {
     return {
+        backendModules: {
+            common: {
+                importPath: Types.toBackendModulePath(`@backend/common`),
+                functions: {
+                    format: Types.toFunctionName(`format`),
+                    pluralize: Types.toFunctionName(`pluralize`),
+                    uncapitalizeKeys: Types.toFunctionName(`uncapitalizeKeys`),
+                    capitalizeKeys: Types.toFunctionName(`capitalizeKeys`),
+                    nullOrBlankDecoder: Types.toFunctionName(`nullOrBlankDecoder`),
+                    excelStringNullableDecoder: Types.toFunctionName(`excelStringNullableDecoder`),
+                    excelStringDecoder: Types.toFunctionName(`excelStringDecoder`),
+                    excelDateNullableDecoder: Types.toFunctionName(`excelDateNullableDecoder`),
+                    excelDateDecoder: Types.toFunctionName(`excelDateDecoder`),
+                    excelBooleanDecoder: Types.toFunctionName(`excelBooleanDecoder`),
+                },
+            },
+            auth: {
+                importPath: Types.toBackendModulePath(`@backend/auth`),
+            },
+            db: {
+                importPath: Types.toBackendModulePath(`@backend/db`),
+                dbService: {
+                    name: Types.toClassName(`DbService`),
+                },
+            },
+            http: {
+                importPath: Types.toBackendModulePath(`@backend/http`),
+            },
+            i18n: {
+                importPath: Types.toBackendModulePath(`@backend/i18n`),
+            },
+            s3: {
+                importPath: Types.toBackendModulePath(`@backend/s3`),
+            },
+            upload: {
+                importPath: Types.toBackendModulePath(`@backend/upload`),
+            },
+            xlport: {
+                importPath: Types.toBackendModulePath(`@backend/xlport`),
+            },
+        },
         actions: {
             moduleName: Types.toClassName(`ActionModule`),
-            importPath: Types.toPath(`@${config.project}/actions`),
+            importPath: Types.toBackendModulePath(`@backend/actions`),
             actionExecution: {
-                filePath: Types.toPath(`@${config.project}/actions/actionExecution.class`),
                 interface: Types.toClassName(`IActionExecution`),
                 class: Types.toClassName(`ActionExecution`),
                 mock: Types.toClassName(`MockActionExecution`),
@@ -47,12 +87,12 @@ function getSchemaMetadata({ config }) {
         },
         businessLogic: {
             moduleName: Types.toClassName(`BusinessLogicModule`),
-            importPath: Types.toPath(`@${config.project}/business-logic`),
+            importPath: Types.toBackendModulePath(`@backend/business-logic`),
             indexFilePath: Types.toPath(`${config.paths.businessLogicPath}index`),
             moduleFilePath: Types.toPath(`${config.paths.businessLogicPath}business-logic.module`),
             view: {
                 moduleName: Types.toClassName(`ViewModule`),
-                importPath: Types.toPath(`@${config.project}/business-logic/view`),
+                importPath: Types.toBackendModulePath(`@backend/business-logic/view`),
                 indexFilePath: Types.toPath(`${config.paths.businessLogicPath}view/index`),
                 moduleFilePath: Types.toPath(`${config.paths.businessLogicPath}view/view.module`),
                 serviceClassName: Types.toClassName(`ViewService`),
@@ -60,7 +100,7 @@ function getSchemaMetadata({ config }) {
             },
             update: {
                 moduleName: Types.toClassName(`UpdateModule`),
-                importPath: Types.toPath(`@${config.project}/business-logic/update`),
+                importPath: Types.toBackendModulePath(`@backend/business-logic/update`),
                 indexFilePath: Types.toPath(`${config.paths.businessLogicPath}update/index`),
                 moduleFilePath: Types.toPath(`${config.paths.businessLogicPath}update/update.module`),
                 serviceClassName: Types.toClassName(`UpdateService`),
@@ -70,7 +110,7 @@ function getSchemaMetadata({ config }) {
         },
         data: {
             moduleName: Types.toClassName(`DataModule`),
-            importPath: Types.toPath(`@${config.project}/data`),
+            importPath: Types.toBackendModulePath(`@backend/data`),
             dataModuleFilePath: Types.toPath(`${config.paths.dataLibPath}data.module`),
             dataMockModuleFilePath: Types.toPath(`${config.paths.dataLibPath}data.mock.module`),
             repository: {
@@ -90,17 +130,21 @@ function getSchemaMetadata({ config }) {
                 executeBulkMutations: Types.toFunctionName(`executeBulkMutations`),
                 executeBulkMutation: Types.toFunctionName(`executeBulkMutation`),
             },
-            dataMockerFilePath: Types.toPath(`${config.paths.cypressPath}support/data-mocker.class`),
-            dataMockerStubImportPath: Types.toPath(`${config.paths.cypressPath}support/stubs`),
-            dataMockerStubIndexFilePath: Types.toPath(`${config.paths.cypressPath}support/stubs/index`),
             stubIndexFilePath: Types.toPath(`${config.paths.dataLibPath}stubs/index`),
-            selectorsFilePath: Types.toPath(`${config.paths.cypressPath}support/selectors`),
             testDataServiceFilePath: Types.toPath(`${config.paths.e2eLibPath}test-data.service`),
             dataMockModuleName: Types.toClassName(`DataMockModule`),
             dataMockDataType: Types.toTypeName(`MockData`),
         },
+        e2e: {
+            dataMocker: {
+                filePath: Types.toPath(`${config.paths.cypressPath}support/data-mocker.class`),
+                stubImportPath: Types.toPath(`${config.paths.cypressPath}support/stubs`),
+                stubIndexFilePath: Types.toPath(`${config.paths.cypressPath}support/stubs/index`),
+            },
+            selectorsFilePath: Types.toPath(`${config.paths.cypressPath}support/selectors`),
+        },
         importExport: {
-            importPath: Types.toPath(`@${config.project}/import-export`),
+            importPath: Types.toBackendModulePath(`@backend/import-export`),
             decoder: {
                 indexFilePath: Types.toPath(`${config.paths.importExportPath}decoders/index`),
                 fullDecoderFilePath: Types.toPath(`${config.paths.importExportPath}decoders/data.decoder`),
@@ -183,21 +227,21 @@ function getSchemaMetadata({ config }) {
             },
         },
         seedData: {
-            importPath: Types.toPath(`@${config.project}/seed-data`),
+            importPath: Types.toBackendModulePath(`@backend/seed-data`),
             initialMigrationFilePath: Types.toPath(`${config.paths.seedDataPath}001-base-data/001-seed.migration`),
             templateExcelFilePath: Types.toPath(`${config.paths.seedDataPath}002-excel-example/template.xlsx`),
         },
         seed: {
             serviceClassName: Types.toClassName(`SeedService`),
-            importPath: Types.toPath(`@${config.project}/seed`),
+            importPath: Types.toBackendModulePath(`@backend/seed`),
         },
         trpc: {
             routesFilePath: Types.toPath(`${config.paths.trpcRoutesFolderPath}index`),
-            importPath: Types.toPath(`@${config.project}/trpc`),
+            importPath: Types.toBackendModulePath(`@backend/trpc`),
         },
         types: {
             indexFilePath: Types.toPath(`${config.paths.modelTypeDefinitionsPath}index`),
-            importPath: Types.toPath(`@${config.project}/types`),
+            importPath: Types.toBackendModulePath(`@backend/types`),
             dto: {
                 path: Types.toPath(`${config.paths.modelTypeDefinitionsPath}dto.types`),
                 genericModel: Types.toTypeName(`GenericModel`),
@@ -229,7 +273,7 @@ function getModelMetadata({ model }) {
             actionScopeConstType: Types.toTypeName(`${camelCase}`),
         },
         data: {
-            importPath: Types.toPath(`@${config.project}/data`),
+            importPath: Types.toBackendModulePath(`@backend/data`),
             mockDataPropertyName: Types.toVariableName(`${uncapitalizedPlural}`),
             repository: {
                 fileName: Types.toFileName(`${camelCase}.repository`),
@@ -243,13 +287,15 @@ function getModelMetadata({ model }) {
                 filePath: Types.toPath(`${config.paths.dataLibPath}repositories/mock/${camelCase}.mock.repository`),
                 className: Types.toClassName(`Mock${PascalCase}Repository`),
             },
-            dataMockerStubFilePath: Types.toPath(`${config.paths.cypressPath}support/stubs/${camelCase}.stub`),
             stubFilePath: Types.toPath(`${config.paths.dataLibPath}stubs/${camelCase}.stub`),
             stubGenerationFnName: Types.toFunctionName(`stub${PascalCase}`),
             defaultStubConstantName: Types.toVariableName(`${camelCase}DefaultStub`),
             dataServiceName: Types.toVariableName(`${uncapitalizedPlural}`),
             dataServiceIdName: Types.toVariableName(`${uncapitalized}`),
         },
+        e2e: {
+            dataMockerStubFilePath: Types.toPath(`${config.paths.cypressPath}support/stubs/${camelCase}.stub`),
+        },
         importExport: {
             exportDataPropertyName: Types.toVariableName(`${capitalizedPlural}`),
             exportDataFullPropertyName: Types.toVariableName(`${uncapitalizedPlural}`),
@@ -269,7 +315,7 @@ function getModelMetadata({ model }) {
         },
         businessLogic: {
             scopeName: Types.toVariableName(`${camelCase}`),
-            importPath: Types.toPath(`@${config.project}/business-logic`),
+            importPath: Types.toBackendModulePath(`@backend/business-logic`),
             view: {
                 serviceClassName: Types.toClassName(`${PascalCase}ViewService`),
                 serviceVariableName: Types.toVariableName(`${uncapitalizedPlural}`),
@@ -299,7 +345,7 @@ function getModelMetadata({ model }) {
         seed: {
             filePath: Types.toPath(`${config.paths.seedDataPath}001-base-data/${uncapitalizedPlural}.seed`),
             constantName: Types.toVariableName(`${uncapitalizedPlural}`),
-            importPath: Types.toPath(`@${config.project}/seed`),
+            importPath: Types.toBackendModulePath(`@backend/seed`),
         },
         react: {
             folderName: Types.toFolderName(`${PascalCase}`),
@@ -331,7 +377,6 @@ function getModelMetadata({ model }) {
         trpc: {
             routerFilePath: Types.toPath(`${config.paths.trpcRoutesFolderPath}${camelCase}.router`),
             routerName: Types.toVariableName(uncapitalizedPlural),
-            importPath: Types.toPath(`@${config.project}${camelCase}.router`),
             getMap: {
                 methodName: Types.toVariableName('getMap'),
                 reactQueryMethod: Types.toFunctionName(`${uncapitalizedPlural}.getMap`),
@@ -350,7 +395,7 @@ function getModelMetadata({ model }) {
             },
         },
         types: {
-            importPath: Types.toPath(`@${config.project}/types`),
+            importPath: Types.toBackendModulePath(`@backend/types`),
             filePath: Types.toPath(`${config.paths.modelTypeDefinitionsPath}${camelCase}.type`),
             brandedIdType: Types.toTypeName(`${PascalCase}Id`),
             toBrandedIdTypeFnName: Types.toFunctionName(`to${PascalCase}Id`),
@@ -413,7 +458,7 @@ function getEnumMetadata({ enumerator: { name, schemaConfig: config }, }) {
         react: {
             folderName: Types.toFolderName((0, string_1.toPascalCase)(name)),
             folderPath: Types.toPath(`${config.paths.reactFolderPath}/enums/${(0, string_1.toPascalCase)(name)}`),
-            importPath: Types.toPath(`@${config.project}/react/enums/${(0, string_1.toPascalCase)(name)}`),
+            importPath: Types.toBackendModulePath(`@backend/react/enums/${(0, string_1.toPascalCase)(name)}`),
             selectInputName: Types.toVariableName(`${(0, string_1.toPascalCase)(name)}SelectInput`),
             selectFieldName: Types.toVariableName(`${(0, string_1.toPascalCase)(name)}SelectField`),
             switcherInputName: Types.toVariableName(`${(0, string_1.toPascalCase)(name)}SwitcherInput`),
@@ -425,7 +470,7 @@ function getEnumMetadata({ enumerator: { name, schemaConfig: config }, }) {
             membersList: Types.toVariableName(`${(0, string_1.toCamelCase)(name)}Members`),
             membersMap: Types.toVariableName(`${(0, string_1.toCamelCase)(name)}`),
             filePath: Types.toPath(`${config.paths.modelTypeDefinitionsPath}${(0, string_1.toCamelCase)(name)}.enum`),
-            importPath: Types.toPath(`@${config.project}/types`),
+            importPath: Types.toBackendModulePath(`@backend/types`),
             sourceName: name,
         },
     };

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

@@ -7,10 +7,6 @@ import * as Types from './types';
  * NOTE: This may be accessed in every model, field and enumerator.
  */
 export type SchemaConfig = {
-    /**
-     * Project scope to use in TypeScript imports (e.g. `mca` for `@mca/types`).
-     */
-    project: string;
     /**
      * Indicates whether the generator should be ignored
      */
@@ -55,72 +51,72 @@ export type SchemaConfig = {
          * NOTE: Metadata assumes that project is set up so that certain parts of the code
          * may reference actions using `@project/actions` import.
          */
-        actionsPath: Types.Path;
+        actionsPath: Types.FilePath;
         /**
          * Path to the directory containing business logic.
          *
          * NOTE: Metadata assumes that project is set up so that certain parts of the code
          * may reference mock data using `@project/business-logic` import.
          */
-        businessLogicPath: Types.Path;
+        businessLogicPath: Types.FilePath;
         /**
          * Path to the directory containing Cypress project.
          */
-        cypressPath: Types.Path;
+        cypressPath: Types.FilePath;
         /**
          * Path to the directory containing e2e tests.
          */
-        e2eLibPath: Types.Path;
+        e2eLibPath: Types.FilePath;
         /**
          * Path to the directory containing data library definitions.
          *
          * NOTE: Metadata assumes that project is set up so that certain parts of the code
          * may reference data library using `@project/data` import.
          */
-        dataLibPath: Types.Path;
+        dataLibPath: Types.FilePath;
         /**
          * Path to the directory containing import-export module.
          *
          * NOTE: Metadata assumes that project is set up so that certain parts of the code
          * may reference import-export using `@project/import-export` import.
          */
-        importExportPath: Types.Path;
+        importExportPath: Types.FilePath;
         /**
          * Path to the directory containing Prisma migrations.
          */
-        migrationsFolderPath: Types.Path;
+        migrationsFolderPath: Types.FilePath;
         /**
          * Path to the directory containing model type definitions.
          *
          * NOTE: Metadata assumes that project is set up so that certain parts of the code
          * may reference type definitions using `@project/types` import.
          */
-        modelTypeDefinitionsPath: Types.Path;
+        modelTypeDefinitionsPath: Types.FilePath;
         /**
          * Path to the directory containing React components.
          *
          * NOTE: Metadata assumes that the project is set up so that React components
          * may be referenced using `@project/react` import.
          */
-        reactFolderPath: Types.Path;
+        reactFolderPath: Types.FilePath;
         /**
          * Path to the directory containing seed module.
          *
          * NOTE: Metadata assumes that project is set up so that certain parts of the code
          * may reference mock data using `@project/seed` import.
          */
-        seedLibPath: Types.Path;
+        seedLibPath: Types.FilePath;
         /**
          * Path to the directory containing mock data samples.
          *
          * NOTE: Metadata assumes that project is set up so that certain parts of the code
          * may reference mock data using `@project/seed-data` import.
          */
-        seedDataPath: Types.Path;
+        seedDataPath: Types.FilePath;
         /**
          * Path to the directory containing trpc routes.
          */
-        trpcRoutesFolderPath: Types.Path;
+        trpcRoutesFolderPath: Types.FilePath;
     };
     /**
      * Whether the generator should overwrite existing files.

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

@@ -49,6 +49,22 @@ export type TypeName = string & {
  * Brands a raw string to a TypeScript Type identifier.
  */
 export declare const toTypeName: (t: string) => TypeName;
+/**
+ * A TypeName that is annotated with the kind of the type.
+ * Note: This is used when distinguishing between kinds is required at runtime.
+ */
+export type AnnotatedTypeName = {
+    typeName: TypeName;
+    kind: 'TypeName';
+};
+/**
+ * Converts a branded string to a branded TypeName.
+ */
+export declare const toAnnotatedTypeName: (name: TypeName) => AnnotatedTypeName;
+/**
+ * Type guard to check if a given type is an AnnotatedTypeName.
+ */
+export declare const isAnnotatedTypeName: (t: string | AnnotatedTypeName) => t is AnnotatedTypeName;
 /**
  * The name of a model field, e.g. "name".
 */
@@ -114,14 +130,28 @@ export declare const toFolderName: (t: string) => FolderName;
 /**
  * A relative or absolute path to a file or folder.
  */
-export type Path = string & {
-    readonly ___type: 'FileName';
+export type FilePath = string & {
+    readonly ___type: 'FilePath';
 };
 /**
- * Converts a string to a branded FileName.
+ * Converts a string to a branded BackendModulePath.
  */
-export declare const toPath: (t: string) => Path;
+export declare const toBackendModulePath: (t: `@backend/${string}`) => BackendModulePath;
+/**
+ * A relative or absolute path to a backend file or folder.
+ */
+export type BackendModulePath = `@backend/${string}` & {
+    readonly ___type: 'BackendModulePath';
+};
+/**
+ * Converts a string to a branded PAth.
+ */
+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 | TypeName | VariableName;
+export type ImportableTypes = FunctionName | ClassName | AnnotatedTypeName | VariableName;
+/**
+ * Branded string values that can be used as paths in import statements
+ */
+export type ImportPaths = BackendModulePath | FilePath;

package/dist/lib/schema/types.js

@@ -1,7 +1,7 @@
 "use strict";
 // MARK: - Generated content related types
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toPath = exports.toFolderName = exports.toFileName = exports.toVariableName = exports.toFunctionName = exports.toEnumName = exports.toFieldName = exports.toTypeName = exports.toModelName = exports.toDiscriminantName = exports.toClassName = void 0;
+exports.toPath = exports.toBackendModulePath = exports.toFolderName = exports.toFileName = exports.toVariableName = exports.toFunctionName = exports.toEnumName = exports.toFieldName = exports.isAnnotatedTypeName = exports.toAnnotatedTypeName = exports.toTypeName = exports.toModelName = exports.toDiscriminantName = exports.toClassName = void 0;
 /**
  * Converts a raw string to a branded ClassName.
  */
@@ -22,6 +22,19 @@ exports.toModelName = toModelName;
  */
 const toTypeName = (t) => t;
 exports.toTypeName = toTypeName;
+/**
+ * Converts a branded string to a branded TypeName.
+ */
+const toAnnotatedTypeName = (name) => ({
+    typeName: name,
+    kind: 'TypeName',
+});
+exports.toAnnotatedTypeName = toAnnotatedTypeName;
+/**
+ * Type guard to check if a given type is an AnnotatedTypeName.
+ */
+const isAnnotatedTypeName = (t) => typeof t === 'object' && t.kind === 'TypeName';
+exports.isAnnotatedTypeName = isAnnotatedTypeName;
 /**
  * Brands a raw string to a FieldName identifier.
  */
@@ -55,7 +68,12 @@ exports.toFileName = toFileName;
 const toFolderName = (t) => t;
 exports.toFolderName = toFolderName;
 /**
- * Converts a string to a branded FileName.
+ * Converts a string to a branded BackendModulePath.
+ */
+const toBackendModulePath = (t) => t;
+exports.toBackendModulePath = toBackendModulePath;
+/**
+ * Converts a string to a branded PAth.
  */
 const toPath = (t) => t;
 exports.toPath = toPath;

package/dist/lib/types.d.ts

@@ -1,6 +1,6 @@
 /**
  * Makes a type check that is only valid when all cases of a switch
- * statement have been convered.
+ * statement have been covered.
  */
 export declare class ExhaustiveSwitchCheck extends Error {
     constructor(val: never);

package/dist/lib/types.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExhaustiveSwitchCheck = void 0;
 /**
  * Makes a type check that is only valid when all cases of a switch
- * statement have been convered.
+ * statement have been covered.
  */
 class ExhaustiveSwitchCheck extends Error {
     constructor(val) {

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

@@ -18,6 +18,10 @@ export declare const toPascalCase: (str: string) => string;
  * Returns a pluralized version of the given string based on the count.
  */
 export declare const pluralize: (s: string, count?: number) => string;
+/**
+ * Returns true if the given string is already pluralized.
+ */
+export declare const isPlural: (s: string) => boolean;
 /**
  * Converts each line of a string to a commented line
  */

package/dist/lib/utils/string.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.conjugateNames = exports.commentLines = exports.pluralize = exports.toPascalCase = exports.toCamelCase = exports.capitalize = exports.uncapitalize = void 0;
+exports.conjugateNames = exports.commentLines = exports.isPlural = exports.pluralize = exports.toPascalCase = exports.toCamelCase = exports.capitalize = exports.uncapitalize = void 0;
 /**
  * Returns the same string with a lowercase first letter.
  */
@@ -47,6 +47,7 @@ const IRREGULAR_PLURALS = Object.entries({
     axis: 'axes',
     basis: 'bases',
     child: 'children',
+    children: 'children',
     crisis: 'crises',
     criterion: 'criteria',
     data: 'data',
@@ -64,6 +65,7 @@ const IRREGULAR_PLURALS = Object.entries({
     phenomenon: 'phenomena',
     prognosis: 'prognoses',
     radius: 'radii',
+    status: 'statuses',
     suffix: 'suffixes',
     syllabus: 'syllabi',
     synopsis: 'synopses',
@@ -73,14 +75,14 @@ const IRREGULAR_PLURALS = Object.entries({
  * Returns a pluralized version of the given string based on the count.
  */
 const pluralize = (s, count = 2) => {
-    // NOTE: If there's one of something we simply use the singluar form.
+    // NOTE: If there's one of something we simply use the singular form.
     if (count === 1) {
         return s;
     }
     // NOTE: For plural forms, we first check whether a word is irregular.
     const lower = s.toLowerCase();
     for (const [singular, plural] of IRREGULAR_PLURALS) {
-        // NOTE: We check that items *end with* a given word becase we use combined words
+        // NOTE: We check that items *end with* a given word because we use combined words
         //       like `UserHistory` as input values of this function.
         if (lower.endsWith(singular)) {
             return s.slice(0, -singular.length + 1) + plural.slice(1);
@@ -100,6 +102,14 @@ const pluralize = (s, count = 2) => {
     return s + 's';
 };
 exports.pluralize = pluralize;
+/**
+ * Returns true if the given string is already pluralized.
+ */
+const isPlural = (s) => {
+    const plural = (0, exports.pluralize)(s);
+    return plural === s;
+};
+exports.isPlural = isPlural;
 /**
  * Converts each line of a string to a commented line
  */

package/dist/prisma/parse.js

@@ -60,6 +60,9 @@ function isModelNotIgnored(model) {
  * Parses the core properties of a model without fields.
  */
 function parseModelCore({ dmmfModel, config, }) {
+    if ((0, string_1.isPlural)(dmmfModel.name)) {
+        (0, error_1.throwError)(`Model ${dmmfModel.name} is plural. Please use singular names for models.`);
+    }
     const attributes = (0, attributes_1.getModelAttributes)(dmmfModel);
     return {
         name: Types.toModelName((0, string_1.toPascalCase)(dmmfModel.name)),

package/package.json

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