@fastify/swagger - npm Package Compare versions

Comparing version 8.1.0 to 8.2.0

index.d.ts

@@ -1,2 +0,2 @@
-import {FastifyPluginCallback, FastifySchema, onRequestHookHandler, preHandlerHookHandler} from 'fastify';
+import { FastifyPluginCallback, FastifySchema, onRequestHookHandler, preHandlerHookHandler } from 'fastify';
 import { OpenAPI, OpenAPIV2, OpenAPIV3 } from 'openapi-types';
@@ -24,5 +24,5 @@
     swagger:
-      ((opts?: { yaml?: false }) => OpenAPI.Document) &
-      ((opts: { yaml: true }) => string) &
-      ((opts: { yaml: boolean }) => OpenAPI.Document | string);
+    ((opts?: { yaml?: false }) => OpenAPI.Document) &
+    ((opts: { yaml: true }) => string) &
+    ((opts: { yaml: boolean }) => OpenAPI.Document | string);
 
@@ -58,46 +58,47 @@ swaggerCSP: {
 
-export const fastifySwagger: FastifyPluginCallback<SwaggerOptions>;
+type FastifySwagger = FastifyPluginCallback<fastifySwagger.SwaggerOptions>
 
-export type SwaggerOptions = (FastifyStaticSwaggerOptions | FastifyDynamicSwaggerOptions);
-export interface FastifySwaggerOptions {
-  mode?: 'static' | 'dynamic';
-}
+declare namespace fastifySwagger {
+  export type SwaggerOptions = (FastifyStaticSwaggerOptions | FastifyDynamicSwaggerOptions);
+  export interface FastifySwaggerOptions {
+    mode?: 'static' | 'dynamic';
+  }
 
-export type FastifySwaggerUiConfigOptions = Partial<{
-  deepLinking: boolean
-  displayOperationId: boolean
-  defaultModelsExpandDepth: number
-  defaultModelExpandDepth: number
-  defaultModelRendering: string
-  displayRequestDuration: boolean
-  docExpansion: string
-  filter: boolean | string
-  layout: string
-  maxDisplayedTags: number
-  showExtensions: boolean
-  showCommonExtensions: boolean
-  useUnsafeMarkdown: boolean
-  syntaxHighlight: {
-    activate?: boolean
-    theme?: string
-  } | false
-  tryItOutEnabled: boolean
-  validatorUrl: string | null
-  supportedSubmitMethods: Array<'get' | 'post' | 'put' | 'delete' | 'patch' | 'options'>
-  persistAuthorization: boolean
-}>
+  export type FastifySwaggerUiConfigOptions = Partial<{
+    deepLinking: boolean
+    displayOperationId: boolean
+    defaultModelsExpandDepth: number
+    defaultModelExpandDepth: number
+    defaultModelRendering: string
+    displayRequestDuration: boolean
+    docExpansion: string
+    filter: boolean | string
+    layout: string
+    maxDisplayedTags: number
+    showExtensions: boolean
+    showCommonExtensions: boolean
+    useUnsafeMarkdown: boolean
+    syntaxHighlight: {
+      activate?: boolean
+      theme?: string
+    } | false
+    tryItOutEnabled: boolean
+    validatorUrl: string | null
+    supportedSubmitMethods: Array<'get' | 'post' | 'put' | 'delete' | 'patch' | 'options'>
+    persistAuthorization: boolean
+  }>
 
-export type FastifySwaggerInitOAuthOptions = Partial<{
-  clientId: string,
-  clientSecret: string,
-  realm: string,
-  appName: string,
-  scopeSeparator: string,
-  scopes: string | string[],
-  additionalQueryStringParams: { [key: string]: any },
-  useBasicAuthenticationWithAccessCodeGrant: boolean,
-  usePkceWithAuthorizationCodeGrant: boolean
-}>
+  export type FastifySwaggerInitOAuthOptions = Partial<{
+    clientId: string,
+    clientSecret: string,
+    realm: string,
+    appName: string,
+    scopeSeparator: string,
+    scopes: string | string[],
+    additionalQueryStringParams: { [key: string]: any },
+    useBasicAuthenticationWithAccessCodeGrant: boolean,
+    usePkceWithAuthorizationCodeGrant: boolean
+  }>
 
-type JSONValue =
+  type JSONValue =
     | string
@@ -110,68 +111,74 @@ | null
 
-export interface JSONObject {
-  [key: string]: JSONValue;
-}
+  export interface JSONObject {
+    [key: string]: JSONValue;
+  }
 
-export interface FastifyDynamicSwaggerOptions extends FastifySwaggerOptions {
-  mode?: 'dynamic';
-  swagger?: Partial<OpenAPIV2.Document>;
-  openapi?: Partial<OpenAPIV3.Document>
-  hiddenTag?: string;
-  hideUntagged?: boolean;
-  /**
-   * Strips matching base path from routes in documentation
-   * @default true
-   */
-  stripBasePath?: boolean;
-  /**
-   * custom function to transform the route's schema and url
-   */
-  transform?: <S extends FastifySchema = FastifySchema>({schema, url}: {schema: S, url: string}) => { schema: JSONObject, url: string };
+  export interface FastifyDynamicSwaggerOptions extends FastifySwaggerOptions {
+    mode?: 'dynamic';
+    swagger?: Partial<OpenAPIV2.Document>;
+    openapi?: Partial<OpenAPIV3.Document>
+    hiddenTag?: string;
+    hideUntagged?: boolean;
+    /**
+     * Strips matching base path from routes in documentation
+     * @default true
+     */
+    stripBasePath?: boolean;
+    /**
+     * custom function to transform the route's schema and url
+     */
+    transform?: <S extends FastifySchema = FastifySchema>({ schema, url }: { schema: S, url: string }) => { schema: JSONObject, url: string };
 
-  refResolver?: {
-    /** Clone the input schema without changing it. Default to `false`. */
-    clone?: boolean;
-    buildLocalReference: (
-      /** The `json` that is being resolved. */
-      json: JSONObject,
-      /** The `baseUri` object of the schema. */
-      baseUri: {
-        scheme?: string;
-        userinfo?: string;
-        host?: string;
-        port?: number | string;
-        path?: string;
-        query?: string;
-        fragment?: string;
-        reference?: string;
-        error?: string;
-      },
-      /** `fragment` is the `$ref` string when the `$ref` is a relative reference. */
-      fragment: string,
-      /** `i` is a local counter to generate a unique key. */
-      i: number
-    ) => string;
+    refResolver?: {
+      /** Clone the input schema without changing it. Default to `false`. */
+      clone?: boolean;
+      buildLocalReference: (
+        /** The `json` that is being resolved. */
+        json: JSONObject,
+        /** The `baseUri` object of the schema. */
+        baseUri: {
+          scheme?: string;
+          userinfo?: string;
+          host?: string;
+          port?: number | string;
+          path?: string;
+          query?: string;
+          fragment?: string;
+          reference?: string;
+          error?: string;
+        },
+        /** `fragment` is the `$ref` string when the `$ref` is a relative reference. */
+        fragment: string,
+        /** `i` is a local counter to generate a unique key. */
+        i: number
+      ) => string;
+    }
   }
-}
 
-export interface StaticPathSpec {
-  path: string;
-  postProcessor?: (spec: OpenAPI.Document) => OpenAPI.Document;
-  baseDir: string;
-}
+  export interface StaticPathSpec {
+    path: string;
+    postProcessor?: (spec: OpenAPI.Document) => OpenAPI.Document;
+    baseDir: string;
+  }
 
-export interface StaticDocumentSpec {
-  document: OpenAPIV2.Document | OpenAPIV3.Document;
-}
+  export interface StaticDocumentSpec {
+    document: OpenAPIV2.Document | OpenAPIV3.Document;
+  }
 
-export interface FastifyStaticSwaggerOptions extends FastifySwaggerOptions {
-  mode: 'static';
-  specification: StaticPathSpec | StaticDocumentSpec;
+  export interface FastifyStaticSwaggerOptions extends FastifySwaggerOptions {
+    mode: 'static';
+    specification: StaticPathSpec | StaticDocumentSpec;
+  }
+
+  export type FastifySwaggerUiHooksOptions = Partial<{
+    onRequest?: onRequestHookHandler,
+    preHandler?: preHandlerHookHandler,
+  }>
+
+  export const fastifySwagger: FastifySwagger
+  export { fastifySwagger as default }
 }
 
-export type FastifySwaggerUiHooksOptions = Partial<{
-  onRequest?: onRequestHookHandler,
-  preHandler?: preHandlerHookHandler,
-}>
+declare function fastifySwagger(...params: Parameters<FastifySwagger>): ReturnType<FastifySwagger>
 
-export default fastifySwagger;
+export = fastifySwagger;

index.js

@@ -30,1 +30,3 @@ 'use strict'
 })
+module.exports.fastifySwagger = fastifySwagger
+module.exports.default = fastifySwagger

package.json

 {
   "name": "@fastify/swagger",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "description": "Serve Swagger/OpenAPI documentation for Fastify, supporting dynamic generation",
   "main": "index.js",
   "types": "index.d.ts",
+  "scripts": {
+    "lint": "standard",
+    "lint:fix": "standard --fix",
+    "test": "npm run test:unit && npm run test:typescript",
+    "test:typescript": "tsd",
+    "test:unit": "tap",
+    "test:unit:report": "npm run test:unit -- --coverage-report=html",
+    "test:unit:verbose": "npm run test:unit -- -Rspec"
+  },
   "repository": {
@@ -38,3 +47,3 @@ "type": "git",
     "joi": "^17.6.0",
-    "joi-to-json": "^2.2.4",
+    "joi-to-json": "^3.1.1",
     "qs": "^6.10.3",
@@ -67,12 +76,3 @@ "standard": "^17.0.0",
     "test"
-  ],
-  "scripts": {
-    "lint": "standard",
-    "lint:fix": "standard --fix",
-    "test": "npm run test:unit && npm run test:typescript",
-    "test:typescript": "tsd",
-    "test:unit": "tap",
-    "test:unit:report": "npm run test:unit -- --coverage-report=html",
-    "test:unit:verbose": "npm run test:unit -- -Rspec"
-  }
-}
+  ]
+}

No alert changes

Improved metrics

Total package byte prevSize

237561

increased by0.21%

Lines of code

6812

increased by0.1%

No dependency changes