@alepha/react 0.11.10 → 0.11.12

package/dist/i18n/index.d.ts

@@ -0,0 +1,168 @@
+import * as alepha1 from "alepha";
+import { Alepha, Descriptor, KIND, TypeBoxError } from "alepha";
+import { DateTime, DateTimeProvider } from "alepha/datetime";
+import * as alepha_logger0 from "alepha/logger";
+import * as alepha_server_cookies0 from "alepha/server/cookies";
+import * as typebox0 from "typebox";
+
+//#region src/i18n/components/Localize.d.ts
+interface LocalizeProps {
+  value: string | number | Date | DateTime | TypeBoxError;
+  /**
+   * Options for number formatting (when value is a number)
+   * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat
+   */
+  number?: Intl.NumberFormatOptions;
+  /**
+   * Options for date formatting (when value is a Date or DateTime)
+   * Can be:
+   * - A dayjs format string (e.g., "LLL", "YYYY-MM-DD", "dddd, MMMM D YYYY")
+   * - "fromNow" for relative time (e.g., "2 hours ago")
+   * - Intl.DateTimeFormatOptions for native formatting
+   * @see https://day.js.org/docs/en/display/format
+   * @see https://day.js.org/docs/en/display/from-now
+   */
+  date?: string | "fromNow" | Intl.DateTimeFormatOptions;
+  /**
+   * Timezone to display dates in (when value is a Date or DateTime)
+   * Uses IANA timezone names (e.g., "America/New_York", "Europe/Paris", "Asia/Tokyo")
+   * @see https://day.js.org/docs/en/timezone/timezone
+   */
+  timezone?: string;
+}
+declare const Localize: (props: LocalizeProps) => string;
+//#endregion
+//#region src/i18n/hooks/useI18n.d.ts
+/**
+ * Hook to access the i18n service.
+ */
+declare const useI18n: <S extends object, K$1 extends keyof ServiceDictionary<S>>() => I18nProvider<S, K$1>;
+type ServiceDictionary<T extends object> = { [K in keyof T]: T[K] extends DictionaryDescriptor<infer U> ? U : never };
+//#endregion
+//#region src/i18n/providers/I18nProvider.d.ts
+declare class I18nProvider<S extends object, K$1 extends keyof ServiceDictionary<S>> {
+  protected logger: alepha_logger0.Logger;
+  protected alepha: Alepha;
+  protected dateTimeProvider: DateTimeProvider;
+  protected cookie: alepha_server_cookies0.AbstractCookieDescriptor<typebox0.TString>;
+  readonly registry: Array<{
+    name: string;
+    lang: string;
+    loader: () => Promise<Record<string, string>>;
+    translations: Record<string, string>;
+  }>;
+  options: {
+    fallbackLang: string;
+  };
+  dateFormat: {
+    format: (value: Date) => string;
+  };
+  numberFormat: {
+    format: (value: number) => string;
+  };
+  get languages(): string[];
+  constructor();
+  protected readonly onRender: alepha1.HookDescriptor<"server:onRequest">;
+  protected readonly onStart: alepha1.HookDescriptor<"start">;
+  protected refreshLocale(): void;
+  setLang: (lang: string) => Promise<void>;
+  protected readonly mutate: alepha1.HookDescriptor<"state:mutate">;
+  get lang(): string;
+  translate: (key: string, args?: string[]) => string;
+  readonly l: (value: I18nLocalizeType, options?: I18nLocalizeOptions) => string;
+  readonly tr: (key: keyof ServiceDictionary<S>[K$1], options?: {
+    args?: string[];
+    default?: string;
+  }) => string;
+  protected render(item: string, args: string[]): string;
+}
+type I18nLocalizeType = string | number | Date | DateTime | TypeBoxError;
+interface I18nLocalizeOptions {
+  /**
+   * Options for number formatting (when value is a number)
+   * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat
+   */
+  number?: Intl.NumberFormatOptions;
+  /**
+   * Options for date formatting (when value is a Date or DateTime)
+   * Can be:
+   * - A dayjs format string (e.g., "LLL", "YYYY-MM-DD", "dddd, MMMM D YYYY")
+   * - "fromNow" for relative time (e.g., "2 hours ago")
+   * - Intl.DateTimeFormatOptions for native formatting
+   * @see https://day.js.org/docs/en/display/format
+   * @see https://day.js.org/docs/en/display/from-now
+   */
+  date?: string | "fromNow" | Intl.DateTimeFormatOptions;
+  /**
+   * Timezone to display dates in (when value is a Date or DateTime)
+   * Uses IANA timezone names (e.g., "America/New_York", "Europe/Paris", "Asia/Tokyo")
+   * @see https://day.js.org/docs/en/timezone/timezone
+   */
+  timezone?: string;
+}
+//#endregion
+//#region src/i18n/descriptors/$dictionary.d.ts
+/**
+ * Register a dictionary entry for translations.
+ *
+ * It allows you to define a set of translations for a specific language.
+ * Entry can be lazy-loaded, which is useful for large dictionaries or when translations are not needed immediately.
+ *
+ * @example
+ * ```ts
+ * import { $dictionary } from "@alepha/react/i18n";
+ *
+ * const Example = () => {
+ *   const { tr } = useI18n<App, "en">();
+ *   return <div>{tr("hello")}</div>; //
+ * }
+ *
+ * class App {
+ *
+ *   en = $dictionary({
+ *     // { default: { hello: "Hey" } }
+ *     lazy: () => import("./translations/en.ts"),
+ *   });
+ *
+ *   home = $page({
+ *     path: "/",
+ *     component: Example,
+ *   })
+ * }
+ *
+ * run(App);
+ * ```
+ */
+declare const $dictionary: {
+  <T extends Record<string, string>>(options: DictionaryDescriptorOptions<T>): DictionaryDescriptor<T>;
+  [KIND]: typeof DictionaryDescriptor;
+};
+interface DictionaryDescriptorOptions<T extends Record<string, string>> {
+  lang?: string;
+  name?: string;
+  lazy: () => Promise<{
+    default: T;
+  }>;
+}
+declare class DictionaryDescriptor<T extends Record<string, string>> extends Descriptor<DictionaryDescriptorOptions<T>> {
+  protected provider: I18nProvider<object, never>;
+  protected onInit(): void;
+}
+//#endregion
+//#region src/i18n/index.d.ts
+declare module "alepha" {
+  interface State {
+    "alepha.react.i18n.lang"?: string;
+  }
+}
+/**
+ * Add i18n support to your Alepha React application. SSR and CSR compatible.
+ *
+ * It supports lazy loading of translations and provides a context to access the current language.
+ *
+ * @module alepha.react.i18n
+ */
+declare const AlephaReactI18n: alepha1.Service<alepha1.Module>;
+//#endregion
+export { $dictionary, AlephaReactI18n, DictionaryDescriptor, DictionaryDescriptorOptions, I18nLocalizeOptions, I18nLocalizeType, I18nProvider, Localize, type LocalizeProps, ServiceDictionary, useI18n };
+//# sourceMappingURL=index.d.ts.map

package/dist/i18n/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/i18n/components/Localize.tsx","../../src/i18n/hooks/useI18n.ts","../../src/i18n/providers/I18nProvider.ts","../../src/i18n/descriptors/$dictionary.ts","../../src/i18n/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;UAIiB,aAAA;2BACU,OAAO,WAAW;;;;;EAD5B,MAAA,CAAA,EAMN,IAAA,CAAK,mBANc;EACH;;;;;;AAsB1B;;;8BAP6B,IAAA,CAAK;ECbtB;;;;;EAGR,QAAA,CAAA,EAAA,MAAA;;AAKL,cDcM,QCdM,EAAiB,CAAA,KAAA,EDcJ,aCdI,EAAA,GAAA,MAAA;;;;;;cARhB,8CAEK,kBAAkB,SAC/B,aAAa,GAAG;KAKT,oDACE,IAAI,EAAE,WAAW,gCAAgC,WDZ/D;;;cEEa,iDAEK,kBAAkB;oBAAD,cAAA,CAEjB;oBACA;8BACU;oBAEV,sBAAA,CAAA,yBAFU,QAAA,CAEV,OAAA;EFVD,SAAA,QAAa,EEeF,KFfE,CAAA;IACH,IAAA,EAAA,MAAA;IAAO,IAAA,EAAA,MAAA;IAAW,MAAA,EAAA,GAAA,GEiB3B,OFjB2B,CEiBnB,MFjBmB,CAAA,MAAA,EAAA,MAAA,CAAA,CAAA;IAK7B,YAAA,EEaE,MFbF,CAAA,MAAA,EAAA,MAAA,CAAA;EAUc,CAAA,CAAK;EAAqB,OAAA,EAAA;IASlD,YAGL,EAAA,MAHwB;;;oBECc;EDvB1B,CAAA;EAEuB,YAAA,EAAA;IAAlB,MAAA,EAAA,CAAA,KAAA,EAAA,MAAA,EAAA,GAAA,MAAA;EACA,CAAA;EAAG,IAAA,SAAA,CAAA,CAAA,EAAA,MAAA,EAAA;EAAhB,WAAA,CAAA;EAAY,mBAAA,QAAA,ECoB0B,OAAA,CAqBd,cDzCZ,CAAA,kBAAA,CAAA;EAKL,mBAAA,OAAiB,ECoCA,OAAA,CAQD,cD5CC,CAAA,OAAA,CAAA;EACf,UAAA,aAAA,CAAA,CAAA,EAAA,IAAA;EAAI,OAAA,EAAA,CAAA,IAAA,EAAA,MAAA,EAAA,GC6EoB,OD7EpB,CAAA,IAAA,CAAA;EAAE,mBAAA,MAAA,EC6EkB,OAAA,CAiBX,cD9FP,CAAA,cAAA,CAAA;EAAW,IAAA,IAAA,CAAA,CAAA,EAAA,MAAA;EAAgC,SAAA,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,IAAA,CAAA,EAAA,MAAA,EAAA,EAAA,GAAA,MAAA;EAAC,SAAA,CAAA,EAAA,CAAA,KAAA,ECsJrD,gBDtJqD,EAAA,OAAA,CAAA,ECuJnD,mBDvJmD,EAAA,GAAA,MAAA;2BCsNjD,kBAAkB,GAAG,aAhOvB;;;EAAA,CAAA,EAAA,GAAA,MAAA;EAEuB,UAAA,MAAA,CAAA,IAAA,EAAA,MAAA,EAAA,IAAA,EAAA,MAAA,EAAA,CAAA,EAAA,MAAA;;AAAD,KAoPvB,gBAAA,GAlPM,MAAA,GAAA,MAAA,GAkP+B,IAlP/B,GAkPsC,QAlPtC,GAkPiD,YAlPjD;AACA,UAmPD,mBAAA,CAnPC;EACU;;;;EAUV,MAAA,CAAA,EA6OP,IAAA,CAAK,mBA7OE;EACA;;;;;;;;;EA+Me,IAAA,CAAA,EAAA,MAAA,GAAA,SAAA,GAuCH,IAAA,CAAK,qBAvCF;EAAlB;;;AAsBf;;EAAwD,QAAA,CAAA,EAAA,MAAA;;;;;;;;;;AFxPxD;;;;;;;AAuBC;;;;ACpBD;;;;;;;AAQA;;;;;;;cEmBa;aAAyB,iCAC3B,4BAA4B,KACpC,qBAAqB;;AD9BxB,CAAA;AAEoC,UCkCnB,2BDlCmB,CAAA,UCkCmB,MDlCnB,CAAA,MAAA,EAAA,MAAA,CAAA,CAAA,CAAA;EAAlB,IAAA,CAAA,EAAA,MAAA;EAAiB,IAAA,CAAA,EAAA,MAEjB;EACA,IAAA,EAAA,GAAA,GCkCJ,ODlCI,CAAA;IACU,OAAA,ECiCK,CDjCL;EAAA,CAAA,CAAA;;AAUF,cC4Bb,oBD5Ba,CAAA,UC6Bd,MD7Bc,CAAA,MAAA,EAAA,MAAA,CAAA,CAAA,SC8BhB,UD9BgB,CC8BL,2BD9BK,CC8BuB,CD9BvB,CAAA,CAAA,CAAA;EAAR,UAAA,QAAA,EC+BE,YD/BF,CAAA,MAAA,EAAA,KAAA,CAAA;EACA,UAAA,MAAA,CAAA,CAAA,EAAA,IAAA;;;;;;;EFnBD;;;;;;;AAuBhB;;cIEY,iBAAe,OAAA,CAAA,QAI1B,OAAA,CAJ0B,MAAA"}