@scalar/fastify-api-reference 1.64.0 → 1.65.0

package/package.json

@@ -17,7 +17,7 @@
     "openapi",
     "swagger"
   ],
-  "version": "1.64.0",
+  "version": "1.65.0",
   "engines": {
     "node": ">=22"
   },
@@ -54,23 +54,26 @@
   "dependencies": {
     "fastify-plugin": "^4.5.1",
     "github-slugger": "2.0.0",
-    "@scalar/client-side-rendering": "0.3.5",
-    "@scalar/openapi-parser": "0.28.11",
-    "@scalar/openapi-types": "0.9.4"
+    "@scalar/client-side-rendering": "0.3.7",
+    "@scalar/openapi-types": "0.9.4",
+    "@scalar/openapi-parser": "0.28.13"
   },
   "devDependencies": {
     "@fastify/basic-auth": "^5.1.1",
     "@fastify/http-proxy": "^9.5.0",
     "@fastify/swagger": "^8.10.1",
+    "@types/node": "^24.1.0",
     "fastify": "^4.0.0",
-    "vite": "8.0.0",
-    "vitest": "4.1.0",
-    "yaml": "^2.8.3",
-    "@scalar/helpers": "0.9.2",
-    "@scalar/api-reference": "1.64.0"
+    "typescript": "^5.8.3",
+    "vite": "8.1.5",
+    "vite-plugin-dts": "^4.3.0",
+    "vitest": "4.1.10",
+    "yaml": "^2.9.0",
+    "@scalar/api-reference": "1.65.0",
+    "@scalar/helpers": "0.10.0"
   },
   "scripts": {
-    "build": "pnpm types:check && vite build && tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
+    "build": "pnpm types:check && vite build",
     "dev": "tsx watch playground/index.ts",
     "docker:build": "docker build --build-arg BASE_IMAGE=scalar-base -t fastify-api-reference -f Dockerfile .",
     "docker:run": "docker run -p 5053:5053 fastify-api-reference",

package/dist/fastifyApiReference.d.ts

@@ -1,5 +0,0 @@
-import type { FastifyBaseLogger, FastifyTypeProviderDefault, RawServerDefault } from 'fastify';
-import type { FastifyApiReferenceOptions } from './types';
-declare const fastifyApiReference: import("fastify").FastifyPluginCallback<FastifyApiReferenceOptions, RawServerDefault, FastifyTypeProviderDefault, FastifyBaseLogger>;
-export default fastifyApiReference;
-//# sourceMappingURL=fastifyApiReference.d.ts.map

package/dist/fastifyApiReference.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fastifyApiReference.d.ts","sourceRoot":"","sources":["../src/fastifyApiReference.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,iBAAiB,EAAiB,0BAA0B,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAI7G,OAAO,KAAK,EAA8D,0BAA0B,EAAE,MAAM,SAAS,CAAA;AAoDrH,QAAA,MAAM,mBAAmB,sIAyMxB,CAAA;AAED,eAAe,mBAAmB,CAAA"}

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AAC/C,YAAY,EACV,yBAAyB,EACzB,+BAA+B,EAC/B,0BAA0B,GAC3B,MAAM,SAAS,CAAA"}

package/dist/types.d.ts

@@ -1,74 +0,0 @@
-import type { HtmlRenderingConfiguration } from '@scalar/client-side-rendering';
-import type { onRequestHookHandler, preHandlerHookHandler } from 'fastify';
-/**
- * The configuration for the Scalar API Reference for Fastify
- */
-export type ApiReferenceConfiguration = HtmlRenderingConfiguration;
-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?: Partial<ApiReferenceConfiguration>;
-    /**
-     * The hooks for the API Reference.
-     */
-    hooks?: FastifyApiReferenceHooksOptions;
-    /**
-     * The log level for all routes registered by this plugin.
-     * Set to 'silent' to disable logging for these routes.
-     */
-    logLevel?: 'fatal' | 'error' | 'warn' | 'info' | 'debug' | 'trace' | 'silent';
-};
-export type FastifyApiReferenceHooksOptions = Partial<{
-    onRequest?: onRequestHookHandler;
-    preHandler?: preHandlerHookHandler;
-}>;
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,+BAA+B,CAAA;AAC/E,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAE1E;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,0BAA0B,CAAA;AAElE,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,OAAO,CAAC,yBAAyB,CAAC,CAAA;IAClD;;OAEG;IACH,KAAK,CAAC,EAAE,+BAA+B,CAAA;IACvC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAA;CAC9E,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/dist/utils/getJavaScriptFile.d.ts

@@ -1,15 +0,0 @@
-/**
- * Return the standalone build of `@scalar/api-reference` as a string.
- *
- * This implementation reads the script from disk and is what runs during
- * development (the playground executes the source directly via `tsx`) and in
- * tests, where `@scalar/api-reference` is available as a workspace dependency.
- *
- * For the published package, the Vite build replaces this module with the
- * script inlined as a string (see `vite.config.ts`). That is what makes the
- * plugin bundler-safe: the output is self-contained and no longer reads the
- * file at runtime, so it survives whatever bundler the consuming application
- * uses (for example when bundling a Fastify app into a Docker image).
- */
-export declare function getJavaScriptFile(): string;
-//# sourceMappingURL=getJavaScriptFile.d.ts.map

package/dist/utils/getJavaScriptFile.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"getJavaScriptFile.d.ts","sourceRoot":"","sources":["../../src/utils/getJavaScriptFile.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;GAYG;AACH,wBAAgB,iBAAiB,IAAI,MAAM,CAY1C"}