@postxl/generators 0.2.2

package/dist/backend-s3/s3.generator.js

@@ -0,0 +1,125 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generator = exports.generatorId = void 0;
+const Generator = __importStar(require("@postxl/generator"));
+const backend_core_1 = require("../backend-core");
+const base_1 = require("../base");
+const s3_config_generator_1 = require("./generators/s3.config.generator");
+const s3_module_generator_1 = require("./generators/s3.module.generator");
+const s3_service_generator_1 = require("./generators/s3.service.generator");
+exports.generatorId = Generator.toGeneratorInterfaceId('backend-s3');
+exports.generator = {
+    id: exports.generatorId,
+    requires: [backend_core_1.backendGeneratorId, base_1.baseGeneratorId],
+    register: (context) => {
+        const moduleName = Generator.toBackendModuleName('s3');
+        context.backend.packageJson.dependencies.push({ packageName: '@aws-sdk/client-s3', version: '3.400.0' });
+        const module = {
+            name: Generator.toClassName('S3Module'),
+            location: Generator.toBackendModuleLocation(`@s3/s3.module`),
+        };
+        const nestJsModule = {
+            name: moduleName,
+            moduleClass: module,
+            apiModuleRegistration: {
+                code: Generator.ts(`S3Module.forRoot(config.aws)`),
+            },
+            envConfig: {
+                dotEnvExample: `
+          # If true, S3 will be used to seed the database
+          AWS_USE_S3=false
+          # If true, ACCESS_KEY and SECRET_ACCESS_KEY will be used to authenticate with AWS S3
+          AWS_USE_CREDENTIALS=false
+          AWS_ACCESS_KEY=""
+          AWS_SECRET_ACCESS_KEY=""
+          AWS_BUCKET=""
+          AWS_FILE_PREFIX=""
+          AWS_REGION="eu-central-1"`,
+                decoder: Generator.ts(`
+            AWS_USE_S3: zEnvBoolean.optional().default('true'),
+            AWS_USE_CREDENTIALS: zEnvBoolean.optional().default('false'),
+            AWS_ACCESS_KEY: z.string().optional(),
+            AWS_SECRET_ACCESS_KEY: z.string().optional(),
+            AWS_BUCKET: z.string(),
+            AWS_FILE_PREFIX: z.string(),
+            AWS_REGION: z.string(),
+            `),
+                transformer: Generator.ts(`
+          aws: {
+            useS3: val.AWS_USE_S3,
+            useCredentials: val.AWS_USE_CREDENTIALS,
+            accessKey: val.AWS_ACCESS_KEY,
+            secretAccessKey: val.AWS_SECRET_ACCESS_KEY,
+            bucket: val.AWS_BUCKET,
+            filePrefix: val.AWS_FILE_PREFIX,
+            region: val.AWS_REGION,
+          }`),
+            },
+        };
+        context.backend.modules.push(nestJsModule);
+        const service = {
+            name: Generator.toClassName('S3Service'),
+            location: Generator.toBackendModuleLocation(`@s3/s3.service`),
+        };
+        const configLocation = Generator.toBackendModuleLocation(`@s3/s3.config`);
+        const config = {
+            name: Generator.toClassName('S3Config'),
+            location: configLocation,
+            type: { name: Generator.toTypeName('Config'), location: configLocation },
+        };
+        const s3 = {
+            module,
+            service,
+            config,
+        };
+        return {
+            ...context,
+            s3,
+        };
+    },
+    generate: (context) => {
+        const vfsSrc = new Generator.VirtualFileSystem();
+        vfsSrc.write(Generator.toLocalFile(context.s3.module), (0, s3_module_generator_1.generateS3Module)(context.s3));
+        vfsSrc.write(Generator.toLocalFile(context.s3.service), (0, s3_service_generator_1.generateS3Service)(context.s3));
+        vfsSrc.write(Generator.toLocalFile(context.s3.config), (0, s3_config_generator_1.generateS3Config)(context.s3));
+        const vfs = new Generator.VirtualFileSystem();
+        vfs.insertFromVfs({ targetPath: 'src', vfs: vfsSrc });
+        vfs.write('/tsconfig.lib.json', Generator.generateTsConfig('s3'));
+        context.vfs.insertFromVfs({ targetPath: 'backend/libs/s3', vfs });
+        return context;
+    },
+};
+//# sourceMappingURL=s3.generator.js.map

package/dist/backend-s3/s3.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"s3.generator.js","sourceRoot":"","sources":["../../src/backend-s3/s3.generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6DAA8C;AAE9C,kDAA+E;AAC/E,kCAAmD;AAEnD,0EAAmE;AACnE,0EAAmE;AACnE,4EAAqE;AAaxD,QAAA,WAAW,GAAG,SAAS,CAAC,sBAAsB,CAAC,YAAY,CAAC,CAAA;AAE5D,QAAA,SAAS,GAAiC;IACrD,EAAE,EAAE,mBAAW;IACf,QAAQ,EAAE,CAAC,iCAAkB,EAAE,sBAAe,CAAC;IAE/C,QAAQ,EAAE,CAAsC,OAAgB,EAAiB,EAAE;QACjF,MAAM,UAAU,GAAG,SAAS,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;QAEtD,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,oBAAoB,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAA;QAExG,MAAM,MAAM,GAA8B;YACxC,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC;YACvC,QAAQ,EAAE,SAAS,CAAC,uBAAuB,CAAC,eAAe,CAAC;SAC7D,CAAA;QACD,MAAM,YAAY,GAAiB;YACjC,IAAI,EAAE,UAAU;YAChB,WAAW,EAAE,MAAM;YAEnB,qBAAqB,EAAE;gBACrB,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC,8BAA8B,CAAC;aACnD;YAED,SAAS,EAAE;gBACT,aAAa,EAAE;;;;;;;;;oCASa;gBAC5B,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;;;;;;;;aAQjB,CAAC;gBACN,WAAW,EAAE,SAAS,CAAC,EAAE,CAAC;;;;;;;;;YAStB,CAAC;aACN;SACF,CAAA;QAED,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QAE1C,MAAM,OAAO,GAA8B;YACzC,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC;YACxC,QAAQ,EAAE,SAAS,CAAC,uBAAuB,CAAC,gBAAgB,CAAC;SAC9D,CAAA;QACD,MAAM,cAAc,GAAG,SAAS,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAA;QACzE,MAAM,MAAM,GAAmE;YAC7E,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC;YACvC,QAAQ,EAAE,cAAc;YACxB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,cAAc,EAAE;SACzE,CAAA;QAED,MAAM,EAAE,GAAc;YACpB,MAAM;YACN,OAAO;YACP,MAAM;SACP,CAAA;QAED,OAAO;YACL,GAAG,OAAO;YACV,EAAE;SACgB,CAAA;IACtB,CAAC;IAED,QAAQ,EAAE,CAAgC,OAAgB,EAAW,EAAE;QACrE,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAA;QAEhD,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,IAAA,sCAAgB,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;QACpF,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,IAAA,wCAAiB,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;QACtF,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,IAAA,sCAAgB,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;QAEpF,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAA;QAC7C,GAAG,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAA;QAErD,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAA;QAEjE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,iBAAiB,EAAE,GAAG,EAAE,CAAC,CAAA;QAEjE,OAAO,OAAO,CAAA;IAChB,CAAC;CACF,CAAA"}

package/dist/backend-seed/generators/seed-module.generator.d.ts

@@ -0,0 +1,2 @@
+import { ContextResult } from '../seed.generator';
+export declare function generateSeedModule(context: ContextResult): string;

package/dist/backend-seed/generators/seed-module.generator.js

@@ -0,0 +1,60 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSeedModule = generateSeedModule;
+const Generator = __importStar(require("@postxl/generator"));
+function generateSeedModule(context) {
+    const imports = Generator.ImportGenerator.from(context.seed.module.location)
+        .add(context.repositories.module)
+        .add(context.actions.module)
+        .add(context.seed.service);
+    return `
+import { forwardRef, Module } from '@nestjs/common'
+${imports.generate()}
+import { XlPortModule } from '@xlport/xlport.module'
+
+
+@Module({
+  imports: [
+    ${context.repositories.module.name},
+    XlPortModule,
+    forwardRef(() => ${context.actions.module.name}),
+  ],
+  providers: [${context.seed.service.name}],
+  exports: [${context.seed.service.name}],
+})
+export class ${context.seed.module.name} {}`;
+}
+//# sourceMappingURL=seed-module.generator.js.map

package/dist/backend-seed/generators/seed-module.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seed-module.generator.js","sourceRoot":"","sources":["../../../src/backend-seed/generators/seed-module.generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,gDAqBC;AAzBD,6DAA8C;AAI9C,SAAgB,kBAAkB,CAAC,OAAsB;IACvD,MAAM,OAAO,GAAG,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC;SACzE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC;SAChC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;SAC3B,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC5B,OAAO;;EAEP,OAAO,CAAC,QAAQ,EAAE;;;;;;MAMd,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI;;uBAEf,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI;;gBAElC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI;cAC3B,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI;;eAExB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,CAAA;AAC5C,CAAC"}

package/dist/backend-seed/generators/seed-service.generator.d.ts

@@ -0,0 +1,2 @@
+import { ContextResult } from '../seed.generator';
+export declare function generateSeedService(context: ContextResult): string;

package/dist/backend-seed/generators/seed-service.generator.js

@@ -0,0 +1,176 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSeedService = generateSeedService;
+const Generator = __importStar(require("@postxl/generator"));
+const schema_1 = require("@postxl/schema");
+function generateSeedService(context) {
+    const seedData = context.seedData;
+    const userModel = context.models.get(schema_1.standardModelName_User);
+    if (!userModel || userModel.repository.kind === 'NoRepository') {
+        throw new Error(`User model is required for seed migrations and must have a repository!`);
+    }
+    const actionsModel = context.models.get(schema_1.standardModelName_Action);
+    if (!actionsModel || actionsModel.repository.kind === 'NoRepository') {
+        throw new Error(`Action model is required for seed migrations and must have a repository!`);
+    }
+    const imports = Generator.ImportGenerator.from(context.seed.service.location)
+        .add(context.actions.dispatcher)
+        .add(context.actions.summary.action)
+        .add(context.import.actions.excel.action)
+        .add(context.import.actions.excelSeed.action)
+        .add(context.repositories.dataService)
+        .addType(seedData.migrationTypes.summary)
+        .addType(seedData.migrationTypes.excel)
+        .addType(seedData.migrationTypes.excelSeed)
+        .add(seedData.seedMigrations);
+    return `
+import { readFile } from 'node:fs/promises'
+
+${imports.generate()}
+import { forwardRef, Inject, Injectable, Logger } from '@nestjs/common'
+
+import { ExhaustiveSwitchCheck, format } from '@postxl/utils'
+
+@Injectable()
+export class ${context.seed.service.name} {
+  private readonly logger = new Logger(${context.seed.service.name}.name)
+
+  constructor(
+    private readonly data: ${context.repositories.dataService.name},
+    @Inject(forwardRef(() => ${context.actions.dispatcher.name})) private readonly dispatcherService: ${context.actions.dispatcher.name},
+  ) {}
+
+  /**
+   * To be called on application startup. Will validate the seed data migrations and execute any pending migrations.
+   *
+   * Each migration is an action, i.e. will be dispatched via the default dispatcher service and logged like any other action.
+   */
+  public async seed() {
+    this.verifyIntegrity()
+
+    // We initialize relevant repositories before seeding
+    // but ignore errors
+    await this.data.init(true)
+
+    let executed = 0
+    for (const migration of migrations) {
+      // Skip any migrations that have already been executed
+      const migrationExists = await this.data.actions.findFirst({
+        predicate: (action) => action.migrationOrder === migration.order && action.status === 'Success',
+        prisma: {migration_order: migration.order, status: 'Success'}
+      })
+
+      if (migrationExists) {
+        continue
+      }
+
+      const action = await this.convertToAction(migration)
+
+      this.logger.log(\`Executing seed migration \${migration.order} - \${migration.name}\`)
+      await this.dispatcherService.dispatch({ action, user: this.data.users.rootUser, migrationOrder: migration.order })
+
+      executed++
+    }
+
+    if (executed === 0) {
+      if (migrations.length > 0) {
+        this.logger.log(\`✅ All \${format(migrations.length)} seed migrations have already been applied\`)
+      } else {
+        this.logger.log('No seed migrations found.')
+      }
+    } else if (executed === migrations.length) {
+      this.logger.log(\`✅ Executed all \${format(executed)} seed migrations\`)
+    } else {
+      this.logger.log(
+        \`✅ Executed \${format(executed)} seed migrations, skipped \${format(migrations.length - executed)} previous migrations\`,
+      )
+    }
+  }
+
+  private async convertToAction(migration: ${seedData.migrationTypes.summary.name}): Promise<Action> {
+    switch (migration.type) {
+      case '${seedData.migrationTypes.customAction.discriminant}':
+        return migration.action
+      case '${seedData.migrationTypes.excel.discriminant}':
+      case '${seedData.migrationTypes.excelSeed.discriminant}':
+        return await this.convertExcelToAction(migration)
+
+      default:
+        throw new ExhaustiveSwitchCheck(migration)
+    }
+  }
+
+  /**
+   * Checks if the order of the migrations is correct and if there are any missing migrations.
+   */
+  private verifyIntegrity() {
+    let startOrder = 0
+    for (const { name, order } of migrations) {
+      if (order <= startOrder) {
+        throw new Error(
+          \`Invalid migration order. The order of migration "\${name}" must be after \${startOrder} but is \${order}. Is the order field correct and the order in the migrations array correct?\`,
+        )
+      }
+      startOrder = order
+    }
+  }
+
+  /**
+   * Reads the Excel file and passes it as the payload to the import action.
+   */
+  private async convertExcelToAction(
+    migration: ${seedData.migrationTypes.excel.name} | ${seedData.migrationTypes.excelSeed.name},
+  ): Promise<${context.import.actions.excel.action.name} | ${context.import.actions.excelSeed.action.name}> {
+    const data = await this.readFileToBuffer(migration.filename)
+    return {
+      scope: 'import',
+      type: migration.type,
+      payload: { filename: migration.filename, data },
+    }
+  }
+
+  private async readFileToBuffer(filePath: string): Promise<Buffer<ArrayBuffer>> {
+    try {
+      const data = await readFile(filePath)
+      return data as Buffer<ArrayBuffer>
+    } catch (error) {
+      this.logger.error(\`Error reading file from disk: \${JSON.stringify(error)}\`)
+      throw error
+    }
+  }
+}`;
+}
+//# sourceMappingURL=seed-service.generator.js.map

package/dist/backend-seed/generators/seed-service.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seed-service.generator.js","sourceRoot":"","sources":["../../../src/backend-seed/generators/seed-service.generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,kDA2IC;AAhJD,6DAA8C;AAC9C,2CAAiF;AAIjF,SAAgB,mBAAmB,CAAC,OAAsB;IACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;IAEjC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,+BAAsB,CAAC,CAAA;IAC5D,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QAC/D,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAA;IAC3F,CAAC;IACD,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,iCAAwB,CAAC,CAAA;IACjE,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,UAAU,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QACrE,MAAM,IAAI,KAAK,CAAC,0EAA0E,CAAC,CAAA;IAC7F,CAAC;IAED,MAAM,OAAO,GAAG,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;SAC1E,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC;SAC/B,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC;SACnC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC;SACxC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC;SAC5C,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC;SACrC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC;SACxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC;SACtC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC;SAC1C,GAAG,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;IAE/B,OAAO;;;EAGP,OAAO,CAAC,QAAQ,EAAE;;;;;;eAML,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI;yCACC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI;;;6BAGrC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI;+BACnC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,0CAA0C,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6CAkD1F,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI;;cAEnE,QAAQ,CAAC,cAAc,CAAC,YAAY,CAAC,YAAY;;cAEjD,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY;cAC1C,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2B3C,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,IAAI,MAAM,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI;eAChF,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI;;;;;;;;;;;;;;;;;;EAkBvG,CAAA;AACF,CAAC"}

package/dist/backend-seed/index.d.ts

@@ -0,0 +1,4 @@
+import * as Generator from './seed.generator';
+export type WithSeed<Context> = Generator.WithBackendSeed<Context>;
+export declare const backendSeedGenerator: import("@postxl/generator").GeneratorInterface;
+export declare const backendSeedGeneratorId: string & import("zod").BRAND<"PXL.GeneratorInterfaceId">;

package/dist/backend-seed/index.js

@@ -0,0 +1,40 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.backendSeedGeneratorId = exports.backendSeedGenerator = void 0;
+const Generator = __importStar(require("./seed.generator"));
+exports.backendSeedGenerator = Generator.generator;
+exports.backendSeedGeneratorId = Generator.generatorId;
+//# sourceMappingURL=index.js.map

package/dist/backend-seed/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/backend-seed/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,4DAA6C;AAGhC,QAAA,oBAAoB,GAAG,SAAS,CAAC,SAAS,CAAA;AAC1C,QAAA,sBAAsB,GAAG,SAAS,CAAC,WAAW,CAAA"}

package/dist/backend-seed/seed.generator.d.ts

@@ -0,0 +1,19 @@
+import * as Generator from '@postxl/generator';
+import { WithActions } from '../backend-actions';
+import { WithBackend } from '../backend-core';
+import { WithBackendImport } from '../backend-import';
+import { WithRepositories } from '../backend-repositories';
+import { WithBase } from '../base';
+import { WithSeedData } from '../seed-data';
+type ContextRequirements = WithSeedData<WithBackendImport<WithActions<WithRepositories<WithBackend<WithBase<Generator.Context>>>>>>;
+export type ContextResult = WithBackendSeed<ContextRequirements>;
+export type WithBackendSeed<Context> = Generator.ExtendContext<Context, {
+    seed: BackendSeedContext;
+}>;
+export type BackendSeedContext = {
+    module: Generator.ImportableItem;
+    service: Generator.ImportableItem;
+};
+export declare const generatorId: string & import("zod").BRAND<"PXL.GeneratorInterfaceId">;
+export declare const generator: Generator.GeneratorInterface;
+export {};

package/dist/backend-seed/seed.generator.js

@@ -0,0 +1,95 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generator = exports.generatorId = void 0;
+const node_path_1 = require("node:path");
+const Generator = __importStar(require("@postxl/generator"));
+const backend_actions_1 = require("../backend-actions");
+const backend_core_1 = require("../backend-core");
+const backend_import_1 = require("../backend-import");
+const backend_repositories_1 = require("../backend-repositories");
+const base_1 = require("../base");
+const seed_module_generator_1 = require("./generators/seed-module.generator");
+const seed_service_generator_1 = require("./generators/seed-service.generator");
+exports.generatorId = Generator.toGeneratorInterfaceId('backend-seed');
+exports.generator = {
+    id: exports.generatorId,
+    requires: [
+        backend_core_1.backendGeneratorId,
+        base_1.baseGeneratorId,
+        backend_actions_1.backendActionsGeneratorId,
+        backend_core_1.backendModuleXlPortGeneratorId,
+        backend_repositories_1.backendRepositoriesGeneratorId,
+        backend_import_1.backendImportGeneratorId,
+    ],
+    register: (context) => {
+        const module = {
+            name: Generator.toClassName('SeedModule'),
+            location: Generator.toBackendModuleLocation(`@seed/seed.module`),
+        };
+        const seedModule = {
+            name: Generator.toBackendModuleName('seed'),
+            moduleClass: module,
+            bootStrap: {
+                import: Generator.ts(`
+          import { SeedService } from '@seed/seed.service'`),
+                code: Generator.ts(`
+          // Executing seeding and initialize data
+            const seedService = app.get(SeedService)
+            await seedService.seed()
+          `),
+            },
+        };
+        context.backend.modules.push(seedModule);
+        const service = {
+            name: Generator.toClassName('SeedService'),
+            location: Generator.toBackendModuleLocation(`@seed/seed.service`),
+        };
+        const seed = { module, service };
+        return { ...context, seed };
+    },
+    generate: async (context) => {
+        const vfsSrc = new Generator.VirtualFileSystem();
+        vfsSrc.write(Generator.toLocalFile(context.seed.service), (0, seed_service_generator_1.generateSeedService)(context));
+        vfsSrc.write(Generator.toLocalFile(context.seed.module), (0, seed_module_generator_1.generateSeedModule)(context));
+        const vfs = new Generator.VirtualFileSystem();
+        vfs.insertFromVfs({ targetPath: 'src', vfs: vfsSrc });
+        await vfs.loadFolder({ diskPath: (0, node_path_1.resolve)(__dirname, './template') });
+        vfs.write('/tsconfig.lib.json', Generator.generateTsConfig('seed'));
+        context.vfs.insertFromVfs({ targetPath: 'backend/libs/seed', vfs });
+        return context;
+    },
+};
+//# sourceMappingURL=seed.generator.js.map

package/dist/backend-seed/seed.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"seed.generator.js","sourceRoot":"","sources":["../../src/backend-seed/seed.generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yCAAmC;AAEnC,6DAA8C;AAE9C,wDAA2E;AAC3E,kDAA+G;AAC/G,sDAA+E;AAC/E,kEAA0F;AAC1F,kCAAmD;AAGnD,8EAAuE;AACvE,gFAAyE;AAY5D,QAAA,WAAW,GAAG,SAAS,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAA;AAE9D,QAAA,SAAS,GAAiC;IACrD,EAAE,EAAE,mBAAW;IACf,QAAQ,EAAE;QACR,iCAAkB;QAClB,sBAAe;QACf,2CAAyB;QACzB,6CAA8B;QAC9B,qDAA8B;QAC9B,yCAAwB;KACzB;IAED,QAAQ,EAAE,CAAsC,OAAgB,EAAiB,EAAE;QACjF,MAAM,MAAM,GAA8B;YACxC,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC,YAAY,CAAC;YACzC,QAAQ,EAAE,SAAS,CAAC,uBAAuB,CAAC,mBAAmB,CAAC;SACjE,CAAA;QAED,MAAM,UAAU,GAAiB;YAC/B,IAAI,EAAE,SAAS,CAAC,mBAAmB,CAAC,MAAM,CAAC;YAC3C,WAAW,EAAE,MAAM;YACnB,SAAS,EAAE;gBACT,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC;2DAC8B,CAAC;gBACpD,IAAI,EAAE,SAAS,CAAC,EAAE,CAAC;;;;WAIhB,CAAC;aACL;SACF,CAAA;QACD,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QACxC,MAAM,OAAO,GAA8B;YACzC,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC;YAC1C,QAAQ,EAAE,SAAS,CAAC,uBAAuB,CAAC,oBAAoB,CAAC;SAClE,CAAA;QAED,MAAM,IAAI,GAAuB,EAAE,MAAM,EAAE,OAAO,EAAE,CAAA;QACpD,OAAO,EAAE,GAAG,OAAO,EAAE,IAAI,EAAE,CAAA;IAC7B,CAAC;IAED,QAAQ,EAAE,KAAK,EAAiC,OAAgB,EAAoB,EAAE;QACpF,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAA;QAChD,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAA,4CAAmB,EAAC,OAAO,CAAC,CAAC,CAAA;QACvF,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAA,0CAAkB,EAAC,OAAO,CAAC,CAAC,CAAA;QAErF,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAA;QAC7C,GAAG,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CAAA;QAErD,MAAM,GAAG,CAAC,UAAU,CAAC,EAAE,QAAQ,EAAE,IAAA,mBAAO,EAAC,SAAS,EAAE,YAAY,CAAC,EAAE,CAAC,CAAA;QAEpE,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAA;QACnE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAA;QAEnE,OAAO,OAAO,CAAA;IAChB,CAAC;CACF,CAAA"}

package/dist/backend-seed/template/src/actions.ts

@@ -0,0 +1,90 @@
+import { IActionExecution } from '@actions/execution/types'
+
+import type z from 'zod'
+// import { DataService } from '@data/data.service'
+// import { BulkMutation } from '@data/types'
+
+/**
+ * Preparation types contain only the information that is needed to prepare the migration.
+ * E.g. Excel migrations need the filename of the Excel file, but not the full data.
+ */
+export type ActionPreparation_Seed =
+  | ActionPreparation_Seed_Seed
+  | ActionPreparation_Seed_Excel
+  | ActionPreparation_Seed_Custom
+
+export type ActionPreparation_Seed_Seed = Action_Seed_Data
+
+export type ActionPreparation_Seed_Excel = {
+  type: 'excel'
+  name: string
+  order: number
+  filename: string
+  // decoder: z.ZodSchema<BulkMutation[], any, any>
+  decoder: z.ZodSchema<any[], any, any>
+}
+
+export type ActionPreparation_Seed_Custom = Action_Seed_CustomLogic & {
+  handler: ({
+    action,
+    execution,
+    data,
+  }: {
+    action: Action_Seed_CustomLogic
+    execution: IActionExecution
+    data: any //DataService
+  }) => Promise<void>
+}
+
+export type Action_Seed = Action_Seed_Data | Action_Seed_Excel | Action_Seed_ExcelError | Action_Seed_CustomLogic
+
+/**
+ * The Result map for all seed actions.
+ *
+ * Used to determine the return type of any seed action
+ */
+export type ActionResult_Seed = {
+  seed: {
+    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+    data: void
+    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+    excel: void
+    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+    'custom-logic': void
+  }
+}
+
+// Shared base type, used by all migration actions
+type Action_Seed_Shared = {
+  scope: 'seed'
+  order: number
+  name: string
+}
+
+export type Action_Seed_Data = Action_Seed_Shared & {
+  type: 'data'
+  payload: any //BulkMutation[]
+}
+
+export type Action_Seed_Excel = Action_Seed_Shared & {
+  type: 'excel'
+  payload: {
+    filename: string
+    data: any //BulkMutation[]
+  }
+}
+
+export type ExcelErrorTypes = 'xlPortError' | 'decoderError'
+
+export type Action_Seed_ExcelError = Action_Seed_Shared & {
+  type: 'excel-error'
+  payload: { filename: string; errorType: ExcelErrorTypes; data?: any; error: any }
+}
+
+/**
+ * Triggers custom seed logic (to be defined by the project)
+ */
+export type Action_Seed_CustomLogic = Action_Seed_Shared & {
+  type: 'custom'
+  payload: unknown // To be defined based on the custom logic
+}

package/dist/backend-seed/template/tsconfig.lib.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "../../dist/libs/seed"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}

package/dist/backend-update/bulk-service.generator.d.ts

@@ -0,0 +1,2 @@
+import { ContextResult } from './update.generator';
+export declare function generateBulkService(context: ContextResult): string;