@elysiajs/swagger
Advanced tools
@elysiajs/swagger - npm Package Compare versions
Comparing version 0.8.3 to 0.8.4
@@ -8,3 +8,3 @@ import { type Elysia } from 'elysia'; | ||
| */ | ||
| export declare const swagger: <Path extends string = "/swagger">({ provider, scalarVersion, scalarConfig, documentation, version, excludeStaticFile, path, exclude, swaggerOptions, theme, autoDarkMode, excludeMethods }?: ElysiaSwaggerConfig<Path>) => (app: Elysia) => Elysia<"", { | ||
| export declare const swagger: <Path extends string = "/swagger">({ provider, scalarVersion, scalarCDN, scalarConfig, documentation, version, excludeStaticFile, path, exclude, swaggerOptions, theme, autoDarkMode, excludeMethods }?: ElysiaSwaggerConfig<Path>) => (app: Elysia) => Elysia<"", { | ||
| request: {}; | ||
@@ -11,0 +11,0 @@ store: {}; |
@@ -12,5 +12,6 @@ "use strict"; | ||
| */ | ||
| const swagger = ({ provider = 'scalar', scalarVersion = '1.12.5', scalarConfig = {}, documentation = {}, version = '5.9.0', excludeStaticFile = true, path = '/swagger', exclude = [], swaggerOptions = {}, theme = `https://unpkg.com/swagger-ui-dist@${version}/swagger-ui.css`, autoDarkMode = true, excludeMethods = ['OPTIONS'] } = { | ||
| const swagger = ({ provider = 'scalar', scalarVersion = 'latest', scalarCDN = '', scalarConfig = {}, documentation = {}, version = '5.9.0', excludeStaticFile = true, path = '/swagger', exclude = [], swaggerOptions = {}, theme = `https://unpkg.com/swagger-ui-dist@${version}/swagger-ui.css`, autoDarkMode = true, excludeMethods = ['OPTIONS'] } = { | ||
| provider: 'scalar', | ||
| scalarVersion: '1.12.5', | ||
| scalarVersion: 'latest', | ||
| scalarCDN: '', | ||
| scalarConfig: {}, | ||
@@ -59,3 +60,3 @@ documentation: {}, | ||
| ? (0, swagger_1.SwaggerUIRender)(info, version, theme, stringifiedSwaggerOptions, autoDarkMode) | ||
| : (0, scalar_1.ScalarRender)(scalarVersion, scalarConfiguration), { | ||
| : (0, scalar_1.ScalarRender)(scalarVersion, scalarConfiguration, scalarCDN), { | ||
| headers: { | ||
@@ -62,0 +63,0 @@ 'content-type': 'text/html; charset=utf8' |
| import type { ReferenceConfiguration } from './types'; | ||
| export declare const ScalarRender: (version: string, config: ReferenceConfiguration) => string; | ||
| export declare const ScalarRender: (version: string, config: ReferenceConfiguration, cdn: string) => string; |
@@ -8,3 +8,3 @@ "use strict"; | ||
| const theme_1 = __importDefault(require("./theme")); | ||
| const ScalarRender = (version, config) => `<!doctype html> | ||
| const ScalarRender = (version, config, cdn) => `<!doctype html> | ||
| <html> | ||
@@ -29,6 +29,11 @@ <head> | ||
| id="api-reference" | ||
| data-url="${config.spec?.url}"></script> | ||
| <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference@${version}/dist/browser/standalone.min.js"></script> | ||
| data-url="${config.spec?.url}" | ||
| data-configuration='${JSON.stringify(config)}' | ||
| > | ||
| </script> | ||
| <script src="${cdn | ||
| ? cdn | ||
| : `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${version}/dist/browser/standalone.min.js`}"></script> | ||
| </body> | ||
| </html>`; | ||
| exports.ScalarRender = ScalarRender; |
@@ -22,3 +22,3 @@ import type { OpenAPIV3 } from 'openapi-types'; | ||
| * | ||
| * @default '1.12.5' | ||
| * @default 'latest' | ||
| * @see https://github.com/scalar/scalar | ||
@@ -28,7 +28,19 @@ */ | ||
| /** | ||
| * Scalar configuration to customize scalar | ||
| * Optional override to specifying the path for the Scalar bundle | ||
| * | ||
| * @default '1.12.5' | ||
| * Custom URL or path to locally hosted Scalar bundle | ||
| * | ||
| * Lease blank to use default jsdeliver.net CDN | ||
| * | ||
| * @default '' | ||
| * @example 'https://unpkg.com/@scalar/api-reference@1.13.10/dist/browser/standalone.js' | ||
| * @example '/public/standalone.js' | ||
| * @see https://github.com/scalar/scalar | ||
| */ | ||
| scalarCDN?: string; | ||
| /** | ||
| * Scalar configuration to customize scalar | ||
| *' | ||
| * @see https://github.com/scalar/scalar | ||
| */ | ||
| scalarConfig?: ReferenceConfiguration; | ||
@@ -35,0 +47,0 @@ /** |
@@ -8,3 +8,3 @@ import { type Elysia } from 'elysia'; | ||
| */ | ||
| export declare const swagger: <Path extends string = "/swagger">({ provider, scalarVersion, scalarConfig, documentation, version, excludeStaticFile, path, exclude, swaggerOptions, theme, autoDarkMode, excludeMethods }?: ElysiaSwaggerConfig<Path>) => (app: Elysia) => Elysia<"", { | ||
| export declare const swagger: <Path extends string = "/swagger">({ provider, scalarVersion, scalarCDN, scalarConfig, documentation, version, excludeStaticFile, path, exclude, swaggerOptions, theme, autoDarkMode, excludeMethods }?: ElysiaSwaggerConfig<Path>) => (app: Elysia) => Elysia<"", { | ||
| request: {}; | ||
@@ -11,0 +11,0 @@ store: {}; |
@@ -9,5 +9,6 @@ import { SwaggerUIRender } from './swagger'; | ||
| */ | ||
| export const swagger = ({ provider = 'scalar', scalarVersion = '1.12.5', scalarConfig = {}, documentation = {}, version = '5.9.0', excludeStaticFile = true, path = '/swagger', exclude = [], swaggerOptions = {}, theme = `https://unpkg.com/swagger-ui-dist@${version}/swagger-ui.css`, autoDarkMode = true, excludeMethods = ['OPTIONS'] } = { | ||
| export const swagger = ({ provider = 'scalar', scalarVersion = 'latest', scalarCDN = '', scalarConfig = {}, documentation = {}, version = '5.9.0', excludeStaticFile = true, path = '/swagger', exclude = [], swaggerOptions = {}, theme = `https://unpkg.com/swagger-ui-dist@${version}/swagger-ui.css`, autoDarkMode = true, excludeMethods = ['OPTIONS'] } = { | ||
| provider: 'scalar', | ||
| scalarVersion: '1.12.5', | ||
| scalarVersion: 'latest', | ||
| scalarCDN: '', | ||
| scalarConfig: {}, | ||
@@ -56,3 +57,3 @@ documentation: {}, | ||
| ? SwaggerUIRender(info, version, theme, stringifiedSwaggerOptions, autoDarkMode) | ||
| : ScalarRender(scalarVersion, scalarConfiguration), { | ||
| : ScalarRender(scalarVersion, scalarConfiguration, scalarCDN), { | ||
| headers: { | ||
@@ -59,0 +60,0 @@ 'content-type': 'text/html; charset=utf8' |
| import type { ReferenceConfiguration } from './types'; | ||
| export declare const ScalarRender: (version: string, config: ReferenceConfiguration) => string; | ||
| export declare const ScalarRender: (version: string, config: ReferenceConfiguration, cdn: string) => string; |
| import scalarElysiaTheme from './theme'; | ||
| export const ScalarRender = (version, config) => `<!doctype html> | ||
| export const ScalarRender = (version, config, cdn) => `<!doctype html> | ||
| <html> | ||
@@ -22,5 +22,10 @@ <head> | ||
| id="api-reference" | ||
| data-url="${config.spec?.url}"></script> | ||
| <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference@${version}/dist/browser/standalone.min.js"></script> | ||
| data-url="${config.spec?.url}" | ||
| data-configuration='${JSON.stringify(config)}' | ||
| > | ||
| </script> | ||
| <script src="${cdn | ||
| ? cdn | ||
| : `https://cdn.jsdelivr.net/npm/@scalar/api-reference@${version}/dist/browser/standalone.min.js`}"></script> | ||
| </body> | ||
| </html>`; |
@@ -22,3 +22,3 @@ import type { OpenAPIV3 } from 'openapi-types'; | ||
| * | ||
| * @default '1.12.5' | ||
| * @default 'latest' | ||
| * @see https://github.com/scalar/scalar | ||
@@ -28,7 +28,19 @@ */ | ||
| /** | ||
| * Scalar configuration to customize scalar | ||
| * Optional override to specifying the path for the Scalar bundle | ||
| * | ||
| * @default '1.12.5' | ||
| * Custom URL or path to locally hosted Scalar bundle | ||
| * | ||
| * Lease blank to use default jsdeliver.net CDN | ||
| * | ||
| * @default '' | ||
| * @example 'https://unpkg.com/@scalar/api-reference@1.13.10/dist/browser/standalone.js' | ||
| * @example '/public/standalone.js' | ||
| * @see https://github.com/scalar/scalar | ||
| */ | ||
| scalarCDN?: string; | ||
| /** | ||
| * Scalar configuration to customize scalar | ||
| *' | ||
| * @see https://github.com/scalar/scalar | ||
| */ | ||
| scalarConfig?: ReferenceConfiguration; | ||
@@ -35,0 +47,0 @@ /** |
| { | ||
| "name": "@elysiajs/swagger", | ||
| "version": "0.8.3", | ||
| "version": "0.8.4", | ||
| "description": "Plugin for Elysia to auto-generate Swagger page", | ||
@@ -5,0 +5,0 @@ "author": { |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.73%
158812
- Lines of code
- increased by0.94%
4079
No dependency changes