@depup/gatsby 5.16.1-depup.0

package/dist/utils/adapter/types.d.ts

@@ -0,0 +1,282 @@
+import type reporter from "gatsby-cli/lib/reporter";
+import type { TrailingSlash } from "gatsby-page-utils";
+import type { IHeader, HttpStatusCode } from "../../redux/types";
+import type { ImageCdnUrlGeneratorFn, ImageCdnSourceImage, ImageCdnTransformArgs, FileCdnUrlGeneratorFn, FileCdnSourceImage } from "gatsby-plugin-utils/dist/polyfill-remote-file/types";
+export type { ImageCdnUrlGeneratorFn, ImageCdnSourceImage, ImageCdnTransformArgs, FileCdnUrlGeneratorFn, FileCdnSourceImage, };
+interface IBaseRoute {
+    /**
+     * Request path that should be matched for this route.
+     * It can be:
+     *  - static: `/about/`
+     *  - dynamic:
+     *    - parameterized: `/blog/:slug/`
+     *    - catch-all / wildcard: `/app/*`
+     */
+    path: string;
+}
+export interface IStaticRoute extends IBaseRoute {
+    type: `static`;
+    /**
+     * Location of the file that should be served for this route.
+     */
+    filePath: string;
+    /**
+     * HTTP headers that should be set for this route.
+     * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/headers/
+     */
+    headers: IHeader["headers"];
+}
+export interface IFunctionRoute extends IBaseRoute {
+    type: `function`;
+    /**
+     * Unique identifier of this function. Corresponds to the `functionId` inside the `functionsManifest`.
+     * Some functions will be shared for multiple routes, e.g. SSR or DSG functions.
+     */
+    functionId: string;
+    /**
+     * If `cache` is true, response of function should be cached for current deployment and served on subsequent requests for this route.
+     */
+    cache?: true;
+}
+/**
+ * Redirects are being created through the `createRedirect` action.
+ * @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createRedirect
+ */
+export interface IRedirectRoute extends IBaseRoute {
+    type: `redirect`;
+    /**
+     * The redirect should happen from `path` to `toPath`.
+     */
+    toPath: string;
+    /**
+     * HTTP status code that should be used for this redirect.
+     */
+    status: HttpStatusCode;
+    ignoreCase?: boolean;
+    /**
+     * HTTP headers that should be used for this redirect.
+     * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/headers/
+     */
+    headers: IHeader["headers"];
+    [key: string]: unknown;
+}
+export type Route = IStaticRoute | IFunctionRoute | IRedirectRoute;
+export type RoutesManifest = Array<Route>;
+export interface IHeaderRoute extends IBaseRoute {
+    headers: IHeader["headers"];
+}
+export type HeaderRoutes = Array<IHeaderRoute>;
+export interface IFunctionDefinition {
+    /**
+     * Unique identifier of this function. Corresponds to the `functionId` inside the `routesManifest`.
+     */
+    functionId: string;
+    /**
+     * Unique name of this function. Use this as a display name for the function.
+     */
+    name: string;
+    /**
+     * Path to function entrypoint that will be used to create function
+     */
+    pathToEntryPoint: string;
+    /**
+     * List of all required files that this function needs to run
+     */
+    requiredFiles: Array<string>;
+}
+export type FunctionsManifest = Array<IFunctionDefinition>;
+interface IDefaultContext {
+    /**
+     * Reporter instance that can be used to log messages to terminal
+     * @see https://www.gatsbyjs.com/docs/reference/config-files/node-api-helpers/#reporter
+     */
+    reporter: typeof reporter;
+}
+export type RemoteFileAllowedUrls = Array<{
+    /**
+     * Allowed url in URLPattern format. In particular it uses wildcard `*` and param `:param` syntax.
+     */
+    urlPattern: string;
+    /**
+     *Allowed url in regex source format
+     */
+    regexSource: string;
+}>;
+export interface IAdaptContext extends IDefaultContext {
+    routesManifest: RoutesManifest;
+    functionsManifest: FunctionsManifest;
+    headerRoutes: HeaderRoutes;
+    /**
+     * @see https://www.gatsbyjs.com/docs/reference/config-files/gatsby-config/#pathprefix
+     */
+    pathPrefix: string;
+    /**
+     * @see https://www.gatsbyjs.com/docs/reference/config-files/gatsby-config/#trailingslash
+     */
+    trailingSlash: TrailingSlash;
+    /**
+     * List of allowed remote file URLs represented in URLPattern and Regex formats.
+     * Allowed urls are provided by user or plugins using `addRemoteFileAllowedUrl` action.
+     * @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#addRemoteFileAllowedUrl
+     */
+    remoteFileAllowedUrls: RemoteFileAllowedUrls;
+}
+export interface ICacheContext extends IDefaultContext {
+    directories: Array<string>;
+}
+export interface IAdapterConfig {
+    /**
+     * URL representing the unique URL for an individual deploy
+     */
+    deployURL?: string;
+    /**
+     * If `true`, Gatsby will not include the LMDB datastore in the serverless functions used for SSR/DSG.
+     * Instead, it will try to download the datastore from the given `deployURL`.
+     */
+    excludeDatastoreFromEngineFunction?: boolean;
+    /**
+     * Adapters can optionally describe which features they support to prevent potentially faulty deployments
+     */
+    supports?: {
+        /**
+         * If `false`, Gatsby will fail the build if user tries to use pathPrefix.
+         */
+        pathPrefix?: boolean;
+        /**
+         * Provide array of supported traling slash options
+         * @example [`always`]
+         */
+        trailingSlash?: Array<TrailingSlash>;
+    };
+    /**
+     * List of plugins that should be disabled when using this adapter. Purpose of this is to disable
+     * any potential plugins that serve similar role as adapter that would cause conflicts when both
+     * plugin and adapter is used at the same time.
+     */
+    pluginsToDisable?: Array<string>;
+    /**
+     * Path to a CommonJS module that implements an image CDN URL generation function. The function
+     * is used to optimize image delivery by generating URLs that leverage CDN capabilities. This module
+     * should have a default export function that conforms to the {@link ImageCdnUrlGeneratorFn} type:
+     *
+     * Adapters should provide an absolute path to this module.
+     * See 'packages/gatsby-adapter-netlify/src/image-cdn-url-generator.ts' as an implementation
+     * example for the Netlify adapter.
+     */
+    imageCDNUrlGeneratorModulePath?: string;
+    /**
+     * Path to a CommonJS module that implements an file CDN URL generation function. This module
+     * should have a default export function that conforms to the {@link FileCdnUrlGeneratorFn} type:
+     *
+     * Adapters should provide an absolute path to this module.
+     * See 'packages/gatsby-adapter-netlify/src/file-cdn-url-generator.ts' as an implementation
+     * example for the Netlify adapter.
+     */
+    fileCDNUrlGeneratorModulePath?: string;
+    /**
+     * The platform bundled functions will execute on. Usually should be `linux`.
+     * This will be used if user didn't specify `GATSBY_FUNCTIONS_PLATFORM` environment variable
+     * or used `-functions-platform` CLI toggle. If none is defined current platform (process.platform) will be used.
+     */
+    functionsPlatform?: string;
+    /**
+     * The architecture bundled functions will execute on. Usually should be `x64`.
+     * This will be used if user didn't specify `GATSBY_FUNCTIONS_ARCH` environment variable
+     * or used `-functions-arch` CLI toggle. If none is defined current arch (process.arch) will be used.
+     */
+    functionsArch?: string;
+}
+type WithRequired<T, K extends keyof T> = T & {
+    [P in K]-?: T[P];
+};
+/**
+ * This is the internal version of "IAdapterConfig" to enforce that certain keys must be present.
+ * Authors of adapters will only see "IAdapterConfig".
+ */
+export type IAdapterFinalConfig = WithRequired<IAdapterConfig, "excludeDatastoreFromEngineFunction" | "pluginsToDisable">;
+export interface IAdapter {
+    /**
+     * Unique name of the adapter. Used to identify adapter in manifest.
+     */
+    name: string;
+    cache?: {
+        /**
+         * Hook to restore `directories` from previous builds. This is executed very early on in the build process. If `false` is returned Gatsby will skip its cache restoration.
+         */
+        restore: (context: ICacheContext) => Promise<boolean | void> | boolean | void;
+        /**
+         * Hook to store `directories` for the current build. Executed as one of the last steps in the build process.
+         */
+        store: (context: ICacheContext) => Promise<void> | void;
+    };
+    /**
+     * Hook to take Gatsby’s output and preparing it for deployment on the adapter’s platform. Executed as one of the last steps in the build process.
+     *
+     * The `adapt` hook should do the following things:
+     * - Apply HTTP headers to assets
+     * - Apply redirects and rewrites. The adapter should can also create its own redirects/rewrites if necessary (e.g. mapping serverless functions to internal URLs).
+     * - Wrap serverless functions coming from Gatsby with platform-specific code (if necessary). Gatsby will produce [Express-like](https://expressjs.com/) handlers.
+     * - Apply trailing slash behavior and path prefix to URLs
+     * - Possibly upload assets to CDN
+     *
+     * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/creating-an-adapter/
+     */
+    adapt: (context: IAdaptContext) => Promise<void> | void;
+    /**
+     * Hook to pass information from the adapter to Gatsby. You must return an object with a predefined shape.
+     * Gatsby uses this information to adjust its build process. The information can be e.g. things that are only known once the project is deployed.
+     *
+     * This hook can enable advanced feature of adapters and it is not required to implement it.
+     *
+     * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/creating-an-adapter/
+     */
+    config?: (context: IDefaultContext) => Promise<IAdapterConfig> | IAdapterConfig;
+}
+/**
+ * Adapter initialization function that returns an instance of the adapter.
+ * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/creating-an-adapter/
+ */
+export type AdapterInit<T = Record<string, unknown>> = (adapterOptions?: T) => IAdapter;
+export interface IAdapterManager {
+    restoreCache: () => Promise<void> | void;
+    storeCache: () => Promise<void> | void;
+    adapt: () => Promise<void> | void;
+    config: () => Promise<IAdapterFinalConfig>;
+}
+/**
+ * Types for gatsby/adapters.js
+ * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/zero-configuration-deployments/
+ */
+export interface IAdapterManifestEntry {
+    /**
+     * Name of the adapter
+     */
+    name: string;
+    /**
+     * Test function to determine if adapter should be used
+     */
+    test: () => boolean;
+    /**
+     * npm module name of the adapter
+     */
+    module: string;
+    /**
+     * List of version pairs that are supported by the adapter.
+     * This allows to have multiple versions of the adapter for different versions of Gatsby.
+     * This is useful for when APIs change or bugs are fixed that require different implementations.
+     */
+    versions: Array<{
+        /**
+         * Version of the `gatsby` package. This is a semver range.
+         */
+        gatsbyVersion: string;
+        /**
+         * Version of the adapter. This is a semver range.
+         */
+        moduleVersion: string;
+        /**
+         * Can override the module defined in the parent manifest entry - useful for when the adapter is renamed.
+         */
+        module?: string;
+    }>;
+}

package/dist/utils/adapter/types.js

@@ -0,0 +1,4 @@
+"use strict";
+
+exports.__esModule = true;
+//# sourceMappingURL=types.js.map

package/dist/utils/adapter/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../src/utils/adapter/types.ts"],"sourcesContent":["import type reporter from \"gatsby-cli/lib/reporter\"\nimport type { TrailingSlash } from \"gatsby-page-utils\"\nimport type { IHeader, HttpStatusCode } from \"../../redux/types\"\n\nimport type {\n  ImageCdnUrlGeneratorFn,\n  ImageCdnSourceImage,\n  ImageCdnTransformArgs,\n  FileCdnUrlGeneratorFn,\n  FileCdnSourceImage,\n} from \"gatsby-plugin-utils/dist/polyfill-remote-file/types\"\n\nexport type {\n  ImageCdnUrlGeneratorFn,\n  ImageCdnSourceImage,\n  ImageCdnTransformArgs,\n  FileCdnUrlGeneratorFn,\n  FileCdnSourceImage,\n}\n\ninterface IBaseRoute {\n  /**\n   * Request path that should be matched for this route.\n   * It can be:\n   *  - static: `/about/`\n   *  - dynamic:\n   *    - parameterized: `/blog/:slug/`\n   *    - catch-all / wildcard: `/app/*`\n   */\n  path: string\n}\n\nexport interface IStaticRoute extends IBaseRoute {\n  type: `static`\n  /**\n   * Location of the file that should be served for this route.\n   */\n  filePath: string\n  /**\n   * HTTP headers that should be set for this route.\n   * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/headers/\n   */\n  headers: IHeader[\"headers\"]\n}\n\nexport interface IFunctionRoute extends IBaseRoute {\n  type: `function`\n  /**\n   * Unique identifier of this function. Corresponds to the `functionId` inside the `functionsManifest`.\n   * Some functions will be shared for multiple routes, e.g. SSR or DSG functions.\n   */\n  functionId: string\n  /**\n   * If `cache` is true, response of function should be cached for current deployment and served on subsequent requests for this route.\n   */\n  cache?: true\n}\n\n/**\n * Redirects are being created through the `createRedirect` action.\n * @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#createRedirect\n */\nexport interface IRedirectRoute extends IBaseRoute {\n  type: `redirect`\n  /**\n   * The redirect should happen from `path` to `toPath`.\n   */\n  toPath: string\n  /**\n   * HTTP status code that should be used for this redirect.\n   */\n  status: HttpStatusCode\n  ignoreCase?: boolean\n  /**\n   * HTTP headers that should be used for this redirect.\n   * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/headers/\n   */\n  headers: IHeader[\"headers\"]\n  [key: string]: unknown\n}\n\nexport type Route = IStaticRoute | IFunctionRoute | IRedirectRoute\n\nexport type RoutesManifest = Array<Route>\n\nexport interface IHeaderRoute extends IBaseRoute {\n  headers: IHeader[\"headers\"]\n}\n\nexport type HeaderRoutes = Array<IHeaderRoute>\nexport interface IFunctionDefinition {\n  /**\n   * Unique identifier of this function. Corresponds to the `functionId` inside the `routesManifest`.\n   */\n  functionId: string\n  /**\n   * Unique name of this function. Use this as a display name for the function.\n   */\n  name: string\n  /**\n   * Path to function entrypoint that will be used to create function\n   */\n  pathToEntryPoint: string\n  /**\n   * List of all required files that this function needs to run\n   */\n  requiredFiles: Array<string>\n}\n\nexport type FunctionsManifest = Array<IFunctionDefinition>\n\ninterface IDefaultContext {\n  /**\n   * Reporter instance that can be used to log messages to terminal\n   * @see https://www.gatsbyjs.com/docs/reference/config-files/node-api-helpers/#reporter\n   */\n  reporter: typeof reporter\n}\n\nexport type RemoteFileAllowedUrls = Array<{\n  /**\n   * Allowed url in URLPattern format. In particular it uses wildcard `*` and param `:param` syntax.\n   */\n  urlPattern: string\n  /**\n   *Allowed url in regex source format\n   */\n  regexSource: string\n}>\n\nexport interface IAdaptContext extends IDefaultContext {\n  routesManifest: RoutesManifest\n  functionsManifest: FunctionsManifest\n  headerRoutes: HeaderRoutes\n  /**\n   * @see https://www.gatsbyjs.com/docs/reference/config-files/gatsby-config/#pathprefix\n   */\n  pathPrefix: string\n  /**\n   * @see https://www.gatsbyjs.com/docs/reference/config-files/gatsby-config/#trailingslash\n   */\n  trailingSlash: TrailingSlash\n  /**\n   * List of allowed remote file URLs represented in URLPattern and Regex formats.\n   * Allowed urls are provided by user or plugins using `addRemoteFileAllowedUrl` action.\n   * @see https://www.gatsbyjs.com/docs/reference/config-files/actions/#addRemoteFileAllowedUrl\n   */\n  remoteFileAllowedUrls: RemoteFileAllowedUrls\n}\n\nexport interface ICacheContext extends IDefaultContext {\n  directories: Array<string>\n}\n\nexport interface IAdapterConfig {\n  /**\n   * URL representing the unique URL for an individual deploy\n   */\n  deployURL?: string\n  /**\n   * If `true`, Gatsby will not include the LMDB datastore in the serverless functions used for SSR/DSG.\n   * Instead, it will try to download the datastore from the given `deployURL`.\n   */\n  excludeDatastoreFromEngineFunction?: boolean\n  /**\n   * Adapters can optionally describe which features they support to prevent potentially faulty deployments\n   */\n  supports?: {\n    /**\n     * If `false`, Gatsby will fail the build if user tries to use pathPrefix.\n     */\n    pathPrefix?: boolean\n    /**\n     * Provide array of supported traling slash options\n     * @example [`always`]\n     */\n    trailingSlash?: Array<TrailingSlash>\n  }\n  /**\n   * List of plugins that should be disabled when using this adapter. Purpose of this is to disable\n   * any potential plugins that serve similar role as adapter that would cause conflicts when both\n   * plugin and adapter is used at the same time.\n   */\n  pluginsToDisable?: Array<string>\n  /**\n   * Path to a CommonJS module that implements an image CDN URL generation function. The function\n   * is used to optimize image delivery by generating URLs that leverage CDN capabilities. This module\n   * should have a default export function that conforms to the {@link ImageCdnUrlGeneratorFn} type:\n   *\n   * Adapters should provide an absolute path to this module.\n   * See 'packages/gatsby-adapter-netlify/src/image-cdn-url-generator.ts' as an implementation\n   * example for the Netlify adapter.\n   */\n  imageCDNUrlGeneratorModulePath?: string\n  /**\n   * Path to a CommonJS module that implements an file CDN URL generation function. This module\n   * should have a default export function that conforms to the {@link FileCdnUrlGeneratorFn} type:\n   *\n   * Adapters should provide an absolute path to this module.\n   * See 'packages/gatsby-adapter-netlify/src/file-cdn-url-generator.ts' as an implementation\n   * example for the Netlify adapter.\n   */\n  fileCDNUrlGeneratorModulePath?: string\n  /**\n   * The platform bundled functions will execute on. Usually should be `linux`.\n   * This will be used if user didn't specify `GATSBY_FUNCTIONS_PLATFORM` environment variable\n   * or used `-functions-platform` CLI toggle. If none is defined current platform (process.platform) will be used.\n   */\n  functionsPlatform?: string\n  /**\n   * The architecture bundled functions will execute on. Usually should be `x64`.\n   * This will be used if user didn't specify `GATSBY_FUNCTIONS_ARCH` environment variable\n   * or used `-functions-arch` CLI toggle. If none is defined current arch (process.arch) will be used.\n   */\n  functionsArch?: string\n}\n\ntype WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] }\n\n/**\n * This is the internal version of \"IAdapterConfig\" to enforce that certain keys must be present.\n * Authors of adapters will only see \"IAdapterConfig\".\n */\nexport type IAdapterFinalConfig = WithRequired<\n  IAdapterConfig,\n  \"excludeDatastoreFromEngineFunction\" | \"pluginsToDisable\"\n>\n\nexport interface IAdapter {\n  /**\n   * Unique name of the adapter. Used to identify adapter in manifest.\n   */\n  name: string\n  cache?: {\n    /**\n     * Hook to restore `directories` from previous builds. This is executed very early on in the build process. If `false` is returned Gatsby will skip its cache restoration.\n     */\n    restore: (\n      context: ICacheContext\n    ) => Promise<boolean | void> | boolean | void\n    /**\n     * Hook to store `directories` for the current build. Executed as one of the last steps in the build process.\n     */\n    store: (context: ICacheContext) => Promise<void> | void\n  }\n  /**\n   * Hook to take Gatsby’s output and preparing it for deployment on the adapter’s platform. Executed as one of the last steps in the build process.\n   *\n   * The `adapt` hook should do the following things:\n   * - Apply HTTP headers to assets\n   * - Apply redirects and rewrites. The adapter should can also create its own redirects/rewrites if necessary (e.g. mapping serverless functions to internal URLs).\n   * - Wrap serverless functions coming from Gatsby with platform-specific code (if necessary). Gatsby will produce [Express-like](https://expressjs.com/) handlers.\n   * - Apply trailing slash behavior and path prefix to URLs\n   * - Possibly upload assets to CDN\n   *\n   * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/creating-an-adapter/\n   */\n  adapt: (context: IAdaptContext) => Promise<void> | void\n  /**\n   * Hook to pass information from the adapter to Gatsby. You must return an object with a predefined shape.\n   * Gatsby uses this information to adjust its build process. The information can be e.g. things that are only known once the project is deployed.\n   *\n   * This hook can enable advanced feature of adapters and it is not required to implement it.\n   *\n   * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/creating-an-adapter/\n   */\n  config?: (\n    context: IDefaultContext\n  ) => Promise<IAdapterConfig> | IAdapterConfig\n}\n\n/**\n * Adapter initialization function that returns an instance of the adapter.\n * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/creating-an-adapter/\n */\nexport type AdapterInit<T = Record<string, unknown>> = (\n  adapterOptions?: T\n) => IAdapter\n\nexport interface IAdapterManager {\n  restoreCache: () => Promise<void> | void\n  storeCache: () => Promise<void> | void\n  adapt: () => Promise<void> | void\n  config: () => Promise<IAdapterFinalConfig>\n}\n/**\n * Types for gatsby/adapters.js\n * @see http://www.gatsbyjs.com/docs/how-to/previews-deploys-hosting/zero-configuration-deployments/\n */\nexport interface IAdapterManifestEntry {\n  /**\n   * Name of the adapter\n   */\n  name: string\n  /**\n   * Test function to determine if adapter should be used\n   */\n  test: () => boolean\n  /**\n   * npm module name of the adapter\n   */\n  module: string\n  /**\n   * List of version pairs that are supported by the adapter.\n   * This allows to have multiple versions of the adapter for different versions of Gatsby.\n   * This is useful for when APIs change or bugs are fixed that require different implementations.\n   */\n  versions: Array<{\n    /**\n     * Version of the `gatsby` package. This is a semver range.\n     */\n    gatsbyVersion: string\n    /**\n     * Version of the adapter. This is a semver range.\n     */\n    moduleVersion: string\n    /**\n     * Can override the module defined in the parent manifest entry - useful for when the adapter is renamed.\n     */\n    module?: string\n  }>\n}\n"],"mappings":""}

package/dist/utils/api-browser-docs.d.ts

@@ -0,0 +1,272 @@
+/**
+ * This argument is empty. This is for consistency so `pluginOptions` is always second argument.
+ * @typedef {undefined} emptyArg
+ */
+/**
+ * Object containing options defined in `gatsby-config.js`
+ * @typedef {object} pluginOptions
+ */
+/**
+ * Called when the Gatsby browser runtime first starts.
+ * @param {emptyArg} _
+ * @param {pluginOptions} pluginOptions
+ * @example
+ * exports.onClientEntry = () => {
+ *   console.log("We've started!")
+ *   callAnalyticsAPI()
+ * }
+ */
+export declare const onClientEntry = true;
+/**
+ * Called when the initial (but not subsequent) render of Gatsby App is done on the client.
+ * @param {emptyArg} _
+ * @param {pluginOptions} pluginOptions
+ * @example
+ * exports.onInitialClientRender = () => {
+ *   console.log("ReactDOM.render has executed")
+ * }
+ */
+export declare const onInitialClientRender = true;
+/**
+ * Called when changing location is started.
+ * @param {object} $0
+ * @param {object} $0.location A location object
+ * @param {object|null} $0.prevLocation The previous location object
+ * @param {pluginOptions} pluginOptions
+ * @example
+ * exports.onPreRouteUpdate = ({ location, prevLocation }) => {
+ *   console.log("Gatsby started to change location to", location.pathname)
+ *   console.log("Gatsby started to change location from", prevLocation ? prevLocation.pathname : null)
+ * }
+ */
+export declare const onPreRouteUpdate = true;
+/**
+ * Called when changing location is longer than 1 second.
+ * @param {object} $0
+ * @param {object} $0.location A location object
+ * @param {object} $0.action The "action" that caused the route change
+ * @param {pluginOptions} pluginOptions
+ * @example
+ * exports.onRouteUpdateDelayed = () => {
+ *   console.log("We can show loading indicator now")
+ * }
+ */
+export declare const onRouteUpdateDelayed = true;
+/**
+ * Called when the user changes routes, including on the initial load of the app
+ * @param {object} $0
+ * @param {object} $0.location A location object
+ * @param {object|null} $0.prevLocation The previous location object
+ * @param {pluginOptions} pluginOptions
+ * @example
+ * exports.onRouteUpdate = ({ location, prevLocation }) => {
+ *   console.log('new pathname', location.pathname)
+ *   console.log('old pathname', prevLocation ? prevLocation.pathname : null)
+ * }
+ */
+export declare const onRouteUpdate = true;
+/**
+ * Allows a plugin to influence scrolling behavior on navigation.
+ * Default behavior is persisting last known scrolling positions and scrolling back to them on navigation.
+ * Plugins can also override this and return an Array of coordinates or an element name to scroll to.
+ * @param {object} $0
+ * @param {object} $0.prevRouterProps The previous state of the router before the route change.
+ * @param {object} $0.routerProps The current state of the router.
+ * @param {string} $0.pathname The new pathname (for backwards compatibility with v1).
+ * @param {function} $0.getSavedScrollPosition Takes a location and returns the
+ * coordinates of the last scroll position for that location, or `null` depending on
+ * whether a scroll happened or not. Gatsby saves scroll positions for each route
+ * in `SessionStorage`, so they are available after page reload.
+ * @returns {(boolean|string|Array)} Should return either an [x, y] Array of
+ * coordinates to scroll to, a string of the `id` or `name` of an element to
+ * scroll to, `false` to not update the scroll position, or `true` for the
+ * default behavior.
+ * @param {pluginOptions} pluginOptions
+ * @example
+ * exports.shouldUpdateScroll = ({
+ *   routerProps: { location },
+ *   getSavedScrollPosition
+ * }) => {
+ *   const currentPosition = getSavedScrollPosition(location)
+ *   const queriedPosition = getSavedScrollPosition({ pathname: `/random` })
+ *
+ *   window.scrollTo(...(currentPosition || [0, 0]))
+ *
+ *   return false
+ * }
+ */
+export declare const shouldUpdateScroll = true;
+/**
+ * Allow a plugin to register a Service Worker. Should be a function that returns true.
+ * @param {emptyArg} _
+ * @param {pluginOptions} pluginOptions
+ * @returns {boolean} Should Gatsby register `/sw.js` service worker
+ * @example
+ * exports.registerServiceWorker = () => true
+ */
+export declare const registerServiceWorker = true;
+/**
+ * Can be used to wrap each page element.
+ *
+ * This is useful for setting wrapper components around pages that won't get
+ * unmounted on page changes. For setting context providers, use [wrapRootElement](#wrapRootElement).
+ *
+ * _Note:_
+ * There is an equivalent hook in Gatsby's [SSR API](/docs/ssr-apis/#wrapPageElement).
+ * It is recommended to use both APIs together.
+ * For example usage, check out [Using i18n](https://github.com/gatsbyjs/gatsby/tree/master/examples/using-i18n).
+ * @param {object} $0
+ * @param {ReactNode} $0.element The "Page" React Element built by Gatsby.
+ * @param {object} $0.props Props object used by page.
+ * @param {pluginOptions} pluginOptions
+ * @returns {ReactNode} Wrapped element
+ * @example
+ * const React = require("react")
+ * const Layout = require("./src/components/layout").default
+ *
+ * exports.wrapPageElement = ({ element, props }) => {
+ *   // props provide same data to Layout as Page element will get
+ *   // including location, data, etc - you don't need to pass it
+ *   return <Layout {...props}>{element}</Layout>
+ * }
+ */
+export declare const wrapPageElement = true;
+/**
+ * Can be used to the wrap the root element.
+ *
+ * This is useful to set up any context providers that will wrap your application.
+ * For setting persistent UI elements around pages use [wrapPageElement](#wrapPageElement).
+ *
+ * _Note:_
+ * There is an equivalent hook in Gatsby's [SSR API](/docs/ssr-apis/#wrapRootElement).
+ * It is recommended to use both APIs together.
+ * For example usage, check out [Using redux](https://github.com/gatsbyjs/gatsby/tree/master/examples/using-redux).
+ * @param {object} $0
+ * @param {ReactNode} $0.element The "Root" React Element built by Gatsby.
+ * @param {pluginOptions} pluginOptions
+ * @returns {ReactNode} Wrapped element
+ * @example
+ * const React = require("react")
+ * const { Provider } = require("react-redux")
+ *
+ * const createStore = require("./src/state/createStore")
+ * const store = createStore()
+ *
+ * exports.wrapRootElement = ({ element }) => {
+ *   return (
+ *     <Provider store={store}>
+ *       {element}
+ *     </Provider>
+ *   )
+ * }
+ */
+export declare const wrapRootElement = true;
+/**
+ * Called when prefetching for a pathname is triggered. Allows
+ * for plugins with custom prefetching logic.
+ * @param {object} $0
+ * @param {string} $0.pathname The pathname whose resources should now be prefetched
+ * @param {function} $0.loadPage Function for fetching resources related to pathname
+ * @param {pluginOptions} pluginOptions
+ */
+export declare const onPrefetchPathname = true;
+/**
+ * Called when prefetching for a pathname is successful. Allows
+ * for plugins with custom prefetching logic.
+ * @param {object} $0
+ * @param {string} $0.pathname The pathname whose resources have now been prefetched
+ * @param {pluginOptions} pluginOptions
+ */
+export declare const onPostPrefetchPathname = true;
+/**
+ * Plugins can take over prefetching logic. If they do, they should call this
+ * to disable the now duplicate core prefetching logic.
+ * @param {emptyArg} _
+ * @param {pluginOptions} pluginOptions
+ * @returns {boolean} Should disable core prefetching
+ * @example
+ * exports.disableCorePrefetching = () => true
+ */
+export declare const disableCorePrefetching = true;
+/**
+ * Allow a plugin to replace the `ReactDOM.createRoot`/`render` function calls with a custom renderer.
+ * @param {emptyArg} _
+ * @param {pluginOptions} pluginOptions
+ * @returns {Function} This method should return a function with same signature as `ReactDOM.createRoot`/`render`
+ *
+ * _Note:_
+ * Refer to React's documentation on [`ReactDOM.createRoot`/`render`](https://reactjs.org/docs/react-dom-client.html#createroot) for more information.
+ * Note that `ReactDOM.createRoot`/`render` is only available in React 18 or greater, prior versions should use [`ReactDOM.render`](https://reactjs.org/docs/react-dom.html#render).
+ * @example
+ * exports.replaceHydrateFunction = () => {
+ *   return (element, container) => {
+ *     const root = ReactDOM.createRoot(container)
+ *     root.render(element)
+ *   }
+ * }
+ */
+export declare const replaceHydrateFunction = true;
+/**
+ * Inform plugins when a service worker has been installed.
+ * @param {object} $0
+ * @param {object} $0.serviceWorker The service worker instance.
+ * @param {pluginOptions} pluginOptions
+ */
+export declare const onServiceWorkerInstalled = true;
+/**
+ * Inform plugins of when a service worker has an update available.
+ * @param {object} $0
+ * @param {object} $0.serviceWorker The service worker instance.
+ * @param {pluginOptions} pluginOptions
+ */
+export declare const onServiceWorkerUpdateFound = true;
+/**
+ * Inform plugins when a service worker has been updated in the background
+ * and the page is ready to reload to apply changes.
+ * @param {object} $0
+ * @param {object} $0.serviceWorker The service worker instance.
+ * @param {pluginOptions} pluginOptions
+ */
+export declare const onServiceWorkerUpdateReady = true;
+/**
+ * Inform plugins when a service worker has become active.
+ * @param {object} $0
+ * @param {object} $0.serviceWorker The service worker instance.
+ * @param {pluginOptions} pluginOptions
+ */
+export declare const onServiceWorkerActive = true;
+/**
+ * Inform plugins when a service worker is redundant.
+ * @param {object} $0
+ * @param {object} $0.serviceWorker The service worker instance.
+ * @param {pluginOptions} pluginOptions
+ */
+export declare const onServiceWorkerRedundant = true;
+/**
+ * Called when React catches an error during rendering, in a lifecycle method, or in the constructor of the whole tree.
+ * This corresponds to React 19's `onCaughtError` root option.
+ * @param {object} $0
+ * @param {Error} $0.error The error that was caught.
+ * @param {object} $0.errorInfo Additional error information containing componentStack.
+ * @param {pluginOptions} pluginOptions
+ * @example
+ * exports.onCaughtError = ({ error, errorInfo }) => {
+ *   console.log('Caught error:', error.message)
+ *   // Log to external error reporting service
+ * }
+ */
+export declare const onCaughtError = true;
+/**
+ * Called when React receives an error that was thrown by an asynchronous event (e.g., setTimeout, requestIdleCallback, etc).
+ * This corresponds to React 19's `onUncaughtError` root option.
+ * @param {object} $0
+ * @param {Error} $0.error The error that was thrown.
+ * @param {object} $0.errorInfo Additional error information containing componentStack.
+ * @param {pluginOptions} pluginOptions
+ * @example
+ * exports.onUncaughtError = ({ error, errorInfo }) => {
+ *   console.error('Uncaught error:', error.message)
+ *   // Log to external error reporting service
+ * }
+ */
+export declare const onUncaughtError = true;