intor-translator 1.0.3 → 1.0.5

package/dist/index.cjs

@@ -126,6 +126,12 @@ var hasKey = ({
 }) => {
   const messages = messagesRef.current;
   const locale = localeRef.current;
+  if (!messages) {
+    throw new Error("[intor-translator] 'messages' is required");
+  }
+  if (!locale) {
+    throw new Error("[intor-translator] 'locale' is required");
+  }
   const localesToTry = resolveLocalesToTry(targetLocale || locale);
   return findMessageInLocales({ messages, localesToTry, key }) ? true : false;
 };
@@ -160,6 +166,12 @@ var translate = ({
 }) => {
   const messages = messagesRef.current;
   const locale = localeRef.current;
+  if (!messages) {
+    throw new Error("[intor-translator] 'messages' is required");
+  }
+  if (!locale) {
+    throw new Error("[intor-translator] 'locale' is required");
+  }
   const isLoading = isLoadingRef.current;
   const {
     fallbackLocales,
@@ -200,9 +212,9 @@ var translate = ({
 
 // src/translators/base-translator/base-translator.ts
 var BaseTranslator = class {
-  constructor(options) {
-    this.messagesRef = { current: {} };
-    this.localeRef = { current: "" };
+  constructor(options = {}) {
+    this.messagesRef = { current: void 0 };
+    this.localeRef = { current: void 0 };
     /** Check if a key exists in the specified locale or current locale. */
     this.hasKey = (key, targetLocale) => {
       return hasKey({
@@ -212,15 +224,12 @@ var BaseTranslator = class {
         targetLocale
       });
     };
-    if (!options.messages) {
-      throw new Error("[intor-translator] 'messages' is required");
+    if (options.messages) {
+      this.messagesRef.current = options.messages;
     }
-    if (!options.locale) {
-      throw new Error("[intor-translator] 'locale' is required");
+    if (options.locale) {
+      this.localeRef.current = options.locale;
     }
-    this.options = options;
-    this.messagesRef.current = options.messages;
-    this.localeRef.current = options.locale;
   }
   /** Get all message data. */
   get messages() {
@@ -237,7 +246,7 @@ var BaseTranslator = class {
   }
   /** Change the active locale if available. */
   setLocale(newLocale) {
-    if (newLocale in this.messagesRef.current) {
+    if (this.messagesRef.current && newLocale in this.messagesRef.current) {
       this.localeRef.current = newLocale;
       return true;
     }
@@ -260,7 +269,7 @@ var CoreTranslator = class extends BaseTranslator {
         replacements
       });
     };
-    this.options = options;
+    this.options = options || {};
   }
   /** Get the current loading state. */
   get isLoading() {
@@ -311,7 +320,6 @@ var ScopeTranslator = class extends CoreTranslator {
         }
       };
     };
-    this.options = options;
   }
 };
 

package/dist/index.d.cts

@@ -262,6 +262,14 @@ type ResolvePathType<T, P extends string> = P extends `${infer Head}.${infer Tai
  * ScopedLeafKeys<Messages, "auth.login"> → "success" | "failed"
  */
 type ScopedLeafKeys<M extends LocaleNamespaceMessages, K extends string, D extends number = DefaultDepth> = UnionLocaleMessages<M> extends infer ResolvedLocaleMessages ? ResolvedLocaleMessages extends object ? LeafKeys<ResolvePathType<ResolvedLocaleMessages, K>, D> : never : never;
+/**
+ * Infer valid key type from locale messages.
+ *
+ * If `M` is not passed or empty, fallback to `string`.
+ */
+type InferTranslatorKey<M extends LocaleNamespaceMessages> = [
+    M
+] extends [never] ? string : UnionLocaleLeafKeys<M>;
 
 /**
  * A ref object holding all localized messages by locale.
@@ -275,7 +283,7 @@ type ScopedLeafKeys<M extends LocaleNamespaceMessages, K extends string, D exten
  * };
  */
 type MessagesRef<M extends LocaleNamespaceMessages> = {
-    current: Readonly<M>;
+    current?: Readonly<M>;
 };
 /**
  * A ref object holding the currently selected locale.
@@ -286,7 +294,7 @@ type MessagesRef<M extends LocaleNamespaceMessages> = {
  * };
  */
 type LocaleRef<M extends LocaleNamespaceMessages> = {
-    current: LocaleKey<M>;
+    current?: LocaleKey<M>;
 };
 /**
  * A ref object indicating whether translation is loading.
@@ -337,43 +345,42 @@ type TranslateContext = {
 };
 
 interface BaseTranslatorOptions<M extends LocaleNamespaceMessages> {
-    messages: Readonly<M>;
-    locale: LocaleKey<M>;
+    messages?: Readonly<M>;
+    locale?: LocaleKey<M>;
 }
 
-declare class BaseTranslator<M extends LocaleNamespaceMessages> {
-    protected options: BaseTranslatorOptions<M>;
+declare class BaseTranslator<M extends LocaleNamespaceMessages = never> {
     protected messagesRef: MessagesRef<M>;
     protected localeRef: LocaleRef<M>;
-    constructor(options: BaseTranslatorOptions<M>);
+    constructor(options?: BaseTranslatorOptions<M>);
     /** Get all message data. */
-    get messages(): M;
+    get messages(): M | undefined;
     /** Replace messages with new ones. */
     setMessages(messages: M): void;
     /** Get the current active locale. */
-    get locale(): LocaleKey<M>;
+    get locale(): LocaleKey<M> | undefined;
     /** Change the active locale if available. */
     setLocale(newLocale: LocaleKey<M>): boolean;
     /** Check if a key exists in the specified locale or current locale. */
-    hasKey: (key: UnionLocaleLeafKeys<M>, targetLocale?: LocaleKey<M>) => boolean;
+    hasKey: (key: InferTranslatorKey<M>, targetLocale?: LocaleKey<M>) => boolean;
 }
 
 interface CoreTranslatorOptions<M extends LocaleNamespaceMessages> extends BaseTranslatorOptions<M>, TranslateConfig {
 }
 
-declare class CoreTranslator<M extends LocaleNamespaceMessages> extends BaseTranslator<M> {
+declare class CoreTranslator<M extends LocaleNamespaceMessages = never> extends BaseTranslator<M> {
     protected options: CoreTranslatorOptions<M>;
     protected isLoadingRef: IsLoadingRef;
-    constructor(options: CoreTranslatorOptions<M>);
+    constructor(options?: CoreTranslatorOptions<M>);
     /** Get the current loading state. */
     get isLoading(): boolean;
     /** Set the loading state. */
     setLoading(state: boolean): void;
-    t: <Result = string>(key: UnionLocaleLeafKeys<M>, replacements?: Replacement | RichReplacement) => Result;
+    t: <Result = string>(key: InferTranslatorKey<M>, replacements?: Replacement | RichReplacement) => Result;
 }
 
-declare class ScopeTranslator<M extends LocaleNamespaceMessages> extends CoreTranslator<M> {
-    constructor(options: CoreTranslatorOptions<M>);
+declare class ScopeTranslator<M extends LocaleNamespaceMessages = never> extends CoreTranslator<M> {
+    constructor(options?: CoreTranslatorOptions<M>);
     scoped: <K extends NodeKeys<UnionLocaleMessages<M>> & string, ScopedKeys extends ScopedLeafKeys<M, K> & string>(preKey: K) => {
         hasKey: (key?: ScopedKeys | undefined, targetLocale?: string) => boolean;
         t: (key?: ScopedKeys | undefined, replacements?: Replacement | RichReplacement) => string;

package/dist/index.d.ts

@@ -262,6 +262,14 @@ type ResolvePathType<T, P extends string> = P extends `${infer Head}.${infer Tai
  * ScopedLeafKeys<Messages, "auth.login"> → "success" | "failed"
  */
 type ScopedLeafKeys<M extends LocaleNamespaceMessages, K extends string, D extends number = DefaultDepth> = UnionLocaleMessages<M> extends infer ResolvedLocaleMessages ? ResolvedLocaleMessages extends object ? LeafKeys<ResolvePathType<ResolvedLocaleMessages, K>, D> : never : never;
+/**
+ * Infer valid key type from locale messages.
+ *
+ * If `M` is not passed or empty, fallback to `string`.
+ */
+type InferTranslatorKey<M extends LocaleNamespaceMessages> = [
+    M
+] extends [never] ? string : UnionLocaleLeafKeys<M>;
 
 /**
  * A ref object holding all localized messages by locale.
@@ -275,7 +283,7 @@ type ScopedLeafKeys<M extends LocaleNamespaceMessages, K extends string, D exten
  * };
  */
 type MessagesRef<M extends LocaleNamespaceMessages> = {
-    current: Readonly<M>;
+    current?: Readonly<M>;
 };
 /**
  * A ref object holding the currently selected locale.
@@ -286,7 +294,7 @@ type MessagesRef<M extends LocaleNamespaceMessages> = {
  * };
  */
 type LocaleRef<M extends LocaleNamespaceMessages> = {
-    current: LocaleKey<M>;
+    current?: LocaleKey<M>;
 };
 /**
  * A ref object indicating whether translation is loading.
@@ -337,43 +345,42 @@ type TranslateContext = {
 };
 
 interface BaseTranslatorOptions<M extends LocaleNamespaceMessages> {
-    messages: Readonly<M>;
-    locale: LocaleKey<M>;
+    messages?: Readonly<M>;
+    locale?: LocaleKey<M>;
 }
 
-declare class BaseTranslator<M extends LocaleNamespaceMessages> {
-    protected options: BaseTranslatorOptions<M>;
+declare class BaseTranslator<M extends LocaleNamespaceMessages = never> {
     protected messagesRef: MessagesRef<M>;
     protected localeRef: LocaleRef<M>;
-    constructor(options: BaseTranslatorOptions<M>);
+    constructor(options?: BaseTranslatorOptions<M>);
     /** Get all message data. */
-    get messages(): M;
+    get messages(): M | undefined;
     /** Replace messages with new ones. */
     setMessages(messages: M): void;
     /** Get the current active locale. */
-    get locale(): LocaleKey<M>;
+    get locale(): LocaleKey<M> | undefined;
     /** Change the active locale if available. */
     setLocale(newLocale: LocaleKey<M>): boolean;
     /** Check if a key exists in the specified locale or current locale. */
-    hasKey: (key: UnionLocaleLeafKeys<M>, targetLocale?: LocaleKey<M>) => boolean;
+    hasKey: (key: InferTranslatorKey<M>, targetLocale?: LocaleKey<M>) => boolean;
 }
 
 interface CoreTranslatorOptions<M extends LocaleNamespaceMessages> extends BaseTranslatorOptions<M>, TranslateConfig {
 }
 
-declare class CoreTranslator<M extends LocaleNamespaceMessages> extends BaseTranslator<M> {
+declare class CoreTranslator<M extends LocaleNamespaceMessages = never> extends BaseTranslator<M> {
     protected options: CoreTranslatorOptions<M>;
     protected isLoadingRef: IsLoadingRef;
-    constructor(options: CoreTranslatorOptions<M>);
+    constructor(options?: CoreTranslatorOptions<M>);
     /** Get the current loading state. */
     get isLoading(): boolean;
     /** Set the loading state. */
     setLoading(state: boolean): void;
-    t: <Result = string>(key: UnionLocaleLeafKeys<M>, replacements?: Replacement | RichReplacement) => Result;
+    t: <Result = string>(key: InferTranslatorKey<M>, replacements?: Replacement | RichReplacement) => Result;
 }
 
-declare class ScopeTranslator<M extends LocaleNamespaceMessages> extends CoreTranslator<M> {
-    constructor(options: CoreTranslatorOptions<M>);
+declare class ScopeTranslator<M extends LocaleNamespaceMessages = never> extends CoreTranslator<M> {
+    constructor(options?: CoreTranslatorOptions<M>);
     scoped: <K extends NodeKeys<UnionLocaleMessages<M>> & string, ScopedKeys extends ScopedLeafKeys<M, K> & string>(preKey: K) => {
         hasKey: (key?: ScopedKeys | undefined, targetLocale?: string) => boolean;
         t: (key?: ScopedKeys | undefined, replacements?: Replacement | RichReplacement) => string;

package/dist/index.js

@@ -124,6 +124,12 @@ var hasKey = ({
 }) => {
   const messages = messagesRef.current;
   const locale = localeRef.current;
+  if (!messages) {
+    throw new Error("[intor-translator] 'messages' is required");
+  }
+  if (!locale) {
+    throw new Error("[intor-translator] 'locale' is required");
+  }
   const localesToTry = resolveLocalesToTry(targetLocale || locale);
   return findMessageInLocales({ messages, localesToTry, key }) ? true : false;
 };
@@ -158,6 +164,12 @@ var translate = ({
 }) => {
   const messages = messagesRef.current;
   const locale = localeRef.current;
+  if (!messages) {
+    throw new Error("[intor-translator] 'messages' is required");
+  }
+  if (!locale) {
+    throw new Error("[intor-translator] 'locale' is required");
+  }
   const isLoading = isLoadingRef.current;
   const {
     fallbackLocales,
@@ -198,9 +210,9 @@ var translate = ({
 
 // src/translators/base-translator/base-translator.ts
 var BaseTranslator = class {
-  constructor(options) {
-    this.messagesRef = { current: {} };
-    this.localeRef = { current: "" };
+  constructor(options = {}) {
+    this.messagesRef = { current: void 0 };
+    this.localeRef = { current: void 0 };
     /** Check if a key exists in the specified locale or current locale. */
     this.hasKey = (key, targetLocale) => {
       return hasKey({
@@ -210,15 +222,12 @@ var BaseTranslator = class {
         targetLocale
       });
     };
-    if (!options.messages) {
-      throw new Error("[intor-translator] 'messages' is required");
+    if (options.messages) {
+      this.messagesRef.current = options.messages;
     }
-    if (!options.locale) {
-      throw new Error("[intor-translator] 'locale' is required");
+    if (options.locale) {
+      this.localeRef.current = options.locale;
     }
-    this.options = options;
-    this.messagesRef.current = options.messages;
-    this.localeRef.current = options.locale;
   }
   /** Get all message data. */
   get messages() {
@@ -235,7 +244,7 @@ var BaseTranslator = class {
   }
   /** Change the active locale if available. */
   setLocale(newLocale) {
-    if (newLocale in this.messagesRef.current) {
+    if (this.messagesRef.current && newLocale in this.messagesRef.current) {
       this.localeRef.current = newLocale;
       return true;
     }
@@ -258,7 +267,7 @@ var CoreTranslator = class extends BaseTranslator {
         replacements
       });
     };
-    this.options = options;
+    this.options = options || {};
   }
   /** Get the current loading state. */
   get isLoading() {
@@ -309,7 +318,6 @@ var ScopeTranslator = class extends CoreTranslator {
         }
       };
     };
-    this.options = options;
   }
 };
 

package/package.json

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