@i18n-micro/types 1.1.6 → 1.1.7

package/dist/index.d.ts

@@ -28,6 +28,29 @@ export type TranslationKey = keyof DefineLocaleMessage extends never ? string :
  * ```
  */
 export type ScopedKey<Scope extends string> = Extract<TranslationKey, `${Scope}.${string}`>;
+/**
+ * Locale configuration object.
+ *
+ * Supports arbitrary custom properties via the index signature `[key: string]: unknown`.
+ * To get full TypeScript support for your custom properties, use module augmentation:
+ *
+ * ```typescript
+ * // app/i18n.d.ts (or any .d.ts file included in your tsconfig)
+ * declare module '@i18n-micro/types' {
+ *   interface Locale {
+ *     flag?: string
+ *     currency?: string
+ *   }
+ * }
+ * ```
+ *
+ * Then access them with full typing:
+ * ```typescript
+ * const locales = $getLocales()
+ * locales[0].flag     // string | undefined  (typed!)
+ * locales[0].currency // string | undefined  (typed!)
+ * ```
+ */
 export interface Locale {
     /** BCP-47 locale code (e.g. `'en'`, `'de-DE'`, `'zh-Hans'`). Used in URLs and as file/key identifier. */
     code: LocaleCode;
@@ -352,6 +375,17 @@ export interface ModuleOptions {
      * @default 0
      */
     cacheTtl?: number;
+    /**
+     * Value used for cache-busting translation requests (`?v=...`).
+     *
+     * When not provided, the module falls back to `Date.now()` (non-deterministic).
+     * For reproducible/rolling deployments, set this to a stable value
+     * (e.g. a git SHA or build number).
+     *
+     * @example
+     * i18n: { dateBuild: 'e3b0c442' }
+     */
+    dateBuild?: string | number;
     /**
      * Bucket for experimental/unstable options.
      * Contents may change or be removed without notice between minor versions.
@@ -363,8 +397,8 @@ export interface ModuleOptions {
  * Includes resolved values and build-time metadata.
  */
 export interface ModuleOptionsExtend extends ModuleOptions {
-    /** Unix timestamp (ms) of the last build. Used for cache-busting translation requests. */
-    dateBuild: number;
+    /** Value used for cache-busting translation requests (`?v=...`). */
+    dateBuild: string | number;
     /** Whether the Nuxt app uses hash-based routing (`router.options.hashMode`). */
     hashMode: boolean;
     /** Whether the current build is a static site generation (SSG / `nuxi generate`). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i18n-micro/types",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "",
   "repository": "s00d/nuxt-i18n-micro",
   "license": "MIT",

package/src/index.ts

@@ -33,6 +33,29 @@ export type TranslationKey = keyof DefineLocaleMessage extends never ? string :
  */
 export type ScopedKey<Scope extends string> = Extract<TranslationKey, `${Scope}.${string}`>
 
+/**
+ * Locale configuration object.
+ *
+ * Supports arbitrary custom properties via the index signature `[key: string]: unknown`.
+ * To get full TypeScript support for your custom properties, use module augmentation:
+ *
+ * ```typescript
+ * // app/i18n.d.ts (or any .d.ts file included in your tsconfig)
+ * declare module '@i18n-micro/types' {
+ *   interface Locale {
+ *     flag?: string
+ *     currency?: string
+ *   }
+ * }
+ * ```
+ *
+ * Then access them with full typing:
+ * ```typescript
+ * const locales = $getLocales()
+ * locales[0].flag     // string | undefined  (typed!)
+ * locales[0].currency // string | undefined  (typed!)
+ * ```
+ */
 export interface Locale {
   /** BCP-47 locale code (e.g. `'en'`, `'de-DE'`, `'zh-Hans'`). Used in URLs and as file/key identifier. */
   code: LocaleCode
@@ -402,6 +425,18 @@ export interface ModuleOptions {
    */
   cacheTtl?: number
 
+  /**
+   * Value used for cache-busting translation requests (`?v=...`).
+   *
+   * When not provided, the module falls back to `Date.now()` (non-deterministic).
+   * For reproducible/rolling deployments, set this to a stable value
+   * (e.g. a git SHA or build number).
+   *
+   * @example
+   * i18n: { dateBuild: 'e3b0c442' }
+   */
+  dateBuild?: string | number
+
   /**
    * Bucket for experimental/unstable options.
    * Contents may change or be removed without notice between minor versions.
@@ -414,8 +449,8 @@ export interface ModuleOptions {
  * Includes resolved values and build-time metadata.
  */
 export interface ModuleOptionsExtend extends ModuleOptions {
-  /** Unix timestamp (ms) of the last build. Used for cache-busting translation requests. */
-  dateBuild: number
+  /** Value used for cache-busting translation requests (`?v=...`). */
+  dateBuild: string | number
   /** Whether the Nuxt app uses hash-based routing (`router.options.hashMode`). */
   hashMode: boolean
   /** Whether the current build is a static site generation (SSG / `nuxi generate`). */