@sitecore-content-sdk/nextjs 1.3.0-canary.9 → 1.4.0-canary.2

package/types/editing/codegen/index.d.ts

@@ -1,2 +1,3 @@
-export { defaultImportEntries, combineImportEntries } from './import-map';
-export { ImportEntry } from '@sitecore-content-sdk/core/codegen';
+export { defaultImportEntries, combineImportEntries } from './import-map';
+export { ImportEntry } from '@sitecore-content-sdk/core/codegen';
+//# sourceMappingURL=index.d.ts.map

package/types/editing/codegen/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/editing/codegen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC"}

package/types/editing/constants.d.ts

@@ -1,7 +1,8 @@
-export declare const QUERY_PARAM_VERCEL_PROTECTION_BYPASS = "x-vercel-protection-bypass";
-export declare const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = "x-vercel-set-bypass-cookie";
-/**
- * Headers that should be passed along to (Editing Chromes handler) SSR request.
- * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
- */
-export declare const EDITING_PASS_THROUGH_HEADERS: string[];
+export declare const QUERY_PARAM_VERCEL_PROTECTION_BYPASS = "x-vercel-protection-bypass";
+export declare const QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE = "x-vercel-set-bypass-cookie";
+/**
+ * Headers that should be passed along to (Editing Chromes handler) SSR request.
+ * Note these are in lowercase format to match expected `IncomingHttpHeaders`.
+ */
+export declare const EDITING_PASS_THROUGH_HEADERS: string[];
+//# sourceMappingURL=constants.d.ts.map

package/types/editing/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/editing/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oCAAoC,+BAA+B,CAAC;AACjF,eAAO,MAAM,oCAAoC,+BAA+B,CAAC;AAEjF;;;GAGG;AACH,eAAO,MAAM,4BAA4B,UAA8B,CAAC"}

package/types/editing/editing-config-middleware.d.ts

@@ -1,31 +1,37 @@
-import { NextApiRequest, NextApiResponse } from 'next';
-import { Metadata } from '@sitecore-content-sdk/core/editing';
-import { ComponentMap } from '@sitecore-content-sdk/react';
-import { NextjsContentSdkComponent } from '../sharedTypes/component-props';
-export type EditingConfigMiddlewareConfig = {
-    /**
-     * Components available in the application
-     */
-    components: ComponentMap<NextjsContentSdkComponent>;
-    /**
-     * Application metadata
-     */
-    metadata: Metadata;
-};
-/**
- * Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
- * provides configuration information to determine feature compatibility on Pages side.
- */
-export declare class EditingConfigMiddleware {
-    protected config: EditingConfigMiddlewareConfig;
-    /**
-     * @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
-     */
-    constructor(config: EditingConfigMiddlewareConfig);
-    /**
-     * Gets the Next.js API route handler
-     * @returns middleware handler
-     */
-    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
-    private handler;
-}
+import { NextApiRequest, NextApiResponse } from 'next';
+import { Metadata } from '@sitecore-content-sdk/core/editing';
+import { ComponentMap } from '@sitecore-content-sdk/react';
+import { NextjsContentSdkComponent } from '../sharedTypes/component-props';
+/**
+ * The interface for the EditingConfigMiddleware configuration.
+ * @public
+ */
+export type EditingConfigMiddlewareConfig = {
+    /**
+     * Components available in the application
+     */
+    components: ComponentMap<NextjsContentSdkComponent>;
+    /**
+     * Application metadata
+     */
+    metadata: Metadata;
+};
+/**
+ * Middleware / handler used in the editing config API route in xmcloud add on (e.g. '/api/editing/config')
+ * provides configuration information to determine feature compatibility on Pages side.
+ * @public
+ */
+export declare class EditingConfigMiddleware {
+    protected config: EditingConfigMiddlewareConfig;
+    /**
+     * @param {EditingConfigMiddlewareConfig} [config] Editing configuration middleware config
+     */
+    constructor(config: EditingConfigMiddlewareConfig);
+    /**
+     * Gets the Next.js API route handler
+     * @returns middleware handler
+     */
+    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    private handler;
+}
+//# sourceMappingURL=editing-config-middleware.d.ts.map

package/types/editing/editing-config-middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editing-config-middleware.d.ts","sourceRoot":"","sources":["../../src/editing/editing-config-middleware.ts"],"names":[],"mappings":"AAAC,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAMxD,OAAO,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAC;AAI9D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,yBAAyB,EAAE,MAAM,gCAAgC,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,UAAU,EAAE,YAAY,CAAC,yBAAyB,CAAC,CAAC;IACpD;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,qBAAa,uBAAuB;IAItB,SAAS,CAAC,MAAM,EAAE,6BAA6B;IAH3D;;OAEG;gBACmB,MAAM,EAAE,6BAA6B;IAE3D;;;OAGG;IACI,UAAU,IAAI,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC;IAIjF,OAAO,CAAC,OAAO,CAsCb;CACH"}

package/types/editing/editing-render-middleware.d.ts

@@ -1,44 +1,47 @@
-import { NextApiRequest, NextApiResponse } from 'next';
-import { EditingRenderQueryParams } from '@sitecore-content-sdk/core/editing';
-import { RenderMiddlewareBase } from './render-middleware';
-/**
- * Configuration for the Editing Render Middleware.
- */
-export type EditingRenderMiddlewareConfig = {
-    /**
-     * Function used to determine route/page URL to render.
-     * This may be necessary for certain custom Next.js routing configurations.
-     * @param {string} itemPath The Sitecore relative item path e.g. '/styleguide'
-     * @returns {string} The URL to render
-     * @default `${itemPath}`
-     */
-    resolvePageUrl?: (itemPath: string) => string;
-    /**
-     * The internal host URL for the Next.js application, used for server-side requests for page rendering during editing.
-     */
-    sitecoreInternalEditingHostUrl?: string;
-};
-/**
- * Next.js API request with editing request query parameters.
- */
-export type EditingNextApiRequest = NextApiRequest & {
-    query: EditingRenderQueryParams;
-};
-/**
- * Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
- * which is required for Sitecore editing support.
- */
-export declare class EditingRenderMiddleware extends RenderMiddlewareBase {
-    config?: EditingRenderMiddlewareConfig | undefined;
-    private dataFetcher;
-    /**
-     * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
-     */
-    constructor(config?: EditingRenderMiddlewareConfig | undefined);
-    /**
-     * Gets the Next.js API route handler
-     * @returns route handler
-     */
-    getHandler(): (req: EditingNextApiRequest, res: NextApiResponse) => Promise<void>;
-    private handler;
-}
+import { NextApiRequest, NextApiResponse } from 'next';
+import { EditingRenderQueryParams } from '@sitecore-content-sdk/core/editing';
+import { RenderMiddlewareBase } from './render-middleware';
+/**
+ * Configuration for the Editing Render Middleware.
+ * @public
+ */
+export type EditingRenderMiddlewareConfig = {
+    /**
+     * Function used to determine route/page URL to render.
+     * This may be necessary for certain custom Next.js routing configurations.
+     * @param {string} itemPath The Sitecore relative item path e.g. '/styleguide'
+     * @returns {string} The URL to render
+     * @default `${itemPath}`
+     */
+    resolvePageUrl?: (itemPath: string) => string;
+    /**
+     * The internal host URL for the Next.js application, used for server-side requests for page rendering during editing.
+     */
+    sitecoreInternalEditingHostUrl?: string;
+};
+/**
+ * Next.js API request with editing request query parameters.
+ */
+export type EditingNextApiRequest = NextApiRequest & {
+    query: EditingRenderQueryParams;
+};
+/**
+ * Middleware / handler for use in the editing render Next.js API route (e.g. '/api/editing/render')
+ * which is required for Sitecore editing support.
+ * @public
+ */
+export declare class EditingRenderMiddleware extends RenderMiddlewareBase {
+    config?: EditingRenderMiddlewareConfig | undefined;
+    private dataFetcher;
+    /**
+     * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
+     */
+    constructor(config?: EditingRenderMiddlewareConfig | undefined);
+    /**
+     * Gets the Next.js API route handler
+     * @returns route handler
+     */
+    getHandler(): (req: EditingNextApiRequest, res: NextApiResponse) => Promise<void>;
+    private handler;
+}
+//# sourceMappingURL=editing-render-middleware.d.ts.map

package/types/editing/editing-render-middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editing-render-middleware.d.ts","sourceRoot":"","sources":["../../src/editing/editing-render-middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAEvD,OAAO,EAIL,wBAAwB,EACzB,MAAM,oCAAoC,CAAC;AAG5C,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAc3D;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,CAAC;IAC9C;;OAEG;IACH,8BAA8B,CAAC,EAAE,MAAM,CAAC;CACzC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,cAAc,GAAG;IACnD,KAAK,EAAE,wBAAwB,CAAC;CACjC,CAAC;AAEF;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,oBAAoB;IAK5C,MAAM,CAAC,EAAE,6BAA6B;IAJzD,OAAO,CAAC,WAAW,CAAoB;IACvC;;OAEG;gBACgB,MAAM,CAAC,EAAE,6BAA6B,YAAA;IAKzD;;;OAGG;IACI,UAAU,IAAI,CAAC,GAAG,EAAE,qBAAqB,EAAE,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC;IAIxF,OAAO,CAAC,OAAO,CAoJb;CACH"}

package/types/editing/feaas-render-middleware.d.ts

@@ -1,32 +1,35 @@
-import { NextApiRequest, NextApiResponse } from 'next';
-import { RenderMiddlewareBase } from './render-middleware';
-/**
- * Configuration for `FEAASRenderMiddleware`.
- */
-export interface FEAASRenderMiddlewareConfig {
-    /**
-     * Defines FEAAS page route to render.
-     * This may be necessary for certain custom Next.js routing configurations.
-     * @default /feaas/render
-     */
-    pageUrl?: string;
-}
-/**
- * Middleware / handler for use in the feaas render Next.js API route (e.g. '/api/editing/feaas/render')
- * which is required for Sitecore editing support.
- */
-export declare class FEAASRenderMiddleware extends RenderMiddlewareBase {
-    protected config?: FEAASRenderMiddlewareConfig | undefined;
-    private pageUrl;
-    private defaultPageUrl;
-    /**
-     * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
-     */
-    constructor(config?: FEAASRenderMiddlewareConfig | undefined);
-    /**
-     * Gets the Next.js API route handler
-     * @returns route handler
-     */
-    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
-    private handler;
-}
+import { NextApiRequest, NextApiResponse } from 'next';
+import { RenderMiddlewareBase } from './render-middleware';
+/**
+ * Configuration for `FEAASRenderMiddleware`.
+ * @public
+ */
+export interface FEAASRenderMiddlewareConfig {
+    /**
+     * Defines FEAAS page route to render.
+     * This may be necessary for certain custom Next.js routing configurations.
+     * @default /feaas/render
+     */
+    pageUrl?: string;
+}
+/**
+ * Middleware / handler for use in the feaas render Next.js API route (e.g. '/api/editing/feaas/render')
+ * which is required for Sitecore editing support.
+ * @public
+ */
+export declare class FEAASRenderMiddleware extends RenderMiddlewareBase {
+    protected config?: FEAASRenderMiddlewareConfig | undefined;
+    private pageUrl;
+    private defaultPageUrl;
+    /**
+     * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
+     */
+    constructor(config?: FEAASRenderMiddlewareConfig | undefined);
+    /**
+     * Gets the Next.js API route handler
+     * @returns route handler
+     */
+    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    private handler;
+}
+//# sourceMappingURL=feaas-render-middleware.d.ts.map

package/types/editing/feaas-render-middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feaas-render-middleware.d.ts","sourceRoot":"","sources":["../../src/editing/feaas-render-middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAQvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAG3D;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,oBAAoB;IAOjD,SAAS,CAAC,MAAM,CAAC,EAAE,2BAA2B;IAN1D,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,cAAc,CAAmB;IAEzC;;OAEG;gBACmB,MAAM,CAAC,EAAE,2BAA2B,YAAA;IAM1D;;;OAGG;IACI,UAAU,IAAI,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC;IAIjF,OAAO,CAAC,OAAO,CAiFb;CACH"}

package/types/editing/index.d.ts

@@ -1,6 +1,7 @@
-export { EditingService } from '@sitecore-content-sdk/core/editing';
-export { EditingRenderMiddleware, EditingRenderMiddlewareConfig, } from './editing-render-middleware';
-export { isDesignLibraryPreviewData, getQueryParamsForPropagation, getHeadersForPropagation, } from './utils';
-export { FEAASRenderMiddleware, FEAASRenderMiddlewareConfig } from './feaas-render-middleware';
-export { EditingConfigMiddleware, EditingConfigMiddlewareConfig, } from './editing-config-middleware';
-export { RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-content-sdk/core/layout';
+export { EditingService } from '@sitecore-content-sdk/core/editing';
+export { EditingRenderMiddleware, EditingRenderMiddlewareConfig, } from './editing-render-middleware';
+export { isDesignLibraryPreviewData, getQueryParamsForPropagation, getHeadersForPropagation, } from './utils';
+export { FEAASRenderMiddleware, FEAASRenderMiddlewareConfig } from './feaas-render-middleware';
+export { EditingConfigMiddleware, EditingConfigMiddlewareConfig, } from './editing-config-middleware';
+export { RenderingType, EDITING_COMPONENT_PLACEHOLDER, EDITING_COMPONENT_ID, } from '@sitecore-content-sdk/core/layout';
+//# sourceMappingURL=index.d.ts.map

package/types/editing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/editing/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EACL,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,0BAA0B,EAC1B,4BAA4B,EAC5B,wBAAwB,GACzB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,qBAAqB,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AAC/F,OAAO,EACL,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EACL,aAAa,EACb,6BAA6B,EAC7B,oBAAoB,GACrB,MAAM,mCAAmC,CAAC"}

package/types/editing/render-middleware.d.ts

@@ -1,25 +1,26 @@
-import { IncomingHttpHeaders } from 'http';
-/**
- * Base class for middleware that handles pages and components rendering in Sitecore Editors.
- * @deprecated getQueryParamsForPropagation and getHeadersForPropagation methods have been moved to separate exports
- */
-export declare abstract class RenderMiddlewareBase {
-    /**
-     * Gets query parameters that should be passed along to subsequent requests (e.g. for deployment protection bypass)
-     * @param {object} query Object of query parameters from incoming URL
-     * @returns Object of approved query parameters
-     */
-    protected getQueryParamsForPropagation: (query: Partial<{
-        [key: string]: string | string[];
-    }>) => {
-        [key: string]: string;
-    };
-    /**
-     * Get headers that should be passed along to subsequent requests
-     * @param {IncomingHttpHeaders} headers Incoming HTTP Headers
-     * @returns Object of approved headers
-     */
-    protected getHeadersForPropagation: (headers: IncomingHttpHeaders | Headers) => {
-        [key: string]: string;
-    };
-}
+import { IncomingHttpHeaders } from 'http';
+/**
+ * Base class for middleware that handles pages and components rendering in Sitecore Editors.
+ * @internal
+ */
+export declare abstract class RenderMiddlewareBase {
+    /**
+     * Gets query parameters that should be passed along to subsequent requests (e.g. for deployment protection bypass)
+     * @param {object} query Object of query parameters from incoming URL
+     * @returns Object of approved query parameters
+     */
+    protected getQueryParamsForPropagation: (query: Partial<{
+        [key: string]: string | string[];
+    }>) => {
+        [key: string]: string;
+    };
+    /**
+     * Get headers that should be passed along to subsequent requests
+     * @param {IncomingHttpHeaders} headers Incoming HTTP Headers
+     * @returns Object of approved headers
+     */
+    protected getHeadersForPropagation: (headers: IncomingHttpHeaders | Headers) => {
+        [key: string]: string;
+    };
+}
+//# sourceMappingURL=render-middleware.d.ts.map

package/types/editing/render-middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"render-middleware.d.ts","sourceRoot":"","sources":["../../src/editing/render-middleware.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAE3C;;;GAGG;AACH,8BAAsB,oBAAoB;IACxC;;;;OAIG;IACH,SAAS,CAAC,4BAA4B,GACpC,OAAO,OAAO,CAAC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;KAAE,CAAC,KACnD;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAa1B;IAEF;;;;OAIG;IACH,SAAS,CAAC,wBAAwB,GAChC,SAAS,mBAAmB,GAAG,OAAO,KACrC;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAa1B;CACH"}

package/types/editing/utils.d.ts

@@ -1,106 +1,110 @@
-import { DesignLibraryRenderPreviewData, EditingRenderQueryParams } from '@sitecore-content-sdk/core/editing';
-import { NextApiRequest } from 'next';
-import { NextRequest } from 'next/server';
-import { IncomingHttpHeaders } from 'http';
-import { NativeDataFetcher } from '@sitecore-content-sdk/core';
-/**
- * Gets editing secret value from request
- * @param {NextApiRequest | NextRequest} req incoming request
- * @returns {string | undefined} editing secret value if present
- */
-export declare const getEditingSecretFromRequest: (req: NextApiRequest | NextRequest) => string | string[] | null | undefined;
-/**
- * Parses query string and its parameters to required editing parameters
- * @param {{ [key: string]: string | undefined }} query query string values
- * @returns {EditingRenderQueryParams} editing parameters
- */
-export declare const mapEditingParams: (query: {
-    [key: string]: string | undefined;
-}) => {
-    [key: string]: string | undefined;
-};
-/**
- * Next.js preview cookies enum
- */
-export declare const enum PreviewCookies {
-    PREVIEW_DATA = "__next_preview_data",
-    PRERENDER_BYPASS = "__prerender_bypass"
-}
-/**
- * Filters out Next.js preview cookies from a cookie string or array
- * @param {string | string[] | null} cookies cookie header value
- * @returns {string[] | null} filtered cookies
- */
-export declare const cleanupNextPreviewCookies: (cookies: string | string[] | null) => string[] | null;
-/**
- * Gets the Next.js preview cookies to enable preview mode
- * @param {string} site current site name
- * @returns {string[]} list of cookies to set
- */
-export declare const getPreviewCookies: (site: string) => string[];
-/**
- * Returns the list of required query parameters based on the page editing mode
- * @param {DesignLibraryMode | LayoutServicePageState.Preview | LayoutServicePageState.Edit} mode current page mode
- * @returns {string[]} list of required parameters for validation
- */
-export declare const getRequiredEditingParamsList: (mode: EditingRenderQueryParams["mode"]) => string[];
-/**
- * Gets query parameters that should be passed along to subsequent requests (e.g. for deployment protection bypass)
- * @param {object} query Object of query parameters from incoming URL
- * @returns Object of approved query parameters
- */
-export declare const getQueryParamsForPropagation: (query: Partial<{
-    [key: string]: string | string[];
-}>) => {
-    [key: string]: string;
-};
-/**
- * Get headers that should be passed along to subsequent requests
- * @param {IncomingHttpHeaders} headers Incoming HTTP Headers
- * @returns Object of approved headers
- */
-export declare const getHeadersForPropagation: (headers: IncomingHttpHeaders | Headers) => {
-    [key: string]: string;
-};
-/**
- * Performs an internal request to get the HTML for the editing mode
- * @param {string} requestUrl URL to send request to
- * @param {object} propagatedQsParams query string params to use with request
- * @param {object} propagatedHeaders headers to use with request
- * @param {string[]} cookies cookies to use with request
- * @param {NativeDataFetcher} dataFetcher NativeFetcher instance to send request with
- * @returns {string} HTML with editing markup
- */
-export declare const getEditingRequestHtml: (requestUrl: URL, propagatedQsParams: {
-    [key: string]: string | undefined;
-}, propagatedHeaders: {
-    [key: string]: string;
-}, cookies: string[], dataFetcher: NativeDataFetcher) => Promise<string>;
-/**
- * Type guard for Design Library mode
- * @param {object} data preview data to check
- * @returns true if the data is EditingPreviewData
- * @see EditingPreviewData
- */
-export declare const isDesignLibraryPreviewData: (data: unknown) => data is DesignLibraryRenderPreviewData;
-/**
- * Server URL Resolution order (highest to lowest priority):
- * 1. `config.sitecoreInternalEditingHostUrl` (explicitly set in config)
- * 2. Environment variable `SITECORE_INTERNAL_EDITING_HOST_URL`
- * 3. Fallbacks:
- *    - For XM Cloud deployments → `'http://localhost:3000'`
- *    - For all other cases → use the request `Host` header
- * Note we use https protocol on Vercel due to serverless function architecture.
- * In all other scenarios, including localhost (with or without a proxy e.g. ngrok)
- * and within a nodejs container, http protocol should be used.
- *
- * For information about the VERCEL environment variable, see
- * https://vercel.com/docs/environment-variables#system-environment-variables
- * @param {NextApiRequest} req
- */
-export declare const resolveServerUrl: (req: NextApiRequest | NextRequest) => string;
-/**
- * Gets the Content-Security-Policy header value
- * @returns Content-Security-Policy header value
- */
-export declare const getCSPHeader: () => string;
+import { DesignLibraryRenderPreviewData, EditingRenderQueryParams } from '@sitecore-content-sdk/core/editing';
+import { NextApiRequest } from 'next';
+import { NextRequest } from 'next/server';
+import { IncomingHttpHeaders } from 'http';
+import { NativeDataFetcher } from '@sitecore-content-sdk/core';
+/**
+ * Gets editing secret value from request
+ * @param {NextApiRequest | NextRequest} req incoming request
+ * @returns {string | undefined} editing secret value if present
+ */
+export declare const getEditingSecretFromRequest: (req: NextApiRequest | NextRequest) => string | string[] | null | undefined;
+/**
+ * Parses query string and its parameters to required editing parameters
+ * @param {{ [key: string]: string | undefined }} query query string values
+ * @returns {EditingRenderQueryParams} editing parameters
+ */
+export declare const mapEditingParams: (query: {
+    [key: string]: string | undefined;
+}) => {
+    [key: string]: string | undefined;
+};
+/**
+ * Next.js preview cookies enum
+ */
+export declare const enum PreviewCookies {
+    PREVIEW_DATA = "__next_preview_data",
+    PRERENDER_BYPASS = "__prerender_bypass"
+}
+/**
+ * Filters out Next.js preview cookies from a cookie string or array
+ * @param {string | string[] | null} cookies cookie header value
+ * @returns {string[] | null} filtered cookies
+ */
+export declare const cleanupNextPreviewCookies: (cookies: string | string[] | null) => string[] | null;
+/**
+ * Gets the Next.js preview cookies to enable preview mode
+ * @param {string} site current site name
+ * @returns {string[]} list of cookies to set
+ */
+export declare const getPreviewCookies: (site: string) => string[];
+/**
+ * Returns the list of required query parameters based on the page editing mode
+ * @param {DesignLibraryMode | LayoutServicePageState.Preview | LayoutServicePageState.Edit} mode current page mode
+ * @returns {string[]} list of required parameters for validation
+ */
+export declare const getRequiredEditingParamsList: (mode: EditingRenderQueryParams["mode"]) => string[];
+/**
+ * Gets query parameters that should be passed along to subsequent requests (e.g. for deployment protection bypass)
+ * @param {object} query Object of query parameters from incoming URL
+ * @returns Object of approved query parameters
+ * @internal
+ */
+export declare const getQueryParamsForPropagation: (query: Partial<{
+    [key: string]: string | string[];
+}>) => {
+    [key: string]: string;
+};
+/**
+ * Get headers that should be passed along to subsequent requests
+ * @param {IncomingHttpHeaders} headers Incoming HTTP Headers
+ * @returns Object of approved headers
+ * @internal
+ */
+export declare const getHeadersForPropagation: (headers: IncomingHttpHeaders | Headers) => {
+    [key: string]: string;
+};
+/**
+ * Performs an internal request to get the HTML for the editing mode
+ * @param {string} requestUrl URL to send request to
+ * @param {object} propagatedQsParams query string params to use with request
+ * @param {object} propagatedHeaders headers to use with request
+ * @param {string[]} cookies cookies to use with request
+ * @param {NativeDataFetcher} dataFetcher NativeFetcher instance to send request with
+ * @returns {string} HTML with editing markup
+ */
+export declare const getEditingRequestHtml: (requestUrl: URL, propagatedQsParams: {
+    [key: string]: string | undefined;
+}, propagatedHeaders: {
+    [key: string]: string;
+}, cookies: string[], dataFetcher: NativeDataFetcher) => Promise<string>;
+/**
+ * Type guard for Design Library mode
+ * @param {object} data preview data to check
+ * @returns true if the data is EditingPreviewData
+ * @see EditingPreviewData
+ * @public
+ */
+export declare const isDesignLibraryPreviewData: (data: unknown) => data is DesignLibraryRenderPreviewData;
+/**
+ * Server URL Resolution order (highest to lowest priority):
+ * 1. `config.sitecoreInternalEditingHostUrl` (explicitly set in config)
+ * 2. Environment variable `SITECORE_INTERNAL_EDITING_HOST_URL`
+ * 3. Fallbacks:
+ *    - For XM Cloud deployments → `'http://localhost:3000'`
+ *    - For all other cases → use the request `Host` header
+ * Note we use https protocol on Vercel due to serverless function architecture.
+ * In all other scenarios, including localhost (with or without a proxy e.g. ngrok)
+ * and within a nodejs container, http protocol should be used.
+ *
+ * For information about the VERCEL environment variable, see
+ * https://vercel.com/docs/environment-variables#system-environment-variables
+ * @param {NextApiRequest} req
+ */
+export declare const resolveServerUrl: (req: NextApiRequest | NextRequest) => string;
+/**
+ * Gets the Content-Security-Policy header value
+ * @returns Content-Security-Policy header value
+ */
+export declare const getCSPHeader: () => string;
+//# sourceMappingURL=utils.d.ts.map

package/types/editing/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/editing/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,8BAA8B,EAE9B,wBAAwB,EAIzB,MAAM,oCAAoC,CAAC;AAG5C,OAAO,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAM1C,OAAO,EAAE,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAE3C,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAG/D;;;;GAIG;AACH,eAAO,MAAM,2BAA2B,GAAI,KAAK,cAAc,GAAG,WAAW,yCAgB5E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO;IACtC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACnC,KAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAyBtC,CAAC;AAEF;;GAEG;AACH,0BAAkB,cAAc;IAC9B,YAAY,wBAAwB;IACpC,gBAAgB,uBAAuB;CACxC;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB,GAAI,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,oBAc1E,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,aAI7C,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,GAAI,MAAM,wBAAwB,CAAC,MAAM,CAAC,aAYlF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,4BAA4B,GACvC,OAAO,OAAO,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,CAAA;CAAE,CAAC,KACnD;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAazB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,GACnC,SAAS,mBAAmB,GAAG,OAAO,KACrC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAazB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,YAAY,GAAG,EACf,oBAAoB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE,EACzD,mBAAmB;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,EAC5C,SAAS,MAAM,EAAE,EACjB,aAAa,iBAAiB,KAC7B,OAAO,CAAC,MAAM,CAgDhB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,GACrC,MAAM,OAAO,KACZ,IAAI,IAAI,8BAOV,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,cAAc,GAAG,WAAW,WAkBjE,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,cAIxB,CAAC"}