@postxl/generator 0.74.2 → 1.0.1

package/dist/lib/schema/types.js

@@ -1,112 +0,0 @@
-"use strict";
-// MARK: - Generated content related types
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.toPackageName = exports.toPath = exports.toBackendModulePath = exports.toModuleLocation = exports.toFolderName = exports.toFileName = exports.toVariableName = exports.toFunctionName = exports.toEnumName = exports.toFieldName = exports.ID_FIELD_NAME = exports.isAnnotatedTypeName = exports.toAnnotatedTypeName = exports.toTypeName = exports.toModelName = exports.toDiscriminantName = exports.toClassName = void 0;
-/**
- * Converts a raw string to a branded ClassName.
- */
-const toClassName = (t) => t;
-exports.toClassName = toClassName;
-/**
- * Brands a raw string as a discriminant.
- */
-const toDiscriminantName = (t) => t;
-exports.toDiscriminantName = toDiscriminantName;
-/**
- * Brands a raw string to a ModelName identifier.
- */
-const toModelName = (t) => t;
-exports.toModelName = toModelName;
-/**
- * Brands a raw string to a TypeScript Type identifier.
- */
-const toTypeName = (t) => t;
-exports.toTypeName = toTypeName;
-/**
- * Converts a branded string to a branded TypeName.
- */
-const toAnnotatedTypeName = (name) => ({
-    typeName: name,
-    kind: 'TypeName',
-});
-exports.toAnnotatedTypeName = toAnnotatedTypeName;
-/**
- * Type guard to check if a given type is an AnnotatedTypeName.
- */
-const isAnnotatedTypeName = (t) => typeof t === 'object' && t.kind === 'TypeName';
-exports.isAnnotatedTypeName = isAnnotatedTypeName;
-/**
- * Brands a raw string to an IdFieldName identifier.
- */
-exports.ID_FIELD_NAME = 'id';
-/**
- * Brands a raw string to a FieldName identifier.
- */
-const toFieldName = (t) => t;
-exports.toFieldName = toFieldName;
-/**
- * Brands a raw string to an EnumName identifier.
- */
-const toEnumName = (t) => t;
-exports.toEnumName = toEnumName;
-/**
- * Converts a string to a branded function name.
- */
-const toFunctionName = (t) => t;
-exports.toFunctionName = toFunctionName;
-/**
- * Converts a string to a branded VariableName.
- */
-const toVariableName = (t) => t;
-exports.toVariableName = toVariableName;
-/**
- * Lets you brand a string value as a name of the file.
- *
- * NOTE: THIS SHOULD NOT BE A PATH!
- */
-const toFileName = (t) => t;
-exports.toFileName = toFileName;
-/**
- * Converts a string to a branded FolderName.
- */
-const toFolderName = (t) => t;
-exports.toFolderName = toFolderName;
-/**
- * Converts a absolute module file path and a module name to a concrete location.
- *
- * @example
- *
- * ```ts
- * toModuleLocation(`actions`, `./backend/libs/actions/src/dispatcher.service`)
- * //  {
- * //    path: '/backend/libs/actions/src/dispatcher.service',
- * //    import: '@backend/actions/dispatcher.service'
- * //  }
- * ```
- */
-const toModuleLocation = (moduleName, absoluteFilePath) => {
-    // NOTE: We assume that the file path contains the backend path and a module name
-    //       and a file is located in the `src` or `e2e` folder.
-    const TEST = new RegExp(`(^.+/${moduleName}/src/)|(^.+/e2e/)`);
-    if (!absoluteFilePath.match(TEST)) {
-        throw new Error(`The file path "${absoluteFilePath}" does not contain the module name "${moduleName}" or is not located in the "src" or "e2e" folder!`);
-    }
-    const importPath = absoluteFilePath.replace(TEST, `${moduleName}/`);
-    return {
-        path: (0, exports.toPath)(absoluteFilePath),
-        import: (0, exports.toBackendModulePath)(`@backend/${importPath}`),
-    };
-};
-exports.toModuleLocation = toModuleLocation;
-/**
- * Converts a string to a branded BackendModulePath.
- */
-const toBackendModulePath = (t) => t;
-exports.toBackendModulePath = toBackendModulePath;
-/**
- * Converts a string to a branded PAth.
- */
-const toPath = (t) => t;
-exports.toPath = toPath;
-const toPackageName = (t) => t;
-exports.toPackageName = toPackageName;

package/dist/lib/serializer.d.ts

@@ -1,15 +0,0 @@
-/**
- * Lets you serialize a string content easily.
- */
-export declare class Serializer {
-    private _content;
-    constructor();
-    /**
-     * Appends given content to the file and inserts a newline.
-     */
-    append(content: string): void;
-    /**
-     * Returns the contents of the serializer.
-     */
-    print(): string;
-}

package/dist/lib/serializer.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Serializer = void 0;
-/**
- * Lets you serialize a string content easily.
- */
-class Serializer {
-    constructor() {
-        this._content = '';
-    }
-    /**
-     * Appends given content to the file and inserts a newline.
-     */
-    append(content) {
-        this._content += `${content}\n`;
-    }
-    /**
-     * Returns the contents of the serializer.
-     */
-    print() {
-        return this._content;
-    }
-}
-exports.Serializer = Serializer;

package/dist/lib/test-id-collector.d.ts

@@ -1,42 +0,0 @@
-export type TestId = string & {
-    __brand: 'ElementId';
-};
-/**
- * The TestIdCollector is used to generate and track HTML element IDs.
- * The idea is that it is instantiated once and then used to generate IDs throughout the generators.
- * After the files are generated, all generated IDs can be serialized to a file.
- *
- * An ID can for instance be something like `post-create-name, `${model.name}-${componentType}-${fieldName}`.
- *
- * Each code generator can instantiate a TestIdCollector - the constructor will require the current model & component type.
- * All generated Ids will be stored in a global static Set so we can serialize them later.
- */
-export declare class TestIdCollector {
-    private _prefix;
-    /**
-     * We store all generated IDs in a global static Set so we can serialize them later.
-     */
-    private static _ids;
-    constructor(_prefix: string);
-    /**
-     * Creates a new instance of the TestIdCollector.
-     */
-    static from(prefix: string): TestIdCollector;
-    /**
-     * Generates a new ID for an element and stores it in the collector
-     */
-    idFor(
-    /**
-     * The name of the element, e.g. `age`, `submit`.
-     */
-    elementName: string, options?: {
-        /**
-         * Optional prefix for the type of the element, e.g. `field` or `button`.
-         */
-        typePrefix?: string;
-    }): TestId;
-    /**
-     * Returns all generated IDs and resets the stored IDs.
-     */
-    static flush(): TestId[];
-}

package/dist/lib/test-id-collector.js

@@ -1,53 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestIdCollector = void 0;
-/**
- * The TestIdCollector is used to generate and track HTML element IDs.
- * The idea is that it is instantiated once and then used to generate IDs throughout the generators.
- * After the files are generated, all generated IDs can be serialized to a file.
- *
- * An ID can for instance be something like `post-create-name, `${model.name}-${componentType}-${fieldName}`.
- *
- * Each code generator can instantiate a TestIdCollector - the constructor will require the current model & component type.
- * All generated Ids will be stored in a global static Set so we can serialize them later.
- */
-class TestIdCollector {
-    constructor(_prefix) {
-        this._prefix = _prefix;
-    }
-    /**
-     * Creates a new instance of the TestIdCollector.
-     */
-    static from(prefix) {
-        return new TestIdCollector(prefix);
-    }
-    /**
-     * Generates a new ID for an element and stores it in the collector
-     */
-    idFor(
-    /**
-     * The name of the element, e.g. `age`, `submit`.
-     */
-    elementName, options) {
-        const { typePrefix } = options !== null && options !== void 0 ? options : {};
-        const id = [this._prefix, typePrefix, elementName].filter((x) => x !== undefined && x !== '').join('-');
-        if (TestIdCollector._ids.has(id)) {
-            throw new Error(`ID ${id} already exists.`);
-        }
-        TestIdCollector._ids.add(id);
-        return id;
-    }
-    /**
-     * Returns all generated IDs and resets the stored IDs.
-     */
-    static flush() {
-        const result = [...TestIdCollector._ids.values()];
-        TestIdCollector._ids.clear();
-        return result;
-    }
-}
-exports.TestIdCollector = TestIdCollector;
-/**
- * We store all generated IDs in a global static Set so we can serialize them later.
- */
-TestIdCollector._ids = new Set();

package/dist/lib/types.d.ts

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

package/dist/lib/types.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExhaustiveSwitchCheck = void 0;
-/**
- * Makes a type check that is only valid when all cases of a switch
- * statement have been covered.
- */
-class ExhaustiveSwitchCheck extends Error {
-    constructor(val) {
-        super(`Unreachable case: ${JSON.stringify(val)}`);
-    }
-}
-exports.ExhaustiveSwitchCheck = ExhaustiveSwitchCheck;

package/dist/lib/typescript.d.ts

@@ -1,5 +0,0 @@
-import { Field } from './schema/schema';
-/**
- * Converts a field to a TypeScript type definition.
- */
-export declare function getFieldType(f: Field): string;

package/dist/lib/typescript.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFieldType = void 0;
-const types_1 = require("./types");
-/**
- * Converts a field to a TypeScript type definition.
- */
-function getFieldType(f) {
-    switch (f.kind) {
-        case 'enum':
-            return f.typeName;
-        case 'relation':
-            return f.relationToModel.brandedIdType;
-        case 'id':
-            return f.model.brandedIdType;
-        case 'scalar':
-            return f.tsTypeName;
-        default:
-            throw new types_1.ExhaustiveSwitchCheck(f);
-    }
-}
-exports.getFieldType = getFieldType;

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

@@ -1,29 +0,0 @@
-/**
- * A collection of utility functions that let you more easily write TypeScript code.
- */
-/**
- * Utility function that lets you easily create a TypeScript switch statement.
- */
-export declare function createSwitchStatement({ field, cases, defaultBlock, }: {
-    /**
-     * The variable name to switch on.
-     */
-    field: string;
-    /**
-     * The cases to switch on.
-     */
-    cases: {
-        /**
-         * The value to match.
-         */
-        match: string;
-        /**
-         * The body of the switch case.
-         */
-        block: string;
-    }[];
-    /**
-     * The execution block of the default case.
-     */
-    defaultBlock?: string;
-}): string;

package/dist/lib/utils/ast.js

@@ -1,23 +0,0 @@
-"use strict";
-/**
- * A collection of utility functions that let you more easily write TypeScript code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSwitchStatement = void 0;
-/**
- * Utility function that lets you easily create a TypeScript switch statement.
- */
-function createSwitchStatement({ field, cases, defaultBlock, }) {
-    const _cases = cases.map(_createSwitchCase).join('\n');
-    const _default = defaultBlock ? `default: {\n${defaultBlock}\n}` : '';
-    return `
-switch (${field}) {
-	${_cases}
-	${_default}
-}
-	`;
-}
-exports.createSwitchStatement = createSwitchStatement;
-function _createSwitchCase({ match, block, }) {
-    return `case ${match}: {\n${block}\n}`;
-}

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

@@ -1,17 +0,0 @@
-import z from 'zod';
-/**
- * Prisma generator often overwrites any error message because of some concurrency issues.
- * By showing the error via console.log and throwing it again, we ensure that the error message is shown.
- */
-export declare function throwError(message: string): never;
-/**
- * Extracts the error message from an error object or any other object.
- */
-export declare function extractError(error: unknown): string;
-/**
- * Tries to extract and format a Zod error to a nice log string, color highlighting
- * the object properties that failed validation and their respective error messages.
- *
- * As a fallback, it returns a JSON string representation of the error.
- */
-export declare function formatZodError(e: z.ZodError): string;

package/dist/lib/utils/error.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatZodError = exports.extractError = exports.throwError = void 0;
-/**
- * Prisma generator often overwrites any error message because of some concurrency issues.
- * By showing the error via console.log and throwing it again, we ensure that the error message is shown.
- */
-function throwError(message) {
-    const m = ` ❌❌❌ ${message}`;
-    console.error(m);
-    throw new Error(m);
-}
-exports.throwError = throwError;
-/**
- * Extracts the error message from an error object or any other object.
- */
-function extractError(error) {
-    if (error instanceof Error) {
-        return error.message;
-    }
-    return JSON.stringify(error);
-}
-exports.extractError = extractError;
-function extractNestedErrors(value) {
-    if (!value._errors) {
-        return '';
-    }
-    return value._errors.join(' or ');
-}
-/**
- * Tries to extract and format a Zod error to a nice log string, color highlighting
- * the object properties that failed validation and their respective error messages.
- *
- * As a fallback, it returns a JSON string representation of the error.
- */
-function formatZodError(e) {
-    const formatted = e.format();
-    if (typeof formatted === 'string') {
-        return formatted;
-    }
-    if (typeof formatted !== 'object') {
-        return JSON.stringify(e.format(), null, 2);
-    }
-    if (formatted._errors && formatted._errors.length > 0) {
-        return `\t${formatted._errors.join(' or ')}`;
-    }
-    return Object.entries(formatted)
-        .filter(([key]) => key !== '_errors')
-        .map(([key, value]) => `\t${key}:\t ${extractNestedErrors(value)}`)
-        .join('\n');
-}
-exports.formatZodError = formatZodError;

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

@@ -1,10 +0,0 @@
-/**
- * Returns the relative path from one file (e.g. current file) to another file
- * assuming that both files have the same starting point (e.g. from `/a` to `/b/c` is `./b/c`).
- *
- * If the referenced file is a package, then we return the package reference (e.g. `@lib/package`).
- */
-export declare function getRelativePath({ from, to }: {
-    from: string;
-    to: string;
-}): string;

package/dist/lib/utils/file.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRelativePath = void 0;
-/**
- * Returns the relative path from one file (e.g. current file) to another file
- * assuming that both files have the same starting point (e.g. from `/a` to `/b/c` is `./b/c`).
- *
- * If the referenced file is a package, then we return the package reference (e.g. `@lib/package`).
- */
-function getRelativePath({ from, to }) {
-    if (to.startsWith('@')) {
-        return to;
-    }
-    const fromParts = _resolvePath(from);
-    const toParts = _resolvePath(to);
-    // NOTE: We expect that from value references a file of a file in a given folder.
-    // Relative to that file, we need to remove it.
-    fromParts.pop();
-    // Remove common parts.
-    while (fromParts.length > 0 && toParts.length > 0 && fromParts[0] === toParts[0]) {
-        fromParts.shift();
-        toParts.shift();
-    }
-    // Add ../ for each remaining part in fromParts.
-    const relativePath = fromParts
-        .map(() => '..')
-        .concat(toParts)
-        .join('/');
-    if (relativePath.startsWith('.')) {
-        return relativePath;
-    }
-    return `./${relativePath}`;
-}
-exports.getRelativePath = getRelativePath;
-/**
- * Returns a list of folders leading from the root to the referenecd file or folder and removes
- * any positional paths.
- */
-function _resolvePath(path) {
-    const chunks = path.split('/');
-    const resolved = [];
-    while (chunks.length > 0) {
-        // NOTE: We can safely force unwrap here because we check the length of the array.
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        const chunk = chunks.shift();
-        if (chunk === '..') {
-            resolved.pop();
-            continue;
-        }
-        if (chunk === '.') {
-            continue;
-        }
-        resolved.push(chunk);
-    }
-    return resolved;
-}

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

@@ -1,9 +0,0 @@
-import type { Field } from '../schema/schema';
-/**
- * Returns a string of JSDoc comments from an array of lines.
- */
-export declare function toJsDocComment(comments: string[] | undefined): string;
-/**
- * Returns a JSDoc comment for a field.
- */
-export declare function getFieldComment(f: Field): string;

package/dist/lib/utils/jsdoc.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFieldComment = exports.toJsDocComment = void 0;
-/**
- * Returns a string of JSDoc comments from an array of lines.
- */
-function toJsDocComment(comments) {
-    if (!comments || comments.length === 0) {
-        return '';
-    }
-    return `/**${comments
-        .filter((c) => c !== '')
-        .map((c) => `\n   * ${c}`)
-        .join('')} \n   */`;
-}
-exports.toJsDocComment = toJsDocComment;
-/**
- * Returns a JSDoc comment for a field.
- */
-function getFieldComment(f) {
-    const lines = [];
-    if (f.description) {
-        lines.push(...f.description.split('\n'));
-    }
-    else if (f.kind === 'enum' && f.enumerator.description) {
-        lines.push(...f.enumerator.description.split('\n'));
-    }
-    const _examples = f.attributes.examples;
-    if (_examples) {
-        lines.push(`Examples: ${_examples.map((e) => `"${e}"`).join(', ')}`);
-    }
-    if (lines.length === 0) {
-        return '';
-    }
-    return toJsDocComment(lines);
-}
-exports.getFieldComment = getFieldComment;

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

@@ -1,17 +0,0 @@
-/**
- * A generic logger interface.
- * Compatible with the `@prisma/internals` logger and console.
- */
-export interface Logger {
-    log(...data: unknown[]): void;
-    warn(message: unknown, ...optionalParams: unknown[]): void;
-    info(message: unknown, ...optionalParams: unknown[]): void;
-    error(message: unknown, ...optionalParams: unknown[]): void;
-    query(message: unknown, ...optionalParams: unknown[]): void;
-}
-/**
- * Highlights a string cyan
- *
- * NOTE: We would normally use `chalk.cyan` here, but this causes an error in the Prisma generator, so we use this workaround.
- */
-export declare function highlight(str: string): string;

package/dist/lib/utils/logger.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.highlight = void 0;
-/**
- * Highlights a string cyan
- *
- * NOTE: We would normally use `chalk.cyan` here, but this causes an error in the Prisma generator, so we use this workaround.
- */
-function highlight(str) {
-    return `\u001B[36m${str}\u001B[39m`;
-}
-exports.highlight = highlight;

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

@@ -1,40 +0,0 @@
-/**
- * Returns the same string with a lowercase first letter.
- */
-export declare const uncapitalize: (str: string) => string;
-/**
- * Returns the same string with an uppercase first letter.
- */
-export declare const capitalize: (str: string) => string;
-/**
- * Returns the camelCase version of the given string.
- */
-export declare const toCamelCase: (str: string) => string;
-/**
- * Returns the PascalCase version of the given string.
- */
-export declare const toPascalCase: (str: string) => string;
-/**
- * Returns a pluralized version of the given string based on the count.
- */
-export declare const pluralize: (s: string, count?: number) => string;
-/**
- * Returns true if the given string is already pluralized.
- */
-export declare const isPlural: (s: string) => boolean;
-/**
- * Converts each line of a string to a commented line
- */
-export declare const commentLines: (lines: string) => string;
-/**
- * Provide all relevant conjugation of a name
- */
-export declare const conjugateNames: (name: string) => {
-    PascalCase: string;
-    camelCase: string;
-    pluralized: string;
-    uncapitalizedPlural: string;
-    uncapitalized: string;
-    capitalized: string;
-    capitalizedPlural: string;
-};