@navios/openapi 0.9.0 → 1.0.0-alpha.2

package/dist/src/legacy-compat/decorators/api-stream.decorator.d.mts

@@ -0,0 +1,52 @@
+import { z } from 'zod/v4';
+declare const ApiStreamSchema: z.ZodObject<{
+    contentType: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** Options for the @ApiStream decorator, inferred from the schema */
+export type ApiStreamOptions = z.infer<typeof ApiStreamSchema>;
+/**
+ * Specifies content type and description for stream endpoints.
+ *
+ * Stream endpoints don't have a responseSchema, so this decorator provides
+ * the necessary metadata for OpenAPI documentation.
+ *
+ * Legacy-compatible version for TypeScript experimental decorators.
+ *
+ * @param options - Stream response options
+ *
+ * @example
+ * ```typescript
+ * @Controller()
+ * export class FileController {
+ *   // Binary file download
+ *   @Stream(downloadFile)
+ *   @ApiStream({
+ *     contentType: 'application/octet-stream',
+ *     description: 'Download file as binary stream'
+ *   })
+ *   async download(params: StreamParams<typeof downloadFile>, reply: Reply) {
+ *     // Stream implementation
+ *   }
+ * }
+ *
+ * @Controller()
+ * export class EventController {
+ *   // Server-Sent Events
+ *   @Stream(streamEvents)
+ *   @ApiStream({
+ *     contentType: 'text/event-stream',
+ *     description: 'Real-time event stream'
+ *   })
+ *   async stream(params: StreamParams<typeof streamEvents>, reply: Reply) {
+ *     // SSE implementation
+ *   }
+ * }
+ * ```
+ */
+export declare const ApiStream: import("@navios/core/legacy-compat").LegacyClassSchemaAttribute<z.ZodObject<{
+    contentType: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>;
+export {};
+//# sourceMappingURL=api-stream.decorator.d.mts.map

package/dist/src/legacy-compat/decorators/api-stream.decorator.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-stream.decorator.d.mts","sourceRoot":"","sources":["../../../../src/legacy-compat/decorators/api-stream.decorator.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAI1B,QAAA,MAAM,eAAe;;;iBAGnB,CAAA;AAEF,qEAAqE;AACrE,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,eAAO,MAAM,SAAS;;;kBAGrB,CAAA"}

package/dist/src/legacy-compat/decorators/api-summary.decorator.d.mts

@@ -0,0 +1,26 @@
+import { z } from 'zod/v4';
+/**
+ * Shorthand decorator for adding just a summary to an endpoint.
+ *
+ * This is equivalent to `@ApiOperation({ summary: '...' })` but more concise.
+ *
+ * Legacy-compatible version for TypeScript experimental decorators.
+ *
+ * @param summary - Short summary text for the endpoint
+ *
+ * @example
+ * ```typescript
+ * @Controller()
+ * export class UserController {
+ *   @Endpoint(getUser)
+ *   @ApiSummary('Get user by ID')
+ *   async getUser() {}
+ *
+ *   @Endpoint(createUser)
+ *   @ApiSummary('Create a new user')
+ *   async createUser() {}
+ * }
+ * ```
+ */
+export declare const ApiSummary: import("@navios/core/legacy-compat").LegacyClassSchemaAttribute<z.ZodString>;
+//# sourceMappingURL=api-summary.decorator.d.mts.map

package/dist/src/legacy-compat/decorators/api-summary.decorator.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-summary.decorator.d.mts","sourceRoot":"","sources":["../../../../src/legacy-compat/decorators/api-summary.decorator.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAM1B;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,UAAU,8EAGtB,CAAA"}

package/dist/src/legacy-compat/decorators/api-tag.decorator.d.mts

@@ -0,0 +1,44 @@
+import { z } from 'zod/v4';
+declare const ApiTagSchema: z.ZodObject<{
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/** Options for the @ApiTag decorator, inferred from the schema */
+export type ApiTagOptions = z.infer<typeof ApiTagSchema>;
+/**
+ * Groups endpoints under a specific tag/folder in the documentation.
+ *
+ * Can be applied to controllers (affects all endpoints) or individual methods.
+ * When applied to both, the method-level tag takes precedence.
+ *
+ * Legacy-compatible version for TypeScript experimental decorators.
+ *
+ * @param name - The tag name
+ * @param description - Optional tag description
+ *
+ * @example
+ * ```typescript
+ * // Apply to entire controller
+ * @Controller()
+ * @ApiTag('Users', 'User management operations')
+ * export class UserController {
+ *   @Endpoint(getUser)
+ *   async getUser() {}
+ * }
+ *
+ * // Apply to individual endpoint
+ * @Controller()
+ * export class MixedController {
+ *   @Endpoint(getUser)
+ *   @ApiTag('Users')
+ *   async getUser() {}
+ *
+ *   @Endpoint(getOrder)
+ *   @ApiTag('Orders')
+ *   async getOrder() {}
+ * }
+ * ```
+ */
+export declare function ApiTag(name: string, description?: string): ClassDecorator & MethodDecorator;
+export {};
+//# sourceMappingURL=api-tag.decorator.d.mts.map

package/dist/src/legacy-compat/decorators/api-tag.decorator.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-tag.decorator.d.mts","sourceRoot":"","sources":["../../../../src/legacy-compat/decorators/api-tag.decorator.mts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAI1B,QAAA,MAAM,YAAY;;;iBAGhB,CAAA;AAEF,kEAAkE;AAClE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAA;AAIxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,oCAExD"}

package/dist/src/legacy-compat/decorators/index.d.mts

@@ -0,0 +1,8 @@
+export { ApiTag, type ApiTagOptions } from './api-tag.decorator.mjs';
+export { ApiOperation, type ApiOperationOptions } from './api-operation.decorator.mjs';
+export { ApiSummary } from './api-summary.decorator.mjs';
+export { ApiDeprecated, type ApiDeprecatedOptions } from './api-deprecated.decorator.mjs';
+export { ApiSecurity, type ApiSecurityRequirement } from './api-security.decorator.mjs';
+export { ApiExclude } from './api-exclude.decorator.mjs';
+export { ApiStream, type ApiStreamOptions } from './api-stream.decorator.mjs';
+//# sourceMappingURL=index.d.mts.map

package/dist/src/legacy-compat/decorators/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../../src/legacy-compat/decorators/index.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,KAAK,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACpE,OAAO,EAAE,YAAY,EAAE,KAAK,mBAAmB,EAAE,MAAM,+BAA+B,CAAA;AACtF,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AACzF,OAAO,EAAE,WAAW,EAAE,KAAK,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AACvF,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAA;AACxD,OAAO,EAAE,SAAS,EAAE,KAAK,gBAAgB,EAAE,MAAM,4BAA4B,CAAA"}

package/dist/src/legacy-compat/index.d.mts

@@ -0,0 +1,24 @@
+/**
+ * Legacy-compatible decorators for projects that cannot use Stage 3 decorators.
+ *
+ * These decorators use the TypeScript experimental decorator API and convert
+ * the arguments to Stage 3 format internally.
+ *
+ * @example
+ * ```typescript
+ * import { ApiTag, ApiOperation, ApiSummary } from '@navios/openapi/legacy-compat'
+ *
+ * @Controller()
+ * @ApiTag('Users', 'User management operations')
+ * export class UserController {
+ *   @Endpoint(getUser)
+ *   @ApiSummary('Get user by ID')
+ *   async getUser() {}
+ * }
+ * ```
+ */
+export { ApiTag, ApiOperation, ApiSummary, ApiDeprecated, ApiSecurity, ApiExclude, ApiStream, type ApiTagOptions, type ApiOperationOptions, type ApiDeprecatedOptions, type ApiSecurityRequirement, type ApiStreamOptions, } from './decorators/index.mjs';
+export { ApiTagToken, ApiOperationToken, ApiSummaryToken, ApiDeprecatedToken, ApiSecurityToken, ApiExcludeToken, ApiStreamToken, } from '../tokens/index.mjs';
+export { OpenApiGeneratorService, EndpointScannerService, MetadataExtractorService, SchemaConverterService, PathBuilderService, } from '../services/index.mjs';
+export type { OpenApiEndpointMetadata } from '../metadata/index.mjs';
+//# sourceMappingURL=index.d.mts.map

package/dist/src/legacy-compat/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/legacy-compat/index.mts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAGH,OAAO,EACL,MAAM,EACN,YAAY,EACZ,UAAU,EACV,aAAa,EACb,WAAW,EACX,UAAU,EACV,SAAS,EACT,KAAK,aAAa,EAClB,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,sBAAsB,EAC3B,KAAK,gBAAgB,GACtB,MAAM,wBAAwB,CAAA;AAG/B,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,cAAc,GACf,MAAM,qBAAqB,CAAA;AAG5B,OAAO,EACL,uBAAuB,EACvB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,kBAAkB,GACnB,MAAM,uBAAuB,CAAA;AAG9B,YAAY,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAA"}

package/dist/src/services/endpoint-scanner.service.d.mts

@@ -1,5 +1,5 @@
+import type { BaseEndpointOptions, EndpointOptions } from '@navios/builder';
 import type { ControllerMetadata, HandlerMetadata, ModuleMetadata } from '@navios/core';
-import type { BaseEndpointConfig } from '@navios/builder';
 import type { OpenApiEndpointMetadata } from '../metadata/openapi.metadata.mjs';
 /**
  * Represents a discovered endpoint with all its metadata
@@ -14,7 +14,7 @@ export interface DiscoveredEndpoint {
     /** Handler (endpoint) metadata */
     handler: HandlerMetadata<any>;
     /** Endpoint configuration from @navios/builder */
-    config: BaseEndpointConfig;
+    config: EndpointOptions | BaseEndpointOptions;
     /** Extracted OpenAPI metadata */
     openApiMetadata: OpenApiEndpointMetadata;
 }

package/dist/src/services/endpoint-scanner.service.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"endpoint-scanner.service.d.mts","sourceRoot":"","sources":["../../../src/services/endpoint-scanner.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,eAAe,EACf,cAAc,EACf,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAIzD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAA;AAI/E;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,MAAM,EAAE,cAAc,CAAA;IACtB,uBAAuB;IACvB,eAAe,EAAE,GAAG,CAAA;IACpB,0BAA0B;IAC1B,UAAU,EAAE,kBAAkB,CAAA;IAC9B,kCAAkC;IAClC,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAA;IAC7B,kDAAkD;IAClD,MAAM,EAAE,kBAAkB,CAAA;IAC1B,iCAAiC;IACjC,eAAe,EAAE,uBAAuB,CAAA;CACzC;AAED;;;;;GAKG;AACH,qBACa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAErB;IAEF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmC;IAErE;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,kBAAkB,EAAE;IAyBhE;;OAEG;IACH,OAAO,CAAC,cAAc;CAsCvB"}
+{"version":3,"file":"endpoint-scanner.service.d.mts","sourceRoot":"","sources":["../../../src/services/endpoint-scanner.service.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAC3E,OAAO,KAAK,EACV,kBAAkB,EAClB,eAAe,EACf,cAAc,EACf,MAAM,cAAc,CAAA;AASrB,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAA;AAI/E;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,sBAAsB;IACtB,MAAM,EAAE,cAAc,CAAA;IACtB,uBAAuB;IACvB,eAAe,EAAE,GAAG,CAAA;IACpB,0BAA0B;IAC1B,UAAU,EAAE,kBAAkB,CAAA;IAC9B,kCAAkC;IAClC,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,CAAA;IAC7B,kDAAkD;IAClD,MAAM,EAAE,eAAe,GAAG,mBAAmB,CAAA;IAC7C,iCAAiC;IACjC,eAAe,EAAE,uBAAuB,CAAA;CACzC;AAED;;;;;GAKG;AACH,qBACa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAErB;IAEF,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAmC;IAErE;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,kBAAkB,EAAE;IA4BhE;;OAEG;IACH,OAAO,CAAC,cAAc;CAoCvB"}

package/dist/src/services/path-builder.service.d.mts

@@ -35,7 +35,7 @@ export declare class PathBuilderService {
     /**
      * Gets the endpoint type based on the adapter token
      */
-    getEndpointType(handler: HandlerMetadata<any>): 'endpoint' | 'multipart' | 'stream';
+    getEndpointType(handler: HandlerMetadata<any>): 'endpoint' | 'multipart' | 'stream' | 'unknown';
     /**
      * Builds OpenAPI parameters from endpoint config
      */
@@ -56,6 +56,13 @@ export declare class PathBuilderService {
      * Builds responses based on endpoint type
      */
     private buildResponses;
+    /**
+     * Builds error responses from errorSchema
+     *
+     * @param errorSchema - Optional record mapping status codes to Zod schemas
+     * @returns ResponsesObject with error responses, or empty object if no errorSchema
+     */
+    private buildErrorResponses;
     /**
      * Builds responses for JSON endpoints
      */
@@ -64,6 +71,11 @@ export declare class PathBuilderService {
      * Builds responses for stream endpoints
      */
     private buildStreamResponses;
+    /**
+     * Builds responses for unknown endpoint types.
+     * Unknown types have no success response but can have error responses.
+     */
+    private buildUnknownResponses;
     /**
      * Gets content object for different stream types
      */

package/dist/src/services/path-builder.service.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"path-builder.service.d.mts","sourceRoot":"","sources":["../../../src/services/path-builder.service.mts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAUxC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAOxE,KAAK,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;AAK1C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,cAAc,CAAA;CACzB;AAED;;;;;GAKG;AACH,qBACa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiC;IAEjE;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,EAAE,kBAAkB,GAAG,cAAc;IAgCnD;;OAEG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIrC;;OAEG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAK3C;;OAEG;IACH,eAAe,CACb,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,GAC5B,UAAU,GAAG,WAAW,GAAG,QAAQ;IAUtC;;OAEG;IACH,OAAO,CAAC,eAAe;IAoCvB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAiBxB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAmCjC;;OAEG;IACH,OAAO,CAAC,cAAc;IActB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA4B1B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;OAEG;IACH,OAAO,CAAC,gBAAgB;CAyCzB"}
+{"version":3,"file":"path-builder.service.d.mts","sourceRoot":"","sources":["../../../src/services/path-builder.service.mts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AAUxC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAA;AAOxE,KAAK,cAAc,GAAG,KAAK,CAAC,cAAc,CAAA;AAK1C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,cAAc,CAAA;CACzB;AAED;;;;;GAKG;AACH,qBACa,kBAAkB;IAC7B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiC;IAEjE;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,EAAE,kBAAkB,GAAG,cAAc;IAgCnD;;OAEG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAIrC;;OAEG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE;IAK3C;;OAEG;IACH,eAAe,CACb,OAAO,EAAE,eAAe,CAAC,GAAG,CAAC,GAC5B,UAAU,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS;IAalD;;OAEG;IACH,OAAO,CAAC,eAAe;IAoCvB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAiBxB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAoCjC;;OAEG;IACH,OAAO,CAAC,cAAc;IAiBtB;;;;;OAKG;IACH,OAAO,CAAC,mBAAmB;IAwB3B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA8B1B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAuB5B;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAO7B;;OAEG;IACH,OAAO,CAAC,gBAAgB;CAyCzB"}