@valkyrjaio/sindri 26.0.1

package/src/Sindri/Generator/Ast/Event/AstEventDataFileGenerator.ts

@@ -0,0 +1,79 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { ts } from 'ts-morph';
+
+import { AstFileGenerator } from '../../Abstract/AstFileGenerator.ts';
+import type { EventDataFileGeneratorContract } from '../../Event/Contract/EventDataFileGeneratorContract.ts';
+import type { GenerateStatus } from '../../Enum/GenerateStatus.ts';
+
+export class AstEventDataFileGenerator extends AstFileGenerator implements EventDataFileGeneratorContract {
+    public classImportMap: Record<string, string> = {};
+
+    private readonly printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
+
+    private readonly dummySourceFile = ts.createSourceFile(
+        '_dummy.ts',
+        '',
+        ts.ScriptTarget.ESNext,
+        false,
+        ts.ScriptKind.TS,
+    );
+
+    public generateFile(
+        directory: string,
+        className: string,
+        namespace: string,
+        listeners: Record<string, ts.Expression>,
+    ): GenerateStatus {
+        const userImports = Object.entries(this.classImportMap)
+            .map(([name, specifier]) => `import { ${name} } from '${specifier}';`)
+            .join('\n');
+
+        const userImportsBlock = userImports ? `${userImports}\n` : '';
+
+        const contents = this.generateClassContents(listeners);
+
+        const data = [
+            '// This file was automatically generated by Sindri.',
+            '',
+            `import { EventData } from '@valkyrjaio/valkyrja/Event/Data/EventData.ts';`,
+            `import { Listener } from '@valkyrjaio/valkyrja/Event/Data/Listener.ts';`,
+            `import type { ListenerContract } from '@valkyrjaio/valkyrja/Event/Data/Contract/ListenerContract.ts';`,
+            userImportsBlock,
+            `export class ${className} extends EventData {`,
+            `    constructor() {`,
+            `        ${contents}`,
+            `    }`,
+            `}`,
+            '',
+        ].join('\n');
+
+        return this.writeFile(directory, className, data);
+    }
+
+    public generateClassContents(listeners: Record<string, ts.Expression>): string {
+        const entries = Object.entries(listeners);
+
+        if (entries.length === 0) {
+            return 'super();';
+        }
+
+        const lines: string[] = [];
+
+        for (const [key, valueExpr] of entries) {
+            const printed = this.printer.printNode(ts.EmitHint.Unspecified, valueExpr, this.dummySourceFile);
+            lines.push(`            ['${key}']: (): ListenerContract => ${printed},`);
+        }
+
+        return ['super(', '            {},', '            {', ...lines, '            },', '        );'].join(
+            '\n        ',
+        );
+    }
+}

package/src/Sindri/Generator/Ast/Http/AstHttpDataFileGenerator.ts

@@ -0,0 +1,306 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { ts } from 'ts-morph';
+
+import { DynamicRoute } from '@valkyrjaio/valkyrja/Http/Routing/Data/DynamicRoute.ts';
+import { Parameter } from '@valkyrjaio/valkyrja/Http/Routing/Data/Parameter.ts';
+import { Regex } from '@valkyrjaio/valkyrja/Http/Routing/Constant/Regex.ts';
+import { Processor } from '@valkyrjaio/valkyrja/Http/Routing/Processor/Processor.ts';
+
+import { AstFileGenerator } from '../../Abstract/AstFileGenerator.ts';
+import { GeneratorUnreachableException } from '../../Throwable/Exception/GeneratorUnreachableException.ts';
+import type { HttpDataFileGeneratorContract } from '../../Http/Contract/HttpDataFileGeneratorContract.ts';
+import type { GenerateStatus } from '../../Enum/GenerateStatus.ts';
+import type { HttpParameterData } from '../../../Ast/Data/HttpParameterData.ts';
+import type { HttpRouteData } from '../../../Ast/Data/HttpRouteData.ts';
+import type { ProcessorContract } from '@valkyrjaio/valkyrja/Http/Routing/Processor/Contract/ProcessorContract.ts';
+
+export class AstHttpDataFileGenerator extends AstFileGenerator implements HttpDataFileGeneratorContract {
+    public classImportMap: Record<string, string> = {};
+
+    protected readonly processor: ProcessorContract;
+
+    private readonly printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed });
+
+    private readonly dummySourceFile = ts.createSourceFile(
+        '_dummy.ts',
+        '',
+        ts.ScriptTarget.ESNext,
+        false,
+        ts.ScriptKind.TS,
+    );
+
+    public constructor(processor: ProcessorContract = new Processor()) {
+        super();
+        this.processor = processor;
+    }
+
+    public generateFile(
+        directory: string,
+        className: string,
+        namespace: string,
+        routes: Record<string, ts.Expression>,
+        routeData: Record<string, HttpRouteData>,
+    ): GenerateStatus {
+        const userImports = Object.entries(this.classImportMap)
+            .map(([name, specifier]) => `import { ${name} } from '${specifier}';`)
+            .join('\n');
+
+        const userImportsBlock = userImports ? `${userImports}\n` : '';
+
+        const routesContent = this.getRoutesAsContent(routes, routeData);
+        const paths = this.printNestedObject(this.buildPaths(routeData));
+        const dynamicPaths = this.printNestedObject(this.buildDynamicPaths(routeData));
+        const regexes = this.printNestedObject(this.buildRegexes(routeData));
+
+        const data = [
+            '// This file was automatically generated by Sindri.',
+            '',
+            `import { HttpRoutingData } from '@valkyrjaio/valkyrja/Http/Routing/Data/HttpRoutingData.ts';`,
+            `import { DynamicRoute } from '@valkyrjaio/valkyrja/Http/Routing/Data/DynamicRoute.ts';`,
+            `import { Route } from '@valkyrjaio/valkyrja/Http/Routing/Data/Route.ts';`,
+            `import { Parameter } from '@valkyrjaio/valkyrja/Http/Routing/Data/Parameter.ts';`,
+            `import { RequestMethod } from '@valkyrjaio/valkyrja/Http/Message/Enum/RequestMethod.ts';`,
+            `import { Regex } from '@valkyrjaio/valkyrja/Http/Routing/Constant/Regex.ts';`,
+            `import type { RouteContract } from '@valkyrjaio/valkyrja/Http/Routing/Data/Contract/RouteContract.ts';`,
+            userImportsBlock,
+            `export class ${className} extends HttpRoutingData {`,
+            `    constructor() {`,
+            `        super(`,
+            `            ${routesContent},`,
+            `            ${paths},`,
+            `            ${dynamicPaths},`,
+            `            ${regexes},`,
+            `        );`,
+            `    }`,
+            `}`,
+            '',
+        ].join('\n');
+
+        return this.writeFile(directory, className, data);
+    }
+
+    public generateClassContents(
+        routes: Record<string, ts.Expression>,
+        routeData: Record<string, HttpRouteData>,
+    ): string {
+        const routesContent = this.getRoutesAsContent(routes, routeData);
+        const paths = this.printNestedObject(this.buildPaths(routeData));
+        const dynamicPaths = this.printNestedObject(this.buildDynamicPaths(routeData));
+        const regexes = this.printNestedObject(this.buildRegexes(routeData));
+
+        return [
+            'super(',
+            `            ${routesContent},`,
+            `            ${paths},`,
+            `            ${dynamicPaths},`,
+            `            ${regexes},`,
+            '        );',
+        ].join('\n        ');
+    }
+
+    protected buildPaths(routeData: Record<string, HttpRouteData>): Record<string, Record<string, string>> {
+        const paths: Record<string, Record<string, string>> = {};
+
+        for (const [name, data] of Object.entries(routeData)) {
+            if (data.isDynamic) {
+                continue;
+            }
+
+            const path = this.normalizePath(data.path);
+
+            for (const method of this.extractMethodNames(data.requestMethods)) {
+                if (paths[method] === undefined) {
+                    paths[method] = {};
+                }
+
+                paths[method][path] = name;
+            }
+        }
+
+        return paths;
+    }
+
+    protected buildDynamicPaths(routeData: Record<string, HttpRouteData>): Record<string, Record<string, string>> {
+        const dynamicPaths: Record<string, Record<string, string>> = {};
+
+        for (const [name, data] of Object.entries(routeData)) {
+            if (!data.isDynamic) {
+                continue;
+            }
+
+            const path = this.normalizePath(data.path);
+
+            for (const method of this.extractMethodNames(data.requestMethods)) {
+                if (dynamicPaths[method] === undefined) {
+                    dynamicPaths[method] = {};
+                }
+
+                dynamicPaths[method][path] = name;
+            }
+        }
+
+        return dynamicPaths;
+    }
+
+    protected buildRegexes(routeData: Record<string, HttpRouteData>): Record<string, Record<string, string>> {
+        const regexes: Record<string, Record<string, string>> = {};
+
+        for (const [name, data] of Object.entries(routeData)) {
+            if (!data.isDynamic || data.parameters.length === 0) {
+                continue;
+            }
+
+            const regex = this.computeRegex(data);
+
+            if (regex === '') {
+                continue;
+            }
+
+            for (const method of this.extractMethodNames(data.requestMethods)) {
+                if (regexes[method] === undefined) {
+                    regexes[method] = {};
+                }
+
+                regexes[method][regex] = name;
+            }
+        }
+
+        return regexes;
+    }
+
+    protected buildNestedStringArrayExpr(data: Record<string, Record<string, string>>): ts.ObjectLiteralExpression {
+        const outerProps: ts.PropertyAssignment[] = [];
+
+        for (const [outerKey, innerMap] of Object.entries(data)) {
+            const innerProps: ts.PropertyAssignment[] = [];
+
+            for (const [innerKey, value] of Object.entries(innerMap)) {
+                innerProps.push(
+                    ts.factory.createPropertyAssignment(
+                        ts.factory.createStringLiteral(innerKey),
+                        ts.factory.createStringLiteral(value),
+                    ),
+                );
+            }
+
+            outerProps.push(
+                ts.factory.createPropertyAssignment(
+                    ts.factory.createStringLiteral(outerKey),
+                    ts.factory.createObjectLiteralExpression(innerProps, true),
+                ),
+            );
+        }
+
+        return ts.factory.createObjectLiteralExpression(outerProps, true);
+    }
+
+    protected printNestedObject(data: Record<string, Record<string, string>>): string {
+        return this.printer.printNode(
+            ts.EmitHint.Unspecified,
+            this.buildNestedStringArrayExpr(data),
+            this.dummySourceFile,
+        );
+    }
+
+    protected computeRegex(data: HttpRouteData): string {
+        const parameters = data.parameters.map((p) => this.buildParameter(p));
+
+        const route = new DynamicRoute(
+            data.path !== '' ? data.path : '/',
+            data.name !== '' ? data.name : 'temp',
+            '',
+            parameters,
+            (): never => {
+                throw new GeneratorUnreachableException('unreachable');
+            },
+        );
+
+        const processed = this.processor.route(route);
+
+        if ('getRegex' in processed && typeof (processed as DynamicRoute).getRegex === 'function') {
+            return (processed as DynamicRoute).getRegex();
+        }
+
+        return '';
+    }
+
+    protected buildParameter(data: HttpParameterData): Parameter {
+        let regex = data.regex;
+
+        if (regex.includes('::')) {
+            const pos = regex.lastIndexOf('::');
+            const className = regex.substring(0, pos);
+            const propName = regex.substring(pos + 2);
+
+            if (className === 'Regex') {
+                const resolved = (Regex as unknown as Record<string, string>)[propName];
+
+                if (typeof resolved === 'string' && resolved !== '') {
+                    regex = resolved;
+                }
+            }
+        }
+
+        return new Parameter(data.name, regex, null, data.isOptional, data.shouldCapture);
+    }
+
+    protected normalizePath(path: string): string {
+        return '/' + path.replace(/^\/+|\/+$/g, '');
+    }
+
+    protected extractMethodNames(requestMethods: readonly string[]): string[] {
+        const methods: string[] = [];
+
+        for (const method of requestMethods) {
+            const pos = method.lastIndexOf('::');
+
+            if (pos !== -1) {
+                methods.push(method.substring(pos + 2));
+            }
+        }
+
+        return methods;
+    }
+
+    protected getRoutesAsContent(
+        routes: Record<string, ts.Expression>,
+        routeData: Record<string, HttpRouteData>,
+    ): string {
+        const entries = Object.entries(routes);
+
+        if (entries.length === 0) {
+            return '{}';
+        }
+
+        const lines: string[] = [];
+
+        for (const [key, routeExpr] of entries) {
+            const data = routeData[key] ?? null;
+            let expr = routeExpr;
+
+            if (data !== null && data.isDynamic && ts.isNewExpression(expr)) {
+                const computedRegex = data.parameters.length > 0 ? this.computeRegex(data) : '';
+                const args = [...(expr.arguments ?? []), ts.factory.createStringLiteral(computedRegex)];
+                expr = ts.factory.createNewExpression(expr.expression, expr.typeArguments, args);
+            }
+
+            const keyExpr = this.buildEnumCaseExpr(key);
+            const printedKey = this.printer.printNode(ts.EmitHint.Unspecified, keyExpr, this.dummySourceFile);
+            const printedRoute = this.printer.printNode(ts.EmitHint.Unspecified, expr, this.dummySourceFile);
+
+            const formattedKey = key.includes('::') ? `[${printedKey}]` : `['${printedKey}']`;
+
+            lines.push(`            ${formattedKey}: (): RouteContract => ${printedRoute},`);
+        }
+
+        return ['{', ...lines, '        }'].join('\n        ');
+    }
+}

package/src/Sindri/Generator/Cli/Contract/CliDataFileGeneratorContract.ts

@@ -0,0 +1,23 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ts } from 'ts-morph';
+
+import type { GenerateStatus } from '../../Enum/GenerateStatus.ts';
+
+export interface CliDataFileGeneratorContract {
+    generateFile(
+        directory: string,
+        className: string,
+        namespace: string,
+        routes: Record<string, ts.Expression>,
+    ): GenerateStatus;
+
+    generateClassContents(routes: Record<string, ts.Expression>): string;
+}

package/src/Sindri/Generator/Container/Contract/ContainerDataFileGeneratorContract.ts

@@ -0,0 +1,21 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { GenerateStatus } from '../../Enum/GenerateStatus.ts';
+
+export interface ContainerDataFileGeneratorContract {
+    generateFile(
+        directory: string,
+        className: string,
+        namespace: string,
+        publishers: Readonly<Record<string, readonly [string, string]>>,
+    ): GenerateStatus;
+
+    generateClassContents(publishers: Readonly<Record<string, readonly [string, string]>>): string;
+}

package/src/Sindri/Generator/Contract/FileGeneratorContract.ts

@@ -0,0 +1,15 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { GenerateStatus } from '../Enum/GenerateStatus.ts';
+
+export interface FileGeneratorContract {
+    generateFile(): GenerateStatus;
+    generateFileContents(): string;
+}

package/src/Sindri/Generator/Enum/GenerateStatus.ts

@@ -0,0 +1,14 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export enum GenerateStatus {
+    SUCCESS = 'SUCCESS',
+    FAILURE = 'FAILURE',
+    SKIPPED = 'SKIPPED',
+}

package/src/Sindri/Generator/Event/Contract/EventDataFileGeneratorContract.ts

@@ -0,0 +1,23 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ts } from 'ts-morph';
+
+import type { GenerateStatus } from '../../Enum/GenerateStatus.ts';
+
+export interface EventDataFileGeneratorContract {
+    generateFile(
+        directory: string,
+        className: string,
+        namespace: string,
+        listeners: Record<string, ts.Expression>,
+    ): GenerateStatus;
+
+    generateClassContents(listeners: Record<string, ts.Expression>): string;
+}

package/src/Sindri/Generator/Http/Contract/HttpDataFileGeneratorContract.ts

@@ -0,0 +1,25 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ts } from 'ts-morph';
+
+import type { HttpRouteData } from '../../../Ast/Data/HttpRouteData.ts';
+import type { GenerateStatus } from '../../Enum/GenerateStatus.ts';
+
+export interface HttpDataFileGeneratorContract {
+    generateFile(
+        directory: string,
+        className: string,
+        namespace: string,
+        routes: Record<string, ts.Expression>,
+        routeData: Record<string, HttpRouteData>,
+    ): GenerateStatus;
+
+    generateClassContents(routes: Record<string, ts.Expression>, routeData: Record<string, HttpRouteData>): string;
+}

package/src/Sindri/Generator/Throwable/Contract/GeneratorThrowable.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { SindriThrowable } from '../../../Throwable/Contract/SindriThrowable.ts';
+
+export type GeneratorThrowable = SindriThrowable;

package/src/Sindri/Generator/Throwable/Exception/Abstract/GeneratorInvalidArgumentException.ts

@@ -0,0 +1,16 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { SindriInvalidArgumentException } from '../../../../Throwable/Exception/Abstract/SindriInvalidArgumentException.ts';
+
+import type { GeneratorThrowable } from '../../Contract/GeneratorThrowable.ts';
+
+export abstract class GeneratorInvalidArgumentException
+    extends SindriInvalidArgumentException
+    implements GeneratorThrowable {}

package/src/Sindri/Generator/Throwable/Exception/Abstract/GeneratorRuntimeException.ts

@@ -0,0 +1,14 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { SindriRuntimeException } from '../../../../Throwable/Exception/Abstract/SindriRuntimeException.ts';
+
+import type { GeneratorThrowable } from '../../Contract/GeneratorThrowable.ts';
+
+export abstract class GeneratorRuntimeException extends SindriRuntimeException implements GeneratorThrowable {}

package/src/Sindri/Generator/Throwable/Exception/GeneratorUnreachableException.ts

@@ -0,0 +1,12 @@
+/*
+ * This file is part of the Sindri package.
+ *
+ * (c) Melech Mizrachi <melechmizrachi@gmail.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import { GeneratorRuntimeException } from './Abstract/GeneratorRuntimeException.ts';
+
+export class GeneratorUnreachableException extends GeneratorRuntimeException {}