From 0ddeff2bf758395d34172fb39dfcd895c3aa2a59 Mon Sep 17 00:00:00 2001 From: John Cudd Date: Thu, 18 Jan 2024 13:43:27 -0500 Subject: [PATCH 1/5] Added cdn option for scalar --- src/index.ts | 2 ++ src/scalar/index.ts | 6 ++++-- src/types.ts | 9 ++++++++- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/src/index.ts b/src/index.ts index 20d480c..74a17d6 100644 --- a/src/index.ts +++ b/src/index.ts @@ -20,6 +20,7 @@ export const swagger = { provider = 'scalar', scalarVersion = '1.12.5', + scalarCDN = "", scalarConfig = {}, documentation = {}, version = '5.9.0', @@ -33,6 +34,7 @@ export const swagger = }: ElysiaSwaggerConfig = { provider: 'scalar', scalarVersion: '1.12.5', + scalarCDN: "", scalarConfig: {}, documentation: {}, version: '5.9.0', diff --git a/src/scalar/index.ts b/src/scalar/index.ts index d4829ff..447a16b 100644 --- a/src/scalar/index.ts +++ b/src/scalar/index.ts @@ -1,7 +1,7 @@ import scalarElysiaTheme from './theme' import type { ReferenceConfiguration } from './types' -export const ScalarRender = (version: string, config: ReferenceConfiguration) => ` +export const ScalarRender = (version: string, config: ReferenceConfiguration, cdn: string) => ` API Reference @@ -23,5 +23,7 @@ export const ScalarRender = (version: string, config: ReferenceConfiguration) => id="api-reference" data-url="${config.spec?.url}"> + + -` \ No newline at end of file +` diff --git a/src/types.ts b/src/types.ts index 9ab362e..0ce2a47 100644 --- a/src/types.ts +++ b/src/types.ts @@ -29,11 +29,18 @@ export interface ElysiaSwaggerConfig { */ scalarVersion?: string /** - * Scalar configuration to customize scalar + * Version to use for Scalar cdn bundle * * @default '1.12.5' * @see https://github.com/scalar/scalar */ + scalarCDN?: string + /** + * Scalar CDN bundle url + * + * @default '' + * @example 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@$1.12.5/dist/browser/standalone.min.js' + */ scalarConfig?: ReferenceConfiguration /** * Version to use for swagger cdn bundle From fac8974739ddcbfba2c3902edfc76a538037cc1f Mon Sep 17 00:00:00 2001 From: John Cudd Date: Thu, 18 Jan 2024 13:44:19 -0500 Subject: [PATCH 2/5] Added parameter to scalarRender function --- src/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/index.ts b/src/index.ts index 74a17d6..3ec1ae8 100644 --- a/src/index.ts +++ b/src/index.ts @@ -95,7 +95,7 @@ export const swagger = stringifiedSwaggerOptions, autoDarkMode ) - : ScalarRender(scalarVersion, scalarConfiguration), + : ScalarRender(scalarVersion, scalarConfiguration, scalarCDN), { headers: { 'content-type': 'text/html; charset=utf8' From ee981cf0d24ea10fa9a6322b57314c421c738077 Mon Sep 17 00:00:00 2001 From: John Cudd Date: Thu, 18 Jan 2024 13:51:14 -0500 Subject: [PATCH 3/5] Removed old script tag --- src/scalar/index.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/scalar/index.ts b/src/scalar/index.ts index 447a16b..fe1410b 100644 --- a/src/scalar/index.ts +++ b/src/scalar/index.ts @@ -22,7 +22,6 @@ export const ScalarRender = (version: string, config: ReferenceConfiguration, cd - From 53c2b133340babab57acd90b8570945383e547e4 Mon Sep 17 00:00:00 2001 From: John Cudd Date: Thu, 18 Jan 2024 14:29:35 -0500 Subject: [PATCH 4/5] Adjusted documentation --- src/types.ts | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/src/types.ts b/src/types.ts index 0ce2a47..38fbf19 100644 --- a/src/types.ts +++ b/src/types.ts @@ -29,17 +29,20 @@ export interface ElysiaSwaggerConfig { */ scalarVersion?: string /** - * Version to use for Scalar cdn bundle + * Custom URL or path to locally hosted Scalar bundle * - * @default '1.12.5' - * @see https://github.com/scalar/scalar + * 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' */ scalarCDN?: string /** - * Scalar CDN bundle url + * Scalar configuration to customize scalar * - * @default '' - * @example 'https://cdn.jsdelivr.net/npm/@scalar/api-reference@$1.12.5/dist/browser/standalone.min.js' + * @default '1.12.5' + * @see https://github.com/scalar/scalar */ scalarConfig?: ReferenceConfiguration /** From 260c2feb6b0c36051bed1a85d9c76435ba96f6eb Mon Sep 17 00:00:00 2001 From: marclave Date: Mon, 22 Jan 2024 14:03:53 -0800 Subject: [PATCH 5/5] feat: move to scalar configuration prop --- src/scalar/index.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/scalar/index.ts b/src/scalar/index.ts index d4829ff..3323684 100644 --- a/src/scalar/index.ts +++ b/src/scalar/index.ts @@ -21,7 +21,7 @@ export const ScalarRender = (version: string, config: ReferenceConfiguration) => + data-configuration="JSON.stringify(${Bun.inspect(config)})"> ` \ No newline at end of file