@i18n-micro/types-generator 1.1.6 → 1.1.7

package/dist/core/generator.d.ts

@@ -3,6 +3,12 @@ export interface GeneratorOptions {
     translationDir: string;
     outputFile?: string;
 }
+/**
+ * Emit a TS property name from a translation key.
+ * JSON.stringify covers quotes/newlines/null bytes; U+2028/U+2029 need an extra escape
+ * so the .d.ts stays safe when embedded in older JS tooling.
+ */
+export declare function formatKeyProperty(key: string): string;
 /**
  * Generates a string with TypeScript types for translation keys.
  * Does not write a file, only returns content.

package/dist/core/generator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/core/generator.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CA4C/E;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAiB9E"}
+{"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/core/generator.ts"],"names":[],"mappings":"AAKA,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAOD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIrD;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAgD/E;AAED;;;;;;GAMG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAiB9E"}

package/dist/core/parser.d.ts

@@ -1,3 +1,7 @@
+/**
+ * True for plain objects suitable as translation maps (not arrays, Date, null, etc.).
+ */
+export declare function isPlainTranslationObject(value: unknown): value is Record<string, unknown>;
 /**
  * Recursively traverses a JSON object and creates a flat list of dot-separated keys.
  *

package/dist/core/parser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/core/parser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,SAAK,GAAG,MAAM,EAAE,CAqB/E"}
+{"version":3,"file":"parser.d.ts","sourceRoot":"","sources":["../../src/core/parser.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzF;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,SAAK,GAAG,MAAM,EAAE,CAwB/E"}

package/dist/generator-BonabDld.cjs

@@ -0,0 +1,14 @@
+let e=require("node:fs"),t=require("node:path"),n=require("globby");function r(e){return typeof e==`object`&&!!e&&!Array.isArray(e)&&Object.getPrototypeOf(e)===Object.prototype}function i(e,t=``){if(!r(e))return[];let n=[];for(let a in e){if(!Object.hasOwn(e,a))continue;let o=e[a],s=t?`${t}.${a}`:a;r(o)?n.push(...i(o,s)):n.push(s)}return n}function a(e){return e.charCodeAt(0)===65279?e.slice(1):e}function o(e){return JSON.stringify(e).replace(/\u2028/g,`\\u2028`).replace(/\u2029/g,`\\u2029`)}async function s(s){let c=(0,t.resolve)(s.srcDir,s.translationDir),l=await(0,n.globby)(`**/*.json`,{cwd:c,absolute:!0,ignore:[`node_modules/**`,`dist/**`,`.nuxt/**`]}),u=new Set;for(let t of l)try{let n=JSON.parse(a((0,e.readFileSync)(t,`utf-8`)));if(!r(n)){console.warn(`[i18n-types] Skipping ${t}: root value must be a plain JSON object`);continue}let o=i(n);for(let e of o)u.add(e)}catch(e){console.warn(`[i18n-types] Failed to parse ${t}:`,e)}return`/* prettier-ignore */
+// @ts-nocheck
+// Generated by @i18n-micro/types-generator
+// DO NOT EDIT THIS FILE MANUALLY
+
+import '@i18n-micro/types';
+
+declare module '@i18n-micro/types' {
+  export interface DefineLocaleMessage {
+${Array.from(u).sort().map(e=>`    ${o(e)}: string;`).join(`
+`)}
+  }
+}
+`}async function c(n){let r=await s(n),i=n.outputFile||(0,t.resolve)(n.srcDir,`i18n-micro.d.ts`),a=(0,t.dirname)(i);try{(0,e.mkdirSync)(a,{recursive:!0})}catch{}return(0,e.writeFileSync)(i,r,`utf-8`),i}Object.defineProperty(exports,"a",{enumerable:!0,get:function(){return r}}),Object.defineProperty(exports,"i",{enumerable:!0,get:function(){return i}}),Object.defineProperty(exports,"n",{enumerable:!0,get:function(){return c}}),Object.defineProperty(exports,"r",{enumerable:!0,get:function(){return s}}),Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return o}});

package/dist/{generator-BRNo9fkZ.js → generator-CWXsEVLn.js}

@@ -2,18 +2,28 @@ import { mkdirSync as e, readFileSync as t, writeFileSync as n } from "node:fs";
 import { dirname as r, resolve as i } from "node:path";
 import { globby as a } from "globby";
 //#region src/core/parser.ts
-function o(e, t = "") {
+function o(e) {
+	return typeof e == "object" && !!e && !Array.isArray(e) && Object.getPrototypeOf(e) === Object.prototype;
+}
+function s(e, t = "") {
+	if (!o(e)) return [];
 	let n = [];
 	for (let r in e) {
 		if (!Object.hasOwn(e, r)) continue;
 		let i = e[r], a = t ? `${t}.${r}` : r;
-		typeof i == "object" && i && !Array.isArray(i) ? n.push(...o(i, a)) : n.push(a);
+		o(i) ? n.push(...s(i, a)) : n.push(a);
 	}
 	return n;
 }
 //#endregion
 //#region src/core/generator.ts
-async function s(e) {
+function c(e) {
+	return e.charCodeAt(0) === 65279 ? e.slice(1) : e;
+}
+function l(e) {
+	return JSON.stringify(e).replace(/\u2028/g, "\\u2028").replace(/\u2029/g, "\\u2029");
+}
+async function u(e) {
 	let n = i(e.srcDir, e.translationDir), r = await a("**/*.json", {
 		cwd: n,
 		absolute: !0,
@@ -22,10 +32,15 @@ async function s(e) {
 			"dist/**",
 			".nuxt/**"
 		]
-	}), s = /* @__PURE__ */ new Set();
+	}), u = /* @__PURE__ */ new Set();
 	for (let e of r) try {
-		let n = o(JSON.parse(t(e, "utf-8")));
-		for (let e of n) s.add(e);
+		let n = JSON.parse(c(t(e, "utf-8")));
+		if (!o(n)) {
+			console.warn(`[i18n-types] Skipping ${e}: root value must be a plain JSON object`);
+			continue;
+		}
+		let r = s(n);
+		for (let e of r) u.add(e);
 	} catch (t) {
 		console.warn(`[i18n-types] Failed to parse ${e}:`, t);
 	}
@@ -38,17 +53,17 @@ import '@i18n-micro/types';
 
 declare module '@i18n-micro/types' {
   export interface DefineLocaleMessage {
-${Array.from(s).sort().map((e) => `    '${e}': string;`).join("\n")}
+${Array.from(u).sort().map((e) => `    ${l(e)}: string;`).join("\n")}
   }
 }
 `;
 }
-async function c(t) {
-	let a = await s(t), o = t.outputFile || i(t.srcDir, "i18n-micro.d.ts"), c = r(o);
+async function d(t) {
+	let a = await u(t), o = t.outputFile || i(t.srcDir, "i18n-micro.d.ts"), s = r(o);
 	try {
-		e(c, { recursive: !0 });
+		e(s, { recursive: !0 });
 	} catch {}
 	return n(o, a, "utf-8"), o;
 }
 //#endregion
-export { s as n, o as r, c as t };
+export { o as a, s as i, d as n, u as r, l as t };

package/dist/index.cjs

@@ -1 +1 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./generator-Cqp8Bpki.cjs");let t=require("node:path"),n=require("chokidar"),r=require("unplugin");var i=null,a=null;function o(e,t){return function(...n){a&&clearTimeout(a),a=setTimeout(()=>{a&&clearTimeout(a),a=null,e(...n)},t)}}var s=(0,r.createUnplugin)(r=>({name:`i18n-micro-types-generator`,async buildStart(){try{await e.t(r)}catch(e){console.warn(`[i18n-types] Failed to generate types:`,e)}if(process.env.NODE_ENV===`development`||process.env.NODE_ENV!==`production`){let a=(0,t.resolve)(r.srcDir,r.translationDir),s=o(async()=>{try{await e.t(r)}catch(e){console.warn(`[i18n-types] Failed to regenerate types:`,e)}},300);i=(0,n.watch)(a,{ignoreInitial:!0,ignored:e=>/(?:^|[/\\])(?:node_modules|dist|\.nuxt)(?:[/\\]|$)/.test(e)}),i.on(`all`,async(e,t)=>{t.endsWith(`.json`)&&s()})}},buildEnd(){i&&=(i.close(),null),a&&=(clearTimeout(a),null)}}));exports.I18nTypesPlugin=s,exports.flattenKeys=e.r,exports.generateTypes=e.t,exports.getTypesString=e.n;
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require("./generator-BonabDld.cjs");let t=require("node:path"),n=require("chokidar"),r=require("unplugin");var i=null,a=null;function o(e,t){return function(...n){a&&clearTimeout(a),a=setTimeout(()=>{a&&clearTimeout(a),a=null,e(...n)},t)}}var s=(0,r.createUnplugin)(r=>({name:`i18n-micro-types-generator`,async buildStart(){try{await e.n(r)}catch(e){console.warn(`[i18n-types] Failed to generate types:`,e)}if(process.env.NODE_ENV===`development`||process.env.NODE_ENV!==`production`){let a=(0,t.resolve)(r.srcDir,r.translationDir),s=o(async()=>{try{await e.n(r)}catch(e){console.warn(`[i18n-types] Failed to regenerate types:`,e)}},300);i=(0,n.watch)(a,{ignoreInitial:!0,ignored:e=>/(?:^|[/\\])(?:node_modules|dist|\.nuxt)(?:[/\\]|$)/.test(e)}),i.on(`all`,async(e,t)=>{t.endsWith(`.json`)&&s()})}},buildEnd(){i&&=(i.close(),null),a&&=(clearTimeout(a),null)}}));exports.I18nTypesPlugin=s,exports.flattenKeys=e.i,exports.formatKeyProperty=e.t,exports.generateTypes=e.n,exports.getTypesString=e.r,exports.isPlainTranslationObject=e.a;

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 export type { GeneratorOptions } from './core/generator';
-export { generateTypes, getTypesString } from './core/generator';
-export { flattenKeys } from './core/parser';
+export { formatKeyProperty, generateTypes, getTypesString } from './core/generator';
+export { flattenKeys, isPlainTranslationObject } from './core/parser';
 export { I18nTypesPlugin } from './unplugin';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export type { GeneratorOptions } from './core/generator';
-export { generateTypes, getTypesString } from './core/generator';
-export { flattenKeys } from './core/parser';
+export { formatKeyProperty, generateTypes, getTypesString } from './core/generator';
+export { flattenKeys, isPlainTranslationObject } from './core/parser';
 export { I18nTypesPlugin } from './unplugin';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACxD,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACxD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACnF,OAAO,EAAE,WAAW,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAA;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA"}

package/dist/index.mjs

@@ -1,17 +1,17 @@
-import { n as e, r as t, t as n } from "./generator-BRNo9fkZ.js";
-import { resolve as r } from "node:path";
-import { watch as i } from "chokidar";
-import { createUnplugin as a } from "unplugin";
+import { a as e, i as t, n, r, t as i } from "./generator-CWXsEVLn.js";
+import { resolve as a } from "node:path";
+import { watch as o } from "chokidar";
+import { createUnplugin as s } from "unplugin";
 //#region src/unplugin.ts
-var o = null, s = null;
-function c(e, t) {
+var c = null, l = null;
+function u(e, t) {
 	return function(...n) {
-		s && clearTimeout(s), s = setTimeout(() => {
-			s && clearTimeout(s), s = null, e(...n);
+		l && clearTimeout(l), l = setTimeout(() => {
+			l && clearTimeout(l), l = null, e(...n);
 		}, t);
 	};
 }
-var l = a((e) => ({
+var d = s((e) => ({
 	name: "i18n-micro-types-generator",
 	async buildStart() {
 		try {
@@ -20,24 +20,24 @@ var l = a((e) => ({
 			console.warn("[i18n-types] Failed to generate types:", e);
 		}
 		if (process.env.NODE_ENV === "development" || process.env.NODE_ENV !== "production") {
-			let t = r(e.srcDir, e.translationDir), a = c(async () => {
+			let t = a(e.srcDir, e.translationDir), r = u(async () => {
 				try {
 					await n(e);
 				} catch (e) {
 					console.warn("[i18n-types] Failed to regenerate types:", e);
 				}
 			}, 300);
-			o = i(t, {
+			c = o(t, {
 				ignoreInitial: !0,
 				ignored: (e) => /(?:^|[/\\])(?:node_modules|dist|\.nuxt)(?:[/\\]|$)/.test(e)
-			}), o.on("all", async (e, t) => {
-				t.endsWith(".json") && a();
+			}), c.on("all", async (e, t) => {
+				t.endsWith(".json") && r();
 			});
 		}
 	},
 	buildEnd() {
-		o &&= (o.close(), null), s &&= (clearTimeout(s), null);
+		c &&= (c.close(), null), l &&= (clearTimeout(l), null);
 	}
 }));
 //#endregion
-export { l as I18nTypesPlugin, t as flattenKeys, n as generateTypes, e as getTypesString };
+export { d as I18nTypesPlugin, t as flattenKeys, i as formatKeyProperty, n as generateTypes, r as getTypesString, e as isPlainTranslationObject };

package/dist/nuxt.cjs

@@ -1 +1 @@
-Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require("./generator-Cqp8Bpki.cjs");let t=require("@nuxt/kit");var n=(0,t.defineNuxtModule)({meta:{name:`@i18n-micro/types-generator`,configKey:`i18nTypes`},defaults:{translationDir:`locales`},async setup(n,r){let i=r.options.i18n,a=n.translationDir||i?.translationDir||`locales`;(0,t.addTypeTemplate)({filename:`types/i18n-micro.d.ts`,getContents:async()=>{try{return await e.n({srcDir:r.options.rootDir,translationDir:a})}catch(e){return console.warn(`[i18n-types] Failed to generate types:`,e),`// Failed to generate types: ${e instanceof Error?e.message:String(e)}`}}}),r.hook(`builder:watch`,async(e,t)=>{let n=t.replace(/\\/g,`/`),i=a.replace(/\\/g,`/`);n.includes(i)&&n.endsWith(`.json`)&&await r.callHook(`builder:generateApp`)})}});exports.default=n;
+Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:`Module`}});const e=require("./generator-BonabDld.cjs");let t=require("@nuxt/kit");var n=(0,t.defineNuxtModule)({meta:{name:`@i18n-micro/types-generator`,configKey:`i18nTypes`},defaults:{translationDir:`locales`},async setup(n,r){let i=r.options.i18n,a=n.translationDir||i?.translationDir||`locales`,o=n.outputFile;typeof o==`string`&&o.length>0&&console.warn("[i18n-types] `i18nTypes.outputFile` is ignored in Nuxt; generated types are written to `.nuxt/types/i18n-micro.d.ts`."),r.options.typescript.hoist||=[],r.options.typescript.hoist.includes(`@i18n-micro/types`)||r.options.typescript.hoist.push(`@i18n-micro/types`),(0,t.addTypeTemplate)({filename:`types/i18n-micro.d.ts`,getContents:async()=>{try{return await e.r({srcDir:r.options.rootDir,translationDir:a})}catch(e){return console.warn(`[i18n-types] Failed to generate types:`,e),`// Failed to generate types: ${e instanceof Error?e.message:String(e)}`}}}),r.hook(`builder:watch`,async(e,t)=>{let n=t.replace(/\\/g,`/`),i=a.replace(/\\/g,`/`);n.includes(i)&&n.endsWith(`.json`)&&await r.callHook(`builder:generateApp`)})}});exports.default=n;

package/dist/nuxt.d.cts

@@ -1,6 +1,6 @@
 export interface I18nTypesGeneratorOptions {
+    /** Translation directory relative to the project root. Defaults to `i18n.translationDir` or `'locales'`. */
     translationDir?: string;
-    outputFile?: string;
 }
 declare const _default: import('@nuxt/schema').NuxtModule<I18nTypesGeneratorOptions, I18nTypesGeneratorOptions, false>;
 export default _default;

package/dist/nuxt.d.ts

@@ -1,6 +1,6 @@
 export interface I18nTypesGeneratorOptions {
+    /** Translation directory relative to the project root. Defaults to `i18n.translationDir` or `'locales'`. */
     translationDir?: string;
-    outputFile?: string;
 }
 declare const _default: import('@nuxt/schema').NuxtModule<I18nTypesGeneratorOptions, I18nTypesGeneratorOptions, false>;
 export default _default;

package/dist/nuxt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"nuxt.d.ts","sourceRoot":"","sources":["../src/nuxt.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,yBAAyB;IACxC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;;AAED,wBA+CE"}
+{"version":3,"file":"nuxt.d.ts","sourceRoot":"","sources":["../src/nuxt.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,yBAAyB;IACxC,4GAA4G;IAC5G,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;;AAED,wBA2DE"}

package/dist/nuxt.mjs

@@ -1,4 +1,4 @@
-import { n as e } from "./generator-BRNo9fkZ.js";
+import { r as e } from "./generator-CWXsEVLn.js";
 import { addTypeTemplate as t, defineNuxtModule as n } from "@nuxt/kit";
 //#region src/nuxt.ts
 var r = n({
@@ -8,8 +8,8 @@ var r = n({
 	},
 	defaults: { translationDir: "locales" },
 	async setup(n, r) {
-		let i = r.options.i18n, a = n.translationDir || i?.translationDir || "locales";
-		t({
+		let i = r.options.i18n, a = n.translationDir || i?.translationDir || "locales", o = n.outputFile;
+		typeof o == "string" && o.length > 0 && console.warn("[i18n-types] `i18nTypes.outputFile` is ignored in Nuxt; generated types are written to `.nuxt/types/i18n-micro.d.ts`."), r.options.typescript.hoist ||= [], r.options.typescript.hoist.includes("@i18n-micro/types") || r.options.typescript.hoist.push("@i18n-micro/types"), t({
 			filename: "types/i18n-micro.d.ts",
 			getContents: async () => {
 				try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@i18n-micro/types-generator",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "Type generator for i18n-micro translation keys",
   "keywords": [
     "i18n",

package/dist/generator-Cqp8Bpki.cjs

@@ -1,14 +0,0 @@
-let e=require("node:fs"),t=require("node:path"),n=require("globby");function r(e,t=``){let n=[];for(let i in e){if(!Object.hasOwn(e,i))continue;let a=e[i],o=t?`${t}.${i}`:i;typeof a==`object`&&a&&!Array.isArray(a)?n.push(...r(a,o)):n.push(o)}return n}async function i(i){let a=(0,t.resolve)(i.srcDir,i.translationDir),o=await(0,n.globby)(`**/*.json`,{cwd:a,absolute:!0,ignore:[`node_modules/**`,`dist/**`,`.nuxt/**`]}),s=new Set;for(let t of o)try{let n=r(JSON.parse((0,e.readFileSync)(t,`utf-8`)));for(let e of n)s.add(e)}catch(e){console.warn(`[i18n-types] Failed to parse ${t}:`,e)}return`/* prettier-ignore */
-// @ts-nocheck
-// Generated by @i18n-micro/types-generator
-// DO NOT EDIT THIS FILE MANUALLY
-
-import '@i18n-micro/types';
-
-declare module '@i18n-micro/types' {
-  export interface DefineLocaleMessage {
-${Array.from(s).sort().map(e=>`    '${e}': string;`).join(`
-`)}
-  }
-}
-`}async function a(n){let r=await i(n),a=n.outputFile||(0,t.resolve)(n.srcDir,`i18n-micro.d.ts`),o=(0,t.dirname)(a);try{(0,e.mkdirSync)(o,{recursive:!0})}catch{}return(0,e.writeFileSync)(a,r,`utf-8`),a}Object.defineProperty(exports,"n",{enumerable:!0,get:function(){return i}}),Object.defineProperty(exports,"r",{enumerable:!0,get:function(){return r}}),Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return a}});