@uniformdev/next-app-router 20.7.1-alpha.118

package/dist/middleware.d.mts

@@ -0,0 +1,70 @@
+import { Quirks } from '@uniformdev/context';
+import { PageState, RewriteRequestPathResult } from '@uniformdev/next-app-router-shared';
+import { NextRequest, NextResponse } from 'next/server';
+import { D as DataClient } from './client-BCGVjYM-.mjs';
+import '@uniformdev/canvas';
+
+type RewriteOptions = {
+    source: 'route' | 'playground';
+    /**
+     * The code that was generated from the evaluated composition.
+     */
+    code: string;
+    /**
+     * The page state that was generated from the evaluated composition.
+     */
+    pageState: PageState;
+};
+type RewriteRequestPathOptions = {
+    url: URL;
+    request: Request;
+};
+type RequestInfo = Pick<NextRequest, 'nextUrl' | 'cookies'>;
+type HandleOptions = {
+    /**
+     * If provided, the rewrite function will be called with the request.
+     * The function should return the desired route path to be resolved via Uniform Route API.
+     */
+    rewriteRequestPath?: (options: RewriteRequestPathOptions) => Promise<RewriteRequestPathResult | undefined>;
+    /**
+     * If provided, the rewrite function will be called with the route and code.
+     * The function should return the path to rewrite to.
+     */
+    rewriteDestinationPath?: (options: RewriteOptions) => Promise<string>;
+    /**
+     * If provided, the middleware will only precompute the runnables for the paths that match the patterns.
+     */
+    pathPatternsWithVariations?: string[];
+    /**
+     * If provided, the middleware will use the data client to retrieve data.
+     */
+    dataClient?: DataClient;
+    /**
+     * Release ID to resolve the route from.
+     */
+    release?: {
+        /**
+         * The release ID to resolve the route from.
+         */
+        id: string;
+    };
+    /**
+     * If provided, the middleware will use the quirks to update the context.
+     */
+    quirks?: Quirks;
+    /**
+     * If provided, the middleware will use this value for defaultConsent on Context.
+     * If not provided, middleware will use the server config default consent or false if not set.
+     */
+    defaultConsent?: boolean | undefined;
+};
+declare const uniformMiddleware: (options?: HandleOptions) => (request: NextRequest) => Promise<NextResponse<unknown>>;
+declare const handleUniformRoute: ({ request, dataClient, ...options }: HandleOptions & {
+    request: NextRequest;
+}) => Promise<NextResponse<unknown>>;
+declare const determinePreviewMode: ({ searchParams, isDraftModeEnabled, }: {
+    searchParams: URLSearchParams;
+    isDraftModeEnabled: boolean;
+}) => "preview" | "editor" | undefined;
+
+export { type HandleOptions, type RequestInfo, type RewriteOptions, type RewriteRequestPathOptions, determinePreviewMode, handleUniformRoute, uniformMiddleware };

package/dist/middleware.d.ts

@@ -0,0 +1,70 @@
+import { Quirks } from '@uniformdev/context';
+import { PageState, RewriteRequestPathResult } from '@uniformdev/next-app-router-shared';
+import { NextRequest, NextResponse } from 'next/server';
+import { D as DataClient } from './client-BCGVjYM-.js';
+import '@uniformdev/canvas';
+
+type RewriteOptions = {
+    source: 'route' | 'playground';
+    /**
+     * The code that was generated from the evaluated composition.
+     */
+    code: string;
+    /**
+     * The page state that was generated from the evaluated composition.
+     */
+    pageState: PageState;
+};
+type RewriteRequestPathOptions = {
+    url: URL;
+    request: Request;
+};
+type RequestInfo = Pick<NextRequest, 'nextUrl' | 'cookies'>;
+type HandleOptions = {
+    /**
+     * If provided, the rewrite function will be called with the request.
+     * The function should return the desired route path to be resolved via Uniform Route API.
+     */
+    rewriteRequestPath?: (options: RewriteRequestPathOptions) => Promise<RewriteRequestPathResult | undefined>;
+    /**
+     * If provided, the rewrite function will be called with the route and code.
+     * The function should return the path to rewrite to.
+     */
+    rewriteDestinationPath?: (options: RewriteOptions) => Promise<string>;
+    /**
+     * If provided, the middleware will only precompute the runnables for the paths that match the patterns.
+     */
+    pathPatternsWithVariations?: string[];
+    /**
+     * If provided, the middleware will use the data client to retrieve data.
+     */
+    dataClient?: DataClient;
+    /**
+     * Release ID to resolve the route from.
+     */
+    release?: {
+        /**
+         * The release ID to resolve the route from.
+         */
+        id: string;
+    };
+    /**
+     * If provided, the middleware will use the quirks to update the context.
+     */
+    quirks?: Quirks;
+    /**
+     * If provided, the middleware will use this value for defaultConsent on Context.
+     * If not provided, middleware will use the server config default consent or false if not set.
+     */
+    defaultConsent?: boolean | undefined;
+};
+declare const uniformMiddleware: (options?: HandleOptions) => (request: NextRequest) => Promise<NextResponse<unknown>>;
+declare const handleUniformRoute: ({ request, dataClient, ...options }: HandleOptions & {
+    request: NextRequest;
+}) => Promise<NextResponse<unknown>>;
+declare const determinePreviewMode: ({ searchParams, isDraftModeEnabled, }: {
+    searchParams: URLSearchParams;
+    isDraftModeEnabled: boolean;
+}) => "preview" | "editor" | undefined;
+
+export { type HandleOptions, type RequestInfo, type RewriteOptions, type RewriteRequestPathOptions, determinePreviewMode, handleUniformRoute, uniformMiddleware };