@lingui/react 4.8.0-next.1 → 4.10.0

package/dist/server.d.ts

@@ -1,45 +1,44 @@
-import React, { ComponentType } from 'react';
-import { MessageOptions, I18n } from '@lingui/core';
+export { c as TransNoContext, T as TransProps, b as TransRenderCallbackOrComponent, a as TransRenderProps } from './shared/react.a673be03.js';
+import { I18n } from '@lingui/core';
+import 'react';
 
-type TransRenderProps = {
-    id: string;
-    translation: React.ReactNode;
-    children: React.ReactNode;
-    message?: string | null;
-    /**
-     * @deprecated isTranslated prop is undocumented and buggy. It'll be removed in v5 release.
-     * */
-    isTranslated: boolean;
-};
-type TransRenderCallbackOrComponent = {
-    component?: undefined;
-    render?: ((props: TransRenderProps) => React.ReactElement<any, any>) | null;
-} | {
-    component?: React.ComponentType<TransRenderProps> | null;
-    render?: undefined;
-};
-type TransProps = {
-    id: string;
-    message?: string;
-    values?: Record<string, unknown>;
-    components?: {
-        [key: string]: React.ElementType | any;
-    };
-    formats?: MessageOptions["formats"];
-    comment?: string;
-    children?: React.ReactNode;
-} & TransRenderCallbackOrComponent;
 /**
- * Version of `<Trans>` component without using a Provider/Context React feature.
- * Primarily made for support React Server Components (RSC)
+ * This is an entry point for React Server Components (RSC)
  *
- * @experimental the api of this component is not stabilized yet.
+ * The RSC uses a static analysis to find any non-valid function calls in the import graph.
+ * That means this entry point and it's children should not have any Provider/Context calls.
  */
-declare function TransNoContext(props: TransProps & {
-    lingui: {
-        i18n: I18n;
-        defaultComponent?: ComponentType<TransRenderProps>;
-    };
-}): React.ReactElement<any, any> | null;
 
-export { TransNoContext, type TransProps, type TransRenderCallbackOrComponent, type TransRenderProps };
+/**
+ * Set Lingui's i18n instance for later use in RSC Components
+ *
+ * Example:
+ *
+ * ```js
+ * import { setupI18n } from "@lingui/core";
+ *
+ * const i18n = setupI18n({
+ *   locale,
+ *   messages: { [locale]: messages },
+ * })
+ *
+ * setI18n(i18n);
+ * ```
+ */
+declare function setI18n(i18n: I18n): void;
+/**
+ * Get Lingui's i18n instance saved for RSC
+ *
+ * ```js
+ * export function generateMetadata() {
+ *   const i18n = getI18n()
+ *
+ *   return {
+ *     title: t(i18n)`Translation Demo`,
+ *   }
+ * }
+ * ```
+ */
+declare function getI18n(): I18n | null;
+
+export { getI18n, setI18n };

package/dist/server.mjs

@@ -1,133 +1,20 @@
+export { T as TransNoContext } from './shared/react.1d406965.mjs';
 import React from 'react';
 
-const tagRe = /<([a-zA-Z0-9]+)>(.*?)<\/\1>|<([a-zA-Z0-9]+)\/>/;
-const nlRe = /(?:\r\n|\r|\n)/g;
-const voidElementTags = {
-  area: true,
-  base: true,
-  br: true,
-  col: true,
-  embed: true,
-  hr: true,
-  img: true,
-  input: true,
-  keygen: true,
-  link: true,
-  meta: true,
-  param: true,
-  source: true,
-  track: true,
-  wbr: true,
-  menuitem: true
-};
-function formatElements(value, elements = {}) {
-  const uniqueId = makeCounter(0, "$lingui$");
-  const parts = value.replace(nlRe, "").split(tagRe);
-  if (parts.length === 1)
-    return value;
-  const tree = [];
-  const before = parts.shift();
-  if (before)
-    tree.push(before);
-  for (const [index, children, after] of getElements(parts)) {
-    let element = typeof index !== "undefined" ? elements[index] : void 0;
-    if (!element || voidElementTags[element.type] && children) {
-      if (!element) {
-        console.error(
-          `Can't use element at index '${index}' as it is not declared in the original translation`
-        );
-      } else {
-        console.error(
-          `${element.type} is a void element tag therefore it must have no children`
-        );
-      }
-      element = React.createElement(React.Fragment);
-    }
-    if (Array.isArray(element)) {
-      element = React.createElement(React.Fragment, {}, element);
-    }
-    tree.push(
-      React.cloneElement(
-        element,
-        { key: uniqueId() },
-        // format children for pair tags
-        // unpaired tags might have children if it's a component passed as a variable
-        children ? formatElements(children, elements) : element.props.children
-      )
-    );
-    if (after)
-      tree.push(after);
+let cache = null;
+const getLinguiCache = () => {
+  if (!cache) {
+    cache = React.cache(() => ({
+      current: null
+    }));
   }
-  return tree;
+  return cache();
+};
+function setI18n(i18n) {
+  getLinguiCache().current = i18n;
 }
-function getElements(parts) {
-  if (!parts.length)
-    return [];
-  const [paired, children, unpaired, after] = parts.slice(0, 4);
-  const triple = [paired || unpaired, children || "", after];
-  return [triple].concat(getElements(parts.slice(4, parts.length)));
+function getI18n() {
+  return getLinguiCache().current;
 }
-const makeCounter = (count = 0, prefix = "") => () => `${prefix}_${count++}`;
-
-function TransNoContext(props) {
-  const {
-    render,
-    component,
-    id,
-    message,
-    formats,
-    lingui: { i18n, defaultComponent }
-  } = props;
-  const values = { ...props.values };
-  const components = { ...props.components };
-  if (values) {
-    Object.keys(values).forEach((key) => {
-      const value = values[key];
-      const valueIsReactEl = React.isValidElement(value) || Array.isArray(value) && value.every(React.isValidElement);
-      if (!valueIsReactEl)
-        return;
-      const index = Object.keys(components).length;
-      components[index] = value;
-      values[key] = `<${index}/>`;
-    });
-  }
-  const _translation = i18n && typeof i18n._ === "function" ? i18n._(id, values, { message, formats }) : id;
-  const translation = _translation ? formatElements(_translation, components) : null;
-  if (render === null || component === null) {
-    return translation;
-  }
-  const FallbackComponent = defaultComponent || RenderFragment;
-  const i18nProps = {
-    id,
-    message,
-    translation,
-    // TODO vonovak - remove isTranslated prop in v5 release
-    isTranslated: id !== translation && message !== translation,
-    children: translation
-    // for type-compatibility with `component` prop
-  };
-  if (render && component) {
-    console.error(
-      "You can't use both `component` and `render` prop at the same time. `component` is ignored."
-    );
-  } else if (render && typeof render !== "function") {
-    console.error(
-      `Invalid value supplied to prop \`render\`. It must be a function, provided ${render}`
-    );
-  } else if (component && typeof component !== "function") {
-    console.error(
-      `Invalid value supplied to prop \`component\`. It must be a React component, provided ${component}`
-    );
-    return React.createElement(FallbackComponent, i18nProps, translation);
-  }
-  if (typeof render === "function") {
-    return render(i18nProps);
-  }
-  const Component = component || FallbackComponent;
-  return React.createElement(Component, i18nProps, translation);
-}
-const RenderFragment = ({ children }) => {
-  return /* @__PURE__ */ React.createElement(React.Fragment, null, children);
-};
 
-export { TransNoContext };
+export { getI18n, setI18n };

package/dist/shared/react.145db227.d.mts

@@ -0,0 +1,17 @@
+import React, { ComponentType, FunctionComponent } from 'react';
+import { I18n } from '@lingui/core';
+import { a as TransRenderProps } from './react.a673be03.mjs';
+
+type I18nContext = {
+    i18n: I18n;
+    _: I18n["_"];
+    defaultComponent?: ComponentType<TransRenderProps>;
+};
+type I18nProviderProps = Omit<I18nContext, "_"> & {
+    children?: React.ReactNode;
+};
+declare const LinguiContext: React.Context<I18nContext | null>;
+declare function useLingui(): I18nContext;
+declare const I18nProvider: FunctionComponent<I18nProviderProps>;
+
+export { I18nProvider as I, LinguiContext as L, type I18nProviderProps as a, type I18nContext as b, useLingui as u };

package/dist/shared/react.1d406965.mjs

@@ -0,0 +1,133 @@
+import React from 'react';
+
+const tagRe = /<([a-zA-Z0-9]+)>(.*?)<\/\1>|<([a-zA-Z0-9]+)\/>/;
+const nlRe = /(?:\r\n|\r|\n)/g;
+const voidElementTags = {
+  area: true,
+  base: true,
+  br: true,
+  col: true,
+  embed: true,
+  hr: true,
+  img: true,
+  input: true,
+  keygen: true,
+  link: true,
+  meta: true,
+  param: true,
+  source: true,
+  track: true,
+  wbr: true,
+  menuitem: true
+};
+function formatElements(value, elements = {}) {
+  const uniqueId = makeCounter(0, "$lingui$");
+  const parts = value.replace(nlRe, "").split(tagRe);
+  if (parts.length === 1)
+    return value;
+  const tree = [];
+  const before = parts.shift();
+  if (before)
+    tree.push(before);
+  for (const [index, children, after] of getElements(parts)) {
+    let element = typeof index !== "undefined" ? elements[index] : void 0;
+    if (!element || voidElementTags[element.type] && children) {
+      if (!element) {
+        console.error(
+          `Can't use element at index '${index}' as it is not declared in the original translation`
+        );
+      } else {
+        console.error(
+          `${element.type} is a void element tag therefore it must have no children`
+        );
+      }
+      element = React.createElement(React.Fragment);
+    }
+    if (Array.isArray(element)) {
+      element = React.createElement(React.Fragment, {}, element);
+    }
+    tree.push(
+      React.cloneElement(
+        element,
+        { key: uniqueId() },
+        // format children for pair tags
+        // unpaired tags might have children if it's a component passed as a variable
+        children ? formatElements(children, elements) : element.props.children
+      )
+    );
+    if (after)
+      tree.push(after);
+  }
+  return tree;
+}
+function getElements(parts) {
+  if (!parts.length)
+    return [];
+  const [paired, children, unpaired, after] = parts.slice(0, 4);
+  const triple = [paired || unpaired, children || "", after];
+  return [triple].concat(getElements(parts.slice(4, parts.length)));
+}
+const makeCounter = (count = 0, prefix = "") => () => `${prefix}_${count++}`;
+
+function TransNoContext(props) {
+  const {
+    render,
+    component,
+    id,
+    message,
+    formats,
+    lingui: { i18n, defaultComponent }
+  } = props;
+  const values = { ...props.values };
+  const components = { ...props.components };
+  if (values) {
+    Object.keys(values).forEach((key) => {
+      const value = values[key];
+      const valueIsReactEl = React.isValidElement(value) || Array.isArray(value) && value.every(React.isValidElement);
+      if (!valueIsReactEl)
+        return;
+      const index = Object.keys(components).length;
+      components[index] = value;
+      values[key] = `<${index}/>`;
+    });
+  }
+  const _translation = i18n && typeof i18n._ === "function" ? i18n._(id, values, { message, formats }) : id;
+  const translation = _translation ? formatElements(_translation, components) : null;
+  if (render === null || component === null) {
+    return translation;
+  }
+  const FallbackComponent = defaultComponent || RenderFragment;
+  const i18nProps = {
+    id,
+    message,
+    translation,
+    // TODO vonovak - remove isTranslated prop in v5 release
+    isTranslated: id !== translation && message !== translation,
+    children: translation
+    // for type-compatibility with `component` prop
+  };
+  if (render && component) {
+    console.error(
+      "You can't use both `component` and `render` prop at the same time. `component` is ignored."
+    );
+  } else if (render && typeof render !== "function") {
+    console.error(
+      `Invalid value supplied to prop \`render\`. It must be a function, provided ${render}`
+    );
+  } else if (component && typeof component !== "function") {
+    console.error(
+      `Invalid value supplied to prop \`component\`. It must be a React component, provided ${component}`
+    );
+    return React.createElement(FallbackComponent, i18nProps, translation);
+  }
+  if (typeof render === "function") {
+    return render(i18nProps);
+  }
+  const Component = component || FallbackComponent;
+  return React.createElement(Component, i18nProps, translation);
+}
+const RenderFragment = ({ children }) => {
+  return /* @__PURE__ */ React.createElement(React.Fragment, null, children);
+};
+
+export { TransNoContext as T };

package/dist/shared/react.6b65948d.cjs

@@ -0,0 +1,139 @@
+'use strict';
+
+const React = require('react');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const React__default = /*#__PURE__*/_interopDefaultCompat(React);
+
+const tagRe = /<([a-zA-Z0-9]+)>(.*?)<\/\1>|<([a-zA-Z0-9]+)\/>/;
+const nlRe = /(?:\r\n|\r|\n)/g;
+const voidElementTags = {
+  area: true,
+  base: true,
+  br: true,
+  col: true,
+  embed: true,
+  hr: true,
+  img: true,
+  input: true,
+  keygen: true,
+  link: true,
+  meta: true,
+  param: true,
+  source: true,
+  track: true,
+  wbr: true,
+  menuitem: true
+};
+function formatElements(value, elements = {}) {
+  const uniqueId = makeCounter(0, "$lingui$");
+  const parts = value.replace(nlRe, "").split(tagRe);
+  if (parts.length === 1)
+    return value;
+  const tree = [];
+  const before = parts.shift();
+  if (before)
+    tree.push(before);
+  for (const [index, children, after] of getElements(parts)) {
+    let element = typeof index !== "undefined" ? elements[index] : void 0;
+    if (!element || voidElementTags[element.type] && children) {
+      if (!element) {
+        console.error(
+          `Can't use element at index '${index}' as it is not declared in the original translation`
+        );
+      } else {
+        console.error(
+          `${element.type} is a void element tag therefore it must have no children`
+        );
+      }
+      element = React__default.createElement(React__default.Fragment);
+    }
+    if (Array.isArray(element)) {
+      element = React__default.createElement(React__default.Fragment, {}, element);
+    }
+    tree.push(
+      React__default.cloneElement(
+        element,
+        { key: uniqueId() },
+        // format children for pair tags
+        // unpaired tags might have children if it's a component passed as a variable
+        children ? formatElements(children, elements) : element.props.children
+      )
+    );
+    if (after)
+      tree.push(after);
+  }
+  return tree;
+}
+function getElements(parts) {
+  if (!parts.length)
+    return [];
+  const [paired, children, unpaired, after] = parts.slice(0, 4);
+  const triple = [paired || unpaired, children || "", after];
+  return [triple].concat(getElements(parts.slice(4, parts.length)));
+}
+const makeCounter = (count = 0, prefix = "") => () => `${prefix}_${count++}`;
+
+function TransNoContext(props) {
+  const {
+    render,
+    component,
+    id,
+    message,
+    formats,
+    lingui: { i18n, defaultComponent }
+  } = props;
+  const values = { ...props.values };
+  const components = { ...props.components };
+  if (values) {
+    Object.keys(values).forEach((key) => {
+      const value = values[key];
+      const valueIsReactEl = React__default.isValidElement(value) || Array.isArray(value) && value.every(React__default.isValidElement);
+      if (!valueIsReactEl)
+        return;
+      const index = Object.keys(components).length;
+      components[index] = value;
+      values[key] = `<${index}/>`;
+    });
+  }
+  const _translation = i18n && typeof i18n._ === "function" ? i18n._(id, values, { message, formats }) : id;
+  const translation = _translation ? formatElements(_translation, components) : null;
+  if (render === null || component === null) {
+    return translation;
+  }
+  const FallbackComponent = defaultComponent || RenderFragment;
+  const i18nProps = {
+    id,
+    message,
+    translation,
+    // TODO vonovak - remove isTranslated prop in v5 release
+    isTranslated: id !== translation && message !== translation,
+    children: translation
+    // for type-compatibility with `component` prop
+  };
+  if (render && component) {
+    console.error(
+      "You can't use both `component` and `render` prop at the same time. `component` is ignored."
+    );
+  } else if (render && typeof render !== "function") {
+    console.error(
+      `Invalid value supplied to prop \`render\`. It must be a function, provided ${render}`
+    );
+  } else if (component && typeof component !== "function") {
+    console.error(
+      `Invalid value supplied to prop \`component\`. It must be a React component, provided ${component}`
+    );
+    return React__default.createElement(FallbackComponent, i18nProps, translation);
+  }
+  if (typeof render === "function") {
+    return render(i18nProps);
+  }
+  const Component = component || FallbackComponent;
+  return React__default.createElement(Component, i18nProps, translation);
+}
+const RenderFragment = ({ children }) => {
+  return /* @__PURE__ */ React__default.createElement(React__default.Fragment, null, children);
+};
+
+exports.TransNoContext = TransNoContext;

package/dist/shared/react.80f80298.d.ts

@@ -0,0 +1,17 @@
+import React, { ComponentType, FunctionComponent } from 'react';
+import { I18n } from '@lingui/core';
+import { a as TransRenderProps } from './react.a673be03.js';
+
+type I18nContext = {
+    i18n: I18n;
+    _: I18n["_"];
+    defaultComponent?: ComponentType<TransRenderProps>;
+};
+type I18nProviderProps = Omit<I18nContext, "_"> & {
+    children?: React.ReactNode;
+};
+declare const LinguiContext: React.Context<I18nContext | null>;
+declare function useLingui(): I18nContext;
+declare const I18nProvider: FunctionComponent<I18nProviderProps>;
+
+export { I18nProvider as I, LinguiContext as L, type I18nProviderProps as a, type I18nContext as b, useLingui as u };

package/dist/shared/react.a673be03.d.cts

@@ -0,0 +1,45 @@
+import React, { ComponentType } from 'react';
+import { MessageOptions, I18n } from '@lingui/core';
+
+type TransRenderProps = {
+    id: string;
+    translation: React.ReactNode;
+    children: React.ReactNode;
+    message?: string | null;
+    /**
+     * @deprecated isTranslated prop is undocumented and buggy. It'll be removed in v5 release.
+     * */
+    isTranslated: boolean;
+};
+type TransRenderCallbackOrComponent = {
+    component?: undefined;
+    render?: ((props: TransRenderProps) => React.ReactElement<any, any>) | null;
+} | {
+    component?: React.ComponentType<TransRenderProps> | null;
+    render?: undefined;
+};
+type TransProps = {
+    id: string;
+    message?: string;
+    values?: Record<string, unknown>;
+    components?: {
+        [key: string]: React.ElementType | any;
+    };
+    formats?: MessageOptions["formats"];
+    comment?: string;
+    children?: React.ReactNode;
+} & TransRenderCallbackOrComponent;
+/**
+ * Version of `<Trans>` component without using a Provider/Context React feature.
+ * Primarily made for support React Server Components (RSC)
+ *
+ * @experimental the api of this component is not stabilized yet.
+ */
+declare function TransNoContext(props: TransProps & {
+    lingui: {
+        i18n: I18n;
+        defaultComponent?: ComponentType<TransRenderProps>;
+    };
+}): React.ReactElement<any, any> | null;
+
+export { type TransProps as T, type TransRenderProps as a, type TransRenderCallbackOrComponent as b, TransNoContext as c };

package/dist/shared/react.a673be03.d.mts

@@ -0,0 +1,45 @@
+import React, { ComponentType } from 'react';
+import { MessageOptions, I18n } from '@lingui/core';
+
+type TransRenderProps = {
+    id: string;
+    translation: React.ReactNode;
+    children: React.ReactNode;
+    message?: string | null;
+    /**
+     * @deprecated isTranslated prop is undocumented and buggy. It'll be removed in v5 release.
+     * */
+    isTranslated: boolean;
+};
+type TransRenderCallbackOrComponent = {
+    component?: undefined;
+    render?: ((props: TransRenderProps) => React.ReactElement<any, any>) | null;
+} | {
+    component?: React.ComponentType<TransRenderProps> | null;
+    render?: undefined;
+};
+type TransProps = {
+    id: string;
+    message?: string;
+    values?: Record<string, unknown>;
+    components?: {
+        [key: string]: React.ElementType | any;
+    };
+    formats?: MessageOptions["formats"];
+    comment?: string;
+    children?: React.ReactNode;
+} & TransRenderCallbackOrComponent;
+/**
+ * Version of `<Trans>` component without using a Provider/Context React feature.
+ * Primarily made for support React Server Components (RSC)
+ *
+ * @experimental the api of this component is not stabilized yet.
+ */
+declare function TransNoContext(props: TransProps & {
+    lingui: {
+        i18n: I18n;
+        defaultComponent?: ComponentType<TransRenderProps>;
+    };
+}): React.ReactElement<any, any> | null;
+
+export { type TransProps as T, type TransRenderProps as a, type TransRenderCallbackOrComponent as b, TransNoContext as c };

package/dist/shared/react.a673be03.d.ts

@@ -0,0 +1,45 @@
+import React, { ComponentType } from 'react';
+import { MessageOptions, I18n } from '@lingui/core';
+
+type TransRenderProps = {
+    id: string;
+    translation: React.ReactNode;
+    children: React.ReactNode;
+    message?: string | null;
+    /**
+     * @deprecated isTranslated prop is undocumented and buggy. It'll be removed in v5 release.
+     * */
+    isTranslated: boolean;
+};
+type TransRenderCallbackOrComponent = {
+    component?: undefined;
+    render?: ((props: TransRenderProps) => React.ReactElement<any, any>) | null;
+} | {
+    component?: React.ComponentType<TransRenderProps> | null;
+    render?: undefined;
+};
+type TransProps = {
+    id: string;
+    message?: string;
+    values?: Record<string, unknown>;
+    components?: {
+        [key: string]: React.ElementType | any;
+    };
+    formats?: MessageOptions["formats"];
+    comment?: string;
+    children?: React.ReactNode;
+} & TransRenderCallbackOrComponent;
+/**
+ * Version of `<Trans>` component without using a Provider/Context React feature.
+ * Primarily made for support React Server Components (RSC)
+ *
+ * @experimental the api of this component is not stabilized yet.
+ */
+declare function TransNoContext(props: TransProps & {
+    lingui: {
+        i18n: I18n;
+        defaultComponent?: ComponentType<TransRenderProps>;
+    };
+}): React.ReactElement<any, any> | null;
+
+export { type TransProps as T, type TransRenderProps as a, type TransRenderCallbackOrComponent as b, TransNoContext as c };

package/dist/shared/react.db09d9c7.d.cts

@@ -0,0 +1,17 @@
+import React, { ComponentType, FunctionComponent } from 'react';
+import { I18n } from '@lingui/core';
+import { a as TransRenderProps } from './react.a673be03.cjs';
+
+type I18nContext = {
+    i18n: I18n;
+    _: I18n["_"];
+    defaultComponent?: ComponentType<TransRenderProps>;
+};
+type I18nProviderProps = Omit<I18nContext, "_"> & {
+    children?: React.ReactNode;
+};
+declare const LinguiContext: React.Context<I18nContext | null>;
+declare function useLingui(): I18nContext;
+declare const I18nProvider: FunctionComponent<I18nProviderProps>;
+
+export { I18nProvider as I, LinguiContext as L, type I18nProviderProps as a, type I18nContext as b, useLingui as u };