@valkyrjaio/sindri 26.0.1

package/src/Sindri/Ast/Data/Contract/HttpRouteDataContract.ts

@@ -0,0 +1,28 @@
+/*
+ * 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 { HandlerDataContract } from './HandlerDataContract.ts';
+import type { HttpParameterDataContract } from './HttpParameterDataContract.ts';
+
+export interface HttpRouteDataContract {
+    readonly path: string;
+    readonly name: string;
+    readonly handler: HandlerDataContract | null;
+    /** "FQN::CASE" strings for RequestMethod enum values */
+    readonly requestMethods: readonly string[];
+    readonly routeMatchedMiddleware: readonly string[];
+    readonly routeDispatchedMiddleware: readonly string[];
+    readonly throwableCaughtMiddleware: readonly string[];
+    readonly sendingResponseMiddleware: readonly string[];
+    readonly terminatedMiddleware: readonly string[];
+    readonly requestStruct: string | null;
+    readonly responseStruct: string | null;
+    readonly isDynamic: boolean;
+    readonly parameters: readonly HttpParameterDataContract[];
+}

package/src/Sindri/Ast/Data/Contract/ListenerDataContract.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 type { HandlerDataContract } from './HandlerDataContract.ts';
+
+export interface ListenerDataContract {
+    readonly eventId: string;
+    readonly name: string;
+    readonly handler: HandlerDataContract | null;
+}

package/src/Sindri/Ast/Data/HandlerData.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 { HandlerDataContract } from './Contract/HandlerDataContract.ts';
+
+export class HandlerData implements HandlerDataContract {
+    readonly class: string;
+    readonly method: string;
+
+    constructor(className: string, method: string) {
+        this.class = className;
+        this.method = method;
+    }
+}

package/src/Sindri/Ast/Data/HttpParameterData.ts

@@ -0,0 +1,20 @@
+/*
+ * 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 { HttpParameterDataContract } from './Contract/HttpParameterDataContract.ts';
+
+export class HttpParameterData implements HttpParameterDataContract {
+    constructor(
+        readonly name: string,
+        readonly regex: string,
+        readonly cast: string | null = null,
+        readonly isOptional: boolean = false,
+        readonly shouldCapture: boolean = true,
+    ) {}
+}

package/src/Sindri/Ast/Data/HttpRouteData.ts

@@ -0,0 +1,30 @@
+/*
+ * 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 { HttpRouteDataContract } from './Contract/HttpRouteDataContract.ts';
+import type { HandlerData } from './HandlerData.ts';
+import type { HttpParameterData } from './HttpParameterData.ts';
+
+export class HttpRouteData implements HttpRouteDataContract {
+    constructor(
+        readonly path: string,
+        readonly name: string,
+        readonly handler: HandlerData | null = null,
+        readonly requestMethods: readonly string[] = [],
+        readonly routeMatchedMiddleware: readonly string[] = [],
+        readonly routeDispatchedMiddleware: readonly string[] = [],
+        readonly throwableCaughtMiddleware: readonly string[] = [],
+        readonly sendingResponseMiddleware: readonly string[] = [],
+        readonly terminatedMiddleware: readonly string[] = [],
+        readonly requestStruct: string | null = null,
+        readonly responseStruct: string | null = null,
+        readonly isDynamic: boolean = false,
+        readonly parameters: readonly HttpParameterData[] = [],
+    ) {}
+}

package/src/Sindri/Ast/Data/ListenerData.ts

@@ -0,0 +1,19 @@
+/*
+ * 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 { ListenerDataContract } from './Contract/ListenerDataContract.ts';
+import type { HandlerData } from './HandlerData.ts';
+
+export class ListenerData implements ListenerDataContract {
+    constructor(
+        readonly eventId: string,
+        readonly name: string,
+        readonly handler: HandlerData | null = null,
+    ) {}
+}

package/src/Sindri/Ast/Data/Result/CliRouteAttributeResult.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 type { ts } from 'ts-morph';
+
+export class CliRouteAttributeResult {
+    constructor(readonly routes: Record<string, ts.Expression> = {}) {}
+}

package/src/Sindri/Ast/Data/Result/ComponentProviderResult.ts

@@ -0,0 +1,28 @@
+/*
+ * 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 class ComponentProviderResult {
+    constructor(
+        readonly componentProviders: readonly string[] = [],
+        readonly serviceProviders: readonly string[] = [],
+        readonly listenerProviders: readonly string[] = [],
+        readonly cliRouteProviders: readonly string[] = [],
+        readonly httpRouteProviders: readonly string[] = [],
+    ) {}
+
+    merge(other: ComponentProviderResult): ComponentProviderResult {
+        return new ComponentProviderResult(
+            [...new Set([...this.componentProviders, ...other.componentProviders])],
+            [...new Set([...this.serviceProviders, ...other.serviceProviders])],
+            [...new Set([...this.listenerProviders, ...other.listenerProviders])],
+            [...new Set([...this.cliRouteProviders, ...other.cliRouteProviders])],
+            [...new Set([...this.httpRouteProviders, ...other.httpRouteProviders])],
+        );
+    }
+}

package/src/Sindri/Ast/Data/Result/ConfigResult.ts

@@ -0,0 +1,18 @@
+/*
+ * 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 class ConfigResult {
+    constructor(
+        readonly namespace: string = '',
+        readonly dir: string = '',
+        readonly dataPath: string = '',
+        readonly dataNamespace: string = '',
+        readonly providers: readonly string[] = [],
+    ) {}
+}

package/src/Sindri/Ast/Data/Result/HttpRouteAttributeResult.ts

@@ -0,0 +1,19 @@
+/*
+ * 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 '../HttpRouteData.ts';
+
+export class HttpRouteAttributeResult {
+    constructor(
+        readonly routes: Record<string, ts.Expression> = {},
+        readonly routeData: Record<string, HttpRouteData> = {},
+    ) {}
+}

package/src/Sindri/Ast/Data/Result/ListenerAttributeResult.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 type { ts } from 'ts-morph';
+
+export class ListenerAttributeResult {
+    constructor(readonly listeners: Record<string, ts.Expression> = {}) {}
+}

package/src/Sindri/Ast/Data/Result/ListenerProviderResult.ts

@@ -0,0 +1,24 @@
+/*
+ * 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';
+
+export class ListenerProviderResult {
+    constructor(
+        readonly listenerClasses: readonly string[] = [],
+        readonly listeners: readonly ts.Expression[] = [],
+    ) {}
+
+    merge(other: ListenerProviderResult): ListenerProviderResult {
+        return new ListenerProviderResult(
+            [...new Set([...this.listenerClasses, ...other.listenerClasses])],
+            [...this.listeners, ...other.listeners],
+        );
+    }
+}

package/src/Sindri/Ast/Data/Result/RouteProviderResult.ts

@@ -0,0 +1,24 @@
+/*
+ * 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';
+
+export class RouteProviderResult {
+    constructor(
+        readonly controllerClasses: readonly string[] = [],
+        readonly routes: readonly ts.Expression[] = [],
+    ) {}
+
+    merge(other: RouteProviderResult): RouteProviderResult {
+        return new RouteProviderResult(
+            [...new Set([...this.controllerClasses, ...other.controllerClasses])],
+            [...this.routes, ...other.routes],
+        );
+    }
+}

package/src/Sindri/Ast/Data/Result/ServiceProviderResult.ts

@@ -0,0 +1,22 @@
+/*
+ * 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 class ServiceProviderResult {
+    constructor(
+        readonly serviceClasses: readonly string[] = [],
+        readonly publishers: Readonly<Record<string, readonly [string, string]>> = {},
+    ) {}
+
+    merge(other: ServiceProviderResult): ServiceProviderResult {
+        return new ServiceProviderResult([...new Set([...this.serviceClasses, ...other.serviceClasses])], {
+            ...this.publishers,
+            ...other.publishers,
+        });
+    }
+}

package/src/Sindri/Ast/HttpRouteAttributeReader.ts

@@ -0,0 +1,315 @@
+/*
+ * 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 { RouteAttributeReader } from './Abstract/RouteAttributeReader.ts';
+import { HttpRouteData } from './Data/HttpRouteData.ts';
+import { HttpRouteAttributeResult } from './Data/Result/HttpRouteAttributeResult.ts';
+import { HttpRouteMiddlewareReader } from './HttpRouteMiddlewareReader.ts';
+import { HttpRouteParameterReader } from './HttpRouteParameterReader.ts';
+
+import type { ClassDeclaration, Decorator, MethodDeclaration, Node } from 'ts-morph';
+
+import type { HttpRouteAttributeReaderContract } from './Contract/HttpRouteAttributeReaderContract.ts';
+import type { HttpRouteMiddlewareReaderContract } from './Contract/HttpRouteMiddlewareReaderContract.ts';
+import type { HttpRouteParameterReaderContract } from './Contract/HttpRouteParameterReaderContract.ts';
+
+/**
+ * Scans an HTTP controller class file for @Route / @DynamicRoute and related
+ * sub-decorators and returns TypeScript compiler API Expr nodes ready for the data cache generator.
+ *
+ * Mirrors the logic of the framework's runtime AttributeRouteCollector but operates
+ * entirely on AST without executing any TypeScript code.
+ */
+export class HttpRouteAttributeReader extends RouteAttributeReader implements HttpRouteAttributeReaderContract {
+    constructor(
+        protected readonly parameterReader: HttpRouteParameterReaderContract = new HttpRouteParameterReader(),
+        protected readonly middlewareReader: HttpRouteMiddlewareReaderContract = new HttpRouteMiddlewareReader(),
+    ) {
+        super();
+    }
+
+    readFile(filePath: string): HttpRouteAttributeResult {
+        const context = this.parseClassFile(filePath);
+
+        if (context === undefined) {
+            return new HttpRouteAttributeResult();
+        }
+
+        const { classDecl, useMap, currentClass } = context;
+
+        const classPathPrefix = this.extractClassPathPrefix(classDecl, useMap, filePath, currentClass);
+        const classNamePrefix = this.extractClassNamePrefix(classDecl, useMap, filePath, currentClass);
+
+        return this.buildRouteResult(classDecl, useMap, filePath, currentClass, classPathPrefix, classNamePrefix);
+    }
+
+    protected getRouteHandlerDecoratorName(): string {
+        return 'RouteHandler';
+    }
+
+    protected extractClassPathPrefix(
+        classDecl: ClassDeclaration,
+        useMap: Record<string, string>,
+        currentFilePath: string,
+        currentClass: string,
+    ): string {
+        for (const decorator of this.findDecoratorsOnNode(classDecl, 'Path', useMap, currentFilePath)) {
+            const value = this.extractExprValue(
+                this.getDecoratorArg(decorator, 0),
+                useMap,
+                currentFilePath,
+                currentClass,
+            );
+
+            if (typeof value === 'string' && value !== '') {
+                return value;
+            }
+        }
+
+        return '';
+    }
+
+    protected extractClassNamePrefix(
+        classDecl: ClassDeclaration,
+        useMap: Record<string, string>,
+        currentFilePath: string,
+        currentClass: string,
+    ): string {
+        for (const decorator of this.findDecoratorsOnNode(classDecl, 'Name', useMap, currentFilePath)) {
+            const value = this.extractExprValue(
+                this.getDecoratorArg(decorator, 0),
+                useMap,
+                currentFilePath,
+                currentClass,
+            );
+
+            if (typeof value === 'string' && value !== '') {
+                return value;
+            }
+        }
+
+        return '';
+    }
+
+    protected buildRouteResult(
+        classDecl: ClassDeclaration,
+        useMap: Record<string, string>,
+        currentFilePath: string,
+        currentClass: string,
+        classPathPrefix: string,
+        classNamePrefix: string,
+    ): HttpRouteAttributeResult {
+        const routes: Record<string, ts.Expression> = {};
+        const routeData: Record<string, HttpRouteData> = {};
+
+        for (const method of classDecl.getMethods()) {
+            for (const decorator of this.findDecoratorsOnNode(method, 'Route', useMap, currentFilePath)) {
+                const data = this.buildRouteData(
+                    decorator,
+                    method,
+                    useMap,
+                    currentFilePath,
+                    currentClass,
+                    classPathPrefix,
+                    classNamePrefix,
+                    false,
+                );
+
+                if (data !== null) {
+                    routes[data.name] = this.buildRouteExpr(data);
+                    routeData[data.name] = data;
+                }
+            }
+
+            for (const decorator of this.findDecoratorsOnNode(method, 'DynamicRoute', useMap, currentFilePath)) {
+                const data = this.buildRouteData(
+                    decorator,
+                    method,
+                    useMap,
+                    currentFilePath,
+                    currentClass,
+                    classPathPrefix,
+                    classNamePrefix,
+                    true,
+                );
+
+                if (data !== null) {
+                    routes[data.name] = this.buildRouteExpr(data);
+                    routeData[data.name] = data;
+                }
+            }
+        }
+
+        return new HttpRouteAttributeResult(routes, routeData);
+    }
+
+    protected buildRouteData(
+        decorator: Decorator,
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        currentFilePath: string,
+        currentClass: string,
+        classPathPrefix: string,
+        classNamePrefix: string,
+        isDynamic: boolean,
+    ): HttpRouteData | null {
+        const path = this.extractStringArg(decorator, 0, useMap, currentFilePath, currentClass);
+        const name = this.extractStringArg(decorator, 1, useMap, currentFilePath, currentClass);
+
+        if (path === '' || name === '') {
+            return null;
+        }
+
+        const updatedPath = this.updatePath(path, classPathPrefix, method, useMap, currentFilePath, currentClass);
+        const updatedName = this.updateName(name, classNamePrefix, method, useMap, currentFilePath, currentClass);
+
+        const resolvedIsDynamic = isDynamic || updatedPath.includes('{');
+
+        const decoratorArgs = decorator.getArguments().map((a: Node) => a.compilerNode as ts.Expression);
+
+        const requestMethods = this.middlewareReader.updateRequestMethods(
+            this.middlewareReader.extractInlineRequestMethods(decoratorArgs, useMap, currentFilePath, currentClass),
+            method,
+            useMap,
+            currentFilePath,
+            currentClass,
+        );
+
+        const [
+            routeMatchedMiddleware,
+            routeDispatchedMiddleware,
+            throwableCaughtMiddleware,
+            sendingResponseMiddleware,
+            terminatedMiddleware,
+        ] = this.middlewareReader.updateMiddleware(
+            method,
+            useMap,
+            currentFilePath,
+            currentClass,
+            this.extractClassListArgFromDecorator(decorator, 5, useMap, currentFilePath, currentClass),
+            this.extractClassListArgFromDecorator(decorator, 6, useMap, currentFilePath, currentClass),
+            this.extractClassListArgFromDecorator(decorator, 7, useMap, currentFilePath, currentClass),
+            this.extractClassListArgFromDecorator(decorator, 8, useMap, currentFilePath, currentClass),
+            this.extractClassListArgFromDecorator(decorator, 9, useMap, currentFilePath, currentClass),
+        );
+
+        return new HttpRouteData(
+            updatedPath,
+            updatedName,
+            this.updateHandler(method, useMap, currentFilePath, currentClass),
+            requestMethods,
+            routeMatchedMiddleware,
+            routeDispatchedMiddleware,
+            throwableCaughtMiddleware,
+            sendingResponseMiddleware,
+            terminatedMiddleware,
+            this.middlewareReader.updateRequestStruct(method, useMap, currentFilePath, currentClass),
+            this.middlewareReader.updateResponseStruct(method, useMap, currentFilePath, currentClass),
+            resolvedIsDynamic,
+            resolvedIsDynamic
+                ? this.updateParameters(decoratorArgs, method, useMap, currentFilePath, currentClass)
+                : [],
+        );
+    }
+
+    protected updatePath(
+        path: string,
+        classPathPrefix: string,
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        currentFilePath: string,
+        currentClass: string,
+    ): string {
+        if (classPathPrefix !== '') {
+            path = classPathPrefix.replace(/\/$/, '') + '/' + path.replace(/^\//, '');
+        }
+
+        for (const decorator of this.findDecoratorsOnNode(method, 'Path', useMap, currentFilePath)) {
+            const suffix = this.extractExprValue(
+                this.getDecoratorArg(decorator, 0),
+                useMap,
+                currentFilePath,
+                currentClass,
+            );
+
+            if (typeof suffix === 'string' && suffix !== '') {
+                path = path.replace(/\/$/, '') + '/' + suffix.replace(/^\//, '');
+            }
+        }
+
+        return path;
+    }
+
+    protected updateName(
+        name: string,
+        classNamePrefix: string,
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        currentFilePath: string,
+        currentClass: string,
+    ): string {
+        if (classNamePrefix !== '') {
+            name = classNamePrefix + '.' + name;
+        }
+
+        for (const decorator of this.findDecoratorsOnNode(method, 'Name', useMap, currentFilePath)) {
+            const suffix = this.extractExprValue(
+                this.getDecoratorArg(decorator, 0),
+                useMap,
+                currentFilePath,
+                currentClass,
+            );
+
+            if (typeof suffix === 'string' && suffix !== '') {
+                name = name + '.' + suffix;
+            }
+        }
+
+        return name;
+    }
+
+    protected buildRouteExpr(data: HttpRouteData): ts.Expression {
+        const args: ts.Expression[] = [this.buildEnumCaseExpr(data.path), this.buildEnumCaseExpr(data.name)];
+
+        if (data.isDynamic && data.parameters.length > 0) {
+            args.push(this.parameterReader.buildParameterListExpr([...data.parameters]));
+        }
+
+        if (data.handler !== null) {
+            args.push(this.buildHandlerExpr(data.handler));
+        } else {
+            args.push(this.buildNullExpr());
+        }
+
+        if (data.requestMethods.length > 0) {
+            args.push(this.buildEnumCaseArrayExpr(data.requestMethods));
+        }
+
+        args.push(...this.middlewareReader.buildRouteMiddlewareArgs(data));
+        args.push(...this.middlewareReader.buildRouteStructArgs(data));
+
+        const targetClass = data.isDynamic
+            ? 'Valkyrja\\Http\\Routing\\Data\\DynamicRoute'
+            : 'Valkyrja\\Http\\Routing\\Data\\Route';
+
+        return this.buildNewExpr(targetClass, args);
+    }
+
+    protected updateParameters(
+        decoratorArgs: ts.Expression[],
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        currentFilePath: string,
+        currentClass: string,
+    ): import('./Data/HttpParameterData.ts').HttpParameterData[] {
+        return this.parameterReader.updateParameters(decoratorArgs, method, useMap, currentFilePath, currentClass);
+    }
+}