@scalar/fastify-api-reference 1.25.19 → 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

@@ -14252,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,
   "/"
 );
@@ -14342,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) {
@@ -14443,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.19
+ * @scalar/api-reference 1.25.20
  *
  * Website: https://scalar.com
  * GitHub:  https://github.com/scalar/scalar

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.19",
+  "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,7 +52,7 @@
     "vitest": "^1.6.0",
     "vue": "^3.4.29",
     "yaml": "^2.4.5",
-    "@scalar/api-reference": "1.25.19",
+    "@scalar/api-reference": "1.25.20",
     "@scalar/openapi-parser": "0.8.4"
   },
   "scripts": {