@postxl/generator 0.74.1 → 1.0.1

package/dist/helpers/import-generator.class.d.ts

@@ -0,0 +1,70 @@
+import { NonEmptyArray } from '@postxl/utils';
+import * as Brands from './branded.types';
+/**
+ * A structured definition of multiple imports: The key of the object is the "from" path,
+ * the value is a list (or single item) of items to import.
+ *
+ * Example:
+ * ```
+ * {
+ *   [context.data.importPath]: context.data.repository.className,
+ *   [context.types.packageName]: [model.id.brandedType, model.typeName],
+ * }
+ * ```
+ */
+export type BulkImportDefinition = Record<Brands.ImportPaths, NonEmptyArray<Brands.ImportableTypes> | Brands.ImportableTypes>;
+/**
+ * A utility component that lets you generate TypeScript import statements
+ * and makes sure every import is only added once.
+ */
+export declare class ImportGenerator {
+    #private;
+    constructor({ path }: {
+        path: string;
+    });
+    /**
+     * Creates a new instance of the imports generator.
+     */
+    static from(path: Brands.ImportPaths): ImportGenerator;
+    /**
+     * Convenience method to add a single import statement.
+     */
+    add({ name, location }: {
+        name: Brands.ImportableTypes;
+        location: Brands.ImportPaths;
+    }): this;
+    /**
+     * Convenience method to add a single import statement.
+     */
+    addType({ name, location }: {
+        name: Brands.TypeName;
+        location: Brands.ImportPaths;
+    }): this;
+    /**
+     * Adds a given import statement to the imports list.
+     */
+    addImport({ items, from: fromSource, }: {
+        items: NonEmptyArray<Brands.ImportableTypes>;
+        from: Brands.ImportPaths;
+    }): this;
+    /**
+     * Adds a given type import statement to the imports list.
+     */
+    addTypeImport({ items, from }: {
+        items: NonEmptyArray<Brands.TypeName>;
+        from: Brands.ImportPaths;
+    }): this;
+    /**
+     * Adds a multiple  import statements to the imports list.
+     */
+    addImports(entries: BulkImportDefinition): this;
+    /**
+     * Returns the TypeScript import statement.
+     */
+    generate(): string;
+    private removeTs;
+    static getRelativePath({ from, to }: {
+        from: string;
+        to: string;
+    }): string;
+}

package/dist/helpers/import-generator.class.js

@@ -0,0 +1,166 @@
+"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.ImportGenerator = void 0;
+const path_1 = require("../utils/path");
+const Brands = __importStar(require("./branded.types"));
+// export type ImportExportLocation = {
+//   /**
+//    * Name of the item to import/export.
+//    */
+//   itemName: Brands.ImportableTypes
+//   /**
+//    * Path of the item to import/export.
+//    */
+//   filePath: Brands.FilePath
+//   /**
+//    * Name of the package that exports the item.
+//    */
+//   packageName?: Brands.PackageName
+// }
+/**
+ * A utility component that lets you generate TypeScript import statements
+ * and makes sure every import is only added once.
+ */
+class ImportGenerator {
+    /**
+     * Lists of values and types we import from a given path indexed by the path.
+     */
+    #imports = {};
+    /**
+     * Path of the file we're generating imports for.
+     */
+    #path;
+    constructor({ path }) {
+        this.#path = this.removeTs(path);
+    }
+    /**
+     * Creates a new instance of the imports generator.
+     */
+    static from(path) {
+        return new ImportGenerator({ path });
+    }
+    /**
+     * Convenience method to add a single import statement.
+     */
+    add({ name, location }) {
+        return this.addImport({ items: [name], from: location });
+    }
+    /**
+     * Convenience method to add a single import statement.
+     */
+    addType({ name, location }) {
+        return this.addTypeImport({ items: [name], from: location });
+    }
+    /**
+     * Adds a given import statement to the imports list.
+     */
+    addImport({ items, from: fromSource, }) {
+        if (items.length === 0) {
+            throw new Error(`You cannot add an import statement without any items from ${fromSource}.`);
+        }
+        const from = this.removeTs(fromSource);
+        // Do not import from self
+        if (from === this.#path) {
+            return this;
+        }
+        const resolvedPath = ImportGenerator.getRelativePath({ from: this.#path, to: from });
+        if (!this.#imports[resolvedPath]) {
+            this.#imports[resolvedPath] = { types: new Set(), nonTypes: new Set() };
+        }
+        items.forEach((item) => {
+            if (Brands.isAnnotatedTypeName(item)) {
+                this.#imports[resolvedPath].types.add(item.typeName);
+            }
+            else {
+                this.#imports[resolvedPath].nonTypes.add(item);
+            }
+        });
+        return this;
+    }
+    /**
+     * Adds a given type import statement to the imports list.
+     */
+    addTypeImport({ items, from }) {
+        return this.addImport({
+            items: items.map((i) => Brands.toAnnotatedTypeName(i)),
+            from,
+        });
+    }
+    /**
+     * Adds a multiple  import statements to the imports list.
+     */
+    addImports(entries) {
+        for (const [key, items] of Object.entries(entries)) {
+            if (Array.isArray(items)) {
+                this.addImport({ items, from: key });
+            }
+            else {
+                this.addImport({ items: [items], from: key });
+            }
+        }
+        return this;
+    }
+    /**
+     * Returns the TypeScript import statement.
+     */
+    generate() {
+        const statements = Object.entries(this.#imports)
+            .sort(([a], [b]) => a.localeCompare(b))
+            .map(([path, items]) => {
+            const nonTypes = Array.from(items.nonTypes).sort((a, b) => a.localeCompare(b));
+            const nonTypesImportStatement = nonTypes.length > 0 ? `import { ${nonTypes.join(', ')} } from '${path}'\n` : '';
+            const types = Array.from(items.types).sort((a, b) => a.localeCompare(b));
+            const typesImportStatement = types.length > 0 ? `import type { ${types.join(', ')} } from '${path}'` : '';
+            return `${nonTypesImportStatement}${typesImportStatement}`;
+        })
+            .join('\n');
+        return statements;
+    }
+    removeTs(path) {
+        return path.replace(/\.ts$/, '');
+    }
+    static getRelativePath({ from, to }) {
+        if (to.startsWith('@') && from.startsWith('@')) {
+            const toModuleName = to.split('/')[0];
+            const fromModuleName = from.split('/')[0];
+            if (toModuleName === fromModuleName) {
+                return (0, path_1.getRelativePath)({ from: from.replace(fromModuleName, '.'), to: to.replace(toModuleName, '.') });
+            }
+        }
+        return (0, path_1.getRelativePath)({ from, to });
+    }
+}
+exports.ImportGenerator = ImportGenerator;

package/dist/helpers/importable.types.d.ts

@@ -0,0 +1,52 @@
+import { BackendModuleLocation, ClassName, ConstantName, FilePath, FunctionName, TypeName } from './branded.types';
+export type ImportableItem = ImportableType | ImportableClass | ImportableFunction | ImportableConstant;
+export type ImportableConstant = {
+    /**
+     * Name of the constant, e.g. `User`, `ExecutionInterface`
+     */
+    readonly name: ConstantName;
+    /**
+     * The location where the constant is imported from, e.g. `@database/database.types`
+     */
+    readonly location: BackendModuleLocation;
+};
+export type ImportableType = {
+    /**
+     * Name of the type, e.g. `User`, `ExecutionInterface`
+     */
+    readonly name: TypeName;
+    /**
+     * The location where the type is imported from, e.g. `@database/database.types`
+     */
+    readonly location: BackendModuleLocation;
+};
+export type ImportableClass = {
+    /**
+     * Name of the type, e.g. `RepositoriesModule`, `ActionService`
+     */
+    readonly name: ClassName;
+    /**
+     * The location where the type is imported from, e.g. `@repositories/repositories.module`
+     */
+    readonly location: BackendModuleLocation;
+};
+export type ImportableFunction = {
+    /**
+     * Name of the type, e.g. `createUser`, `updateUser`
+     */
+    readonly name: FunctionName;
+    /**
+     * The location where the type is imported from, e.g. `@database/database.service`
+     */
+    readonly location: BackendModuleLocation;
+};
+/**
+ * Utility function that converts an importable item to a local file path.
+ */
+export declare function toLocalFile({ location, extension, }: {
+    location: BackendModuleLocation;
+    extension?: string;
+}): FilePath;
+export declare function toLocalReactComponent({ location }: {
+    location: BackendModuleLocation;
+}): string;

package/dist/helpers/importable.types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toLocalFile = toLocalFile;
+exports.toLocalReactComponent = toLocalReactComponent;
+const branded_types_1 = require("./branded.types");
+/**
+ * Utility function that converts an importable item to a local file path.
+ */
+function toLocalFile({ location, extension = 'ts', }) {
+    const moduleName = location.split('/')[0];
+    return (0, branded_types_1.toFilePath)(location.replace(moduleName, '.') + '.' + extension);
+}
+function toLocalReactComponent({ location }) {
+    return toLocalFile({ location, extension: 'tsx' });
+}

package/dist/helpers/index-generator.class.d.ts

@@ -0,0 +1,10 @@
+import { BackendModuleLocation, FilePath } from './branded.types';
+import { ImportableItem } from './importable.types';
+export declare class IndexGenerator {
+    private readonly imports;
+    private readonly root;
+    constructor(root: BackendModuleLocation | FilePath);
+    add(item: BackendModuleLocation | ImportableItem | FilePath): this;
+    generate(): string;
+    private getRelativePath;
+}

package/dist/helpers/index-generator.class.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IndexGenerator = void 0;
+const path_1 = require("../utils/path");
+class IndexGenerator {
+    imports = new Set();
+    root;
+    constructor(root) {
+        if (root.endsWith('.ts') || root.endsWith('.tsx')) {
+            root = root.replace(/\.ts$/, '');
+        }
+        if (!root.endsWith('/index')) {
+            root = (root + '/index');
+        }
+        this.root = root;
+    }
+    add(item) {
+        const location = typeof item === 'string' ? item : item.location;
+        if (this.root.includes(location)) {
+            throw new Error(`You cannot import from the index of the same module that you are exporting from.`);
+        }
+        const path = this.getRelativePath({ from: this.root, to: location });
+        this.imports.add(path);
+        return this;
+    }
+    generate() {
+        if (this.imports.size === 0) {
+            throw new Error('You must add at least one item before generating the index.');
+        }
+        return Array.from(this.imports)
+            .toSorted((a, b) => a.localeCompare(b))
+            .map((f) => `export * from '${f}'`)
+            .join('\n');
+    }
+    getRelativePath({ from, to }) {
+        if (to.startsWith('@') && from.startsWith('@')) {
+            const toModuleName = to.split('/')[0];
+            const fromModuleName = from.split('/')[0];
+            if (toModuleName === fromModuleName) {
+                return (0, path_1.getRelativePath)({ from: from.replace(fromModuleName, '.'), to: to.replace(toModuleName, '.') });
+            }
+        }
+        return (0, path_1.getRelativePath)({ from, to });
+    }
+}
+exports.IndexGenerator = IndexGenerator;

package/dist/helpers/index.d.ts

@@ -0,0 +1,8 @@
+export * from './branded.types';
+export * from './config-builder.class';
+export * from './importable.types';
+export * from './import-generator.class';
+export * from './index-generator.class';
+export * from './package-json.generator';
+export * from './tsconfig.generator';
+export * from './verify-context';

package/dist/helpers/index.js

@@ -0,0 +1,24 @@
+"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("./branded.types"), exports);
+__exportStar(require("./config-builder.class"), exports);
+__exportStar(require("./importable.types"), exports);
+__exportStar(require("./import-generator.class"), exports);
+__exportStar(require("./index-generator.class"), exports);
+__exportStar(require("./package-json.generator"), exports);
+__exportStar(require("./tsconfig.generator"), exports);
+__exportStar(require("./verify-context"), exports);

package/dist/helpers/package-json.generator.d.ts

@@ -0,0 +1,56 @@
+import { BackendModuleName, PackageName } from './branded.types';
+export type PackageJsonConfig = {
+    /**
+     * Name of the package. Should contain `@postxl/` prefix.
+     */
+    name: PackageName;
+    /**
+     * Description of the package.
+     */
+    description: string;
+    /**
+     * package.json dependencies that should be added to the project.
+     *
+     * Example: `ctx.dependencies.push({name: toPackageName("@aws-sdk/client-s3"), version: "3.400.0"})`
+     */
+    dependencies: PackageDependency[];
+    /**
+     * package.json devDependencies that should be added to the project.
+     *
+     * Example: `ctx.devDependencies.push({name: toPackageName("@types/jsonwebtoken"), version: "9.6.0"})`
+     */
+    devDependencies: PackageDependency[];
+    /**
+     * package.json scripts that should be added to the project.
+     *
+     * Example: `ctx.scripts.push({name: 'build', command: 'nest build'})`
+     */
+    scripts: PackageScript[];
+    /**
+     * Type of the package.
+     */
+    type?: 'module' | 'commonjs';
+    /**
+     * The package manager used in the project.
+     */
+    packageManager?: string;
+};
+export type PackageDependency = PackageDependency_Workspace | PackageDependency_Package | PackageDependency_LocalProject;
+export type PackageDependency_Workspace = {
+    packageName: PackageName;
+};
+export type PackageDependency_Package = {
+    packageName: string;
+    version: string;
+};
+export type PackageDependency_LocalProject = {
+    packageName: PackageName;
+    backendModuleName: BackendModuleName;
+    path: string;
+};
+export declare function isLocalProjectDependency(dependency: PackageDependency): dependency is PackageDependency_LocalProject;
+export type PackageScript = {
+    name: string;
+    command: string;
+};
+export declare function generatePackageJson({ dependencies, devDependencies, scripts, name, description, type: pType, packageManager, }: PackageJsonConfig): string;

package/dist/helpers/package-json.generator.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLocalProjectDependency = isLocalProjectDependency;
+exports.generatePackageJson = generatePackageJson;
+function isLocalProjectDependency(dependency) {
+    return 'path' in dependency;
+}
+function generatePackageJson({ dependencies, devDependencies, scripts, name, description, type: pType, packageManager, }) {
+    return JSON.stringify({
+        name,
+        version: '0.0.0',
+        description,
+        ...(pType ? { type: pType } : {}),
+        author: 'PostXL GmbH',
+        private: true,
+        scripts: scripts
+            .toSorted((a, b) => a.name.localeCompare(b.name))
+            .reduce((acc, script) => ({ ...acc, [script.name]: script.command }), {}),
+        packageManager,
+        dependencies: dependencies
+            .map(toDependency_Package)
+            .toSorted((a, b) => a.packageName.localeCompare(b.packageName))
+            .reduce((acc, dep) => ({ ...acc, [dep.packageName]: dep.version }), {}),
+        devDependencies: devDependencies
+            .map(toDependency_Package)
+            .toSorted((a, b) => a.packageName.localeCompare(b.packageName))
+            .reduce((acc, dep) => ({ ...acc, [dep.packageName]: dep.version }), {}),
+        license: 'UNLICENSED',
+    });
+}
+function toDependency_Package(dependency) {
+    if ('version' in dependency) {
+        return dependency;
+    }
+    return { packageName: dependency.packageName, version: 'workspace:*' };
+}

package/dist/helpers/tsconfig.generator.d.ts

@@ -0,0 +1 @@
+export declare function generateTsConfig(name: string): string;

package/dist/helpers/tsconfig.generator.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTsConfig = generateTsConfig;
+function generateTsConfig(name) {
+    return /* json */ `{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "../../dist/libs/${name}"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
+}`;
+}

package/dist/helpers/verify-context.d.ts

@@ -0,0 +1,4 @@
+import { EnumName, ModelName } from '@postxl/schema';
+import { Context as BaseContext } from '../generator.context';
+export declare function verifyModelExists<Context extends BaseContext>(modelName: ModelName, context: Context): void;
+export declare function verifyEnumExists<Context extends BaseContext>(enumName: EnumName, context: Context): void;

package/dist/helpers/verify-context.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifyModelExists = verifyModelExists;
+exports.verifyEnumExists = verifyEnumExists;
+function verifyModelExists(modelName, context) {
+    const model = context.models.get(modelName);
+    if (!model) {
+        err(`Cannot find model ${modelName} in schema! Please ensure that model was added, either to "standardModels" or "model"!`, context);
+    }
+}
+function verifyEnumExists(enumName, context) {
+    const enum_ = context.enums.get(enumName);
+    if (!enum_) {
+        err(`Cannot find enum ${enumName} in schema! Please ensure that enum was added, either to "standardEnums" or "enum"!`, context);
+    }
+}
+function err(message, { options: { ignoreErrors } }) {
+    if (ignoreErrors) {
+        console.error(message);
+        return;
+    }
+    throw new Error(message);
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './helpers';
+export * from './generator.context';
+export * from './generator-manager.class';
+export * from './generator.class';
+export * from './utils';

package/dist/index.js

@@ -0,0 +1,21 @@
+"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("./helpers"), exports);
+__exportStar(require("./generator.context"), exports);
+__exportStar(require("./generator-manager.class"), exports);
+__exportStar(require("./generator.class"), exports);
+__exportStar(require("./utils"), exports);

package/dist/utils/checksum.d.ts

@@ -0,0 +1,10 @@
+import z from 'zod';
+export declare const zChecksum: z.ZodBranded<z.ZodString, "PXL.Checksum">;
+/**
+ * Branded Id type that should be used to identify checksum strings.
+ */
+export type Checksum = z.infer<typeof zChecksum>;
+/**
+ * Returns the checksum of the given file
+ */
+export declare function calculateChecksum(content: string | Buffer): Promise<Checksum>;