use-intl 3.25.0 → 4.0.0-beta-00a79d4

package/dist/types/{src/react → react}/useIntlContext.d.ts

@@ -1,2 +1,2 @@
-import { IntlContextValue } from './IntlContext';
+import { type IntlContextValue } from './IntlContext.tsx';
 export default function useIntlContext(): IntlContextValue;

package/dist/types/react/useLocale.d.ts

@@ -0,0 +1,2 @@
+import type { Locale } from '../core.tsx';
+export default function useLocale(): Locale;

package/dist/types/react/useMessages.d.ts

@@ -0,0 +1,2 @@
+import type { Messages } from '../core/AppConfig.tsx';
+export default function useMessages(): Messages;

package/dist/types/react/useNow.d.ts

@@ -0,0 +1,8 @@
+type Options = {
+    updateInterval?: number;
+};
+/**
+ * @see https://next-intl-docs.vercel.app/docs/usage/dates-times#relative-times-usenow
+ */
+export default function useNow(options?: Options): Date;
+export {};

package/dist/types/react/useTimeZone.d.ts

@@ -0,0 +1 @@
+export default function useTimeZone(): import("../core.tsx").Timezone | undefined;

package/dist/types/react/useTranslations.d.ts

@@ -0,0 +1,12 @@
+import type { Messages } from '../core/AppConfig.tsx';
+import type { NamespaceKeys, NestedKeyOf } from '../core/MessageKeys.tsx';
+import type createTranslator from '../core/createTranslator.tsx';
+/**
+ * Translates messages from the given namespace by using the ICU syntax.
+ * See https://formatjs.io/docs/core-concepts/icu-syntax.
+ *
+ * If no namespace is provided, all available messages are returned.
+ * The namespace can also indicate nesting by using a dot
+ * (e.g. `namespace.Component`).
+ */
+export default function useTranslations<NestedKey extends NamespaceKeys<Messages, NestedKeyOf<Messages>> = never>(namespace?: NestedKey): ReturnType<typeof createTranslator<Messages, NestedKey>>;

package/dist/types/react/useTranslationsImpl.d.ts

@@ -0,0 +1,9 @@
+import type AbstractIntlMessages from '../core/AbstractIntlMessages.tsx';
+import type { NestedKeyOf } from '../core/MessageKeys.tsx';
+export default function useTranslationsImpl<Messages extends AbstractIntlMessages, NestedKey extends NestedKeyOf<Messages>>(allMessagesPrefixed: Messages, namespacePrefixed: NestedKey, namespacePrefix: string): {
+    <TargetKey extends unknown>(key: TargetKey, values?: import("../core.tsx").TranslationValues, formats?: import("../core.tsx").Formats): string;
+    rich: (key: string, values?: import("../core.tsx").RichTranslationValues, formats?: import("../core.tsx").Formats) => import("react").ReactNode;
+    markup(key: Parameters<(key: string, values?: import("../core.tsx").RichTranslationValues, formats?: import("../core.tsx").Formats) => import("react").ReactNode>[0], values: import("../core.tsx").MarkupTranslationValues, formats?: Parameters<(key: string, values?: import("../core.tsx").RichTranslationValues, formats?: import("../core.tsx").Formats) => import("react").ReactNode>[2]): string;
+    raw(key: string): any;
+    has(key: string): boolean;
+};

package/dist/types/react.d.ts

@@ -0,0 +1 @@
+export * from './react/index.tsx';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-intl",
-  "version": "3.25.0",
+  "version": "4.0.0-beta-00a79d4",
   "sideEffects": false,
   "author": "Jan Amann <jan@amann.work>",
   "description": "Internationalization (i18n) for React",
@@ -15,42 +15,35 @@
     "test": "TZ=Europe/Berlin vitest",
     "lint": "pnpm run lint:source && pnpm run lint:package",
     "lint:source": "eslint src test && tsc --noEmit && pnpm run lint:prettier",
-    "lint:package": "publint && attw --pack",
+    "lint:package": "publint && attw --pack --ignore-rules=cjs-resolves-to-esm",
     "lint:prettier": "prettier src --check",
     "prepublishOnly": "turbo build",
     "size": "size-limit"
   },
-  "main": "./dist/index.js",
-  "module": "dist/esm/index.js",
-  "typings": "./dist/types/src/index.d.ts",
+  "type": "module",
+  "main": "./dist/esm/production/index.js",
+  "typings": "./dist/types/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/types/src/index.d.ts",
-      "default": "./dist/index.js"
+      "types": "./dist/types/index.d.ts",
+      "development": "./dist/esm/development/index.js",
+      "default": "./dist/esm/production/index.js"
     },
     "./core": {
-      "types": "./core.d.ts",
-      "default": "./dist/core.js"
+      "types": "./dist/types/core.d.ts",
+      "development": "./dist/esm/development/core.js",
+      "default": "./dist/esm/production/core.js"
     },
     "./react": {
-      "types": "./react.d.ts",
-      "default": "./dist/react.js"
-    },
-    "./_useLocale": {
-      "types": "./_useLocale.d.ts",
-      "default": "./dist/_useLocale.js"
-    },
-    "./_IntlProvider": {
-      "types": "./_IntlProvider.d.ts",
-      "default": "./dist/_IntlProvider.js"
+      "types": "./dist/types/react.d.ts",
+      "development": "./dist/esm/development/react.js",
+      "default": "./dist/esm/production/react.js"
     }
   },
   "files": [
     "dist",
     "core.d.ts",
-    "react.d.ts",
-    "_useLocale.d.ts",
-    "_IntlProvider.d.ts"
+    "react.d.ts"
   ],
   "keywords": [
     "react",
@@ -65,10 +58,11 @@
   ],
   "dependencies": {
     "@formatjs/fast-memoize": "^2.2.0",
+    "@schummar/icu-type-parser": "1.21.5",
     "intl-messageformat": "^10.5.14"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || >=19.0.0-rc <19.0.0"
+    "react": "^17.0.0 || ^18.0.0 || >=19.0.0-rc <19.0.0"
   },
-  "gitHead": "4e3e9151d9b962ec36afcd19e420c49f5b316124"
+  "gitHead": "9c05cd576d214480f7459b2351f94cfa9e4aef85"
 }

package/react.d.ts

@@ -1 +1,2 @@
-export * from './dist/types/src/react';
+// Needed for projects with `moduleResolution: 'node'`
+export * from './dist/types/react.d.ts';

package/_IntlProvider.d.ts

@@ -1 +0,0 @@
-export * from './dist/types/src/_IntlProvider';

package/_useLocale.d.ts

@@ -1 +0,0 @@
-export * from './dist/types/src/_useLocale';

package/dist/_IntlProvider.js

@@ -1,7 +0,0 @@
-'use strict';
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./production/_IntlProvider.js');
-} else {
-  module.exports = require('./development/_IntlProvider.js');
-}

package/dist/_useLocale.js

@@ -1,7 +0,0 @@
-'use strict';
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./production/_useLocale.js');
-} else {
-  module.exports = require('./development/_useLocale.js');
-}

package/dist/core.js

@@ -1,7 +0,0 @@
-'use strict';
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./production/core.js');
-} else {
-  module.exports = require('./development/core.js');
-}

package/dist/development/IntlContext-BKfsnzBx.js

@@ -1,7 +0,0 @@
-'use strict';
-
-var React = require('react');
-
-const IntlContext = /*#__PURE__*/React.createContext(undefined);
-
-exports.IntlContext = IntlContext;

package/dist/development/_IntlProvider.js

@@ -1,61 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var React = require('react');
-var initializeConfig = require('./initializeConfig-BhfMSHP7.js');
-var IntlContext = require('./IntlContext-BKfsnzBx.js');
-require('@formatjs/fast-memoize');
-
-function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
-
-var React__default = /*#__PURE__*/_interopDefault(React);
-
-function IntlProvider(_ref) {
-  let {
-    children,
-    defaultTranslationValues,
-    formats,
-    getMessageFallback,
-    locale,
-    messages,
-    now,
-    onError,
-    timeZone
-  } = _ref;
-  // The formatter cache is released when the locale changes. For
-  // long-running apps with a persistent `IntlProvider` at the root,
-  // this can reduce the memory footprint (e.g. in React Native).
-  const cache = React.useMemo(() => {
-    return initializeConfig.createCache();
-  }, [locale]);
-  const formatters = React.useMemo(() => initializeConfig.createIntlFormatters(cache), [cache]);
-
-  // Memoizing this value helps to avoid triggering a re-render of all
-  // context consumers in case the configuration didn't change. However,
-  // if some of the non-primitive values change, a re-render will still
-  // be triggered. Note that there's no need to put `memo` on `IntlProvider`
-  // itself, because the `children` typically change on every render.
-  // There's some burden on the consumer side if it's important to reduce
-  // re-renders, put that's how React works.
-  // See: https://blog.isquaredsoftware.com/2020/05/blogged-answers-a-mostly-complete-guide-to-react-rendering-behavior/#context-updates-and-render-optimizations
-  const value = React.useMemo(() => ({
-    ...initializeConfig.initializeConfig({
-      locale,
-      defaultTranslationValues,
-      formats,
-      getMessageFallback,
-      messages,
-      now,
-      onError,
-      timeZone
-    }),
-    formatters,
-    cache
-  }), [cache, defaultTranslationValues, formats, formatters, getMessageFallback, locale, messages, now, onError, timeZone]);
-  return /*#__PURE__*/React__default.default.createElement(IntlContext.IntlContext.Provider, {
-    value: value
-  }, children);
-}
-
-exports.IntlProvider = IntlProvider;

package/dist/development/_useLocale-0Rl9uR82.js

@@ -1,19 +0,0 @@
-'use strict';
-
-var React = require('react');
-var IntlContext = require('./IntlContext-BKfsnzBx.js');
-
-function useIntlContext() {
-  const context = React.useContext(IntlContext.IntlContext);
-  if (!context) {
-    throw new Error('No intl context found. Have you configured the provider? See https://next-intl-docs.vercel.app/docs/usage/configuration#client-server-components' );
-  }
-  return context;
-}
-
-function useLocale() {
-  return useIntlContext().locale;
-}
-
-exports.useIntlContext = useIntlContext;
-exports.useLocale = useLocale;

package/dist/development/_useLocale.js

@@ -1,11 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var _useLocale = require('./_useLocale-0Rl9uR82.js');
-require('react');
-require('./IntlContext-BKfsnzBx.js');
-
-
-
-exports.useLocale = _useLocale.useLocale;

package/dist/development/core.js

@@ -1,69 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var initializeConfig = require('./initializeConfig-BhfMSHP7.js');
-var createFormatter = require('./createFormatter-D2v4ATzl.js');
-require('@formatjs/fast-memoize');
-require('intl-messageformat');
-require('react');
-
-function createTranslatorImpl(_ref, namespacePrefix) {
-  let {
-    messages,
-    namespace,
-    ...rest
-  } = _ref;
-  // The `namespacePrefix` is part of the type system.
-  // See the comment in the function invocation.
-  messages = messages[namespacePrefix];
-  namespace = createFormatter.resolveNamespace(namespace, namespacePrefix);
-  return createFormatter.createBaseTranslator({
-    ...rest,
-    messages,
-    namespace
-  });
-}
-
-/**
- * Translates messages from the given namespace by using the ICU syntax.
- * See https://formatjs.io/docs/core-concepts/icu-syntax.
- *
- * If no namespace is provided, all available messages are returned.
- * The namespace can also indicate nesting by using a dot
- * (e.g. `namespace.Component`).
- */
-function createTranslator(_ref) {
-  let {
-    _cache = initializeConfig.createCache(),
-    _formatters = initializeConfig.createIntlFormatters(_cache),
-    getMessageFallback = initializeConfig.defaultGetMessageFallback,
-    messages,
-    namespace,
-    onError = initializeConfig.defaultOnError,
-    ...rest
-  } = _ref;
-  // We have to wrap the actual function so the type inference for the optional
-  // namespace works correctly. See https://stackoverflow.com/a/71529575/343045
-  // The prefix ("!") is arbitrary.
-  return createTranslatorImpl({
-    ...rest,
-    onError,
-    cache: _cache,
-    formatters: _formatters,
-    getMessageFallback,
-    // @ts-expect-error `messages` is allowed to be `undefined` here and will be handled internally
-    messages: {
-      '!': messages
-    },
-    namespace: namespace ? "!.".concat(namespace) : '!'
-  }, '!');
-}
-
-exports.IntlError = initializeConfig.IntlError;
-exports.IntlErrorCode = initializeConfig.IntlErrorCode;
-exports._createCache = initializeConfig.createCache;
-exports._createIntlFormatters = initializeConfig.createIntlFormatters;
-exports.initializeConfig = initializeConfig.initializeConfig;
-exports.createFormatter = createFormatter.createFormatter;
-exports.createTranslator = createTranslator;

package/dist/development/index.js

@@ -1,31 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var initializeConfig = require('./initializeConfig-BhfMSHP7.js');
-var core = require('./core.js');
-var createFormatter = require('./createFormatter-D2v4ATzl.js');
-var _IntlProvider = require('./_IntlProvider.js');
-var react = require('./react.js');
-var _useLocale = require('./_useLocale-0Rl9uR82.js');
-require('@formatjs/fast-memoize');
-require('intl-messageformat');
-require('react');
-require('./IntlContext-BKfsnzBx.js');
-
-
-
-exports.IntlError = initializeConfig.IntlError;
-exports.IntlErrorCode = initializeConfig.IntlErrorCode;
-exports._createCache = initializeConfig.createCache;
-exports._createIntlFormatters = initializeConfig.createIntlFormatters;
-exports.initializeConfig = initializeConfig.initializeConfig;
-exports.createTranslator = core.createTranslator;
-exports.createFormatter = createFormatter.createFormatter;
-exports.IntlProvider = _IntlProvider.IntlProvider;
-exports.useFormatter = react.useFormatter;
-exports.useMessages = react.useMessages;
-exports.useNow = react.useNow;
-exports.useTimeZone = react.useTimeZone;
-exports.useTranslations = react.useTranslations;
-exports.useLocale = _useLocale.useLocale;

package/dist/development/initializeConfig-BhfMSHP7.js

@@ -1,185 +0,0 @@
-'use strict';
-
-var fastMemoize = require('@formatjs/fast-memoize');
-
-function _defineProperty(e, r, t) {
-  return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
-    value: t,
-    enumerable: !0,
-    configurable: !0,
-    writable: !0
-  }) : e[r] = t, e;
-}
-function _toPrimitive(t, r) {
-  if ("object" != typeof t || !t) return t;
-  var e = t[Symbol.toPrimitive];
-  if (void 0 !== e) {
-    var i = e.call(t, r || "default");
-    if ("object" != typeof i) return i;
-    throw new TypeError("@@toPrimitive must return a primitive value.");
-  }
-  return ("string" === r ? String : Number)(t);
-}
-function _toPropertyKey(t) {
-  var i = _toPrimitive(t, "string");
-  return "symbol" == typeof i ? i : i + "";
-}
-
-let IntlErrorCode = /*#__PURE__*/function (IntlErrorCode) {
-  IntlErrorCode["MISSING_MESSAGE"] = "MISSING_MESSAGE";
-  IntlErrorCode["MISSING_FORMAT"] = "MISSING_FORMAT";
-  IntlErrorCode["ENVIRONMENT_FALLBACK"] = "ENVIRONMENT_FALLBACK";
-  IntlErrorCode["INSUFFICIENT_PATH"] = "INSUFFICIENT_PATH";
-  IntlErrorCode["INVALID_MESSAGE"] = "INVALID_MESSAGE";
-  IntlErrorCode["INVALID_KEY"] = "INVALID_KEY";
-  IntlErrorCode["FORMATTING_ERROR"] = "FORMATTING_ERROR";
-  return IntlErrorCode;
-}({});
-class IntlError extends Error {
-  constructor(code, originalMessage) {
-    let message = code;
-    if (originalMessage) {
-      message += ': ' + originalMessage;
-    }
-    super(message);
-    _defineProperty(this, "code", void 0);
-    _defineProperty(this, "originalMessage", void 0);
-    this.code = code;
-    if (originalMessage) {
-      this.originalMessage = originalMessage;
-    }
-  }
-}
-
-function joinPath() {
-  for (var _len = arguments.length, parts = new Array(_len), _key = 0; _key < _len; _key++) {
-    parts[_key] = arguments[_key];
-  }
-  return parts.filter(Boolean).join('.');
-}
-
-/**
- * Contains defaults that are used for all entry points into the core.
- * See also `InitializedIntlConfiguration`.
- */
-
-function defaultGetMessageFallback(props) {
-  return joinPath(props.namespace, props.key);
-}
-function defaultOnError(error) {
-  console.error(error);
-}
-
-function createCache() {
-  return {
-    dateTime: {},
-    number: {},
-    message: {},
-    relativeTime: {},
-    pluralRules: {},
-    list: {},
-    displayNames: {}
-  };
-}
-function createMemoCache(store) {
-  return {
-    create() {
-      return {
-        get(key) {
-          return store[key];
-        },
-        set(key, value) {
-          store[key] = value;
-        }
-      };
-    }
-  };
-}
-function memoFn(fn, cache) {
-  return fastMemoize.memoize(fn, {
-    cache: createMemoCache(cache),
-    strategy: fastMemoize.strategies.variadic
-  });
-}
-function memoConstructor(ConstructorFn, cache) {
-  return memoFn(function () {
-    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
-      args[_key] = arguments[_key];
-    }
-    return new ConstructorFn(...args);
-  }, cache);
-}
-function createIntlFormatters(cache) {
-  const getDateTimeFormat = memoConstructor(Intl.DateTimeFormat, cache.dateTime);
-  const getNumberFormat = memoConstructor(Intl.NumberFormat, cache.number);
-  const getPluralRules = memoConstructor(Intl.PluralRules, cache.pluralRules);
-  const getRelativeTimeFormat = memoConstructor(Intl.RelativeTimeFormat, cache.relativeTime);
-  const getListFormat = memoConstructor(Intl.ListFormat, cache.list);
-  const getDisplayNames = memoConstructor(Intl.DisplayNames, cache.displayNames);
-  return {
-    getDateTimeFormat,
-    getNumberFormat,
-    getPluralRules,
-    getRelativeTimeFormat,
-    getListFormat,
-    getDisplayNames
-  };
-}
-
-function validateMessagesSegment(messages, invalidKeyLabels, parentPath) {
-  Object.entries(messages).forEach(_ref => {
-    let [key, messageOrMessages] = _ref;
-    if (key.includes('.')) {
-      let keyLabel = key;
-      if (parentPath) keyLabel += " (at ".concat(parentPath, ")");
-      invalidKeyLabels.push(keyLabel);
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-    if (messageOrMessages != null && typeof messageOrMessages === 'object') {
-      validateMessagesSegment(messageOrMessages, invalidKeyLabels, joinPath(parentPath, key));
-    }
-  });
-}
-function validateMessages(messages, onError) {
-  const invalidKeyLabels = [];
-  validateMessagesSegment(messages, invalidKeyLabels);
-  if (invalidKeyLabels.length > 0) {
-    onError(new IntlError(IntlErrorCode.INVALID_KEY, "Namespace keys can not contain the character \".\" as this is used to express nesting. Please remove it or replace it with another character.\n\nInvalid ".concat(invalidKeyLabels.length === 1 ? 'key' : 'keys', ": ").concat(invalidKeyLabels.join(', '), "\n\nIf you're migrating from a flat structure, you can convert your messages as follows:\n\nimport {set} from \"lodash\";\n\nconst input = {\n  \"one.one\": \"1.1\",\n  \"one.two\": \"1.2\",\n  \"two.one.one\": \"2.1.1\"\n};\n\nconst output = Object.entries(input).reduce(\n  (acc, [key, value]) => set(acc, key, value),\n  {}\n);\n\n// Output:\n//\n// {\n//   \"one\": {\n//     \"one\": \"1.1\",\n//     \"two\": \"1.2\"\n//   },\n//   \"two\": {\n//     \"one\": {\n//       \"one\": \"2.1.1\"\n//     }\n//   }\n// }\n") ));
-  }
-}
-
-/**
- * Enhances the incoming props with defaults.
- */
-function initializeConfig(_ref) {
-  let {
-    getMessageFallback,
-    messages,
-    onError,
-    ...rest
-  } = _ref;
-  const finalOnError = onError || defaultOnError;
-  const finalGetMessageFallback = getMessageFallback || defaultGetMessageFallback;
-  {
-    if (messages) {
-      validateMessages(messages, finalOnError);
-    }
-  }
-  return {
-    ...rest,
-    messages,
-    onError: finalOnError,
-    getMessageFallback: finalGetMessageFallback
-  };
-}
-
-exports.IntlError = IntlError;
-exports.IntlErrorCode = IntlErrorCode;
-exports.createCache = createCache;
-exports.createIntlFormatters = createIntlFormatters;
-exports.defaultGetMessageFallback = defaultGetMessageFallback;
-exports.defaultOnError = defaultOnError;
-exports.initializeConfig = initializeConfig;
-exports.joinPath = joinPath;
-exports.memoFn = memoFn;