@lingui/core 6.0.1 → 6.2.0

package/dist/index.d.mts

@@ -60,15 +60,40 @@ type Values = Record<string, unknown>;
 type UncompiledMessage = string;
 type Messages = Record<string, UncompiledMessage | CompiledMessage>;
 type AllMessages = Record<Locale, Messages>;
+/**
+ * Register interface for module augmentation.
+ * Users can augment this interface to narrow MessageId to a specific union type.
+ *
+ * @example
+ * ```ts
+ * // src/lingui.d.ts
+ * import type enMessages from "./locales/en/messages.json";
+ *
+ * declare module "@lingui/core" {
+ *   interface Register {
+ *     messageIds: keyof typeof enMessages;
+ *   }
+ * }
+ * ```
+ */
+interface Register {
+}
+/**
+ * Resolves to the registered message ID union, or falls back to `string`
+ * when no augmentation exists.
+ */
+type MessageId = Register extends {
+    messageIds: infer TIds extends string;
+} ? TIds : string;
 type MessageDescriptor = {
-    id: string;
+    id: MessageId;
     comment?: string;
     message?: string;
     values?: Record<string, unknown>;
 };
 type MissingMessageEvent = {
     locale: Locale;
-    id: string;
+    id: MessageId;
 };
 type MissingHandler = string | ((locale: string, id: string) => string);
 type I18nProps = {
@@ -125,7 +150,7 @@ declare class I18n extends EventEmitter<Events> {
     loadAndActivate({ locale, locales, messages }: LoadAndActivateOptions): void;
     activate(locale: Locale, locales?: Locales): void;
     _(descriptor: MessageDescriptor): string;
-    _(id: string, values?: Values, options?: MessageOptions): string;
+    _(id: MessageId, values?: Values, options?: MessageOptions): string;
     /**
      * Alias for {@see I18n._}
      */
@@ -144,4 +169,4 @@ declare function setupI18n(params?: I18nProps): I18n;
 declare const i18n: I18n;
 
 export { I18n, formats, i18n, setupI18n };
-export type { AllMessages, Locale, Locales, MessageDescriptor, MessageOptions, Messages };
+export type { AllMessages, Locale, Locales, MessageDescriptor, MessageId, MessageOptions, Messages, Register };

package/dist/index.mjs

@@ -344,9 +344,9 @@ class I18n extends EventEmitter {
 > ${translation}
 
 That means you use raw catalog or your catalog doesn't have a translation for the message and fallback was used.
-ICU features such as interpolation and plurals will not work properly for that message. 
+ICU features such as interpolation and plurals will not work properly for that message.
 
-Please compile your catalog first. 
+Please compile your catalog first.
 `);
       }
     }

package/macro/index.d.mts

@@ -1,4 +1,4 @@
-import type { I18n, MessageDescriptor } from "@lingui/core"
+import type { I18n, MessageDescriptor, MessageId } from "@lingui/core"
 
 export type ChoiceOptions = {
   /** Offset of value when calculating plural forms */
@@ -17,11 +17,11 @@ export type ChoiceOptions = {
 
 export type MacroMessageDescriptor = (
   | {
-      id: string
+      id: MessageId
       message?: string
     }
   | {
-      id?: string
+      id?: MessageId
       message: string
     }
 ) & {
@@ -126,7 +126,7 @@ export function t(i18n: I18n): {
  */
 export function plural(
   value: number | string | LabeledExpression<number | string>,
-  options: ChoiceOptions
+  options: ChoiceOptions,
 ): string
 
 /**
@@ -151,7 +151,7 @@ export function plural(
  */
 export function selectOrdinal(
   value: number | string | LabeledExpression<number | string>,
-  options: ChoiceOptions
+  options: ChoiceOptions,
 ): string
 
 type SelectOptions = {
@@ -182,7 +182,7 @@ type SelectOptions = {
  */
 export function select(
   value: string | LabeledExpression<string>,
-  choices: SelectOptions
+  choices: SelectOptions,
 ): string
 
 /**
@@ -203,7 +203,7 @@ export function select(
  * @param descriptor The message descriptor
  */
 export function defineMessage(
-  descriptor: MacroMessageDescriptor
+  descriptor: MacroMessageDescriptor,
 ): MessageDescriptor
 
 /**
@@ -232,4 +232,4 @@ export const msg: typeof defineMessage
 /**
  * Helps to define a name for a variable in the message
  */
-export function ph(def: LabeledExpression<string | number>): string
+export function ph(def: LabeledExpression<string | number>): string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/core",
-  "version": "6.0.1",
+  "version": "6.2.0",
   "sideEffects": false,
   "description": "Internationalization (i18n) tools for JavaScript",
   "type": "module",
@@ -55,11 +55,12 @@
     "macro/index.mjs"
   ],
   "dependencies": {
-    "@lingui/babel-plugin-lingui-macro": "6.0.1",
-    "@lingui/message-utils": "6.0.1"
+    "@lingui/babel-plugin-lingui-macro": "6.2.0",
+    "@lingui/message-utils": "6.2.0"
   },
   "devDependencies": {
     "@lingui/test-utils": "3.0.3",
+    "typescript": "catalog:",
     "unbuild": "catalog:",
     "vitest": "catalog:"
   },
@@ -74,5 +75,5 @@
   "unbuild": {
     "declaration": "node16"
   },
-  "gitHead": "a710fd3c6dca7406a5b0ee219e99474586e93e59"
+  "gitHead": "9f2a37bc4a9e3de323b4b9094898e8f05cf05956"
 }