@navios/openapi-bun 0.7.0

package/src/services/openapi-document.service.mts

@@ -0,0 +1,83 @@
+import type { ModuleMetadata } from '@navios/core'
+import type { oas31 } from 'zod-openapi'
+
+import { inject, Injectable, InjectionToken } from '@navios/core'
+import { OpenApiGeneratorService } from '@navios/openapi'
+
+import { stringify as yamlStringify } from 'yaml'
+
+import { OpenApiOptionsToken } from '../tokens/openapi-options.token.mjs'
+
+type OpenAPIObject = oas31.OpenAPIObject
+
+/**
+ * Injection token for the document service
+ */
+export const OpenApiDocumentServiceToken =
+  InjectionToken.create<OpenApiDocumentService>(
+    Symbol.for('OpenApiDocumentService'),
+  )
+
+/**
+ * Service that generates and caches the OpenAPI document.
+ *
+ * The document is generated once during plugin initialization
+ * and served by controllers.
+ */
+@Injectable({
+  token: OpenApiDocumentServiceToken,
+})
+export class OpenApiDocumentService {
+  private options = inject(OpenApiOptionsToken)
+  private generator = inject(OpenApiGeneratorService)
+
+  private document: OpenAPIObject | null = null
+  private yamlDocument: string | null = null
+
+  /**
+   * Initializes the document service by generating the OpenAPI document.
+   * Called by the plugin during registration.
+   *
+   * @param modules - All loaded modules with their metadata
+   * @param globalPrefix - Global route prefix (e.g., '/api/v1')
+   */
+  initialize(modules: Map<string, ModuleMetadata>, globalPrefix: string): void {
+    // Generate document
+    this.document = this.generator.generate(modules, this.options)
+
+    // Apply global prefix to servers if not already set
+    if (
+      globalPrefix &&
+      (!this.document.servers || this.document.servers.length === 0)
+    ) {
+      this.document.servers = [{ url: globalPrefix }]
+    }
+
+    // Pre-generate YAML
+    this.yamlDocument = yamlStringify(this.document)
+  }
+
+  /**
+   * Returns the OpenAPI document as JSON-serializable object.
+   */
+  getDocument(): OpenAPIObject {
+    if (!this.document) {
+      throw new Error(
+        'OpenApiDocumentService not initialized. Call initialize() first.',
+      )
+    }
+    return this.document
+  }
+
+  /**
+   * Returns the OpenAPI document as YAML string.
+   */
+  getYamlDocument(): string {
+    if (!this.yamlDocument) {
+      throw new Error(
+        'OpenApiDocumentService not initialized. Call initialize() first.',
+      )
+    }
+    return this.yamlDocument
+  }
+}

package/src/tokens/index.mts

@@ -0,0 +1 @@
+export { OpenApiOptionsToken, type BunOpenApiPluginOptions } from './openapi-options.token.mjs'

package/src/tokens/openapi-options.token.mts

@@ -0,0 +1,31 @@
+import type { OpenApiGeneratorOptions } from '@navios/openapi'
+
+import { InjectionToken } from '@navios/core'
+
+import type { BunOpenApiPluginOptionsBase } from '../schemas/index.mjs'
+
+/**
+ * Combined options for the Bun OpenAPI plugin.
+ * Extends OpenApiGeneratorOptions with Bun-specific settings.
+ */
+export interface BunOpenApiPluginOptions
+  extends OpenApiGeneratorOptions, Partial<BunOpenApiPluginOptionsBase> {}
+
+/**
+ * Injection token for OpenAPI plugin options.
+ *
+ * Controllers inject this to access the plugin configuration
+ * (paths, Scalar theme, info, etc.)
+ *
+ * @example
+ * ```typescript
+ * @Injectable()
+ * class OpenApiJsonController {
+ *   private options = inject(OpenApiOptionsToken)
+ * }
+ * ```
+ */
+export const OpenApiOptionsToken =
+  InjectionToken.create<BunOpenApiPluginOptions>(
+    Symbol.for('BunOpenApiPluginOptions'),
+  )

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "module": "Node18",
+    "outDir": "dist"
+  },
+  "references": [
+    { "path": "./tsconfig.lib.json" },
+    { "path": "../core" },
+    { "path": "../di" },
+    { "path": "../openapi" },
+    { "path": "../adapter-bun" },
+    { "path": "../builder" }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["src/**/*.spec.mts", "src/**/*.spec-d.mts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "types": ["vitest/globals"]
+  },
+  "include": ["src/**/*.spec.mts", "src/**/*.spec-d.mts"]
+}

package/tsdown.config.mts

@@ -0,0 +1,41 @@
+import { withFilter } from 'rolldown/filter'
+import { defineConfig } from 'tsdown'
+import swc from 'unplugin-swc'
+
+export default defineConfig({
+  entry: ['src/index.mts'],
+  outDir: 'lib',
+  format: ['esm', 'cjs'],
+  clean: true,
+  tsconfig: 'tsconfig.lib.json',
+  treeshake: true,
+  sourcemap: true,
+  platform: 'node',
+  external: [
+    '@navios/core',
+    '@navios/openapi',
+    '@navios/adapter-bun',
+    '@navios/builder',
+    'zod',
+  ],
+  dts: true,
+  target: 'es2022',
+  plugins: [
+    withFilter(
+      swc.rolldown({
+        jsc: {
+          target: 'es2022',
+          parser: {
+            syntax: 'typescript',
+            decorators: true,
+          },
+          transform: {
+            decoratorVersion: '2022-03',
+          },
+        },
+      }),
+      // Only run this transform if the file contains a decorator.
+      { transform: { code: '@' } },
+    ),
+  ],
+})

package/vitest.config.mts

@@ -0,0 +1,11 @@
+import { defineProject } from 'vitest/config'
+
+export default defineProject({
+  test: {
+    typecheck: {
+      enabled: true,
+      tsconfig: './tsconfig.lib.json',
+    },
+    include: ['src/**/*.spec.mts', 'src/**/*.spec-d.mts'],
+  },
+})