@alepha/react 0.13.0 → 0.13.1

package/dist/i18n/index.d.cts

@@ -1,437 +0,0 @@
-import * as alepha16 from "alepha";
-import { Alepha, Async, Descriptor, KIND, LogLevel, LoggerInterface, Static, TSchema, TypeBoxError } from "alepha";
-import dayjsDuration from "dayjs/plugin/duration.js";
-import DayjsApi, { Dayjs, ManipulateType, PluginFunc } from "dayjs";
-
-//#region ../alepha/src/datetime/providers/DateTimeProvider.d.ts
-
-type DateTime = DayjsApi.Dayjs;
-type Duration = dayjsDuration.Duration;
-type DurationLike = number | dayjsDuration.Duration | [number, ManipulateType];
-declare class DateTimeProvider {
-  static PLUGINS: Array<PluginFunc<any>>;
-  protected alepha: Alepha;
-  protected ref: DateTime | null;
-  protected readonly timeouts: Timeout[];
-  protected readonly intervals: Interval[];
-  constructor();
-  protected readonly onStart: alepha16.HookDescriptor<"start">;
-  protected readonly onStop: alepha16.HookDescriptor<"stop">;
-  setLocale(locale: string): void;
-  isDateTime(value: unknown): value is DateTime;
-  /**
-   * Create a new UTC DateTime instance.
-   */
-  utc(date: string | number | Date | Dayjs | null | undefined): DateTime;
-  /**
-   * Create a new DateTime instance.
-   */
-  of(date: string | number | Date | Dayjs | null | undefined): DateTime;
-  /**
-   * Get the current date as a string.
-   */
-  toISOString(date?: Date | string | DateTime): string;
-  /**
-   * Get the current date.
-   */
-  now(): DateTime;
-  /**
-   * Get the current date as a string.
-   *
-   * This is much faster than `DateTimeProvider.now().toISOString()` as it avoids creating a DateTime instance.
-   */
-  nowISOString(): string;
-  /**
-   * Get the current date as milliseconds since epoch.
-   *
-   * This is much faster than `DateTimeProvider.now().valueOf()` as it avoids creating a DateTime instance.
-   */
-  nowMillis(): number;
-  /**
-   * Get the current date as a string.
-   *
-   * @protected
-   */
-  protected getCurrentDate(): DateTime;
-  /**
-   * Create a new Duration instance.
-   */
-  duration: (duration: DurationLike, unit?: ManipulateType) => Duration;
-  isDurationLike(value: unknown): value is DurationLike;
-  /**
-   * Return a promise that resolves after the next tick.
-   * It uses `setTimeout` with 0 ms delay.
-   */
-  tick(): Promise<void>;
-  /**
-   * Wait for a certain duration.
-   *
-   * You can clear the timeout by using the `AbortSignal` API.
-   * Aborted signal will resolve the promise immediately, it does not reject it.
-   */
-  wait(duration: DurationLike, options?: {
-    signal?: AbortSignal;
-    now?: number;
-  }): Promise<void>;
-  createInterval(run: () => unknown, duration: DurationLike, start?: boolean): Interval;
-  /**
-   * Run a callback after a certain duration.
-   */
-  createTimeout(callback: () => void, duration: DurationLike, now?: number): Timeout;
-  clearTimeout(timeout: Timeout): void;
-  clearInterval(interval: Interval): void;
-  /**
-   * Run a function with a deadline.
-   */
-  deadline<T>(fn: (signal: AbortSignal) => Promise<T>, duration: DurationLike): Promise<T>;
-  /**
-   * Add time to the current date.
-   */
-  travel(duration: DurationLike, unit?: ManipulateType): Promise<void>;
-  /**
-   * Stop the time.
-   */
-  pause(): DateTime;
-  /**
-   * Reset the reference date.
-   */
-  reset(): void;
-}
-interface Interval {
-  timer?: any;
-  duration: number;
-  run: () => unknown;
-}
-interface Timeout {
-  now: number;
-  timer?: any;
-  duration: number;
-  callback: () => void;
-  clear: () => void;
-}
-//#endregion
-//#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 ../alepha/src/logger/schemas/logEntrySchema.d.ts
-declare const logEntrySchema: alepha16.TObject<{
-  level: alepha16.TUnsafe<"SILENT" | "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR">;
-  message: alepha16.TString;
-  service: alepha16.TString;
-  module: alepha16.TString;
-  context: alepha16.TOptional<alepha16.TString>;
-  app: alepha16.TOptional<alepha16.TString>;
-  data: alepha16.TOptional<alepha16.TAny>;
-  timestamp: alepha16.TNumber;
-}>;
-type LogEntry = Static<typeof logEntrySchema>;
-//#endregion
-//#region ../alepha/src/logger/providers/LogDestinationProvider.d.ts
-declare abstract class LogDestinationProvider {
-  abstract write(message: string, entry: LogEntry): void;
-}
-//#endregion
-//#region ../alepha/src/logger/providers/LogFormatterProvider.d.ts
-declare abstract class LogFormatterProvider {
-  abstract format(entry: LogEntry): string;
-}
-//#endregion
-//#region ../alepha/src/logger/services/Logger.d.ts
-declare class Logger implements LoggerInterface {
-  protected readonly alepha: Alepha;
-  protected readonly formatter: LogFormatterProvider;
-  protected readonly destination: LogDestinationProvider;
-  protected readonly dateTimeProvider: DateTimeProvider;
-  protected readonly levels: Record<string, number>;
-  protected readonly service: string;
-  protected readonly module: string;
-  protected readonly app?: string;
-  protected appLogLevel: string;
-  protected logLevel: LogLevel;
-  constructor(service: string, module: string);
-  get context(): string | undefined;
-  get level(): string;
-  parseLevel(level: string, app: string): LogLevel;
-  private matchesPattern;
-  asLogLevel(something: string): LogLevel;
-  error(message: string, data?: unknown): void;
-  warn(message: string, data?: unknown): void;
-  info(message: string, data?: unknown): void;
-  debug(message: string, data?: unknown): void;
-  trace(message: string, data?: unknown): void;
-  protected log(level: LogLevel, message: string, data?: unknown): void;
-  protected emit(entry: LogEntry, message?: string): void;
-}
-//#endregion
-//#region ../alepha/src/logger/index.d.ts
-declare const envSchema: alepha16.TObject<{
-  /**
-   * Default log level for the application.
-   *
-   * Default by environment:
-   * - dev = info
-   * - prod = info
-   * - test = error
-   *
-   * Levels are: "trace" | "debug" | "info" | "warn" | "error" | "silent"
-   *
-   * Level can be set for a specific module:
-   *
-   * @example
-   * LOG_LEVEL=my.module.name:debug,info # Set debug level for my.module.name and info for all other modules
-   * LOG_LEVEL=alepha:trace, info # Set trace level for all alepha modules and info for all other modules
-   */
-  LOG_LEVEL: alepha16.TOptional<alepha16.TString>;
-  /**
-   * Built-in log formats.
-   * - "json" - JSON format, useful for structured logging and log aggregation. {@link JsonFormatterProvider}
-   * - "pretty" - Simple text format, human-readable, with colors. {@link SimpleFormatterProvider}
-   * - "raw" - Raw format, no formatting, just the message.  {@link RawFormatterProvider}
-   */
-  LOG_FORMAT: alepha16.TOptional<alepha16.TUnsafe<"json" | "pretty" | "raw">>;
-}>;
-declare module "alepha" {
-  interface Env extends Partial<Static<typeof envSchema>> {}
-  interface State {
-    /**
-     * Current log level for the application or specific modules.
-     */
-    "alepha.logger.level"?: string;
-  }
-  interface Hooks {
-    log: {
-      message?: string;
-      entry: LogEntry;
-    };
-  }
-}
-//#endregion
-//#region ../alepha/src/server-cookies/descriptors/$cookie.d.ts
-interface CookieDescriptorOptions<T extends TSchema> {
-  /** The schema for the cookie's value, used for validation and type safety. */
-  schema: T;
-  /** The name of the cookie. */
-  name?: string;
-  /** The cookie's path. Defaults to "/". */
-  path?: string;
-  /** Time-to-live for the cookie. Maps to `Max-Age`. */
-  ttl?: DurationLike;
-  /** If true, the cookie is only sent over HTTPS. Defaults to true in production. */
-  secure?: boolean;
-  /** If true, the cookie cannot be accessed by client-side scripts. */
-  httpOnly?: boolean;
-  /** SameSite policy for the cookie. Defaults to "lax". */
-  sameSite?: "strict" | "lax" | "none";
-  /** The domain for the cookie. */
-  domain?: string;
-  /** If true, the cookie value will be compressed using zlib. */
-  compress?: boolean;
-  /** If true, the cookie value will be encrypted. Requires `COOKIE_SECRET` env var. */
-  encrypt?: boolean;
-  /** If true, the cookie will be signed to prevent tampering. Requires `COOKIE_SECRET` env var. */
-  sign?: boolean;
-}
-interface AbstractCookieDescriptor<T extends TSchema> {
-  readonly name: string;
-  readonly options: CookieDescriptorOptions<T>;
-  set(value: Static<T>, options?: {
-    cookies?: Cookies;
-    ttl?: DurationLike;
-  }): void;
-  get(options?: {
-    cookies?: Cookies;
-  }): Static<T> | undefined;
-  del(options?: {
-    cookies?: Cookies;
-  }): void;
-}
-interface Cookies {
-  req: Record<string, string>;
-  res: Record<string, Cookie | null>;
-}
-interface Cookie {
-  value: string;
-  path?: string;
-  maxAge?: number;
-  secure?: boolean;
-  httpOnly?: boolean;
-  sameSite?: "strict" | "lax" | "none";
-  domain?: string;
-}
-//#endregion
-//#region ../alepha/src/server-cookies/index.d.ts
-declare module "alepha/server" {
-  interface ServerRequest {
-    cookies: Cookies;
-  }
-}
-/**
- * Provides HTTP cookie management capabilities for server requests and responses with type-safe cookie descriptors.
- *
- * The server-cookies module enables declarative cookie handling using the `$cookie` descriptor on class properties.
- * It offers automatic cookie parsing, secure cookie configuration, and seamless integration with server routes
- * for managing user sessions, preferences, and authentication tokens.
- *
- * @see {@link $cookie}
- * @module alepha.server.cookies
- */
-//#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 log: Logger;
-  protected alepha: Alepha;
-  protected dateTimeProvider: DateTimeProvider;
-  protected cookie: AbstractCookieDescriptor<alepha16.TString>;
-  readonly registry: Array<{
-    target: string;
-    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: alepha16.HookDescriptor<"server:onRequest">;
-  protected readonly onStart: alepha16.HookDescriptor<"start">;
-  protected refreshLocale(): void;
-  setLang: (lang: string) => Promise<void>;
-  protected readonly mutate: alepha16.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: () => Async<{
-    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: alepha16.Service<alepha16.Module>;
-//#endregion
-export { $dictionary, AlephaReactI18n, DictionaryDescriptor, DictionaryDescriptorOptions, I18nLocalizeOptions, I18nLocalizeType, I18nProvider, Localize, type LocalizeProps, ServiceDictionary, useI18n };
-//# sourceMappingURL=index.d.cts.map