@i18n-micro/node 1.2.20 → 2.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
  
- Copyright (c) 2016 
+ Copyright (c) 2024 s00d
  
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,44 +1,24 @@
 # @i18n-micro/node
 
-Node.js runtime for nuxt-i18n-micro — filesystem translation loading on top of [`@i18n-micro/runtime`](../runtime). Use this in Node.js applications, CLI tools, or backend services.
-
-For browser / vanilla JS without `fs`, use `@i18n-micro/runtime` directly.
-
-## Installation
+Node.js loader for Nuxt I18n Micro: reads a translation folder (`locales/en.json`, `locales/pages/<page>/en.json`) into an `@i18n-micro/runtime` instance, for servers, CLIs and generators. Node.js `>=20`.
 
 ```bash
 pnpm add @i18n-micro/node
-# or
-npm install @i18n-micro/node
-# or
-yarn add @i18n-micro/node
 ```
 
-## Quick Start
-
-```typescript
+```ts
 import { createI18n } from '@i18n-micro/node'
 
-// 1. Create I18n instance
-const i18n = createI18n({
-  locale: 'en',
-  fallbackLocale: 'en',
-  translationDir: './locales', // Path to your locales directory
-  disablePageLocales: false, // If true, ignores pages/ folder and treats all files as global translations
-})
-
-// 2. Load translations from directory (recursive, supports pages structure)
+const i18n = createI18n({ locale: 'en', fallbackLocale: 'en', translationDir: './locales' })
 await i18n.loadTranslations()
 
-// 3. Use translations
-console.log(i18n.t('greeting', { name: 'John' })) // "Hello, John!"
-console.log(i18n.tc('apples', 5)) // "5 apples"
+i18n.t('greeting', { name: 'Ada' })
+i18n.t('title', undefined, undefined, 'blog-post') // locales/pages/blog/post/en.json
 ```
 
-## Resources
+Per request, `i18n.run(locale, () => next())` gives everything the request awaits its own locale and route; `i18n.fork(locale)` returns such an instance to pass around.
 
-- **Repository**: [https://github.com/s00d/nuxt-i18n-micro](https://github.com/s00d/nuxt-i18n-micro)
-- **Documentation**: [https://s00d.github.io/nuxt-i18n-micro/](https://s00d.github.io/nuxt-i18n-micro/)
+Docs: [https://s00d.github.io/nuxt-i18n-micro/integrations/nodejs-package](https://s00d.github.io/nuxt-i18n-micro/integrations/nodejs-package) · Repository: [github.com/s00d/nuxt-i18n-micro](https://github.com/s00d/nuxt-i18n-micro)
 
 ## License
 

package/dist/index.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require("@i18n-micro/runtime"),t=require("@i18n-micro/utils/parse-path"),n=require("node:fs/promises"),r=require("node:path"),i=require("@i18n-micro/core");async function a(e,i=!1){let a={root:{},routes:{}};try{let o=(await(0,n.readdir)(e,{recursive:!0,withFileTypes:!0})).filter(e=>e.isFile()&&e.name.endsWith(`.json`)),s=await Promise.all(o.map(async t=>{let i=(0,r.join)(t.path,t.name),a=(0,r.relative)(e,i).split(r.sep).join(`/`);try{let e=await(0,n.readFile)(i,`utf-8`);return{relativePath:a,translations:JSON.parse(e)}}catch(e){return console.error(`Failed to load translation file ${i}:`,e),null}}));for(let e of s)e&&(0,t.storeLoadedTranslationFile)(a,e.relativePath,e.translations,i)}catch(t){t&&typeof t==`object`&&`code`in t&&t.code!==`ENOENT`&&console.error(`Failed to read directory ${e}:`,t)}return a}async function o(e,t=!1){let{root:n}=await a(e,t);return n}var s=class extends e.I18n{constructor(e){let{translationDir:t,disablePageLocales:n,...r}=e;super(r),this.translationDir=t,this.disablePageLocales=n??!1}async loadTranslations(e){let n=e||this.translationDir;if(!n){console.warn(`[i18n-node] No translation directory specified`);return}let{root:r,routes:i}=await a(n,this.disablePageLocales);for(let[e,t]of Object.entries(r))this.helper.mergeTranslation(e,`index`,t,!0);for(let[e,n]of Object.entries(i))for(let[r,i]of Object.entries(n)){let n=this.helper.getCache(r,`index`);this.helper.loadPageTranslations(r,e,(0,t.mergeRouteTranslationsWithRoot)(n,i))}this.onTranslationsChanged()}async reload(){let e=this.translationDir;if(!e){console.warn(`[i18n-node] No translation directory specified`);return}this.clearCache(),await this.loadTranslations(e),console.log(`[i18n-node] Cache cleared and translations reloaded.`)}};function c(e){return new s(e)}Object.defineProperty(exports,"FormatService",{enumerable:!0,get:function(){return i.FormatService}}),exports.I18n=s,exports.createI18n=c,Object.defineProperty(exports,"interpolate",{enumerable:!0,get:function(){return i.interpolate}}),exports.loadRootTranslations=o,exports.loadTranslations=a;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require("node:async_hooks"),t=require("node:fs"),n=require("@i18n-micro/runtime"),r=require("@i18n-micro/utils/load-dir"),i=require("@i18n-micro/core");function a(e,t=!1){return(0,r.loadTranslationDirAsync)(e,t)}async function o(e,t=!1){let{root:n}=await a(e,t);return n}var s=class extends n.I18n{constructor(t){let{translationDir:n,disablePageLocales:r,...i}=t;super(i);let a=t.parent;this.translationDir=n??a?.translationDir,this.disablePageLocales=r??a?.disablePageLocales??!1,this.scope=a?.scope??new e.AsyncLocalStorage,this.forked=a!==void 0}get store(){return this.forked?this.ownStore:this.scope?.getStore()?.ownStore??this.ownStore}run(e,t){let n=this.fork(e);return this.scope.run(n,t,n)}async loadTranslations(e){let t=e||this.translationDir;if(!t){console.warn(`[i18n-node] No translation directory specified`);return}let{root:n,routes:r}=await a(t,this.disablePageLocales);this.loadMessages(n,r)}async reload(){let e=this.translationDir;if(!e){console.warn(`[i18n-node] No translation directory specified`);return}let{root:n,routes:r}=await a(e,this.disablePageLocales);(0,t.existsSync)(e)&&(this.clearCache(),this.loadMessages(n,r))}};function c(e){return new s(e)}Object.defineProperty(exports,"FormatService",{enumerable:!0,get:function(){return i.FormatService}}),exports.I18n=s,exports.createI18n=c,Object.defineProperty(exports,"interpolate",{enumerable:!0,get:function(){return i.interpolate}}),exports.loadRootTranslations=o,exports.loadTranslations=a,Object.defineProperty(exports,"localeIsoMap",{enumerable:!0,get:function(){return i.localeIsoMap}});

package/dist/index.d.cts

@@ -6,8 +6,10 @@ import { I18nOptions as I18nOptions_2 } from '@i18n-micro/runtime';
 import { interpolate } from '@i18n-micro/core';
 import { Locale } from '@i18n-micro/types';
 import { LocaleCode } from '@i18n-micro/types';
+import { localeIsoMap } from '@i18n-micro/core';
 import { Params } from '@i18n-micro/types';
 import { PluralFunc } from '@i18n-micro/types';
+import { ReactiveI18nStore } from '@i18n-micro/core';
 import { TranslationFileBuckets } from '@i18n-micro/utils/parse-path';
 import { Translations } from '@i18n-micro/types';
 
@@ -22,8 +24,20 @@ export { Getter }
 export declare class I18n extends I18n_2 {
     translationDir?: string;
     private disablePageLocales;
+    /** The request's fork; shared with forks, so `run` works from any of them. */
+    private readonly scope;
+    private readonly forked;
     constructor(options: I18nOptions);
+    /** Inside `run`, the shared instance answers with the request's locale and route. A fork always answers with its own. */
+    protected get store(): ReactiveI18nStore;
+    /**
+     * Runs `fn` with a fork for `locale` as the current request: until `fn` and everything it awaits
+     * finish, this instance reads and sets that fork's locale and route. `fn` also gets the fork.
+     * ponytail: dictionary writes go to the instance they are called on; write to the fork for request-only keys.
+     */
+    run<T>(locale: string, fn: (i18n: this) => T): T;
     loadTranslations(dir?: string): Promise<void>;
+    /** Re-reads the directory. The old dictionaries answer until the new ones are in, so no request sees an empty instance. */
     reload(): Promise<void>;
 }
 
@@ -57,6 +71,8 @@ export { Locale }
 
 export { LocaleCode }
 
+export { localeIsoMap }
+
 export { Params }
 
 export { PluralFunc }

package/dist/index.d.ts

@@ -6,8 +6,10 @@ import { I18nOptions as I18nOptions_2 } from '@i18n-micro/runtime';
 import { interpolate } from '@i18n-micro/core';
 import { Locale } from '@i18n-micro/types';
 import { LocaleCode } from '@i18n-micro/types';
+import { localeIsoMap } from '@i18n-micro/core';
 import { Params } from '@i18n-micro/types';
 import { PluralFunc } from '@i18n-micro/types';
+import { ReactiveI18nStore } from '@i18n-micro/core';
 import { TranslationFileBuckets } from '@i18n-micro/utils/parse-path';
 import { Translations } from '@i18n-micro/types';
 
@@ -22,8 +24,20 @@ export { Getter }
 export declare class I18n extends I18n_2 {
     translationDir?: string;
     private disablePageLocales;
+    /** The request's fork; shared with forks, so `run` works from any of them. */
+    private readonly scope;
+    private readonly forked;
     constructor(options: I18nOptions);
+    /** Inside `run`, the shared instance answers with the request's locale and route. A fork always answers with its own. */
+    protected get store(): ReactiveI18nStore;
+    /**
+     * Runs `fn` with a fork for `locale` as the current request: until `fn` and everything it awaits
+     * finish, this instance reads and sets that fork's locale and route. `fn` also gets the fork.
+     * ponytail: dictionary writes go to the instance they are called on; write to the fork for request-only keys.
+     */
+    run<T>(locale: string, fn: (i18n: this) => T): T;
     loadTranslations(dir?: string): Promise<void>;
+    /** Re-reads the directory. The old dictionaries answer until the new ones are in, so no request sees an empty instance. */
     reload(): Promise<void>;
 }
 
@@ -57,6 +71,8 @@ export { Locale }
 
 export { LocaleCode }
 
+export { localeIsoMap }
+
 export { Params }
 
 export { PluralFunc }

package/dist/index.mjs

@@ -1,60 +1,39 @@
-import { I18n as e } from "@i18n-micro/runtime";
-import { mergeRouteTranslationsWithRoot as t, storeLoadedTranslationFile as n } from "@i18n-micro/utils/parse-path";
-import { readFile as r, readdir as i } from "node:fs/promises";
-import { join as a, relative as o, sep as s } from "node:path";
-import { FormatService as c, interpolate as l } from "@i18n-micro/core";
-//#region src/loader.ts
-async function u(e, t = !1) {
-	let c = {
-		root: {},
-		routes: {}
-	};
-	try {
-		let l = (await i(e, {
-			recursive: !0,
-			withFileTypes: !0
-		})).filter((e) => e.isFile() && e.name.endsWith(".json")), u = await Promise.all(l.map(async (t) => {
-			let n = a(t.path, t.name), i = o(e, n).split(s).join("/");
-			try {
-				let e = await r(n, "utf-8");
-				return {
-					relativePath: i,
-					translations: JSON.parse(e)
-				};
-			} catch (e) {
-				return console.error(`Failed to load translation file ${n}:`, e), null;
-			}
-		}));
-		for (let e of u) e && n(c, e.relativePath, e.translations, t);
-	} catch (t) {
-		t && typeof t == "object" && "code" in t && t.code !== "ENOENT" && console.error(`Failed to read directory ${e}:`, t);
-	}
-	return c;
+import { AsyncLocalStorage as e } from "node:async_hooks";
+import { existsSync as t } from "node:fs";
+import { I18n as n } from "@i18n-micro/runtime";
+import { loadTranslationDirAsync as r } from "@i18n-micro/utils/load-dir";
+import { FormatService as i, interpolate as a, localeIsoMap as o } from "@i18n-micro/core";
+// src/loader.ts
+function s(e, t = !1) {
+	return r(e, t);
 }
-async function d(e, t = !1) {
-	let { root: n } = await u(e, t);
+async function c(e, t = !1) {
+	let { root: n } = await s(e, t);
 	return n;
 }
-//#endregion
-//#region src/i18n.ts
-var f = class extends e {
-	constructor(e) {
-		let { translationDir: t, disablePageLocales: n, ...r } = e;
-		super(r), this.translationDir = t, this.disablePageLocales = n ?? !1;
+// src/i18n.ts
+var l = class extends n {
+	constructor(t) {
+		let { translationDir: n, disablePageLocales: r, ...i } = t;
+		super(i);
+		let a = t.parent;
+		this.translationDir = n ?? a?.translationDir, this.disablePageLocales = r ?? a?.disablePageLocales ?? !1, this.scope = a?.scope ?? new e(), this.forked = a !== void 0;
+	}
+	get store() {
+		return this.forked ? this.ownStore : this.scope?.getStore()?.ownStore ?? this.ownStore;
+	}
+	run(e, t) {
+		let n = this.fork(e);
+		return this.scope.run(n, t, n);
 	}
 	async loadTranslations(e) {
-		let n = e || this.translationDir;
-		if (!n) {
+		let t = e || this.translationDir;
+		if (!t) {
 			console.warn("[i18n-node] No translation directory specified");
 			return;
 		}
-		let { root: r, routes: i } = await u(n, this.disablePageLocales);
-		for (let [e, t] of Object.entries(r)) this.helper.mergeTranslation(e, "index", t, !0);
-		for (let [e, n] of Object.entries(i)) for (let [r, i] of Object.entries(n)) {
-			let n = this.helper.getCache(r, "index");
-			this.helper.loadPageTranslations(r, e, t(n, i));
-		}
-		this.onTranslationsChanged();
+		let { root: n, routes: r } = await s(t, this.disablePageLocales);
+		this.loadMessages(n, r);
 	}
 	async reload() {
 		let e = this.translationDir;
@@ -62,11 +41,11 @@ var f = class extends e {
 			console.warn("[i18n-node] No translation directory specified");
 			return;
 		}
-		this.clearCache(), await this.loadTranslations(e), console.log("[i18n-node] Cache cleared and translations reloaded.");
+		let { root: n, routes: r } = await s(e, this.disablePageLocales);
+		t(e) && (this.clearCache(), this.loadMessages(n, r));
 	}
 };
-function p(e) {
-	return new f(e);
+function u(e) {
+	return new l(e);
 }
-//#endregion
-export { c as FormatService, f as I18n, p as createI18n, l as interpolate, d as loadRootTranslations, u as loadTranslations };
+export { i as FormatService, l as I18n, u as createI18n, a as interpolate, c as loadRootTranslations, s as loadTranslations, o as localeIsoMap };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i18n-micro/node",
-  "version": "1.2.20",
+  "version": "2.0.0",
   "description": "Node.js utilities for loading translations and locale data in Nuxt I18n Micro.",
   "keywords": [
     "i18n",
@@ -13,6 +13,11 @@
     "url": "https://github.com/s00d/nuxt-i18n-micro/issues"
   },
   "license": "MIT",
+  "author": {
+    "name": "s00d",
+    "email": "Virus191288@gmail.com",
+    "url": "https://s00d.github.io/"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/s00d/nuxt-i18n-micro.git",
@@ -45,25 +50,25 @@
     "access": "public"
   },
   "dependencies": {
-    "@i18n-micro/core": "^1.3.21",
-    "@i18n-micro/types": "^1.2.17",
-    "@i18n-micro/runtime": "^1.0.4",
-    "@i18n-micro/utils": "^1.0.26"
+    "@i18n-micro/core": "^2.0.0",
+    "@i18n-micro/runtime": "^2.0.0",
+    "@i18n-micro/types": "^2.0.0",
+    "@i18n-micro/utils": "^2.0.0"
   },
   "devDependencies": {
     "@types/node": "^22.19.0",
-    "publint": "^0.3.24",
-    "vite": "^8.3.1",
-    "vite-plugin-dts": "^5.1.1",
-    "vitest": "^5.0.2"
+    "publint": "^0.3.25",
+    "vite": "^8.3.5",
+    "vite-plugin-dts": "^5.1.2",
+    "vitest": "^5.1.0"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=20"
   },
   "scripts": {
     "build": "vite build",
     "check:package": "publint",
-    "dev": "cd playground && npm run dev",
+    "dev": "pnpm --dir playground dev",
     "test": "vitest run",
     "typecheck": "tsc --noEmit"
   }