@navios/openapi-bun 0.7.0

package/lib/index.d.cts

@@ -0,0 +1,262 @@
+import { InjectionToken, ModuleMetadata, NaviosPlugin, PluginContext, PluginDefinition } from "@navios/core";
+import { z } from "zod";
+import { OpenApiGeneratorOptions } from "@navios/openapi";
+import { oas31 } from "zod-openapi";
+import { ClassType } from "@navios/di";
+
+//#region src/schemas/openapi-bun-options.schema.d.mts
+/**
+ * Zod schema for Scalar UI theme options
+ */
+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 configuration options
+ */
+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 Bun OpenAPI plugin options
+ */
+declare const bunOpenApiPluginOptionsSchema: 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>>;
+  disableJson: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+  disableScalar: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+  disableYaml: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
+type ScalarTheme = z.infer<typeof scalarThemeSchema>;
+type ScalarOptions = z.infer<typeof scalarOptionsSchema>;
+type BunOpenApiPluginOptionsBase = z.infer<typeof bunOpenApiPluginOptionsSchema>;
+//#endregion
+//#region src/tokens/openapi-options.token.d.mts
+/**
+ * Combined options for the Bun OpenAPI plugin.
+ * Extends OpenApiGeneratorOptions with Bun-specific settings.
+ */
+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)
+ * }
+ * ```
+ */
+declare const OpenApiOptionsToken: InjectionToken<BunOpenApiPluginOptions, undefined, false>;
+//#endregion
+//#region src/openapi-bun.plugin.d.mts
+/**
+ * OpenAPI plugin for Bun adapter.
+ *
+ * This plugin:
+ * - Scans all registered modules for endpoints
+ * - Generates an OpenAPI 3.1 document
+ * - Injects controllers for JSON, YAML, and Scalar UI endpoints
+ *
+ * Unlike the Fastify plugin which registers routes directly,
+ * this plugin uses the standard Navios controller pattern via
+ * ModuleLoaderService.extendModules().
+ */
+declare class OpenApiBunPlugin implements NaviosPlugin<BunOpenApiPluginOptions> {
+  readonly name = "openapi-bun";
+  register(context: PluginContext, options: BunOpenApiPluginOptions): Promise<void>;
+  /**
+   * Registers the plugin options in the DI container.
+   */
+  private registerOptions;
+  /**
+   * Registers and initializes the document service.
+   */
+  private initializeDocumentService;
+  /**
+   * Creates controller classes based on options.
+   */
+  private createControllers;
+}
+/**
+ * Creates a plugin definition for the OpenAPI Bun plugin.
+ *
+ * @param options - Plugin configuration options
+ * @returns Plugin definition to pass to `app.usePlugin()`
+ *
+ * @example
+ * ```typescript
+ * import { NaviosFactory } from '@navios/core'
+ * import { defineBunEnvironment } from '@navios/adapter-bun'
+ * import { defineOpenApiPlugin } from '@navios/openapi-bun'
+ *
+ * const app = await NaviosFactory.create(AppModule, {
+ *   adapter: defineBunEnvironment(),
+ * })
+ *
+ * app.usePlugin(defineOpenApiPlugin({
+ *   info: {
+ *     title: 'My API',
+ *     version: '1.0.0',
+ *     description: 'API documentation',
+ *   },
+ *   servers: [
+ *     { url: 'http://localhost:3000', description: 'Development' },
+ *   ],
+ *   scalar: {
+ *     theme: 'purple',
+ *   },
+ * }))
+ *
+ * await app.listen({ port: 3000 })
+ * // API docs available at http://localhost:3000/docs
+ * ```
+ */
+declare function defineOpenApiPlugin(options: BunOpenApiPluginOptions): PluginDefinition<BunOpenApiPluginOptions>;
+//#endregion
+//#region src/services/openapi-document.service.d.mts
+type OpenAPIObject = oas31.OpenAPIObject;
+/**
+ * Injection token for the document service
+ */
+declare const OpenApiDocumentServiceToken: InjectionToken<OpenApiDocumentService, undefined, false>;
+/**
+ * Service that generates and caches the OpenAPI document.
+ *
+ * The document is generated once during plugin initialization
+ * and served by controllers.
+ */
+declare class OpenApiDocumentService {
+  private options;
+  private generator;
+  private document;
+  private yamlDocument;
+  /**
+   * 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;
+  /**
+   * Returns the OpenAPI document as JSON-serializable object.
+   */
+  getDocument(): OpenAPIObject;
+  /**
+   * Returns the OpenAPI document as YAML string.
+   */
+  getYamlDocument(): string;
+}
+//#endregion
+//#region src/controllers/openapi-json.controller.d.mts
+/**
+ * Creates a customized JSON controller with the correct path.
+ * Called by the plugin to create a controller with the configured jsonPath.
+ *
+ * @param jsonPath - The path to serve the OpenAPI JSON (e.g., '/openapi.json')
+ * @returns A controller class that serves the OpenAPI document as JSON
+ */
+declare function createOpenApiJsonController(jsonPath: string): ClassType;
+//#endregion
+//#region src/controllers/openapi-yaml.controller.d.mts
+/**
+ * Creates a customized YAML controller with the correct path.
+ * Uses Stream endpoint to set content-type header properly.
+ *
+ * @param yamlPath - The path to serve the OpenAPI YAML (e.g., '/openapi.yaml')
+ * @returns A controller class that serves the OpenAPI document as YAML
+ */
+declare function createOpenApiYamlController(yamlPath: string): ClassType;
+//#endregion
+//#region src/controllers/openapi-ui.controller.d.mts
+/**
+ * Creates a customized Scalar UI controller with the correct path.
+ *
+ * @param docsPath - The path to serve the Scalar UI (e.g., '/docs')
+ * @param jsonPath - The path to the OpenAPI JSON spec (used by Scalar to load the spec)
+ * @returns A controller class that serves the Scalar API Reference UI
+ */
+declare function createOpenApiUiController(docsPath: string, jsonPath: string): ClassType;
+//#endregion
+export { type BunOpenApiPluginOptions, type BunOpenApiPluginOptionsBase, OpenApiBunPlugin, OpenApiDocumentService, OpenApiDocumentServiceToken, OpenApiOptionsToken, type ScalarOptions, type ScalarTheme, bunOpenApiPluginOptionsSchema, createOpenApiJsonController, createOpenApiUiController, createOpenApiYamlController, defineOpenApiPlugin, scalarOptionsSchema, scalarThemeSchema };
+//# sourceMappingURL=index.d.cts.map

package/lib/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/schemas/openapi-bun-options.schema.mts","../src/tokens/openapi-options.token.mts","../src/openapi-bun.plugin.mts","../src/services/openapi-document.service.mts","../src/controllers/openapi-json.controller.mts","../src/controllers/openapi-yaml.controller.mts","../src/controllers/openapi-ui.controller.mts"],"sourcesContent":[],"mappings":";;;;;;;;;;cAKa,mBAAiB,CAAA,CAAA;;;EAAjB,IAAA,EAAA,MAAA;EAkCA,MAAA,EAAA,QAAA;;;;;;;;;;;;;;;cAAA,qBAAmB,CAAA,CAAA;;;;;IAAA,MAAA,EAAA,QAAA;IAAA,SAAA,EAAA,WAAA;IAiDnB,UAAA,EAAA,YAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAAA,+BAA6B,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;IAAA,UAAA,eAAA,aAAA,CAAA;IAAA,SAAA,eAAA,YAAA,CAAA;IA2C9B,QAAA,eAA6B,YAAA,CAAA;MAE7B,KAAA,eAA+B,YAAA,CAAA;MAC/B,WAAA,eAA2B,YAAkB,CAAA;;;;MC5HxC,WAAA,eACf,YAAA,CAAA;IAAyC,CAAA,eAAA,CAAA,CAAA;IAAjC,GAAA,eAAA,YAAA,CAAA;EAAyB,CAAA,eAAA,CAAA,CAAA;EAAO,WAAA,cAAA,cAAA,aAAA,CAAA,CAAA;EAgB7B,aAAA,cAGV,cAH6B,aAAA,CAAA,CAAA;;;KDwGpB,WAAA,GAAc,CAAA,CAAE,aAAa;AEpGa,KFsG1C,aAAA,GAAgB,CAAA,CAAE,KEtGwB,CAAA,OFsGX,mBEtGW,CAAA;AAIzC,KFmGD,2BAAA,GAA8B,CAAA,CAAE,KEnG/B,CAAA,OFmG4C,6BEnG5C,CAAA;;;;;;;AF9BA,UCKI,uBAAA,SACP,uBDNoB,ECMK,ODNL,CCMa,2BDNb,CAAA,CAAA,CAkC9B;;;;;;;;;;;;;;;cCZa,qBAAmB,eAAA;;;;;;;ADtBhC;AAkCA;;;;;;;cERa,gBAAA,YAA4B,aAAa;;oBAIzC,wBACA,0BACR;;;;;;;;;;;;;;;;;;;;;;;;AFmDL;;;;;;;;;;;;;;;;;;;;;;;;iBEoEgB,mBAAA,UACL,0BACR,iBAAiB;;;KCpJf,aAAA,GAAgB,KAAA,CAAM;;;;AHLd,cGUA,2BHViB,EGUU,cHVV,CGUU,sBHVV,EAAA,SAAA,EAAA,KAAA,CAAA;AAkC9B;;;;;;cGVa,sBAAA;;;;;;;;;;;;sBAcS,YAAY;;;;iBAmBjB;;;;;;;;;;;;;;AHzDjB;AAkCa,iBIfG,2BAAA,CJ2Dd,QAAA,EAAA,MAAA,CAAA,EI3D6D,SJ2D7D;;;;;;;;;AA9EF;AAkCa,iBKvBG,2BAAA,CLmEd,QAAA,EAAA,MAAA,CAAA,EKnE6D,SLmE7D;;;;;;;;;AA9EF;AAkCa,iBMnBG,yBAAA,CN+Dd,QAAA,EAAA,MAAA,EAAA,QAAA,EAAA,MAAA,CAAA,EM5DC,SN4DD"}

package/lib/index.d.mts

@@ -0,0 +1,262 @@
+import { InjectionToken, ModuleMetadata, NaviosPlugin, PluginContext, PluginDefinition } from "@navios/core";
+import { OpenApiGeneratorOptions } from "@navios/openapi";
+import { z } from "zod";
+import { oas31 } from "zod-openapi";
+import { ClassType } from "@navios/di";
+
+//#region src/schemas/openapi-bun-options.schema.d.mts
+/**
+ * Zod schema for Scalar UI theme options
+ */
+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 configuration options
+ */
+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 Bun OpenAPI plugin options
+ */
+declare const bunOpenApiPluginOptionsSchema: 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>>;
+  disableJson: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+  disableScalar: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+  disableYaml: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>;
+type ScalarTheme = z.infer<typeof scalarThemeSchema>;
+type ScalarOptions = z.infer<typeof scalarOptionsSchema>;
+type BunOpenApiPluginOptionsBase = z.infer<typeof bunOpenApiPluginOptionsSchema>;
+//#endregion
+//#region src/tokens/openapi-options.token.d.mts
+/**
+ * Combined options for the Bun OpenAPI plugin.
+ * Extends OpenApiGeneratorOptions with Bun-specific settings.
+ */
+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)
+ * }
+ * ```
+ */
+declare const OpenApiOptionsToken: InjectionToken<BunOpenApiPluginOptions, undefined, false>;
+//#endregion
+//#region src/openapi-bun.plugin.d.mts
+/**
+ * OpenAPI plugin for Bun adapter.
+ *
+ * This plugin:
+ * - Scans all registered modules for endpoints
+ * - Generates an OpenAPI 3.1 document
+ * - Injects controllers for JSON, YAML, and Scalar UI endpoints
+ *
+ * Unlike the Fastify plugin which registers routes directly,
+ * this plugin uses the standard Navios controller pattern via
+ * ModuleLoaderService.extendModules().
+ */
+declare class OpenApiBunPlugin implements NaviosPlugin<BunOpenApiPluginOptions> {
+  readonly name = "openapi-bun";
+  register(context: PluginContext, options: BunOpenApiPluginOptions): Promise<void>;
+  /**
+   * Registers the plugin options in the DI container.
+   */
+  private registerOptions;
+  /**
+   * Registers and initializes the document service.
+   */
+  private initializeDocumentService;
+  /**
+   * Creates controller classes based on options.
+   */
+  private createControllers;
+}
+/**
+ * Creates a plugin definition for the OpenAPI Bun plugin.
+ *
+ * @param options - Plugin configuration options
+ * @returns Plugin definition to pass to `app.usePlugin()`
+ *
+ * @example
+ * ```typescript
+ * import { NaviosFactory } from '@navios/core'
+ * import { defineBunEnvironment } from '@navios/adapter-bun'
+ * import { defineOpenApiPlugin } from '@navios/openapi-bun'
+ *
+ * const app = await NaviosFactory.create(AppModule, {
+ *   adapter: defineBunEnvironment(),
+ * })
+ *
+ * app.usePlugin(defineOpenApiPlugin({
+ *   info: {
+ *     title: 'My API',
+ *     version: '1.0.0',
+ *     description: 'API documentation',
+ *   },
+ *   servers: [
+ *     { url: 'http://localhost:3000', description: 'Development' },
+ *   ],
+ *   scalar: {
+ *     theme: 'purple',
+ *   },
+ * }))
+ *
+ * await app.listen({ port: 3000 })
+ * // API docs available at http://localhost:3000/docs
+ * ```
+ */
+declare function defineOpenApiPlugin(options: BunOpenApiPluginOptions): PluginDefinition<BunOpenApiPluginOptions>;
+//#endregion
+//#region src/services/openapi-document.service.d.mts
+type OpenAPIObject = oas31.OpenAPIObject;
+/**
+ * Injection token for the document service
+ */
+declare const OpenApiDocumentServiceToken: InjectionToken<OpenApiDocumentService, undefined, false>;
+/**
+ * Service that generates and caches the OpenAPI document.
+ *
+ * The document is generated once during plugin initialization
+ * and served by controllers.
+ */
+declare class OpenApiDocumentService {
+  private options;
+  private generator;
+  private document;
+  private yamlDocument;
+  /**
+   * 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;
+  /**
+   * Returns the OpenAPI document as JSON-serializable object.
+   */
+  getDocument(): OpenAPIObject;
+  /**
+   * Returns the OpenAPI document as YAML string.
+   */
+  getYamlDocument(): string;
+}
+//#endregion
+//#region src/controllers/openapi-json.controller.d.mts
+/**
+ * Creates a customized JSON controller with the correct path.
+ * Called by the plugin to create a controller with the configured jsonPath.
+ *
+ * @param jsonPath - The path to serve the OpenAPI JSON (e.g., '/openapi.json')
+ * @returns A controller class that serves the OpenAPI document as JSON
+ */
+declare function createOpenApiJsonController(jsonPath: string): ClassType;
+//#endregion
+//#region src/controllers/openapi-yaml.controller.d.mts
+/**
+ * Creates a customized YAML controller with the correct path.
+ * Uses Stream endpoint to set content-type header properly.
+ *
+ * @param yamlPath - The path to serve the OpenAPI YAML (e.g., '/openapi.yaml')
+ * @returns A controller class that serves the OpenAPI document as YAML
+ */
+declare function createOpenApiYamlController(yamlPath: string): ClassType;
+//#endregion
+//#region src/controllers/openapi-ui.controller.d.mts
+/**
+ * Creates a customized Scalar UI controller with the correct path.
+ *
+ * @param docsPath - The path to serve the Scalar UI (e.g., '/docs')
+ * @param jsonPath - The path to the OpenAPI JSON spec (used by Scalar to load the spec)
+ * @returns A controller class that serves the Scalar API Reference UI
+ */
+declare function createOpenApiUiController(docsPath: string, jsonPath: string): ClassType;
+//#endregion
+export { type BunOpenApiPluginOptions, type BunOpenApiPluginOptionsBase, OpenApiBunPlugin, OpenApiDocumentService, OpenApiDocumentServiceToken, OpenApiOptionsToken, type ScalarOptions, type ScalarTheme, bunOpenApiPluginOptionsSchema, createOpenApiJsonController, createOpenApiUiController, createOpenApiYamlController, defineOpenApiPlugin, scalarOptionsSchema, scalarThemeSchema };
+//# sourceMappingURL=index.d.mts.map

package/lib/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/schemas/openapi-bun-options.schema.mts","../src/tokens/openapi-options.token.mts","../src/openapi-bun.plugin.mts","../src/services/openapi-document.service.mts","../src/controllers/openapi-json.controller.mts","../src/controllers/openapi-yaml.controller.mts","../src/controllers/openapi-ui.controller.mts"],"sourcesContent":[],"mappings":";;;;;;;;;;cAKa,mBAAiB,CAAA,CAAA;;;EAAjB,IAAA,EAAA,MAAA;EAkCA,MAAA,EAAA,QAAA;;;;;;;;;;;;;;;cAAA,qBAAmB,CAAA,CAAA;;;;;IAAA,MAAA,EAAA,QAAA;IAAA,SAAA,EAAA,WAAA;IAiDnB,UAAA,EAAA,YAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAAA,+BAA6B,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;IAAA,UAAA,eAAA,aAAA,CAAA;IAAA,SAAA,eAAA,YAAA,CAAA;IA2C9B,QAAA,eAA6B,YAAA,CAAA;MAE7B,KAAA,eAA+B,YAAA,CAAA;MAC/B,WAAA,eAA2B,YAAkB,CAAA;;;;MC5HxC,WAAA,eACf,YAAA,CAAA;IAAyC,CAAA,eAAA,CAAA,CAAA;IAAjC,GAAA,eAAA,YAAA,CAAA;EAAyB,CAAA,eAAA,CAAA,CAAA;EAAO,WAAA,cAAA,cAAA,aAAA,CAAA,CAAA;EAgB7B,aAAA,cAGV,cAH6B,aAAA,CAAA,CAAA;;;KDwGpB,WAAA,GAAc,CAAA,CAAE,aAAa;AEpGa,KFsG1C,aAAA,GAAgB,CAAA,CAAE,KEtGwB,CAAA,OFsGX,mBEtGW,CAAA;AAIzC,KFmGD,2BAAA,GAA8B,CAAA,CAAE,KEnG/B,CAAA,OFmG4C,6BEnG5C,CAAA;;;;;;;AF9BA,UCKI,uBAAA,SACP,uBDNoB,ECMK,ODNL,CCMa,2BDNb,CAAA,CAAA,CAkC9B;;;;;;;;;;;;;;;cCZa,qBAAmB,eAAA;;;;;;;ADtBhC;AAkCA;;;;;;;cERa,gBAAA,YAA4B,aAAa;;oBAIzC,wBACA,0BACR;;;;;;;;;;;;;;;;;;;;;;;;AFmDL;;;;;;;;;;;;;;;;;;;;;;;;iBEoEgB,mBAAA,UACL,0BACR,iBAAiB;;;KCpJf,aAAA,GAAgB,KAAA,CAAM;;;;AHLd,cGUA,2BHViB,EGUU,cHVV,CGUU,sBHVV,EAAA,SAAA,EAAA,KAAA,CAAA;AAkC9B;;;;;;cGVa,sBAAA;;;;;;;;;;;;sBAcS,YAAY;;;;iBAmBjB;;;;;;;;;;;;;;AHzDjB;AAkCa,iBIfG,2BAAA,CJ2Dd,QAAA,EAAA,MAAA,CAAA,EI3D6D,SJ2D7D;;;;;;;;;AA9EF;AAkCa,iBKvBG,2BAAA,CLmEd,QAAA,EAAA,MAAA,CAAA,EKnE6D,SLmE7D;;;;;;;;;AA9EF;AAkCa,iBMnBG,yBAAA,CN+Dd,QAAA,EAAA,MAAA,EAAA,QAAA,EAAA,MAAA,CAAA,EM5DC,SN4DD"}