@navios/openapi-fastify 0.7.0

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.7.0] - 2025-12-18
+
+### Added
+
+- **Fastify OpenAPI Provider**: Initial release of the Fastify provider for OpenAPI documentation
+- **Scalar UI Integration**: Interactive Scalar UI for exploring API documentation
+- **OpenAPI Plugin**: `defineOpenApiPlugin()` function for easy integration with Navios applications
+- **Automatic Spec Generation**: Automatic OpenAPI specification generation from Navios controllers
+- **JSON Endpoint**: `/openapi.json` endpoint serving OpenAPI specification in JSON format
+- **YAML Endpoint**: `/openapi.yaml` endpoint serving OpenAPI specification in YAML format (configurable)
+- **Documentation UI**: `/docs` endpoint serving interactive Scalar UI documentation
+- **Customizable Configuration**: Extensive configuration options:
+  - OpenAPI info (title, version, description, contact, license, termsOfService)
+  - Server definitions
+  - Security schemes and global security requirements
+  - Custom tags with descriptions
+  - Customizable paths for JSON, YAML, and docs endpoints
+  - Scalar UI theme configuration (default, alternate, moon, purple, solarized)
+  - Option to disable YAML endpoint
+- **Fastify Plugin Integration**: Seamless integration with Fastify's plugin system
+- **Global Prefix Support**: Automatic respect for Fastify's global prefix configuration
+- **Type Safety**: Full TypeScript support with comprehensive type definitions
+- **All Core Decorators**: Full support for all decorators from `@navios/openapi`:
+  - `@ApiTag`, `@ApiOperation`, `@ApiSummary`, `@ApiDeprecated`, `@ApiSecurity`, `@ApiExclude`, `@ApiStream`
+- **Endpoint Type Support**: Support for all endpoint types (standard, multipart, stream)
+- **Zod Schema Support**: Automatic conversion of Zod schemas to OpenAPI schemas
+

package/LICENSE

@@ -0,0 +1,8 @@
+Copyright 2025 Oleksandr Hanzha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

package/README.md

@@ -0,0 +1,311 @@
+# @navios/openapi-fastify
+
+Fastify provider for OpenAPI documentation with Scalar UI integration.
+
+This package provides OpenAPI documentation generation for Navios applications running on Fastify, including automatic endpoint discovery, schema conversion, and Scalar UI integration for interactive API documentation.
+
+## Overview
+
+`@navios/openapi-fastify` extends `@navios/openapi` with Fastify-specific integration, providing:
+
+- Scalar UI for interactive API documentation
+- Automatic OpenAPI spec generation
+- JSON and YAML endpoints for the OpenAPI specification
+- Seamless integration with Fastify's plugin system
+
+## Features
+
+- Automatic endpoint discovery from Navios controllers
+- Zod schema to OpenAPI schema conversion
+- Interactive Scalar UI documentation
+- OpenAPI JSON and YAML endpoints
+- Customizable themes and configuration
+- Support for all endpoint types (standard, multipart, stream)
+- Type-safe configuration
+- Fastify plugin integration
+
+## Installation
+
+```bash
+npm install @navios/openapi @navios/openapi-fastify
+```
+
+Or with yarn:
+
+```bash
+yarn add @navios/openapi @navios/openapi-fastify
+```
+
+## Usage
+
+### Basic Setup
+
+```ts
+import { defineFastifyEnvironment } from '@navios/adapter-fastify'
+import { Module, NaviosFactory } from '@navios/core'
+import { defineOpenApiPlugin } from '@navios/openapi-fastify'
+import { ApiTag, ApiOperation } from '@navios/openapi'
+
+import { AppModule } from './app.module.js'
+
+async function bootstrap() {
+  const app = await NaviosFactory.create(AppModule, {
+    adapter: defineFastifyEnvironment(),
+  })
+
+  app.usePlugin(
+    defineOpenApiPlugin({
+      info: {
+        title: 'My API',
+        version: '1.0.0',
+        description: 'API documentation',
+      },
+    }),
+  )
+
+  await app.init()
+  await app.listen({ port: 3000 })
+  
+  console.log('API docs available at http://localhost:3000/docs')
+}
+
+bootstrap()
+```
+
+### Complete Example
+
+```ts
+import { defineFastifyEnvironment } from '@navios/adapter-fastify'
+import { builder } from '@navios/builder'
+import {
+  Controller,
+  Endpoint,
+  EndpointParams,
+  Module,
+  NaviosFactory,
+} from '@navios/core'
+import { defineOpenApiPlugin } from '@navios/openapi-fastify'
+import { ApiOperation, ApiTag } from '@navios/openapi'
+import { z } from 'zod'
+
+const API = builder()
+
+const userSchema = z.object({
+  id: z.string(),
+  name: z.string(),
+  email: z.string().email(),
+})
+
+export const getUser = API.declareEndpoint({
+  method: 'GET',
+  url: '/users/$userId',
+  responseSchema: userSchema,
+})
+
+@Controller()
+@ApiTag('Users', 'User management operations')
+class UserController {
+  @Endpoint(getUser)
+  @ApiOperation({
+    summary: 'Get user by ID',
+    description: 'Retrieves a user by their unique identifier.',
+  })
+  async getUser(params: EndpointParams<typeof getUser>) {
+    return {
+      id: params.urlParams.userId,
+      name: 'John',
+      email: 'john@example.com',
+    }
+  }
+}
+
+@Module({ controllers: [UserController] })
+class AppModule {}
+
+async function bootstrap() {
+  const app = await NaviosFactory.create(AppModule, {
+    adapter: defineFastifyEnvironment(),
+  })
+
+  app.usePlugin(
+    defineOpenApiPlugin({
+      info: {
+        title: 'User API',
+        version: '1.0.0',
+      },
+      securitySchemes: {
+        bearerAuth: {
+          type: 'http',
+          scheme: 'bearer',
+        },
+      },
+    }),
+  )
+
+  await app.init()
+  await app.listen({ port: 3000 })
+  console.log('API docs: http://localhost:3000/docs')
+}
+
+bootstrap()
+```
+
+### Advanced Configuration
+
+```ts
+app.usePlugin(
+  defineOpenApiPlugin({
+    info: {
+      title: 'My API',
+      version: '1.0.0',
+      description: 'Complete API documentation',
+      termsOfService: 'https://example.com/terms',
+      contact: {
+        name: 'API Support',
+        url: 'https://example.com/support',
+        email: 'support@example.com',
+      },
+      license: {
+        name: 'MIT',
+        url: 'https://opensource.org/licenses/MIT',
+      },
+    },
+    servers: [
+      { url: 'http://localhost:3000', description: 'Development' },
+      { url: 'https://api.example.com', description: 'Production' },
+    ],
+    securitySchemes: {
+      bearerAuth: {
+        type: 'http',
+        scheme: 'bearer',
+        bearerFormat: 'JWT',
+      },
+      apiKey: {
+        type: 'apiKey',
+        in: 'header',
+        name: 'X-API-Key',
+      },
+    },
+    security: [{ bearerAuth: [] }], // Global security requirement
+    tags: [
+      { name: 'Users', description: 'User management' },
+      { name: 'Orders', description: 'Order processing' },
+    ],
+    jsonPath: '/openapi.json',
+    yamlPath: '/openapi.yaml',
+    docsPath: '/docs',
+    scalar: {
+      theme: 'purple',
+    },
+  }),
+)
+```
+
+## Configuration Options
+
+### Path Configuration
+
+| Option     | Default         | Description                |
+| ---------- | --------------- | -------------------------- |
+| `jsonPath` | `/openapi.json` | Path to serve OpenAPI JSON |
+| `yamlPath` | `/openapi.yaml` | Path to serve OpenAPI YAML |
+| `docsPath` | `/docs`         | Path to serve Scalar UI    |
+| `disableYaml` | `false`      | Disable YAML endpoint      |
+
+### Scalar Themes
+
+The `scalar.theme` option accepts: `'default'`, `'alternate'`, `'moon'`, `'purple'`, `'solarized'`.
+
+## Decorators
+
+All decorators from `@navios/openapi` are available:
+
+- `@ApiTag` - Group endpoints under tags
+- `@ApiOperation` - Full operation metadata
+- `@ApiSummary` - Quick summary
+- `@ApiDeprecated` - Mark as deprecated
+- `@ApiSecurity` - Security requirements
+- `@ApiExclude` - Exclude from docs
+- `@ApiStream` - Stream endpoint metadata
+
+See [@navios/openapi](../openapi/README.md) for detailed decorator documentation.
+
+## Endpoints
+
+After setup, the following endpoints are automatically available:
+
+- `GET /docs` - Interactive Scalar UI documentation
+- `GET /openapi.json` - OpenAPI specification in JSON format
+- `GET /openapi.yaml` - OpenAPI specification in YAML format (if enabled)
+
+## Global Prefix Support
+
+The plugin automatically respects Fastify's global prefix configuration:
+
+```ts
+const app = await NaviosFactory.create(AppModule, {
+  adapter: defineFastifyEnvironment(),
+})
+
+app.setGlobalPrefix('/api')
+
+app.usePlugin(
+  defineOpenApiPlugin({
+    info: { title: 'My API', version: '1.0.0' },
+  }),
+)
+
+// Documentation will be available at:
+// - /api/docs
+// - /api/openapi.json
+// - /api/openapi.yaml
+```
+
+## Requirements
+
+- **Runtime**: Node.js 18+
+- **Dependencies**:
+  - `@navios/adapter-fastify` - Fastify adapter for Navios
+  - `@navios/core` - Core Navios framework
+  - `@navios/openapi` - Core OpenAPI package
+  - `fastify` ^5.0.0 - Fastify web framework
+  - `zod` ^3.25.0 || ^4.0.0 - Schema validation
+
+## Features
+
+- **Automatic Discovery**: Discovers all endpoints from your controllers
+- **Schema Conversion**: Converts Zod schemas to OpenAPI schemas automatically
+- **Interactive UI**: Beautiful Scalar UI for exploring your API
+- **Type Safety**: Full TypeScript support with comprehensive types
+- **Customizable**: Extensive configuration options
+- **Production Ready**: Battle-tested in production environments
+- **Fastify Integration**: Seamless integration with Fastify's plugin system
+
+## Examples
+
+For complete working examples, see:
+
+- [OpenAPI Examples](../../examples/openapi/src/main.mts) - Full Fastify example
+- [OpenAPI Guide](../../apps/docs/docs/server/guides/openapi.md) - Comprehensive documentation
+
+## Documentation
+
+For complete documentation on using OpenAPI with Navios, see:
+
+- [OpenAPI Guide](../../apps/docs/docs/server/guides/openapi.md)
+- [@navios/openapi Core Package](../openapi/README.md)
+- [Controllers & Endpoints](../core/docs/controllers.md)
+
+## Comparison with Bun Provider
+
+| Feature     | Fastify Provider | Bun Provider    |
+| ----------- | ---------------- | --------------- |
+| Runtime     | Node.js          | Bun             |
+| Performance | High             | Very High       |
+| UI          | Scalar           | Scalar          |
+| Setup       | Simple           | Simple          |
+| Themes      | 5 themes         | 5 themes        |
+| Ecosystem   | Rich             | Growing         |
+
+Both providers offer the same features and API - choose based on your runtime environment.
+

package/dist/src/index.d.mts

@@ -0,0 +1,6 @@
+export { defineOpenApiPlugin, OpenApiFastifyPlugin, type FastifyOpenApiPluginOptions, type ScalarOptions, type ScalarTheme, } from './openapi-fastify.plugin.mjs';
+export { fastifyOpenApiPluginOptionsSchema, scalarOptionsSchema, scalarThemeSchema, scalarMetaDataSchema, } from './schemas/index.mjs';
+export { applyGlobalPrefix } from './utils/index.mjs';
+export type { OpenApiGeneratorOptions, OpenApiEndpointMetadata, ApiOperationOptions, ApiTagOptions, ApiStreamOptions, ApiDeprecatedOptions, ApiSecurityRequirement, } from '@navios/openapi';
+export { ApiTag, ApiOperation, ApiSummary, ApiDeprecated, ApiSecurity, ApiExclude, ApiStream, } from '@navios/openapi';
+//# sourceMappingURL=index.d.mts.map

package/dist/src/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../src/index.mts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,KAAK,2BAA2B,EAChC,KAAK,aAAa,EAClB,KAAK,WAAW,GACjB,MAAM,8BAA8B,CAAA;AAGrC,OAAO,EACL,iCAAiC,EACjC,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,GACrB,MAAM,qBAAqB,CAAA;AAG5B,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAGrD,YAAY,EACV,uBAAuB,EACvB,uBAAuB,EACvB,mBAAmB,EACnB,aAAa,EACb,gBAAgB,EAChB,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,iBAAiB,CAAA;AAGxB,OAAO,EACL,MAAM,EACN,YAAY,EACZ,UAAU,EACV,aAAa,EACb,WAAW,EACX,UAAU,EACV,SAAS,GACV,MAAM,iBAAiB,CAAA"}

package/dist/src/openapi-fastify.plugin.d.mts

@@ -0,0 +1,74 @@
+import type { NaviosPlugin, PluginContext, PluginDefinition } from '@navios/core';
+import type { OpenApiGeneratorOptions } from '@navios/openapi';
+import type { FastifyOpenApiPluginOptionsBase, ScalarOptions, ScalarTheme } from './schemas/index.mjs';
+/**
+ * Combined options for the Fastify OpenAPI plugin.
+ * Extends OpenApiGeneratorOptions with Fastify-specific settings.
+ */
+export interface FastifyOpenApiPluginOptions extends OpenApiGeneratorOptions, Partial<FastifyOpenApiPluginOptionsBase> {
+}
+/**
+ * Class-based OpenAPI Fastify plugin that integrates with Navios plugin system.
+ *
+ * This plugin:
+ * - Scans all registered modules for endpoints
+ * - Generates an OpenAPI 3.1 document
+ * - Serves the document as JSON and optionally YAML
+ * - Provides Scalar UI for interactive documentation
+ */
+export declare class OpenApiFastifyPlugin implements NaviosPlugin<FastifyOpenApiPluginOptions> {
+    readonly name = "openapi-fastify";
+    register(context: PluginContext, options: FastifyOpenApiPluginOptions): Promise<void>;
+    /**
+     * Generates the Scalar API Reference HTML document.
+     *
+     * @param specUrl - URL to the OpenAPI JSON specification
+     * @param options - Scalar UI configuration options
+     * @returns Complete HTML document string
+     */
+    private generateScalarHtml;
+}
+/**
+ * Creates a plugin definition for the OpenAPI Fastify plugin.
+ *
+ * @param options - Plugin configuration options
+ * @returns Plugin definition to pass to `app.usePlugin()`
+ *
+ * @example
+ * ```typescript
+ * import { NaviosFactory } from '@navios/core'
+ * import { defineFastifyEnvironment } from '@navios/adapter-fastify'
+ * import { defineOpenApiPlugin } from '@navios/openapi-fastify'
+ *
+ * const app = await NaviosFactory.create(AppModule, {
+ *   adapter: defineFastifyEnvironment(),
+ * })
+ *
+ * app.usePlugin(defineOpenApiPlugin({
+ *   info: {
+ *     title: 'My API',
+ *     version: '1.0.0',
+ *     description: 'API documentation',
+ *   },
+ *   servers: [
+ *     { url: 'http://localhost:3000', description: 'Development' },
+ *   ],
+ *   securitySchemes: {
+ *     bearerAuth: {
+ *       type: 'http',
+ *       scheme: 'bearer',
+ *       bearerFormat: 'JWT',
+ *     },
+ *   },
+ *   scalar: {
+ *     theme: 'purple',
+ *   },
+ * }))
+ *
+ * await app.listen({ port: 3000 })
+ * // API docs available at http://localhost:3000/docs
+ * ```
+ */
+export declare function defineOpenApiPlugin(options: FastifyOpenApiPluginOptions): PluginDefinition<FastifyOpenApiPluginOptions>;
+export type { ScalarOptions, ScalarTheme };
+//# sourceMappingURL=openapi-fastify.plugin.d.mts.map

package/dist/src/openapi-fastify.plugin.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-fastify.plugin.d.mts","sourceRoot":"","sources":["../../src/openapi-fastify.plugin.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,gBAAgB,EACjB,MAAM,cAAc,CAAA;AACrB,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAA;AAQ9D,OAAO,KAAK,EACV,+BAA+B,EAC/B,aAAa,EACb,WAAW,EACZ,MAAM,qBAAqB,CAAA;AAK5B;;;GAGG;AACH,MAAM,WAAW,2BACf,SAAQ,uBAAuB,EAAE,OAAO,CAAC,+BAA+B,CAAC;CAAG;AAE9E;;;;;;;;GAQG;AACH,qBAAa,oBAAqB,YAAW,YAAY,CAAC,2BAA2B,CAAC;IACpF,QAAQ,CAAC,IAAI,qBAAoB;IAE3B,QAAQ,CACZ,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC,IAAI,CAAC;IAiDhB;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;CAa3B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,2BAA2B,GACnC,gBAAgB,CAAC,2BAA2B,CAAC,CAK/C;AAGD,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,CAAA"}

package/dist/src/schemas/index.d.mts

@@ -0,0 +1,2 @@
+export { fastifyOpenApiPluginOptionsSchema, scalarMetaDataSchema, scalarOptionsSchema, scalarThemeSchema, type FastifyOpenApiPluginOptionsBase, type ScalarMetaData, type ScalarOptions, type ScalarTheme, } from './openapi-fastify-options.schema.mjs';
+//# sourceMappingURL=index.d.mts.map

package/dist/src/schemas/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/schemas/index.mts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,KAAK,+BAA+B,EACpC,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,WAAW,GACjB,MAAM,sCAAsC,CAAA"}

package/dist/src/schemas/openapi-fastify-options.schema.d.mts

@@ -0,0 +1,113 @@
+import { z } from 'zod';
+/**
+ * Zod schema for Scalar UI theme options
+ */
+export declare const scalarThemeSchema: z.ZodEnum<{
+    default: "default";
+    alternate: "alternate";
+    moon: "moon";
+    purple: "purple";
+    solarized: "solarized";
+    bluePlanet: "bluePlanet";
+    saturn: "saturn";
+    kepler: "kepler";
+    mars: "mars";
+    deepSpace: "deepSpace";
+    laserwave: "laserwave";
+    elysiajs: "elysiajs";
+    fastify: "fastify";
+    none: "none";
+}>;
+/**
+ * Zod schema for Scalar UI metadata
+ */
+export declare const scalarMetaDataSchema: z.ZodOptional<z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+    ogDescription: z.ZodOptional<z.ZodString>;
+    ogTitle: z.ZodOptional<z.ZodString>;
+    ogImage: z.ZodOptional<z.ZodString>;
+    twitterCard: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>>;
+/**
+ * Zod schema for Scalar UI configuration options
+ */
+export declare const scalarOptionsSchema: z.ZodObject<{
+    theme: z.ZodOptional<z.ZodEnum<{
+        default: "default";
+        alternate: "alternate";
+        moon: "moon";
+        purple: "purple";
+        solarized: "solarized";
+        bluePlanet: "bluePlanet";
+        saturn: "saturn";
+        kepler: "kepler";
+        mars: "mars";
+        deepSpace: "deepSpace";
+        laserwave: "laserwave";
+        elysiajs: "elysiajs";
+        fastify: "fastify";
+        none: "none";
+    }>>;
+    favicon: z.ZodOptional<z.ZodString>;
+    logo: z.ZodOptional<z.ZodString>;
+    hideDownloadButton: z.ZodOptional<z.ZodBoolean>;
+    hideSearch: z.ZodOptional<z.ZodBoolean>;
+    customCss: z.ZodOptional<z.ZodString>;
+    metaData: z.ZodOptional<z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        description: z.ZodOptional<z.ZodString>;
+        ogDescription: z.ZodOptional<z.ZodString>;
+        ogTitle: z.ZodOptional<z.ZodString>;
+        ogImage: z.ZodOptional<z.ZodString>;
+        twitterCard: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    cdn: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Zod schema for Fastify OpenAPI plugin options
+ */
+export declare const fastifyOpenApiPluginOptionsSchema: z.ZodObject<{
+    jsonPath: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    yamlPath: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    docsPath: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    scalar: z.ZodOptional<z.ZodObject<{
+        theme: z.ZodOptional<z.ZodEnum<{
+            default: "default";
+            alternate: "alternate";
+            moon: "moon";
+            purple: "purple";
+            solarized: "solarized";
+            bluePlanet: "bluePlanet";
+            saturn: "saturn";
+            kepler: "kepler";
+            mars: "mars";
+            deepSpace: "deepSpace";
+            laserwave: "laserwave";
+            elysiajs: "elysiajs";
+            fastify: "fastify";
+            none: "none";
+        }>>;
+        favicon: z.ZodOptional<z.ZodString>;
+        logo: z.ZodOptional<z.ZodString>;
+        hideDownloadButton: z.ZodOptional<z.ZodBoolean>;
+        hideSearch: z.ZodOptional<z.ZodBoolean>;
+        customCss: z.ZodOptional<z.ZodString>;
+        metaData: z.ZodOptional<z.ZodObject<{
+            title: z.ZodOptional<z.ZodString>;
+            description: z.ZodOptional<z.ZodString>;
+            ogDescription: z.ZodOptional<z.ZodString>;
+            ogTitle: z.ZodOptional<z.ZodString>;
+            ogImage: z.ZodOptional<z.ZodString>;
+            twitterCard: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+        cdn: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    disableScalar: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    disableYaml: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
+export type ScalarTheme = z.infer<typeof scalarThemeSchema>;
+export type ScalarMetaData = z.infer<typeof scalarMetaDataSchema>;
+export type ScalarOptions = z.infer<typeof scalarOptionsSchema>;
+export type FastifyOpenApiPluginOptionsBase = z.infer<typeof fastifyOpenApiPluginOptionsSchema>;
+//# sourceMappingURL=openapi-fastify-options.schema.d.mts.map

package/dist/src/schemas/openapi-fastify-options.schema.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-fastify-options.schema.d.mts","sourceRoot":"","sources":["../../../src/schemas/openapi-fastify-options.schema.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;EAe5B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;kBASpB,CAAA;AAEb;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA4C9B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmC5C,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AAC3D,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACjE,MAAM,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mBAAmB,CAAC,CAAA;AAC/D,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAA"}

package/dist/src/utils/apply-global-prefix.util.d.mts

@@ -0,0 +1,26 @@
+import type { OpenApiGeneratorOptions } from '@navios/openapi';
+/**
+ * OpenAPI document shape (minimal interface for typing)
+ */
+export interface OpenAPIDocument {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+    };
+    paths?: Record<string, unknown>;
+    servers?: Array<{
+        url: string;
+        description?: string;
+    }>;
+}
+/**
+ * Applies global prefix to OpenAPI servers if needed.
+ *
+ * @param document - The OpenAPI document to modify
+ * @param globalPrefix - The global route prefix (e.g., '/api/v1')
+ * @param options - Plugin options that may contain server configuration
+ * @returns The document with servers array updated if applicable
+ */
+export declare function applyGlobalPrefix<T extends OpenAPIDocument>(document: T, globalPrefix: string, options: OpenApiGeneratorOptions): T;
+//# sourceMappingURL=apply-global-prefix.util.d.mts.map

package/dist/src/utils/apply-global-prefix.util.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-global-prefix.util.d.mts","sourceRoot":"","sources":["../../../src/utils/apply-global-prefix.util.mts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iBAAiB,CAAA;AAE9D;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC/B,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,GAAG,EAAE,MAAM,CAAA;QACX,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB,CAAC,CAAA;CACH;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,eAAe,EACzD,QAAQ,EAAE,CAAC,EACX,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,uBAAuB,GAC/B,CAAC,CAqBH"}

package/dist/src/utils/index.d.mts

@@ -0,0 +1,2 @@
+export { applyGlobalPrefix, type OpenAPIDocument } from './apply-global-prefix.util.mjs';
+//# sourceMappingURL=index.d.mts.map

package/dist/src/utils/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/utils/index.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,KAAK,eAAe,EAAE,MAAM,gCAAgC,CAAA"}