cloudflare-next-intl 0.5.1 → 0.5.3

package/README.md

@@ -188,8 +188,10 @@ import ThemeSwitcher from "cloudflare-next-intl/ThemeSwitcher";
 ### Cookie consent
 
 Set `cookieConsent` on your `RoutingConfig` to enable — `IntlProvider` then
-auto-wires `CookieConsentProvider` (and `CookieConsentAnalytics`, if
-`cookieConsent.secrets`/`getSecrets` is set) with no manual nesting needed.
+auto-wires `CookieConsentProvider`, `CookieConsentAnalytics` (if
+`cookieConsent.secrets`/`getSecrets` is set), and both `CookieConsentDialog`/
+`PrivacyPolicyUpdateDialog` (with their built-in default styling and
+English/Ukrainian copy) with no manual nesting needed.
 
 ```typescript
 // intl-config.ts
@@ -210,10 +212,17 @@ export default setIntlConfig({
         getCloudflareContext,
         // gdprCountries: [...], // defaults to EU/EEA + UK + Switzerland
         // enableAnalyticsInDevMode: true, // analytics stay off in dev otherwise
+        // autoWireDialogs: false, // opt out and render the dialogs yourself
+        // dialogProps: { acceptText: "Accept" }, // forwarded to CookieConsentDialog
+        // updateDialogProps: { closeText: "Got it" }, // forwarded to PrivacyPolicyUpdateDialog
     },
 });
 ```
 
+`CookieConsentDialog`/`PrivacyPolicyUpdateDialog` render automatically — no
+JSX needed in your layout. Set `autoWireDialogs: false` to render them
+yourself instead (e.g. for full control over placement):
+
 ```tsx
 import { CookieConsentDialog, PrivacyPolicyUpdateDialog, useCookieConsent } from "cloudflare-next-intl/cookieConsent";
 

package/dist/src/client/components/client_provider.d.ts

@@ -1,12 +1,14 @@
 import type { TranslationObject } from "../../types/types";
 import type { SerializedAuthUser } from "../../firebase_auth/types";
 import type { CookieConsentAnalyticsSecrets } from "../../types/types";
+import type { CookieConsentDialogProps } from "../../cookie_consent/client/components/cookie_consent_dialog";
+import type { PrivacyPolicyUpdateDialogProps } from "../../cookie_consent/client/components/privacy_policy_update_dialog";
 interface LocaleContextType {
     language: string;
     messages: TranslationObject;
 }
 export declare const LocaleContext: import("react").Context<LocaleContextType | undefined>;
-export default function LocationzationClientProvider({ language, messages, initialAuthUser, skipAuthProvider, analyticsSecrets, requiresConsent, children }: {
+export default function LocationzationClientProvider({ language, messages, initialAuthUser, skipAuthProvider, analyticsSecrets, requiresConsent, autoWireDialogs, dialogProps, updateDialogProps, children }: {
     language: string;
     messages: TranslationObject;
     initialAuthUser?: SerializedAuthUser | null;
@@ -21,6 +23,12 @@ export default function LocationzationClientProvider({ language, messages, initi
      * for a first-time visitor instead of `null`.
      */
     requiresConsent?: boolean;
+    /** From `cookieConsent.autoWireDialogs` — renders `CookieConsentDialog`/`PrivacyPolicyUpdateDialog` automatically when `true` (default). */
+    autoWireDialogs?: boolean;
+    /** From `cookieConsent.dialogProps` — forwarded as-is to the auto-wired `CookieConsentDialog`. */
+    dialogProps?: CookieConsentDialogProps;
+    /** From `cookieConsent.updateDialogProps` — forwarded as-is to the auto-wired `PrivacyPolicyUpdateDialog`. */
+    updateDialogProps?: PrivacyPolicyUpdateDialogProps;
     children: React.ReactNode;
 }): Component;
 export {};

package/dist/src/client/components/client_provider.js

@@ -15,7 +15,9 @@ export const LocaleContext = createContext(undefined);
 const AuthUserProvider = dynamic(() => import("../../firebase_auth/client/auth_user_provider"));
 const CookieConsentProvider = dynamic(() => import("../../cookie_consent/client/cookie_consent_provider"));
 const CookieConsentAnalytics = dynamic(() => import("../../cookie_consent/client/components/cookie_consent_analytics"));
-export default function LocationzationClientProvider({ language, messages, initialAuthUser = null, skipAuthProvider = false, analyticsSecrets, requiresConsent = true, children }) {
+const CookieConsentDialog = dynamic(() => import("../../cookie_consent/client/components/cookie_consent_dialog"));
+const PrivacyPolicyUpdateDialog = dynamic(() => import("../../cookie_consent/client/components/privacy_policy_update_dialog"));
+export default function LocationzationClientProvider({ language, messages, initialAuthUser = null, skipAuthProvider = false, analyticsSecrets, requiresConsent = true, autoWireDialogs = true, dialogProps, updateDialogProps, children }) {
     setLocaleCache(language);
     setMessageForLocaleCache(language, messages);
     // `LocaleContext.Provider` stays the outermost element here — the
@@ -28,7 +30,7 @@ export default function LocationzationClientProvider({ language, messages, initi
         providedChildren = _jsx(AuthUserProvider, { initialUser: initialAuthUser, children: children });
     }
     if (config.cookieConsent) {
-        providedChildren = _jsxs(CookieConsentProvider, { requiresConsent: requiresConsent, children: [providedChildren, analyticsSecrets && _jsx(CookieConsentAnalytics, { secrets: analyticsSecrets })] });
+        providedChildren = _jsxs(CookieConsentProvider, { requiresConsent: requiresConsent, children: [providedChildren, analyticsSecrets && _jsx(CookieConsentAnalytics, { secrets: analyticsSecrets }), autoWireDialogs && _jsx(CookieConsentDialog, { ...dialogProps }), autoWireDialogs && _jsx(PrivacyPolicyUpdateDialog, { ...updateDialogProps })] });
     }
     const contextValue = useMemo(() => ({ language, messages }), [language, messages]);
     return _jsx(LocaleContext.Provider, { value: contextValue, children: providedChildren });

package/dist/src/cookie_consent/client/components/cookie_consent_dialog.js

@@ -12,8 +12,8 @@ import { defaultCookieDialogClassNames } from './default_dialog_styles';
  * particular design system.
  */
 export default function CookieConsentDialog({ message, link, privacyPolicyLinkText, acceptText, declineText, hideDecline = false, id = 'cookie-consent-dialog', classNames, styles, render, }) {
-    const { consent, setConsent, privacyPolicyPath } = useCookieConsent();
-    if (consent !== null)
+    const { consent, isMounted, setConsent, privacyPolicyPath } = useCookieConsent();
+    if (!isMounted || consent !== null)
         return null;
     if (render)
         return _jsx(_Fragment, { children: render({ setConsent }) });

package/dist/src/cookie_consent/client/cookie_consent_provider.js

@@ -58,14 +58,14 @@ export default function CookieConsentProvider({ requiresConsent = true, children
     }, []);
     const [consent, setConsentState] = useState(null);
     const [privacyPolicyUpdated, setPrivacyPolicyUpdated] = useState(false);
+    const [isMounted, setIsMounted] = useState(false);
     useEffect(() => {
         const storedConsent = parseConsent(getCookie(consentCookieName));
-        if (storedConsent === null && !requiresConsent) {
-            setConsentState(true);
-            return;
-        }
-        setConsentState(storedConsent);
-        if (storedConsent === null || !policyDate)
+        const autoAccepted = storedConsent === null && !requiresConsent;
+        setConsentState(autoAccepted ? true : storedConsent);
+        setIsMounted(true);
+        const isFirstVisit = storedConsent === null && !autoAccepted;
+        if (isFirstVisit || !policyDate)
             return;
         const storedDateRaw = getCookie(dateCookieName);
         if (!storedDateRaw) {
@@ -90,6 +90,6 @@ export default function CookieConsentProvider({ requiresConsent = true, children
         setPrivacyPolicyUpdated(false);
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, []);
-    const contextValue = useMemo(() => ({ consent, privacyPolicyUpdated, setConsent, acknowledgePrivacyPolicyUpdate, privacyPolicyPath }), [consent, privacyPolicyUpdated, setConsent, acknowledgePrivacyPolicyUpdate, privacyPolicyPath]);
+    const contextValue = useMemo(() => ({ consent, privacyPolicyUpdated, isMounted, setConsent, acknowledgePrivacyPolicyUpdate, privacyPolicyPath }), [consent, privacyPolicyUpdated, isMounted, setConsent, acknowledgePrivacyPolicyUpdate, privacyPolicyPath]);
     return (_jsx(CookieConsentContext.Provider, { value: contextValue, children: children }));
 }

package/dist/src/cookie_consent/index.d.ts

@@ -5,4 +5,6 @@ export { default as PrivacyPolicyUpdateDialog } from './client/components/privac
 export { default as CookieConsentAnalytics } from './client/components/cookie_consent_analytics';
 export { defaultGdprCountries } from './gdpr_countries';
 export type { CookieConsentContextType, ConsentValue, CookieDialogClassNames, CookieDialogStyles } from './types';
+export type { CookieConsentDialogProps } from './client/components/cookie_consent_dialog';
+export type { PrivacyPolicyUpdateDialogProps } from './client/components/privacy_policy_update_dialog';
 export type { CookieConsentRoutingConfig, CookieConsentAnalyticsSecrets, CookieConsentCloudflareContext, CookieConsentGetCloudflareContext, } from '../types/types';

package/dist/src/cookie_consent/types.d.ts

@@ -4,6 +4,14 @@ export type ConsentValue = boolean | null;
 export interface CookieConsentContextType {
     /** Current consent value; `null` until the visitor decides. */
     consent: ConsentValue;
+    /**
+     * `false` until the client has read the stored consent/date cookies once
+     * (always `false` during SSR and the first client render, to avoid a
+     * hydration mismatch). The default dialog components render nothing
+     * until this is `true`, so a returning visitor's decided consent never
+     * flashes the banner before disappearing.
+     */
+    isMounted: boolean;
     /**
      * `true` once a privacy-policy update has been detected (stored consent
      * predates `cookieConsent.privacyPolicyDate`) and hasn't been

package/dist/src/server/components/server_provider.js

@@ -77,5 +77,5 @@ export default async function LocationzationProvider({ language, messages, child
                 : config.cookieConsent.secrets;
         }
     }
-    return _jsx(LocationzationClientProvider, { language: language, messages: messagesValue, initialAuthUser: initialAuthUser, skipAuthProvider: !autoWireClientProvider, analyticsSecrets: analyticsSecrets, requiresConsent: requiresConsent, children: children });
+    return _jsx(LocationzationClientProvider, { language: language, messages: messagesValue, initialAuthUser: initialAuthUser, skipAuthProvider: !autoWireClientProvider, analyticsSecrets: analyticsSecrets, requiresConsent: requiresConsent, autoWireDialogs: config.cookieConsent?.autoWireDialogs !== false, dialogProps: config.cookieConsent?.dialogProps, updateDialogProps: config.cookieConsent?.updateDialogProps, children: children });
 }

package/dist/src/types/types.d.ts

@@ -1,6 +1,8 @@
 import type { NextResponse } from 'next/server';
 import type { Languages } from 'next/dist/lib/metadata/types/alternative-urls-types';
 import type { Videos } from 'next/dist/lib/metadata/types/metadata-types';
+import type { CookieConsentDialogProps } from '../cookie_consent/client/components/cookie_consent_dialog';
+import type { PrivacyPolicyUpdateDialogProps } from '../cookie_consent/client/components/privacy_policy_update_dialog';
 /**
  * Custom middleware hook, run by `intlMiddleware` for your own logic
  * (e.g. auth, feature flags, A/B tests) — on top of the library's own
@@ -179,6 +181,26 @@ export interface CookieConsentRoutingConfig {
      * scripts locally.
      */
     enableAnalyticsInDevMode?: boolean;
+    /**
+     * Whether `IntlProvider` should automatically render
+     * `CookieConsentDialog` and `PrivacyPolicyUpdateDialog` (with their
+     * built-in default styling/EN+UK copy) at the end of your app tree.
+     * Defaults to `true` whenever `cookieConsent` is set. Set `false` to
+     * keep `cookieConsent` configured for `useCookieConsent()`/analytics
+     * only and render your own dialogs (or the exported components)
+     * yourself, wherever you like in the tree.
+     */
+    autoWireDialogs?: boolean;
+    /**
+     * Props forwarded as-is to the auto-wired `CookieConsentDialog`.
+     * Ignored when `autoWireDialogs` is `false`.
+     */
+    dialogProps?: CookieConsentDialogProps;
+    /**
+     * Props forwarded as-is to the auto-wired `PrivacyPolicyUpdateDialog`.
+     * Ignored when `autoWireDialogs` is `false`.
+     */
+    updateDialogProps?: PrivacyPolicyUpdateDialogProps;
 }
 /**
  * Minimal shape read from your `getCloudflareContext()` return value — only

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudflare-next-intl",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "Optimized Next Intl Package Special for App Router and Cloudflare",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/src/general/get_layout_states.js

@@ -1,39 +0,0 @@
-"use strict";
-// NOTE: currently disabled — this file exports nothing at runtime, even
-// though "./getLayoutStates" is listed in package.json's exports map.
-// Do not rely on `cloudflare-next-intl/getLayoutStates` until this is
-// re-enabled; use `getLocale()` + read the theme cookie manually instead.
-// "use server";
-// import { cookies } from "next/headers";
-// import { localeCookieName, isDarkCookieKey } from "../config/cookie_key";
-// import config from "../config/intl_config";
-// interface HtmlParamProps {
-//     className?: string;
-//     suppressHydrationWarning?: boolean;
-//     lang: string;
-// }
-// export default async function getLayoutStates(): Promise<{
-//     isDark: boolean | null;
-//     locale: string;
-//     htmlParam?: HtmlParamProps;
-// }> {
-//     const cookie = await cookies();
-//     const isDarkMode = cookie.get(isDarkCookieKey)?.value;
-//     const isDark = getCookieBooleanValue(isDarkMode);
-//     const cookieLocale = (cookie.get(localeCookieName)?.value as string) ?? config.defaultLocale;
-//     const htmlParam: HtmlParamProps = { suppressHydrationWarning: !isDarkMode, lang: cookieLocale };
-//     if (isDark === true) {
-//         htmlParam.className = 'dark';
-//     }
-//     return { isDark, locale: cookieLocale, htmlParam };
-// }
-// function getCookieBooleanValue(cookieValue: string | undefined): boolean | null {
-//     switch (cookieValue) {
-//         case "true":
-//             return true;
-//         case "false":
-//             return false;
-//         default:
-//             return null;
-//     }
-// }