@scalar/fastify-api-reference 1.25.18 → 1.25.20

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { default } from './fastifyApiReference';
+export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC/C,cAAc,SAAS,CAAA"}

package/dist/index.js

@@ -14109,33 +14109,39 @@ function t$5(t5) {
     return ((_a2 = e4.$ref) == null ? void 0 : _a2.startsWith("#/definitions/")) && (e4.$ref = e4.$ref.replace(/^#\/definitions\//, "#/components/schemas/")), e4;
   })), t5.paths) {
     for (const e4 in t5.paths) if (Object.hasOwn(t5.paths, e4)) {
-      const s2 = t5.paths[e4];
-      for (const e5 in s2) if (Object.hasOwn(s2, e5)) {
-        const o2 = s2[e5];
-        if (o2.parameters) {
-          const e6 = structuredClone(o2.parameters.find((e7) => "body" === e7.in) ?? {});
+      const o2 = t5.paths[e4];
+      for (const e5 in o2) if (Object.hasOwn(o2, e5)) {
+        const s2 = o2[e5];
+        if (s2.parameters) {
+          const e6 = structuredClone(s2.parameters.find((e7) => "body" === e7.in) ?? {});
           if (e6 && Object.keys(e6).length) {
             delete e6.name, delete e6.in;
-            const s3 = t5.consumes ?? o2.consumes ?? ["application/json"];
-            "object" != typeof o2.requestBody && (o2.requestBody = {}), "object" != typeof o2.requestBody.content && (o2.requestBody.content = {});
+            const o4 = t5.consumes ?? s2.consumes ?? ["application/json"];
+            "object" != typeof s2.requestBody && (s2.requestBody = {}), "object" != typeof s2.requestBody.content && (s2.requestBody.content = {});
             const { schema: n2, ...r3 } = e6;
-            o2.requestBody = { ...o2.requestBody, ...r3 };
-            for (const e7 of s3) o2.requestBody.content[e7] = { schema: n2 };
+            s2.requestBody = { ...s2.requestBody, ...r3 };
+            for (const e7 of o4) s2.requestBody.content[e7] = { schema: n2 };
+          }
+          s2.parameters = s2.parameters.filter((e7) => "body" !== e7.in), delete s2.consumes;
+          const o3 = s2.parameters.filter((e7) => "formData" === e7.in);
+          if (o3.length > 0) {
+            "object" != typeof s2.requestBody && (s2.requestBody = {}), "object" != typeof s2.requestBody.content && (s2.requestBody.content = {}), s2.requestBody.content["application/x-www-form-urlencoded"] = { schema: { type: "object", properties: {}, required: [] } };
+            for (const e7 of o3) s2.requestBody.content["application/x-www-form-urlencoded"].schema.properties[e7.name] = { type: e7.type, description: e7.description }, e7.required && s2.requestBody.content["application/x-www-form-urlencoded"].schema.required.push(e7.name);
+            s2.parameters = s2.parameters.filter((e7) => "formData" !== e7.in);
           }
-          o2.parameters = o2.parameters.filter((e7) => "body" !== e7.in), delete o2.consumes;
         }
-        if (o2.responses) {
-          for (const e6 in o2.responses) if (Object.hasOwn(o2.responses, e6)) {
-            const s3 = o2.responses[e6];
-            if (s3.schema) {
-              const e7 = t5.produces ?? o2.produces ?? ["application/json"];
-              "object" != typeof s3.content && (s3.content = {});
-              for (const t6 of e7) s3.content[t6] = { schema: s3.schema };
-              delete s3.schema;
+        if (s2.responses) {
+          for (const e6 in s2.responses) if (Object.hasOwn(s2.responses, e6)) {
+            const o3 = s2.responses[e6];
+            if (o3.schema) {
+              const e7 = t5.produces ?? s2.produces ?? ["application/json"];
+              "object" != typeof o3.content && (o3.content = {});
+              for (const t6 of e7) o3.content[t6] = { schema: o3.schema };
+              delete o3.schema;
             }
           }
         }
-        delete o2.produces, 0 === ((_c = o2.parameters) == null ? void 0 : _c.length) && delete o2.parameters;
+        delete s2.produces, 0 === ((_c = s2.parameters) == null ? void 0 : _c.length) && delete s2.parameters;
       }
     }
   }
@@ -14246,12 +14252,16 @@ function getJavaScriptFile() {
 const schemaToHideRoute = {
   hide: true
 };
-const getRoutePrefix = (routePrefix) => routePrefix ?? "/reference";
+const getRoutePrefix = (routePrefix) => {
+  const prefix = routePrefix ?? "/reference";
+  return prefix.endsWith("/") ? prefix.slice(0, -1) : prefix;
+};
 const getOpenApiDocumentEndpoints = (openApiDocumentEndpoints) => {
   const { json = "/openapi.json", yaml = "/openapi.yaml" } = openApiDocumentEndpoints ?? {};
   return { json, yaml };
 };
-const getJavaScriptUrl = (routePrefix, publicPath) => `${publicPath ?? ""}${getRoutePrefix(routePrefix)}/@scalar/fastify-api-reference/js/browser.js`.replace(
+const RELATIVE_JAVASCRIPT_PATH = "js/scalar.js";
+const getJavaScriptUrl = (routePrefix) => `${getRoutePrefix(routePrefix)}/${RELATIVE_JAVASCRIPT_PATH}`.replace(
   /\/\//g,
   "/"
 );
@@ -14336,7 +14346,7 @@ const javascript = (options) => {
       id="api-reference"
       type="application/json"
       data-configuration="${JSON.stringify(configuration ?? {}).split('"').join("&quot;")}">${((_a = configuration == null ? void 0 : configuration.spec) == null ? void 0 : _a.content) ? typeof ((_b = configuration == null ? void 0 : configuration.spec) == null ? void 0 : _b.content) === "function" ? JSON.stringify((_c = configuration == null ? void 0 : configuration.spec) == null ? void 0 : _c.content()) : JSON.stringify((_d = configuration == null ? void 0 : configuration.spec) == null ? void 0 : _d.content) : ""}<\/script>
-      <script src="${getJavaScriptUrl(options.routePrefix, options.publicPath)}"><\/script>
+      <script src="${RELATIVE_JAVASCRIPT_PATH}"><\/script>
   `;
 };
 function htmlDocument(options) {
@@ -14437,9 +14447,21 @@ const fastifyApiReference = fp(
         return reply.header("Content-Type", `application/yaml`).header("Content-Disposition", `filename=${filename}.yaml`).send(yaml);
       }
     });
+    if (getRoutePrefix(options.routePrefix)) {
+      fastify.route({
+        method: "GET",
+        url: getRoutePrefix(options.routePrefix),
+        // @ts-ignore We don't know whether @fastify/swagger is loaded.
+        schema: schemaToHideRoute,
+        ...hooks,
+        handler(_, reply) {
+          return reply.redirect(getRoutePrefix(options.routePrefix) + "/", 302);
+        }
+      });
+    }
     fastify.route({
       method: "GET",
-      url: getRoutePrefix(options.routePrefix),
+      url: `${getRoutePrefix(options.routePrefix)}/`,
       // We don’t know whether @fastify/swagger is registered, but it doesn’t hurt to add a schema anyway.
       // @ts-ignore We don’t know whether @fastify/swagger is loaded.
       schema: schemaToHideRoute,

package/dist/js/standalone.js

@@ -5,7 +5,7 @@
  *  ___/ / /___/ ___ |/ /___/ ___ |/ _, _/
  * /____/\____/_/  |_/_____/_/  |_/_/ |_|
  *
- * @scalar/api-reference 1.25.18
+ * @scalar/api-reference 1.25.20
  *
  * Website: https://scalar.com
  * GitHub:  https://github.com/scalar/scalar
@@ -11889,7 +11889,16 @@ const t=structuredClone(o.parameters.find((e=>"body"===e.in))??{})
 "object"!=typeof o.requestBody.content&&(o.requestBody.content={})
 ;const{schema:r,...a}=t;o.requestBody={...o.requestBody,...a}
 ;for(const e of n)o.requestBody.content[e]={schema:r}}
-o.parameters=o.parameters.filter((e=>"body"!==e.in)),delete o.consumes}
+o.parameters=o.parameters.filter((e=>"body"!==e.in)),delete o.consumes
+;const n=o.parameters.filter((e=>"formData"===e.in));if(n.length>0){
+"object"!=typeof o.requestBody&&(o.requestBody={}),
+"object"!=typeof o.requestBody.content&&(o.requestBody.content={}),
+o.requestBody.content["application/x-www-form-urlencoded"]={schema:{
+type:"object",properties:{},required:[]}}
+;for(const e of n)o.requestBody.content["application/x-www-form-urlencoded"].schema.properties[e.name]={
+type:e.type,description:e.description
+},e.required&&o.requestBody.content["application/x-www-form-urlencoded"].schema.required.push(e.name)
+;o.parameters=o.parameters.filter((e=>"formData"!==e.in))}}
 if(o.responses)for(const t in o.responses)if(Object.hasOwn(o.responses,t)){
 const n=o.responses[t];if(n.schema){
 const t=e.produces??o.produces??["application/json"]
@@ -26741,7 +26750,7 @@ default:Tr((()=>[ei("span",qOe,st(a.value||"Select a value"),1),ti(Fn(kZ),{
 icon:"ChevronDown",size:"xs"})])),_:1})])),_:1},8,["value"]))]))}})
 ;function VOe(e){return e.flatMap((e=>{if("value"===e.key)try{
 const t=JSON.parse(e.value);return Object.keys(t).map((e=>({key:e,value:t[e]})))
-}catch{}return[]}))}
+}catch{}return[e]}))}
 var WOe=Object.defineProperty,XOe=(e,t,n)=>((e,t,n)=>t in e?WOe(e,t,{
 enumerable:!0,configurable:!0,writable:!0,value:n
 }):e[t]=n)(e,"symbol"!=typeof t?t+"":t,n);let YOe=class e extends jie{
@@ -28382,10 +28391,10 @@ r.delete(e),o.value===e&&(o.value=null)})(e.uid)
 button:Tr((()=>[ti(Rxe,{click:s},{title:Tr((()=>[oi("Add Environment")])),_:1
 })])),_:1}),ti(Wne,{class:"flex-1"},{default:Tr((()=>[ti(Lre,null,Jr({
 default:Tr((()=>[o.value?(za(),Xa(lye,{key:0,class:"pl-px pr-2 md:px-2 py-2.5",
-lineNumbers:"",modelValue:Fn(n)[o.value].value,"onUpdate:modelValue":l
-},null,8,["modelValue"])):ii("",!0)])),_:2},[o.value?{name:"title",
-fn:Tr((()=>[!i.value||Fn(n)[o.value].isDefault?(za(),Wa("span",{key:0,
-onDblclick:u},st(Fn(n)[o.value].name),33)):(za(),Wa("input",{key:1,
+language:"json",lineNumbers:"",modelValue:Fn(n)[o.value].value,
+"onUpdate:modelValue":l},null,8,["modelValue"])):ii("",!0)])),_:2},[o.value?{
+name:"title",fn:Tr((()=>[!i.value||Fn(n)[o.value].isDefault?(za(),Wa("span",{
+key:0,onDblclick:u},st(Fn(n)[o.value].name),33)):(za(),Wa("input",{key:1,
 ref_key:"nameInputRef",ref:a,
 class:"ring-1 ring-offset-4 ring-b-outline rounded",spellcheck:"false",
 type:"text",value:Fn(n)[o.value].name,onBlur:t[0]||(t[0]=e=>i.value=!1),

package/dist/types.d.ts

@@ -0,0 +1,65 @@
+import type { ReferenceConfiguration } from '@scalar/types/legacy';
+import type { onRequestHookHandler, preHandlerHookHandler } from 'fastify';
+export type FastifyApiReferenceOptions = {
+    /**
+     * If you’re prefixing Fastify with a path, you can set it here.
+     * It’ll be added to the JavaScript URL and the route.
+     *
+     * Example: `${publicPath}${routePrefix}/js/scalar.js`
+     * @deprecated We don't use this anymore.
+     */
+    publicPath?: string;
+    /**
+     * Prefix the route with a path. This is where the API Reference will be available.
+     *
+     * @default '/reference'
+     */
+    routePrefix?: `/${string}`;
+    /**
+     * Set where the OpenAPI specification is exposed under `${routePrefix}`.
+     *
+     * The specification is always available on these endpoints, parsed by `@scalar/openapi-parser`.
+     *
+     * The specification is sourced from, in order of precedence:
+     * - `configuration.spec.content`
+     * - `configuration.spec.url` – fetched via `@scalar/openapi-parser/plugins/fetch-urls`
+     * - `@fastify/swagger` – if `configuration.spec` is not provided
+     *
+     * These endpoints can be used to fetch the OpenAPI specification for your own programmatic use.
+     *
+     * @default{ json: '/openapi.json', yaml: '/openapi.yaml' }
+     */
+    openApiDocumentEndpoints?: {
+        /**
+         * Set where the OpenAPI specification is exposed under `${routePrefix}`, in JSON format.
+         *
+         * With the default value, the endpoint is: `${publicPath}${routePrefix}/openapi.json`
+         *
+         * @default '/openapi.json'
+         */
+        json?: `/${string}`;
+        /**
+         * Set where the OpenAPI specification is exposed under `${routePrefix}`, in YAML format.
+         *
+         * With the default value, the endpoint is: `${publicPath}${routePrefix}/openapi.yaml`
+         *
+         * @default '/openapi.yaml'
+         */
+        yaml?: `/${string}`;
+    };
+    /**
+     * The universal configuration object for @scalar/api-reference.
+     *
+     * Read more: https://github.com/scalar/scalar
+     */
+    configuration?: ReferenceConfiguration;
+    /**
+     * The hooks for the API Reference.
+     */
+    hooks?: FastifyApiReferenceHooksOptions;
+};
+export type FastifyApiReferenceHooksOptions = Partial<{
+    onRequest?: onRequestHookHandler;
+    preHandler?: preHandlerHookHandler;
+}>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAClE,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAE1E,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,IAAI,MAAM,EAAE,CAAA;IAC1B;;;;;;;;;;;;;OAaG;IACH,wBAAwB,CAAC,EAAE;QACzB;;;;;;WAMG;QACH,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,CAAA;QACnB;;;;;;WAMG;QACH,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,CAAA;KACpB,CAAA;IACD;;;;OAIG;IACH,aAAa,CAAC,EAAE,sBAAsB,CAAA;IACtC;;OAEG;IACH,KAAK,CAAC,EAAE,+BAA+B,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG,OAAO,CAAC;IACpD,SAAS,CAAC,EAAE,oBAAoB,CAAA;IAChC,UAAU,CAAC,EAAE,qBAAqB,CAAA;CACnC,CAAC,CAAA"}

package/package.json

@@ -17,7 +17,7 @@
     "openapi",
     "swagger"
   ],
-  "version": "1.25.18",
+  "version": "1.25.20",
   "engines": {
     "node": ">=18"
   },
@@ -39,6 +39,7 @@
   },
   "devDependencies": {
     "@fastify/basic-auth": "^5.1.1",
+    "@fastify/http-proxy": "^9.0.0",
     "@fastify/swagger": "^8.10.1",
     "@vitest/coverage-v8": "^1.6.0",
     "fastify": "^4.26.2",
@@ -51,8 +52,8 @@
     "vitest": "^1.6.0",
     "vue": "^3.4.29",
     "yaml": "^2.4.5",
-    "@scalar/api-reference": "1.25.18",
-    "@scalar/openapi-parser": "0.8.3"
+    "@scalar/api-reference": "1.25.20",
+    "@scalar/openapi-parser": "0.8.4"
   },
   "scripts": {
     "build": "vite build && tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",