intor-translator 1.0.12 → 1.0.13

package/dist/index.d.cts

@@ -327,6 +327,15 @@ type IsLoadingRef = {
     current: boolean;
 };
 
+type ScopedTranslatorMethods<M, K extends string> = {
+    hasKey: (key?: ScopedLeafKeys<M, K> & string, targetLocale?: LocaleKey<M>) => boolean;
+    t: (key?: ScopedLeafKeys<M, K> & string, replacements?: Replacement | RichReplacement) => string;
+};
+type TranslatorMethods<M> = {
+    hasKey: (key?: InferTranslatorKey<M> & string, targetLocale?: LocaleKey<M>) => boolean;
+    t: (key?: InferTranslatorKey<M> & string, replacements?: Replacement | RichReplacement) => string;
+};
+
 /** Config options for translation behavior. */
 type TranslateConfig<M> = {
     fallbackLocales?: FallbackLocalesMap<LocaleKey<M>>;
@@ -405,14 +414,28 @@ declare class CoreTranslator<M = unknown> extends BaseTranslator<M> {
 
 declare class ScopeTranslator<M = unknown> extends CoreTranslator<M> {
     constructor(options?: CoreTranslatorOptions<M>);
-    scoped<K extends NodeKeys<UnionLocaleMessages<M>> & string>(preKey: K): {
-        hasKey: (key?: ScopedLeafKeys<M, K> & string, targetLocale?: LocaleKey<M>) => boolean;
-        t: (key?: ScopedLeafKeys<M, K> & string, replacements?: Replacement | RichReplacement) => string;
-    };
-    scoped(): {
-        hasKey: (key?: InferTranslatorKey<M> & string, targetLocale?: LocaleKey<M>) => boolean;
-        t: (key?: InferTranslatorKey<M> & string, replacements?: Replacement | RichReplacement) => string;
-    };
+    scoped<K extends NodeKeys<UnionLocaleMessages<M>> & string>(preKey: K): ScopedTranslatorMethods<M, K>;
+    scoped(): TranslatorMethods<M>;
 }
 
-export { type FallbackLocalesMap, type FormatMessage, type InferTranslatorKey, 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 };
+/**
+ * Generic translate function type.
+ *
+ * Represents the shape of a `t()` function that supports typed keys and optional replacements.
+ *
+ * @template M - The shape of the messages object (e.g., typeof messages)
+ * @template Result - The expected return type (usually string, but can be JSX or others)
+ */
+type TranslateFunction = <M, Result = string>(key: InferTranslatorKey<M>, replacements?: Replacement | RichReplacement) => Result;
+/**
+ * Generic hasKey function type.
+ *
+ * Represents a function that checks if a given key exists in a message set,
+ * optionally for a specific locale.
+ *
+ * @template M - The shape of the messages object
+ * @template Result - The return value (default is boolean, override if needed)
+ */
+type HasKeyFunction = <M, Result = boolean>(key: InferTranslatorKey<M>, targetLocale?: LocaleKey<M>) => Result;
+
+export { type FallbackLocalesMap, type FormatMessage, type HasKeyFunction, type InferTranslatorKey, 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 TranslateFunction, type TranslateHandlers, ScopeTranslator as Translator, type UnionLocaleLeafKeys, type UnionLocaleMessages };

package/dist/index.d.ts

@@ -327,6 +327,15 @@ type IsLoadingRef = {
     current: boolean;
 };
 
+type ScopedTranslatorMethods<M, K extends string> = {
+    hasKey: (key?: ScopedLeafKeys<M, K> & string, targetLocale?: LocaleKey<M>) => boolean;
+    t: (key?: ScopedLeafKeys<M, K> & string, replacements?: Replacement | RichReplacement) => string;
+};
+type TranslatorMethods<M> = {
+    hasKey: (key?: InferTranslatorKey<M> & string, targetLocale?: LocaleKey<M>) => boolean;
+    t: (key?: InferTranslatorKey<M> & string, replacements?: Replacement | RichReplacement) => string;
+};
+
 /** Config options for translation behavior. */
 type TranslateConfig<M> = {
     fallbackLocales?: FallbackLocalesMap<LocaleKey<M>>;
@@ -405,14 +414,28 @@ declare class CoreTranslator<M = unknown> extends BaseTranslator<M> {
 
 declare class ScopeTranslator<M = unknown> extends CoreTranslator<M> {
     constructor(options?: CoreTranslatorOptions<M>);
-    scoped<K extends NodeKeys<UnionLocaleMessages<M>> & string>(preKey: K): {
-        hasKey: (key?: ScopedLeafKeys<M, K> & string, targetLocale?: LocaleKey<M>) => boolean;
-        t: (key?: ScopedLeafKeys<M, K> & string, replacements?: Replacement | RichReplacement) => string;
-    };
-    scoped(): {
-        hasKey: (key?: InferTranslatorKey<M> & string, targetLocale?: LocaleKey<M>) => boolean;
-        t: (key?: InferTranslatorKey<M> & string, replacements?: Replacement | RichReplacement) => string;
-    };
+    scoped<K extends NodeKeys<UnionLocaleMessages<M>> & string>(preKey: K): ScopedTranslatorMethods<M, K>;
+    scoped(): TranslatorMethods<M>;
 }
 
-export { type FallbackLocalesMap, type FormatMessage, type InferTranslatorKey, 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 };
+/**
+ * Generic translate function type.
+ *
+ * Represents the shape of a `t()` function that supports typed keys and optional replacements.
+ *
+ * @template M - The shape of the messages object (e.g., typeof messages)
+ * @template Result - The expected return type (usually string, but can be JSX or others)
+ */
+type TranslateFunction = <M, Result = string>(key: InferTranslatorKey<M>, replacements?: Replacement | RichReplacement) => Result;
+/**
+ * Generic hasKey function type.
+ *
+ * Represents a function that checks if a given key exists in a message set,
+ * optionally for a specific locale.
+ *
+ * @template M - The shape of the messages object
+ * @template Result - The return value (default is boolean, override if needed)
+ */
+type HasKeyFunction = <M, Result = boolean>(key: InferTranslatorKey<M>, targetLocale?: LocaleKey<M>) => Result;
+
+export { type FallbackLocalesMap, type FormatMessage, type HasKeyFunction, type InferTranslatorKey, 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 TranslateFunction, type TranslateHandlers, ScopeTranslator as Translator, type UnionLocaleLeafKeys, type UnionLocaleMessages };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "intor-translator",
-  "version": "1.0.12",
+  "version": "1.0.13",
   "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",