@postxl/generators 0.2.2

package/dist/backend-view/view-service.generator.js

@@ -0,0 +1,56 @@
+"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.generateViewService = generateViewService;
+const Generator = __importStar(require("@postxl/generator"));
+function generateViewService(context) {
+    const imports = Generator.ImportGenerator.from(context.view.service.location);
+    const constructor = [];
+    for (const model of Array.from(context.models.values()).toSorted((a, b) => a.name.localeCompare(b.name))) {
+        imports.add(model.view.service);
+        constructor.push(`@Inject(forwardRef(() => ${model.view.service.name}))  public readonly ${model.view.service.variableName} :${model.view.service.name}`);
+    }
+    return /* ts */ `
+import { Inject, Injectable, forwardRef } from '@nestjs/common'
+
+${imports.generate()}
+
+@Injectable()
+export class ${context.view.service.name} {
+  constructor(${constructor.join(',\n')}) {}
+}
+  `;
+}
+//# sourceMappingURL=view-service.generator.js.map

package/dist/backend-view/view-service.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view-service.generator.js","sourceRoot":"","sources":["../../src/backend-view/view-service.generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,kDAqBC;AAzBD,6DAA8C;AAI9C,SAAgB,mBAAmB,CAAC,OAAsB;IACxD,MAAM,OAAO,GAAG,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE7E,MAAM,WAAW,GAAa,EAAE,CAAA;IAChC,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACzG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAC/B,WAAW,CAAC,IAAI,CACd,4BAA4B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,uBAAuB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,KAAK,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CACxI,CAAA;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;;;EAGhB,OAAO,CAAC,QAAQ,EAAE;;;eAGL,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI;gBACxB,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;;GAEpC,CAAA;AACH,CAAC"}

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

@@ -0,0 +1,32 @@
+import * as Generator from '@postxl/generator';
+import { WithBackend } from '../backend-core';
+import { WithRepositories } from '../backend-repositories';
+import { WithBase } from '../base';
+import { WithTypes } from '../types';
+type ContextRequirements = WithRepositories<WithTypes<WithBackend<WithBase<Generator.Context>>>>;
+export type ContextResult = WithView<ContextRequirements>;
+export type ModelResult = Generator.InferModelContext<ContextResult>;
+export type ModelContextResult = Generator.InferModelContext<ContextResult>;
+export type WithView<Context> = Generator.ExtendContextAndModel<Context, {
+    view: ViewContext;
+}, {
+    view: ModelContextView;
+}>;
+export type ViewContext = {
+    module: Generator.ImportableItem;
+    /**
+     * The central view service that gathers and exposes all model view services
+     */
+    service: Generator.ImportableClass;
+};
+export type ModelContextView = {
+    /**
+     * The view service for the model
+     */
+    service: Generator.ImportableClass & {
+        variableName: Generator.VariableName;
+    };
+};
+export declare const generatorId: string & import("zod").BRAND<"PXL.GeneratorInterfaceId">;
+export declare const generator: Generator.GeneratorInterface;
+export {};

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

@@ -0,0 +1,100 @@
+"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 backend_repositories_1 = require("../backend-repositories");
+const base_1 = require("../base");
+const types_1 = require("../types");
+const model_view_service_generator_1 = require("./model-view-service.generator");
+const view_module_generator_1 = require("./view-module.generator");
+const view_service_generator_1 = require("./view-service.generator");
+exports.generatorId = Generator.toGeneratorInterfaceId('backend-view');
+exports.generator = {
+    id: exports.generatorId,
+    requires: [backend_core_1.backendGeneratorId, base_1.baseGeneratorId, types_1.typesGeneratorId, backend_repositories_1.backendRepositoriesGeneratorId],
+    register: (context) => {
+        const module = {
+            name: Generator.toClassName('ViewModule'),
+            location: Generator.toBackendModuleLocation(`@view/view.module`),
+        };
+        const viewModule = {
+            name: Generator.toBackendModuleName('view'),
+            moduleClass: module,
+        };
+        context.backend.modules.push(viewModule);
+        const models = new Map();
+        for (const [modelName, model] of context.models) {
+            models.set(modelName, registerModel(model));
+        }
+        const view = {
+            module,
+            service: {
+                name: Generator.toClassName('ViewService'),
+                location: Generator.toBackendModuleLocation(`@view/view.service`),
+            },
+        };
+        return {
+            ...context,
+            view,
+            models,
+        };
+    },
+    generate: (context) => {
+        const vfsSrc = new Generator.VirtualFileSystem();
+        for (const model of context.models.values()) {
+            vfsSrc.write(Generator.toLocalFile(model.view.service), (0, model_view_service_generator_1.generateModelViewService)({ model, context }));
+        }
+        vfsSrc.write(Generator.toLocalFile(context.view.service), (0, view_service_generator_1.generateViewService)(context));
+        vfsSrc.write(Generator.toLocalFile(context.view.module), (0, view_module_generator_1.generateViewModule)(context));
+        const vfs = new Generator.VirtualFileSystem();
+        vfs.insertFromVfs({ targetPath: 'src', vfs: vfsSrc });
+        vfs.write('/tsconfig.lib.json', Generator.generateTsConfig('view'));
+        context.vfs.insertFromVfs({ targetPath: 'backend/libs/view', vfs });
+        return context;
+    },
+};
+function registerModel(model) {
+    const view = {
+        service: {
+            name: Generator.toClassName(`${model._conjugated.PascalCase}ViewService`),
+            location: Generator.toBackendModuleLocation(`@view/${model._conjugated.camelCase}.view.service`),
+            variableName: Generator.toVariableName(`${model._conjugated.camelCasePlural}`),
+        },
+    };
+    return { ...model, view };
+}
+//# sourceMappingURL=view.generator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"view.generator.js","sourceRoot":"","sources":["../../src/backend-view/view.generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6DAA8C;AAE9C,kDAA+E;AAC/E,kEAA0F;AAC1F,kCAAmD;AACnD,oCAAsD;AAEtD,iFAAyE;AACzE,mEAA4D;AAC5D,qEAA8D;AAgCjD,QAAA,WAAW,GAAG,SAAS,CAAC,sBAAsB,CAAC,cAAc,CAAC,CAAA;AAE9D,QAAA,SAAS,GAAiC;IACrD,EAAE,EAAE,mBAAW;IACf,QAAQ,EAAE,CAAC,iCAAkB,EAAE,sBAAe,EAAE,wBAAgB,EAAE,qDAA8B,CAAC;IAEjG,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;SACpB,CAAA;QACD,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAExC,MAAM,MAAM,GAAgC,IAAI,GAAG,EAAE,CAAA;QACrD,KAAK,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YAChD,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC,CAAA;QAC7C,CAAC;QAED,MAAM,IAAI,GAAgB;YACxB,MAAM;YACN,OAAO,EAAE;gBACP,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC;gBAC1C,QAAQ,EAAE,SAAS,CAAC,uBAAuB,CAAC,oBAAoB,CAAC;aAClE;SACF,CAAA;QACD,OAAO;YACL,GAAG,OAAO;YACV,IAAI;YACJ,MAAM;SACc,CAAA;IACxB,CAAC;IAED,QAAQ,EAAE,CAAgC,OAAgB,EAAW,EAAE;QACrE,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAA;QAEhD,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC;YAC5C,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,IAAA,uDAAwB,EAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;QACvG,CAAC;QACD,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;QACrD,GAAG,CAAC,KAAK,CAAC,oBAAoB,EAAE,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAA;QAEnE,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,mBAAmB,EAAE,GAAG,EAAE,CAAC,CAAA;QAEnE,OAAO,OAAO,CAAA;IAChB,CAAC;CACF,CAAA;AAED,SAAS,aAAa,CAAgD,KAAmB;IACvF,MAAM,IAAI,GAAqB;QAC7B,OAAO,EAAE;YACP,IAAI,EAAE,SAAS,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,UAAU,aAAa,CAAC;YACzE,QAAQ,EAAE,SAAS,CAAC,uBAAuB,CAAC,SAAS,KAAK,CAAC,WAAW,CAAC,SAAS,eAAe,CAAC;YAChG,YAAY,EAAE,SAAS,CAAC,cAAc,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,eAAe,EAAE,CAAC;SAC/E;KACF,CAAA;IAED,OAAO,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,CAAA;AAC3B,CAAC"}

package/dist/base/base.generator.d.ts

@@ -0,0 +1,26 @@
+import * as Generator from '@postxl/generator';
+export type WithBase<Context extends Generator.Context = Generator.Context> = Generator.ExtendContext<Context, {
+    /**
+     * The global configuration for the base generator.
+     *
+     * Allows to extend npm dependencies and scripts for the base generator.
+     */
+    base: BaseContext;
+}>;
+/**
+ * The global configuration for the Base generator.
+ *
+ * Allows to register npm dependencies and scripts.
+ */
+export type BaseContext = {
+    packageJson: Generator.PackageJsonConfig;
+    /**
+     * An example for the module's env configuration.
+     *
+     * Example:
+     * DATABASE_CONNECTION=postgresql://postgres:postgres@localhost:5432/pxl
+     */
+    dotEnvExamples: string[];
+};
+export declare const baseGeneratorId: string & import("zod").BRAND<"PXL.GeneratorInterfaceId">;
+export declare const baseGenerator: Generator.GeneratorInterface;

package/dist/base/base.generator.js

@@ -0,0 +1,138 @@
+"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.baseGenerator = exports.baseGeneratorId = void 0;
+const path = __importStar(require("node:path"));
+const Generator = __importStar(require("@postxl/generator"));
+const workspaceDevDependencies = [
+    { packageName: Generator.toPostXlPackageName('@postxl/generator') },
+    { packageName: Generator.toPostXlPackageName('@postxl/generators') },
+    { packageName: Generator.toPostXlPackageName('@postxl/schema') },
+];
+const baseDevDependencies = [
+    { packageName: '@dotenvx/dotenvx', version: '1.51.1' },
+    { packageName: '@eslint/eslintrc', version: '3.2.0' },
+    { packageName: '@eslint/js', version: '9.10.0' },
+    { packageName: '@typescript-eslint/eslint-plugin', version: '8.46.3' },
+    { packageName: '@typescript-eslint/eslint-plugin', version: '8.46.3' },
+    { packageName: '@typescript-eslint/parser', version: '8.46.3' },
+    { packageName: 'chokidar-cli', version: '3.0.0' },
+    { packageName: 'commander', version: '12.1.0' },
+    { packageName: 'eslint-plugin-react-hooks', version: '5.0.0' },
+    { packageName: 'eslint-plugin-react', version: '7.37.2' },
+    { packageName: 'eslint-plugin-simple-import-sort', version: '12.1.1' },
+    { packageName: 'eslint-plugin-storybook', version: '0.8.0' },
+    { packageName: 'eslint', version: '9.39.1' },
+    { packageName: 'globals', version: '15.14.0' },
+    { packageName: 'jest', version: '29.7.0' },
+    { packageName: 'prettier', version: '3.4.2' },
+    { packageName: 'rimraf', version: '6.1.0' },
+];
+const workspaceScripts = [
+    { name: 'generate', command: 'pnpm run generate:project' },
+    { name: 'generate:project', command: 'node ../../packages/cli/dist/index.js generate' },
+    {
+        name: 'generate:watch',
+        command: "chokidar '../../packages/**/dist/**' '../../generators/**/dist/**' '../../generators/**/template/**' './generate.ts' './postxl-schema.json' -c 'pnpm run generate:project -f -i'",
+    },
+    { name: 'pxl', command: 'node ../../packages/cli/dist/index.js' },
+];
+const baseScripts = [
+    { name: 'lint', command: 'pnpm run -r lint' },
+    { name: 'setup', command: './scripts/setup.sh' },
+    { name: 'docker', command: './scripts/docker.sh' },
+    { name: 'prettier:check', command: 'prettier --check "**/*.{ts,tsx}" --config ../../prettier.config.js' },
+];
+const pnpmWorkspaceYaml = `packages:
+  - 'backend'
+  - 'frontend'
+  - 'e2e'
+`;
+const turboJson = `{
+  "$schema": "https://turbo.build/schema.json",
+  "tasks": {
+    "build": {
+      "dependsOn": ["^build"],
+      "outputs": ["dist/**"]
+    }
+  }
+}
+`;
+exports.baseGeneratorId = Generator.toGeneratorInterfaceId('base');
+exports.baseGenerator = {
+    id: exports.baseGeneratorId,
+    implementsInterface: [exports.baseGeneratorId],
+    requires: [],
+    register: (context) => {
+        const isWorkspaceProject = context.schema.projectType.kind === 'workspace';
+        const base = {
+            packageJson: {
+                name: Generator.toPostXlPackageName(`@postxl/${context.schema.slug}`),
+                description: context.schema.description,
+                dependencies: [],
+                devDependencies: [...baseDevDependencies, ...(isWorkspaceProject ? workspaceDevDependencies : [])],
+                packageManager: 'pnpm@10.25.0',
+                scripts: [...baseScripts, ...(isWorkspaceProject ? workspaceScripts : [])],
+            },
+            dotEnvExamples: [],
+        };
+        return {
+            ...context,
+            base,
+        };
+    },
+    generate: async (ctx) => {
+        const vfs = new Generator.VirtualFileSystem();
+        // Load the template
+        await vfs.loadFolder({
+            diskPath: path.resolve(__dirname, './template'),
+        });
+        // write dynamic files
+        vfs.write('/package.json', Generator.generatePackageJson(ctx.base.packageJson));
+        const env = ctx.base.dotEnvExamples.join('\n');
+        vfs.write('/.env.example', env);
+        // We write the .env file so that the project can get started without the need for the developer to
+        // copy the .env.example file. The .env file is not committed to the repository as it is part of the
+        // .gitignore file.
+        vfs.write('/.env', env);
+        if (ctx.schema.projectType.kind === 'standalone') {
+            vfs.write('pnpm-workspace.yaml', pnpmWorkspaceYaml);
+            vfs.write('turbo.json', turboJson);
+        }
+        ctx.vfs.insertFromVfs({ vfs, targetPath: '.' });
+        return ctx;
+    },
+};
+//# sourceMappingURL=base.generator.js.map

package/dist/base/base.generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.generator.js","sourceRoot":"","sources":["../../src/base/base.generator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,gDAAiC;AAEjC,6DAA8C;AA8B9C,MAAM,wBAAwB,GAAkC;IAC9D,EAAE,WAAW,EAAE,SAAS,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,EAAE;IACnE,EAAE,WAAW,EAAE,SAAS,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,EAAE;IACpE,EAAE,WAAW,EAAE,SAAS,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,EAAE;CACjE,CAAA;AAED,MAAM,mBAAmB,GAAkC;IACzD,EAAE,WAAW,EAAE,kBAAkB,EAAE,OAAO,EAAE,QAAQ,EAAE;IACtD,EAAE,WAAW,EAAE,kBAAkB,EAAE,OAAO,EAAE,OAAO,EAAE;IACrD,EAAE,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE;IAChD,EAAE,WAAW,EAAE,kCAAkC,EAAE,OAAO,EAAE,QAAQ,EAAE;IACtE,EAAE,WAAW,EAAE,kCAAkC,EAAE,OAAO,EAAE,QAAQ,EAAE;IACtE,EAAE,WAAW,EAAE,2BAA2B,EAAE,OAAO,EAAE,QAAQ,EAAE;IAC/D,EAAE,WAAW,EAAE,cAAc,EAAE,OAAO,EAAE,OAAO,EAAE;IACjD,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,EAAE;IAC/C,EAAE,WAAW,EAAE,2BAA2B,EAAE,OAAO,EAAE,OAAO,EAAE;IAC9D,EAAE,WAAW,EAAE,qBAAqB,EAAE,OAAO,EAAE,QAAQ,EAAE;IACzD,EAAE,WAAW,EAAE,kCAAkC,EAAE,OAAO,EAAE,QAAQ,EAAE;IACtE,EAAE,WAAW,EAAE,yBAAyB,EAAE,OAAO,EAAE,OAAO,EAAE;IAC5D,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE;IAC5C,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE;IAC9C,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE;IAC1C,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAAE;IAC7C,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE;CAC5C,CAAA;AAED,MAAM,gBAAgB,GAA8B;IAClD,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,2BAA2B,EAAE;IAC1D,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,EAAE,gDAAgD,EAAE;IACvF;QACE,IAAI,EAAE,gBAAgB;QACtB,OAAO,EACL,kLAAkL;KACrL;IACD,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,uCAAuC,EAAE;CAClE,CAAA;AAED,MAAM,WAAW,GAA8B;IAC7C,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE;IAC7C,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,oBAAoB,EAAE;IAChD,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,qBAAqB,EAAE;IAClD,EAAE,IAAI,EAAE,gBAAgB,EAAE,OAAO,EAAE,oEAAoE,EAAE;CAC1G,CAAA;AAED,MAAM,iBAAiB,GAAG;;;;CAIzB,CAAA;AAED,MAAM,SAAS,GAAG;;;;;;;;;CASjB,CAAA;AAEY,QAAA,eAAe,GAAG,SAAS,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;AAE1D,QAAA,aAAa,GAAiC;IACzD,EAAE,EAAE,uBAAe;IACnB,mBAAmB,EAAE,CAAC,uBAAe,CAAC;IACtC,QAAQ,EAAE,EAAE;IAEZ,QAAQ,EAAE,CACR,OAA4B,EACb,EAAE;QACjB,MAAM,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,KAAK,WAAW,CAAA;QAE1E,MAAM,IAAI,GAAgB;YACxB,WAAW,EAAE;gBACX,IAAI,EAAE,SAAS,CAAC,mBAAmB,CAAC,WAAW,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACrE,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW;gBACvC,YAAY,EAAE,EAAE;gBAChB,eAAe,EAAE,CAAC,GAAG,mBAAmB,EAAE,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;gBAClG,cAAc,EAAE,cAAc;gBAC9B,OAAO,EAAE,CAAC,GAAG,WAAW,EAAE,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;aAC3E;YACD,cAAc,EAAE,EAAE;SACnB,CAAA;QACD,OAAO;YACL,GAAG,OAAO;YACV,IAAI;SACY,CAAA;IACpB,CAAC;IAED,QAAQ,EAAE,KAAK,EAAyC,GAAM,EAAc,EAAE;QAC5E,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAA;QAE7C,oBAAoB;QACpB,MAAM,GAAG,CAAC,UAAU,CAAC;YACnB,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,YAAY,CAAC;SAChD,CAAC,CAAA;QAEF,sBAAsB;QACtB,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,SAAS,CAAC,mBAAmB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAA;QAE/E,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC9C,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;QAC/B,mGAAmG;QACnG,oGAAoG;QACpG,mBAAmB;QACnB,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;QAEvB,IAAI,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACjD,GAAG,CAAC,KAAK,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,CAAA;YACnD,GAAG,CAAC,KAAK,CAAC,YAAY,EAAE,SAAS,CAAC,CAAA;QACpC,CAAC;QAED,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,CAAC,CAAA;QAC/C,OAAO,GAAG,CAAA;IACZ,CAAC;CACF,CAAA"}

package/dist/base/index.d.ts

@@ -0,0 +1 @@
+export * from './base.generator';

package/dist/base/index.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./base.generator"), exports);
+//# sourceMappingURL=index.js.map

package/dist/base/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/base/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAgC"}

package/dist/base/template/.nvmrc

@@ -0,0 +1 @@
+v24.11.0

package/dist/base/template/.prettierignore

@@ -0,0 +1,5 @@
+/**/dist
+/**/node_modules
+/**/generated
+/**/*.gen.ts
+/backend/libs/database/src/prisma/**/*

package/dist/base/template/.turboignore

@@ -0,0 +1 @@
+tsconfig.generate.json

package/dist/base/template/.vscode/extensions.json

@@ -0,0 +1,16 @@
+{
+  "recommendations": [
+    // ESLint
+    "dbaeumer.vscode-eslint",
+    // Prettier
+    "esbenp.prettier-vscode",
+    // Spell Checker
+    "streetsidesoftware.code-spell-checker",
+    // Prisma (also to avoid conflicts between Prisma and Prisma Insiders)
+    "prisma.prisma",
+    // MDX Support
+    "unifiedjs.vscode-mdx",
+    // Shell Script
+    "foxundermoon.shell-format"
+  ]
+}

package/dist/base/template/.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Attach",
+      "port": 9229,
+      "request": "attach",
+      "skipFiles": ["<node_internals>/**"],
+      "type": "node"
+    }
+  ]
+}

package/dist/base/template/.vscode/settings.json

@@ -0,0 +1,73 @@
+{
+  "files.eol": "\n",
+  "search.useIgnoreFiles": false,
+  "search.exclude": {
+    "**/.next": true,
+    "**/*.code-search": true,
+    "**/bower_components": true,
+    "**/node_modules": true,
+    "**/dist": true,
+    "pnpm-lock.yaml": true
+  },
+  "eslint.workingDirectories": ["./backend", "./web", "./e2e", "./frontend"],
+
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "always"
+  },
+  "editor.formatOnSave": true,
+  "editor.formatOnPaste": false,
+  "prettier.configPath": "./prettier.config.js",
+  "editor.detectIndentation": false,
+  "editor.tabSize": 2,
+  "editor.insertSpaces": true,
+
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "[prisma]": {
+    "editor.defaultFormatter": "Prisma.prisma"
+  },
+
+  "jest.runMode": {
+    "type": "on-save",
+    "testFileOnly": true
+  },
+
+  "cSpell.words": [
+    "backlink",
+    "Dockerfiles",
+    "fastify",
+    "formik",
+    "keycloak",
+    "lockfiles",
+    "monorepository",
+    "NOSONAR",
+    "postxl",
+    "pxl",
+    "pxlignore",
+    "roadmap",
+    "trpc",
+    "watchlist",
+    "xlport"
+  ],
+  "[shellscript]": {
+    "editor.defaultFormatter": "foxundermoon.shell-format"
+  },
+  "[dockerfile]": {
+    "editor.defaultFormatter": "ms-azuretools.vscode-docker"
+  },
+  "[dotenv]": {
+    "editor.defaultFormatter": "foxundermoon.shell-format"
+  },
+  "[ignore]": {
+    "editor.defaultFormatter": "foxundermoon.shell-format"
+  },
+  "sonarlint.connectedMode.project": {
+    "connectionId": "postxl",
+    "projectKey": "PostXL_usp-msm"
+  },
+  "[properties]": {
+    "editor.defaultFormatter": "foxundermoon.shell-format"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
+}

package/dist/base/template/README.md

@@ -0,0 +1,115 @@
+# PostXL Project Template
+
+This document only provides quick setup instructions for the project.
+
+A detailed documentation can be found in the [docs](./docs) folder!
+
+## Quick Setup
+
+```sh
+# Install dependencies, copy `.env.example` files, ...
+pnpm run setup
+
+# Overwrite `.env` files.
+pnpm run setup -f
+
+# Start the Postgres DB and Keycloak server
+docker compose up -d db keycloak
+
+# Create initial migration (required)!
+pnpm prisma migrate dev
+
+# Start backend
+pnpm run --dir backend/ dev
+
+# Start frontend
+pnpm run --dir frontend/ dev
+```
+
+### Workspace Set Up
+
+- (Visual Studio Code)[https://code.visualstudio.com/download]
+- (Cursor)[https://cursor.sh/]
+
+Prerequisites/software needed:
+
+- (Git)[https://git-scm.com/download/win]
+- (Docker)[https://docs.docker.com/docker-for-windows/install/]
+
+#### Installing NodeJS
+
+Use Node Version Manager to download the appropriate NodeJS version.
+
+- (MacOS) [Homebrew](https://formulae.brew.sh/formula/nvm)
+- (Windows) [Guide](https://www.freecodecamp.org/news/nvm-for-windows-how-to-download-and-install-node-version-manager-in-windows-10/)
+
+Once you've installed `nvm`, navigate to the root of the repository and run.
+
+```sh
+# NVM will automatically detect the Node version from `.nvmrc` file in the root.
+nvm install
+nvm use
+```
+
+> You should run `nvm use` whenever you start developing the product, to make sure the whole team is on the same NodeJS version.
+
+#### Installing pnpm
+
+We are using [pnpm](https://pnpm.io/installation#using-npm) for dependency management. To install all dependencies, navigate to the project root and run the following command:
+
+```sh
+npm install -g pnpm
+```
+
+```sh
+pnpm i
+```
+
+#### Setting Up Environment Variables
+
+Create a copy of `.env.example` file called `.env` for every `.env.example` file in the project! If you already ran `pnpm run setup -f` before, this step was included.
+
+#### Migrating the Database
+
+MSM uses Prisma and Prisma ships with a database migration utility. To run and create migrations, use the following command or check the migration [docs](https://www.prisma.io/docs/reference/api-reference/command-reference#prisma-migrate).
+
+```sh
+# Apply local migrations or Create a new migration
+pnpm prisma migrate dev
+```
+
+Note: For E2E tests, we set up a separate database - which you need also need to migrate. Check `/.env` which database is configured for the database migration!
+
+#### Running the project
+
+To start the project run `pnpm dev` in the `backend` folder to start the server, and `pnpm dev` in the `web` folder to start the frontend.
+
+```bash
+# backend
+pnpm dev
+
+# web
+pnpm dev
+pnpm storybook:start
+```
+
+---
+
+## E2E Testing
+
+See the [E2E Testing](./e2e/README.md) documentation.
+
+---
+
+## Miscellaneous
+
+#### I am getting a Prisma error when starting server
+
+```
+Invalid `prisma.config.findFirst()` invocation:
+
+
+The table `PXL.Config` does not exist in the current database.
+```
+
+You need to run `pnpm prisma migrate dev` first to create an initial migration and tables in the database.