intor 1.0.39 → 2.0.0

package/dist/next/server/index.d.cts

@@ -0,0 +1,149 @@
+import { Level, NormalizerConfig, FormatterConfig, LoggerPreset } from 'logry/edge';
+import { Locale, LocaleNamespaceMessages, FallbackLocalesMap, TranslateConfig, Translator } from 'intor-translator';
+
+type CookieRawOptions = {
+    /** Completely disable cookie usage (no read, no write, no lookup by name) - default: false */
+    disabled?: boolean;
+    /** Allow the system to automatically set cookies - default: true */
+    autoSetCookie?: boolean;
+    /** default: "intor.i18n.locale" */
+    name?: string;
+    /** default: null */
+    domain?: string | null;
+    /** default: "/" */
+    path?: string;
+    /** default: 60 * 60 * 24 * 365 (365 days) */
+    maxAge?: number;
+    /** default: false */
+    httpOnly?: boolean;
+    /** default: process.env.NODE_ENV !== "development" */
+    secure?: boolean;
+    /** default: lax */
+    sameSite?: "lax" | "strict" | "none";
+};
+type CookieResolvedOptions = Required<Omit<CookieRawOptions, "domain">> & {
+    domain: string | null;
+};
+
+/**
+ * ```ts
+ * {
+ *  default: ["ui", "meta"],
+ *  "/auth": ["auth", "admin"],
+ * }
+ * // When pathname is "/" => namespaces: ["ui", "meta"]
+ * // When pathname is "/auth" => namespaces: ["ui", "meta", "auth", "admin"]
+ * ```
+ */
+type RouteNamespaces = {
+    [key: string]: string[];
+} | {
+    [key: string]: string[];
+    default: string[];
+};
+interface ApiHeaders {
+    authorization?: string;
+    "x-api-key"?: string;
+    [key: string]: string | undefined;
+}
+type BaseLoaderOptions = {
+    basePath?: string;
+    namespaces?: string[];
+    routeNamespaces?: RouteNamespaces;
+    concurrency?: number;
+    lazyLoad?: boolean;
+};
+type ImportLoader = BaseLoaderOptions & {
+    type: "import";
+};
+type ApiLoader = BaseLoaderOptions & {
+    type: "api";
+    apiUrl: string;
+    apiHeaders?: ApiHeaders;
+    fullReload?: boolean;
+};
+type LoaderOptions = ImportLoader | ApiLoader;
+
+type LoggerOptions = {
+    level?: Level;
+    normalizerConfig?: NormalizerConfig;
+    formatterConfig?: FormatterConfig;
+    preset?: LoggerPreset;
+};
+
+declare const routingPrefix: readonly ["none", "all", "except-default"];
+declare const routingFirstVisitLocaleSource: readonly ["default", "browser"];
+type RoutingRawOptions = {
+    /** default: "none" */
+    prefix?: (typeof routingPrefix)[number];
+    firstVisit?: {
+        /** default: "browser" */
+        localeSource?: (typeof routingFirstVisitLocaleSource)[number];
+        /** default: true */
+        redirect?: boolean;
+    };
+    /** default: "" */
+    basePath?: string;
+};
+type RoutingResolvedOptions = Required<RoutingRawOptions>;
+
+type CacheRawOptions = {
+    enabled?: boolean;
+    /** default: 60\*60\*1000 (1 hour) */
+    ttl?: number;
+};
+type CacheResolvedOptions = Required<CacheRawOptions>;
+
+type TranslatorOptions = {
+    loadingMessage?: string;
+    placeholder?: string;
+};
+
+type WithoutLoader = {
+    loader?: undefined;
+    supportedLocales?: readonly Locale[];
+};
+type WithLoader = {
+    loader: LoaderOptions;
+    supportedLocales: readonly Locale[];
+};
+type IntorResolvedConfig = (WithLoader | WithoutLoader) & {
+    readonly id: string;
+    readonly messages?: LocaleNamespaceMessages;
+    readonly defaultLocale: Locale;
+    readonly fallbackLocales: FallbackLocalesMap;
+    readonly translator?: TranslatorOptions;
+    readonly cookie: CookieResolvedOptions;
+    readonly routing: RoutingResolvedOptions;
+    readonly logger?: LoggerOptions;
+    readonly cache: CacheResolvedOptions;
+};
+
+interface AdapterRuntime {
+    locale: Locale;
+    pathname: string;
+}
+
+/**
+ * Prepares runtime data for Next.js.
+ */
+declare const nextAdapter: (config: IntorResolvedConfig) => Promise<AdapterRuntime>;
+
+type MessagesLoaderResult = Promise<LocaleNamespaceMessages | undefined>;
+
+/**
+ * Retrieves messages in a Next.js SSR environment.
+ * This function wraps the standard `getMessages` with the Next.js adapter,
+ * automatically resolving runtime data.
+ */
+declare const getMessages: (config: IntorResolvedConfig) => Promise<MessagesLoaderResult>;
+
+/**
+ * Creates a ready-to-use translation function (`t`) for the current
+ * Next.js SSR runtime environment. It automatically resolves the
+ * locale and pathname using the Next.js adapter, loads all
+ * corresponding messages, and returns a `t` function bound to them.
+ */
+declare const getTranslation: (config: IntorResolvedConfig, preKey?: string, options?: TranslateConfig<unknown>) => Promise<Translator["t"]>;
+
+export { getMessages, getTranslation, nextAdapter };

package/dist/next/server/index.d.ts

@@ -0,0 +1,149 @@
+import { Level, NormalizerConfig, FormatterConfig, LoggerPreset } from 'logry/edge';
+import { Locale, LocaleNamespaceMessages, FallbackLocalesMap, TranslateConfig, Translator } from 'intor-translator';
+
+type CookieRawOptions = {
+    /** Completely disable cookie usage (no read, no write, no lookup by name) - default: false */
+    disabled?: boolean;
+    /** Allow the system to automatically set cookies - default: true */
+    autoSetCookie?: boolean;
+    /** default: "intor.i18n.locale" */
+    name?: string;
+    /** default: null */
+    domain?: string | null;
+    /** default: "/" */
+    path?: string;
+    /** default: 60 * 60 * 24 * 365 (365 days) */
+    maxAge?: number;
+    /** default: false */
+    httpOnly?: boolean;
+    /** default: process.env.NODE_ENV !== "development" */
+    secure?: boolean;
+    /** default: lax */
+    sameSite?: "lax" | "strict" | "none";
+};
+type CookieResolvedOptions = Required<Omit<CookieRawOptions, "domain">> & {
+    domain: string | null;
+};
+
+/**
+ * ```ts
+ * {
+ *  default: ["ui", "meta"],
+ *  "/auth": ["auth", "admin"],
+ * }
+ * // When pathname is "/" => namespaces: ["ui", "meta"]
+ * // When pathname is "/auth" => namespaces: ["ui", "meta", "auth", "admin"]
+ * ```
+ */
+type RouteNamespaces = {
+    [key: string]: string[];
+} | {
+    [key: string]: string[];
+    default: string[];
+};
+interface ApiHeaders {
+    authorization?: string;
+    "x-api-key"?: string;
+    [key: string]: string | undefined;
+}
+type BaseLoaderOptions = {
+    basePath?: string;
+    namespaces?: string[];
+    routeNamespaces?: RouteNamespaces;
+    concurrency?: number;
+    lazyLoad?: boolean;
+};
+type ImportLoader = BaseLoaderOptions & {
+    type: "import";
+};
+type ApiLoader = BaseLoaderOptions & {
+    type: "api";
+    apiUrl: string;
+    apiHeaders?: ApiHeaders;
+    fullReload?: boolean;
+};
+type LoaderOptions = ImportLoader | ApiLoader;
+
+type LoggerOptions = {
+    level?: Level;
+    normalizerConfig?: NormalizerConfig;
+    formatterConfig?: FormatterConfig;
+    preset?: LoggerPreset;
+};
+
+declare const routingPrefix: readonly ["none", "all", "except-default"];
+declare const routingFirstVisitLocaleSource: readonly ["default", "browser"];
+type RoutingRawOptions = {
+    /** default: "none" */
+    prefix?: (typeof routingPrefix)[number];
+    firstVisit?: {
+        /** default: "browser" */
+        localeSource?: (typeof routingFirstVisitLocaleSource)[number];
+        /** default: true */
+        redirect?: boolean;
+    };
+    /** default: "" */
+    basePath?: string;
+};
+type RoutingResolvedOptions = Required<RoutingRawOptions>;
+
+type CacheRawOptions = {
+    enabled?: boolean;
+    /** default: 60\*60\*1000 (1 hour) */
+    ttl?: number;
+};
+type CacheResolvedOptions = Required<CacheRawOptions>;
+
+type TranslatorOptions = {
+    loadingMessage?: string;
+    placeholder?: string;
+};
+
+type WithoutLoader = {
+    loader?: undefined;
+    supportedLocales?: readonly Locale[];
+};
+type WithLoader = {
+    loader: LoaderOptions;
+    supportedLocales: readonly Locale[];
+};
+type IntorResolvedConfig = (WithLoader | WithoutLoader) & {
+    readonly id: string;
+    readonly messages?: LocaleNamespaceMessages;
+    readonly defaultLocale: Locale;
+    readonly fallbackLocales: FallbackLocalesMap;
+    readonly translator?: TranslatorOptions;
+    readonly cookie: CookieResolvedOptions;
+    readonly routing: RoutingResolvedOptions;
+    readonly logger?: LoggerOptions;
+    readonly cache: CacheResolvedOptions;
+};
+
+interface AdapterRuntime {
+    locale: Locale;
+    pathname: string;
+}
+
+/**
+ * Prepares runtime data for Next.js.
+ */
+declare const nextAdapter: (config: IntorResolvedConfig) => Promise<AdapterRuntime>;
+
+type MessagesLoaderResult = Promise<LocaleNamespaceMessages | undefined>;
+
+/**
+ * Retrieves messages in a Next.js SSR environment.
+ * This function wraps the standard `getMessages` with the Next.js adapter,
+ * automatically resolving runtime data.
+ */
+declare const getMessages: (config: IntorResolvedConfig) => Promise<MessagesLoaderResult>;
+
+/**
+ * Creates a ready-to-use translation function (`t`) for the current
+ * Next.js SSR runtime environment. It automatically resolves the
+ * locale and pathname using the Next.js adapter, loads all
+ * corresponding messages, and returns a `t` function bound to them.
+ */
+declare const getTranslation: (config: IntorResolvedConfig, preKey?: string, options?: TranslateConfig<unknown>) => Promise<Translator["t"]>;
+
+export { getMessages, getTranslation, nextAdapter };