cloudflare-next-intl 0.6.2 → 0.6.3

package/dist/types/general/cache_variables.d.ts

@@ -0,0 +1,14 @@
+import type { TranslationObject, TranslatorReturnType } from "../types/types";
+/**
+ * Sets the current locale.
+ * @param locale The language to set.
+ */
+export declare function setLocaleCache(locale: string): void;
+export declare function setLocaleAsync(params: Promise<{
+    locale: string;
+}>): Promise<void>;
+export declare function getLocaleCache(): string | undefined;
+export declare function setMessageForLocaleCache(locale: string, message: TranslationObject): void;
+export declare function getMessageCache(locale?: string): TranslationObject | undefined;
+export declare function setTranslationCache(cache: string, value: TranslatorReturnType): void;
+export declare function getTranslationCache(cacheKey: string): TranslatorReturnType | undefined;

package/dist/types/general/cache_variables.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/general/general_functions.bench.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/general/general_functions.d.ts

@@ -0,0 +1,2 @@
+import type { TranslationObject, TranslatorReturnType } from "../types/types";
+export declare function getTranslationsImpl(locale: string, messages: TranslationObject, namespace: string, cacheKey?: string): TranslatorReturnType;

package/dist/types/general/general_functions.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,2 @@
+export { setLocaleCache as setLocale, setLocaleAsync } from './cache_variables';
+export { alternatesLinks } from './metadata';

package/dist/types/general/metadata.bench.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/general/metadata.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Builds the `alternates` field for Next's `generateMetadata` — a canonical
+ * URL plus per-locale `hreflang` links, exported memoized as `alternatesLinks`
+ * from `cloudflare-next-intl/metadata`.
+ *
+ * @param url        Absolute base URL of your site (no locale, no path),
+ *   e.g. `"https://example.com"`.
+ * @param locale     The current page's locale — used to decide the
+ *   `canonical` URL (only set for `defaultLocale` unless you pass one).
+ * @param linkPart   The path segment after the locale, e.g. `"/about"`.
+ *   Pass `"/"` or omit for the root page.
+ * @param canonical  Optional override for the canonical URL.
+ * @returns `{ canonical, languages }` ready to spread into `Metadata.alternates`,
+ *   or `undefined` if building the links threw (logged, not re-thrown).
+ *
+ * @example
+ * ```ts
+ * export async function generateMetadata({ params }) {
+ *   const { locale } = await params;
+ *   return {
+ *     alternates: alternatesLinks({ url: "https://example.com", locale, linkPart: "/about" }),
+ *   };
+ * }
+ * ```
+ */
+export declare function iAlternatesLinks({ locale, url, canonical, linkPart }: {
+    url: string;
+    locale: string;
+    linkPart?: string;
+    canonical?: string;
+}): {
+    canonical?: string;
+    languages: Record<string, string>;
+} | undefined;
+export declare const alternatesLinks: typeof iAlternatesLinks;
+declare function iLanguages(url: string, linkPart?: string): Record<string, string>;
+export declare const languages: typeof iLanguages;
+export {};

package/dist/types/general/metadata.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from './config';
+export * from './general';
+export * from './server';
+export * from './client';
+export * from './theme_switcher';
+export * from './types';

package/dist/types/server/components/helper_script.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Server component exported as `IntlHelperScript` from
+ * `cloudflare-next-intl/IntlHelperScript`. Renders inline bootstrap
+ * `<script>` tags that run before hydration to avoid FOUC/flicker:
+ * - syncs dark-mode class from the theme cookie (or `prefers-color-scheme`)
+ * - redirects to the locale-prefixed URL if the locale cookie disagrees
+ *   with the current path (covers client-side navigation edge cases)
+ * - (prod only) checks `BUILD_ID` and force-reloads on stale deploys
+ *
+ * Place it once in your root layout's `<head>`, alongside `IntlProvider`.
+ * No props.
+ *
+ * @example
+ * ```tsx
+ * <head>
+ *   <IntlHelperScript />
+ * </head>
+ * ```
+ */
+export default function HelperScript(): Component | null;

package/dist/types/server/components/link.d.ts

@@ -0,0 +1,25 @@
+import { type LinkProps } from 'next/link';
+import { type ComponentProps } from 'react';
+type NextLinkProps = Omit<ComponentProps<'a'>, keyof LinkProps> & Omit<LinkProps, 'locale'>;
+/**
+ * Server-safe, locale-aware drop-in replacement for `next/link`. Import
+ * from `cloudflare-next-intl/Link` (a separate subpath from the client-side
+ * `LocaleLink`).
+ *
+ * Prepends the current locale segment to `href` automatically when the
+ * current locale isn't the `defaultLocale` — you never build the
+ * `/en/about`-style path yourself. To link to a SPECIFIC locale (a language
+ * switcher) use `LocaleLink` instead, which takes an explicit `locale` prop.
+ *
+ * All other `next/link` props (`prefetch`, `replace`, `scroll`, etc.) and
+ * standard `<a>` props are passed straight through.
+ *
+ * @example
+ * ```tsx
+ * import Link from "cloudflare-next-intl/Link";
+ *
+ * <Link href="/about">About</Link> // -> "/about" or "/de/about"
+ * ```
+ */
+declare const Link: import("react").ForwardRefExoticComponent<Omit<NextLinkProps, "ref"> & import("react").RefAttributes<HTMLAnchorElement>>;
+export default Link;

package/dist/types/server/components/server_provider.d.ts

@@ -0,0 +1,35 @@
+import type { TranslationObject } from "../../types/types";
+/**
+ * Server component that provides locale/messages context to the rest of the
+ * tree. Exported publicly as `IntlProvider` from `cloudflare-next-intl/serverProvider`.
+ *
+ * Wrap this around your app once, near the root layout, below `[locale]`.
+ * It seeds the server-side locale/message caches (for `getLocale`/`getTranslations`)
+ * and also passes them to the client `LocaleContext` (for `useLocale`/`useTranslations`
+ * in client components).
+ *
+ * @param language The current route's locale (typically the `[locale]` route
+ *   param). Must be one of your configured `locales` — calls `notFound()`
+ *   otherwise.
+ * @param messages Optional pre-loaded messages for `language`. If omitted,
+ *   they're loaded via `getMessage(language)`.
+ *
+ * @example
+ * ```tsx
+ * export default async function RootLayout({ children, params }) {
+ *   const { locale } = await params;
+ *   return (
+ *     <html lang={locale}>
+ *       <body>
+ *         <IntlProvider language={locale}>{children}</IntlProvider>
+ *       </body>
+ *     </html>
+ *   );
+ * }
+ * ```
+ */
+export default function LocationzationProvider({ language, messages, children }: {
+    language: string;
+    messages?: TranslationObject;
+    children: React.ReactNode;
+}): Promise<Component>;

package/dist/types/server/functions/get_user_locale.bench.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/server/functions/get_user_locale.d.ts

@@ -0,0 +1,3 @@
+export declare const languageDetecotr: typeof languageDetecotrImpl;
+declare function languageDetecotrImpl(acceptLanguageHeader: string | null): string;
+export {};

package/dist/types/server/functions/get_user_locale.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/server/functions/locale_static_params.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generates the `[locale]` route params for every configured locale — pass
+ * directly as your `[locale]/layout.tsx`'s `generateStaticParams` so Next
+ * pre-renders/statically-generates a route for each locale.
+ *
+ * @returns One `{ locale }` object per entry in your `setIntlConfig({ locales })`.
+ *
+ * @example
+ * ```tsx
+ * export const generateStaticParams = getLocaleStaticParams;
+ * ```
+ */
+export declare function getLocaleStaticParams(): {
+    locale: string;
+}[];

package/dist/types/server/functions/locale_static_params.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/server/functions/server.bench.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/server/functions/server.d.ts

@@ -0,0 +1,67 @@
+import type { TranslationObject, TranslatorReturnType } from "../../types/types";
+/**
+ * Loads and caches messages for a specific locale using dynamic import.
+ * Prevents redundant file loads and handles import errors gracefully.
+ * @param locale The locale for which to load messages.
+ * @returns A promise that resolves to the TranslationObject for the given locale.
+ */
+declare function iGetMessage(locale: string): Promise<TranslationObject>;
+/**
+ * Server-only: loads (and caches) the translation messages for a locale.
+ * Use {@link getTranslations} instead unless you need the raw message object.
+ *
+ * @param locale The locale to load messages for (e.g. `"en"`).
+ * @returns The `TranslationObject` for that locale.
+ * @throws via `notFound()` if `locale` isn't in your configured locales.
+ */
+export declare const getMessage: typeof iGetMessage;
+/**
+ * Retrieves a translation function for a specific namespace and locale.
+ * This function handles caching of both translation files and memoized translation functions.
+ * @param namespace The dot-separated namespace (e.g., "common.buttons").
+ * @param locale Optional: The specific locale to use. If not provided, it will be determined.
+ * @returns A promise that resolves to a function, which takes a key and returns the translated string.
+ */
+declare function iGetTranslations(namespace: string, locale?: string): Promise<TranslatorReturnType>;
+/**
+ * Server Component only: gets a translation function for a namespace.
+ *
+ * @param namespace Dot-separated key prefix into your messages file
+ *   (e.g. `"HomePage"`, `"Common.buttons"`).
+ * @param locale    Optional. Defaults to {@link getLocale}'s result — pass
+ *   this explicitly only if you already resolved the locale (e.g. from route
+ *   params) to avoid an extra lookup.
+ * @returns A function `(key: string) => string` that looks up `key` inside
+ *   `namespace`.
+ *
+ * @example
+ * ```tsx
+ * export default async function Page() {
+ *   const t = await getTranslations("HomePage");
+ *   return <h1>{t("title")}</h1>;
+ * }
+ * ```
+ */
+export declare const getTranslations: typeof iGetTranslations;
+/**
+ * Determines the current locale. It first checks for an explicitly set locale,
+ * and finally reads from cookies.
+ * @returns A promise that resolves to the determined Language.
+ */
+declare function iGetLocale(): Promise<string>;
+/**
+ * Server Component only: resolves the current request's locale.
+ *
+ * Order of resolution: an explicitly-set locale (e.g. via `IntlProvider`)
+ * takes priority, then falls back to the `NEXT_LOCALE`-style cookie set by
+ * `intlMiddleware`, then to `defaultLocale` from your `setIntlConfig` config.
+ *
+ * @returns The resolved locale string (e.g. `"en"`).
+ *
+ * @example
+ * ```tsx
+ * const locale = await getLocale();
+ * ```
+ */
+export declare const getLocale: typeof iGetLocale;
+export {};

package/dist/types/server/functions/server.perf.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/server/functions/server.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/server/functions/use_functions.bench.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/server/functions/use_functions.d.ts

@@ -0,0 +1,33 @@
+import type { TranslatorReturnType } from "../../types/types";
+/**
+ * React Server Component `useLocale`, reached via the `cloudflare-next-intl/use`
+ * subpath's `react-server` condition (resolved automatically — you always
+ * just `import { useLocale } from "cloudflare-next-intl/use"`; the matching
+ * client-hook version from `client_hooks.ts` is used automatically in client
+ * components instead).
+ *
+ * Uses React's `use()` on the locale promise resolved by `getLocale()`/
+ * `IntlProvider` — must be called within a component tree wrapped in
+ * `IntlProvider`.
+ *
+ * @returns The current locale (e.g. `"en"`).
+ * @throws If called without an `IntlProvider` above it in the tree.
+ * @example
+ * const locale = useLocale(); // "en"
+ */
+export declare function useLocaleImpl(): string;
+export declare const useLocale: typeof useLocaleImpl;
+/**
+ * React Server Component `useTranslations` — see {@link useLocaleImpl} for
+ * the `react-server`/client resolution note.
+ *
+ * @param namespace Dot-separated key prefix into your messages file.
+ * @returns A `(key: string) => string` translation function.
+ * @throws If called without an `IntlProvider` above it in the tree.
+ * @example
+ * const t = useTranslations("Index");
+ * return <h1>{t("title")}</h1>;
+ */
+declare function useTranslationsImpl(namespace: string): TranslatorReturnType;
+export declare const useTranslations: typeof useTranslationsImpl;
+export {};

package/dist/types/server/functions/use_functions.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,5 @@
+export { getMessage as getMessage, getTranslations, getLocale } from './functions/server';
+export { default as IntlProvider } from './components/server_provider';
+export { default as Link } from './components/link';
+export { default as IntlHelperScript } from './components/helper_script';
+export { getLocaleStaticParams } from './functions/locale_static_params';

package/dist/types/test_utils/mock_intl_config.d.ts

@@ -0,0 +1,3 @@
+import type { RoutingConfig } from '../types/types';
+declare const mockIntlConfig: RoutingConfig<readonly ['en', 'de'], 'as-needed'>;
+export default mockIntlConfig;

package/dist/types/test_utils/mock_next_server.d.ts

@@ -0,0 +1,5 @@
+import { NextRequest } from 'next/server';
+export declare function makeTestRequest(url: string, init?: {
+    cookies?: Record<string, string>;
+    headers?: Record<string, string>;
+}): NextRequest;

package/dist/types/theme_switcher/components/icons.d.ts

@@ -0,0 +1,6 @@
+export declare function Sun({ className }: {
+    className: string;
+}): Component;
+export declare function Moon({ className }: {
+    className: string;
+}): Component;

package/dist/types/theme_switcher/components/theme_switcher.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Light/dark theme toggle button, exported as `ThemeSwitcher` from
+ * `cloudflare-next-intl/ThemeSwitcher`. Persists the choice via the
+ * theme cookie this package's `IntlHelperScript` reads on load (so the
+ * correct theme applies before hydration, no flash).
+ *
+ * @param lightLabelText Accessible label shown/used when in light mode.
+ * @param darkLabelText  Accessible label shown/used when in dark mode.
+ * @param className      Optional class applied to the underlying button.
+ */
+export default function ThemeSwticher(params: {
+    className?: string;
+    lightLabelText: string;
+    darkLabelText: string;
+}): Component;

package/dist/types/theme_switcher/components/theme_switcher_button.d.ts

@@ -0,0 +1,6 @@
+export default function ThemeSwticherButton({ className, lightLabelText, darkLabelText, children, }: {
+    className?: string;
+    lightLabelText: string;
+    darkLabelText: string;
+    children: React.ReactNode;
+}): Component;

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

@@ -0,0 +1 @@
+export { default as ThemeSwitcher } from './components/theme_switcher';

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

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