@intlayer/engine 9.5.12 → 9.7.0

package/dist/types/utils/chunkJSON.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chunkJSON.d.ts","names":[],"sources":["../../../src/utils/chunkJSON.ts"],"mappings":";;;;;;;;KAUK;KACA,YAAY,gBAAgB,aAAa;YAElC;GACT,YAAY;;KAGV,YAAY;KAEZ,OAAO;KAEP;EAAa;EAAW,MAAM;EAAM,OAAO;;KAC3C;EACH;EACA,MAAM;EACN;EACA;EACA;;KAEG,QAAQ,WAAW;KAEnB;YAEO;EACV;EACA;EACA;EACA,UAAU;EACV;EACA,SAAS;;;;;qBA+ME,YAAS,OACb,aAAa,WAAS,qBAE5B;;;;;;;;;;;qBAsHU,6BAA0B,OAC9B,cACN,aAAa;qBAiGH,eAAY,QAAY,gBAAc,aAAa"}
+{"version":3,"file":"chunkJSON.d.ts","names":[],"sources":["../../../src/utils/chunkJSON.ts"],"mappings":";;;;;;;;KAUK;KACA,YAAY,gBAAgB,aAAa;YAElC;GACT,YAAY;;KAGV,YAAY;KAEZ,OAAO;KAEP;EAAa;EAAW,MAAM;EAAM,OAAO;;KAC3C;EACH;EACA,MAAM;EACN;EACA;EACA;;KAEG,QAAQ,WAAW;KAEnB;YAEO;EACV;EACA;EACA;EACA,UAAU;EACV;EACA,SAAS;;;;;qBAgNE,YAAS,OACb,aAAa,WAAS,qBAE5B;;;;;;;;;;;qBAsHU,6BAA0B,OAC9B,cACN,aAAa;qBAiGH,eAAY,QAAY,gBAAc,aAAa"}

package/dist/types/utils/index.d.ts

@@ -8,6 +8,7 @@ import { formatLocale, formatPath } from "./formatter.js";
 import { getChunk } from "./getChunk.js";
 import { getContentExtension } from "./getContentExtension.js";
 import { getPathHash } from "./getPathHash.js";
+import { isDirectoryExcluded } from "./isDirectoryExcluded.js";
 import { mergeChunks } from "./mergeChunks.js";
 import { parallelize } from "./parallelize.js";
 import { Queue, pLimit } from "./pLimit.js";
@@ -23,4 +24,4 @@ import { splitTextByLines } from "./splitTextByLine.js";
 import { StartContentWatcherOptions, startContentWatcher } from "./startContentWatcher.js";
 import { verifyIdenticObjectFormat } from "./verifyIdenticObjectFormat.js";
 import { withFileLock } from "./withFileLock.js";
-export { CLI_CONTENT_WATCHER_ENV_VAR, ContentDeclarationFileName, ContentWatcherOwner, ContentWatcherSource, Extension, Format, JSONObject, JsonChunk, ParallelHandle, Primitive, Queue, Recursive, RunOnceContext, StartContentWatcherOptions, acquireContentWatcherLock, assembleJSON, autoDecorateContent, buildComponentFilesList, chunkArray, chunkJSON, claimCliContentWatcher, excludeObjectFormat, formatLocale, formatPath, getChunk, getCliContentWatcherLabel, getContentExtension, getContentWatcherLockFilePath, getContentWatcherOwner, getExtensionFromFormat, getFormatFromExtension, getGlobalLimiter, getPathHash, getTaskLimiter, mergeChunks, pLimit, parallelize, parallelizeGlobal, parseContentDeclarationFileName, reconstructFromSingleChunk, reduceObjectFormat, reportRedundantContentWatcher, resolveObjectPromises, resolveRelativePath, runOnce, runParallel, sortAlphabetically, splitTextByLines, startContentWatcher, verifyIdenticObjectFormat, withFileLock };
+export { CLI_CONTENT_WATCHER_ENV_VAR, ContentDeclarationFileName, ContentWatcherOwner, ContentWatcherSource, Extension, Format, JSONObject, JsonChunk, ParallelHandle, Primitive, Queue, Recursive, RunOnceContext, StartContentWatcherOptions, acquireContentWatcherLock, assembleJSON, autoDecorateContent, buildComponentFilesList, chunkArray, chunkJSON, claimCliContentWatcher, excludeObjectFormat, formatLocale, formatPath, getChunk, getCliContentWatcherLabel, getContentExtension, getContentWatcherLockFilePath, getContentWatcherOwner, getExtensionFromFormat, getFormatFromExtension, getGlobalLimiter, getPathHash, getTaskLimiter, isDirectoryExcluded, mergeChunks, pLimit, parallelize, parallelizeGlobal, parseContentDeclarationFileName, reconstructFromSingleChunk, reduceObjectFormat, reportRedundantContentWatcher, resolveObjectPromises, resolveRelativePath, runOnce, runParallel, sortAlphabetically, splitTextByLines, startContentWatcher, verifyIdenticObjectFormat, withFileLock };

package/dist/types/utils/isDirectoryExcluded.d.ts

@@ -0,0 +1,15 @@
+//#region src/utils/isDirectoryExcluded.d.ts
+/**
+ * Whether a directory path lies inside a directory matched by one of the
+ * exclude patterns (e.g. `packages/ds/dist/esm` against `**\/dist/**`).
+ *
+ * Used to keep explicitly configured directories (`codeDir`, `contentDir`)
+ * from being dropped by an exclusion that only matches their ancestors.
+ *
+ * @example
+ * isDirectoryExcluded('ds/dist/esm', ['**\/dist/**']); // true
+ * isDirectoryExcluded('src/distance', ['**\/dist/**']); // false
+ */
+export declare const isDirectoryExcluded: (directoryPath: string, excludePatterns: string[]) => boolean;
+//#endregion
+//# sourceMappingURL=isDirectoryExcluded.d.ts.map

package/dist/types/utils/isDirectoryExcluded.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isDirectoryExcluded.d.ts","names":[],"sources":["../../../src/utils/isDirectoryExcluded.ts"],"mappings":";;;;;;;;;;;;qBAgCa,sBAAmB,uBACT"}

package/dist/types/watcher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"watcher.d.ts","names":[],"sources":["../../src/watcher.ts"],"mappings":";;;KA0DK;EACH,gBAAgB;EAChB,gBAAgB;EAChB;EACA;;qBAsBW,QAAK,UAAoB,iBAAY;EAkDZ,mBAAM;;qBAgR/B,wBAAqB,UAAoB,iBAAY"}
+{"version":3,"file":"watcher.d.ts","names":[],"sources":["../../src/watcher.ts"],"mappings":";;;KA2DK;EACH,gBAAgB;EAChB,gBAAgB;EAChB;EACA;;qBAsBW,QAAK,UAAoB,iBAAY;EAkDZ,mBAAM;;qBA6R/B,wBAAqB,UAAoB,iBAAY"}

package/dist/types/writeConfiguration/index.d.ts

@@ -2,5 +2,18 @@ import { IntlayerConfig } from "@intlayer/types/config";
 //#region src/writeConfiguration/index.d.ts
 export declare const isCachedConfigurationUpToDate: (configuration: IntlayerConfig) => Promise<boolean | null>;
 export declare const writeConfiguration: (configuration: IntlayerConfig) => Promise<void>;
+/** Editor settings the built configuration can be overridden with. */
+export type BuiltEditorOverride = Partial<Pick<IntlayerConfig['editor'], 'enabled' | 'editorURL'>>;
+/**
+ * Writes the built configuration (`.intlayer/config`) with editor settings
+ * overridden, leaving the user configuration file untouched. Lets the visual
+ * editor connect to the application when the configuration disables it, or
+ * points at another URL. The next configuration build restores the
+ * configured values.
+ *
+ * @returns The overridden keys that differ from the configuration; nothing is
+ * written when empty.
+ */
+export declare const overrideBuiltEditorConfiguration: (configuration: IntlayerConfig, editorOverride: BuiltEditorOverride) => Promise<(keyof BuiltEditorOverride)[]>;
 //#endregion
 //# sourceMappingURL=index.d.ts.map

package/dist/types/writeConfiguration/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/writeConfiguration/index.ts"],"mappings":";;qBAMa,gCAA6B,eACzB,mBACd;qBAWU,qBAAkB,eAAyB,mBAAc"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/writeConfiguration/index.ts"],"mappings":";;qBAMa,gCAA6B,eACzB,mBACd;qBAWU,qBAAkB,eAAyB,mBAAc;;YAkB1D,sBAAsB,QAChC,KAAK;;;;;;;;;;;qBAaM,mCAAgC,eAC5B,gBAAc,gBACb,wBACf,eAAe"}

package/dist/types/writeContentDeclaration/index.d.ts

@@ -1,6 +1,7 @@
 import { detectExportedComponentName } from "./detectExportedComponentName.js";
 import { DictionaryStatus } from "./dictionaryStatus.js";
+import { RenderContentDeclarationOptions, RenderedContentDeclaration, formatContentDeclaration, isRenderableContentDeclarationPath, renderContentDeclaration, renderMarkdownContentDeclaration, renderYamlContentDeclaration } from "./renderContentDeclaration.js";
 import { transformJSFile } from "./transformJSFile.js";
 import { writeContentDeclaration } from "./writeContentDeclaration.js";
 import { writeJSFile } from "./writeJSFile.js";
-export { DictionaryStatus, detectExportedComponentName, transformJSFile, writeContentDeclaration, writeJSFile };
+export { DictionaryStatus, RenderContentDeclarationOptions, RenderedContentDeclaration, detectExportedComponentName, formatContentDeclaration, isRenderableContentDeclarationPath, renderContentDeclaration, renderMarkdownContentDeclaration, renderYamlContentDeclaration, transformJSFile, writeContentDeclaration, writeJSFile };

package/dist/types/writeContentDeclaration/processContentDeclarationContent.d.ts

@@ -1,12 +1,18 @@
 import { Dictionary } from "@intlayer/types/dictionary";
 //#region src/writeContentDeclaration/processContentDeclarationContent.d.ts
+/**
+ * Receives the content of a `file()` node instead of writing it to disk.
+ * `filePath` is relative to the project base directory.
+ */
+export type ExternalFileHandler = (filePath: string, content: string) => void;
 /**
  * Process content declaration content
  *
  * It filter node that are autogenerated by intlayer to do not rewrite them in the content declaration file.
  *
- * And write external sources as file content if necessary.
+ * And write external sources as file content if necessary. Pass
+ * `onExternalFile` to collect them instead of writing them to disk.
  */
-export declare const processContentDeclarationContent: (dictionary: Dictionary) => Promise<any>;
+export declare const processContentDeclarationContent: (dictionary: Dictionary, onExternalFile?: ExternalFileHandler) => Promise<any>;
 //#endregion
 //# sourceMappingURL=processContentDeclarationContent.d.ts.map

package/dist/types/writeContentDeclaration/processContentDeclarationContent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"processContentDeclarationContent.d.ts","names":[],"sources":["../../../src/writeContentDeclaration/processContentDeclarationContent.ts"],"mappings":";;;;;;;;;qBAiIa,mCAAgC,YAC/B,eAAU"}
+{"version":3,"file":"processContentDeclarationContent.d.ts","names":[],"sources":["../../../src/writeContentDeclaration/processContentDeclarationContent.ts"],"mappings":";;;;;;YAqBY,uBAAuB,kBAAkB;;;;;;;;;qBA4HxC,mCAAgC,YAC/B,YAAU,iBACN,wBAAmB"}

package/dist/types/writeContentDeclaration/renderContentDeclaration.d.ts

@@ -0,0 +1,61 @@
+import { ExternalFileHandler } from "./processContentDeclarationContent.js";
+import { IntlayerConfig } from "@intlayer/types/config";
+import { Dictionary } from "@intlayer/types/dictionary";
+import { LocalesValues } from "@intlayer/types/module_augmentation";
+//#region src/writeContentDeclaration/renderContentDeclaration.d.ts
+/**
+ * Whether a content declaration file can be rewritten from a dictionary.
+ * Other extensions (e.g. `.po`) are owned by plugins.
+ */
+export declare const isRenderableContentDeclarationPath: (filePath: string) => boolean;
+type FormatContentDeclarationOptions = {
+  /** Plugins `formatOutput` hooks are applied when provided. */
+  configuration?: IntlayerConfig;
+  localeList?: LocalesValues[];
+  /** Collects `file()` node contents instead of writing them to disk. */
+  onExternalFile?: ExternalFileHandler;
+};
+/**
+ * Cleans a dictionary before persisting it: strips auto-generated node
+ * metadata, filters locales, and applies the plugins `formatOutput` hooks.
+ */
+export declare const formatContentDeclaration: (dictionary: Dictionary, options?: FormatContentDeclarationOptions) => Promise<Dictionary>;
+/**
+ * Renders a `.content.md` file. When the current file is provided, its
+ * frontmatter fields are kept and only overridden by the dictionary ones; the
+ * original frontmatter text is reused verbatim when nothing changed.
+ */
+export declare const renderMarkdownContentDeclaration: (dictionary: Dictionary, existingFileContent?: string) => string;
+/**
+ * Renders a `.content.yaml` file. When the current file is provided, its
+ * fields are kept and only overridden by the dictionary ones; the original
+ * text is returned untouched when nothing changed.
+ */
+export declare const renderYamlContentDeclaration: (dictionary: Dictionary, existingFileContent?: string) => string;
+export type RenderContentDeclarationOptions = {
+  /** Path of the content declaration file, used to pick its format. */
+  filePath: string;
+  /** Current source of the file. */
+  fileContent: string;
+  /** Applies the plugins `formatOutput` hooks when provided. */
+  configuration?: IntlayerConfig;
+  localeList?: LocalesValues[];
+  /** Forces the `noMetadata` mode; detected from the source when omitted. */
+  noMetadata?: boolean;
+};
+export type RenderedContentDeclaration = {
+  /** New source of the content declaration file. */
+  fileContent: string;
+  /** Content of the `file()` nodes, keyed by path relative to the base dir. */
+  externalFiles: Record<string, string>;
+};
+/**
+ * Renders the new source of an existing content declaration file from a
+ * dictionary, without touching the file system. JS/TS and JSON sources are
+ * updated through their AST so untouched code keeps its formatting.
+ *
+ * Returns `undefined` for formats owned by plugins (e.g. `.po`).
+ */
+export declare const renderContentDeclaration: (dictionary: Dictionary, options: RenderContentDeclarationOptions) => Promise<RenderedContentDeclaration | undefined>;
+//#endregion
+//# sourceMappingURL=renderContentDeclaration.d.ts.map

package/dist/types/writeContentDeclaration/renderContentDeclaration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderContentDeclaration.d.ts","names":[],"sources":["../../../src/writeContentDeclaration/renderContentDeclaration.ts"],"mappings":";;;;;;;;;qBA+Ea,qCAAkC;KAa1C;;EAEH,gBAAgB;EAChB,aAAa;;EAEb,iBAAiB;;;;;;qBAON,2BAAwB,YACvB,YAAU,UACb,oCACR,QAAQ;;;;;;qBA2HE,mCAAgC,YAC/B,YAAU;;;;;;qBA2CX,+BAA4B,YAC3B,YAAU;YA4CZ;;EAEV;;EAEA;;EAEA,gBAAgB;EAChB,aAAa;;EAEb;;YAGU;;EAEV;;EAEA,eAAe;;;;;;;;;qBAUJ,2BAAwB,YACvB,YAAU,SACb,oCACR,QAAQ"}

package/dist/types/writeContentDeclaration/writeContentDeclaration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writeContentDeclaration.d.ts","names":[],"sources":["../../../src/writeContentDeclaration/writeContentDeclaration.ts"],"mappings":";;;;;;KA+HK;EACH;EACA,aAAa;EACb,iBAAiB;;qBAON,0BAAuB,YACtB,YAAU,eACP,gBAAc,UACnB,mCACT;EAAU,QAAQ;EAAkB"}
+{"version":3,"file":"writeContentDeclaration.d.ts","names":[],"sources":["../../../src/writeContentDeclaration/writeContentDeclaration.ts"],"mappings":";;;;;;KAmBK;EACH;EACA,aAAa;EACb,iBAAiB;;qBAON,0BAAuB,YACtB,YAAU,eACP,gBAAc,UACnB,mCACT;EAAU,QAAQ;EAAkB"}

package/dist/types/writeContentDeclaration/writeMarkdownFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writeMarkdownFile.d.ts","names":[],"sources":["../../../src/writeContentDeclaration/writeMarkdownFile.ts"],"mappings":";;;qBA+Da,oBAAiB,0BACJ,YACZ,YAAU,eACP,mBACd"}
+{"version":3,"file":"writeMarkdownFile.d.ts","names":[],"sources":["../../../src/writeContentDeclaration/writeMarkdownFile.ts"],"mappings":";;;qBAQa,oBAAiB,0BACJ,YACZ,YAAU,eACP,mBACd"}

package/dist/types/writeContentDeclaration/writeYamlFile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"writeYamlFile.d.ts","names":[],"sources":["../../../src/writeContentDeclaration/writeYamlFile.ts"],"mappings":";;;qBAWa,gBAAa,0BACA,YACZ,YAAU,eACP,mBACd"}
+{"version":3,"file":"writeYamlFile.d.ts","names":[],"sources":["../../../src/writeContentDeclaration/writeYamlFile.ts"],"mappings":";;;qBAQa,gBAAa,0BACA,YACZ,YAAU,eACP,mBACd"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intlayer/engine",
-  "version": "9.5.12",
+  "version": "9.7.0",
   "private": false,
   "description": "Scans and builds Intlayer declaration files into dictionaries based on Intlayer configuration.",
   "keywords": [
@@ -85,6 +85,11 @@
       "require": "./dist/cjs/docReview/index.cjs",
       "import": "./dist/esm/docReview/index.mjs"
     },
+    "./contentDeclaration": {
+      "types": "./dist/types/writeContentDeclaration/renderContentDeclaration.d.ts",
+      "require": "./dist/cjs/writeContentDeclaration/renderContentDeclaration.cjs",
+      "import": "./dist/esm/writeContentDeclaration/renderContentDeclaration.mjs"
+    },
     "./package.json": "./package.json"
   },
   "main": "dist/cjs/index.cjs",
@@ -122,6 +127,9 @@
       "docReview": [
         "./dist/types/docReview/index.d.ts"
       ],
+      "contentDeclaration": [
+        "./dist/types/writeContentDeclaration/renderContentDeclaration.d.ts"
+      ],
       "package.json": [
         "./package.json"
       ]
@@ -150,31 +158,31 @@
     "typecheck": "tsc --noEmit --project tsconfig.types.json"
   },
   "dependencies": {
-    "@intlayer/api": "9.5.12",
-    "@intlayer/config": "9.5.12",
-    "@intlayer/core": "9.5.12",
-    "@intlayer/dictionaries-entry": "9.5.12",
-    "@intlayer/types": "9.5.12",
+    "@intlayer/api": "9.7.0",
+    "@intlayer/config": "9.6.0",
+    "@intlayer/core": "9.7.0",
+    "@intlayer/dictionaries-entry": "9.6.0",
+    "@intlayer/types": "9.7.0",
     "@parcel/watcher": "2.6.0",
     "defu": "6.1.7",
     "fast-glob": "3.3.3",
     "recast": "0.24.0",
-    "simple-git": "3.36.0",
+    "simple-git": "4.0.2",
     "zod-to-ts": "2.1.0"
   },
   "devDependencies": {
-    "@types/node": "^22",
+    "@types/node": "^26",
     "@utils/ts-config": "1.0.4",
     "@utils/ts-config-types": "1.0.4",
     "@utils/tsdown-config": "1.0.4",
     "rimraf": "6.1.3",
     "tsdown": "0.23.0",
     "typescript": "7.0.2",
-    "vitest": "5.0.2",
+    "vitest": "5.0.3",
     "zod": "4.6.5"
   },
   "peerDependencies": {
-    "@intlayer/babel": "9.5.12"
+    "@intlayer/babel": "9.6.0"
   },
   "peerDependenciesMeta": {
     "@intlayer/babel": {