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

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

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} +362 -564
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 +701 -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 +589 -664
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/middleware/request-handler/index.d.ts CHANGED Viewed

@@ -1,24 +1,27 @@
 import type { Action } from '@qwik.dev/router';
-import type { _deserialize } from '@qwik.dev/core/internal';
+import type { AsyncLocalStorage } from 'node:async_hooks';
 import type { EnvGetter as EnvGetter_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { FailReturn } from '@qwik.dev/router';
 import type { Loader as Loader_2 } from '@qwik.dev/router';
 import type { QwikCityPlan } from '@qwik.dev/router';
 import type { QwikIntrinsicElements } from '@qwik.dev/core';
 import type { QwikRouterConfig } from '@qwik.dev/router';
+import { RedirectMessage as RedirectMessage_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { Render } from '@qwik.dev/core/server';
 import type { RenderOptions } from '@qwik.dev/core/server';
 import { RequestEvent as RequestEvent_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { RequestHandler as RequestHandler_2 } from '@qwik.dev/router/middleware/request-handler';
 import type { ResolveSyncValue as ResolveSyncValue_2 } from '@qwik.dev/router/middleware/request-handler';
-import type { _serialize } from '@qwik.dev/core/internal';
+import { SerializationStrategy } from '@qwik.dev/core/internal';
 import type { ValueOrPromise } from '@qwik.dev/core';
-import type { _verifySerializable } from '@qwik.dev/core/internal';
 /** @public */
 export declare class AbortMessage {
 }
+/** @internal */
+export declare let _asyncRequestStore: AsyncLocalStorage<RequestEventInternal> | undefined;
 /** @public */
 export declare type CacheControl = CacheControlOptions | number | 'day' | 'week' | 'month' | 'year' | 'no-cache' | 'immutable' | 'private';
@@ -206,6 +209,7 @@ declare type DocumentHead = DocumentHeadValue | ((props: DocumentHeadProps) => D
 /** @public */
 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_2;
 }
@@ -214,10 +218,7 @@ declare interface DocumentHeadProps extends RouteLocation {
 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[];
@@ -234,50 +235,48 @@ declare interface DocumentHeadValue<FrontMatter extends Record<string, any> = Re
 }
 /** @public */
-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;
-}
+declare type DocumentLink = QwikIntrinsicElements['link'];
 /** @public */
-declare interface DocumentMeta {
-    readonly content?: string;
-    readonly httpEquiv?: string;
-    readonly name?: string;
-    readonly property?: string;
-    readonly key?: string;
-    readonly itemprop?: string;
-    readonly media?: string;
-}
+declare type DocumentMeta = QwikIntrinsicElements['meta'];
-/** @beta */
-declare interface DocumentScript {
-    readonly script?: string;
-    readonly props?: Readonly<QwikIntrinsicElements['script']>;
-    readonly key?: string;
-}
+/** @public */
+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 */
-declare interface DocumentStyle {
-    readonly style: string;
-    readonly props?: Readonly<QwikIntrinsicElements['style']>;
-    readonly key?: string;
-}
+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;
+})>;
 /** @public */
 export declare interface EnvGetter {
@@ -289,12 +288,26 @@ declare type ErrorCodes = ClientErrorCode | ServerErrorCode;
 /** @public */
 export declare function getErrorHtml(status: number, e: any): string;
+/**
+ * Return the HTML for a 404 page.
+ *
+ * @internal
+ */
+export declare function getNotFound(prefix: string): string;
 /**
  * HTTP Informational Status Codes Status codes in the 1xx range indicate that the server has
  * received and is processing the request, but no response is available yet.
  */
 declare type InformationalCode = 100 | 101 | 102 | 103;
+/**
+ * Decide whether a given request path is a static path, for optimizing file access.
+ *
+ * @internal
+ */
+export declare function isStaticPath(method: string, url: URL): boolean;
 declare interface LayoutModule extends RouteModule {
     readonly default: unknown;
     readonly head?: ContentModuleHead;
@@ -323,16 +336,21 @@ declare interface PageModule extends RouteModule {
 declare type PathParams = Record<string, string>;
 declare interface QwikRouterRun<T> {
+    /**
+     * The response to the request, if any. If there is no response, there might have been an error,
+     * or the request was aborted.
+     */
     response: Promise<T | null>;
     requestEv: RequestEvent_2;
-    completion: Promise<unknown>;
-}
-/** @public */
-declare interface QwikSerializer {
-    _deserialize: typeof _deserialize;
-    _serialize: typeof _serialize;
-    _verifySerializable: typeof _verifySerializable;
+    /**
+     * Promise for the completion of the request.
+     *
+     * If it returns a RedirectMessage, it means the request must be redirected.
+     *
+     * If it returns an Error, it means there was an error, and if possible, the response already
+     * includes the error. The error is informational only.
+     */
+    completion: Promise<RedirectMessage_2 | Error | undefined>;
 }
 /**
@@ -528,12 +546,11 @@ export declare interface RequestEventCommon<PLATFORM = QwikRouterPlatform> exten
     readonly exit: () => AbortMessage;
 }
-declare interface RequestEventInternal extends RequestEvent, RequestEventLoader {
-    [RequestEvLoaders]: Record<string, ValueOrPromise<unknown> | undefined>;
-    [RequestEvMode]: ServerRequestMode;
-    [RequestEvTrailingSlash]: boolean;
-    [RequestEvRoute]: LoadedRoute | null;
-    [RequestEvQwikSerializer]: QwikSerializer;
+declare interface RequestEventInternal extends Readonly<RequestEvent>, Readonly<RequestEventLoader> {
+    readonly [RequestEvLoaders]: Record<string, ValueOrPromise<unknown> | undefined>;
+    readonly [RequestEvLoaderSerializationStrategyMap]: Map<string, SerializationStrategy>;
+    readonly [RequestEvMode]: ServerRequestMode;
+    readonly [RequestEvRoute]: LoadedRoute | null;
     /**
      * Check if this request is already written to.
      *
@@ -558,37 +575,38 @@ export declare interface RequestEventLoader<PLATFORM = QwikRouterPlatform> exten
 declare const RequestEvLoaders: unique symbol;
-declare const RequestEvMode: unique symbol;
+declare const RequestEvLoaderSerializationStrategyMap: unique symbol;
-declare const RequestEvQwikSerializer: unique symbol;
+declare const RequestEvMode: unique symbol;
 declare const RequestEvRoute: unique symbol;
-declare const RequestEvTrailingSlash: unique symbol;
+/** @internal */
+export declare const RequestEvShareQData = "qData";
 /** @public */
 export declare type RequestHandler<PLATFORM = QwikRouterPlatform> = (ev: RequestEvent<PLATFORM>) => Promise<void> | void;
 /**
- * The request handler for QwikRouter. Called by every integration.
+ * The request handler for QwikRouter. Called by every adapter.
  *
  * @public
  */
-export declare function requestHandler<T = unknown>(serverRequestEv: ServerRequestEvent<T>, opts: ServerRenderOptions, qwikSerializer: QwikSerializer): Promise<QwikRouterRun<T> | null>;
+export declare function requestHandler<T = unknown>(serverRequestEv: ServerRequestEvent<T>, opts: ServerRenderOptions): Promise<QwikRouterRun<T> | null>;
 /** @public */
 declare type ResolvedDocumentHead<FrontMatter extends Record<string, any> = Record<string, unknown>> = Required<DocumentHeadValue<FrontMatter>>;
 /** @public */
 export declare interface ResolveSyncValue {
+    <T, INPUT, OPTIONAL extends boolean>(action: Action<T, INPUT, OPTIONAL>): Awaited<T> | undefined;
     <T>(loader: Loader_2<T>): Awaited<T> extends () => any ? never : Awaited<T>;
-    <T>(action: Action<T>): Awaited<T> | undefined;
 }
 /** @public */
 export declare interface ResolveValue {
+    <T, INPUT, OPTIONAL extends boolean>(action: Action<T, INPUT, OPTIONAL>): Promise<T | undefined>;
     <T>(loader: Loader_2<T>): Awaited<T> extends () => any ? never : Promise<T>;
-    <T>(action: Action<T>): Promise<T | undefined>;
 }
 /** @public */
@@ -638,20 +656,21 @@ declare type ServerErrorCode = 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 5
 /** @public */
 export declare interface ServerRenderOptions extends RenderOptions {
     render: Render;
-    /** @deprecated Use `QwikRouterConfig` instead. Will be removed in V3 */
+    /** @deprecated Not used */
     qwikCityPlan?: QwikCityPlan;
+    /** @deprecated Not used */
     qwikRouterConfig?: QwikRouterConfig;
     /**
      * Protection against cross-site request forgery (CSRF) attacks.
      *
      * When `true`, for every incoming POST, PUT, PATCH, or DELETE form submissions, the request
-     * origin is checked to match the server's origin.
+     * origin is checked to match the server's origin. `lax-proto` is for SSL-terminating proxies
      *
      * Be careful when disabling this option as it may lead to CSRF attacks.
      *
      * Defaults to `true`.
      */
-    checkOrigin?: boolean;
+    checkOrigin?: boolean | 'lax-proto';
 }
 /**