@scalar/fastify-api-reference 1.13.2 → 1.13.6
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/CHANGELOG.md +16 -0
- package/dist/fastifyApiReference.d.ts +2 -2
- package/dist/fastifyApiReference.d.ts.map +1 -1
- package/dist/index.cjs +1 -1
- package/dist/index.js +2 -4
- package/dist/js/standalone.js +7 -7
- package/package.json +4 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
# @scalar/fastify-api-reference
|
|
2
2
|
|
|
3
|
+
## 1.13.6
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 2003819a: fix: actually update fastify-html
|
|
8
|
+
|
|
9
|
+
## 1.13.5
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- 5ca138ee: - Removed activeBreadCrumb from api-client as its available in the slot
|
|
14
|
+
- Centralized navigation logic
|
|
15
|
+
- use proper anchor navigation instead of scrollIntoView, it will also be saved to history
|
|
16
|
+
- scrolling down will open the next section
|
|
17
|
+
- dda5162c: chore: update fastify-html
|
|
18
|
+
|
|
3
19
|
## 1.13.2
|
|
4
20
|
|
|
5
21
|
### Patch Changes
|
|
@@ -21,6 +21,6 @@ export declare const javascript: (options: FastifyApiReferenceOptions) => string
|
|
|
21
21
|
* The HTML template to render the API Reference.
|
|
22
22
|
*/
|
|
23
23
|
export declare function htmlDocument(options: FastifyApiReferenceOptions): string;
|
|
24
|
-
declare const
|
|
25
|
-
export default
|
|
24
|
+
declare const fastifyApiReference: FastifyPluginAsync<FastifyApiReferenceOptions>;
|
|
25
|
+
export default fastifyApiReference;
|
|
26
26
|
//# sourceMappingURL=fastifyApiReference.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fastifyApiReference.d.ts","sourceRoot":"","sources":["../src/fastifyApiReference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;
|
|
1
|
+
{"version":3,"file":"fastifyApiReference.d.ts","sourceRoot":"","sources":["../src/fastifyApiReference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAA;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAIjD,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,sBAAsB,CAAA;CACvC,CAAA;AAcD;;GAEG;AACH,eAAO,MAAM,UAAU,i8EA+EtB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,UAAU,YAAa,0BAA0B,WAkB7D,CAAA;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,0BAA0B,UAqB/D;AAED,QAAA,MAAM,mBAAmB,EAAE,kBAAkB,CAC3C,0BAA0B,CAkF3B,CAAA;AAED,eAAe,mBAAmB,CAAA"}
|
package/dist/index.cjs
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
"use strict";Object.create,Object.defineProperty,Object.getOwnPropertyDescriptor,Object.getOwnPropertyNames,Object.getPrototypeOf,Object.prototype.hasOwnProperty;const e=require("
|
|
1
|
+
"use strict";Object.create,Object.defineProperty,Object.getOwnPropertyDescriptor,Object.getOwnPropertyNames,Object.getPrototypeOf,Object.prototype.hasOwnProperty;const e=require("node:fs"),n=require("node:path");const t={hide:!0},o=e=>`${e??""}/@scalar/fastify-api-reference/js/browser.js`.replace(/\/\//g,"/");function r(e){return`\n<!DOCTYPE html>\n<html>\n <head>\n <title>API Reference</title>\n <meta charset="utf-8" />\n <meta\n name="viewport"\n content="width=device-width, initial-scale=1" />\n <style>\n body {\n margin: 0;\n }\n </style>\n </head>\n <body>\n ${(e=>{var n,t,r,c;const{configuration:a}=e;return`\n <script\n id="api-reference"\n type="application/json"\n data-configuration="${JSON.stringify(a??{}).split('"').join(""")}">${(null==(n=null==a?void 0:a.spec)?void 0:n.content)?"function"==typeof(null==(t=null==a?void 0:a.spec)?void 0:t.content)?JSON.stringify(null==(r=null==a?void 0:a.spec)?void 0:r.content()):JSON.stringify(null==(c=null==a?void 0:a.spec)?void 0:c.content):""}<\/script>\n <script src="${o(e.routePrefix)}"><\/script>\n `})(e)}\n </body>\n</html>\n`}module.exports=async(c,a)=>{var l,s;let{configuration:i}=a;const h=c.hasPlugin("@fastify/swagger");if(c.hasPlugin("fastify-html")||await c.register(import("fastify-html")),!(null==(l=null==i?void 0:i.spec)?void 0:l.content)&&!(null==(s=null==i?void 0:i.spec)?void 0:s.url)&&!h)return void c.log.warn("[@scalar/fastify-api-reference] You didn’t provide a spec.content or spec.url and @fastify/swagger could not be find either. Please provide one of these options.");const d=function(){const t=[n.resolve(`${__dirname}/js/standalone.js`),n.resolve(`${__dirname}/../../dist/js/standalone.js`)].find((n=>e.existsSync(n)));if(void 0===t)throw new Error(`JavaScript file not found: ${n.resolve(`${__dirname}/js/standalone.js`)}`);return e.readFileSync(t,"utf8")}();c.route({method:"GET",url:a.routePrefix??"/",schema:t,async handler(e,n){var t,o;return n.header("Content-Type","text/html; charset=utf-8"),(null==(t=null==i?void 0:i.spec)?void 0:t.content)||(null==(o=null==i?void 0:i.spec)?void 0:o.url)||!h||(i={...i,spec:{content:()=>c.swagger()}}),(null==i?void 0:i.customCss)||(null==i?void 0:i.theme)||(i={...i,customCss:"\n:root {\n --theme-font: 'Inter', var(--system-fonts);\n}\n\n.light-mode {\n color-scheme: light;\n --theme-color-1: #1c1e21;\n --theme-color-2: #757575;\n --theme-color-3: #8e8e8e;\n --theme-color-disabled: #b4b1b1;\n --theme-color-ghost: #a7a7a7;\n --theme-color-accent: #2f8555;\n --theme-background-1: #fff;\n --theme-background-2: #f5f5f5;\n --theme-background-3: #ededed;\n --theme-background-4: rgba(0, 0, 0, 0.06);\n --theme-background-accent: #2f85551f;\n\n --theme-border-color: rgba(0, 0, 0, 0.1);\n --theme-scrollbar-color: rgba(0, 0, 0, 0.18);\n --theme-scrollbar-color-active: rgba(0, 0, 0, 0.36);\n --theme-lifted-brightness: 1;\n --theme-backdrop-brightness: 1;\n\n --theme-shadow-1: 0 1px 3px 0 rgba(0, 0, 0, 0.11);\n --theme-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 --theme-button-1: rgb(49 53 56);\n --theme-button-1-color: #fff;\n --theme-button-1-hover: rgb(28 31 33);\n\n --theme-color-green: #007300;\n --theme-color-red: #af272b;\n --theme-color-yellow: #b38200;\n --theme-color-blue: #3b8ba5;\n --theme-color-orange: #fb892c;\n --theme-color-purple: #5203d1;\n}\n\n.dark-mode {\n color-scheme: dark;\n --theme-color-1: rgba(255, 255, 255, 0.9);\n --theme-color-2: rgba(255, 255, 255, 0.62);\n --theme-color-3: rgba(255, 255, 255, 0.44);\n --theme-color-disabled: rgba(255, 255, 255, 0.34);\n --theme-color-ghost: rgba(255, 255, 255, 0.26);\n --theme-color-accent: #27c2a0;\n --theme-background-1: #1b1b1d;\n --theme-background-2: #242526;\n --theme-background-3: #3b3b3b;\n --theme-background-4: rgba(255, 255, 255, 0.06);\n --theme-background-accent: #27c2a01f;\n\n --theme-border-color: rgba(255, 255, 255, 0.1);\n --theme-scrollbar-color: rgba(255, 255, 255, 0.24);\n --theme-scrollbar-color-active: rgba(255, 255, 255, 0.48);\n --theme-lifted-brightness: 1.45;\n --theme-backdrop-brightness: 0.5;\n\n --theme-shadow-1: 0 1px 3px 0 rgb(0, 0, 0, 0.1);\n --theme-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 --theme-button-1: #f6f6f6;\n --theme-button-1-color: #000;\n --theme-button-1-hover: #e7e7e7;\n\n --theme-color-green: #26b226;\n --theme-color-red: #fb565b;\n --theme-color-yellow: #ffc426;\n --theme-color-blue: #6ecfef;\n --theme-color-orange: #ff8d4d;\n --theme-color-purple: #b191f9;\n}\n.scalar-card:nth-of-type(3) {\n display: none;\n}\n"}),n.html`!${r({...a,configuration:i})}`}}),c.route({method:"GET",url:o(a.routePrefix),schema:t,async handler(e,n){n.header("Content-Type","application/javascript; charset=utf-8"),n.send(d)}})};
|
package/dist/index.js
CHANGED
|
@@ -7,7 +7,6 @@ const __dirname = __getDirname();
|
|
|
7
7
|
const __filename = __getFilename();
|
|
8
8
|
const self = globalThis;
|
|
9
9
|
const require2 = __createRequire(import.meta.url);
|
|
10
|
-
import fp from "fastify-plugin";
|
|
11
10
|
import fs from "node:fs";
|
|
12
11
|
import path from "node:path";
|
|
13
12
|
function getJavaScriptFile() {
|
|
@@ -183,7 +182,7 @@ const fastifyApiReference = async (fastify, options) => {
|
|
|
183
182
|
customCss: defaultCss
|
|
184
183
|
};
|
|
185
184
|
}
|
|
186
|
-
return reply.html
|
|
185
|
+
return reply.html`!${htmlDocument({
|
|
187
186
|
...options,
|
|
188
187
|
configuration
|
|
189
188
|
})}`;
|
|
@@ -201,7 +200,6 @@ const fastifyApiReference = async (fastify, options) => {
|
|
|
201
200
|
}
|
|
202
201
|
});
|
|
203
202
|
};
|
|
204
|
-
const fastifyApiReference$1 = fp(fastifyApiReference);
|
|
205
203
|
export {
|
|
206
|
-
fastifyApiReference
|
|
204
|
+
fastifyApiReference as default
|
|
207
205
|
};
|