next-intl 3.21.1 → 3.21.2-canary.0

package/dist/types/src/server/react-server/getRequestConfig.d.ts

@@ -1,20 +1,46 @@
 import type { IntlConfig } from 'use-intl/core';
-type RequestConfig = Omit<IntlConfig, 'locale'> & {
+export type RequestConfig = Omit<IntlConfig, 'locale'> & {
     /**
-     * Instead of reading a `locale` from the argument that's passed to the
+     * Instead of reading a `requestLocale` from the argument that's passed to the
      * function within `getRequestConfig`, you can include a locale as part of the
      * returned request configuration.
      *
-     * This is helpful for apps that only support a single language and for apps
-     * where the locale should be read from user settings instead of the pathname.
+     * This can be helpful for the following use cases:
+     * - Apps that only support a single language
+     * - Apps where the locale should be read from user settings instead of the pathname
+     * - Providing a fallback locale in case the locale was not matched by the middleware
      **/
     locale?: IntlConfig['locale'];
 };
 export type GetRequestConfigParams = {
+    /**
+     * Deprecated in favor of `requestLocale` (see https://github.com/amannn/next-intl/pull/1383).
+     *
+     * The locale that was matched by the `[locale]` path segment. Note however
+     * that this can be overridden in async APIs when the `locale` is explicitly
+     * passed (e.g. `getTranslations({locale: 'en'})`).
+     *
+     * @deprecated
+     */
     locale: string;
+    /**
+     * Typically corresponds to the `[locale]` segment that was matched by the middleware.
+     *
+     * However, there are three special cases to consider:
+     * 1. **Overrides**: When an explicit `locale` is passed to awaitable functions
+     *    like `getTranslations({locale: 'en'})`, then this value will be used
+     *    instead of the segment.
+     * 2. **`undefined`**: The value can be `undefined` when a page outside of the
+     *    `[locale]` segment renders (e.g. a language selection page at `app/page.tsx`).
+     * 3. **Invalid values**: Since the `[locale]` segment effectively acts like a
+     *    catch-all for unknown routes (e.g. `/unknown.txt`), invalid values should
+     *    be replaced with a valid locale.
+     *
+     * @see https://next-intl-docs.vercel.app/docs/usage/configuration#i18n-request
+     */
+    requestLocale: Promise<string | undefined>;
 };
 /**
- * Should be called in `i18n.ts` to create the configuration for the current request.
+ * Should be called in `i18n/request.ts` to create the configuration for the current request.
  */
 export default function getRequestConfig(createRequestConfig: (params: GetRequestConfigParams) => RequestConfig | Promise<RequestConfig>): (params: GetRequestConfigParams) => RequestConfig | Promise<RequestConfig>;
-export {};

package/dist/types/src/server/react-server/index.d.ts

@@ -8,4 +8,4 @@ export { default as getTimeZone } from './getTimeZone';
 export { default as getTranslations } from './getTranslations';
 export { default as getMessages } from './getMessages';
 export { default as getLocale } from './getLocale';
-export { setRequestLocale as unstable_setRequestLocale } from './RequestLocale';
+export { setCachedRequestLocale as unstable_setRequestLocale } from './RequestLocaleCache';

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

@@ -1,6 +1,3 @@
-export declare const COOKIE_LOCALE_NAME = "NEXT_LOCALE";
-export declare const COOKIE_MAX_AGE = 31536000;
-export declare const COOKIE_SAME_SITE = "lax";
 export declare const COOKIE_BASE_PATH_NAME = "NEXT_INTL_BASE_PATH";
 export declare const HEADER_LOCALE_NAME = "X-NEXT-INTL-LOCALE";
 export declare const LOCALE_SEGMENT_NAME = "locale";

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

@@ -1,2 +1,5 @@
 export type ParametersExceptFirst<Fn> = Fn extends (arg0: any, ...rest: infer R) => any ? R : never;
 export type ParametersExceptFirstTwo<Fn> = Fn extends (arg0: any, arg1: any, ...rest: infer R) => any ? R : never;
+export type Prettify<Type> = {
+    [Key in keyof Type]: Type[Key];
+} & {};

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

@@ -1,7 +1,7 @@
 import { UrlObject } from 'url';
 import NextLink from 'next/link';
 import { ComponentProps } from 'react';
-import { Locales, LocalePrefixConfigVerbose } from '../routing/types';
+import { Locales, LocalePrefixConfigVerbose, LocalePrefixMode } from '../routing/types';
 type Href = ComponentProps<typeof NextLink>['href'];
 export declare function isLocalizableHref(href: Href): boolean;
 export declare function localizeHref(href: string, locale: string, curLocale: string, curPathname: string, prefix: string): string;
@@ -17,7 +17,7 @@ export declare function matchesPathname(
 template: string, 
 /** E.g. `/users/23-jane` */
 pathname: string): boolean;
-export declare function getLocalePrefix<AppLocales extends Locales>(locale: AppLocales[number], localePrefix: LocalePrefixConfigVerbose<AppLocales>): string;
+export declare function getLocalePrefix<AppLocales extends Locales, AppLocalePrefixMode extends LocalePrefixMode>(locale: AppLocales[number], localePrefix: LocalePrefixConfigVerbose<AppLocales, AppLocalePrefixMode>): string;
 export declare function templateToRegex(template: string): RegExp;
 export declare function getSortedPathnames(pathnames: Array<string>): string[];
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "next-intl",
-  "version": "3.21.1",
+  "version": "3.21.2-canary.0",
   "sideEffects": false,
   "author": "Jan Amann <jan@amann.work>",
   "funding": [
@@ -87,11 +87,11 @@
   "dependencies": {
     "@formatjs/intl-localematcher": "^0.5.4",
     "negotiator": "^0.6.3",
-    "use-intl": "^3.21.1"
+    "use-intl": "^3.21.2-canary.0"
   },
   "peerDependencies": {
     "next": "^10.0.0 || ^11.0.0 || ^12.0.0 || ^13.0.0 || ^14.0.0",
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0"
   },
-  "gitHead": "cd3d7a2c76a3824b176e00957ff69b2dda2b879b"
+  "gitHead": "55bb437395fc4d6d3886fdd7c058b843022630b8"
 }

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

@@ -1,7 +0,0 @@
-export type MiddlewareOptions = {
-    /** Sets the `Link` response header to notify search engines about content in other languages (defaults to `true`). See https://developers.google.com/search/docs/specialty/international/localized-versions#http */
-    alternateLinks?: boolean;
-    /** By setting this to `false`, the cookie as well as the `accept-language` header will no longer be used for locale detection. */
-    localeDetection?: boolean;
-};
-export type ResolvedMiddlewareOptions = Required<MiddlewareOptions>;