use-intl 2.19.1 → 3.0.0-beta.1

package/dist/src/react/useTranslations.js

@@ -1,21 +0,0 @@
-import useIntlContext from './useIntlContext';
-import useTranslationsImpl from './useTranslationsImpl';
-/**
- * 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(namespace) {
-    const context = useIntlContext();
-    const messages = context.messages;
-    // We have to wrap the actual hook so the type inference for the optional
-    // namespace works correctly. See https://stackoverflow.com/a/71529575/343045
-    // The prefix ("!") is arbitrary.
-    return useTranslationsImpl({ '!': messages }, 
-    // @ts-ignore
-    namespace ? `!.${namespace}` : '!', '!');
-}
-//# sourceMappingURL=useTranslations.js.map

package/dist/src/react/useTranslations.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useTranslations.js","sourceRoot":"","sources":["../../../src/react/useTranslations.tsx"],"names":[],"mappings":"AASA,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,mBAAmB,MAAM,uBAAuB,CAAC;AAExD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAMrC,SAAqB;IA6DrB,MAAM,OAAO,GAAG,cAAc,EAAE,CAAC;IACjC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAwB,CAAC;IAElD,yEAAyE;IACzE,6EAA6E;IAC7E,iCAAiC;IACjC,OAAO,mBAAmB,CAIxB,EAAC,GAAG,EAAE,QAAQ,EAAC;IACf,aAAa;IACb,SAAS,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC,CAAC,CAAC,GAAG,EAClC,GAAG,CACJ,CAAC;AACJ,CAAC"}

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

@@ -1,8 +0,0 @@
-/// <reference types="react" />
-import AbstractIntlMessages from '../core/AbstractIntlMessages';
-import NestedKeyOf from '../core/utils/NestedKeyOf';
-export default function useTranslationsImpl<Messages extends AbstractIntlMessages, NestedKey extends NestedKeyOf<Messages>>(allMessages: Messages, namespace: NestedKey, namespacePrefix: string): {
-    <TargetKey extends unknown>(key: TargetKey, values?: import("../core/TranslationValues").default | undefined, formats?: Partial<import("../core/Formats").default> | undefined): string;
-    rich: (key: string, values?: import("..").RichTranslationValues | undefined, formats?: Partial<import("../core/Formats").default> | undefined) => string | import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>> | import("react").ReactNodeArray;
-    raw(key: string): any;
-};

package/dist/src/react/useTranslationsImpl.js

@@ -1,35 +0,0 @@
-import { useMemo, useRef } from 'react';
-import createBaseTranslator, { getMessagesOrError } from '../core/createBaseTranslator';
-import resolveNamespace from '../core/resolveNamespace';
-import useIntlContext from './useIntlContext';
-export default function useTranslationsImpl(allMessages, namespace, namespacePrefix) {
-    const { defaultTranslationValues, formats: globalFormats, getMessageFallback, locale, onError, timeZone } = useIntlContext();
-    // The `namespacePrefix` is part of the type system.
-    // See the comment in the hook invocation.
-    allMessages = allMessages[namespacePrefix];
-    namespace = resolveNamespace(namespace, namespacePrefix);
-    const cachedFormatsByLocaleRef = useRef({});
-    const messagesOrError = useMemo(() => getMessagesOrError({ messages: allMessages, namespace, onError }), [allMessages, namespace, onError]);
-    const translate = useMemo(() => createBaseTranslator({
-        cachedFormatsByLocale: cachedFormatsByLocaleRef.current,
-        getMessageFallback,
-        messagesOrError,
-        defaultTranslationValues,
-        namespace,
-        onError,
-        formats: globalFormats,
-        locale,
-        timeZone
-    }), [
-        getMessageFallback,
-        messagesOrError,
-        defaultTranslationValues,
-        namespace,
-        onError,
-        globalFormats,
-        locale,
-        timeZone
-    ]);
-    return translate;
-}
-//# sourceMappingURL=useTranslationsImpl.js.map

package/dist/src/react/useTranslationsImpl.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useTranslationsImpl.js","sourceRoot":"","sources":["../../../src/react/useTranslationsImpl.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAC,OAAO,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AAEtC,OAAO,oBAAoB,EAAE,EAC3B,kBAAkB,EACnB,MAAM,8BAA8B,CAAC;AACtC,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AAExD,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAGzC,WAAqB,EAAE,SAAoB,EAAE,eAAuB;IACpE,MAAM,EACJ,wBAAwB,EACxB,OAAO,EAAE,aAAa,EACtB,kBAAkB,EAClB,MAAM,EACN,OAAO,EACP,QAAQ,EACT,GAAG,cAAc,EAAE,CAAC;IAErB,oDAAoD;IACpD,0CAA0C;IAC1C,WAAW,GAAG,WAAW,CAAC,eAAe,CAAa,CAAC;IACvD,SAAS,GAAG,gBAAgB,CAAC,SAAS,EAAE,eAAe,CAAc,CAAC;IAEtE,MAAM,wBAAwB,GAAG,MAAM,CAErC,EAAE,CAAC,CAAC;IAEN,MAAM,eAAe,GAAG,OAAO,CAC7B,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAC,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,OAAO,EAAC,CAAC,EACrE,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,CAAC,CAClC,CAAC;IAEF,MAAM,SAAS,GAAG,OAAO,CACvB,GAAG,EAAE,CACH,oBAAoB,CAAC;QACnB,qBAAqB,EAAE,wBAAwB,CAAC,OAAO;QACvD,kBAAkB;QAClB,eAAe;QACf,wBAAwB;QACxB,SAAS;QACT,OAAO;QACP,OAAO,EAAE,aAAa;QACtB,MAAM;QACN,QAAQ;KACT,CAAC,EACJ;QACE,kBAAkB;QAClB,eAAe;QACf,wBAAwB;QACxB,SAAS;QACT,OAAO;QACP,aAAa;QACb,MAAM;QACN,QAAQ;KACT,CACF,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/src/core/AbstractIntlMessages.tsx

@@ -1,10 +0,0 @@
-/** A generic type that describes the shape of messages.
- *
- * Optionally `IntlMessages` can be provided to get type safety for message
- * namespaces and keys. See https://next-intl-docs.vercel.app/docs/usage/typescript
- */
-type AbstractIntlMessages = {
-  [id: string]: AbstractIntlMessages | string;
-};
-
-export default AbstractIntlMessages;

package/src/core/DateTimeFormatOptions.tsx

@@ -1,130 +0,0 @@
-// https://github.com/microsoft/TypeScript/issues/35865
-
-import TimeZone from './TimeZone';
-
-/**
- * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat
- */
-type DateTimeFormatOptions = Intl.DateTimeFormatOptions & {
-  /**
-   * Examples:
-   * - numeric: "2021"
-   * - 2-digit: "21"
-   */
-  year?: 'numeric' | '2-digit';
-
-  /** Examples:
-   * - numeric: "3"
-   * - 2-digit: "03"
-   * - long: "March"
-   * - short: "Mar"
-   * - narrow: "M"
-   */
-  month?: 'numeric' | '2-digit' | 'long' | 'short' | 'narrow';
-
-  /** Examples:
-   * - numeric: "2"
-   * - 2-digit: "02"
-   */
-  day?: 'numeric' | '2-digit';
-
-  /** Examples:
-   * - numeric: "2"
-   * - 2-digit: "02"
-   */
-  hour?: 'numeric' | '2-digit';
-
-  /** Examples:
-   * - numeric: "2"
-   * - 2-digit: "02"
-   */
-  minute?: 'numeric' | '2-digit';
-
-  /** Examples:
-   * - numeric: "2"
-   * - 2-digit: "02"
-   */
-  second?: 'numeric' | '2-digit';
-
-  /** Examples:
-   * - long: "Thursday"
-   * - short: "Thu"
-   * - narrow: "T"
-   */
-  weekday?: 'long' | 'short' | 'narrow';
-
-  /** Examples:
-   * - long: "Anno Domini"
-   * - short: "AD", narrow "A"
-   */
-  era?: 'long' | 'short' | 'narrow';
-
-  /** If this is set to `true`, a 12-hour am/pm format is used. Otherwise a 24-hour time.
-   *
-   */
-  hour12?: boolean;
-
-  /** Examples:
-   * - long: "Pacific Daylight Time"
-   * - short: "PDT"
-   */
-  timeZoneName?: 'long' | 'short';
-
-  /**
-   * One of the [database names from the TZ database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
-   */
-  timeZone?: TimeZone;
-
-  localeMatcher?: 'best fit' | 'lookup';
-
-  formatMatcher?: 'best fit' | 'basic';
-
-  dateStyle?: 'full' | 'long' | 'medium' | 'short';
-
-  timeStyle?: 'full' | 'long' | 'medium' | 'short';
-
-  calendar?:
-    | 'buddhist'
-    | 'chinese'
-    | 'coptic'
-    | 'ethiopia'
-    | 'ethiopic'
-    | 'gregory'
-    | 'hebrew'
-    | 'indian'
-    | 'islamic'
-    | 'iso8601'
-    | 'japanese'
-    | 'persian'
-    | 'roc';
-
-  dayPeriod?: 'narrow' | 'short' | 'long';
-
-  numberingSystem?:
-    | 'arab'
-    | 'arabext'
-    | 'bali'
-    | 'beng'
-    | 'deva'
-    | 'fullwide'
-    | 'gujr'
-    | 'guru'
-    | 'hanidec'
-    | 'khmr'
-    | 'knda'
-    | 'laoo'
-    | 'latn'
-    | 'limb'
-    | 'mlym'
-    | 'mong'
-    | 'mymr'
-    | 'orya'
-    | 'tamldec'
-    | 'telu'
-    | 'thai'
-    | 'tibt';
-
-  hourCycle?: 'h11' | 'h12' | 'h23' | 'h24';
-};
-
-export default DateTimeFormatOptions;

package/src/core/Formats.tsx

@@ -1,10 +0,0 @@
-import DateTimeFormatOptions from './DateTimeFormatOptions';
-import NumberFormatOptions from './NumberFormatOptions';
-
-type Formats = {
-  number: Record<string, NumberFormatOptions>;
-  dateTime: Record<string, DateTimeFormatOptions>;
-  list: Record<string, Intl.ListFormatOptions>;
-};
-
-export default Formats;

package/src/core/IntlConfig.tsx

@@ -1,59 +0,0 @@
-import Formats from './Formats';
-import IntlError from './IntlError';
-import TimeZone from './TimeZone';
-import {AbstractIntlMessages, RichTranslationValues} from '.';
-
-/**
- * Should be used for entry points that configure the library.
- */
-
-type IntlConfig<Messages = AbstractIntlMessages> = {
-  /** A valid Unicode locale tag (e.g. "en" or "en-GB"). */
-  locale: string;
-  /** Global formats can be provided to achieve consistent
-   * formatting across components. */
-  formats?: Partial<Formats>;
-  /** A time zone as defined in [the tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) which will be applied when formatting dates and times. If this is absent, the user time zone will be used. You can override this by supplying an explicit time zone to `formatDateTime`. */
-  timeZone?: TimeZone;
-  /** This callback will be invoked when an error is encountered during
-   * resolving a message or formatting it. This defaults to `console.error` to
-   * keep your app running. You can customize the handling by taking
-   * `error.code` into account. */
-  onError?(error: IntlError): void;
-  /** Will be called when a message couldn't be resolved or formatting it led to
-   * an error. This defaults to `${namespace}.${key}` You can use this to
-   * customize what will be rendered in this case. */
-  getMessageFallback?(info: {
-    error: IntlError;
-    key: string;
-    namespace?: string;
-  }): string;
-  /**
-   * Providing this value will have two effects:
-   * 1. It will be used as the default for the `now` argument of
-   *    `useIntl().formatRelativeTime` if no explicit value is provided.
-   * 2. It will be returned as a static value from the `useNow` hook. Note
-   *    however that when `updateInterval` is configured on the `useNow` hook,
-   *    the global `now` value will only be used for the initial render, but
-   *    afterwards the current date will be returned continuously.
-   */
-  now?: Date;
-  /** All messages that will be available. */
-  messages?: Messages;
-  /** Global default values for translation values and rich text elements.
-   * Can be used for consistent usage or styling of rich text elements.
-   * Defaults will be overidden by locally provided values. */
-  defaultTranslationValues?: RichTranslationValues;
-};
-
-/**
- * A stricter set of the configuration that should be used internally
- * once defaults are assigned to `IntlConfiguration`.
- */
-export type InitializedIntlConfig<Messages = AbstractIntlMessages> =
-  IntlConfig<Messages> & {
-    onError: NonNullable<IntlConfig<Messages>['onError']>;
-    getMessageFallback: NonNullable<IntlConfig<Messages>['getMessageFallback']>;
-  };
-
-export default IntlConfig;

package/src/core/IntlError.tsx

@@ -1,26 +0,0 @@
-export enum IntlErrorCode {
-  MISSING_MESSAGE = 'MISSING_MESSAGE',
-  MISSING_FORMAT = 'MISSING_FORMAT',
-  INSUFFICIENT_PATH = 'INSUFFICIENT_PATH',
-  INVALID_MESSAGE = 'INVALID_MESSAGE',
-  INVALID_KEY = 'INVALID_KEY',
-  FORMATTING_ERROR = 'FORMATTING_ERROR'
-}
-
-export default class IntlError extends Error {
-  public readonly code: IntlErrorCode;
-  public readonly originalMessage: string | undefined;
-
-  constructor(code: IntlErrorCode, originalMessage?: string) {
-    let message: string = code;
-    if (originalMessage) {
-      message += ': ' + originalMessage;
-    }
-    super(message);
-
-    this.code = code;
-    if (originalMessage) {
-      this.originalMessage = originalMessage;
-    }
-  }
-}

package/src/core/NumberFormatOptions.tsx

@@ -1,3 +0,0 @@
-import type {NumberFormatOptions} from '@formatjs/ecma402-abstract/types/number';
-
-export default NumberFormatOptions;