intor-translator 1.1.2 → 1.1.3

package/dist/index.cjs

@@ -39,9 +39,6 @@ var hasKey = ({
 }) => {
   const messages = messagesRef.current;
   const locale = localeRef.current;
-  if (!messages) {
-    throw new Error("[intor-translator] 'messages' is required");
-  }
   const candidateLocales = resolveCandidateLocales(targetLocale || locale);
   const message = findMessageInLocales({ messages, candidateLocales, key });
   return !!message;
@@ -78,9 +75,6 @@ var translate = ({
   const messages = messagesRef.current;
   const locale = localeRef.current;
   const isLoading = isLoadingRef.current;
-  if (!messages) {
-    throw new Error("[intor-translator] 'messages' is required");
-  }
   const { fallbackLocales, loadingMessage, placeholder, handlers } = translateConfig;
   const { formatHandler, loadingHandler, missingHandler } = handlers || {};
   const candidateLocales = resolveCandidateLocales(locale, fallbackLocales);
@@ -104,11 +98,16 @@ var translate = ({
 
 // src/translators/base-translator/base-translator.ts
 var BaseTranslator = class {
+  /** Current messages for translation */
+  messagesRef;
+  /** Current active locale */
+  localeRef;
+  /** Current loading state */
+  isLoadingRef;
   constructor(options) {
-    /** Current messages for translation, updatable at runtime */
-    this.messagesRef = { current: void 0 };
-    this.messagesRef = { current: options.messages };
+    this.messagesRef = { current: options.messages ?? {} };
     this.localeRef = { current: options.locale };
+    this.isLoadingRef = { current: options.isLoading ?? false };
   }
   /** Get messages. */
   get messages() {
@@ -118,6 +117,10 @@ var BaseTranslator = class {
   get locale() {
     return this.localeRef.current;
   }
+  /** Get the current loading state. */
+  get isLoading() {
+    return this.isLoadingRef.current;
+  }
   /**
    * Replace messages with new ones.
    *
@@ -135,42 +138,39 @@ var BaseTranslator = class {
   setLocale(newLocale) {
     this.localeRef.current = newLocale;
   }
+  /** Set the loading state. */
+  setLoading(state) {
+    this.isLoadingRef.current = state;
+  }
 };
 
 // src/translators/core-translator/core-translator.ts
 var CoreTranslator = class extends BaseTranslator {
+  options;
   constructor(options) {
     super({ locale: options.locale, messages: options.messages });
-    this.isLoadingRef = { current: false };
-    /** Check if a key exists in the specified locale or current locale. */
-    this.hasKey = (key, targetLocale) => {
-      return hasKey({
-        messagesRef: this.messagesRef,
-        localeRef: this.localeRef,
-        key,
-        targetLocale
-      });
-    };
-    this.t = (key, replacements) => {
-      return translate({
-        messagesRef: this.messagesRef,
-        localeRef: this.localeRef,
-        isLoadingRef: this.isLoadingRef,
-        translateConfig: this.options,
-        key,
-        replacements
-      });
-    };
     this.options = options;
   }
-  /** Get the current loading state. */
-  get isLoading() {
-    return this.isLoadingRef.current;
-  }
-  /** Set the loading state. */
-  setLoading(state) {
-    this.isLoadingRef.current = state;
-  }
+  /** Check if a key exists in the specified locale or current locale. */
+  hasKey = (key, targetLocale) => {
+    return hasKey({
+      messagesRef: this.messagesRef,
+      localeRef: this.localeRef,
+      key,
+      targetLocale
+    });
+  };
+  /** Get the translated message for a key, with optional replacements. */
+  t = (key, replacements) => {
+    return translate({
+      messagesRef: this.messagesRef,
+      localeRef: this.localeRef,
+      isLoadingRef: this.isLoadingRef,
+      translateConfig: this.options,
+      key,
+      replacements
+    });
+  };
 };
 
 // src/utils/get-full-key.ts
@@ -185,6 +185,7 @@ var ScopeTranslator = class extends CoreTranslator {
   constructor(options) {
     super(options);
   }
+  /** Create a scoped translator with a prefix key, providing `t` and `hasKey` for nested keys. */
   scoped(preKey) {
     return {
       hasKey: (key, targetLocale) => {

package/dist/index.d.cts

@@ -21,7 +21,7 @@ type NestedMessage = string | {
  * Messages grouped by locale.
  * Used to structure all available messages for multiple locales.
  *
- * - Each key is a locale string, e.g., "en" or "zh-TW".
+ * - The root-level keys are locale identifiers, e.g., "en" or "zh-TW".
  * - Each value is a `NestedMessage`, allowing for deeply nested message objects.
  *
  * @example
@@ -260,7 +260,7 @@ type ScopedLeafKeys<M, PK extends string, L extends keyof M | "union" = "union",
  * ```
  */
 type MessagesRef<M = unknown> = {
-    current?: Readonly<M>;
+    current: Readonly<M>;
 };
 /**
  * A ref object holding the currently selected locale.
@@ -356,18 +356,26 @@ interface BaseTranslatorOptions<M = unknown> {
      * - If `messages` is typed as `LocaleMessages`, this can be inferred automatically.
      */
     locale: Locale<M>;
+    /**
+     * Indicates whether the translator is in a loading state.
+     */
+    isLoading?: boolean;
 }
 
 declare class BaseTranslator<M = unknown> {
-    /** Current messages for translation, updatable at runtime */
+    /** Current messages for translation */
     protected messagesRef: MessagesRef<M>;
-    /** Current active locale, can be changed dynamically */
+    /** Current active locale */
     protected localeRef: LocaleRef<M>;
+    /** Current loading state */
+    protected isLoadingRef: IsLoadingRef;
     constructor(options: BaseTranslatorOptions<M>);
     /** Get messages. */
     get messages(): M | undefined;
     /** Get the current active locale. */
     get locale(): Locale<M>;
+    /** Get the current loading state. */
+    get isLoading(): boolean;
     /**
      * Replace messages with new ones.
      *
@@ -381,6 +389,8 @@ declare class BaseTranslator<M = unknown> {
      * - Note: Unlike `setMessages`, the locale structure cannot be changed at runtime.
      */
     setLocale(newLocale: Locale<M>): void;
+    /** Set the loading state. */
+    setLoading(state: boolean): void;
 }
 
 interface CoreTranslatorOptions<M> extends BaseTranslatorOptions<M>, TranslateConfig<M> {
@@ -388,14 +398,10 @@ interface CoreTranslatorOptions<M> extends BaseTranslatorOptions<M>, TranslateCo
 
 declare class CoreTranslator<M = unknown, L extends keyof M | "union" = "union"> extends BaseTranslator<M> {
     protected options: CoreTranslatorOptions<M>;
-    protected isLoadingRef: IsLoadingRef;
     constructor(options: CoreTranslatorOptions<M>);
-    /** Get the current loading state. */
-    get isLoading(): boolean;
-    /** Set the loading state. */
-    setLoading(state: boolean): void;
     /** Check if a key exists in the specified locale or current locale. */
     hasKey: <K = LocalizedLeafKeys<M, L>>(key: K, targetLocale?: Locale<M>) => boolean;
+    /** Get the translated message for a key, with optional replacements. */
     t: <Result = string, K = LocalizedLeafKeys<M, L>>(key: K, replacements?: Replacement) => Result;
 }
 
@@ -407,7 +413,8 @@ type ScopeTranslatorMethods<M, L extends keyof M | "union" = "union", K = Locali
 
 declare class ScopeTranslator<M = unknown, L extends keyof M | "union" = "union"> extends CoreTranslator<M> {
     constructor(options: ScopeTranslatorOptions<M>);
+    /** Create a scoped translator with a prefix key, providing `t` and `hasKey` for nested keys. */
     scoped<PK extends LocalizedNodeKeys<M, L> | undefined = undefined>(preKey?: PK): PK extends string ? ScopeTranslatorMethods<M, L, ScopedLeafKeys<M, PK, L>> : ScopeTranslatorMethods<M, L>;
 }
 
-export { type FallbackLocalesMap, type FormatHandler, type IsLoadingRef, type LeafKeys, type LoadingHandler, type Locale, type LocaleMessages, type LocaleRef, type LocalizedLeafKeys, type LocalizedMessagesUnion, type LocalizedNodeKeys, type MessagesRef, type MissingHandler, type NestedMessage, type NodeKeys, type Replacement, ScopeTranslator, type ScopeTranslatorMethods, type ScopeTranslatorOptions, type ScopedLeafKeys, type TranslateHandlerContext, type TranslateHandlers, ScopeTranslator as Translator };
+export { type DefaultDepth, type FallbackLocalesMap, type FormatHandler, type IsLoadingRef, type LeafKeys, type LoadingHandler, type Locale, type LocaleMessages, type LocaleRef, type LocalizedLeafKeys, type LocalizedMessagesUnion, type LocalizedNodeKeys, type MessagesRef, type MissingHandler, type NestedMessage, type NodeKeys, type Replacement, ScopeTranslator, type ScopeTranslatorMethods, type ScopeTranslatorOptions, type ScopedLeafKeys, type TranslateHandlerContext, type TranslateHandlers, ScopeTranslator as Translator };

package/dist/index.d.ts

@@ -21,7 +21,7 @@ type NestedMessage = string | {
  * Messages grouped by locale.
  * Used to structure all available messages for multiple locales.
  *
- * - Each key is a locale string, e.g., "en" or "zh-TW".
+ * - The root-level keys are locale identifiers, e.g., "en" or "zh-TW".
  * - Each value is a `NestedMessage`, allowing for deeply nested message objects.
  *
  * @example
@@ -260,7 +260,7 @@ type ScopedLeafKeys<M, PK extends string, L extends keyof M | "union" = "union",
  * ```
  */
 type MessagesRef<M = unknown> = {
-    current?: Readonly<M>;
+    current: Readonly<M>;
 };
 /**
  * A ref object holding the currently selected locale.
@@ -356,18 +356,26 @@ interface BaseTranslatorOptions<M = unknown> {
      * - If `messages` is typed as `LocaleMessages`, this can be inferred automatically.
      */
     locale: Locale<M>;
+    /**
+     * Indicates whether the translator is in a loading state.
+     */
+    isLoading?: boolean;
 }
 
 declare class BaseTranslator<M = unknown> {
-    /** Current messages for translation, updatable at runtime */
+    /** Current messages for translation */
     protected messagesRef: MessagesRef<M>;
-    /** Current active locale, can be changed dynamically */
+    /** Current active locale */
     protected localeRef: LocaleRef<M>;
+    /** Current loading state */
+    protected isLoadingRef: IsLoadingRef;
     constructor(options: BaseTranslatorOptions<M>);
     /** Get messages. */
     get messages(): M | undefined;
     /** Get the current active locale. */
     get locale(): Locale<M>;
+    /** Get the current loading state. */
+    get isLoading(): boolean;
     /**
      * Replace messages with new ones.
      *
@@ -381,6 +389,8 @@ declare class BaseTranslator<M = unknown> {
      * - Note: Unlike `setMessages`, the locale structure cannot be changed at runtime.
      */
     setLocale(newLocale: Locale<M>): void;
+    /** Set the loading state. */
+    setLoading(state: boolean): void;
 }
 
 interface CoreTranslatorOptions<M> extends BaseTranslatorOptions<M>, TranslateConfig<M> {
@@ -388,14 +398,10 @@ interface CoreTranslatorOptions<M> extends BaseTranslatorOptions<M>, TranslateCo
 
 declare class CoreTranslator<M = unknown, L extends keyof M | "union" = "union"> extends BaseTranslator<M> {
     protected options: CoreTranslatorOptions<M>;
-    protected isLoadingRef: IsLoadingRef;
     constructor(options: CoreTranslatorOptions<M>);
-    /** Get the current loading state. */
-    get isLoading(): boolean;
-    /** Set the loading state. */
-    setLoading(state: boolean): void;
     /** Check if a key exists in the specified locale or current locale. */
     hasKey: <K = LocalizedLeafKeys<M, L>>(key: K, targetLocale?: Locale<M>) => boolean;
+    /** Get the translated message for a key, with optional replacements. */
     t: <Result = string, K = LocalizedLeafKeys<M, L>>(key: K, replacements?: Replacement) => Result;
 }
 
@@ -407,7 +413,8 @@ type ScopeTranslatorMethods<M, L extends keyof M | "union" = "union", K = Locali
 
 declare class ScopeTranslator<M = unknown, L extends keyof M | "union" = "union"> extends CoreTranslator<M> {
     constructor(options: ScopeTranslatorOptions<M>);
+    /** Create a scoped translator with a prefix key, providing `t` and `hasKey` for nested keys. */
     scoped<PK extends LocalizedNodeKeys<M, L> | undefined = undefined>(preKey?: PK): PK extends string ? ScopeTranslatorMethods<M, L, ScopedLeafKeys<M, PK, L>> : ScopeTranslatorMethods<M, L>;
 }
 
-export { type FallbackLocalesMap, type FormatHandler, type IsLoadingRef, type LeafKeys, type LoadingHandler, type Locale, type LocaleMessages, type LocaleRef, type LocalizedLeafKeys, type LocalizedMessagesUnion, type LocalizedNodeKeys, type MessagesRef, type MissingHandler, type NestedMessage, type NodeKeys, type Replacement, ScopeTranslator, type ScopeTranslatorMethods, type ScopeTranslatorOptions, type ScopedLeafKeys, type TranslateHandlerContext, type TranslateHandlers, ScopeTranslator as Translator };
+export { type DefaultDepth, type FallbackLocalesMap, type FormatHandler, type IsLoadingRef, type LeafKeys, type LoadingHandler, type Locale, type LocaleMessages, type LocaleRef, type LocalizedLeafKeys, type LocalizedMessagesUnion, type LocalizedNodeKeys, type MessagesRef, type MissingHandler, type NestedMessage, type NodeKeys, type Replacement, ScopeTranslator, type ScopeTranslatorMethods, type ScopeTranslatorOptions, type ScopedLeafKeys, type TranslateHandlerContext, type TranslateHandlers, ScopeTranslator as Translator };

package/dist/index.js

@@ -37,9 +37,6 @@ var hasKey = ({
 }) => {
   const messages = messagesRef.current;
   const locale = localeRef.current;
-  if (!messages) {
-    throw new Error("[intor-translator] 'messages' is required");
-  }
   const candidateLocales = resolveCandidateLocales(targetLocale || locale);
   const message = findMessageInLocales({ messages, candidateLocales, key });
   return !!message;
@@ -76,9 +73,6 @@ var translate = ({
   const messages = messagesRef.current;
   const locale = localeRef.current;
   const isLoading = isLoadingRef.current;
-  if (!messages) {
-    throw new Error("[intor-translator] 'messages' is required");
-  }
   const { fallbackLocales, loadingMessage, placeholder, handlers } = translateConfig;
   const { formatHandler, loadingHandler, missingHandler } = handlers || {};
   const candidateLocales = resolveCandidateLocales(locale, fallbackLocales);
@@ -102,11 +96,16 @@ var translate = ({
 
 // src/translators/base-translator/base-translator.ts
 var BaseTranslator = class {
+  /** Current messages for translation */
+  messagesRef;
+  /** Current active locale */
+  localeRef;
+  /** Current loading state */
+  isLoadingRef;
   constructor(options) {
-    /** Current messages for translation, updatable at runtime */
-    this.messagesRef = { current: void 0 };
-    this.messagesRef = { current: options.messages };
+    this.messagesRef = { current: options.messages ?? {} };
     this.localeRef = { current: options.locale };
+    this.isLoadingRef = { current: options.isLoading ?? false };
   }
   /** Get messages. */
   get messages() {
@@ -116,6 +115,10 @@ var BaseTranslator = class {
   get locale() {
     return this.localeRef.current;
   }
+  /** Get the current loading state. */
+  get isLoading() {
+    return this.isLoadingRef.current;
+  }
   /**
    * Replace messages with new ones.
    *
@@ -133,42 +136,39 @@ var BaseTranslator = class {
   setLocale(newLocale) {
     this.localeRef.current = newLocale;
   }
+  /** Set the loading state. */
+  setLoading(state) {
+    this.isLoadingRef.current = state;
+  }
 };
 
 // src/translators/core-translator/core-translator.ts
 var CoreTranslator = class extends BaseTranslator {
+  options;
   constructor(options) {
     super({ locale: options.locale, messages: options.messages });
-    this.isLoadingRef = { current: false };
-    /** Check if a key exists in the specified locale or current locale. */
-    this.hasKey = (key, targetLocale) => {
-      return hasKey({
-        messagesRef: this.messagesRef,
-        localeRef: this.localeRef,
-        key,
-        targetLocale
-      });
-    };
-    this.t = (key, replacements) => {
-      return translate({
-        messagesRef: this.messagesRef,
-        localeRef: this.localeRef,
-        isLoadingRef: this.isLoadingRef,
-        translateConfig: this.options,
-        key,
-        replacements
-      });
-    };
     this.options = options;
   }
-  /** Get the current loading state. */
-  get isLoading() {
-    return this.isLoadingRef.current;
-  }
-  /** Set the loading state. */
-  setLoading(state) {
-    this.isLoadingRef.current = state;
-  }
+  /** Check if a key exists in the specified locale or current locale. */
+  hasKey = (key, targetLocale) => {
+    return hasKey({
+      messagesRef: this.messagesRef,
+      localeRef: this.localeRef,
+      key,
+      targetLocale
+    });
+  };
+  /** Get the translated message for a key, with optional replacements. */
+  t = (key, replacements) => {
+    return translate({
+      messagesRef: this.messagesRef,
+      localeRef: this.localeRef,
+      isLoadingRef: this.isLoadingRef,
+      translateConfig: this.options,
+      key,
+      replacements
+    });
+  };
 };
 
 // src/utils/get-full-key.ts
@@ -183,6 +183,7 @@ var ScopeTranslator = class extends CoreTranslator {
   constructor(options) {
     super(options);
   }
+  /** Create a scoped translator with a prefix key, providing `t` and `hasKey` for nested keys. */
   scoped(preKey) {
     return {
       hasKey: (key, targetLocale) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "intor-translator",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "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",
@@ -60,29 +60,18 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@eslint/eslintrc": "^3.3.1",
-    "@testing-library/dom": "^10.4.0",
-    "@testing-library/jest-dom": "^6.6.3",
-    "@testing-library/react": "^16.3.0",
     "@types/node": "^24.10.1",
-    "@types/react": "^19.1.4",
-    "@types/react-dom": "^19.1.5",
     "@vitest/coverage-v8": "4.0.9",
     "eslint": "^9.39.1",
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-prettier": "^5.5.4",
     "eslint-plugin-unicorn": "^62.0.0",
     "eslint-plugin-unused-imports": "^4.3.0",
-    "globals": "^16.1.0",
     "intl-messageformat": "^10.7.16",
     "knip": "^5.69.1",
-    "next": "^15.3.2",
-    "prettier": "^3.5.3",
-    "react": "^19.1.0",
-    "react-dom": "^19.1.0",
+    "prettier": "^3.6.2",
     "ts-node": "^10.9.2",
     "tsd": "^0.33.0",
     "tsup": "^8.4.0",