@sitecore-jss/sitecore-jss-nextjs 21.7.0-canary.7 → 21.7.0-canary.70

package/types/revalidate/revalidate-middleware.d.ts

@@ -0,0 +1,115 @@
+import { NextApiResponse, NextApiRequest } from 'next';
+import { GraphQLRequestClientFactory } from '@sitecore-jss/sitecore-jss/graphql';
+declare enum EntityDefinition {
+    LayoutData = "LayoutData",
+    Item = "Item"
+}
+/**
+ * Object model of each updated entity returned from the webhook payload
+ */
+export type Entity = {
+    identifier: string;
+    entity_definition: EntityDefinition;
+    operation: string;
+    entity_culture: string;
+};
+/**
+ * Object model for updated paths returned from the webhook payload
+ */
+export type UpdatedPaths = {
+    path: string;
+    language: string;
+};
+/**
+ *  Object model for personalized results from GraphqlPersonalizeService
+ */
+export type PersonalizedResult = {
+    path: string;
+    variantId: string;
+};
+export type RevalidateConfig = {
+    /**
+     * A GraphQL Request Client Factory is a function that accepts configuration and returns an instance of a GraphQLRequestClient.
+     * This factory function is used to create and configure GraphQL clients for making GraphQL API requests.
+     */
+    clientFactory: GraphQLRequestClientFactory;
+    /**
+     * Indicates whether multisite functionality is enabled.
+     * Default is false
+     */
+    multiSite?: boolean;
+    /**
+     * Indicates whether personalization is enabled.
+     * Default is false
+     */
+    personalize?: boolean;
+    /**
+     * Function to handle language prefixes for different locales.
+     * @param language - The language to generate the prefix for.
+     * @returns The language prefix or null.
+     */
+    localePrefix?: (language: string) => string | null;
+};
+/**
+ * Middleware / handler for on-demand ISR (e.g. '/api/revalidate').
+ */
+export declare class RevalidateMiddleware {
+    protected config: RevalidateConfig;
+    private personalizeService;
+    constructor(config: RevalidateConfig);
+    /**
+     * Generates a Next.js API route handler that executes a revalidation process.
+     * @returns The route handler function for handling Next.js API requests.
+     */
+    getHandler(): (req: NextApiRequest, res: NextApiResponse) => Promise<void>;
+    /**
+     * Gets personalized results for the updated paths
+     * @param {UpdatedPaths[]} filteredUpdates Updated paths
+     */
+    getPersonalizedResults(filteredUpdates: UpdatedPaths[]): Promise<{
+        personalized: PersonalizedResult[];
+        nonPersonalized: {
+            path: string;
+        }[];
+    }>;
+    protected isEmpty(data: UpdatedPaths[]): boolean;
+    /**
+     * Extracts the paths from the updated paths
+     * @param {UpdatedPaths[]} filteredUpdates Updated paths
+     * @returns {string[]} paths
+     */
+    protected extractPaths(filteredUpdates: UpdatedPaths[]): string[];
+    /**
+     * Gets the site name from the path name
+     * @param {string} pathname Path name
+     * @returns {string} site name
+     */
+    protected getSiteName(pathname: string): string;
+    /**
+     * Gets the path name from the full path
+     * @param {string} fullPath Full path
+     * @returns {string} path name
+     */
+    protected getPathName(fullPath: string): string;
+    protected extractSiteName(path: string): string;
+    /**
+     * Filters out the updated paths and language from the request body
+     * @param {NextApiRequest} req Next.js API request
+     * @returns {UpdatedPaths[]} updated paths
+     */
+    protected getFilteredUpdates(req: NextApiRequest): UpdatedPaths[];
+    protected handleMultiSitePersonalization(personalizeInfo: {
+        personalized: PersonalizedResult[];
+        nonPersonalized: {
+            path: string;
+        }[];
+    }, pathsToRevalidate: string[], getPathName: (x: string) => string, getSiteName: (x: string) => string): void;
+    protected handleNonMultiSitePersonalization(personalizeInfo: {
+        personalized: PersonalizedResult[];
+        nonPersonalized: {
+            path: string;
+        }[];
+    }, pathsToRevalidate: string[], getPathName: (x: string) => string): void;
+    private handler;
+}
+export {};

package/types/utils/utils.d.ts

@@ -5,6 +5,7 @@
  * VERCEL_URL is provided by Vercel in case if we are in Preview deployment (deployment based on the custom branch),
  * preview deployment has unique url, we don't know exact url.
  * Similarly, DEPLOY_URL is provided by Netlify and would give us the deploy URL
+ * In production non-editing environments it is desirable to use relative urls, so in that case set PUBLIC_URL = ''
  */
 export declare const getPublicUrl: () => string;
 /**