@scalar/fastify-api-reference 1.64.0 → 1.65.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/fastify-api-reference
 
+## 1.65.0
+
+## 1.64.1
+
+### Patch Changes
+
+- [#9835](https://github.com/scalar/scalar/pull/9835): Fix the published type declarations so they resolve under `moduleResolution: node16`/`nodenext` again. Since `1.62.1` the `.d.ts` files re-exported relative modules without a file extension (`export { default } from './fastifyApiReference'`), which ESM resolution rejects with TS2834 — so the plugin's types silently degraded to `any` for those consumers. The declarations are now emitted as a single self-contained `index.d.ts` (matching the Next.js integration), which resolves under every module resolution setting.
+
 ## 1.64.0
 
 ## 1.63.0

package/dist/index.d.ts

@@ -1,3 +1,86 @@
-export { default } from './fastifyApiReference';
-export type { ApiReferenceConfiguration, FastifyApiReferenceHooksOptions, FastifyApiReferenceOptions, } from './types';
-//# sourceMappingURL=index.d.ts.map
+import { FastifyBaseLogger } from 'fastify';
+import { FastifyPluginCallback } from 'fastify';
+import { FastifyTypeProviderDefault } from 'fastify';
+import { HtmlRenderingConfiguration } from '@scalar/client-side-rendering';
+import { onRequestHookHandler } from 'fastify';
+import { preHandlerHookHandler } from 'fastify';
+import { RawServerDefault } from 'fastify';
+
+/**
+ * The configuration for the Scalar API Reference for Fastify
+ */
+export declare type ApiReferenceConfiguration = HtmlRenderingConfiguration;
+
+declare const fastifyApiReference: FastifyPluginCallback<FastifyApiReferenceOptions, RawServerDefault, FastifyTypeProviderDefault, FastifyBaseLogger>;
+export default fastifyApiReference;
+
+export declare type FastifyApiReferenceHooksOptions = Partial<{
+    onRequest?: onRequestHookHandler;
+    preHandler?: preHandlerHookHandler;
+}>;
+
+export declare 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 { }