@scalar/hono-api-reference 0.5.107 → 0.5.110
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/honoApiReference.d.ts +19 -0
- package/dist/honoApiReference.d.ts.map +1 -0
- package/dist/{index.cjs → honoApiReference.js} +29 -50
- package/dist/honoApiReference.test.d.ts +2 -0
- package/dist/honoApiReference.test.d.ts.map +1 -0
- package/dist/index.d.ts +2 -22
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +1 -144
- package/package.json +18 -15
- package/dist/index.d.cts +0 -22
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type { ReferenceConfiguration } from '@scalar/api-reference';
|
|
2
|
+
import type { Env, MiddlewareHandler } from 'hono';
|
|
3
|
+
export type ApiReferenceOptions = ReferenceConfiguration & {
|
|
4
|
+
pageTitle?: string;
|
|
5
|
+
cdn?: string;
|
|
6
|
+
};
|
|
7
|
+
/**
|
|
8
|
+
* The custom theme CSS for the API Reference.
|
|
9
|
+
*/
|
|
10
|
+
export declare const customThemeCSS = "\n.light-mode {\n color-scheme: light;\n --scalar-color-1: #2a2f45;\n --scalar-color-2: #757575;\n --scalar-color-3: #8e8e8e;\n --scalar-color-disabled: #b4b1b1;\n --scalar-color-ghost: #a7a7a7;\n --scalar-color-accent: #0099ff;\n --scalar-background-1: #fff;\n --scalar-background-2: #f6f6f6;\n --scalar-background-3: #e7e7e7;\n --scalar-background-4: rgba(0, 0, 0, 0.06);\n --scalar-background-accent: #8ab4f81f;\n\n --scalar-border-color: rgba(0, 0, 0, 0.1);\n --scalar-scrollbar-color: rgba(0, 0, 0, 0.18);\n --scalar-scrollbar-color-active: rgba(0, 0, 0, 0.36);\n --scalar-lifted-brightness: 1;\n --scalar-backdrop-brightness: 1;\n\n --scalar-shadow-1: 0 1px 3px 0 rgba(0, 0, 0, 0.11);\n --scalar-shadow-2: rgba(0, 0, 0, 0.08) 0px 13px 20px 0px,\n rgba(0, 0, 0, 0.08) 0px 3px 8px 0px, #eeeeed 0px 0 0 1px;\n\n --scalar-button-1: rgb(49 53 56);\n --scalar-button-1-color: #fff;\n --scalar-button-1-hover: rgb(28 31 33);\n\n --scalar-color-green: #069061;\n --scalar-color-red: #ef0006;\n --scalar-color-yellow: #edbe20;\n --scalar-color-blue: #0082d0;\n --scalar-color-orange: #fb892c;\n --scalar-color-purple: #5203d1;\n}\n\n.dark-mode {\n color-scheme: dark;\n --scalar-color-1: rgba(255, 255, 245, .86);\n --scalar-color-2: rgba(255, 255, 245, .6);\n --scalar-color-3: rgba(255, 255, 245, .38);\n --scalar-color-disabled: rgba(255, 255, 245, .25);\n --scalar-color-ghost: rgba(255, 255, 245, .25);\n --scalar-color-accent: #e36002;\n --scalar-background-1: #1e1e20;\n --scalar-background-2: #2a2a2a;\n --scalar-background-3: #505053;\n --scalar-background-4: rgba(255, 255, 255, 0.06);\n --scalar-background-accent: #e360021f;\n\n --scalar-border-color: rgba(255, 255, 255, 0.1);\n --scalar-scrollbar-color: rgba(255, 255, 255, 0.24);\n --scalar-scrollbar-color-active: rgba(255, 255, 255, 0.48);\n --scalar-lifted-brightness: 1.45;\n --scalar-backdrop-brightness: 0.5;\n\n --scalar-shadow-1: 0 1px 3px 0 rgb(0, 0, 0, 0.1);\n --scalar-shadow-2: rgba(15, 15, 15, 0.2) 0px 3px 6px,\n rgba(15, 15, 15, 0.4) 0px 9px 24px, 0 0 0 1px rgba(255, 255, 255, 0.1);\n\n --scalar-button-1: #f6f6f6;\n --scalar-button-1-color: #000;\n --scalar-button-1-hover: #e7e7e7;\n\n --scalar-color-green: #3dd68c;\n --scalar-color-red: #f66f81;\n --scalar-color-yellow: #f9b44e;\n --scalar-color-blue: #5c73e7;\n --scalar-color-orange: #ff8d4d;\n --scalar-color-purple: #b191f9;\n}\n/* Sidebar */\n.light-mode .t-doc__sidebar {\n --scalar-sidebar-background-1: var(--scalar-background-1);\n --scalar-sidebar-item-hover-color: currentColor;\n --scalar-sidebar-item-hover-background: var(--scalar-background-2);\n --scalar-sidebar-item-active-background: var(--scalar-background-accent);\n --scalar-sidebar-border-color: var(--scalar-border-color);\n --scalar-sidebar-color-1: var(--scalar-color-1);\n --scalar-sidebar-color-2: var(--scalar-color-2);\n --scalar-sidebar-color-active: var(--scalar-color-accent);\n --scalar-sidebar-search-background: var(--scalar-background-2);\n --scalar-sidebar-search-border-color: var(--scalar-sidebar-border-color);\n --scalar-sidebar-search-color: var(--scalar-color-3);\n}\n\n.dark-mode .sidebar {\n --scalar-sidebar-background-1: #161618;\n --scalar-sidebar-item-hover-color: var(--scalar-color-accent);\n --scalar-sidebar-item-hover-background: transparent;\n --scalar-sidebar-item-active-background: transparent;\n --scalar-sidebar-border-color: transparent;\n --scalar-sidebar-color-1: var(--scalar-color-1);\n --scalar-sidebar-color-2: var(--scalar-color-2);\n --scalar-sidebar-color-active: var(--scalar-color-accent);\n --scalar-sidebar-search-background: #252529;\n --scalar-sidebar-search-border-color: transparent;\n --scalar-sidebar-search-color: var(--scalar-color-3);\n}\n";
|
|
11
|
+
/**
|
|
12
|
+
* The HTML to load the @scalar/api-reference JavaScript package.
|
|
13
|
+
*/
|
|
14
|
+
export declare const javascript: (configuration: ApiReferenceOptions) => import("hono/utils/html").HtmlEscapedString | Promise<import("hono/utils/html").HtmlEscapedString>;
|
|
15
|
+
/**
|
|
16
|
+
* The middleware for the API Reference.
|
|
17
|
+
*/
|
|
18
|
+
export declare const apiReference: <E extends Env>(options: ApiReferenceOptions) => MiddlewareHandler<E>;
|
|
19
|
+
//# sourceMappingURL=honoApiReference.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"honoApiReference.d.ts","sourceRoot":"","sources":["../src/honoApiReference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,GAAG,EAAE,iBAAiB,EAAE,MAAM,MAAM,CAAA;AAGlD,MAAM,MAAM,mBAAmB,GAAG,sBAAsB,GAAG;IACzD,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,mtHAoG1B,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,UAAU,kBAAmB,mBAAmB,uGAmB5D,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,YAAY,GACtB,CAAC,SAAS,GAAG,WAAW,mBAAmB,KAAG,iBAAiB,CAAC,CAAC,CAoBjE,CAAA"}
|
|
@@ -1,34 +1,9 @@
|
|
|
1
|
-
|
|
2
|
-
var __defProp = Object.defineProperty;
|
|
3
|
-
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
-
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
-
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
-
var __export = (target, all) => {
|
|
7
|
-
for (var name in all)
|
|
8
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
-
};
|
|
10
|
-
var __copyProps = (to, from, except, desc) => {
|
|
11
|
-
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
-
for (let key of __getOwnPropNames(from))
|
|
13
|
-
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
-
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
-
}
|
|
16
|
-
return to;
|
|
17
|
-
};
|
|
18
|
-
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
1
|
+
import { html, raw } from 'hono/html';
|
|
19
2
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
customThemeCSS: () => customThemeCSS,
|
|
25
|
-
javascript: () => javascript
|
|
26
|
-
});
|
|
27
|
-
module.exports = __toCommonJS(src_exports);
|
|
28
|
-
|
|
29
|
-
// src/honoApiReference.ts
|
|
30
|
-
var import_html = require("hono/html");
|
|
31
|
-
var customThemeCSS = `
|
|
3
|
+
/**
|
|
4
|
+
* The custom theme CSS for the API Reference.
|
|
5
|
+
*/
|
|
6
|
+
const customThemeCSS = `
|
|
32
7
|
.light-mode {
|
|
33
8
|
color-scheme: light;
|
|
34
9
|
--scalar-color-1: #2a2f45;
|
|
@@ -129,27 +104,36 @@ var customThemeCSS = `
|
|
|
129
104
|
--scalar-sidebar-search-color: var(--scalar-color-3);
|
|
130
105
|
}
|
|
131
106
|
`;
|
|
132
|
-
|
|
133
|
-
|
|
107
|
+
/**
|
|
108
|
+
* The HTML to load the @scalar/api-reference JavaScript package.
|
|
109
|
+
*/
|
|
110
|
+
const javascript = (configuration) => {
|
|
111
|
+
return html `
|
|
134
112
|
<script
|
|
135
113
|
id="api-reference"
|
|
136
114
|
type="application/json"
|
|
137
|
-
data-configuration="${JSON.stringify(configuration)
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
115
|
+
data-configuration="${JSON.stringify(configuration)
|
|
116
|
+
.split('"')
|
|
117
|
+
.join('"')}">
|
|
118
|
+
${raw(configuration.spec?.content
|
|
119
|
+
? typeof configuration.spec?.content === 'function'
|
|
120
|
+
? JSON.stringify(configuration.spec?.content())
|
|
121
|
+
: JSON.stringify(configuration.spec?.content)
|
|
122
|
+
: '')}
|
|
141
123
|
</script>
|
|
142
|
-
<script src="${configuration.cdn ||
|
|
124
|
+
<script src="${configuration.cdn ||
|
|
125
|
+
'https://cdn.jsdelivr.net/npm/@scalar/api-reference'}"></script>
|
|
143
126
|
`;
|
|
144
127
|
};
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
128
|
+
/**
|
|
129
|
+
* The middleware for the API Reference.
|
|
130
|
+
*/
|
|
131
|
+
const apiReference = (options) => async (c) => {
|
|
132
|
+
return c.html(/* html */ `
|
|
149
133
|
<!DOCTYPE html>
|
|
150
134
|
<html>
|
|
151
135
|
<head>
|
|
152
|
-
<title>${options?.pageTitle ??
|
|
136
|
+
<title>${options?.pageTitle ?? 'API Reference'}</title>
|
|
153
137
|
<meta charset="utf-8" />
|
|
154
138
|
<meta
|
|
155
139
|
name="viewport"
|
|
@@ -162,12 +146,7 @@ var apiReference = (options) => async (c) => {
|
|
|
162
146
|
${javascript(options)}
|
|
163
147
|
</body>
|
|
164
148
|
</html>
|
|
165
|
-
`
|
|
166
|
-
);
|
|
149
|
+
`);
|
|
167
150
|
};
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
apiReference,
|
|
171
|
-
customThemeCSS,
|
|
172
|
-
javascript
|
|
173
|
-
});
|
|
151
|
+
|
|
152
|
+
export { apiReference, customThemeCSS, javascript };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"honoApiReference.test.d.ts","sourceRoot":"","sources":["../src/honoApiReference.test.ts"],"names":[],"mappings":""}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,22 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
import { Env, MiddlewareHandler } from 'hono';
|
|
4
|
-
|
|
5
|
-
type ApiReferenceOptions = ReferenceConfiguration & {
|
|
6
|
-
pageTitle?: string;
|
|
7
|
-
cdn?: string;
|
|
8
|
-
};
|
|
9
|
-
/**
|
|
10
|
-
* The custom theme CSS for the API Reference.
|
|
11
|
-
*/
|
|
12
|
-
declare const customThemeCSS = "\n.light-mode {\n color-scheme: light;\n --scalar-color-1: #2a2f45;\n --scalar-color-2: #757575;\n --scalar-color-3: #8e8e8e;\n --scalar-color-disabled: #b4b1b1;\n --scalar-color-ghost: #a7a7a7;\n --scalar-color-accent: #0099ff;\n --scalar-background-1: #fff;\n --scalar-background-2: #f6f6f6;\n --scalar-background-3: #e7e7e7;\n --scalar-background-4: rgba(0, 0, 0, 0.06);\n --scalar-background-accent: #8ab4f81f;\n\n --scalar-border-color: rgba(0, 0, 0, 0.1);\n --scalar-scrollbar-color: rgba(0, 0, 0, 0.18);\n --scalar-scrollbar-color-active: rgba(0, 0, 0, 0.36);\n --scalar-lifted-brightness: 1;\n --scalar-backdrop-brightness: 1;\n\n --scalar-shadow-1: 0 1px 3px 0 rgba(0, 0, 0, 0.11);\n --scalar-shadow-2: rgba(0, 0, 0, 0.08) 0px 13px 20px 0px,\n rgba(0, 0, 0, 0.08) 0px 3px 8px 0px, #eeeeed 0px 0 0 1px;\n\n --scalar-button-1: rgb(49 53 56);\n --scalar-button-1-color: #fff;\n --scalar-button-1-hover: rgb(28 31 33);\n\n --scalar-color-green: #069061;\n --scalar-color-red: #ef0006;\n --scalar-color-yellow: #edbe20;\n --scalar-color-blue: #0082d0;\n --scalar-color-orange: #fb892c;\n --scalar-color-purple: #5203d1;\n}\n\n.dark-mode {\n color-scheme: dark;\n --scalar-color-1: rgba(255, 255, 245, .86);\n --scalar-color-2: rgba(255, 255, 245, .6);\n --scalar-color-3: rgba(255, 255, 245, .38);\n --scalar-color-disabled: rgba(255, 255, 245, .25);\n --scalar-color-ghost: rgba(255, 255, 245, .25);\n --scalar-color-accent: #e36002;\n --scalar-background-1: #1e1e20;\n --scalar-background-2: #2a2a2a;\n --scalar-background-3: #505053;\n --scalar-background-4: rgba(255, 255, 255, 0.06);\n --scalar-background-accent: #e360021f;\n\n --scalar-border-color: rgba(255, 255, 255, 0.1);\n --scalar-scrollbar-color: rgba(255, 255, 255, 0.24);\n --scalar-scrollbar-color-active: rgba(255, 255, 255, 0.48);\n --scalar-lifted-brightness: 1.45;\n --scalar-backdrop-brightness: 0.5;\n\n --scalar-shadow-1: 0 1px 3px 0 rgb(0, 0, 0, 0.1);\n --scalar-shadow-2: rgba(15, 15, 15, 0.2) 0px 3px 6px,\n rgba(15, 15, 15, 0.4) 0px 9px 24px, 0 0 0 1px rgba(255, 255, 255, 0.1);\n\n --scalar-button-1: #f6f6f6;\n --scalar-button-1-color: #000;\n --scalar-button-1-hover: #e7e7e7;\n\n --scalar-color-green: #3dd68c;\n --scalar-color-red: #f66f81;\n --scalar-color-yellow: #f9b44e;\n --scalar-color-blue: #5c73e7;\n --scalar-color-orange: #ff8d4d;\n --scalar-color-purple: #b191f9;\n}\n/* Sidebar */\n.light-mode .t-doc__sidebar {\n --scalar-sidebar-background-1: var(--scalar-background-1);\n --scalar-sidebar-item-hover-color: currentColor;\n --scalar-sidebar-item-hover-background: var(--scalar-background-2);\n --scalar-sidebar-item-active-background: var(--scalar-background-accent);\n --scalar-sidebar-border-color: var(--scalar-border-color);\n --scalar-sidebar-color-1: var(--scalar-color-1);\n --scalar-sidebar-color-2: var(--scalar-color-2);\n --scalar-sidebar-color-active: var(--scalar-color-accent);\n --scalar-sidebar-search-background: var(--scalar-background-2);\n --scalar-sidebar-search-border-color: var(--scalar-sidebar-border-color);\n --scalar-sidebar-search-color: var(--scalar-color-3);\n}\n\n.dark-mode .sidebar {\n --scalar-sidebar-background-1: #161618;\n --scalar-sidebar-item-hover-color: var(--scalar-color-accent);\n --scalar-sidebar-item-hover-background: transparent;\n --scalar-sidebar-item-active-background: transparent;\n --scalar-sidebar-border-color: transparent;\n --scalar-sidebar-color-1: var(--scalar-color-1);\n --scalar-sidebar-color-2: var(--scalar-color-2);\n --scalar-sidebar-color-active: var(--scalar-color-accent);\n --scalar-sidebar-search-background: #252529;\n --scalar-sidebar-search-border-color: transparent;\n --scalar-sidebar-search-color: var(--scalar-color-3);\n}\n";
|
|
13
|
-
/**
|
|
14
|
-
* The HTML to load the @scalar/api-reference JavaScript package.
|
|
15
|
-
*/
|
|
16
|
-
declare const javascript: (configuration: ApiReferenceOptions) => hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
|
|
17
|
-
/**
|
|
18
|
-
* The middleware for the API Reference.
|
|
19
|
-
*/
|
|
20
|
-
declare const apiReference: <E extends Env>(options: ApiReferenceOptions) => MiddlewareHandler<E>;
|
|
21
|
-
|
|
22
|
-
export { type ApiReferenceOptions, apiReference, customThemeCSS, javascript };
|
|
1
|
+
export * from './honoApiReference.js';
|
|
2
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAA"}
|
package/dist/index.js
CHANGED
|
@@ -1,144 +1 @@
|
|
|
1
|
-
|
|
2
|
-
import { html, raw } from "hono/html";
|
|
3
|
-
var customThemeCSS = `
|
|
4
|
-
.light-mode {
|
|
5
|
-
color-scheme: light;
|
|
6
|
-
--scalar-color-1: #2a2f45;
|
|
7
|
-
--scalar-color-2: #757575;
|
|
8
|
-
--scalar-color-3: #8e8e8e;
|
|
9
|
-
--scalar-color-disabled: #b4b1b1;
|
|
10
|
-
--scalar-color-ghost: #a7a7a7;
|
|
11
|
-
--scalar-color-accent: #0099ff;
|
|
12
|
-
--scalar-background-1: #fff;
|
|
13
|
-
--scalar-background-2: #f6f6f6;
|
|
14
|
-
--scalar-background-3: #e7e7e7;
|
|
15
|
-
--scalar-background-4: rgba(0, 0, 0, 0.06);
|
|
16
|
-
--scalar-background-accent: #8ab4f81f;
|
|
17
|
-
|
|
18
|
-
--scalar-border-color: rgba(0, 0, 0, 0.1);
|
|
19
|
-
--scalar-scrollbar-color: rgba(0, 0, 0, 0.18);
|
|
20
|
-
--scalar-scrollbar-color-active: rgba(0, 0, 0, 0.36);
|
|
21
|
-
--scalar-lifted-brightness: 1;
|
|
22
|
-
--scalar-backdrop-brightness: 1;
|
|
23
|
-
|
|
24
|
-
--scalar-shadow-1: 0 1px 3px 0 rgba(0, 0, 0, 0.11);
|
|
25
|
-
--scalar-shadow-2: rgba(0, 0, 0, 0.08) 0px 13px 20px 0px,
|
|
26
|
-
rgba(0, 0, 0, 0.08) 0px 3px 8px 0px, #eeeeed 0px 0 0 1px;
|
|
27
|
-
|
|
28
|
-
--scalar-button-1: rgb(49 53 56);
|
|
29
|
-
--scalar-button-1-color: #fff;
|
|
30
|
-
--scalar-button-1-hover: rgb(28 31 33);
|
|
31
|
-
|
|
32
|
-
--scalar-color-green: #069061;
|
|
33
|
-
--scalar-color-red: #ef0006;
|
|
34
|
-
--scalar-color-yellow: #edbe20;
|
|
35
|
-
--scalar-color-blue: #0082d0;
|
|
36
|
-
--scalar-color-orange: #fb892c;
|
|
37
|
-
--scalar-color-purple: #5203d1;
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
.dark-mode {
|
|
41
|
-
color-scheme: dark;
|
|
42
|
-
--scalar-color-1: rgba(255, 255, 245, .86);
|
|
43
|
-
--scalar-color-2: rgba(255, 255, 245, .6);
|
|
44
|
-
--scalar-color-3: rgba(255, 255, 245, .38);
|
|
45
|
-
--scalar-color-disabled: rgba(255, 255, 245, .25);
|
|
46
|
-
--scalar-color-ghost: rgba(255, 255, 245, .25);
|
|
47
|
-
--scalar-color-accent: #e36002;
|
|
48
|
-
--scalar-background-1: #1e1e20;
|
|
49
|
-
--scalar-background-2: #2a2a2a;
|
|
50
|
-
--scalar-background-3: #505053;
|
|
51
|
-
--scalar-background-4: rgba(255, 255, 255, 0.06);
|
|
52
|
-
--scalar-background-accent: #e360021f;
|
|
53
|
-
|
|
54
|
-
--scalar-border-color: rgba(255, 255, 255, 0.1);
|
|
55
|
-
--scalar-scrollbar-color: rgba(255, 255, 255, 0.24);
|
|
56
|
-
--scalar-scrollbar-color-active: rgba(255, 255, 255, 0.48);
|
|
57
|
-
--scalar-lifted-brightness: 1.45;
|
|
58
|
-
--scalar-backdrop-brightness: 0.5;
|
|
59
|
-
|
|
60
|
-
--scalar-shadow-1: 0 1px 3px 0 rgb(0, 0, 0, 0.1);
|
|
61
|
-
--scalar-shadow-2: rgba(15, 15, 15, 0.2) 0px 3px 6px,
|
|
62
|
-
rgba(15, 15, 15, 0.4) 0px 9px 24px, 0 0 0 1px rgba(255, 255, 255, 0.1);
|
|
63
|
-
|
|
64
|
-
--scalar-button-1: #f6f6f6;
|
|
65
|
-
--scalar-button-1-color: #000;
|
|
66
|
-
--scalar-button-1-hover: #e7e7e7;
|
|
67
|
-
|
|
68
|
-
--scalar-color-green: #3dd68c;
|
|
69
|
-
--scalar-color-red: #f66f81;
|
|
70
|
-
--scalar-color-yellow: #f9b44e;
|
|
71
|
-
--scalar-color-blue: #5c73e7;
|
|
72
|
-
--scalar-color-orange: #ff8d4d;
|
|
73
|
-
--scalar-color-purple: #b191f9;
|
|
74
|
-
}
|
|
75
|
-
/* Sidebar */
|
|
76
|
-
.light-mode .t-doc__sidebar {
|
|
77
|
-
--scalar-sidebar-background-1: var(--scalar-background-1);
|
|
78
|
-
--scalar-sidebar-item-hover-color: currentColor;
|
|
79
|
-
--scalar-sidebar-item-hover-background: var(--scalar-background-2);
|
|
80
|
-
--scalar-sidebar-item-active-background: var(--scalar-background-accent);
|
|
81
|
-
--scalar-sidebar-border-color: var(--scalar-border-color);
|
|
82
|
-
--scalar-sidebar-color-1: var(--scalar-color-1);
|
|
83
|
-
--scalar-sidebar-color-2: var(--scalar-color-2);
|
|
84
|
-
--scalar-sidebar-color-active: var(--scalar-color-accent);
|
|
85
|
-
--scalar-sidebar-search-background: var(--scalar-background-2);
|
|
86
|
-
--scalar-sidebar-search-border-color: var(--scalar-sidebar-border-color);
|
|
87
|
-
--scalar-sidebar-search-color: var(--scalar-color-3);
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
.dark-mode .sidebar {
|
|
91
|
-
--scalar-sidebar-background-1: #161618;
|
|
92
|
-
--scalar-sidebar-item-hover-color: var(--scalar-color-accent);
|
|
93
|
-
--scalar-sidebar-item-hover-background: transparent;
|
|
94
|
-
--scalar-sidebar-item-active-background: transparent;
|
|
95
|
-
--scalar-sidebar-border-color: transparent;
|
|
96
|
-
--scalar-sidebar-color-1: var(--scalar-color-1);
|
|
97
|
-
--scalar-sidebar-color-2: var(--scalar-color-2);
|
|
98
|
-
--scalar-sidebar-color-active: var(--scalar-color-accent);
|
|
99
|
-
--scalar-sidebar-search-background: #252529;
|
|
100
|
-
--scalar-sidebar-search-border-color: transparent;
|
|
101
|
-
--scalar-sidebar-search-color: var(--scalar-color-3);
|
|
102
|
-
}
|
|
103
|
-
`;
|
|
104
|
-
var javascript = (configuration) => {
|
|
105
|
-
return html`
|
|
106
|
-
<script
|
|
107
|
-
id="api-reference"
|
|
108
|
-
type="application/json"
|
|
109
|
-
data-configuration="${JSON.stringify(configuration).split('"').join(""")}">
|
|
110
|
-
${raw(
|
|
111
|
-
configuration.spec?.content ? typeof configuration.spec?.content === "function" ? JSON.stringify(configuration.spec?.content()) : JSON.stringify(configuration.spec?.content) : ""
|
|
112
|
-
)}
|
|
113
|
-
</script>
|
|
114
|
-
<script src="${configuration.cdn || "https://cdn.jsdelivr.net/npm/@scalar/api-reference"}"></script>
|
|
115
|
-
`;
|
|
116
|
-
};
|
|
117
|
-
var apiReference = (options) => async (c) => {
|
|
118
|
-
return c.html(
|
|
119
|
-
/* html */
|
|
120
|
-
`
|
|
121
|
-
<!DOCTYPE html>
|
|
122
|
-
<html>
|
|
123
|
-
<head>
|
|
124
|
-
<title>${options?.pageTitle ?? "API Reference"}</title>
|
|
125
|
-
<meta charset="utf-8" />
|
|
126
|
-
<meta
|
|
127
|
-
name="viewport"
|
|
128
|
-
content="width=device-width, initial-scale=1" />
|
|
129
|
-
<style>
|
|
130
|
-
${options.theme ? null : customThemeCSS}
|
|
131
|
-
</style>
|
|
132
|
-
</head>
|
|
133
|
-
<body>
|
|
134
|
-
${javascript(options)}
|
|
135
|
-
</body>
|
|
136
|
-
</html>
|
|
137
|
-
`
|
|
138
|
-
);
|
|
139
|
-
};
|
|
140
|
-
export {
|
|
141
|
-
apiReference,
|
|
142
|
-
customThemeCSS,
|
|
143
|
-
javascript
|
|
144
|
-
};
|
|
1
|
+
export { apiReference, customThemeCSS, javascript } from './honoApiReference.js';
|
package/package.json
CHANGED
|
@@ -10,23 +10,17 @@
|
|
|
10
10
|
"url": "https://github.com/scalar/scalar.git",
|
|
11
11
|
"directory": "packages/hono-api-reference"
|
|
12
12
|
},
|
|
13
|
-
"version": "0.5.
|
|
13
|
+
"version": "0.5.110",
|
|
14
14
|
"engines": {
|
|
15
15
|
"node": ">=18"
|
|
16
16
|
},
|
|
17
17
|
"type": "module",
|
|
18
|
-
"main": "dist/index.
|
|
19
|
-
"types": "dist/index.d.
|
|
18
|
+
"main": "dist/index.js",
|
|
19
|
+
"types": "dist/index.d.ts",
|
|
20
20
|
"exports": {
|
|
21
21
|
".": {
|
|
22
|
-
"import":
|
|
23
|
-
|
|
24
|
-
"default": "./dist/index.js"
|
|
25
|
-
},
|
|
26
|
-
"require": {
|
|
27
|
-
"types": "./dist/index.d.cts",
|
|
28
|
-
"default": "./dist/index.cjs"
|
|
29
|
-
}
|
|
22
|
+
"import": "./dist/index.js",
|
|
23
|
+
"types": "./dist/index.d.ts"
|
|
30
24
|
}
|
|
31
25
|
},
|
|
32
26
|
"files": [
|
|
@@ -35,16 +29,25 @@
|
|
|
35
29
|
"module": "dist/index.js",
|
|
36
30
|
"dependencies": {
|
|
37
31
|
"hono": "^4.2.7",
|
|
38
|
-
"@scalar/api-reference": "1.24.
|
|
32
|
+
"@scalar/api-reference": "1.24.49"
|
|
39
33
|
},
|
|
40
34
|
"devDependencies": {
|
|
35
|
+
"@hono/node-server": "^1.11.0",
|
|
36
|
+
"@hono/zod-openapi": "^0.8.6",
|
|
41
37
|
"hono": "^4.2.7",
|
|
42
38
|
"tsup": "^7.2.0",
|
|
43
39
|
"vite": "^5.2.10",
|
|
44
|
-
"
|
|
40
|
+
"vite-node": "^1.3.1",
|
|
41
|
+
"vitest": "^1.6.0",
|
|
42
|
+
"@scalar/build-tooling": "0.1.9"
|
|
45
43
|
},
|
|
46
44
|
"scripts": {
|
|
47
|
-
"build": "
|
|
48
|
-
"
|
|
45
|
+
"build": "scalar-build-rollup",
|
|
46
|
+
"dev": "nodemon --exec \"vite-node playground/index.ts\" --ext ts --quiet --watch ./",
|
|
47
|
+
"docker:build": "docker buildx build --platform=linux/amd64 -t scalar-hono-reference --build-arg=\"BASE_IMAGE=scalar-base\" .",
|
|
48
|
+
"docker:run": "docker run -t scalar-hono-reference",
|
|
49
|
+
"test": "vitest",
|
|
50
|
+
"types:build": "scalar-types-build",
|
|
51
|
+
"types:check": "scalar-types-check"
|
|
49
52
|
}
|
|
50
53
|
}
|
package/dist/index.d.cts
DELETED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
import * as hono_utils_html from 'hono/utils/html';
|
|
2
|
-
import { ReferenceConfiguration } from '@scalar/api-reference';
|
|
3
|
-
import { Env, MiddlewareHandler } from 'hono';
|
|
4
|
-
|
|
5
|
-
type ApiReferenceOptions = ReferenceConfiguration & {
|
|
6
|
-
pageTitle?: string;
|
|
7
|
-
cdn?: string;
|
|
8
|
-
};
|
|
9
|
-
/**
|
|
10
|
-
* The custom theme CSS for the API Reference.
|
|
11
|
-
*/
|
|
12
|
-
declare const customThemeCSS = "\n.light-mode {\n color-scheme: light;\n --scalar-color-1: #2a2f45;\n --scalar-color-2: #757575;\n --scalar-color-3: #8e8e8e;\n --scalar-color-disabled: #b4b1b1;\n --scalar-color-ghost: #a7a7a7;\n --scalar-color-accent: #0099ff;\n --scalar-background-1: #fff;\n --scalar-background-2: #f6f6f6;\n --scalar-background-3: #e7e7e7;\n --scalar-background-4: rgba(0, 0, 0, 0.06);\n --scalar-background-accent: #8ab4f81f;\n\n --scalar-border-color: rgba(0, 0, 0, 0.1);\n --scalar-scrollbar-color: rgba(0, 0, 0, 0.18);\n --scalar-scrollbar-color-active: rgba(0, 0, 0, 0.36);\n --scalar-lifted-brightness: 1;\n --scalar-backdrop-brightness: 1;\n\n --scalar-shadow-1: 0 1px 3px 0 rgba(0, 0, 0, 0.11);\n --scalar-shadow-2: rgba(0, 0, 0, 0.08) 0px 13px 20px 0px,\n rgba(0, 0, 0, 0.08) 0px 3px 8px 0px, #eeeeed 0px 0 0 1px;\n\n --scalar-button-1: rgb(49 53 56);\n --scalar-button-1-color: #fff;\n --scalar-button-1-hover: rgb(28 31 33);\n\n --scalar-color-green: #069061;\n --scalar-color-red: #ef0006;\n --scalar-color-yellow: #edbe20;\n --scalar-color-blue: #0082d0;\n --scalar-color-orange: #fb892c;\n --scalar-color-purple: #5203d1;\n}\n\n.dark-mode {\n color-scheme: dark;\n --scalar-color-1: rgba(255, 255, 245, .86);\n --scalar-color-2: rgba(255, 255, 245, .6);\n --scalar-color-3: rgba(255, 255, 245, .38);\n --scalar-color-disabled: rgba(255, 255, 245, .25);\n --scalar-color-ghost: rgba(255, 255, 245, .25);\n --scalar-color-accent: #e36002;\n --scalar-background-1: #1e1e20;\n --scalar-background-2: #2a2a2a;\n --scalar-background-3: #505053;\n --scalar-background-4: rgba(255, 255, 255, 0.06);\n --scalar-background-accent: #e360021f;\n\n --scalar-border-color: rgba(255, 255, 255, 0.1);\n --scalar-scrollbar-color: rgba(255, 255, 255, 0.24);\n --scalar-scrollbar-color-active: rgba(255, 255, 255, 0.48);\n --scalar-lifted-brightness: 1.45;\n --scalar-backdrop-brightness: 0.5;\n\n --scalar-shadow-1: 0 1px 3px 0 rgb(0, 0, 0, 0.1);\n --scalar-shadow-2: rgba(15, 15, 15, 0.2) 0px 3px 6px,\n rgba(15, 15, 15, 0.4) 0px 9px 24px, 0 0 0 1px rgba(255, 255, 255, 0.1);\n\n --scalar-button-1: #f6f6f6;\n --scalar-button-1-color: #000;\n --scalar-button-1-hover: #e7e7e7;\n\n --scalar-color-green: #3dd68c;\n --scalar-color-red: #f66f81;\n --scalar-color-yellow: #f9b44e;\n --scalar-color-blue: #5c73e7;\n --scalar-color-orange: #ff8d4d;\n --scalar-color-purple: #b191f9;\n}\n/* Sidebar */\n.light-mode .t-doc__sidebar {\n --scalar-sidebar-background-1: var(--scalar-background-1);\n --scalar-sidebar-item-hover-color: currentColor;\n --scalar-sidebar-item-hover-background: var(--scalar-background-2);\n --scalar-sidebar-item-active-background: var(--scalar-background-accent);\n --scalar-sidebar-border-color: var(--scalar-border-color);\n --scalar-sidebar-color-1: var(--scalar-color-1);\n --scalar-sidebar-color-2: var(--scalar-color-2);\n --scalar-sidebar-color-active: var(--scalar-color-accent);\n --scalar-sidebar-search-background: var(--scalar-background-2);\n --scalar-sidebar-search-border-color: var(--scalar-sidebar-border-color);\n --scalar-sidebar-search-color: var(--scalar-color-3);\n}\n\n.dark-mode .sidebar {\n --scalar-sidebar-background-1: #161618;\n --scalar-sidebar-item-hover-color: var(--scalar-color-accent);\n --scalar-sidebar-item-hover-background: transparent;\n --scalar-sidebar-item-active-background: transparent;\n --scalar-sidebar-border-color: transparent;\n --scalar-sidebar-color-1: var(--scalar-color-1);\n --scalar-sidebar-color-2: var(--scalar-color-2);\n --scalar-sidebar-color-active: var(--scalar-color-accent);\n --scalar-sidebar-search-background: #252529;\n --scalar-sidebar-search-border-color: transparent;\n --scalar-sidebar-search-color: var(--scalar-color-3);\n}\n";
|
|
13
|
-
/**
|
|
14
|
-
* The HTML to load the @scalar/api-reference JavaScript package.
|
|
15
|
-
*/
|
|
16
|
-
declare const javascript: (configuration: ApiReferenceOptions) => hono_utils_html.HtmlEscapedString | Promise<hono_utils_html.HtmlEscapedString>;
|
|
17
|
-
/**
|
|
18
|
-
* The middleware for the API Reference.
|
|
19
|
-
*/
|
|
20
|
-
declare const apiReference: <E extends Env>(options: ApiReferenceOptions) => MiddlewareHandler<E>;
|
|
21
|
-
|
|
22
|
-
export { type ApiReferenceOptions, apiReference, customThemeCSS, javascript };
|