@navios/openapi 0.7.0 → 0.9.1

package/lib/legacy-compat/index.mjs

@@ -0,0 +1,271 @@
+import { a as _MetadataExtractorService, c as ApiOperationToken, d as ApiSummaryToken, f as ApiTagToken, i as _EndpointScannerService, l as ApiSecurityToken, n as _PathBuilderService, o as ApiDeprecatedToken, r as _SchemaConverterService, s as ApiExcludeToken, t as _OpenApiGeneratorService, u as ApiStreamToken } from "../services-MFCyRMd8.mjs";
+import { z } from "zod/v4";
+import { LegacyAttributeFactory } from "@navios/core/legacy-compat";
+
+//#region src/legacy-compat/decorators/api-tag.decorator.mts
+const ApiTagSchema = z.object({
+	name: z.string(),
+	description: z.string().optional()
+});
+const BaseApiTag = LegacyAttributeFactory.createAttribute(ApiTagToken, 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() {}
+* }
+* ```
+*/ function ApiTag(name, description) {
+	return BaseApiTag({
+		name,
+		description
+	});
+}
+
+//#endregion
+//#region src/legacy-compat/decorators/api-operation.decorator.mts
+const ApiOperationSchema = z.object({
+	summary: z.string().optional(),
+	description: z.string().optional(),
+	operationId: z.string().optional(),
+	deprecated: z.boolean().optional(),
+	externalDocs: z.object({
+		url: z.string(),
+		description: z.string().optional()
+	}).optional()
+});
+/**
+* Provides detailed operation metadata for an endpoint.
+*
+* Use this decorator when you need to specify multiple operation properties.
+* For simple cases, consider using @ApiSummary instead.
+*
+* Legacy-compatible version for TypeScript experimental decorators.
+*
+* @param options - Operation configuration options
+*
+* @example
+* ```typescript
+* @Controller()
+* export class UserController {
+*   @Endpoint(getUser)
+*   @ApiOperation({
+*     summary: 'Get user by ID',
+*     description: 'Retrieves a user by their unique identifier. Returns 404 if not found.',
+*     operationId: 'getUserById',
+*   })
+*   async getUser(params: EndpointParams<typeof getUser>) {}
+*
+*   @Endpoint(legacyGetUser)
+*   @ApiOperation({
+*     summary: 'Get user (legacy)',
+*     deprecated: true,
+*     externalDocs: {
+*       url: 'https://docs.example.com/migration',
+*       description: 'Migration guide'
+*     }
+*   })
+*   async getLegacyUser() {}
+* }
+* ```
+*/ const ApiOperation = LegacyAttributeFactory.createAttribute(ApiOperationToken, ApiOperationSchema);
+
+//#endregion
+//#region src/legacy-compat/decorators/api-summary.decorator.mts
+const ApiSummarySchema = z.string();
+/**
+* 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() {}
+* }
+* ```
+*/ const ApiSummary = LegacyAttributeFactory.createAttribute(ApiSummaryToken, ApiSummarySchema);
+
+//#endregion
+//#region src/legacy-compat/decorators/api-deprecated.decorator.mts
+const ApiDeprecatedSchema = z.object({ message: z.string().optional() });
+const BaseApiDeprecated = LegacyAttributeFactory.createAttribute(ApiDeprecatedToken, ApiDeprecatedSchema);
+/**
+* Marks an endpoint as deprecated.
+*
+* Deprecated endpoints are shown with a visual indicator in documentation
+* and may include a migration message.
+*
+* Legacy-compatible version for TypeScript experimental decorators.
+*
+* @param message - Optional deprecation message
+*
+* @example
+* ```typescript
+* @Controller()
+* export class UserController {
+*   // Simple deprecation
+*   @Endpoint(legacyGetUser)
+*   @ApiDeprecated()
+*   async getLegacyUser() {}
+*
+*   // With migration message
+*   @Endpoint(oldCreateUser)
+*   @ApiDeprecated('Use POST /v2/users instead')
+*   async oldCreateUser() {}
+* }
+* ```
+*/ function ApiDeprecated(message) {
+	return BaseApiDeprecated({ message });
+}
+
+//#endregion
+//#region src/legacy-compat/decorators/api-security.decorator.mts
+const ApiSecuritySchema = z.record(z.string(), z.array(z.string()));
+/**
+* Specifies security requirements for an endpoint.
+*
+* The security requirement object maps security scheme names to their scopes.
+* For schemes that don't use scopes (like API keys), use an empty array.
+*
+* Legacy-compatible version for TypeScript experimental decorators.
+*
+* @param requirements - Security requirements object
+*
+* @example
+* ```typescript
+* @Controller()
+* export class UserController {
+*   // Require bearer token authentication
+*   @Endpoint(getUser)
+*   @ApiSecurity({ bearerAuth: [] })
+*   async getUser() {}
+*
+*   // Require multiple authentication methods
+*   @Endpoint(adminEndpoint)
+*   @ApiSecurity({ bearerAuth: [], apiKey: [] })
+*   async adminAction() {}
+*
+*   // OAuth2 with specific scopes
+*   @Endpoint(writeUser)
+*   @ApiSecurity({ oauth2: ['users:write', 'users:read'] })
+*   async writeUser() {}
+* }
+* ```
+*/ const ApiSecurity = LegacyAttributeFactory.createAttribute(ApiSecurityToken, ApiSecuritySchema);
+
+//#endregion
+//#region src/legacy-compat/decorators/api-exclude.decorator.mts
+/**
+* Excludes an endpoint from OpenAPI documentation.
+*
+* Use this decorator for internal endpoints that should not be visible
+* in the public API documentation.
+*
+* Legacy-compatible version for TypeScript experimental decorators.
+*
+* @example
+* ```typescript
+* @Controller()
+* export class HealthController {
+*   @Endpoint(healthCheck)
+*   @ApiExclude()
+*   async healthCheck() {
+*     return { status: 'ok' }
+*   }
+*
+*   @Endpoint(internalMetrics)
+*   @ApiExclude()
+*   async internalMetrics() {
+*     return { ... }
+*   }
+* }
+* ```
+*/ const ApiExclude = LegacyAttributeFactory.createAttribute(ApiExcludeToken);
+
+//#endregion
+//#region src/legacy-compat/decorators/api-stream.decorator.mts
+const ApiStreamSchema = z.object({
+	contentType: z.string(),
+	description: z.string().optional()
+});
+/**
+* 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
+*   }
+* }
+* ```
+*/ const ApiStream = LegacyAttributeFactory.createAttribute(ApiStreamToken, ApiStreamSchema);
+
+//#endregion
+export { ApiDeprecated, ApiDeprecatedToken, ApiExclude, ApiExcludeToken, ApiOperation, ApiOperationToken, ApiSecurity, ApiSecurityToken, ApiStream, ApiStreamToken, ApiSummary, ApiSummaryToken, ApiTag, ApiTagToken, _EndpointScannerService as EndpointScannerService, _MetadataExtractorService as MetadataExtractorService, _OpenApiGeneratorService as OpenApiGeneratorService, _PathBuilderService as PathBuilderService, _SchemaConverterService as SchemaConverterService };
+//# sourceMappingURL=index.mjs.map

package/lib/legacy-compat/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["LegacyAttributeFactory","z","ApiTagToken","ApiTagSchema","object","name","string","description","optional","BaseApiTag","createAttribute","ApiTag","LegacyAttributeFactory","z","ApiOperationToken","ApiOperationSchema","object","summary","string","optional","description","operationId","deprecated","boolean","externalDocs","url","ApiOperation","createAttribute","LegacyAttributeFactory","z","ApiSummaryToken","ApiSummarySchema","string","ApiSummary","createAttribute","LegacyAttributeFactory","z","ApiDeprecatedToken","ApiDeprecatedSchema","object","message","string","optional","BaseApiDeprecated","createAttribute","ApiDeprecated","LegacyAttributeFactory","z","ApiSecurityToken","ApiSecuritySchema","record","string","array","ApiSecurity","createAttribute","LegacyAttributeFactory","ApiExcludeToken","ApiExclude","createAttribute","LegacyAttributeFactory","z","ApiStreamToken","ApiStreamSchema","object","contentType","string","description","optional","ApiStream","createAttribute"],"sources":["../../src/legacy-compat/decorators/api-tag.decorator.mts","../../src/legacy-compat/decorators/api-operation.decorator.mts","../../src/legacy-compat/decorators/api-summary.decorator.mts","../../src/legacy-compat/decorators/api-deprecated.decorator.mts","../../src/legacy-compat/decorators/api-security.decorator.mts","../../src/legacy-compat/decorators/api-exclude.decorator.mts","../../src/legacy-compat/decorators/api-stream.decorator.mts"],"sourcesContent":["import { LegacyAttributeFactory } from '@navios/core/legacy-compat'\nimport { z } from 'zod/v4'\n\nimport { ApiTagToken } from '../../tokens/index.mjs'\n\nconst ApiTagSchema = z.object({\n  name: z.string(),\n  description: z.string().optional(),\n})\n\n/** Options for the @ApiTag decorator, inferred from the schema */\nexport type ApiTagOptions = z.infer<typeof ApiTagSchema>\n\nconst BaseApiTag = LegacyAttributeFactory.createAttribute(ApiTagToken, ApiTagSchema)\n\n/**\n * Groups endpoints under a specific tag/folder in the documentation.\n *\n * Can be applied to controllers (affects all endpoints) or individual methods.\n * When applied to both, the method-level tag takes precedence.\n *\n * Legacy-compatible version for TypeScript experimental decorators.\n *\n * @param name - The tag name\n * @param description - Optional tag description\n *\n * @example\n * ```typescript\n * // Apply to entire controller\n * @Controller()\n * @ApiTag('Users', 'User management operations')\n * export class UserController {\n *   @Endpoint(getUser)\n *   async getUser() {}\n * }\n *\n * // Apply to individual endpoint\n * @Controller()\n * export class MixedController {\n *   @Endpoint(getUser)\n *   @ApiTag('Users')\n *   async getUser() {}\n *\n *   @Endpoint(getOrder)\n *   @ApiTag('Orders')\n *   async getOrder() {}\n * }\n * ```\n */\nexport function ApiTag(name: string, description?: string) {\n  return BaseApiTag({ name, description })\n}\n","import { LegacyAttributeFactory } from '@navios/core/legacy-compat'\nimport { z } from 'zod/v4'\n\nimport { ApiOperationToken } from '../../tokens/index.mjs'\n\nconst ApiOperationSchema = z.object({\n  summary: z.string().optional(),\n  description: z.string().optional(),\n  operationId: z.string().optional(),\n  deprecated: z.boolean().optional(),\n  externalDocs: z\n    .object({\n      url: z.string(),\n      description: z.string().optional(),\n    })\n    .optional(),\n})\n\n/** Options for the @ApiOperation decorator, inferred from the schema */\nexport type ApiOperationOptions = z.infer<typeof ApiOperationSchema>\n\n/**\n * Provides detailed operation metadata for an endpoint.\n *\n * Use this decorator when you need to specify multiple operation properties.\n * For simple cases, consider using @ApiSummary instead.\n *\n * Legacy-compatible version for TypeScript experimental decorators.\n *\n * @param options - Operation configuration options\n *\n * @example\n * ```typescript\n * @Controller()\n * export class UserController {\n *   @Endpoint(getUser)\n *   @ApiOperation({\n *     summary: 'Get user by ID',\n *     description: 'Retrieves a user by their unique identifier. Returns 404 if not found.',\n *     operationId: 'getUserById',\n *   })\n *   async getUser(params: EndpointParams<typeof getUser>) {}\n *\n *   @Endpoint(legacyGetUser)\n *   @ApiOperation({\n *     summary: 'Get user (legacy)',\n *     deprecated: true,\n *     externalDocs: {\n *       url: 'https://docs.example.com/migration',\n *       description: 'Migration guide'\n *     }\n *   })\n *   async getLegacyUser() {}\n * }\n * ```\n */\nexport const ApiOperation = LegacyAttributeFactory.createAttribute(\n  ApiOperationToken,\n  ApiOperationSchema,\n)\n","import { LegacyAttributeFactory } from '@navios/core/legacy-compat'\nimport { z } from 'zod/v4'\n\nimport { ApiSummaryToken } from '../../tokens/index.mjs'\n\nconst ApiSummarySchema = z.string()\n\n/**\n * Shorthand decorator for adding just a summary to an endpoint.\n *\n * This is equivalent to `@ApiOperation({ summary: '...' })` but more concise.\n *\n * Legacy-compatible version for TypeScript experimental decorators.\n *\n * @param summary - Short summary text for the endpoint\n *\n * @example\n * ```typescript\n * @Controller()\n * export class UserController {\n *   @Endpoint(getUser)\n *   @ApiSummary('Get user by ID')\n *   async getUser() {}\n *\n *   @Endpoint(createUser)\n *   @ApiSummary('Create a new user')\n *   async createUser() {}\n * }\n * ```\n */\nexport const ApiSummary = LegacyAttributeFactory.createAttribute(\n  ApiSummaryToken,\n  ApiSummarySchema,\n)\n","import { LegacyAttributeFactory } from '@navios/core/legacy-compat'\nimport { z } from 'zod/v4'\n\nimport { ApiDeprecatedToken } from '../../tokens/index.mjs'\n\nconst ApiDeprecatedSchema = z.object({\n  message: z.string().optional(),\n})\n\n/** Options for the @ApiDeprecated decorator, inferred from the schema */\nexport type ApiDeprecatedOptions = z.infer<typeof ApiDeprecatedSchema>\n\nconst BaseApiDeprecated = LegacyAttributeFactory.createAttribute(\n  ApiDeprecatedToken,\n  ApiDeprecatedSchema,\n)\n\n/**\n * Marks an endpoint as deprecated.\n *\n * Deprecated endpoints are shown with a visual indicator in documentation\n * and may include a migration message.\n *\n * Legacy-compatible version for TypeScript experimental decorators.\n *\n * @param message - Optional deprecation message\n *\n * @example\n * ```typescript\n * @Controller()\n * export class UserController {\n *   // Simple deprecation\n *   @Endpoint(legacyGetUser)\n *   @ApiDeprecated()\n *   async getLegacyUser() {}\n *\n *   // With migration message\n *   @Endpoint(oldCreateUser)\n *   @ApiDeprecated('Use POST /v2/users instead')\n *   async oldCreateUser() {}\n * }\n * ```\n */\nexport function ApiDeprecated(message?: string) {\n  return BaseApiDeprecated({ message })\n}\n","import { LegacyAttributeFactory } from '@navios/core/legacy-compat'\nimport { z } from 'zod/v4'\n\nimport { ApiSecurityToken } from '../../tokens/index.mjs'\n\nconst ApiSecuritySchema = z.record(z.string(), z.array(z.string()))\n\n/** Security requirement for an endpoint, inferred from the schema */\nexport type ApiSecurityRequirement = z.infer<typeof ApiSecuritySchema>\n\n/**\n * Specifies security requirements for an endpoint.\n *\n * The security requirement object maps security scheme names to their scopes.\n * For schemes that don't use scopes (like API keys), use an empty array.\n *\n * Legacy-compatible version for TypeScript experimental decorators.\n *\n * @param requirements - Security requirements object\n *\n * @example\n * ```typescript\n * @Controller()\n * export class UserController {\n *   // Require bearer token authentication\n *   @Endpoint(getUser)\n *   @ApiSecurity({ bearerAuth: [] })\n *   async getUser() {}\n *\n *   // Require multiple authentication methods\n *   @Endpoint(adminEndpoint)\n *   @ApiSecurity({ bearerAuth: [], apiKey: [] })\n *   async adminAction() {}\n *\n *   // OAuth2 with specific scopes\n *   @Endpoint(writeUser)\n *   @ApiSecurity({ oauth2: ['users:write', 'users:read'] })\n *   async writeUser() {}\n * }\n * ```\n */\nexport const ApiSecurity = LegacyAttributeFactory.createAttribute(\n  ApiSecurityToken,\n  ApiSecuritySchema,\n)\n","import { LegacyAttributeFactory } from '@navios/core/legacy-compat'\n\nimport { ApiExcludeToken } from '../../tokens/index.mjs'\n\n/**\n * Excludes an endpoint from OpenAPI documentation.\n *\n * Use this decorator for internal endpoints that should not be visible\n * in the public API documentation.\n *\n * Legacy-compatible version for TypeScript experimental decorators.\n *\n * @example\n * ```typescript\n * @Controller()\n * export class HealthController {\n *   @Endpoint(healthCheck)\n *   @ApiExclude()\n *   async healthCheck() {\n *     return { status: 'ok' }\n *   }\n *\n *   @Endpoint(internalMetrics)\n *   @ApiExclude()\n *   async internalMetrics() {\n *     return { ... }\n *   }\n * }\n * ```\n */\nexport const ApiExclude = LegacyAttributeFactory.createAttribute(ApiExcludeToken)\n","import { LegacyAttributeFactory } from '@navios/core/legacy-compat'\nimport { z } from 'zod/v4'\n\nimport { ApiStreamToken } from '../../tokens/index.mjs'\n\nconst ApiStreamSchema = z.object({\n  contentType: z.string(),\n  description: z.string().optional(),\n})\n\n/** Options for the @ApiStream decorator, inferred from the schema */\nexport type ApiStreamOptions = z.infer<typeof ApiStreamSchema>\n\n/**\n * Specifies content type and description for stream endpoints.\n *\n * Stream endpoints don't have a responseSchema, so this decorator provides\n * the necessary metadata for OpenAPI documentation.\n *\n * Legacy-compatible version for TypeScript experimental decorators.\n *\n * @param options - Stream response options\n *\n * @example\n * ```typescript\n * @Controller()\n * export class FileController {\n *   // Binary file download\n *   @Stream(downloadFile)\n *   @ApiStream({\n *     contentType: 'application/octet-stream',\n *     description: 'Download file as binary stream'\n *   })\n *   async download(params: StreamParams<typeof downloadFile>, reply: Reply) {\n *     // Stream implementation\n *   }\n * }\n *\n * @Controller()\n * export class EventController {\n *   // Server-Sent Events\n *   @Stream(streamEvents)\n *   @ApiStream({\n *     contentType: 'text/event-stream',\n *     description: 'Real-time event stream'\n *   })\n *   async stream(params: StreamParams<typeof streamEvents>, reply: Reply) {\n *     // SSE implementation\n *   }\n * }\n * ```\n */\nexport const ApiStream = LegacyAttributeFactory.createAttribute(\n  ApiStreamToken,\n  ApiStreamSchema,\n)\n"],"mappings":";;;;;AAKA,MAAMG,eAAeF,EAAEG,OAAO;CAC5BC,MAAMJ,EAAEK,QAAM;CACdC,aAAaN,EAAEK,QAAM,CAAGE,UAAQ;CAClC,CAAA;AAKA,MAAMC,aAAaT,uBAAuBU,gBAAgBR,aAAaC,aAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCvE,SAAgBQ,OAAON,MAAcE,aAAoB;AACvD,QAAOE,WAAW;EAAEJ;EAAME;EAAY,CAAA;;;;;AC7CxC,MAAMQ,qBAAqBF,EAAEG,OAAO;CAClCC,SAASJ,EAAEK,QAAM,CAAGC,UAAQ;CAC5BC,aAAaP,EAAEK,QAAM,CAAGC,UAAQ;CAChCE,aAAaR,EAAEK,QAAM,CAAGC,UAAQ;CAChCG,YAAYT,EAAEU,SAAO,CAAGJ,UAAQ;CAChCK,cAAcX,EACXG,OAAO;EACNS,KAAKZ,EAAEK,QAAM;EACbE,aAAaP,EAAEK,QAAM,CAAGC,UAAQ;EAClC,CAAA,CACCA,UAAQ;CACb,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCA,MAAaO,eAAed,uBAAuBe,gBACjDb,mBACAC,mBAAAA;;;;ACrDF,MAAMgB,mBAAmBF,EAAEG,QAAM;;;;;;;;;;;;;;;;;;;;;;;GAyBjC,MAAaC,aAAaL,uBAAuBM,gBAC/CJ,iBACAC,iBAAAA;;;;AC3BF,MAAMO,sBAAsBF,EAAEG,OAAO,EACnCC,SAASJ,EAAEK,QAAM,CAAGC,UAAQ,EAC9B,CAAA;AAKA,MAAMC,oBAAoBR,uBAAuBS,gBAC/CP,oBACAC,oBAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BF,SAAgBO,cAAcL,SAAgB;AAC5C,QAAOG,kBAAkB,EAAEH,SAAQ,CAAA;;;;;ACvCrC,MAAMS,oBAAoBF,EAAEG,OAAOH,EAAEI,QAAM,EAAIJ,EAAEK,MAAML,EAAEI,QAAM,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoC/D,MAAaE,cAAcP,uBAAuBQ,gBAChDN,kBACAC,kBAAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GCbF,MAAaQ,aAAaF,uBAAuBG,gBAAgBF,gBAAAA;;;;ACzBjE,MAAMM,kBAAkBF,EAAEG,OAAO;CAC/BC,aAAaJ,EAAEK,QAAM;CACrBC,aAAaN,EAAEK,QAAM,CAAGE,UAAQ;CAClC,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CA,MAAaC,YAAYT,uBAAuBU,gBAC9CR,gBACAC,gBAAAA"}