@postxl/generator 0.68.0 → 0.69.0

package/dist/lib/attributes.d.ts

@@ -16,11 +16,6 @@ export type ModelAttributes = {
      * Note: Prisma has it's own schema attribute - but does not expose it in the DMMF.
      */
     databaseSchema: string;
-    /**
-     * Schema tag: ´@@InMemoryOnly()`
-     * Whether the model should be stored in the database or only in memory.
-     */
-    inMemoryOnly: boolean;
     /**
      * Schema tag: ´@@Index()`
      * Creates an index on the given fields.

package/dist/lib/meta.d.ts

@@ -182,10 +182,6 @@ export type SchemaMetaData = {
          * Location of the module class
          */
         moduleLocation: Types.ModuleLocation;
-        /**
-         * Path to the file containing the data module class definition.
-         */
-        emptyDbCommandFilePath: Types.FilePath;
         repository: {
             /**
              * Path to the file containing the repository type definition.
@@ -218,20 +214,6 @@ export type SchemaMetaData = {
              */
             bulkMutationForModel: Types.TypeName;
         };
-        mockModule: {
-            /**
-             * Path to the file containing the mock data for the database.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * Name of the mock data module class.
-             */
-            name: Types.ClassName;
-        };
-        /**
-         * Name of the data mock type/interface.
-         */
-        dataMockDataType: Types.TypeName;
         dataService: {
             /**
              * Path to the file containing data service class definitions.
@@ -350,10 +332,6 @@ export type SchemaMetaData = {
              * Name of the function that converts a delta to BulkMutations.
              */
             deltaToBulkMutations: Types.FunctionName;
-            /**
-             * Name of the function that converts mock data to BulkMutations.
-             */
-            mockDataToBulkMutations: Types.FunctionName;
         };
         /**
          * Meta data for the import export types file.
@@ -630,10 +608,6 @@ export type SchemaMetaData = {
      * Meta data for the e2e generators.
      */
     e2e: {
-        /**
-         * Path to the file containing data mocker class definitions.
-         */
-        dataMockerLocation: Types.ModuleLocation;
         /**
          * Path to the file containing component test ids for e2e tests.
          */
@@ -765,26 +739,6 @@ export type ModelMetaData = {
              */
             getMethodFnName: Types.FunctionName;
         };
-        mockRepository: {
-            /**
-             * Path to the file containing the mock repository definition.
-             */
-            location: Types.ModuleLocation;
-            /**
-             * The name of the class for the in-memory mock repository definition of this model (e.g. MockAggregationRepository).
-             */
-            className: Types.ClassName;
-        };
-    };
-    e2e: {
-        /**
-         * The path to the file containing stub definitions of this model.
-         */
-        stubLocation: Types.ModuleLocation;
-        /**
-         * The name of the function that adds missing values to the partially populated model value.
-         */
-        stubGenerationFnName: Types.FunctionName;
     };
     /**
      *  Properties provided by the `importExport` generators

package/dist/lib/meta.js

@@ -118,7 +118,6 @@ function getSchemaMetadata({ config }) {
         data: {
             moduleName: Types.toClassName(`DataModule`),
             moduleLocation: Types.toModuleLocation(`data`, `${config.paths.dataLibPath}data.module`),
-            emptyDbCommandFilePath: Types.toPath(`${config.paths.dbLibPath}wipe-database.sql`),
             repository: {
                 typeFilePath: Types.toPath(`${config.paths.dataLibPath}repository.type`),
                 typeName: Types.toTypeName(`Repository`),
@@ -138,14 +137,8 @@ function getSchemaMetadata({ config }) {
             },
             stubIndexFilePath: Types.toPath(`${config.paths.dataLibPath}stubs/index`),
             testDataServiceFilePath: Types.toPath(`${config.paths.e2eLibPath}test-data.service`),
-            mockModule: {
-                location: Types.toModuleLocation(`data`, `${config.paths.dataLibPath}data.mock.module`),
-                name: Types.toClassName(`DataMockModule`),
-            },
-            dataMockDataType: Types.toTypeName(`MockData`),
         },
         e2e: {
-            dataMockerLocation: Types.toModuleLocation(`e2e`, `${config.paths.playwrightPath}support/data-mocker.class`),
             testIdsFilePath: Types.toPath(`${config.paths.playwrightPath}support/model-test-ids`),
         },
         importExport: {
@@ -174,7 +167,6 @@ function getSchemaMetadata({ config }) {
                 location: Types.toModuleLocation(`import-export`, `${config.paths.importExportPath}convert-import.functions`),
                 importedDataToBulkMutations: Types.toFunctionName(`importToBulkMutations`),
                 deltaToBulkMutations: Types.toFunctionName(`deltaToBulkMutations`),
-                mockDataToBulkMutations: Types.toFunctionName(`mockDataToBulkMutations`),
             },
             types: {
                 location: Types.toModuleLocation(`import-export`, `${config.paths.importExportPath}types`),
@@ -284,20 +276,12 @@ function getModelMetadata({ model }) {
                 decoderFnName: Types.toFunctionName(`to${PascalCase}`),
                 getMethodFnName: Types.toFunctionName(`${camelCase}`),
             },
-            mockRepository: {
-                location: Types.toModuleLocation(`data`, `${config.paths.dataLibPath}repositories/mock/${camelCase}.mock.repository`),
-                className: Types.toClassName(`Mock${PascalCase}Repository`),
-            },
             stubLocation: Types.toModuleLocation(`data`, `${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: {
-            stubGenerationFnName: Types.toFunctionName(`stub${PascalCase}`),
-            stubLocation: Types.toModuleLocation(`e2e`, `${config.paths.playwrightPath}support/stubs/${camelCase}.stub`),
-        },
         importExport: {
             exportDataPropertyName: Types.toVariableName(`${capitalizedPlural}`),
             exportDataFullPropertyName: Types.toVariableName(`${uncapitalizedPlural}`),

package/dist/prisma/attributes.js

@@ -71,7 +71,6 @@ function getModelAttributes(model) {
     const decoder = zod_1.default
         .object({
         ignore: blankStringBooleanDecoder,
-        inMemoryOnly: blankStringBooleanDecoder,
         description: zod_1.default.string().optional(),
         schema: zod_1.default.string({
             required_error: `The PostXL attribute ${(0, logger_1.highlight)('`///@@Schema`')} attribute must be provided (in addition to Prisma's @@schema attribute)!`,
@@ -85,7 +84,6 @@ function getModelAttributes(model) {
     })
         .transform((obj) => ({
         ignore: obj.ignore,
-        inMemoryOnly: obj.inMemoryOnly,
         description: obj.description,
         databaseSchema: obj.schema,
         index: obj.index,

package/package.json

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

package/dist/generators/indices/datamock-module.generator.d.ts

@@ -1,9 +0,0 @@
-import { SchemaMetaData } from '../../lib/meta';
-import { Model } from '../../lib/schema/schema';
-/**
- * Generates a mocking class
- */
-export declare function generateDataMockModule({ models, meta }: {
-    models: Model[];
-    meta: SchemaMetaData;
-}): string;

package/dist/generators/indices/datamock-module.generator.js

@@ -1,64 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateDataMockModule = void 0;
-const imports_1 = require("../../lib/imports");
-const meta_1 = require("../../lib/meta");
-/**
- * Generates a mocking class
- */
-function generateDataMockModule({ models, meta }) {
-    const mm = models.map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }));
-    const imports = imports_1.ImportsGenerator.from(meta.data.mockModule.location.path).addImports({
-        [meta.data.moduleLocation.path]: [meta.data.moduleName],
-        [meta.data.dataService.location.path]: [meta.data.dataService.class],
-        [meta.backendModules.db.moduleLocation.import]: [meta.backendModules.db.moduleName],
-        // we need to import the file directly instead via the normal index file as this would cause a circular dependency else
-        [meta.actions.execution.mockLocation.import]: [meta.actions.execution.mock],
-    });
-    for (const { model, meta } of mm) {
-        imports.addTypeImport({ items: [model.typeName], from: meta.types.importPath });
-        imports.addImport({ items: [meta.data.repository.className], from: meta.data.repository.location.path });
-        imports.addImport({ items: [meta.data.mockRepository.className], from: meta.data.mockRepository.location.path });
-    }
-    const providers = mm
-        .map(({ meta }) => `{ 
-          provide: ${meta.data.repository.className},
-          useFactory: async () => {
-            const repository = new ${meta.data.mockRepository.className}()
-            if (!!seed && !!seed.${meta.seed.constantName}) {
-              await repository.reInit({items: seed.${meta.seed.constantName}, execution })
-            }
-            return repository
-          }
-        }`)
-        .join(', ');
-    return /* ts */ `
-import { DynamicModule } from '@nestjs/common'
-
-${imports.generate()}
-
-export class ${meta.data.mockModule.name} {
-  static mock(seed?: MockData): DynamicModule {
-    const execution = new MockActionExecution()
-
-    const providers = [
-      DataService, 
-      ${providers} 
-    ]
-
-    return {
-      module: ${meta.data.moduleName},
-      imports: [DatabaseModule.provideMock()],
-      providers,
-      exports: providers,
-      global: true,
-    }    
-  }
-}
-
-export interface ${meta.data.dataMockDataType} {
-  ${mm.map(({ model, meta }) => `${meta.data.mockDataPropertyName}?: ${model.typeName}[]`).join('\n')}
-}
-`;
-}
-exports.generateDataMockModule = generateDataMockModule;

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

@@ -1,9 +0,0 @@
-import { SchemaMetaData } from '../../lib/meta';
-import { Model } from '../../lib/schema/schema';
-/**
- * Generates a generic data mocker class.
- */
-export declare function generateDataMocker({ models, meta: schemaMeta }: {
-    models: Model[];
-    meta: SchemaMetaData;
-}): string;

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

@@ -1,88 +0,0 @@
-"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 types_1 = require("../../lib/schema/types");
-/**
- * Generates a generic data mocker class.
- */
-function generateDataMocker({ models, meta: schemaMeta }) {
-    const modelMetas = models.map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }));
-    const imports = imports_1.ImportsGenerator.from(schemaMeta.e2e.dataMockerLocation.path);
-    for (const { model, meta } of modelMetas) {
-        imports.addImports({
-            [meta.types.importPath]: [(0, types_1.toAnnotatedTypeName)(model.typeName)],
-            [meta.e2e.stubLocation.path]: [meta.e2e.stubGenerationFnName],
-        });
-    }
-    const publicVariables = modelMetas
-        .map(({ model, meta }) => `public ${meta.data.dataServiceName}: ${model.typeName}[] = []`)
-        .join('\n');
-    const privateIds = modelMetas
-        .map(({ model, meta }) => `private ${meta.data.dataServiceIdName}Ids = new IdTracker<${model.typeName}>()`)
-        .join('\n');
-    const addDataFunctions = modelMetas.map(({ model, meta }) => generateAddDataFunction(model, meta)).join('\n');
-    return `
-/* eslint-disable @typescript-eslint/no-unused-vars */
-import type { MockData } from '@backend/data/data.mock.module'
-
-${imports.generate()}
-
-import { IdTracker } from './id-tracker.class'
-
-
-export class DataMocker implements MockData {
-  ${publicVariables}
-
-  ${privateIds}
-
-  ${addDataFunctions}
-}
-`;
-}
-exports.generateDataMocker = generateDataMocker;
-function generateAddDataFunction(model, meta) {
-    const { fields, idField } = model;
-    const relations = fields
-        .filter(schema_1.isFieldRelation)
-        .map((field) => (Object.assign(Object.assign({}, field), { meta: (0, meta_1.getModelMetadata)({ model: field.relationToModel }), fieldMeta: (0, meta_1.getFieldMetadata)({ field }), model: field.relationToModel })))
-        .map((r) => {
-        if (r.isRequired) {
-            return `
-        if (_item.${r.name}) {
-          if (this.${r.meta.data.dataServiceName}.findIndex((x) => x.id === _item.${r.name}) === -1) {
-            this.add${r.model.typeName}({ id: _item.${r.name} })
-          }
-        } else {
-          if (this.${r.meta.data.dataServiceName}.length === 0) {
-            this.add${r.model.typeName}()
-          }
-          _item.${r.name} = this.${r.meta.data.dataServiceName}[0].id
-        }
-      `;
-        }
-        return `
-      if (_item.${r.name}) {
-        if (this.${r.meta.data.dataServiceName}.findIndex((x) => x.id === _item.${r.name}) === -1) {
-          this.add${r.model.typeName}({ id: _item.${r.name} })
-        }
-      }
-    `;
-    });
-    // TODO: Move the publicly accessible function's name to the metadata definition!
-    return /* ts */ `
-  public add${model.typeName}(
-    item?: Partial<Omit<${model.typeName}, '${idField.name}'> & { ${idField.name}: ${idField.unbrandedTypeName} }>
-  ): DataMocker {
-    const _stub = stub${model.typeName}(item ?? {})
-    const _item = this.${meta.data.dataServiceIdName}Ids.ensureId(_stub)
-    
-    this.${meta.data.dataServiceName}.push(_item)
-    
-    ${relations.join('\n')}
-    
-    return this
-  }`;
-}

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

@@ -1,11 +0,0 @@
-import { SchemaMetaData } from '../../lib/meta';
-import { Model } from '../../lib/schema/schema';
-/**
- * Generates a const that contains the SQL to delete all data from the E2E database.
- *
- * This is used in e2e tests to empty the database before each test.
- */
-export declare function generateEmptyDatabaseCommand({ models }: {
-    models: Model[];
-    meta: SchemaMetaData;
-}): string;

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

@@ -1,34 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateEmptyDatabaseCommand = void 0;
-/**
- * Generates a const that contains the SQL to delete all data from the E2E database.
- *
- * This is used in e2e tests to empty the database before each test.
- */
-function generateEmptyDatabaseCommand({ models }) {
-    const modelTables = models.map((model) => `${model.sourceSchemaName !== undefined ? `"${model.sourceSchemaName}".` : ''}"${model.sourceName}"`);
-    // We determine the schema used for all system tables by looking at the User model's schema.
-    const userModel = models.find((model) => model.name === 'User');
-    if (!userModel) {
-        throw new Error('Model definition for "User" could not be found - hence schema for system table cannot be derived!');
-    }
-    const configSchema = userModel.sourceSchemaName !== undefined ? `"${userModel.sourceSchemaName}".` : '';
-    const systemTables = ['Action', 'Mutation'].map((table) => `${configSchema}"${table}"`);
-    const configTableName = `${configSchema}"Config"`;
-    return /** ts */ `
-/** 
- * SQL instruction to delete all data from the E2E database. Should only be used internally by the DbService!
- */
-export const wipeDatabaseCommand = \`
-DO $$
-BEGIN
-  IF EXISTS (SELECT 1 FROM ${configTableName} WHERE "isTest" = TRUE) THEN
-    TRUNCATE TABLE 
-      ${[...systemTables, ...modelTables].join(',\n      ')};
-  END IF;
-END
-$$;\`
-`;
-}
-exports.generateEmptyDatabaseCommand = generateEmptyDatabaseCommand;

package/dist/generators/indices/testdata-service.generator.d.ts

@@ -1,9 +0,0 @@
-import { SchemaMetaData } from '../../lib/meta';
-import { Model } from '../../lib/schema/schema';
-/**
- * Generates the TestDataService class.
- */
-export declare function generateTestDataService({ models, meta: schemaMeta, }: {
-    models: Model[];
-    meta: SchemaMetaData;
-}): string;

package/dist/generators/indices/testdata-service.generator.js

@@ -1,84 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateTestDataService = void 0;
-const imports_1 = require("../../lib/imports");
-const meta_1 = require("../../lib/meta");
-const types_1 = require("../../lib/schema/types");
-/**
- * Generates the TestDataService class.
- */
-function generateTestDataService({ models, meta: schemaMeta, }) {
-    const imports = imports_1.ImportsGenerator.from(schemaMeta.data.testDataServiceFilePath);
-    imports.addImports({
-        [schemaMeta.actions.execution.classLocation.import]: [(0, types_1.toClassName)('ActionExecutionFactory')],
-        [schemaMeta.data.dataService.location.import]: [schemaMeta.data.dataService.class],
-        [schemaMeta.backendModules.db.databaseService.location.import]: [schemaMeta.backendModules.db.databaseService.name],
-        [schemaMeta.data.mockModule.location.import]: [(0, types_1.toAnnotatedTypeName)(schemaMeta.data.dataMockDataType)],
-        [schemaMeta.importExport.converterFunctions.location.import]: [
-            schemaMeta.importExport.converterFunctions.mockDataToBulkMutations,
-        ],
-    });
-    const reInitCalls = [];
-    const modelMetas = models.map((model) => ({ model, meta: (0, meta_1.getModelMetadata)({ model }) }));
-    for (const { model, meta } of modelMetas) {
-        if (model.defaultField) {
-            imports.addImport({ items: [meta.data.stubGenerationFnName], from: meta.data.stubLocation.import });
-            const stubDefault = `${meta.data.stubGenerationFnName}({ ${model.defaultField.name}: true })`;
-            reInitCalls.push(`await this.dataService.${meta.data.dataServiceName}.reInit({ items: mockData.${meta.seed.constantName}?.create ?? [${stubDefault}], execution: actionExecution })`);
-        }
-        else {
-            reInitCalls.push(`await this.dataService.${meta.data.dataServiceName}.reInit({ items: mockData.${meta.seed.constantName}?.create ?? [], execution: actionExecution })`);
-        }
-    }
-    return /* ts */ `
-import { Injectable, Logger } from '@nestjs/common'
-
-${imports.generate()}
-
-@Injectable()
-export class TestDataService {
-  private logger = new Logger(TestDataService.name)
-
-  constructor(
-    private readonly databaseService: DatabaseService,
-    private readonly dataService: ${schemaMeta.data.dataService.class},
-    private readonly actionExecutionFactory: ActionExecutionFactory,
-  ) {}
-
-  public async resetTestData(data: MockData) {
-    this.logger.log('💥 Emptying test data')
-    await this.databaseService.WIPE_ENTIRE_DATABASE()
-
-    // We need to init the user repository first so the root user is created
-    this.logger.log('✍ Setting test data')
-    await this.dataService.users.init()
-
-    this.logger.log('✍ Setting test data')
-
-    const mockData = ${schemaMeta.importExport.converterFunctions.mockDataToBulkMutations}(data)
-
-    const actionExecution = await this.actionExecutionFactory.create({
-      action: {
-        scope: 'seed',
-        type: 'data',
-        name: 'E2E', 
-        order: 0, 
-        payload: []
-      },
-      databaseService: this.databaseService,
-      user: this.dataService.users.rootUser,
-    })
-
-    try {
-      ${reInitCalls.join('\n')}
-      
-      await actionExecution.success()
-      this.logger.log('✅ Reset test data')
-    } catch (e) {
-      await actionExecution.error(e)
-      throw e
-    }
-  }
-}`;
-}
-exports.generateTestDataService = generateTestDataService;