intor-translator 1.0.9 → 1.0.11

package/dist/index.d.cts

@@ -161,7 +161,7 @@ type LocaleNamespaceMessages = Record<Locale, NamespaceMessages>;
  * type Result = UnionLocaleMessages<typeof messages>;
  * // Result: { auth: { login: "Login" } } | { auth: { logout: "登出" } }
  */
-type UnionLocaleMessages<M> = M[LocaleKey<M>];
+type UnionLocaleMessages<M> = M[StrictLocaleKey<M>];
 
 /**
  * Extracts the locale keys from the messages object as string literals.
@@ -173,7 +173,28 @@ type UnionLocaleMessages<M> = M[LocaleKey<M>];
  * }>;
  * // Locales is "en" | "zh-TW"
  */
-type LocaleKey<M> = keyof M & string;
+type StrictLocaleKey<M> = keyof M & string;
+/**
+ * Extracts locale keys only when M is a valid messages object.
+ *
+ * When M is a concrete `LocaleNamespaceMessages`, the locale key
+ * will be inferred as a union of its top-level keys like `"en" | "zh-TW"`.
+ * Otherwise, falls back to a generic `string`.
+ *
+ * This helps retain intellisense when `messages` is provided,
+ * but avoids TypeScript errors when M is left as `unknown`.
+ *
+ * @example
+ * type Locales = LocaleKey<{
+ *   en: {};
+ *   fr: {};
+ * }>;
+ * //   → "en" | "fr"
+ *
+ * type Fallback = LocaleKey<unknown>;
+ * //   → string
+ */
+type LocaleKey<M = unknown> = M extends LocaleNamespaceMessages ? StrictLocaleKey<M> : string;
 /**
  * A map that defines fallback locales for each base locale.
  *
@@ -342,7 +363,7 @@ type TranslateContext = {
     replacements?: Replacement | RichReplacement;
 };
 
-interface BaseTranslatorOptions<M> {
+interface BaseTranslatorOptions<M = unknown> {
     messages?: Readonly<M>;
     locale?: LocaleKey<M>;
 }
@@ -394,4 +415,4 @@ declare class ScopeTranslator<M = unknown> extends CoreTranslator<M> {
     };
 }
 
-export { type FallbackLocalesMap, type FormatMessage, type IsLoadingRef, type LeafKeys, type Locale, type LocaleKey, type LocaleNamespaceMessages, type LocaleRef, type Message, type MessageRecord, type MessagesRef, type Namespace, type NamespaceMessages, type NestedMessage, type NodeKeys, type OnLoading, type OnMissing, type Replacement, type RichReplacement, type ScopedLeafKeys, type TranslateConfig, type TranslateContext, type TranslateHandlers, ScopeTranslator as Translator, type UnionLocaleLeafKeys, type UnionLocaleMessages };
+export { type FallbackLocalesMap, type FormatMessage, type IsLoadingRef, type LeafKeys, type Locale, type LocaleKey, type LocaleNamespaceMessages, type LocaleRef, type Message, type MessageRecord, type MessagesRef, type Namespace, type NamespaceMessages, type NestedMessage, type NodeKeys, type OnLoading, type OnMissing, type Replacement, type RichReplacement, type ScopedLeafKeys, type StrictLocaleKey, type TranslateConfig, type TranslateContext, type TranslateHandlers, ScopeTranslator as Translator, type UnionLocaleLeafKeys, type UnionLocaleMessages };

package/dist/index.d.ts

@@ -161,7 +161,7 @@ type LocaleNamespaceMessages = Record<Locale, NamespaceMessages>;
  * type Result = UnionLocaleMessages<typeof messages>;
  * // Result: { auth: { login: "Login" } } | { auth: { logout: "登出" } }
  */
-type UnionLocaleMessages<M> = M[LocaleKey<M>];
+type UnionLocaleMessages<M> = M[StrictLocaleKey<M>];
 
 /**
  * Extracts the locale keys from the messages object as string literals.
@@ -173,7 +173,28 @@ type UnionLocaleMessages<M> = M[LocaleKey<M>];
  * }>;
  * // Locales is "en" | "zh-TW"
  */
-type LocaleKey<M> = keyof M & string;
+type StrictLocaleKey<M> = keyof M & string;
+/**
+ * Extracts locale keys only when M is a valid messages object.
+ *
+ * When M is a concrete `LocaleNamespaceMessages`, the locale key
+ * will be inferred as a union of its top-level keys like `"en" | "zh-TW"`.
+ * Otherwise, falls back to a generic `string`.
+ *
+ * This helps retain intellisense when `messages` is provided,
+ * but avoids TypeScript errors when M is left as `unknown`.
+ *
+ * @example
+ * type Locales = LocaleKey<{
+ *   en: {};
+ *   fr: {};
+ * }>;
+ * //   → "en" | "fr"
+ *
+ * type Fallback = LocaleKey<unknown>;
+ * //   → string
+ */
+type LocaleKey<M = unknown> = M extends LocaleNamespaceMessages ? StrictLocaleKey<M> : string;
 /**
  * A map that defines fallback locales for each base locale.
  *
@@ -342,7 +363,7 @@ type TranslateContext = {
     replacements?: Replacement | RichReplacement;
 };
 
-interface BaseTranslatorOptions<M> {
+interface BaseTranslatorOptions<M = unknown> {
     messages?: Readonly<M>;
     locale?: LocaleKey<M>;
 }
@@ -394,4 +415,4 @@ declare class ScopeTranslator<M = unknown> extends CoreTranslator<M> {
     };
 }
 
-export { type FallbackLocalesMap, type FormatMessage, type IsLoadingRef, type LeafKeys, type Locale, type LocaleKey, type LocaleNamespaceMessages, type LocaleRef, type Message, type MessageRecord, type MessagesRef, type Namespace, type NamespaceMessages, type NestedMessage, type NodeKeys, type OnLoading, type OnMissing, type Replacement, type RichReplacement, type ScopedLeafKeys, type TranslateConfig, type TranslateContext, type TranslateHandlers, ScopeTranslator as Translator, type UnionLocaleLeafKeys, type UnionLocaleMessages };
+export { type FallbackLocalesMap, type FormatMessage, type IsLoadingRef, type LeafKeys, type Locale, type LocaleKey, type LocaleNamespaceMessages, type LocaleRef, type Message, type MessageRecord, type MessagesRef, type Namespace, type NamespaceMessages, type NestedMessage, type NodeKeys, type OnLoading, type OnMissing, type Replacement, type RichReplacement, type ScopedLeafKeys, type StrictLocaleKey, type TranslateConfig, type TranslateContext, type TranslateHandlers, ScopeTranslator as Translator, type UnionLocaleLeafKeys, type UnionLocaleMessages };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "intor-translator",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "A type safe translator that knows what to say and how to handle the rest. Supports custom messages, rich replacements, and async loading.",
   "author": "Yiming Liao",
   "license": "MIT",