cloudflare-next-intl 0.4.1 → 0.4.2

package/README.md

@@ -193,6 +193,8 @@ auto-wires `CookieConsentProvider` (and `CookieConsentAnalytics`, if
 
 ```typescript
 // intl-config.ts
+import { getCloudflareContext } from "@opennextjs/cloudflare";
+
 export default setIntlConfig({
     locales: ["en", "de"],
     defaultLocale: "en",
@@ -200,7 +202,10 @@ export default setIntlConfig({
         privacyPolicyDate: "2026-01-01",
         // Optional: gate the banner to GDPR-region visitors only. Omit both
         // getters to disable country-based gating (consent always implicit).
-        getCloudflareContext: () => getCloudflareContext(),
+        // Pass @opennextjs/cloudflare's getCloudflareContext directly — its
+        // exact overloaded signature is accepted as-is, called internally
+        // with { async: true }.
+        getCloudflareContext,
         // gdprCountries: [...], // defaults to EU/EEA + UK + Switzerland
         // enableAnalyticsInDevMode: true, // analytics stay off in dev otherwise
     },

package/dist/src/cookie_consent/gdpr_countries.bench.js

@@ -1,5 +1,9 @@
 import { bench, describe } from 'vitest';
 import resolveRequiresConsent, { defaultGdprCountries } from './gdpr_countries';
+const fakeGetCloudflareContext = ((options) => {
+    const context = { cf: { country: 'DE' } };
+    return options?.async === false ? context : Promise.resolve(context);
+});
 const customList = ['US', 'CA', 'MX'];
 describe('resolveRequiresConsent: default GDPR list lookup', () => {
     bench('country inside the list (worst case for Array.includes: near the end)', async () => {
@@ -21,7 +25,7 @@ describe('resolveRequiresConsent: gating disabled', () => {
 });
 describe('resolveRequiresConsent: getCloudflareContext path', () => {
     bench('resolves cf.country from an async context getter', async () => {
-        await resolveRequiresConsent(undefined, async () => ({ cf: { country: 'DE' } }), undefined);
+        await resolveRequiresConsent(undefined, fakeGetCloudflareContext, undefined);
     });
 });
 // Sanity check the list itself isn't accidentally growing unbounded — a

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

@@ -1,4 +1,4 @@
-import type { CookieConsentCloudflareContext } from '../types/types';
+import type { CookieConsentGetCloudflareContext } from '../types/types';
 /**
  * Default `cookieConsent.gdprCountries` — EU/EEA member states (GDPR),
  * Iceland/Liechtenstein/Norway (EEA), the UK (UK-GDPR), and Switzerland
@@ -15,4 +15,4 @@ export declare const defaultGdprCountries: readonly string[];
  *   `gdprCountries` skips the banner. `getCountryCode` takes precedence
  *   over `getCloudflareContext` when both are set.
  */
-export default function resolveRequiresConsent(getCountryCode: (() => string | undefined | Promise<string | undefined>) | undefined, getCloudflareContext: (() => CookieConsentCloudflareContext | Promise<CookieConsentCloudflareContext>) | undefined, gdprCountries: readonly string[] | undefined): Promise<boolean>;
+export default function resolveRequiresConsent(getCountryCode: (() => string | undefined | Promise<string | undefined>) | undefined, getCloudflareContext: CookieConsentGetCloudflareContext | undefined, gdprCountries: readonly string[] | undefined): Promise<boolean>;

package/dist/src/cookie_consent/gdpr_countries.js

@@ -45,7 +45,7 @@ export default async function resolveRequiresConsent(getCountryCode, getCloudfla
         return false;
     const countryCode = getCountryCode
         ? await getCountryCode()
-        : (await getCloudflareContext()).cf?.country;
+        : (await getCloudflareContext({ async: true }))?.cf?.country;
     if (!countryCode)
         return true;
     return getGdprCountriesSet(gdprCountries).has(countryCode);

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

@@ -5,4 +5,4 @@ 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 { CookieConsentRoutingConfig, CookieConsentAnalyticsSecrets } from '../types/types';
+export type { CookieConsentRoutingConfig, CookieConsentAnalyticsSecrets, CookieConsentCloudflareContext, CookieConsentGetCloudflareContext, } from '../types/types';

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

@@ -1 +1 @@
-export type { CookieAttributes, LocalePrefixMode, Locales, ReturnType, RoutingConfig, TranslationEntry, TranslationObject, TranslatorReturnType, Alternates, changeFrequency, IntlSitemap, CookieConsentRoutingConfig, CookieConsentAnalyticsSecrets, CookieConsentCloudflareContext, } from './types';
+export type { CookieAttributes, LocalePrefixMode, Locales, ReturnType, RoutingConfig, TranslationEntry, TranslationObject, TranslatorReturnType, Alternates, changeFrequency, IntlSitemap, CookieConsentRoutingConfig, CookieConsentAnalyticsSecrets, CookieConsentCloudflareContext, CookieConsentGetCloudflareContext, } from './types';

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

@@ -136,11 +136,12 @@ export interface CookieConsentRoutingConfig {
      */
     getCountryCode?: () => string | undefined | Promise<string | undefined>;
     /**
-     * Returns the Cloudflare request context — e.g. your own
-     * `getCloudflareContext()` call from `@opennextjs/cloudflare` (not a
-     * dependency of this package, so bring your own). Only `cf.country`
-     * is read from the resolved context. Ignored when `getCountryCode` is
-     * also set.
+     * Pass `getCloudflareContext` from `@opennextjs/cloudflare` directly
+     * (not a dependency of this package, so bring your own import) — its
+     * exact overloaded signature is accepted as-is; called internally with
+     * `{ async: true }`, so you never need to wrap it yourself. Only
+     * `cf.country` is read from the resolved context. Ignored when
+     * `getCountryCode` is also set.
      *
      * Country-based gating (via either `getCountryCode` or
      * `getCloudflareContext`) decides whether the cookie-consent banner is
@@ -151,7 +152,7 @@ export interface CookieConsentRoutingConfig {
      * is the simplest opt-in-by-default setup; set one of the two getters
      * once you need real GDPR-region gating.
      */
-    getCloudflareContext?: () => CookieConsentCloudflareContext | Promise<CookieConsentCloudflareContext>;
+    getCloudflareContext?: CookieConsentGetCloudflareContext;
     /**
      * Country codes (ISO 3166-1 alpha-2) for which the cookie-consent banner
      * is required. Only consulted when `getCountryCode` or
@@ -183,6 +184,23 @@ export interface CookieConsentCloudflareContext {
         country?: string;
     };
 }
+/**
+ * Matches `@opennextjs/cloudflare`'s `getCloudflareContext` overloaded
+ * signature exactly, so that function can be passed as
+ * `cookieConsent.getCloudflareContext` directly — this package always
+ * calls it with `{ async: true }` internally (the first overload), which is
+ * why that overload's return type drives `resolveRequiresConsent`'s
+ * awaited result; the sync overload is accepted structurally only so the
+ * real function's type (which has both) is assignable as-is.
+ */
+export interface CookieConsentGetCloudflareContext {
+    (options: {
+        async: true;
+    }): Promise<CookieConsentCloudflareContext | null>;
+    (options?: {
+        async: false;
+    }): CookieConsentCloudflareContext | null;
+}
 export interface CookieConsentAnalyticsSecrets {
     /** Cloudflare Web Analytics beacon token, e.g. `'{"token": "..."}'` (the raw `data-cf-beacon` attribute value). */
     cloudflareBeaconToken?: string;

package/llms.txt

@@ -42,7 +42,7 @@ other subpath can be used.
 - `./CookieConsentDialog` — default cookie-consent banner; accepts per-slot `classNames`/`styles` or a `render` prop for fully custom markup.
 - `./PrivacyPolicyUpdateDialog` — "privacy policy updated" banner; auto-enabled only when `cookieConsent.privacyPolicyDate` is set.
 - `./cookieConsentAnalytics` — `CookieConsentAnalytics`: gates Cloudflare Web Analytics / Google Ads / Google Analytics / AdSense / Microsoft Clarity behind consent; rendered automatically by `IntlProvider` when `cookieConsent.secrets` or `getSecrets` is set (and `autoWireAnalytics !== false`). Never renders in local dev (`NODE_ENV === 'development'`) unless `cookieConsent.enableAnalyticsInDevMode` is `true`.
-- Country-based gating (`cookieConsent.getCountryCode` / `getCloudflareContext` + `gdprCountries`): resolved server-side by `IntlProvider` into a `requiresConsent` boolean passed to `CookieConsentProvider`. Neither getter set → gating off, consent always implicitly granted. `getCountryCode` (direct country resolver) takes precedence over `getCloudflareContext` (reads `cf.country`) when both are set. Unresolved country always requires consent (fail-safe). `./cookieConsent` also exports `defaultGdprCountries` (EU/EEA + UK + Switzerland).
+- Country-based gating (`cookieConsent.getCountryCode` / `getCloudflareContext` + `gdprCountries`): resolved server-side by `IntlProvider` into a `requiresConsent` boolean passed to `CookieConsentProvider`. Neither getter set → gating off, consent always implicitly granted. `getCountryCode` (direct country resolver) takes precedence over `getCloudflareContext` (reads `cf.country`) when both are set. `getCloudflareContext` accepts `@opennextjs/cloudflare`'s `getCloudflareContext` function directly (its exact overloaded signature — `CookieConsentGetCloudflareContext`), called internally with `{ async: true }`. Unresolved country (or a `null` context) always requires consent (fail-safe). `./cookieConsent` also exports `defaultGdprCountries` (EU/EEA + UK + Switzerland).
 
 ## Conventions
 

package/package.json

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