@webda/core 4.0.0-beta.2 → 4.0.0-beta.4

package/lib/rest/hooks.js

@@ -0,0 +1,10 @@
+import { useDynamicService } from "../core/hooks.js";
+/**
+ * Return the Router service
+ *
+ * @returns the result
+ */
+export function useRouter() {
+    return useDynamicService("Router");
+}
+//# sourceMappingURL=hooks.js.map

package/lib/rest/hooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.js","sourceRoot":"","sources":["../../src/rest/hooks.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAGrD;;;;GAIG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,iBAAiB,CAAS,QAAQ,CAAC,CAAC;AAC7C,CAAC"}

package/lib/rest/irest.d.ts

@@ -0,0 +1,212 @@
+import type { JSONSchema7 } from "json-schema";
+import type { OpenAPIV3 } from "openapi-types";
+import { HttpMethodType } from "../contexts/httpcontext.js";
+import { DeepPartial } from "@webda/tsc-esm";
+import { IWebContext } from "../contexts/icontext.js";
+import type { Repository } from "@webda/models";
+/**
+ * Define overridable OpenAPI description
+ */
+export interface OpenAPIWebdaDefinition extends DeepPartial<OpenAPIV3.PathItemObject> {
+    /**
+     * Do not output for this specific Route
+     *
+     * It can still be output with --include-hidden, as it is needed to declare
+     * the route in API Gateway or any other internal documentation
+     */
+    hidden?: boolean;
+    /**
+     * If defined will link to the model schema instead of a generic Object
+     */
+    model?: string;
+    /**
+     * Tags defined for all methods
+     */
+    tags?: string[];
+    post?: OpenApiWebdaOperation;
+    put?: OpenApiWebdaOperation;
+    patch?: OpenApiWebdaOperation;
+    get?: OpenApiWebdaOperation;
+}
+/**
+ * Bind a class method to an HTTP route at the service's base URL.
+ *
+ * **Prefer `@Operation`.** Operations plug into REST, GraphQL, and gRPC with
+ * a single declaration and give you request/response schema generation for
+ * free. `@Route` is the escape hatch for endpoints that don't fit the
+ * operation model (static assets, JWKS, Accept-based content negotiation,
+ * server-sent events, manual streaming, etc.) — anything where you need raw
+ * access to `WebContext` and the operation abstraction would get in the way.
+ *
+ * Routes are read by `Router.discoverRoutes()` after service init and
+ * registered on the router with the same semantics as a manual
+ * `this.addRoute(...)` call. `route` is resolved relative to the service's
+ * `url` parameter when it starts with `.` (`".", "./me", "./email/{email}"`).
+ *
+ * @param route - URL pattern, e.g. `"."`, `"./me"`, `"./{id}/children"`
+ * @param methods - HTTP verb or list; defaults to `["GET"]`
+ * @param openapi - OpenAPI `PathItemObject` fragment for this method
+ *
+ * @example
+ * ```ts
+ * class JwksService extends Service {
+ *   // Raw route — JWKS content-type isn't a natural fit for @Operation
+ *   ⁣@Route(".", ["GET"], { get: { operationId: "getJWKS" } })
+ *   async serveJWKS(ctx: OperationContext) { … }
+ * }
+ * ```
+ */
+export declare const Route: {
+    (value: any, context: ClassMethodDecoratorContext<any, any>): any;
+    (route: string, methods?: HttpMethodType[] | HttpMethodType, openapi?: OpenAPIWebdaDefinition): (value: any, context: ClassMethodDecoratorContext<any, any>) => any;
+};
+/**
+ * Operation object with optional schemas
+ */
+export interface OpenApiWebdaOperation extends DeepPartial<OpenAPIV3.OperationObject> {
+    schemas?: {
+        input?: JSONSchema7 | string;
+        output?: JSONSchema7 | string;
+    };
+}
+/**
+ * Route Information default information
+ */
+export interface RouteInfo {
+    model?: Repository;
+    /**
+     * HTTP Method to expose
+     */
+    methods: HttpMethodType[];
+    /**
+     * Executor name
+     */
+    executor: string;
+    /**
+     * Method name on the executor
+     */
+    _method?: string | Function;
+    /**
+     * OpenAPI definition
+     */
+    openapi?: OpenAPIWebdaDefinition;
+    /**
+     * URI Template parser
+     */
+    _uriTemplateParse?: {
+        fromUri: (uri: string, options?: {
+            strict: boolean;
+        }) => any;
+        varNames: any;
+    };
+    /**
+     * Query parameters to extract
+     */
+    _queryParams?: {
+        name: string;
+        required: boolean;
+    }[];
+    /**
+     * Catch all parameter
+     */
+    _queryCatchAll?: string;
+    /**
+     * Hash
+     */
+    hash?: string;
+    /**
+     * Intend to override existing
+     */
+    override?: boolean;
+}
+/**
+ * RequestFilter allows a service to control incoming requests.
+ *
+ * Services implementing this interface can accept or reject HTTP requests
+ * based on authentication, authorization, or other criteria. If at least one
+ * registered filter returns `true`, the request proceeds.
+ *
+ * The compiler detects this interface via the `@WebdaCapability` tag and
+ * automatically registers implementing services with the Router during
+ * framework initialization.
+ *
+ * @WebdaCapability request-filter
+ *
+ * @typeParam T - The context type, defaults to {@link IWebContext}
+ *
+ * @example
+ * ```typescript
+ * class ApiKeyFilter extends Service implements RequestFilter {
+ *   async checkRequest(context: IWebContext, type: "AUTH"): Promise<boolean> {
+ *     return context.getHttpContext().getHeader("x-api-key") === this.parameters.apiKey;
+ *   }
+ * }
+ * ```
+ */
+export interface RequestFilter<T extends IWebContext = IWebContext> {
+    /**
+     * Check whether a request should be allowed through.
+     *
+     * Called for authentication/authorization checks on every incoming request.
+     *
+     * @param context - The current request context
+     * @param type - Always `"AUTH"` for request filters
+     * @returns `true` to allow the request, `false` to reject it
+     */
+    checkRequest(context: T, type: "AUTH"): Promise<boolean>;
+}
+/**
+ * CORSFilter allows a service to control Cross-Origin Resource Sharing requests.
+ *
+ * Similar to {@link RequestFilter} but specifically for CORS validation.
+ * CORS filters are **not applied in devMode**, allowing unrestricted
+ * cross-origin requests during development.
+ *
+ * @WebdaCapability cors-filter
+ *
+ * @typeParam T - The context type, defaults to {@link IWebContext}
+ *
+ * @example
+ * ```typescript
+ * class OriginFilter extends Service implements CORSFilter {
+ *   async checkRequest(context: IWebContext, type: "CORS"): Promise<boolean> {
+ *     const origin = context.getHttpContext().getHeader("origin");
+ *     return this.parameters.allowedOrigins.includes(origin);
+ *   }
+ * }
+ * ```
+ */
+export interface CORSFilter<T extends IWebContext = IWebContext> {
+    /**
+     * Check whether a CORS request should be allowed.
+     *
+     * Called for cross-origin validation. CORS filters are **not applied
+     * in devMode**, allowing unrestricted cross-origin requests during development.
+     *
+     * @param context - The current request context
+     * @param type - Always `"CORS"` for CORS filters
+     * @returns `true` to allow the request, `false` to reject it
+     */
+    checkRequest(context: T, type: "CORS"): Promise<boolean>;
+}
+export interface IRouter {
+    /**
+     * Add to context information and executor based on the http context
+     */
+    exportOpenAPI(arg0: boolean): any;
+    registerModelUrl(arg0: any, prefix: string): unknown;
+    registerRequestFilter(filter: RequestFilter): any;
+    registerCORSFilter(filter: CORSFilter): any;
+    execute(context: IWebContext): Promise<void>;
+    /**
+     * Auto-discover services with request-filter and cors-filter capabilities
+     */
+    discoverFilters(services: Iterable<{
+        getCapabilities(): Record<string, any>;
+    }>): void;
+    /**
+     * Auto-discover routes declared via `@Route` on each service and register them
+     */
+    discoverRoutes(services: Iterable<any>): void;
+}
+//# sourceMappingURL=irest.d.ts.map

package/lib/rest/irest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"irest.d.ts","sourceRoot":"","sources":["../../src/rest/irest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAyB,WAAW,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC;IACnF;;;;;OAKG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,qBAAqB,CAAC;IAC7B,GAAG,CAAC,EAAE,qBAAqB,CAAC;IAC5B,KAAK,CAAC,EAAE,qBAAqB,CAAC;IAC9B,GAAG,CAAC,EAAE,qBAAqB,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,KAAK;;;CAgBjB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,WAAW,CAAC,SAAS,CAAC,eAAe,CAAC;IACnF,OAAO,CAAC,EAAE;QACR,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;QAC7B,MAAM,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;KAC/B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC;IACjC;;OAEG;IACH,iBAAiB,CAAC,EAAE;QAAE,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;YAAE,MAAM,EAAE,OAAO,CAAA;SAAE,KAAK,GAAG,CAAC;QAAC,QAAQ,EAAE,GAAG,CAAA;KAAE,CAAC;IACpG;;OAEG;IACH,YAAY,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;IACrD;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IAChE;;;;;;;;OAQG;IACH,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1D;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IAC7D;;;;;;;;;OASG;IACH,YAAY,CAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC1D;AAED,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,aAAa,CAAC,IAAI,EAAE,OAAO,GAAG,GAAG,CAAC;IAClC,gBAAgB,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC;IACrD,qBAAqB,CAAC,MAAM,EAAE,aAAa,OAAE;IAC7C,kBAAkB,CAAC,MAAM,EAAE,UAAU,OAAE;IACvC,OAAO,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C;;OAEG;IACH,eAAe,CAAC,QAAQ,EAAE,QAAQ,CAAC;QAAE,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;IACtF;;OAEG;IACH,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;CAC/C"}

package/lib/rest/irest.js

@@ -0,0 +1,39 @@
+import { createMethodDecorator } from "@webda/tsc-esm";
+/**
+ * Bind a class method to an HTTP route at the service's base URL.
+ *
+ * **Prefer `@Operation`.** Operations plug into REST, GraphQL, and gRPC with
+ * a single declaration and give you request/response schema generation for
+ * free. `@Route` is the escape hatch for endpoints that don't fit the
+ * operation model (static assets, JWKS, Accept-based content negotiation,
+ * server-sent events, manual streaming, etc.) — anything where you need raw
+ * access to `WebContext` and the operation abstraction would get in the way.
+ *
+ * Routes are read by `Router.discoverRoutes()` after service init and
+ * registered on the router with the same semantics as a manual
+ * `this.addRoute(...)` call. `route` is resolved relative to the service's
+ * `url` parameter when it starts with `.` (`".", "./me", "./email/{email}"`).
+ *
+ * @param route - URL pattern, e.g. `"."`, `"./me"`, `"./{id}/children"`
+ * @param methods - HTTP verb or list; defaults to `["GET"]`
+ * @param openapi - OpenAPI `PathItemObject` fragment for this method
+ *
+ * @example
+ * ```ts
+ * class JwksService extends Service {
+ *   // Raw route — JWKS content-type isn't a natural fit for @Operation
+ *   ⁣@Route(".", ["GET"], { get: { operationId: "getJWKS" } })
+ *   async serveJWKS(ctx: OperationContext) { … }
+ * }
+ * ```
+ */
+export const Route = createMethodDecorator((_value, context, route, methods = ["GET"], openapi = {}) => {
+    context.metadata["webda.route"] ??= {};
+    context.metadata["webda.route"][route] ??= [];
+    context.metadata["webda.route"][route].push({
+        methods: Array.isArray(methods) ? methods : [methods],
+        executor: context.name,
+        openapi
+    });
+});
+//# sourceMappingURL=irest.js.map

package/lib/rest/irest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"irest.js","sourceRoot":"","sources":["../../src/rest/irest.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,qBAAqB,EAAe,MAAM,gBAAgB,CAAC;AA6BpE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,qBAAqB,CACxC,CACE,MAAW,EACX,OAAoC,EACpC,KAAa,EACb,OAAO,GAAsC,CAAC,KAAK,CAAC,EACpD,OAAO,GAA2B,EAAE,EACpC,EAAE;IACF,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;IACvC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IAC9C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;QAC1C,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QACrD,QAAQ,EAAE,OAAO,CAAC,IAAI;QACtB,OAAO;KACR,CAAC,CAAC;AACL,CAAC,CACF,CAAC"}

package/lib/rest/originfilter.d.ts

@@ -0,0 +1,38 @@
+import { IWebContext } from "../contexts/icontext.js";
+import { RegExpValidator } from "@webda/utils";
+import { RequestFilter } from "./irest.js";
+/**
+ * Filter request based on their origin
+ *
+ * @category CoreFeatures
+ */
+export declare class OriginFilter implements RequestFilter<IWebContext> {
+    regexs: RegExpValidator;
+    /** Create a new OriginFilter
+     * @param origins - allowed origin patterns
+     */
+    constructor(origins: string[]);
+    /**
+     *
+     * @param context - the execution context
+     * @returns true if the condition is met
+     */
+    checkRequest(context: IWebContext): Promise<boolean>;
+}
+/**
+ * Authorize requests based on the website
+ */
+export declare class WebsiteOriginFilter implements RequestFilter<IWebContext> {
+    websites: string[];
+    /** Create a new WebsiteOriginFilter
+     * @param website - allowed website URL or array of URLs
+     */
+    constructor(website: any);
+    /**
+     * Verify that the request origin or host is in the allowed websites list
+     * @param context - the execution context
+     * @returns true if the condition is met
+     */
+    checkRequest(context: IWebContext): Promise<boolean>;
+}
+//# sourceMappingURL=originfilter.d.ts.map

package/lib/rest/originfilter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"originfilter.d.ts","sourceRoot":"","sources":["../../src/rest/originfilter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;GAIG;AACH,qBAAa,YAAa,YAAW,aAAa,CAAC,WAAW,CAAC;IAC7D,MAAM,EAAE,eAAe,CAAC;IACxB;;OAEG;IACH,YAAY,OAAO,EAAE,MAAM,EAAE,EAE5B;IACD;;;;OAIG;IACG,YAAY,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAGzD;CACF;AAED;;GAEG;AACH,qBAAa,mBAAoB,YAAW,aAAa,CAAC,WAAW,CAAC;IACpE,QAAQ,EAAE,MAAM,EAAE,CAAM;IACxB;;OAEG;IACH,YAAY,OAAO,EAAE,GAAG,EAUvB;IAED;;;;OAIG;IACG,YAAY,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,CAUzD;CACF"}

package/lib/rest/originfilter.js

@@ -0,0 +1,61 @@
+import { RegExpValidator } from "@webda/utils";
+/**
+ * Filter request based on their origin
+ *
+ * @category CoreFeatures
+ */
+export class OriginFilter {
+    regexs;
+    /** Create a new OriginFilter
+     * @param origins - allowed origin patterns
+     */
+    constructor(origins) {
+        this.regexs = new RegExpValidator(origins);
+    }
+    /**
+     *
+     * @param context - the execution context
+     * @returns true if the condition is met
+     */
+    async checkRequest(context) {
+        const httpContext = context.getHttpContext();
+        return this.regexs.validate(httpContext.hostname) || this.regexs.validate(httpContext.origin);
+    }
+}
+/**
+ * Authorize requests based on the website
+ */
+export class WebsiteOriginFilter {
+    websites = [];
+    /** Create a new WebsiteOriginFilter
+     * @param website - allowed website URL or array of URLs
+     */
+    constructor(website) {
+        if (!Array.isArray(website)) {
+            if (typeof website === "object") {
+                this.websites.push(website.url);
+            }
+            else {
+                this.websites.push(website);
+            }
+        }
+        else {
+            this.websites = [...website];
+        }
+    }
+    /**
+     * Verify that the request origin or host is in the allowed websites list
+     * @param context - the execution context
+     * @returns true if the condition is met
+     */
+    async checkRequest(context) {
+        const httpContext = context.getHttpContext();
+        if (this.websites.indexOf(httpContext.origin) >= 0 ||
+            this.websites.indexOf(httpContext.host) >= 0 ||
+            this.websites.indexOf("*") >= 0) {
+            return true;
+        }
+        return false;
+    }
+}
+//# sourceMappingURL=originfilter.js.map

package/lib/rest/originfilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"originfilter.js","sourceRoot":"","sources":["../../src/rest/originfilter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAG/C;;;;GAIG;AACH,MAAM,OAAO,YAAY;IACvB,MAAM,CAAkB;IACxB;;OAEG;IACH,YAAY,OAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,OAAoB;QACrC,MAAM,WAAW,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAChG,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC9B,QAAQ,GAAa,EAAE,CAAC;IACxB;;OAEG;IACH,YAAY,OAAY;QACtB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC5B,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAChC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,OAAoB;QACrC,MAAM,WAAW,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;QAC7C,IACE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC;YAC9C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;YAC5C,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAC/B,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/lib/rest/restoperationstransport.service.d.ts

@@ -0,0 +1,193 @@
+import { TransformCaseType } from "@webda/utils";
+import { OperationsTransport, OperationsTransportParameters } from "../services/operationstransport.js";
+import { OperationDefinition } from "../core/icore.js";
+import { WebContext } from "../contexts/webcontext.js";
+import type { ModelClass } from "@webda/models";
+import type { ModelAction } from "../models/types.js";
+import type { ModelGraphBehaviorDefinition, ModelMetadata } from "@webda/compiler";
+/**
+ * Parameters for RESTOperationsTransport
+ */
+export declare class RESTOperationsTransportParameters extends OperationsTransportParameters {
+    /**
+     * Expose the OpenAPI
+     *
+     * @default true if debug false otherwise
+     */
+    exposeOpenAPI?: boolean;
+    /**
+     * Swagger version to use
+     *
+     * https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui.css
+     * https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui-bundle.js
+     * https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.19.5/swagger-ui-standalone-preset.js
+     *
+     * TODO Add renovatebot regex
+     */
+    swaggerVersion: string;
+    /**
+     * Base URL for the REST API
+     */
+    url: string;
+    /**
+     * Transform the name of the model to be used in the URL
+     *
+     * @see https://blog.boot.dev/clean-code/casings-in-coding/
+     * @default camelCase
+     */
+    nameTransformer?: TransformCaseType;
+    /**
+     * Method used for query objects
+     *
+     * @default "PUT"
+     */
+    queryMethod?: "PUT" | "GET";
+    /**
+     * Load parameters with defaults
+     * @param params - the service parameters
+     * @returns this for chaining
+     */
+    load(params?: any): this;
+}
+/**
+ * REST transport that exposes model operations as RESTful HTTP routes.
+ *
+ * Instead of iterating operations flat, it walks the model tree
+ * (parent/child relationships) to build nested URL prefixes like
+ * `/companies/{pid.0}/users/{uuid}`.
+ *
+ * @WebdaModda
+ */
+export declare class RESTOperationsTransport<T extends RESTOperationsTransportParameters = RESTOperationsTransportParameters> extends OperationsTransport<T> {
+    /**
+     * OpenAPI cache
+     */
+    openapiContent: string;
+    /**
+     * Transform name using configured casing
+     * @param name - the name to transform
+     * @returns the transformed name
+     */
+    transformName(name: string): string;
+    /**
+     * Resolve the service - set up OpenAPI route if configured
+     * @returns this for chaining
+     */
+    resolve(): this;
+    /**
+     * Override initTransport to walk the model tree instead of flat iteration.
+     * For each model, we look up its operations and register REST routes.
+     */
+    protected initTransport(): void;
+    /**
+     * Expose service/bean operations that have rest hints but aren't tied to model CRUD.
+     * These are operations registered by Service.initOperations() from @Operation decorators.
+     * @param operations - the filtered operations map
+     */
+    protected exposeServiceOperations(operations: Record<string, OperationDefinition>): void;
+    /**
+     * Recursively walk a model and its children, registering routes at each level
+     * @param model - the model class
+     * @param metadata - model metadata
+     * @param operations - filtered operations map
+     * @param basePrefix - URL prefix from parent context
+     * @param depth - nesting depth for parent id parameters
+     */
+    protected walkModel(model: ModelClass, metadata: ModelMetadata, operations: Record<string, OperationDefinition>, basePrefix: string, depth: number): void;
+    /**
+     * Register query route for a model
+     * @param prefix - the URL prefix for this model
+     * @param plural - the pluralized model name
+     * @param shortId - the short model identifier
+     * @param identifier - the full model identifier
+     * @param depth - nesting depth for parent id parameters
+     * @param injectAttribute - parent attribute to inject in queries
+     * @param operations - the filtered operations map
+     */
+    protected exposeQueryRoute(prefix: string, plural: string, shortId: string, identifier: string, depth: number, injectAttribute: string | undefined, operations: Record<string, OperationDefinition>): void;
+    /**
+     * Register create route for a model
+     * @param prefix - the URL prefix for this model
+     * @param shortId - the short model identifier
+     * @param identifier - the full model identifier
+     * @param depth - nesting depth for parent id parameters
+     * @param injectAttribute - parent attribute to inject on create
+     * @param operations - the filtered operations map
+     */
+    protected exposeCreateRoute(prefix: string, shortId: string, identifier: string, depth: number, injectAttribute: string | undefined, operations: Record<string, OperationDefinition>): void;
+    /**
+     * Register delete route for a model
+     * @param prefix - the URL prefix for this model
+     * @param shortId - the short model identifier
+     * @param identifier - the full model identifier
+     * @param operations - the filtered operations map
+     */
+    protected exposeDeleteRoute(prefix: string, shortId: string, identifier: string, operations: Record<string, OperationDefinition>): void;
+    /**
+     * Register update (PUT) and patch (PATCH) routes for a model
+     * @param prefix - the URL prefix for this model
+     * @param shortId - the short model identifier
+     * @param identifier - the full model identifier
+     * @param operations - the filtered operations map
+     */
+    protected exposeUpdateRoute(prefix: string, shortId: string, identifier: string, operations: Record<string, OperationDefinition>): void;
+    /**
+     * Register get route for a model
+     * @param prefix - the URL prefix for this model
+     * @param shortId - the short model identifier
+     * @param identifier - the full model identifier
+     * @param operations - the filtered operations map
+     */
+    protected exposeGetRoute(prefix: string, shortId: string, identifier: string, operations: Record<string, OperationDefinition>): void;
+    /**
+     * Register action route for a model
+     * @param prefix - the URL prefix for this model
+     * @param shortId - the short model identifier
+     * @param identifier - the full model identifier
+     * @param actionName - the name of the action
+     * @param action - the action definition
+     * @param depth - nesting depth for parent id parameters
+     * @param injectAttribute - parent attribute to inject
+     */
+    protected exposeActionRoute(prefix: string, shortId: string, identifier: string, actionName: string, action: ModelAction, depth: number, injectAttribute: string | undefined): void;
+    /**
+     * Register routes for every `@Action` on every Behavior attribute of a
+     * model. The default URL pattern is `{prefix}/{uuid}/{attribute}.{action}`
+     * (PUT) — the dot disambiguates Behavior calls from nested-resource routing.
+     *
+     * Authors can override the route via `@Action({ rest: { route, method } })`.
+     * `addBehaviorOperations` resolves that hint and writes the final
+     * `rest.method`/`rest.path` on the registered operation; this method just
+     * mirrors what's there, falling back to the dot-notation default if no
+     * hint was set.
+     *
+     * Each route dispatches the registered behavior operation
+     * (`{ShortId}.{AttributeCap}.{ActionCap}`). The dispatcher itself
+     * (`modelBehaviorAction`) handles model load, `canAct` gating, and method
+     * invocation — this method only wires the HTTP surface.
+     *
+     * Schema decoration on the OpenAPI doc is best-effort — we lean on
+     * `hasSchema()` (the AJV registry) to decide whether to emit
+     * `requestBody` / `responses` `$ref`s.
+     *
+     * @param prefix - the URL prefix for this model (e.g. `/api/users`)
+     * @param shortId - the short model identifier (e.g. `User`)
+     * @param identifier - the full model identifier (e.g. `MyApp/User`) — accepted
+     *   for symmetry with `walkModel`'s caller signature even though we don't currently use it
+     * @param name - the model display name used in OpenAPI tags
+     * @param behavior - the Behavior attribute relation to expose
+     */
+    protected exposeBehaviorRoutes(prefix: string, shortId: string, identifier: string, name: string, behavior: ModelGraphBehaviorDefinition): void;
+    /**
+     * No-op: route exposure is handled entirely by initTransport's tree walk
+     * @param _operationId - the operation identifier (unused)
+     * @param _definition - the operation definition (unused)
+     */
+    exposeOperation(_operationId: string, _definition: OperationDefinition): void;
+    /**
+     * Serve the openapi with the swagger-ui
+     * @param ctx - the web context
+     */
+    openapi(ctx: WebContext): Promise<void>;
+}
+//# sourceMappingURL=restoperationstransport.service.d.ts.map

package/lib/rest/restoperationstransport.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"restoperationstransport.service.d.ts","sourceRoot":"","sources":["../../src/rest/restoperationstransport.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACxG,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAQvD,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAGvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,4BAA4B,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AA6CnF;;GAEG;AACH,qBAAa,iCAAkC,SAAQ,6BAA6B;IAClF;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;OAQG;IACH,cAAc,EAAE,MAAM,CAAY;IAClC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAO;IAClB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;IACpC;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IAE5B;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAS3B;CACF;AAED;;;;;;;;GAQG;AACH,qBAAa,uBAAuB,CAClC,CAAC,SAAS,iCAAiC,GAAG,iCAAiC,CAC/E,SAAQ,mBAAmB,CAAC,CAAC,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAGvB;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElC;IAED;;;OAGG;IACH,OAAO,SAON;IAED;;;OAGG;IACH,SAAS,CAAC,aAAa,IAAI,IAAI,CAiC9B;IAED;;;;OAIG;IACH,SAAS,CAAC,uBAAuB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,IAAI,CAmCvF;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,SAAS,CACjB,KAAK,EAAE,UAAU,EACjB,QAAQ,EAAE,aAAa,EACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAC/C,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,IAAI,CA+CN;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,gBAAgB,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CAiGN;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CA8EN;IAED;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CA0CN;IAED;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CAuEN;IAED;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CACtB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CA0CN;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GAAG,SAAS,GAClC,IAAI,CAyDN;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,SAAS,CAAC,oBAAoB,CAC5B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,4BAA4B,GACrC,IAAI,CAoEN;IAED;;;;OAIG;IACH,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,mBAAmB,GAAG,IAAI,CAE5E;IAED;;;OAGG;IACG,OAAO,CAAC,GAAG,EAAE,UAAU,iBAM5B;CACF"}