@lucaapp/service-utils 5.29.2 → 5.31.0

package/dist/lib/api/api.d.ts

@@ -7,6 +7,23 @@ import { ZodObjectSchemaOrUndefined } from './types/utils';
 type OpenApiVersion = '3.0.0' | '3.0.1' | '3.0.2' | '3.0.3' | '3.1.0';
 type ApiConstructorOptions = {
     prefixPath?: string;
+    /**
+     * Keep every endpoint registered on this Api out of the generated OpenAPI
+     * spec. Inherited by children and never turned off again, so a hidden branch
+     * stays hidden. Routing is unaffected; this only controls documentation.
+     */
+    hidden?: boolean;
+    /**
+     * Paths kept out of the generated OpenAPI spec, matched against the full
+     * registered path including the prefix. A string must match exactly; a
+     * RegExp is tested against it. Inherited by children.
+     *
+     * This is the central place to keep routes undocumented, so the decision
+     * lives in one list next to the Api rather than spread across the route
+     * files it applies to. `hidden` on a single endpoint does the same thing at
+     * the definition site; prefer this list when the routes share a reason.
+     */
+    excludeFromSpec?: ReadonlyArray<string | RegExp>;
     openApiVersion?: OpenApiVersion;
     apiVersion?: string;
     apiTitle?: string;
@@ -19,6 +36,7 @@ type ApiConstructorOptions = {
 type ApiChildOptions = {
     prefixPath?: string;
     tags?: string[];
+    hidden?: boolean;
 };
 export declare class Api {
     router: Router;
@@ -31,6 +49,8 @@ export declare class Api {
     private rootPrefixPath;
     debug: boolean;
     tags: string[];
+    private hidden;
+    private excludeFromSpec;
     constructor(options?: ApiConstructorOptions);
     child(options: ApiChildOptions): Api;
     get<TResponseSchemas extends ReadonlyArray<EndpointResponseSchema>, TRequestBodySchema extends ZodObjectSchemaOrUndefined = undefined, TRequestParamsSchema extends ZodObjectSchemaOrUndefined = undefined, TRequestQuerySchema extends ZodObjectSchemaOrUndefined = undefined, TRequestHeadersSchema extends ZodObjectSchemaOrUndefined = undefined, TMiddlewares extends ReadonlyArray<Middleware<any, any, any, any, any, any>> | undefined = undefined>(path: string, summary: string, options: EndpointOptions<TResponseSchemas, TRequestBodySchema, TRequestParamsSchema, TRequestQuerySchema, TRequestHeadersSchema, TMiddlewares>, handler: EndpointHandler<TResponseSchemas, TRequestBodySchema, TRequestParamsSchema, TRequestQuerySchema, TRequestHeadersSchema, TMiddlewares>): void;

package/dist/lib/api/api.js

@@ -30,6 +30,8 @@ class Api {
         this.apiDescription = options.apiDescription || '';
         this.debug = options.debug || false;
         this.tags = options.tags || [];
+        this.hidden = options.hidden || false;
+        this.excludeFromSpec = options.excludeFromSpec || [];
         this.router.use(body_parser_1.default.json({ verify: rawBodySaver, limit: '2mb' }));
     }
     child(options) {
@@ -39,29 +41,32 @@ class Api {
             tags: [...this.tags, ...(options.tags || [])],
             registry: this.registry,
             router: this.router,
+            // Once hidden, always hidden: a child cannot re-expose its parent's tree.
+            hidden: this.hidden || options.hidden || false,
+            excludeFromSpec: this.excludeFromSpec,
         });
         child.rootPrefixPath = this.rootPrefixPath;
         return child;
     }
     get(path, summary, options, handler) {
         (0, endpoint_1.mountEndpoint)(this.router, 'get', path, options, handler, this.debug);
-        (0, openapi_1.registerEndpoint)(this.registry, 'get', this.prefixPath, this.rootPrefixPath, path, summary, options, this.tags, this.debug);
+        (0, openapi_1.registerEndpoint)(this.registry, 'get', this.prefixPath, this.rootPrefixPath, path, summary, options, this.tags, this.debug, this.hidden, this.excludeFromSpec);
     }
     post(path, summary, options, handler) {
         (0, endpoint_1.mountEndpoint)(this.router, 'post', path, options, handler, this.debug);
-        (0, openapi_1.registerEndpoint)(this.registry, 'post', this.prefixPath, this.rootPrefixPath, path, summary, options, this.tags, this.debug);
+        (0, openapi_1.registerEndpoint)(this.registry, 'post', this.prefixPath, this.rootPrefixPath, path, summary, options, this.tags, this.debug, this.hidden, this.excludeFromSpec);
     }
     patch(path, summary, options, handler) {
         (0, endpoint_1.mountEndpoint)(this.router, 'patch', path, options, handler, this.debug);
-        (0, openapi_1.registerEndpoint)(this.registry, 'patch', this.prefixPath, this.rootPrefixPath, path, summary, options, this.tags, this.debug);
+        (0, openapi_1.registerEndpoint)(this.registry, 'patch', this.prefixPath, this.rootPrefixPath, path, summary, options, this.tags, this.debug, this.hidden, this.excludeFromSpec);
     }
     put(path, summary, options, handler) {
         (0, endpoint_1.mountEndpoint)(this.router, 'put', path, options, handler, this.debug);
-        (0, openapi_1.registerEndpoint)(this.registry, 'put', this.prefixPath, this.rootPrefixPath, path, summary, options, this.tags, this.debug);
+        (0, openapi_1.registerEndpoint)(this.registry, 'put', this.prefixPath, this.rootPrefixPath, path, summary, options, this.tags, this.debug, this.hidden, this.excludeFromSpec);
     }
     delete(path, summary, options, handler) {
         (0, endpoint_1.mountEndpoint)(this.router, 'delete', path, options, handler, this.debug);
-        (0, openapi_1.registerEndpoint)(this.registry, 'delete', this.prefixPath, this.rootPrefixPath, path, summary, options, this.tags, this.debug);
+        (0, openapi_1.registerEndpoint)(this.registry, 'delete', this.prefixPath, this.rootPrefixPath, path, summary, options, this.tags, this.debug, this.hidden, this.excludeFromSpec);
     }
     generateOpenAPISpec() {
         let generator;

package/dist/lib/api/openapi.d.ts

@@ -25,5 +25,5 @@ export declare const hoistCombinatorRequiredFields: (spec: {
         schemas?: Record<string, unknown>;
     };
 }) => void;
-export declare const registerEndpoint: (registry: OpenAPIRegistry, method: HttpMethod, prefixPath: string, rootPrefixPath: string, path: string, summary: string, options: EndpointOptions<any, any, any, any, any, any>, tags: string[], debug: boolean) => void;
+export declare const registerEndpoint: (registry: OpenAPIRegistry, method: HttpMethod, prefixPath: string, rootPrefixPath: string, path: string, summary: string, options: EndpointOptions<any, any, any, any, any, any>, tags: string[], debug: boolean, hiddenApi?: boolean, excludeFromSpec?: ReadonlyArray<string | RegExp>) => void;
 export {};

package/dist/lib/api/openapi.js

@@ -227,7 +227,18 @@ const hoistCombinatorRequiredFields = (spec) => {
 exports.hoistCombinatorRequiredFields = hoistCombinatorRequiredFields;
 const registerEndpoint = (registry, method, prefixPath, rootPrefixPath, path, summary, 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-options, tags, debug) => {
+options, tags, debug, hiddenApi = false, excludeFromSpec = []) => {
+    // Hidden endpoints are never registered, so they leave no path, no
+    // operationId and no security behind. Checked before any schema work: there
+    // is nothing to build for an operation that will not be published.
+    //
+    // The exclusion list is matched against the same path string the spec would
+    // have used, so an entry can be copied straight out of a generated spec.
+    const specPath = mapExpressParamsToOpenAPIParams(prefixPath + path);
+    const excluded = excludeFromSpec.some(pattern => typeof pattern === 'string' ? pattern === specPath : pattern.test(specPath));
+    if (hiddenApi || options.hidden || excluded) {
+        return;
+    }
     let bodySchema = options.schemas?.body || undefined;
     let paramsSchema = options.schemas?.params || undefined;
     let querySchema = options.schemas?.query || undefined;

package/dist/lib/api/types/endpoint.d.ts

@@ -21,4 +21,11 @@ export type EndpointOptions<TResponseSchemas extends ReadonlyArray<EndpointRespo
     responses: TResponseSchemas;
     errors?: Record<string, number>;
     operationId?: string;
+    /**
+     * Keep this endpoint out of the generated OpenAPI spec. For routes that only
+     * a known caller may use -- provider webhooks, service-to-service endpoints,
+     * job triggers -- where publishing the shape invites traffic that has no
+     * business arriving. Routing is unaffected.
+     */
+    hidden?: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lucaapp/service-utils",
-  "version": "5.29.2",
+  "version": "5.31.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [