@valkyrjaio/sindri 26.0.1

package/src/Sindri/Ast/ConfigReader.ts

@@ -0,0 +1,213 @@
+/*
+ * 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 * as path from 'path';
+
+import { ts } from 'ts-morph';
+
+import { AstReader } from './Abstract/AstReader.ts';
+import { ConfigResult } from './Data/Result/ConfigResult.ts';
+
+import type { ClassDeclaration } from 'ts-morph';
+
+import type { ConfigReaderContract } from './Contract/ConfigReaderContract.ts';
+
+/**
+ * Reads an application config class file via AST and extracts the values
+ * needed by GenerateDataFromAst without executing the TypeScript file.
+ *
+ * Expects a class with a constructor that calls super() with positional or
+ * named arguments: (namespace, dir, ..., dataPath, dataNamespace, providers).
+ * __dirname / import.meta.dirname in the dir argument is resolved relative to
+ * the config file path.
+ */
+export class ConfigReader extends AstReader implements ConfigReaderContract {
+    readFile(filePath: string): ConfigResult {
+        const context = this.parseClassFile(filePath);
+
+        if (context === undefined) {
+            return new ConfigResult();
+        }
+
+        const { classDecl, useMap } = context;
+        const args = this.findSuperConstructorArgs(classDecl);
+
+        if (args === undefined) {
+            return new ConfigResult();
+        }
+
+        return this.buildConfigResult(args, filePath, useMap);
+    }
+
+    /**
+     * Locate the constructor and extract its super() call arguments.
+     */
+    protected findSuperConstructorArgs(classDecl: ClassDeclaration): ts.NodeArray<ts.Expression> | undefined {
+        const constructor = classDecl.getConstructors()[0];
+
+        if (constructor === undefined) {
+            return undefined;
+        }
+
+        const body = constructor.compilerNode.body;
+
+        if (body === undefined) {
+            return undefined;
+        }
+
+        for (const stmt of body.statements) {
+            if (ts.isExpressionStatement(stmt) && ts.isCallExpression(stmt.expression)) {
+                const call = stmt.expression;
+
+                if (ts.isIdentifier(call.expression) && call.expression.text === 'super') {
+                    return call.arguments;
+                }
+            }
+        }
+
+        return undefined;
+    }
+
+    /**
+     * Build a ConfigResult from the extracted super() argument list.
+     *
+     * The TS Config base class constructor signature (CliConfig):
+     *   (namespace, dir, version, env, debug, timezone, secret, dataPath, dataNamespace, ...)
+     *
+     * Positional args:
+     *   0: namespace (string)
+     *   1: dir (string — may use process.cwd() or __dirname)
+     *   2: version (string)
+     *   3: env (string)
+     *   4: debug (bool)
+     *   5: timezone (string)
+     *   6: secret (string)
+     *   7: dataPath (string — relative path)
+     *   8: dataNamespace (string)
+     *   9+: other args, then providers array
+     */
+    protected buildConfigResult(
+        args: ts.NodeArray<ts.Expression>,
+        filePath: string,
+        useMap: Record<string, string>,
+    ): ConfigResult {
+        const fileDir = path.dirname(filePath);
+
+        const namespace = this.extractStringFromArg(args[0]);
+        const dir = this.resolvePathFromArg(args[1], fileDir);
+        const dataPath = this.resolveDataPathFromArgs(args, fileDir);
+        const dataNamespace = this.extractStringFromArg(args[8]);
+        const providers = this.extractProvidersFromArgs(args, useMap, filePath);
+
+        if (namespace === '' || dir === '' || dataPath === '' || dataNamespace === '') {
+            return new ConfigResult();
+        }
+
+        return new ConfigResult(namespace, dir, dataPath, dataNamespace, providers);
+    }
+
+    protected extractStringFromArg(arg: ts.Expression | undefined): string {
+        if (arg === undefined) {
+            return '';
+        }
+
+        if (ts.isStringLiteral(arg)) {
+            return arg.text;
+        }
+
+        return '';
+    }
+
+    protected resolvePathFromArg(arg: ts.Expression | undefined, fileDir: string): string {
+        if (arg === undefined) {
+            return '';
+        }
+
+        if (ts.isStringLiteral(arg)) {
+            return arg.text;
+        }
+
+        // process.cwd() → use the file directory as a proxy
+        if (ts.isCallExpression(arg) && ts.isPropertyAccessExpression(arg.expression)) {
+            const obj = arg.expression.expression;
+            const prop = arg.expression.name;
+
+            if (ts.isIdentifier(obj) && obj.text === 'process' && ts.isIdentifier(prop) && prop.text === 'cwd') {
+                return fileDir;
+            }
+        }
+
+        // __dirname or import.meta.dirname
+        if (ts.isIdentifier(arg) && arg.text === '__dirname') {
+            return fileDir;
+        }
+
+        if (
+            ts.isPropertyAccessExpression(arg) &&
+            ts.isPropertyAccessExpression(arg.expression) &&
+            ts.isMetaProperty(arg.expression.expression) &&
+            arg.expression.expression.name.text === 'meta'
+        ) {
+            return fileDir;
+        }
+
+        return '';
+    }
+
+    /**
+     * Resolve the data path from args, prepending the app root when relative.
+     * Args[7] is dataPath in CliConfig.
+     */
+    protected resolveDataPathFromArgs(args: ts.NodeArray<ts.Expression>, fileDir: string): string {
+        const dataPathArg = args[7];
+
+        if (dataPathArg === undefined) {
+            return '';
+        }
+
+        const dataPath = this.extractStringFromArg(dataPathArg);
+
+        if (dataPath === '') {
+            return '';
+        }
+
+        if (!dataPath.startsWith('/')) {
+            const dirArg = args[1];
+            const appRoot = this.resolvePathFromArg(dirArg, fileDir);
+
+            if (appRoot !== '') {
+                return appRoot.replace(/\/$/, '') + '/' + dataPath;
+            }
+        }
+
+        return dataPath;
+    }
+
+    /**
+     * Extract provider class names from the providers argument.
+     * In CliConfig, providers is typically the 12th positional arg (index 11).
+     */
+    protected extractProvidersFromArgs(
+        args: ts.NodeArray<ts.Expression>,
+        useMap: Record<string, string>,
+        filePath: string,
+    ): string[] {
+        // Try to find the providers array in the argument list
+        // It's typically at index 11 in CliConfig
+        for (let i = 10; i < args.length; i++) {
+            const arg = args[i];
+
+            if (arg !== undefined && ts.isArrayLiteralExpression(arg)) {
+                return this.extractClassListFromArrayExpr(arg, useMap, filePath);
+            }
+        }
+
+        return [];
+    }
+}

package/src/Sindri/Ast/Contract/CliRouteAttributeReaderContract.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 { CliRouteAttributeResult } from '../Data/Result/CliRouteAttributeResult.ts';
+
+export interface CliRouteAttributeReaderContract {
+    readFile(filePath: string): CliRouteAttributeResult;
+}

package/src/Sindri/Ast/Contract/CliRouteParameterReaderContract.ts

@@ -0,0 +1,34 @@
+/*
+ * 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 { MethodDeclaration } from 'ts-morph';
+
+import type { CliArgumentParameterData } from '../Data/CliArgumentParameterData.ts';
+import type { CliOptionParameterData } from '../Data/CliOptionParameterData.ts';
+import type { CliRouteData } from '../Data/CliRouteData.ts';
+
+export interface CliRouteParameterReaderContract {
+    buildParameterArgs(data: CliRouteData): ts.Expression[];
+
+    updateArguments(
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        namespace: string,
+        currentClass: string,
+    ): CliArgumentParameterData[];
+
+    updateOptions(
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        namespace: string,
+        currentClass: string,
+    ): CliOptionParameterData[];
+}

package/src/Sindri/Ast/Contract/ComponentProviderReaderContract.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 { ComponentProviderResult } from '../Data/Result/ComponentProviderResult.ts';
+
+export interface ComponentProviderReaderContract {
+    readFile(filePath: string): ComponentProviderResult;
+}

package/src/Sindri/Ast/Contract/ConfigReaderContract.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 { ConfigResult } from '../Data/Result/ConfigResult.ts';
+
+export interface ConfigReaderContract {
+    readFile(filePath: string): ConfigResult;
+}

package/src/Sindri/Ast/Contract/HttpRouteAttributeReaderContract.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 { HttpRouteAttributeResult } from '../Data/Result/HttpRouteAttributeResult.ts';
+
+export interface HttpRouteAttributeReaderContract {
+    readFile(filePath: string): HttpRouteAttributeResult;
+}

package/src/Sindri/Ast/Contract/HttpRouteMiddlewareReaderContract.ts

@@ -0,0 +1,61 @@
+/*
+ * 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 { MethodDeclaration } from 'ts-morph';
+
+import type { HttpRouteData } from '../Data/HttpRouteData.ts';
+
+export interface HttpRouteMiddlewareReaderContract {
+    extractInlineRequestMethods(
+        decoratorArgs: ts.NodeArray<ts.Expression> | ts.Expression[],
+        useMap: Record<string, string>,
+        namespace: string,
+        currentClass: string,
+    ): string[];
+
+    updateRequestMethods(
+        requestMethods: string[],
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        namespace: string,
+        currentClass: string,
+    ): string[];
+
+    updateMiddleware(
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        namespace: string,
+        currentClass: string,
+        routeMatchedMiddleware: string[],
+        routeDispatchedMiddleware: string[],
+        throwableCaughtMiddleware: string[],
+        sendingResponseMiddleware: string[],
+        terminatedMiddleware: string[],
+    ): [string[], string[], string[], string[], string[]];
+
+    updateRequestStruct(
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        namespace: string,
+        currentClass: string,
+    ): string | null;
+
+    updateResponseStruct(
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        namespace: string,
+        currentClass: string,
+    ): string | null;
+
+    buildRouteMiddlewareArgs(data: HttpRouteData): ts.Expression[];
+
+    buildRouteStructArgs(data: HttpRouteData): ts.Expression[];
+}

package/src/Sindri/Ast/Contract/HttpRouteParameterReaderContract.ts

@@ -0,0 +1,26 @@
+/*
+ * 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 { MethodDeclaration } from 'ts-morph';
+
+import type { HttpParameterData } from '../Data/HttpParameterData.ts';
+
+export interface HttpRouteParameterReaderContract {
+    updateParameters(
+        decoratorArgs: ts.NodeArray<ts.Expression> | ts.Expression[],
+        method: MethodDeclaration,
+        useMap: Record<string, string>,
+        namespace: string,
+        currentClass: string,
+    ): HttpParameterData[];
+
+    buildParameterListExpr(parameters: HttpParameterData[]): ts.ArrayLiteralExpression;
+}

package/src/Sindri/Ast/Contract/ListenerAttributeReaderContract.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 { ListenerAttributeResult } from '../Data/Result/ListenerAttributeResult.ts';
+
+export interface ListenerAttributeReaderContract {
+    readFile(filePath: string): ListenerAttributeResult;
+}

package/src/Sindri/Ast/Contract/ListenerProviderReaderContract.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 { ListenerProviderResult } from '../Data/Result/ListenerProviderResult.ts';
+
+export interface ListenerProviderReaderContract {
+    readFile(filePath: string): ListenerProviderResult;
+}

package/src/Sindri/Ast/Contract/RouteProviderReaderContract.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 { RouteProviderResult } from '../Data/Result/RouteProviderResult.ts';
+
+export interface RouteProviderReaderContract {
+    readFile(filePath: string): RouteProviderResult;
+}

package/src/Sindri/Ast/Contract/ServiceProviderReaderContract.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 { ServiceProviderResult } from '../Data/Result/ServiceProviderResult.ts';
+
+export interface ServiceProviderReaderContract {
+    readFile(filePath: string): ServiceProviderResult;
+}

package/src/Sindri/Ast/Data/CliArgumentParameterData.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 { CliArgumentParameterDataContract } from './Contract/CliArgumentParameterDataContract.ts';
+
+export class CliArgumentParameterData implements CliArgumentParameterDataContract {
+    constructor(
+        readonly name: string,
+        readonly description: string,
+        readonly cast: string | null = null,
+        readonly mode: string = 'Valkyrja\\Cli\\Routing\\Enum\\ArgumentMode::OPTIONAL',
+        readonly valueMode: string = 'Valkyrja\\Cli\\Routing\\Enum\\ArgumentValueMode::DEFAULT',
+    ) {}
+}

package/src/Sindri/Ast/Data/CliOptionParameterData.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 { CliOptionParameterDataContract } from './Contract/CliOptionParameterDataContract.ts';
+
+export class CliOptionParameterData implements CliOptionParameterDataContract {
+    constructor(
+        readonly name: string,
+        readonly description: string,
+        readonly valueDisplayName: string = '',
+        readonly cast: string | null = null,
+        readonly defaultValue: string = '',
+        readonly shortNames: readonly string[] = [],
+        readonly validValues: readonly string[] = [],
+        readonly mode: string = 'Valkyrja\\Cli\\Routing\\Enum\\OptionMode::OPTIONAL',
+        readonly valueMode: string = 'Valkyrja\\Cli\\Routing\\Enum\\OptionValueMode::DEFAULT',
+    ) {}
+}

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

@@ -0,0 +1,32 @@
+/*
+ * 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 { CliArgumentParameterData } from './CliArgumentParameterData.ts';
+import type { CliOptionParameterData } from './CliOptionParameterData.ts';
+import type { CliRouteDataContract } from './Contract/CliRouteDataContract.ts';
+import type { HandlerData } from './HandlerData.ts';
+
+export class CliRouteData implements CliRouteDataContract {
+    readonly arguments: readonly CliArgumentParameterData[];
+
+    constructor(
+        readonly name: string,
+        readonly description: string,
+        readonly handler: HandlerData | null = null,
+        readonly helpText: HandlerData | null = null,
+        readonly routeMatchedMiddleware: readonly string[] = [],
+        readonly routeDispatchedMiddleware: readonly string[] = [],
+        readonly throwableCaughtMiddleware: readonly string[] = [],
+        readonly exitedMiddleware: readonly string[] = [],
+        args: readonly CliArgumentParameterData[] = [],
+        readonly options: readonly CliOptionParameterData[] = [],
+    ) {
+        this.arguments = args;
+    }
+}

package/src/Sindri/Ast/Data/ConfigData.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 { ConfigDataContract } from './Contract/ConfigDataContract.ts';
+
+export class ConfigData implements ConfigDataContract {
+    constructor(
+        readonly namespace: string,
+        readonly dir: string,
+        readonly dataPath: string,
+        readonly dataNamespace: string,
+        readonly providers: readonly string[] = [],
+    ) {}
+}

package/src/Sindri/Ast/Data/Contract/CliArgumentParameterDataContract.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 interface CliArgumentParameterDataContract {
+    readonly name: string;
+    readonly description: string;
+    readonly cast: string | null;
+    /** Stored as "FQN::CASE" */
+    readonly mode: string;
+    /** Stored as "FQN::CASE" */
+    readonly valueMode: string;
+}

package/src/Sindri/Ast/Data/Contract/CliOptionParameterDataContract.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 interface CliOptionParameterDataContract {
+    readonly name: string;
+    readonly description: string;
+    readonly valueDisplayName: string;
+    readonly cast: string | null;
+    readonly defaultValue: string;
+    readonly shortNames: readonly string[];
+    readonly validValues: readonly string[];
+    /** Stored as "FQN::CASE" */
+    readonly mode: string;
+    /** Stored as "FQN::CASE" */
+    readonly valueMode: string;
+}

package/src/Sindri/Ast/Data/Contract/CliRouteDataContract.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 { CliArgumentParameterDataContract } from './CliArgumentParameterDataContract.ts';
+import type { CliOptionParameterDataContract } from './CliOptionParameterDataContract.ts';
+import type { HandlerDataContract } from './HandlerDataContract.ts';
+
+export interface CliRouteDataContract {
+    readonly name: string;
+    readonly description: string;
+    readonly handler: HandlerDataContract | null;
+    readonly helpText: HandlerDataContract | null;
+    readonly routeMatchedMiddleware: readonly string[];
+    readonly routeDispatchedMiddleware: readonly string[];
+    readonly throwableCaughtMiddleware: readonly string[];
+    readonly exitedMiddleware: readonly string[];
+    readonly arguments: readonly CliArgumentParameterDataContract[];
+    readonly options: readonly CliOptionParameterDataContract[];
+}

package/src/Sindri/Ast/Data/Contract/ConfigDataContract.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.
+ */
+
+export interface ConfigDataContract {
+    readonly namespace: string;
+    readonly dir: string;
+    readonly dataPath: string;
+    readonly dataNamespace: string;
+    readonly providers: readonly string[];
+}

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

@@ -0,0 +1,13 @@
+/*
+ * 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 interface HandlerDataContract {
+    readonly class: string;
+    readonly method: string;
+}

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

@@ -0,0 +1,17 @@
+/*
+ * 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 interface HttpParameterDataContract {
+    readonly name: string;
+    readonly regex: string;
+    /** Stored as "FQN::CASE" or null */
+    readonly cast: string | null;
+    readonly isOptional: boolean;
+    readonly shouldCapture: boolean;
+}