@i18n-micro/types 1.2.2 → 1.2.4

package/README.md

@@ -68,12 +68,15 @@ const routeParams: I18nRouteParams = {
 ### Types and Interfaces
 
 #### `Locale`
+
 Represents a locale configuration.
 
 #### `LocaleCode`
+
 Represents a locale code (e.g., `'en'`, `'de'`).
 
 #### `Strategies`
+
 Represents the available routing strategies.
 
 ```typescript
@@ -81,30 +84,39 @@ export type Strategies = 'no_prefix' | 'prefix_except_default' | 'prefix' | 'pre
 ```
 
 #### `ModuleOptions`
+
 Represents the configuration options for the `nuxt-i18n-micro` module.
 
 #### `ModuleOptionsExtend`
+
 Extends `ModuleOptions` with additional properties.
 
 #### `I18nRouteParams`
+
 Represents route parameters for different locales.
 
 #### `Params`
+
 Represents a key-value pair of parameters for interpolation.
 
 #### `PluralFunc`
+
 Represents a function for handling pluralization in translations.
 
 #### `GlobalLocaleRoutes`
+
 Represents global route configurations for different locales.
 
 #### `Translations`
+
 Represents a key-value pair of translations.
 
 #### `Translation`
+
 Represents a translation value, which can be a string, number, boolean, nested translations, or `null`.
 
 #### `PluralTranslations`
+
 Represents translations for singular and plural forms.
 
 ## Contributing

package/dist/index.d.cts

@@ -213,6 +213,11 @@ export interface ModuleOptions {
      * @default true
      */
     components?: boolean;
+    /**
+     * Preload index-page translations in Nitro global middleware (server-only, private config).
+     * @default false
+     */
+    serverTranslationPreload?: boolean;
     /**
      * The locale to use when no locale can be determined from URL or user preferences.
      * Also used as the fallback locale for missing translations when `fallbackLocale` is not set.
@@ -244,6 +249,14 @@ export interface ModuleOptions {
      * @default 'locales'
      */
     translationDir?: string;
+    /**
+     * Controls how pre-merged translation payload files are emitted during build.
+     *
+     * 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.
+     */
+    translationPayloads?: TranslationPayloadOptions;
     /**
      * Automatically detect the user's preferred language from the `Accept-Language` HTTP header.
      * Used in combination with `autoDetectPath` to decide when detection occurs.
@@ -404,6 +417,58 @@ export interface ModuleOptions {
      */
     experimental?: Record<string, unknown>;
 }
+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)
+     * @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`.
+     * @default true
+     */
+    serverAssets?: boolean;
+    /**
+     * Register the built-in server route at `/{apiBaseUrl}/:page/:locale/data.json`.
+     * Disable this when translation payloads are served from an external host/CDN.
+     * @default true
+     */
+    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
+     */
+    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
+     */
+    prerenderRoutes?: boolean;
+    /**
+     * Public output directory for copied translation payloads, relative to Nitro's public directory.
+     * Defaults to `translationDir`.
+     */
+    publicDir?: string;
+    /**
+     * Warn during build when generated payload file count exceeds this threshold.
+     * @default 500
+     */
+    warnFileCount?: number;
+    /**
+     * Warn during build when generated payload total size exceeds this threshold in bytes.
+     * @default 10485760 (10 MB)
+     */
+    warnSizeBytes?: number;
+}
 /**
  * Extended module options injected into the Nuxt runtime config.
  * Includes resolved values and build-time metadata.
@@ -421,6 +486,8 @@ export interface ModuleOptionsExtend extends ModuleOptions {
     disablePageLocales: boolean;
     /** Resolved flag: whether locale-based redirects are enabled. */
     redirects?: boolean;
+    /** Resolved translation payload loading strategy. */
+    translationPayloadMode?: 'premerged' | 'source';
 }
 /**
  * Private (server-only) module options passed to Nitro plugins and server middleware.
@@ -447,6 +514,8 @@ export interface ModulePrivateOptionsExtend extends ModuleOptions {
     routesLocaleLinks?: {
         [key: string]: string;
     };
+    /** Preload index translations in Nitro global middleware. */
+    serverTranslationPreload?: boolean;
 }
 /** Object shape for a translation value that contains singular/plural forms. */
 export interface PluralTranslations {

package/dist/index.d.ts

@@ -213,6 +213,11 @@ export interface ModuleOptions {
      * @default true
      */
     components?: boolean;
+    /**
+     * Preload index-page translations in Nitro global middleware (server-only, private config).
+     * @default false
+     */
+    serverTranslationPreload?: boolean;
     /**
      * The locale to use when no locale can be determined from URL or user preferences.
      * Also used as the fallback locale for missing translations when `fallbackLocale` is not set.
@@ -244,6 +249,14 @@ export interface ModuleOptions {
      * @default 'locales'
      */
     translationDir?: string;
+    /**
+     * Controls how pre-merged translation payload files are emitted during build.
+     *
+     * 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.
+     */
+    translationPayloads?: TranslationPayloadOptions;
     /**
      * Automatically detect the user's preferred language from the `Accept-Language` HTTP header.
      * Used in combination with `autoDetectPath` to decide when detection occurs.
@@ -404,6 +417,58 @@ export interface ModuleOptions {
      */
     experimental?: Record<string, unknown>;
 }
+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)
+     * @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`.
+     * @default true
+     */
+    serverAssets?: boolean;
+    /**
+     * Register the built-in server route at `/{apiBaseUrl}/:page/:locale/data.json`.
+     * Disable this when translation payloads are served from an external host/CDN.
+     * @default true
+     */
+    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
+     */
+    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
+     */
+    prerenderRoutes?: boolean;
+    /**
+     * Public output directory for copied translation payloads, relative to Nitro's public directory.
+     * Defaults to `translationDir`.
+     */
+    publicDir?: string;
+    /**
+     * Warn during build when generated payload file count exceeds this threshold.
+     * @default 500
+     */
+    warnFileCount?: number;
+    /**
+     * Warn during build when generated payload total size exceeds this threshold in bytes.
+     * @default 10485760 (10 MB)
+     */
+    warnSizeBytes?: number;
+}
 /**
  * Extended module options injected into the Nuxt runtime config.
  * Includes resolved values and build-time metadata.
@@ -421,6 +486,8 @@ export interface ModuleOptionsExtend extends ModuleOptions {
     disablePageLocales: boolean;
     /** Resolved flag: whether locale-based redirects are enabled. */
     redirects?: boolean;
+    /** Resolved translation payload loading strategy. */
+    translationPayloadMode?: 'premerged' | 'source';
 }
 /**
  * Private (server-only) module options passed to Nitro plugins and server middleware.
@@ -447,6 +514,8 @@ export interface ModulePrivateOptionsExtend extends ModuleOptions {
     routesLocaleLinks?: {
         [key: string]: string;
     };
+    /** Preload index translations in Nitro global middleware. */
+    serverTranslationPreload?: boolean;
 }
 /** Object shape for a translation value that contains singular/plural forms. */
 export interface PluralTranslations {

package/package.json

@@ -1,27 +1,35 @@
 {
   "name": "@i18n-micro/types",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "TypeScript definitions for the Nuxt I18n Micro ecosystem.",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/s00d/nuxt-i18n-micro.git",
-    "directory": "packages/types"
+  "keywords": [
+    "i18n",
+    "nuxt",
+    "types",
+    "typescript"
+  ],
+  "homepage": "https://github.com/s00d/nuxt-i18n-micro/tree/main/packages/types#readme",
+  "bugs": {
+    "url": "https://github.com/s00d/nuxt-i18n-micro/issues"
   },
   "license": "MIT",
-  "type": "module",
-  "sideEffects": false,
   "author": {
     "name": "s00d",
     "email": "Virus191288@gmail.com",
     "url": "https://s00d.github.io/"
   },
-  "homepage": "https://github.com/s00d/nuxt-i18n-micro/tree/main/packages/types#readme",
-  "bugs": {
-    "url": "https://github.com/s00d/nuxt-i18n-micro/issues"
-  },
-  "engines": {
-    "node": ">=18"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/s00d/nuxt-i18n-micro.git",
+    "directory": "packages/types"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "type": "module",
+  "sideEffects": false,
   "main": "dist/index.cjs",
   "types": "dist/index.d.ts",
   "exports": {
@@ -38,25 +46,17 @@
     },
     "./package.json": "./package.json"
   },
-  "files": [
-    "dist",
-    "README.md",
-    "LICENSE"
-  ],
   "publishConfig": {
     "access": "public"
   },
-  "keywords": [
-    "nuxt",
-    "i18n",
-    "typescript",
-    "types"
-  ],
   "devDependencies": {
     "publint": "^0.3.17",
     "vite": "^7.3.1",
     "vite-plugin-dts": "^4.5.4"
   },
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "build": "vite build",
     "check:package": "publint"