@i18n-micro/types 1.2.6 → 1.2.8

package/dist/index.d.cts

@@ -251,11 +251,13 @@ export interface ModuleOptions {
      */
     translationDir?: string;
     /**
-     * Controls how pre-merged translation payload files are emitted during build.
+     * Controls how translation payloads are emitted (Node: `public/<apiBaseUrl>`; Edge: Nitro `serverAssets`).
      *
-     * Keep the defaults for the existing all-in-one behavior. For serverless or CDN-backed
-     * deployments, disable individual outputs to avoid duplicating large locale payloads in
-     * both Nitro server assets and public assets.
+     * - **Node**: `serverAssets` means local SSR via `readFile` under `public/` (no Rollup `raw:`).
+     * - **Edge**: `serverAssets` registers Nitro `serverAssets` (`assets:i18n`); it does not force a public copy.
+     *
+     * Keep the defaults for the usual all-in-one setup. For large Edge catalogs prefer `mode: 'source'`.
+     * For CDN-backed deployments, disable local outputs and set `apiBaseClientHost` / `apiBaseServerHost`.
      */
     translationPayloads?: TranslationPayloadOptions;
     /**
@@ -401,6 +403,47 @@ export interface ModuleOptions {
      * @default 0
      */
     cacheTtl?: number;
+    /**
+     * Named number formats per locale (Vue I18n-compatible).
+     * Enables `$tn(1000, 'currency')` style calls.
+     *
+     * @example
+     * numberFormats: {
+     *   en: { currency: { style: 'currency', currency: 'USD' } },
+     *   de: { currency: { style: 'currency', currency: 'EUR' } },
+     * }
+     */
+    numberFormats?: Record<string, Record<string, Intl.NumberFormatOptions>>;
+    /**
+     * Named datetime formats per locale (Vue I18n-compatible `datetimeFormats`).
+     * Enables `$td(date, 'short')` style calls.
+     *
+     * @example
+     * datetimeFormats: {
+     *   en: { short: { year: 'numeric', month: 'short', day: 'numeric' } },
+     *   de: { short: { year: 'numeric', month: 'short', day: 'numeric' } },
+     * }
+     */
+    datetimeFormats?: Record<string, Record<string, Intl.DateTimeFormatOptions>>;
+    /**
+     * HTTP `Cache-Control` max-age (seconds) for `/{apiBaseUrl}/:page/:locale/data.json`.
+     *
+     * Applies in full only while `dateBuild` busts the URL (`?v=...`), which is the default:
+     * the response is then `public, max-age=…, immutable` and safe for browsers and CDNs.
+     *
+     * - `dateBuild: 0`/`''` — the URL is stable, so this duration is *not* honoured; the
+     *   response becomes `public, max-age=0, must-revalidate` instead. A long `max-age` on an
+     *   unchanging URL pins the first payload a browser ever saw.
+     * - `0` — do not set `Cache-Control` at all (useful in local debugging)
+     * - Not applied in development (`import.meta.dev`) so HMR is not fought by the browser cache
+     * - Reaches only responses served through Nitro. Payloads copied into `public/` and served
+     *   by the hosting platform take that platform's headers — see the Performance guide.
+     *
+     * Analogous to `@nuxtjs/i18n` experimental `httpCacheDuration` (v10.2.0), but as an
+     * explicit response header rather than Nitro `defineCachedEventHandler` maxAge.
+     * @default 31536000
+     */
+    httpCacheDuration?: number;
     /**
      * Value used for cache-busting translation requests (`?v=...`).
      *
@@ -421,17 +464,19 @@ export interface ModuleOptions {
 export interface TranslationPayloadOptions {
     /**
      * Translation payload strategy.
-     * - `premerged`: build-time page/locale matrix (default)
-     * - `source`: compact source files merged at runtime (recommended for large serverless apps)
+     * - `premerged`: build-time `{page}/{locale}/data.json` matrix (default)
+     * - `source`: compact source files merged at runtime (prefer on Edge / large catalogs)
      * @default 'premerged'
      */
     mode?: 'premerged' | 'source';
     /**
-     * Register translation payload files as Nitro server assets.
-     * In `premerged` mode this is the fully merged page/locale matrix.
-     * In `source` mode this is the compact layer-merged source directory.
-     * Required for the built-in local `_locales` server route unless translations are fetched
-     * from `apiBaseServerHost`.
+     * Local SSR payloads: Node reads `public/<apiBaseUrl>` (forces public copy); Edge embeds via Nitro `serverAssets`.
+     *
+     * - **Node**: no Nitro `serverAssets` (avoids Rollup `raw:`). SSR reads
+     *   `public/<apiBaseUrl|publicDir>` as `{page}/{locale}/data.json`; when this is `true`,
+     *   a public copy is forced even if `publicAssets` is false.
+     * - **Edge** (`nitro.node === false`): Nitro `serverAssets` (`assets:i18n`) with the same
+     *   layout as `mode`. Does **not** force a public copy — set `publicAssets: true` for CDN.
      * @default true
      */
     serverAssets?: boolean;
@@ -442,21 +487,21 @@ export interface TranslationPayloadOptions {
      */
     serverHandler?: boolean;
     /**
-     * Copy translation payload files into Nitro public assets during production builds.
-     * In `source` mode this copies the compact source directory, not a pre-merged matrix.
-     * @default true in `premerged` mode, `false` in `source` mode
+     * Copy payloads into Nitro public output. Premerged → `{page}/{locale}/data.json` under `apiBaseUrl`; source → compact tree.
+     *
+     * On Node this tree is also the SSR source when `serverAssets` forces a public copy.
+     * @default true in premerged mode, false in source mode
      */
     publicAssets?: boolean;
     /**
-     * Add translation data routes to Nuxt/Nitro prerender output.
-     * Disable this when `_locales` payloads are served from an external host/CDN or should not be
-     * materialized into public output.
-     * @default true in `premerged` mode, `false` in `source` mode
+     * Opt in to Nitro-prerender `/{apiBaseUrl}/.../data.json`. Usually redundant when premerged `publicAssets` already wrote those files.
+     * @default false
      */
     prerenderRoutes?: boolean;
     /**
-     * Public output directory for copied translation payloads, relative to Nitro's public directory.
-     * Defaults to `translationDir`.
+     * Public output folder relative to Nitro public root. Defaults to `apiBaseUrl` (`_locales`).
+     *
+     * So static files match client fetch URLs (`/{apiBaseUrl}/{page}/{locale}/data.json`).
      */
     publicDir?: string;
     /**
@@ -517,6 +562,15 @@ export interface ModulePrivateOptionsExtend extends ModuleOptions {
     };
     /** Preload index translations in Nitro global middleware. */
     serverTranslationPreload?: boolean;
+    /**
+     * Absolute buildDir path to payload files (`.nuxt/i18n-merged` or `.nuxt/i18n-source`).
+     * Used by the Node fs reader in `import.meta.dev` / `import.meta.prerender`.
+     */
+    payloadFsDir: string;
+    /**
+     * Directory under Nitro `public/` for prod payload files (defaults to `translationDir`).
+     */
+    payloadPublicRel: string;
 }
 /** Object shape for a translation value that contains singular/plural forms. */
 export interface PluralTranslations {

package/dist/index.d.ts

@@ -251,11 +251,13 @@ export interface ModuleOptions {
      */
     translationDir?: string;
     /**
-     * Controls how pre-merged translation payload files are emitted during build.
+     * Controls how translation payloads are emitted (Node: `public/<apiBaseUrl>`; Edge: Nitro `serverAssets`).
      *
-     * Keep the defaults for the existing all-in-one behavior. For serverless or CDN-backed
-     * deployments, disable individual outputs to avoid duplicating large locale payloads in
-     * both Nitro server assets and public assets.
+     * - **Node**: `serverAssets` means local SSR via `readFile` under `public/` (no Rollup `raw:`).
+     * - **Edge**: `serverAssets` registers Nitro `serverAssets` (`assets:i18n`); it does not force a public copy.
+     *
+     * Keep the defaults for the usual all-in-one setup. For large Edge catalogs prefer `mode: 'source'`.
+     * For CDN-backed deployments, disable local outputs and set `apiBaseClientHost` / `apiBaseServerHost`.
      */
     translationPayloads?: TranslationPayloadOptions;
     /**
@@ -401,6 +403,47 @@ export interface ModuleOptions {
      * @default 0
      */
     cacheTtl?: number;
+    /**
+     * Named number formats per locale (Vue I18n-compatible).
+     * Enables `$tn(1000, 'currency')` style calls.
+     *
+     * @example
+     * numberFormats: {
+     *   en: { currency: { style: 'currency', currency: 'USD' } },
+     *   de: { currency: { style: 'currency', currency: 'EUR' } },
+     * }
+     */
+    numberFormats?: Record<string, Record<string, Intl.NumberFormatOptions>>;
+    /**
+     * Named datetime formats per locale (Vue I18n-compatible `datetimeFormats`).
+     * Enables `$td(date, 'short')` style calls.
+     *
+     * @example
+     * datetimeFormats: {
+     *   en: { short: { year: 'numeric', month: 'short', day: 'numeric' } },
+     *   de: { short: { year: 'numeric', month: 'short', day: 'numeric' } },
+     * }
+     */
+    datetimeFormats?: Record<string, Record<string, Intl.DateTimeFormatOptions>>;
+    /**
+     * HTTP `Cache-Control` max-age (seconds) for `/{apiBaseUrl}/:page/:locale/data.json`.
+     *
+     * Applies in full only while `dateBuild` busts the URL (`?v=...`), which is the default:
+     * the response is then `public, max-age=…, immutable` and safe for browsers and CDNs.
+     *
+     * - `dateBuild: 0`/`''` — the URL is stable, so this duration is *not* honoured; the
+     *   response becomes `public, max-age=0, must-revalidate` instead. A long `max-age` on an
+     *   unchanging URL pins the first payload a browser ever saw.
+     * - `0` — do not set `Cache-Control` at all (useful in local debugging)
+     * - Not applied in development (`import.meta.dev`) so HMR is not fought by the browser cache
+     * - Reaches only responses served through Nitro. Payloads copied into `public/` and served
+     *   by the hosting platform take that platform's headers — see the Performance guide.
+     *
+     * Analogous to `@nuxtjs/i18n` experimental `httpCacheDuration` (v10.2.0), but as an
+     * explicit response header rather than Nitro `defineCachedEventHandler` maxAge.
+     * @default 31536000
+     */
+    httpCacheDuration?: number;
     /**
      * Value used for cache-busting translation requests (`?v=...`).
      *
@@ -421,17 +464,19 @@ export interface ModuleOptions {
 export interface TranslationPayloadOptions {
     /**
      * Translation payload strategy.
-     * - `premerged`: build-time page/locale matrix (default)
-     * - `source`: compact source files merged at runtime (recommended for large serverless apps)
+     * - `premerged`: build-time `{page}/{locale}/data.json` matrix (default)
+     * - `source`: compact source files merged at runtime (prefer on Edge / large catalogs)
      * @default 'premerged'
      */
     mode?: 'premerged' | 'source';
     /**
-     * Register translation payload files as Nitro server assets.
-     * In `premerged` mode this is the fully merged page/locale matrix.
-     * In `source` mode this is the compact layer-merged source directory.
-     * Required for the built-in local `_locales` server route unless translations are fetched
-     * from `apiBaseServerHost`.
+     * Local SSR payloads: Node reads `public/<apiBaseUrl>` (forces public copy); Edge embeds via Nitro `serverAssets`.
+     *
+     * - **Node**: no Nitro `serverAssets` (avoids Rollup `raw:`). SSR reads
+     *   `public/<apiBaseUrl|publicDir>` as `{page}/{locale}/data.json`; when this is `true`,
+     *   a public copy is forced even if `publicAssets` is false.
+     * - **Edge** (`nitro.node === false`): Nitro `serverAssets` (`assets:i18n`) with the same
+     *   layout as `mode`. Does **not** force a public copy — set `publicAssets: true` for CDN.
      * @default true
      */
     serverAssets?: boolean;
@@ -442,21 +487,21 @@ export interface TranslationPayloadOptions {
      */
     serverHandler?: boolean;
     /**
-     * Copy translation payload files into Nitro public assets during production builds.
-     * In `source` mode this copies the compact source directory, not a pre-merged matrix.
-     * @default true in `premerged` mode, `false` in `source` mode
+     * Copy payloads into Nitro public output. Premerged → `{page}/{locale}/data.json` under `apiBaseUrl`; source → compact tree.
+     *
+     * On Node this tree is also the SSR source when `serverAssets` forces a public copy.
+     * @default true in premerged mode, false in source mode
      */
     publicAssets?: boolean;
     /**
-     * Add translation data routes to Nuxt/Nitro prerender output.
-     * Disable this when `_locales` payloads are served from an external host/CDN or should not be
-     * materialized into public output.
-     * @default true in `premerged` mode, `false` in `source` mode
+     * Opt in to Nitro-prerender `/{apiBaseUrl}/.../data.json`. Usually redundant when premerged `publicAssets` already wrote those files.
+     * @default false
      */
     prerenderRoutes?: boolean;
     /**
-     * Public output directory for copied translation payloads, relative to Nitro's public directory.
-     * Defaults to `translationDir`.
+     * Public output folder relative to Nitro public root. Defaults to `apiBaseUrl` (`_locales`).
+     *
+     * So static files match client fetch URLs (`/{apiBaseUrl}/{page}/{locale}/data.json`).
      */
     publicDir?: string;
     /**
@@ -517,6 +562,15 @@ export interface ModulePrivateOptionsExtend extends ModuleOptions {
     };
     /** Preload index translations in Nitro global middleware. */
     serverTranslationPreload?: boolean;
+    /**
+     * Absolute buildDir path to payload files (`.nuxt/i18n-merged` or `.nuxt/i18n-source`).
+     * Used by the Node fs reader in `import.meta.dev` / `import.meta.prerender`.
+     */
+    payloadFsDir: string;
+    /**
+     * Directory under Nitro `public/` for prod payload files (defaults to `translationDir`).
+     */
+    payloadPublicRel: string;
 }
 /** Object shape for a translation value that contains singular/plural forms. */
 export interface PluralTranslations {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i18n-micro/types",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "description": "TypeScript definitions for the Nuxt I18n Micro ecosystem.",
   "keywords": [
     "i18n",
@@ -51,14 +51,16 @@
   },
   "devDependencies": {
     "publint": "^0.3.17",
-    "vite": "^7.3.1",
-    "vite-plugin-dts": "^4.5.4"
+    "vite": "^7.3.6",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^4.1.10"
   },
   "engines": {
     "node": ">=18"
   },
   "scripts": {
     "build": "vite build",
-    "check:package": "publint"
+    "check:package": "publint",
+    "test": "vitest run --typecheck"
   }
 }