@lingui/core 5.1.1 → 5.2.0

package/dist/index.cjs

@@ -14,12 +14,59 @@ function normalizeLocales(locales) {
 }
 function date(locales, value, format) {
   const _locales = normalizeLocales(locales);
+  if (!format) {
+    format = "default";
+  }
+  let o;
+  if (typeof format === "string") {
+    o = {
+      day: "numeric",
+      month: "short",
+      year: "numeric"
+    };
+    switch (format) {
+      case "full":
+        o.weekday = "long";
+      case "long":
+        o.month = "long";
+        break;
+      case "short":
+        o.month = "numeric";
+        break;
+    }
+  } else {
+    o = format;
+  }
   const formatter = getMemoized(
     () => cacheKey("date", _locales, format),
-    () => new Intl.DateTimeFormat(_locales, format)
+    () => new Intl.DateTimeFormat(_locales, o)
   );
   return formatter.format(isString(value) ? new Date(value) : value);
 }
+function time(locales, value, format) {
+  let o;
+  if (!format) {
+    format = "default";
+  }
+  if (typeof format === "string") {
+    o = {
+      second: "numeric",
+      minute: "numeric",
+      hour: "numeric"
+    };
+    switch (format) {
+      case "full":
+      case "long":
+        o.timeZoneName = "short";
+        break;
+      case "short":
+        delete o.second;
+    }
+  } else {
+    o = format;
+  }
+  return date(locales, value, o);
+}
 function number(locales, value, format) {
   const _locales = normalizeLocales(locales);
   const formatter = getMemoized(
@@ -58,7 +105,8 @@ const formats = {
   date: date,
   defaultLocale: defaultLocale,
   number: number,
-  plural: plural
+  plural: plural,
+  time: time
 };
 
 const UNICODE_REGEX = /\\u[a-fA-F0-9]{4}|\\x[a-fA-F0-9]{2}/;
@@ -66,7 +114,9 @@ const OCTOTHORPE_PH = "%__lingui_octothorpe__%";
 const getDefaultFormats = (locale, passedLocales, formats = {}) => {
   const locales = passedLocales || locale;
   const style = (format) => {
-    return typeof format === "object" ? format : formats[format] || { style: format };
+    if (typeof format === "object")
+      return format;
+    return formats[format];
   };
   const replaceOctothorpe = (value, message) => {
     const numberFormat = Object.keys(formats).length ? style("number") : void 0;
@@ -85,8 +135,13 @@ const getDefaultFormats = (locale, passedLocales, formats = {}) => {
       return replaceOctothorpe(value - offset, message);
     },
     select: selectFormatter,
-    number: (value, format) => number(locales, value, style(format)),
-    date: (value, format) => date(locales, value, style(format))
+    number: (value, format) => number(
+      locales,
+      value,
+      style(format) || { style: format }
+    ),
+    date: (value, format) => date(locales, value, style(format) || format),
+    time: (value, format) => time(locales, value, style(format) || format)
   };
 };
 const selectFormatter = (value, rules) => rules[value] ?? rules.other;
@@ -132,10 +187,10 @@ function interpolate(translation, locale, locales) {
     };
     const result = formatMessage(translation);
     if (isString(result) && UNICODE_REGEX.test(result)) {
-      return unraw.unraw(result.trim());
+      return unraw.unraw(result);
     }
     if (isString(result))
-      return result.trim();
+      return result;
     return result ? String(result) : "";
   };
 }
@@ -253,9 +308,8 @@ class I18n extends EventEmitter {
   /**
    * @deprecated Plurals automatically used from Intl.PluralRules you can safely remove this call. Deprecated in v4
    */
-  // @ts-ignore deprecated, so ignore the reported error
   loadLocaleData(localeOrAllData, localeData) {
-    if (localeData != null) {
+    if (typeof localeOrAllData === "string") {
       this._loadLocaleData(localeOrAllData, localeData);
     } else {
       Object.keys(localeOrAllData).forEach(
@@ -302,6 +356,11 @@ class I18n extends EventEmitter {
     this.emit("change");
   }
   _(id, values, options) {
+    if (!this.locale) {
+      throw new Error(
+        "Lingui: Attempted to call a translation function without setting a locale.\nMake sure to call `i18n.activate(locale)` before using Lingui functions.\nThis issue may also occur due to a race condition in your initialization logic."
+      );
+    }
     let message = options?.message;
     if (!id) {
       id = "";

package/dist/index.d.cts

@@ -127,7 +127,9 @@ declare class I18n extends EventEmitter<Events> {
 declare function setupI18n(params?: I18nProps): I18n;
 
 declare const defaultLocale = "en";
-declare function date(locales: Locales, value: string | Date, format?: Intl.DateTimeFormatOptions): string;
+type DateTimeFormatSize = "short" | "default" | "long" | "full";
+declare function date(locales: Locales, value: string | Date, format?: Intl.DateTimeFormatOptions | DateTimeFormatSize): string;
+declare function time(locales: Locales, value: string | Date, format?: Intl.DateTimeFormatOptions | DateTimeFormatSize): string;
 declare function number(locales: Locales, value: number, format?: Intl.NumberFormatOptions): string;
 type PluralOptions = {
     [key: string]: Intl.LDMLPluralRule;
@@ -137,13 +139,15 @@ type PluralOptions = {
 };
 declare function plural(locales: Locales, ordinal: boolean, value: number, { offset, ...rules }: PluralOptions): string;
 
+type formats_DateTimeFormatSize = DateTimeFormatSize;
 type formats_PluralOptions = PluralOptions;
 declare const formats_date: typeof date;
 declare const formats_defaultLocale: typeof defaultLocale;
 declare const formats_number: typeof number;
 declare const formats_plural: typeof plural;
+declare const formats_time: typeof time;
 declare namespace formats {
-  export { type formats_PluralOptions as PluralOptions, formats_date as date, formats_defaultLocale as defaultLocale, formats_number as number, formats_plural as plural };
+  export { type formats_DateTimeFormatSize as DateTimeFormatSize, type formats_PluralOptions as PluralOptions, formats_date as date, formats_defaultLocale as defaultLocale, formats_number as number, formats_plural as plural, formats_time as time };
 }
 
 declare const i18n: I18n;

package/dist/index.d.mts

@@ -127,7 +127,9 @@ declare class I18n extends EventEmitter<Events> {
 declare function setupI18n(params?: I18nProps): I18n;
 
 declare const defaultLocale = "en";
-declare function date(locales: Locales, value: string | Date, format?: Intl.DateTimeFormatOptions): string;
+type DateTimeFormatSize = "short" | "default" | "long" | "full";
+declare function date(locales: Locales, value: string | Date, format?: Intl.DateTimeFormatOptions | DateTimeFormatSize): string;
+declare function time(locales: Locales, value: string | Date, format?: Intl.DateTimeFormatOptions | DateTimeFormatSize): string;
 declare function number(locales: Locales, value: number, format?: Intl.NumberFormatOptions): string;
 type PluralOptions = {
     [key: string]: Intl.LDMLPluralRule;
@@ -137,13 +139,15 @@ type PluralOptions = {
 };
 declare function plural(locales: Locales, ordinal: boolean, value: number, { offset, ...rules }: PluralOptions): string;
 
+type formats_DateTimeFormatSize = DateTimeFormatSize;
 type formats_PluralOptions = PluralOptions;
 declare const formats_date: typeof date;
 declare const formats_defaultLocale: typeof defaultLocale;
 declare const formats_number: typeof number;
 declare const formats_plural: typeof plural;
+declare const formats_time: typeof time;
 declare namespace formats {
-  export { type formats_PluralOptions as PluralOptions, formats_date as date, formats_defaultLocale as defaultLocale, formats_number as number, formats_plural as plural };
+  export { type formats_DateTimeFormatSize as DateTimeFormatSize, type formats_PluralOptions as PluralOptions, formats_date as date, formats_defaultLocale as defaultLocale, formats_number as number, formats_plural as plural, formats_time as time };
 }
 
 declare const i18n: I18n;

package/dist/index.d.ts

@@ -127,7 +127,9 @@ declare class I18n extends EventEmitter<Events> {
 declare function setupI18n(params?: I18nProps): I18n;
 
 declare const defaultLocale = "en";
-declare function date(locales: Locales, value: string | Date, format?: Intl.DateTimeFormatOptions): string;
+type DateTimeFormatSize = "short" | "default" | "long" | "full";
+declare function date(locales: Locales, value: string | Date, format?: Intl.DateTimeFormatOptions | DateTimeFormatSize): string;
+declare function time(locales: Locales, value: string | Date, format?: Intl.DateTimeFormatOptions | DateTimeFormatSize): string;
 declare function number(locales: Locales, value: number, format?: Intl.NumberFormatOptions): string;
 type PluralOptions = {
     [key: string]: Intl.LDMLPluralRule;
@@ -137,13 +139,15 @@ type PluralOptions = {
 };
 declare function plural(locales: Locales, ordinal: boolean, value: number, { offset, ...rules }: PluralOptions): string;
 
+type formats_DateTimeFormatSize = DateTimeFormatSize;
 type formats_PluralOptions = PluralOptions;
 declare const formats_date: typeof date;
 declare const formats_defaultLocale: typeof defaultLocale;
 declare const formats_number: typeof number;
 declare const formats_plural: typeof plural;
+declare const formats_time: typeof time;
 declare namespace formats {
-  export { type formats_PluralOptions as PluralOptions, formats_date as date, formats_defaultLocale as defaultLocale, formats_number as number, formats_plural as plural };
+  export { type formats_DateTimeFormatSize as DateTimeFormatSize, type formats_PluralOptions as PluralOptions, formats_date as date, formats_defaultLocale as defaultLocale, formats_number as number, formats_plural as plural, formats_time as time };
 }
 
 declare const i18n: I18n;

package/dist/index.mjs

@@ -12,12 +12,59 @@ function normalizeLocales(locales) {
 }
 function date(locales, value, format) {
   const _locales = normalizeLocales(locales);
+  if (!format) {
+    format = "default";
+  }
+  let o;
+  if (typeof format === "string") {
+    o = {
+      day: "numeric",
+      month: "short",
+      year: "numeric"
+    };
+    switch (format) {
+      case "full":
+        o.weekday = "long";
+      case "long":
+        o.month = "long";
+        break;
+      case "short":
+        o.month = "numeric";
+        break;
+    }
+  } else {
+    o = format;
+  }
   const formatter = getMemoized(
     () => cacheKey("date", _locales, format),
-    () => new Intl.DateTimeFormat(_locales, format)
+    () => new Intl.DateTimeFormat(_locales, o)
   );
   return formatter.format(isString(value) ? new Date(value) : value);
 }
+function time(locales, value, format) {
+  let o;
+  if (!format) {
+    format = "default";
+  }
+  if (typeof format === "string") {
+    o = {
+      second: "numeric",
+      minute: "numeric",
+      hour: "numeric"
+    };
+    switch (format) {
+      case "full":
+      case "long":
+        o.timeZoneName = "short";
+        break;
+      case "short":
+        delete o.second;
+    }
+  } else {
+    o = format;
+  }
+  return date(locales, value, o);
+}
 function number(locales, value, format) {
   const _locales = normalizeLocales(locales);
   const formatter = getMemoized(
@@ -56,7 +103,8 @@ const formats = {
   date: date,
   defaultLocale: defaultLocale,
   number: number,
-  plural: plural
+  plural: plural,
+  time: time
 };
 
 const UNICODE_REGEX = /\\u[a-fA-F0-9]{4}|\\x[a-fA-F0-9]{2}/;
@@ -64,7 +112,9 @@ const OCTOTHORPE_PH = "%__lingui_octothorpe__%";
 const getDefaultFormats = (locale, passedLocales, formats = {}) => {
   const locales = passedLocales || locale;
   const style = (format) => {
-    return typeof format === "object" ? format : formats[format] || { style: format };
+    if (typeof format === "object")
+      return format;
+    return formats[format];
   };
   const replaceOctothorpe = (value, message) => {
     const numberFormat = Object.keys(formats).length ? style("number") : void 0;
@@ -83,8 +133,13 @@ const getDefaultFormats = (locale, passedLocales, formats = {}) => {
       return replaceOctothorpe(value - offset, message);
     },
     select: selectFormatter,
-    number: (value, format) => number(locales, value, style(format)),
-    date: (value, format) => date(locales, value, style(format))
+    number: (value, format) => number(
+      locales,
+      value,
+      style(format) || { style: format }
+    ),
+    date: (value, format) => date(locales, value, style(format) || format),
+    time: (value, format) => time(locales, value, style(format) || format)
   };
 };
 const selectFormatter = (value, rules) => rules[value] ?? rules.other;
@@ -130,10 +185,10 @@ function interpolate(translation, locale, locales) {
     };
     const result = formatMessage(translation);
     if (isString(result) && UNICODE_REGEX.test(result)) {
-      return unraw(result.trim());
+      return unraw(result);
     }
     if (isString(result))
-      return result.trim();
+      return result;
     return result ? String(result) : "";
   };
 }
@@ -251,9 +306,8 @@ class I18n extends EventEmitter {
   /**
    * @deprecated Plurals automatically used from Intl.PluralRules you can safely remove this call. Deprecated in v4
    */
-  // @ts-ignore deprecated, so ignore the reported error
   loadLocaleData(localeOrAllData, localeData) {
-    if (localeData != null) {
+    if (typeof localeOrAllData === "string") {
       this._loadLocaleData(localeOrAllData, localeData);
     } else {
       Object.keys(localeOrAllData).forEach(
@@ -300,6 +354,11 @@ class I18n extends EventEmitter {
     this.emit("change");
   }
   _(id, values, options) {
+    if (!this.locale) {
+      throw new Error(
+        "Lingui: Attempted to call a translation function without setting a locale.\nMake sure to call `i18n.activate(locale)` before using Lingui functions.\nThis issue may also occur due to a race condition in your initialization logic."
+      );
+    }
     let message = options?.message;
     if (!id) {
       id = "";

package/macro/index.d.ts

@@ -38,7 +38,7 @@ type MacroMessageDescriptor = (
  * const message = t({
  *   id: "msg.hello",
  *   comment: "Greetings at the homepage",
- *   message: `Hello ${name}`,
+ *   message: `Hello ${{name}}`,
  * });
  * ```
  *
@@ -55,18 +55,24 @@ type MacroMessageDescriptor = (
  */
 export function t(descriptor: MacroMessageDescriptor): string
 
+export type LabeledExpression<T> = Record<string, T>
+export type MessagePlaceholder =
+  | string
+  | number
+  | LabeledExpression<string | number>
+
 /**
  * Translates a template string using the global I18n instance
  *
  * @example
  * ```
  * import { t } from "@lingui/core/macro";
- * const message = t`Hello ${name}`;
+ * const message = t`Hello ${{name}}`;
  * ```
  */
 export function t(
   literals: TemplateStringsArray,
-  ...placeholders: any[]
+  ...placeholders: MessagePlaceholder[]
 ): string
 
 /**
@@ -78,9 +84,9 @@ export function t(
  * import { I18n } from "@lingui/core";
  * const i18n = new I18n({
  *   locale: "nl",
- *   messages: { "Hello {name}": "Hallo {name}" },
+ *   messages: { "Hello {{name}}": "Hallo {{name}}" },
  * });
- * const message = t(i18n)`Hello ${name}`;
+ * const message = t(i18n)`Hello ${{name}}`;
  * ```
  *
  * @example
@@ -89,13 +95,13 @@ export function t(
  * import { I18n } from "@lingui/core";
  * const i18n = new I18n({
  *   locale: "nl",
- *   messages: { "Hello {name}": "Hallo {name}" },
+ *   messages: { "Hello {{name}}": "Hallo {{name}}" },
  * });
- * const message = t(i18n)({ message: `Hello ${name}` });
+ * const message = t(i18n)({ message: `Hello ${{name}}` });
  * ```
  *
  * @deprecated in v5, would be removed in v6.
- * Please use `` i18n._(msg`Hello ${name}`) `` instead
+ * Please use `` i18n._(msg`Hello ${{name}}`) `` instead
  *
  */
 export function t(i18n: I18n): {
@@ -109,7 +115,7 @@ export function t(i18n: I18n): {
  * @example
  * ```
  * import { plural } from "@lingui/core/macro";
- * const message = plural(count, {
+ * const message = plural({count}, {
  *   one: "# Book",
  *   other: "# Books",
  * });
@@ -118,7 +124,10 @@ export function t(i18n: I18n): {
  * @param value Determines the plural form
  * @param options Object with available plural forms
  */
-export function plural(value: number | string, options: ChoiceOptions): string
+export function plural(
+  value: number | string | LabeledExpression<number | string>,
+  options: ChoiceOptions
+): string
 
 /**
  * Pluralize a message using ordinal forms
@@ -129,7 +138,7 @@ export function plural(value: number | string, options: ChoiceOptions): string
  * @example
  * ```
  * import { selectOrdinal } from "@lingui/core/macro";
- * const message = selectOrdinal(count, {
+ * const message = selectOrdinal({count}, {
  *    one: "#st",
  *    two: "#nd",
  *    few: "#rd",
@@ -141,7 +150,7 @@ export function plural(value: number | string, options: ChoiceOptions): string
  * @param options Object with available plural forms
  */
 export function selectOrdinal(
-  value: number | string,
+  value: number | string | LabeledExpression<number | string>,
   options: ChoiceOptions
 ): string
 
@@ -161,7 +170,7 @@ type SelectOptions = {
  * @example
  * ```
  * import { select } from "@lingui/core/macro";
- * const message = select(gender, {
+ * const message = select({gender}, {
  *    male: "he",
  *    female: "she",
  *    other: "they",
@@ -171,7 +180,10 @@ type SelectOptions = {
  * @param value The key of choices to use
  * @param choices
  */
-export function select(value: string, choices: SelectOptions): string
+export function select(
+  value: string | LabeledExpression<string>,
+  choices: SelectOptions
+): string
 
 /**
  * Define a message for later use
@@ -184,7 +196,7 @@ export function select(value: string, choices: SelectOptions): string
  * import { defineMessage } from "@lingui/core/macro";
  * const message = defineMessage({
  *    comment: "Greetings on the welcome page",
- *    message: `Welcome, ${name}!`,
+ *    message: `Welcome, ${{name}}!`,
  * });
  * ```
  *
@@ -200,15 +212,15 @@ export function defineMessage(
  * @example
  * ```
  * import { defineMessage, msg } from "@lingui/core/macro";
- * const message = defineMessage`Hello ${name}`;
+ * const message = defineMessage`Hello ${{name}}`;
  *
  * // or using shorter version
- * const message = msg`Hello ${name}`;
+ * const message = msg`Hello ${{name}}`;
  * ```
  */
 export function defineMessage(
   literals: TemplateStringsArray,
-  ...placeholders: any[]
+  ...placeholders: MessagePlaceholder[]
 ): MessageDescriptor
 
 /**
@@ -216,3 +228,8 @@ export function defineMessage(
  * Alias for {@link defineMessage}
  */
 export const msg: typeof defineMessage
+
+/**
+ * Helps to define a name for a variable in the message
+ */
+export function ph(def: LabeledExpression<string | number>): string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/core",
-  "version": "5.1.1",
+  "version": "5.2.0",
   "sideEffects": false,
   "description": "I18n tools for javascript",
   "main": "./dist/index.cjs",
@@ -60,7 +60,7 @@
   ],
   "dependencies": {
     "@babel/runtime": "^7.20.13",
-    "@lingui/message-utils": "5.1.1",
+    "@lingui/message-utils": "5.2.0",
     "unraw": "^3.0.0"
   },
   "devDependencies": {
@@ -69,7 +69,7 @@
     "unbuild": "2.0.0"
   },
   "peerDependencies": {
-    "@lingui/babel-plugin-lingui-macro": "5.1.0",
+    "@lingui/babel-plugin-lingui-macro": "5.2.0",
     "babel-plugin-macros": "2 || 3"
   },
   "peerDependenciesMeta": {
@@ -80,5 +80,5 @@
       "optional": true
     }
   },
-  "gitHead": "de0517677882f1900a052018e396b94f406963d6"
+  "gitHead": "9c50b4877ca8b134d0d96c09a8055221ca70b095"
 }