@veloxts/router 0.7.6 → 0.7.7

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @veloxts/router
 
+## 0.7.7
+
+### Patch Changes
+
+- refactor(router): rename swaggerUIPlugin → swaggerPlugin, remove redundant exports
+- Updated dependencies
+  - @veloxts/core@0.7.7
+  - @veloxts/validation@0.7.7
+
 ## 0.7.6
 
 ### Patch Changes

package/GUIDE.md

@@ -198,9 +198,9 @@ fs.writeFileSync('openapi.json', JSON.stringify(spec, null, 2));
 Serve interactive API documentation with Swagger UI:
 
 ```typescript
-import { swaggerUIPlugin } from '@veloxts/router';
+import { swaggerPlugin } from '@veloxts/router';
 
-app.server.register(swaggerUIPlugin, {
+app.server.register(swaggerPlugin, {
   routePrefix: '/docs',
   collections: [userProcedures, postProcedures],
   openapi: {
@@ -215,31 +215,6 @@ app.server.register(swaggerUIPlugin, {
 // - /docs/openapi.json - Raw OpenAPI spec
 ```
 
-### Factory Functions
-
-```typescript
-import { createSwaggerUI, getOpenApiSpec, registerDocs } from '@veloxts/router';
-
-// Create pre-configured plugin
-const docs = createSwaggerUI({
-  collections: [userProcedures],
-  openapi: { info: { title: 'My API', version: '1.0.0' } },
-});
-app.server.register(docs);
-
-// Get spec without registering routes
-const spec = getOpenApiSpec({
-  collections: [userProcedures],
-  openapi: { info: { title: 'My API', version: '1.0.0' } },
-});
-
-// Register docs with one call
-await registerDocs(app.server, {
-  collections: [userProcedures],
-  openapi: { info: { title: 'My API', version: '1.0.0' } },
-});
-```
-
 ### CLI Commands
 
 Generate and serve OpenAPI specs from the command line:

package/dist/index.d.ts

@@ -66,7 +66,7 @@ export { serve } from './expose.js';
  *
  * @example
  * ```typescript
- * import { generateOpenApiSpec, swaggerUIPlugin } from '@veloxts/router';
+ * import { generateOpenApiSpec, swaggerPlugin } from '@veloxts/router';
  *
  * // Generate spec programmatically
  * const spec = generateOpenApiSpec([userProcedures], {
@@ -74,7 +74,7 @@ export { serve } from './expose.js';
  * });
  *
  * // Or serve Swagger UI
- * app.register(swaggerUIPlugin, {
+ * app.register(swaggerPlugin, {
  *   routePrefix: '/docs',
  *   collections: [userProcedures],
  *   openapi: { info: { title: 'My API', version: '1.0.0' } },
@@ -82,7 +82,7 @@ export { serve } from './expose.js';
  * ```
  */
 export type { BuildParametersOptions, BuildParametersResult, GuardMappingOptions, JSONSchema, OpenAPIComponents, OpenAPIContact, OpenAPIEncoding, OpenAPIExample, OpenAPIExternalDocs, OpenAPIGeneratorOptions, OpenAPIHeader, OpenAPIHttpMethod, OpenAPIInfo, OpenAPILicense, OpenAPILink, OpenAPIMediaType, OpenAPIOAuthFlow, OpenAPIOAuthFlows, OpenAPIOperation, OpenAPIParameter, OpenAPIPathItem, OpenAPIRequestBody, OpenAPIResponse, OpenAPISecurityRequirement, OpenAPISecurityScheme, OpenAPIServer, OpenAPISpec, OpenAPITag, ParameterIn, QueryParamExtractionOptions, RouteInfo, SchemaConversionOptions, SecuritySchemeType, SwaggerUIConfig, SwaggerUIHtmlOptions, SwaggerUIPluginOptions, } from './openapi/index.js';
-export { buildParameters, convertFromOpenAPIPath, convertToOpenAPIPath, createSecurityRequirement, createStringSchema, createSwaggerUI, DEFAULT_GUARD_MAPPINGS, DEFAULT_SECURITY_SCHEMES, DEFAULT_UI_CONFIG, escapeHtml, extractGuardScopes, extractPathParamNames, extractQueryParameters, extractResourceFromPath, extractSchemaProperties, extractUsedSecuritySchemes, filterUsedSecuritySchemes, generateOpenApiSpec, generateSwaggerUIHtml, getOpenApiRouteSummary, getOpenApiSpec, guardsRequireAuth, guardsToSecurity, hasPathParameters, joinPaths, mapGuardToSecurity, mergeSchemas, mergeSecuritySchemes, normalizePath, parsePathParameters, registerDocs, removeSchemaProperties, SWAGGER_UI_CDN, schemaHasProperties, swaggerUIPlugin, validateOpenApiSpec, zodSchemaToJsonSchema, } from './openapi/index.js';
+export { buildParameters, convertFromOpenAPIPath, convertToOpenAPIPath, createSecurityRequirement, createStringSchema, DEFAULT_GUARD_MAPPINGS, DEFAULT_SECURITY_SCHEMES, DEFAULT_UI_CONFIG, escapeHtml, extractGuardScopes, extractPathParamNames, extractQueryParameters, extractResourceFromPath, extractSchemaProperties, extractUsedSecuritySchemes, filterUsedSecuritySchemes, generateOpenApiSpec, generateSwaggerUIHtml, getOpenApiRouteSummary, getOpenApiSpec, guardsRequireAuth, guardsToSecurity, hasPathParameters, joinPaths, mapGuardToSecurity, mergeSchemas, mergeSecuritySchemes, normalizePath, parsePathParameters, removeSchemaProperties, SWAGGER_UI_CDN, schemaHasProperties, swaggerPlugin, validateOpenApiSpec, zodSchemaToJsonSchema, } from './openapi/index.js';
 export type { AccessLevel, AccessLevelConfig, ADMIN, AdminOutput, AdminTaggedContext, ANONYMOUS, AnonymousOutput, AnonymousTaggedContext, AnyResourceOutput, AUTHENTICATED, AuthenticatedOutput, AuthenticatedTaggedContext, BuilderField, ContextTag, CustomResourceSchemaWithViews, CustomSchemaBuilder, ExtractTag, FilterFieldsByLevel, HasTag, IfAdmin, IfAuthenticated, InferResourceData, InferResourceOutput, IsVisibleToTag, LevelToTag, OutputForLevel, OutputForTag, PUBLIC, PublicOutput, PublicTaggedContext, RelationField, ResourceField, ResourceSchema, ResourceSchemaWithViews, RuntimeField, TaggedContext, TagToLevel, VisibilityLevel, WithTag, } from './resource/index.js';
 /**
  * Resource API for context-dependent output types using phantom types.

package/dist/index.js

@@ -71,13 +71,13 @@ buildParameters, convertFromOpenAPIPath, convertToOpenAPIPath,
 // Security mapper
 createSecurityRequirement, 
 // Schema converter
-createStringSchema, 
-// Plugin
-createSwaggerUI, DEFAULT_GUARD_MAPPINGS, DEFAULT_SECURITY_SCHEMES, DEFAULT_UI_CONFIG, escapeHtml, extractGuardScopes, extractPathParamNames, extractQueryParameters, extractResourceFromPath, extractSchemaProperties, extractUsedSecuritySchemes, filterUsedSecuritySchemes, 
+createStringSchema, DEFAULT_GUARD_MAPPINGS, DEFAULT_SECURITY_SCHEMES, DEFAULT_UI_CONFIG, escapeHtml, extractGuardScopes, extractPathParamNames, extractQueryParameters, extractResourceFromPath, extractSchemaProperties, extractUsedSecuritySchemes, filterUsedSecuritySchemes, 
 // Generator
 generateOpenApiSpec, 
 // HTML Generator
-generateSwaggerUIHtml, getOpenApiRouteSummary, getOpenApiSpec, guardsRequireAuth, guardsToSecurity, hasPathParameters, joinPaths, mapGuardToSecurity, mergeSchemas, mergeSecuritySchemes, normalizePath, parsePathParameters, registerDocs, removeSchemaProperties, SWAGGER_UI_CDN, schemaHasProperties, swaggerUIPlugin, validateOpenApiSpec, zodSchemaToJsonSchema, } from './openapi/index.js';
+generateSwaggerUIHtml, getOpenApiRouteSummary, getOpenApiSpec, guardsRequireAuth, guardsToSecurity, hasPathParameters, joinPaths, mapGuardToSecurity, mergeSchemas, mergeSecuritySchemes, normalizePath, parsePathParameters, removeSchemaProperties, SWAGGER_UI_CDN, schemaHasProperties, 
+// Plugin
+swaggerPlugin, validateOpenApiSpec, zodSchemaToJsonSchema, } from './openapi/index.js';
 /**
  * Resource API for context-dependent output types using phantom types.
  *

package/dist/openapi/index.d.ts

@@ -9,8 +9,7 @@
  * ```typescript
  * import {
  *   generateOpenApiSpec,
- *   swaggerUIPlugin,
- *   createSwaggerUI,
+ *   swaggerPlugin,
  * } from '@veloxts/router';
  *
  * // Generate spec programmatically
@@ -20,7 +19,7 @@
  * });
  *
  * // Or register Swagger UI plugin
- * app.register(swaggerUIPlugin, {
+ * app.register(swaggerPlugin, {
  *   routePrefix: '/docs',
  *   collections: [userProcedures],
  *   openapi: {
@@ -30,7 +29,7 @@
  * ```
  */
 export { generateOpenApiSpec, getOpenApiRouteSummary, validateOpenApiSpec, } from './generator.js';
-export { createSwaggerUI, getOpenApiSpec, registerDocs, swaggerUIPlugin, } from './plugin.js';
+export { getOpenApiSpec, swaggerPlugin, } from './plugin.js';
 export { DEFAULT_UI_CONFIG, escapeHtml, generateSwaggerUIHtml, SWAGGER_UI_CDN, type SwaggerUIHtmlOptions, } from './html-generator.js';
 export { createStringSchema, extractSchemaProperties, mergeSchemas, removeSchemaProperties, type SchemaConversionOptions, schemaHasProperties, zodSchemaToJsonSchema, } from './schema-converter.js';
 export { type BuildParametersOptions, type BuildParametersResult, buildParameters, convertFromOpenAPIPath, convertToOpenAPIPath, extractPathParamNames, extractQueryParameters, extractResourceFromPath, hasPathParameters, joinPaths, normalizePath, parsePathParameters, type QueryParamExtractionOptions, } from './path-extractor.js';

package/dist/openapi/index.js

@@ -9,8 +9,7 @@
  * ```typescript
  * import {
  *   generateOpenApiSpec,
- *   swaggerUIPlugin,
- *   createSwaggerUI,
+ *   swaggerPlugin,
  * } from '@veloxts/router';
  *
  * // Generate spec programmatically
@@ -20,7 +19,7 @@
  * });
  *
  * // Or register Swagger UI plugin
- * app.register(swaggerUIPlugin, {
+ * app.register(swaggerPlugin, {
  *   routePrefix: '/docs',
  *   collections: [userProcedures],
  *   openapi: {
@@ -36,7 +35,7 @@ export { generateOpenApiSpec, getOpenApiRouteSummary, validateOpenApiSpec, } fro
 // ============================================================================
 // Plugin
 // ============================================================================
-export { createSwaggerUI, getOpenApiSpec, registerDocs, swaggerUIPlugin, } from './plugin.js';
+export { getOpenApiSpec, swaggerPlugin, } from './plugin.js';
 // ============================================================================
 // HTML Generator
 // ============================================================================

package/dist/openapi/plugin.d.ts

@@ -14,9 +14,9 @@ import type { OpenAPISpec, SwaggerUIPluginOptions } from './types.js';
  *
  * @example
  * ```typescript
- * import { swaggerUIPlugin } from '@veloxts/router';
+ * import { swaggerPlugin } from '@veloxts/router';
  *
- * app.register(swaggerUIPlugin, {
+ * app.register(swaggerPlugin, {
  *   routePrefix: '/docs',
  *   collections: [userProcedures, postProcedures],
  *   openapi: {
@@ -30,51 +30,7 @@ import type { OpenAPISpec, SwaggerUIPluginOptions } from './types.js';
  * });
  * ```
  */
-export declare const swaggerUIPlugin: FastifyPluginAsync<SwaggerUIPluginOptions>;
-/**
- * Creates a Swagger UI plugin with pre-configured options
- *
- * @param options - Plugin options
- * @returns Configured plugin
- *
- * @example
- * ```typescript
- * import { createSwaggerUI } from '@veloxts/router';
- *
- * const docs = createSwaggerUI({
- *   collections: [userProcedures],
- *   openapi: {
- *     info: { title: 'My API', version: '1.0.0' },
- *   },
- * });
- *
- * app.register(docs);
- * ```
- */
-export declare function createSwaggerUI(options: SwaggerUIPluginOptions): FastifyPluginAsync<SwaggerUIPluginOptions>;
-/**
- * Registers multiple procedure collections with Swagger UI
- *
- * Convenience function that sets up both REST routes and documentation.
- *
- * @param fastify - Fastify instance
- * @param options - Documentation options
- *
- * @example
- * ```typescript
- * import { registerDocs } from '@veloxts/router';
- *
- * await registerDocs(app, {
- *   collections: [userProcedures, postProcedures],
- *   openapi: {
- *     info: { title: 'My API', version: '1.0.0' },
- *   },
- * });
- * ```
- */
-export declare function registerDocs(fastify: {
-    register: (plugin: FastifyPluginAsync<SwaggerUIPluginOptions>, options: SwaggerUIPluginOptions) => Promise<void>;
-}, options: SwaggerUIPluginOptions): Promise<void>;
+export declare const swaggerPlugin: FastifyPluginAsync<SwaggerUIPluginOptions>;
 /**
  * Gets the generated OpenAPI specification without registering routes
  *

package/dist/openapi/plugin.js

@@ -17,9 +17,9 @@ import { generateSwaggerUIHtml } from './html-generator.js';
  *
  * @example
  * ```typescript
- * import { swaggerUIPlugin } from '@veloxts/router';
+ * import { swaggerPlugin } from '@veloxts/router';
  *
- * app.register(swaggerUIPlugin, {
+ * app.register(swaggerPlugin, {
  *   routePrefix: '/docs',
  *   collections: [userProcedures, postProcedures],
  *   openapi: {
@@ -33,7 +33,7 @@ import { generateSwaggerUIHtml } from './html-generator.js';
  * });
  * ```
  */
-export const swaggerUIPlugin = async (fastify, options) => {
+export const swaggerPlugin = async (fastify, options) => {
     const { routePrefix = '/docs', specRoute = `${routePrefix}/openapi.json`, uiConfig = {}, openapi, collections, title = 'API Documentation', favicon, } = options;
     // Generate the OpenAPI specification
     let spec;
@@ -69,54 +69,6 @@ export const swaggerUIPlugin = async (fastify, options) => {
 // ============================================================================
 // Utility Functions
 // ============================================================================
-/**
- * Creates a Swagger UI plugin with pre-configured options
- *
- * @param options - Plugin options
- * @returns Configured plugin
- *
- * @example
- * ```typescript
- * import { createSwaggerUI } from '@veloxts/router';
- *
- * const docs = createSwaggerUI({
- *   collections: [userProcedures],
- *   openapi: {
- *     info: { title: 'My API', version: '1.0.0' },
- *   },
- * });
- *
- * app.register(docs);
- * ```
- */
-export function createSwaggerUI(options) {
-    return async (fastify) => {
-        await swaggerUIPlugin(fastify, options);
-    };
-}
-/**
- * Registers multiple procedure collections with Swagger UI
- *
- * Convenience function that sets up both REST routes and documentation.
- *
- * @param fastify - Fastify instance
- * @param options - Documentation options
- *
- * @example
- * ```typescript
- * import { registerDocs } from '@veloxts/router';
- *
- * await registerDocs(app, {
- *   collections: [userProcedures, postProcedures],
- *   openapi: {
- *     info: { title: 'My API', version: '1.0.0' },
- *   },
- * });
- * ```
- */
-export async function registerDocs(fastify, options) {
-    await fastify.register(swaggerUIPlugin, options);
-}
 /**
  * Gets the generated OpenAPI specification without registering routes
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veloxts/router",
-  "version": "0.7.6",
+  "version": "0.7.7",
   "description": "Procedure definitions with tRPC and REST routing for VeloxTS framework",
   "type": "module",
   "main": "dist/index.js",
@@ -39,8 +39,8 @@
   "dependencies": {
     "@trpc/server": "11.10.0",
     "fastify": "5.7.4",
-    "@veloxts/validation": "0.7.6",
-    "@veloxts/core": "0.7.6"
+    "@veloxts/core": "0.7.7",
+    "@veloxts/validation": "0.7.7"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "4.0.18",