@sheet-i18n/react-client 1.5.3 → 1.6.0-canary.0

package/dist/index.d.mts

@@ -40,7 +40,16 @@ type SafeMessageId<TSupportedLocales extends readonly string[], TLocaleSet exten
  * Resolves to valid sheet titles from the locale set
  * or defaults to string if type safety is off or keys are not available.
  */
-type SafeSheetTitle<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean> = TTypeSafe extends true ? keyof TLocaleSet[TSupportedLocales[number]] extends never ? string : keyof TLocaleSet[TSupportedLocales[number]] : string;
+type SupportedLocales = readonly string[];
+type LocaleSet = Partial<Record<SupportedLocales[number], Record<string, any>>>;
+type TypeSafe = boolean;
+type SafeSheetTitle<TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TTypeSafe extends TypeSafe> = TTypeSafe extends true ? keyof TLocaleSet[TSupportedLocales[number]] extends never ? string : keyof TLocaleSet[TSupportedLocales[number]] : string;
+/**
+ * Plugin types
+ */
+type RuleKey = string;
+type RuleFn<TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TI18nStore extends I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, TTypeSafe extends TypeSafe, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues = any> = (values: TValues, currentLocaleSet: ReturnType<TI18nStore['getCurrentLocaleSet']>) => TMessageId;
+type Rules<TSupportedLocales extends SupportedLocales = SupportedLocales, TLocaleSet extends LocaleSet = LocaleSet, TTypeSafe extends TypeSafe = TypeSafe, TI18nStore extends I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe> = I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe> = SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe> = SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>> = Record<RuleKey, RuleFn<TSupportedLocales, TLocaleSet, TI18nStore, TTypeSafe, TSheetTitle, TMessageId>>;
 
 type GetTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>> = {
     t: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: TMessageId, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? TMessageId : any;
@@ -51,11 +60,12 @@ type GetTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSe
     };
 };
 
-type UseTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Partial<Record<TSupportedLocales[number], Record<string, any>>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>> = {
+type UseTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Partial<Record<TSupportedLocales[number], Record<string, any>>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TRules extends Rules> = {
     t: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: TMessageId, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? TMessageId : any;
 } & {
     t: {
         dynamic: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: string, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? string : any;
+        rule: <TRuleKey extends keyof TRules, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>>(ruleKey: TRuleKey, values?: Parameters<TRules[TRuleKey]>[0]) => TTypeSafe extends true ? TMessageId : any;
     };
 };
 
@@ -76,16 +86,26 @@ interface StorageBasedIntlProviderProps<TSupportedLocales extends readonly strin
     children: React.ReactNode;
 }
 
-declare function createI18nContext<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>): {
+interface Plugins<TRules extends Rules> {
+    rules?: TRules;
+}
+declare function createI18nContext<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TRules extends Rules, TTypeSafe extends boolean = false>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, plugins?: Plugins<TRules>): {
     IntlProvider: ({ currentLocale, children, }: Omit<IntlProviderProps<TSupportedLocales, TLocaleSet>, "currentLocale" | "i18nStore"> & {
         currentLocale?: string;
         children?: React.ReactNode;
     }) => react_jsx_runtime.JSX.Element;
     StorageBasedIntlProvider: ({ storageManager, children, }: Omit<StorageBasedIntlProviderProps<TSupportedLocales, TLocaleSet, TTypeSafe>, "i18nStore">) => react_jsx_runtime.JSX.Element;
-    useTranslation: <TSheetTitle extends TTypeSafe extends true ? keyof TLocaleSet[TSupportedLocales[number]] extends never ? string : keyof TLocaleSet[TSupportedLocales[number]] : string>(sheetTitle: TSheetTitle) => UseTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>;
-    getTranslation: <TSheetTitle extends TTypeSafe extends true ? keyof TLocaleSet[TSupportedLocales[number]] extends never ? string : keyof TLocaleSet[TSupportedLocales[number]] : string>(sheetTitle: TSheetTitle) => GetTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>;
+    useTranslation: <TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>>(sheetTitle: TSheetTitle) => UseTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle, TRules>;
+    getTranslation: <TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>>(sheetTitle: TSheetTitle) => GetTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>;
     getLocaleStorageManager: (storageService?: IStorageService<string>) => LocaleStorageManager<TSupportedLocales, TLocaleSet, TTypeSafe>;
     useLocaleStorage: typeof useLocaleStorage;
 };
 
-export { type IStorageService, createI18nContext };
+declare class RuleService<TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TTypeSafe extends TypeSafe, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>> {
+    private readonly i18nStore;
+    constructor(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>);
+    createRule: <TValues extends $TParams[0]>(ruleFn: RuleFn<TSupportedLocales, TLocaleSet, I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, TTypeSafe, TSheetTitle, TMessageId, TValues>) => (values: TValues) => TMessageId;
+}
+declare const ruleFactory: <TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TTypeSafe extends TypeSafe>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>) => RuleService<TSupportedLocales, TLocaleSet, TTypeSafe, SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, SafeMessageId<TSupportedLocales, TLocaleSet, SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TTypeSafe>>;
+
+export { type IStorageService, createI18nContext, ruleFactory };

package/dist/index.d.ts

@@ -40,7 +40,16 @@ type SafeMessageId<TSupportedLocales extends readonly string[], TLocaleSet exten
  * Resolves to valid sheet titles from the locale set
  * or defaults to string if type safety is off or keys are not available.
  */
-type SafeSheetTitle<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean> = TTypeSafe extends true ? keyof TLocaleSet[TSupportedLocales[number]] extends never ? string : keyof TLocaleSet[TSupportedLocales[number]] : string;
+type SupportedLocales = readonly string[];
+type LocaleSet = Partial<Record<SupportedLocales[number], Record<string, any>>>;
+type TypeSafe = boolean;
+type SafeSheetTitle<TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TTypeSafe extends TypeSafe> = TTypeSafe extends true ? keyof TLocaleSet[TSupportedLocales[number]] extends never ? string : keyof TLocaleSet[TSupportedLocales[number]] : string;
+/**
+ * Plugin types
+ */
+type RuleKey = string;
+type RuleFn<TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TI18nStore extends I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, TTypeSafe extends TypeSafe, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues = any> = (values: TValues, currentLocaleSet: ReturnType<TI18nStore['getCurrentLocaleSet']>) => TMessageId;
+type Rules<TSupportedLocales extends SupportedLocales = SupportedLocales, TLocaleSet extends LocaleSet = LocaleSet, TTypeSafe extends TypeSafe = TypeSafe, TI18nStore extends I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe> = I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe> = SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe> = SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>> = Record<RuleKey, RuleFn<TSupportedLocales, TLocaleSet, TI18nStore, TTypeSafe, TSheetTitle, TMessageId>>;
 
 type GetTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>> = {
     t: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: TMessageId, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? TMessageId : any;
@@ -51,11 +60,12 @@ type GetTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSe
     };
 };
 
-type UseTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Partial<Record<TSupportedLocales[number], Record<string, any>>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>> = {
+type UseTranslationReturn<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Partial<Record<TSupportedLocales[number], Record<string, any>>>>, TTypeSafe extends boolean, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TRules extends Rules> = {
     t: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: TMessageId, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? TMessageId : any;
 } & {
     t: {
         dynamic: <TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>, TValues extends $TParams[0], TOpts extends $TParams[1], TDescriptor extends $TParams[2]>(id: string, values?: TValues, opts?: TOpts, _descriptor?: TDescriptor) => TTypeSafe extends true ? string : any;
+        rule: <TRuleKey extends keyof TRules, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>>(ruleKey: TRuleKey, values?: Parameters<TRules[TRuleKey]>[0]) => TTypeSafe extends true ? TMessageId : any;
     };
 };
 
@@ -76,16 +86,26 @@ interface StorageBasedIntlProviderProps<TSupportedLocales extends readonly strin
     children: React.ReactNode;
 }
 
-declare function createI18nContext<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TTypeSafe extends boolean = false>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>): {
+interface Plugins<TRules extends Rules> {
+    rules?: TRules;
+}
+declare function createI18nContext<TSupportedLocales extends readonly string[], TLocaleSet extends Partial<Record<TSupportedLocales[number], Record<string, any>>>, TRules extends Rules, TTypeSafe extends boolean = false>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, plugins?: Plugins<TRules>): {
     IntlProvider: ({ currentLocale, children, }: Omit<IntlProviderProps<TSupportedLocales, TLocaleSet>, "currentLocale" | "i18nStore"> & {
         currentLocale?: string;
         children?: React.ReactNode;
     }) => react_jsx_runtime.JSX.Element;
     StorageBasedIntlProvider: ({ storageManager, children, }: Omit<StorageBasedIntlProviderProps<TSupportedLocales, TLocaleSet, TTypeSafe>, "i18nStore">) => react_jsx_runtime.JSX.Element;
-    useTranslation: <TSheetTitle extends TTypeSafe extends true ? keyof TLocaleSet[TSupportedLocales[number]] extends never ? string : keyof TLocaleSet[TSupportedLocales[number]] : string>(sheetTitle: TSheetTitle) => UseTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>;
-    getTranslation: <TSheetTitle extends TTypeSafe extends true ? keyof TLocaleSet[TSupportedLocales[number]] extends never ? string : keyof TLocaleSet[TSupportedLocales[number]] : string>(sheetTitle: TSheetTitle) => GetTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>;
+    useTranslation: <TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>>(sheetTitle: TSheetTitle) => UseTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle, TRules>;
+    getTranslation: <TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>>(sheetTitle: TSheetTitle) => GetTranslationReturn<TSupportedLocales, TLocaleSet, TTypeSafe, TSheetTitle>;
     getLocaleStorageManager: (storageService?: IStorageService<string>) => LocaleStorageManager<TSupportedLocales, TLocaleSet, TTypeSafe>;
     useLocaleStorage: typeof useLocaleStorage;
 };
 
-export { type IStorageService, createI18nContext };
+declare class RuleService<TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TTypeSafe extends TypeSafe, TSheetTitle extends SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TMessageId extends SafeMessageId<TSupportedLocales, TLocaleSet, TSheetTitle, TTypeSafe>> {
+    private readonly i18nStore;
+    constructor(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>);
+    createRule: <TValues extends $TParams[0]>(ruleFn: RuleFn<TSupportedLocales, TLocaleSet, I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>, TTypeSafe, TSheetTitle, TMessageId, TValues>) => (values: TValues) => TMessageId;
+}
+declare const ruleFactory: <TSupportedLocales extends SupportedLocales, TLocaleSet extends LocaleSet, TTypeSafe extends TypeSafe>(i18nStore: I18nStore<TSupportedLocales, TLocaleSet, TTypeSafe>) => RuleService<TSupportedLocales, TLocaleSet, TTypeSafe, SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, SafeMessageId<TSupportedLocales, TLocaleSet, SafeSheetTitle<TSupportedLocales, TLocaleSet, TTypeSafe>, TTypeSafe>>;
+
+export { type IStorageService, createI18nContext, ruleFactory };

package/dist/index.js

@@ -38,7 +38,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  createI18nContext: () => createI18nContext
+  createI18nContext: () => createI18nContext,
+  ruleFactory: () => ruleFactory
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -134,7 +135,7 @@ function useDynamicLocale(useDynamicLocaleProps) {
     if (!dynamicLoaders) return;
     const targetDynamicLoader = dynamicLoaders[currentLocale];
     if (!targetDynamicLoader) return;
-    const currentLocaleSet = i18nStore == null ? void 0 : i18nStore.getLocaleSet();
+    const currentLocaleSet = i18nStore == null ? void 0 : i18nStore.localeSet;
     const targetLocaleData = currentLocaleSet == null ? void 0 : currentLocaleSet[currentLocale];
     if (targetLocaleData) return;
     setIsLoading(true);
@@ -251,20 +252,26 @@ var TranslationService = class {
 // src/hooks/useTranslation.ts
 function useTranslation({
   sheetTitle,
-  i18nStore
+  i18nStore,
+  rules
 }) {
   const intlInstance = intlInstanceCache.getCachedIntlInstance(
     sheetTitle,
     i18nStore
   );
+  const translationService = new TranslationService(intlInstance);
   const t = (id, values, opts, _descriptor) => {
-    const translationService = new TranslationService(intlInstance);
     return translationService.translate(id, values, opts, _descriptor);
   };
   t.dynamic = (id, values, opts, _descriptor) => {
-    const translationService = new TranslationService(intlInstance);
     return translationService.translate(id, values, opts, _descriptor);
   };
+  t.rule = (ruleKey, values) => {
+    const ruleFn = rules == null ? void 0 : rules[ruleKey];
+    if (!ruleFn) return ruleKey;
+    const messageId = ruleFn(values, {});
+    return translationService.translate(messageId, values);
+  };
   return { t };
 }
 
@@ -280,39 +287,33 @@ function getTranslation({
   sheetTitle,
   i18nStore
 }) {
+  const intlInstance = intlInstanceCache.getCachedIntlInstance(
+    sheetTitle,
+    i18nStore,
+    "server"
+  );
+  const translationService = new TranslationService(intlInstance);
   const t = (id, values, opts, _descriptor) => {
-    const intlInstance = intlInstanceCache.getCachedIntlInstance(
-      sheetTitle,
-      i18nStore,
-      "server"
-    );
-    const translationService = new TranslationService(intlInstance);
     return translationService.translate(id, values, opts, _descriptor);
   };
   t.dynamic = (id, values, opts, _descriptor) => {
-    const intlInstance = intlInstanceCache.getCachedIntlInstance(
-      sheetTitle,
-      i18nStore,
-      "server"
-    );
-    const translationService = new TranslationService(intlInstance);
     return translationService.translate(id, values, opts, _descriptor);
   };
   t.promise = (id, values, opts, _descriptor) => {
     const intlInitPromise = new Promise((resolve) => {
       setTimeout(() => {
-        const intlInstance = intlInstanceCache.getCachedIntlInstance(
+        const intlInstance2 = intlInstanceCache.getCachedIntlInstance(
           sheetTitle,
           i18nStore,
           "server"
         );
-        resolve(intlInstance);
+        resolve(intlInstance2);
       }, 1);
     });
     return new Promise((resolve) => {
-      intlInitPromise.then((intlInstance) => {
-        const translationService = new TranslationService(intlInstance);
-        resolve(translationService.translate(id, values, opts, _descriptor));
+      intlInitPromise.then((intlInstance2) => {
+        const translationService2 = new TranslationService(intlInstance2);
+        resolve(translationService2.translate(id, values, opts, _descriptor));
       });
     });
   };
@@ -497,7 +498,7 @@ function StorageBasedIntlProvider({
 
 // src/createI18nContext.tsx
 var import_jsx_runtime3 = require("react/jsx-runtime");
-function createI18nContext(i18nStore) {
+function createI18nContext(i18nStore, plugins) {
   if (import_shared_utils6.validator.isNullish(i18nStore)) {
     throw new InvalidI18nContextStateError(
       "\u26A0\uFE0F no i18nStore provided. To use createI18nContext, you must provide an i18nStore as a parameter"
@@ -508,6 +509,7 @@ function createI18nContext(i18nStore) {
       "\u26A0\uFE0F The provided i18nStore is invalid. Please ensure a store instance you passed is an instance of I18nStore."
     );
   }
+  const { rules } = plugins != null ? plugins : {};
   const IntlProviderImpl = ({
     currentLocale,
     children
@@ -530,7 +532,7 @@ function createI18nContext(i18nStore) {
       children
     }
   );
-  const useTranslationImpl = (sheetTitle) => useTranslation({ sheetTitle, i18nStore });
+  const useTranslationImpl = (sheetTitle) => useTranslation({ sheetTitle, i18nStore, rules });
   const getTranslationImpl = (sheetTitle) => getTranslation({ sheetTitle, i18nStore });
   const getLocaleStorageManagerImpl = (storageService) => {
     return getLocaleStorageManager(i18nStore, storageService);
@@ -544,7 +546,22 @@ function createI18nContext(i18nStore) {
     useLocaleStorage
   };
 }
+
+// src/Service/RuleService.ts
+var RuleService = class {
+  constructor(i18nStore) {
+    this.i18nStore = i18nStore;
+    this.createRule = (ruleFn) => {
+      const currentLocaleSet = this.i18nStore.getCurrentLocaleSet();
+      return (values) => ruleFn(values, currentLocaleSet);
+    };
+  }
+};
+var ruleFactory = (i18nStore) => {
+  return new RuleService(i18nStore);
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  createI18nContext
+  createI18nContext,
+  ruleFactory
 });

package/dist/index.mjs

@@ -111,7 +111,7 @@ function useDynamicLocale(useDynamicLocaleProps) {
     if (!dynamicLoaders) return;
     const targetDynamicLoader = dynamicLoaders[currentLocale];
     if (!targetDynamicLoader) return;
-    const currentLocaleSet = i18nStore == null ? void 0 : i18nStore.getLocaleSet();
+    const currentLocaleSet = i18nStore == null ? void 0 : i18nStore.localeSet;
     const targetLocaleData = currentLocaleSet == null ? void 0 : currentLocaleSet[currentLocale];
     if (targetLocaleData) return;
     setIsLoading(true);
@@ -228,20 +228,26 @@ var TranslationService = class {
 // src/hooks/useTranslation.ts
 function useTranslation({
   sheetTitle,
-  i18nStore
+  i18nStore,
+  rules
 }) {
   const intlInstance = intlInstanceCache.getCachedIntlInstance(
     sheetTitle,
     i18nStore
   );
+  const translationService = new TranslationService(intlInstance);
   const t = (id, values, opts, _descriptor) => {
-    const translationService = new TranslationService(intlInstance);
     return translationService.translate(id, values, opts, _descriptor);
   };
   t.dynamic = (id, values, opts, _descriptor) => {
-    const translationService = new TranslationService(intlInstance);
     return translationService.translate(id, values, opts, _descriptor);
   };
+  t.rule = (ruleKey, values) => {
+    const ruleFn = rules == null ? void 0 : rules[ruleKey];
+    if (!ruleFn) return ruleKey;
+    const messageId = ruleFn(values, {});
+    return translationService.translate(messageId, values);
+  };
   return { t };
 }
 
@@ -257,39 +263,33 @@ function getTranslation({
   sheetTitle,
   i18nStore
 }) {
+  const intlInstance = intlInstanceCache.getCachedIntlInstance(
+    sheetTitle,
+    i18nStore,
+    "server"
+  );
+  const translationService = new TranslationService(intlInstance);
   const t = (id, values, opts, _descriptor) => {
-    const intlInstance = intlInstanceCache.getCachedIntlInstance(
-      sheetTitle,
-      i18nStore,
-      "server"
-    );
-    const translationService = new TranslationService(intlInstance);
     return translationService.translate(id, values, opts, _descriptor);
   };
   t.dynamic = (id, values, opts, _descriptor) => {
-    const intlInstance = intlInstanceCache.getCachedIntlInstance(
-      sheetTitle,
-      i18nStore,
-      "server"
-    );
-    const translationService = new TranslationService(intlInstance);
     return translationService.translate(id, values, opts, _descriptor);
   };
   t.promise = (id, values, opts, _descriptor) => {
     const intlInitPromise = new Promise((resolve) => {
       setTimeout(() => {
-        const intlInstance = intlInstanceCache.getCachedIntlInstance(
+        const intlInstance2 = intlInstanceCache.getCachedIntlInstance(
           sheetTitle,
           i18nStore,
           "server"
         );
-        resolve(intlInstance);
+        resolve(intlInstance2);
       }, 1);
     });
     return new Promise((resolve) => {
-      intlInitPromise.then((intlInstance) => {
-        const translationService = new TranslationService(intlInstance);
-        resolve(translationService.translate(id, values, opts, _descriptor));
+      intlInitPromise.then((intlInstance2) => {
+        const translationService2 = new TranslationService(intlInstance2);
+        resolve(translationService2.translate(id, values, opts, _descriptor));
       });
     });
   };
@@ -474,7 +474,7 @@ function StorageBasedIntlProvider({
 
 // src/createI18nContext.tsx
 import { jsx as jsx3 } from "react/jsx-runtime";
-function createI18nContext(i18nStore) {
+function createI18nContext(i18nStore, plugins) {
   if (validator5.isNullish(i18nStore)) {
     throw new InvalidI18nContextStateError(
       "\u26A0\uFE0F no i18nStore provided. To use createI18nContext, you must provide an i18nStore as a parameter"
@@ -485,6 +485,7 @@ function createI18nContext(i18nStore) {
       "\u26A0\uFE0F The provided i18nStore is invalid. Please ensure a store instance you passed is an instance of I18nStore."
     );
   }
+  const { rules } = plugins != null ? plugins : {};
   const IntlProviderImpl = ({
     currentLocale,
     children
@@ -507,7 +508,7 @@ function createI18nContext(i18nStore) {
       children
     }
   );
-  const useTranslationImpl = (sheetTitle) => useTranslation({ sheetTitle, i18nStore });
+  const useTranslationImpl = (sheetTitle) => useTranslation({ sheetTitle, i18nStore, rules });
   const getTranslationImpl = (sheetTitle) => getTranslation({ sheetTitle, i18nStore });
   const getLocaleStorageManagerImpl = (storageService) => {
     return getLocaleStorageManager(i18nStore, storageService);
@@ -521,6 +522,21 @@ function createI18nContext(i18nStore) {
     useLocaleStorage
   };
 }
+
+// src/Service/RuleService.ts
+var RuleService = class {
+  constructor(i18nStore) {
+    this.i18nStore = i18nStore;
+    this.createRule = (ruleFn) => {
+      const currentLocaleSet = this.i18nStore.getCurrentLocaleSet();
+      return (values) => ruleFn(values, currentLocaleSet);
+    };
+  }
+};
+var ruleFactory = (i18nStore) => {
+  return new RuleService(i18nStore);
+};
 export {
-  createI18nContext
+  createI18nContext,
+  ruleFactory
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sheet-i18n/react-client",
-  "version": "1.5.3",
+  "version": "1.6.0-canary.0",
   "description": "a client package for react modules used by sheet-i18n",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -27,7 +27,7 @@
   "dependencies": {
     "@sheet-i18n/shared-utils": "1.8.2",
     "@sheet-i18n/errors": "1.8.1",
-    "@sheet-i18n/react-core": "1.5.2"
+    "@sheet-i18n/react-core": "1.6.0-canary.0"
   },
   "devDependencies": {
     "@types/react": "^19.0.2",