npm - @qwik.dev/router - Versions diffs - 2.0.0-beta.2 → 2.0.0-beta.21 - Mend

@qwik.dev/router 2.0.0-beta.2 → 2.0.0-beta.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

package/adapters/static/vite.d.ts +1 -1
package/lib/adapters/azure-swa/vite/index.d.ts +2 -2
package/lib/adapters/azure-swa/vite/index.mjs +9 -9
package/lib/adapters/bun-server/vite/index.d.ts +2 -2
package/lib/adapters/bun-server/vite/index.mjs +9 -7
package/lib/adapters/cloud-run/vite/index.d.ts +2 -2
package/lib/adapters/cloud-run/vite/index.mjs +9 -7
package/lib/adapters/cloudflare-pages/vite/index.d.ts +2 -2
package/lib/adapters/cloudflare-pages/vite/index.mjs +9 -24
package/lib/adapters/deno-server/vite/index.d.ts +2 -2
package/lib/adapters/deno-server/vite/index.mjs +9 -7
package/lib/adapters/netlify-edge/vite/index.d.ts +2 -2
package/lib/adapters/netlify-edge/vite/index.mjs +10 -14
package/lib/adapters/node-server/vite/index.d.ts +2 -2
package/lib/adapters/node-server/vite/index.mjs +9 -7
package/lib/adapters/shared/vite/index.d.ts +13 -19
package/lib/adapters/shared/vite/index.mjs +107 -139
package/lib/adapters/ssg/vite/index.d.ts +13 -0
package/lib/adapters/ssg/vite/index.mjs +18 -0
package/lib/adapters/vercel-edge/vite/index.d.ts +3 -3
package/lib/adapters/vercel-edge/vite/index.mjs +9 -11
package/lib/chunks/error-handler.mjs +57 -0
package/lib/chunks/format-error.mjs +137 -0
package/lib/chunks/fs.mjs +254 -0
package/lib/{static/node.mjs → chunks/index.mjs} +361 -563
package/lib/chunks/mime-types.mjs +52 -0
package/lib/chunks/routing.qwik.mjs +429 -0
package/lib/chunks/types.qwik.mjs +22 -0
package/lib/index.d.ts +240 -60
package/lib/index.qwik.mjs +698 -983
package/lib/middleware/aws-lambda/index.d.ts +3 -2
package/lib/middleware/aws-lambda/index.mjs +8 -12
package/lib/middleware/azure-swa/index.mjs +10 -216
package/lib/middleware/bun/index.d.ts +11 -0
package/lib/middleware/bun/index.mjs +24 -83
package/lib/middleware/cloudflare-pages/index.mjs +10 -22
package/lib/middleware/deno/index.d.ts +11 -0
package/lib/middleware/deno/index.mjs +24 -83
package/lib/middleware/firebase/index.mjs +7 -11
package/lib/middleware/netlify-edge/index.mjs +10 -23
package/lib/middleware/node/index.mjs +22 -87
package/lib/middleware/request-handler/index.d.ts +89 -70
package/lib/middleware/request-handler/index.mjs +584 -659
package/lib/middleware/vercel-edge/index.mjs +15 -27
package/lib/modules.d.ts +4 -12
package/lib/service-worker/index.mjs +4 -0
package/lib/{static → ssg}/index.d.ts +17 -17
package/lib/ssg/index.mjs +14 -0
package/lib/vite/index.d.ts +32 -10
package/lib/vite/index.mjs +1524 -26934
package/modules.d.ts +4 -12
package/package.json +62 -68
package/ssg.d.ts +2 -0
package/static.d.ts +1 -1
package/lib/adapters/azure-swa/vite/index.cjs +0 -96
package/lib/adapters/bun-server/vite/index.cjs +0 -50
package/lib/adapters/cloud-run/vite/index.cjs +0 -47
package/lib/adapters/cloudflare-pages/vite/index.cjs +0 -115
package/lib/adapters/deno-server/vite/index.cjs +0 -62
package/lib/adapters/netlify-edge/vite/index.cjs +0 -129
package/lib/adapters/node-server/vite/index.cjs +0 -50
package/lib/adapters/shared/vite/index.cjs +0 -378
package/lib/adapters/static/vite/index.cjs +0 -368
package/lib/adapters/static/vite/index.d.ts +0 -10
package/lib/adapters/static/vite/index.mjs +0 -331
package/lib/adapters/vercel-edge/vite/index.cjs +0 -118
package/lib/index.qwik.cjs +0 -1947
package/lib/middleware/node/index.cjs +0 -314
package/lib/middleware/request-handler/index.cjs +0 -1614
package/lib/service-worker.cjs +0 -17
package/lib/service-worker.mjs +0 -15
package/lib/static/deno.mjs +0 -8
package/lib/static/index.cjs +0 -67
package/lib/static/index.mjs +0 -48
package/lib/static/node.cjs +0 -1124
package/lib/vite/index.cjs +0 -27445
package/middleware/request-handler/generated/not-found-paths.ts +0 -7
package/middleware/request-handler/generated/static-paths.ts +0 -35

package/lib/index.d.ts CHANGED Viewed

@@ -1,5 +1,6 @@
 /// <reference path="./modules.d.ts" />
+import type { AsyncSignal } from '@qwik.dev/core/internal';
 import { Component } from '@qwik.dev/core';
 import { Cookie } from '@qwik.dev/router/middleware/request-handler';
 import { CookieOptions } from '@qwik.dev/router/middleware/request-handler';
@@ -12,6 +13,8 @@ import { QRLEventHandlerMulti } from '@qwik.dev/core';
 import { QwikIntrinsicElements } from '@qwik.dev/core';
 import { QwikJSX } from '@qwik.dev/core';
 import type { ReadonlySignal } from '@qwik.dev/core';
+import { Render } from '@qwik.dev/core/server';
+import { RenderOptions } from '@qwik.dev/core/server';
 import { RequestEvent } from '@qwik.dev/router/middleware/request-handler';
 import { RequestEventAction } from '@qwik.dev/router/middleware/request-handler';
 import { RequestEventBase } from '@qwik.dev/router/middleware/request-handler';
@@ -19,8 +22,10 @@ import { RequestEventCommon } from '@qwik.dev/router/middleware/request-handler'
 import { RequestEventLoader } from '@qwik.dev/router/middleware/request-handler';
 import { RequestHandler } from '@qwik.dev/router/middleware/request-handler';
 import type { ResolveSyncValue } from '@qwik.dev/router/middleware/request-handler';
+import type { SerializationStrategy } from '@qwik.dev/core/internal';
 import type * as v from 'valibot';
 import type { ValueOrPromise } from '@qwik.dev/core';
+import { ValueOrPromise as ValueOrPromise_2 } from '@qwik.dev/core/internal';
 import { z } from 'zod';
 import type * as z_2 from 'zod';
@@ -188,6 +193,38 @@ export { CookieOptions }
 export { CookieValue }
+/**
+ * Creates the `render()` function that is required by `createQwikRouter()`. It requires a function
+ * that returns the `jsx` and `options` for the renderer.
+ *
+ * @example
+ *
+ * ```tsx
+ * const renderer = createRenderer((opts) => {
+ *   if (opts.requestHeaders['x-hello'] === 'world') {
+ *     return { jsx: <Hello />, options: opts };
+ *   }
+ *   return { jsx: <Root />, options: {
+ *     ...opts,
+ *     serverData: {
+ *       ...opts.serverData,
+ *       documentHead: {
+ *         meta: [
+ *           { name: 'renderedAt', content: new Date().toISOString() },
+ *         ],
+ *       },
+ *     },
+ *   } };
+ * });
+ * ```
+ *
+ * @public
+ */
+export declare const createRenderer: (getOptions: (options: RendererOptions) => {
+    jsx: JSXOutput_2;
+    options: RendererOutputOptions;
+}) => Render;
 /** @public */
 export declare type DataValidator<T extends Record<string, any> = {}> = {
     validate(ev: RequestEvent, data: unknown): Promise<ValidatorReturn<T>>;
@@ -209,18 +246,40 @@ export declare type DocumentHead = DocumentHeadValue | ((props: DocumentHeadProp
 /** @public */
 export declare interface DocumentHeadProps extends RouteLocation {
     readonly head: ResolvedDocumentHead;
+    /** @deprecated This is not necessary, it works correctly without */
     readonly withLocale: <T>(fn: () => T) => T;
     readonly resolveValue: ResolveSyncValue;
 }
+/**
+ * This renders all the tags collected from `head`.
+ *
+ * You can partially override the head, for example if you want to change the title:
+ *
+ * ```tsx
+ * import { DocumentHeadTags, useDocumentHead } from '@qwik.dev/router';
+ *
+ * export default component$(() => {
+ *   const head = useDocumentHead();
+ *   return <DocumentHeadTags title={`${head.title} - My App`} />;
+ * });
+ * ```
+ *
+ * You don't have to use this component, you can also do it yourself for full control. Just copy the
+ * code from this component and modify it to your needs.
+ *
+ * Note that this component normally only runs once, during SSR. You can use Signals in your
+ * `src/root.tsx` to make runtime changes to `<head>` if needed.
+ *
+ * @public
+ */
+export declare const DocumentHeadTags: Component<DocumentHeadValue<Record<string, unknown>>>;
 /** @public */
 export declare interface DocumentHeadValue<FrontMatter extends Record<string, any> = Record<string, unknown>> {
     /** Sets `document.title`. */
     readonly title?: string;
-    /**
-     * Used to manually set meta tags in the head. Additionally, the `data` property could be used to
-     * set arbitrary data which the `<head>` component could later use to generate `<meta>` tags.
-     */
+    /** Used to manually set meta tags in the head. */
     readonly meta?: readonly DocumentMeta[];
     /** Used to manually append `<link>` elements to the `<head>`. */
     readonly links?: readonly DocumentLink[];
@@ -237,53 +296,59 @@ export declare interface DocumentHeadValue<FrontMatter extends Record<string, an
 }
 /** @public */
-export declare interface DocumentLink {
-    as?: string;
-    crossorigin?: string;
-    disabled?: boolean;
-    href?: string;
-    hreflang?: string;
-    id?: string;
-    imagesizes?: string;
-    imagesrcset?: string;
-    integrity?: string;
-    media?: string;
-    prefetch?: string;
-    referrerpolicy?: string;
-    rel?: string;
-    sizes?: string;
-    title?: string;
-    type?: string;
-    key?: string;
-}
+export declare type DocumentLink = QwikIntrinsicElements['link'];
 /** @public */
-export declare interface DocumentMeta {
-    readonly content?: string;
-    readonly httpEquiv?: string;
-    readonly name?: string;
-    readonly property?: string;
-    readonly key?: string;
-    readonly itemprop?: string;
-    readonly media?: string;
-}
-/** @beta */
-export declare interface DocumentScript {
-    readonly script?: string;
-    readonly props?: Readonly<QwikIntrinsicElements['script']>;
-    readonly key?: string;
-}
+export declare type DocumentMeta = QwikIntrinsicElements['meta'];
 /** @public */
-export declare interface DocumentStyle {
-    readonly style: string;
-    readonly props?: Readonly<QwikIntrinsicElements['style']>;
-    readonly key?: string;
-}
+export declare type DocumentScript = ((Omit<QwikIntrinsicElements['script'], 'dangerouslySetInnerHTML'> & {
+    props?: never;
+}) | {
+    key?: string;
+    /**
+     * The props of the script element. @deprecated Prefer setting the properties directly instead
+     * of using this property.
+     */
+    props: Readonly<QwikIntrinsicElements['script']>;
+}) & ({
+    /** The inline script content. */
+    script?: string;
+    dangerouslySetInnerHTML?: never;
+} | {
+    dangerouslySetInnerHTML?: string;
+    script?: never;
+});
+/** @public */
+export declare type DocumentStyle = Readonly<((Omit<QwikIntrinsicElements['style'], 'dangerouslySetInnerHTML'> & {
+    props?: never;
+}) | {
+    key?: string;
+    /**
+     * The props of the style element. @deprecated Prefer setting the properties directly
+     * instead of using this property.
+     */
+    props: Readonly<QwikIntrinsicElements['style']>;
+}) & ({
+    /** The inline style content. */
+    style?: string;
+    dangerouslySetInnerHTML?: never;
+} | {
+    dangerouslySetInnerHTML?: string;
+    style?: never;
+})>;
 declare type EndpointModuleLoader = () => Promise<RouteModule>;
+declare interface EndpointResponse {
+    status: number;
+    loaders: Record<string, unknown>;
+    loadersSerializationStrategy: Map<string, SerializationStrategy>;
+    formData?: FormData;
+    action?: string;
+}
 /** @public */
 export declare const ErrorBoundary: Component<ErrorBoundaryProps>;
@@ -412,7 +477,7 @@ export declare interface LinkProps extends AnchorAttributes {
      *
      * This **improves UX performance** for client-side (**SPA**) navigations.
      *
-     * Prefetching occurs when a the Link enters the viewport in production (**`on:qvisible`**), or
+     * Prefetching occurs when a the Link enters the viewport in production (**`q-e:qvisible`**), or
      * with **`mouseover`/`focus`** during dev.
      *
      * Prefetching will not occur if the user has the **data saver** setting enabled.
@@ -426,6 +491,14 @@ export declare interface LinkProps extends AnchorAttributes {
     scroll?: boolean;
 }
+declare type LoadedRoute = [
+routeName: string,
+params: PathParams,
+mods: (RouteModule | ContentModule)[],
+menu: ContentMenu | undefined,
+routeBundleNames: string[] | undefined
+];
 /** @public */
 declare type Loader_2<RETURN> = {
     /**
@@ -450,11 +523,13 @@ declare type LoaderConstructorQRL = {
 /** @public */
 declare type LoaderOptions = {
-    id?: string;
+    readonly id?: string;
+    readonly validation?: DataValidator[];
+    readonly serializationStrategy?: SerializationStrategy;
 };
 /** @public */
-export declare type LoaderSignal<TYPE> = TYPE extends () => ValueOrPromise<infer VALIDATOR> ? ReadonlySignal<ValueOrPromise<VALIDATOR>> : ReadonlySignal<TYPE>;
+export declare type LoaderSignal<TYPE> = (TYPE extends () => ValueOrPromise<infer VALIDATOR> ? ReadonlySignal<ValueOrPromise<VALIDATOR>> : ReadonlySignal<TYPE>) & Pick<AsyncSignal, 'promise' | 'loading' | 'error'>;
 /** @public */
 export declare type MenuData = [pathname: string, menuLoader: MenuModuleLoader];
@@ -507,6 +582,9 @@ declare type Prettify<T> = {} & {
  */
 export declare type PreventNavigateCallback = (url?: number | URL) => ValueOrPromise<boolean>;
+/** @public */
+export declare const Q_ROUTE = "q:route";
 /**
  * @deprecated Use `QWIK_ROUTER_SCROLLER` instead (will be removed in V3)
  * @public
@@ -517,13 +595,7 @@ export declare const QWIK_CITY_SCROLLER = "_qCityScroller";
 export declare const QWIK_ROUTER_SCROLLER = "_qRouterScroller";
 /**
- * @deprecated Use `QwikRouterMockProps` instead. will be removed in V3
- * @public
- */
-export declare type QwikCityMockProps = QwikRouterMockProps;
-/**
- * @deprecated Use `QwikRouterMockProvider` instead. Will be removed in V3
+ * @deprecated Use `useQwikMockRouter()` instead. Will be removed in V3
  * @public
  */
 export declare const QwikCityMockProvider: Component<QwikRouterMockProps>;
@@ -535,13 +607,13 @@ export declare const QwikCityMockProvider: Component<QwikRouterMockProps>;
 export declare type QwikCityPlan = QwikRouterConfig;
 /**
- * @deprecated Use `QwikRouterProps` instead. will be removed in V3
+ * @deprecated Use `QwikRouterProps` instead. Will be removed in v3.
  * @public
  */
 export declare type QwikCityProps = QwikRouterProps;
 /**
- * @deprecated Use `QwikRouterProvider` instead. will be removed in V3
+ * @deprecated Use `useQwikRouter()` instead. Will be removed in v3.
  * @public
  */
 export declare const QwikCityProvider: Component<QwikRouterProps>;
@@ -556,11 +628,71 @@ export declare interface QwikRouterConfig {
     readonly cacheModules?: boolean;
 }
+/** @public */
+export declare interface QwikRouterEnvData {
+    routeName: string;
+    ev: RequestEvent;
+    params: PathParams;
+    response: EndpointResponse;
+    loadedRoute: LoadedRoute | null;
+}
+/** @public */
+export declare interface QwikRouterMockActionProp<T = any> {
+    /** The action function to mock. */
+    action: Action<T>;
+    /** The QRL function that will be called when the action is submitted. */
+    handler: QRL<(data: T) => ValueOrPromise_2<RouteActionResolver>>;
+}
+/** @public */
+export declare interface QwikRouterMockLoaderProp<T = any> {
+    /** The loader function to mock. */
+    loader: Loader_2<T>;
+    /** The data to return when the loader is called. */
+    data: T;
+}
 /** @public */
 export declare interface QwikRouterMockProps {
+    /**
+     * Allow mocking the url returned by `useLocation` hook.
+     *
+     * Default: `http://localhost/`
+     */
     url?: string;
+    /** Allow mocking the route params returned by `useLocation` hook. */
     params?: Record<string, string>;
+    /** Allow mocking the `goto` function returned by `useNavigate` hook. */
     goto?: RouteNavigate;
+    /**
+     * Allow mocking data for loaders defined with `routeLoader$` function.
+     *
+     * ```
+     * [
+     *   {
+     *     loader: useProductData,
+     *     data: { product: { name: 'Test Product' } },
+     *   },
+     * ];
+     * ```
+     */
+    loaders?: Array<QwikRouterMockLoaderProp<any>>;
+    /**
+     * Allow mocking actions defined with `routeAction$` function.
+     *
+     * ```
+     * [
+     *   {
+     *     action: useAddUser,
+     *     handler: $(async (data) => {
+     *       console.log('useAddUser action called with data:', data);
+     *     }),
+     *   },
+     * ];
+     * ```
+     */
+    actions?: Array<QwikRouterMockActionProp<any>>;
 }
 /** @public */
@@ -575,12 +707,12 @@ export declare interface QwikRouterProps {
      *
      * @see https://github.com/WICG/view-transitions/blob/main/explainer.md
      * @see https://developer.mozilla.org/en-US/docs/Web/API/View_Transitions_API
-     * @see https://caniuse.com/mdn-api_viewtransition
+     * @see https://caniuse.com/mdn_api_viewtransition
      */
     viewTransition?: boolean;
 }
-/** @public */
+/** @public This is a wrapper around the `useQwikRouter()` hook. We recommend using the hook instead of this component, unless you have a good reason to make your root component reactive. */
 export declare const QwikRouterProvider: Component<QwikRouterProps>;
 /** @public */
@@ -588,6 +720,18 @@ declare interface ReadonlySignal_2<T = unknown> {
     readonly value: T;
 }
+/** @public */
+export declare type RendererOptions = Omit<RenderOptions, 'serverData'> & {
+    serverData: ServerData;
+};
+/** @public */
+export declare type RendererOutputOptions = Omit<RenderOptions, 'serverData'> & {
+    serverData: ServerData & {
+        documentHead?: DocumentHeadValue;
+    } & Record<string, unknown>;
+};
 export { RequestEvent }
 export { RequestEventAction }
@@ -608,11 +752,21 @@ export declare const routeAction$: ActionConstructor;
 /* Excluded from this release type: routeActionQrl */
+declare type RouteActionResolver = {
+    status: number;
+    result: unknown;
+};
 /** @public */
-export declare type RouteData = [routeName: string, loaders: ModuleLoader[]] | [
+export declare type RouteData = [
+routeName: string,
+moduleLoaders: ModuleLoader[]
+] | [
 routeName: string,
-loaders: ModuleLoader[],
+moduleLoaders: ModuleLoader[],
+/** The actual src/routes pathname, not rewritten */
 originalPathname: string,
+/** The bundles that contain the loaders */
 routeBundleNames: string[]
 ];
@@ -662,6 +816,18 @@ declare interface ServerConfig {
     fetchOptions?: any;
 }
+/** @public The server data that is provided by Qwik Router during SSR rendering. It can be retrieved with `useServerData(key)` in the server, but it is not available in the client. */
+export declare type ServerData = {
+    url: string;
+    requestHeaders: Record<string, string>;
+    locale: string | undefined;
+    nonce: string | undefined;
+    containerAttributes: Record<string, string> & {
+        [Q_ROUTE]: string;
+    };
+    qwikrouter: QwikRouterEnvData;
+};
 /** @public */
 export declare type ServerFunction = {
     (this: RequestEventBase, ...args: any[]): any;
@@ -683,6 +849,12 @@ export declare type ServerQRL<T extends ServerFunction> = QRL<((abort: AbortSign
  * JS extensions are allowed) will be picked up, bundled into a separate file, and registered as a
  * service worker.
  *
+ * Qwik 1.14.0 and above now use `<link rel="modulepreload">` by default. If you didn't add custom
+ * service-worker logic, you should remove your service-worker.ts file(s) for the
+ * `ServiceWorkerRegister` Component to actually unregister the service-worker.js and delete its
+ * related cache. Make sure to keep the `ServiceWorkerRegister` Component in your app (without any
+ * service-worker.ts file) as long as you want to unregister the service-worker.js for your users.
+ *
  * @public
  */
 export declare const ServiceWorkerRegister: (props: {
@@ -785,6 +957,14 @@ export declare const usePreventNavigate$: (qrl: PreventNavigateCallback) => void
 /* Excluded from this release type: usePreventNavigateQrl */
+/**
+ * @public
+ * This hook initializes Qwik Router, providing the necessary context for it to work.
+ *
+ * This hook should be used once, at the root of your application.
+ */
+export declare const useQwikRouter: (props?: QwikRouterProps) => void;
 /** @beta */
 export declare const valibot$: ValibotConstructor;