@breadstone-tools/localizator-core 0.0.12-beta.0

package/Services/DiffService.js

@@ -0,0 +1,86 @@
+"use strict";
+// import { createTwoFilesPatch } from 'diff';
+// interface ModifiedFile {
+//     type: 'diff' | 'file';
+//     content: string;
+// }
+// type FileModifications = Record<string, ModifiedFile>;
+// export function computeFileModifications(files:, modifiedFiles: Map<string, string>) {
+//     const modifications: FileModifications = {};
+//     let hasModifiedFiles = false;
+//     for (const [filePath, originalContent] of modifiedFiles) {
+//         const file = files[filePath];
+//         if (file?.type !== 'file') {
+//             continue;
+//         }
+//         const unifiedDiff = diffFiles(filePath, originalContent, file.content);
+//         if (!unifiedDiff) {
+//             // files are identical
+//             continue;
+//         }
+//         hasModifiedFiles = true;
+//         if (unifiedDiff.length > file.content.length) {
+//             // if there are lots of changes we simply grab the current file content since it's smaller than the diff
+//             modifications[filePath] = {
+//                 type: 'file',
+//                 content: file.content
+//             };
+//         } else {
+//             // otherwise we use the diff since it's smaller
+//             modifications[filePath] = {
+//                 type: 'diff',
+//                 content: unifiedDiff
+//             };
+//         }
+//     }
+//     if (!hasModifiedFiles) {
+//         return undefined;
+//     }
+//     return modifications;
+// }
+// /**
+//  * Computes a diff in the unified format. The only difference is that the header is omitted
+//  * because it will always assume that you're comparing two versions of the same file and
+//  * it allows us to avoid the extra characters we send back to the llm.
+//  *
+//  * @see https://www.gnu.org/software/diffutils/manual/html_node/Unified-Format.html
+//  */
+// export function diffFiles(fileName: string, oldFileContent: string, newFileContent: string) {
+//     let unifiedDiff = createTwoFilesPatch(fileName, fileName, oldFileContent, newFileContent);
+//     const patchHeaderEnd = `--- ${fileName}\n+++ ${fileName}\n`;
+//     const headerEndIndex = unifiedDiff.indexOf(patchHeaderEnd);
+//     if (headerEndIndex >= 0) {
+//         unifiedDiff = unifiedDiff.slice(headerEndIndex + patchHeaderEnd.length);
+//     }
+//     if (unifiedDiff === '') {
+//         return undefined;
+//     }
+//     return unifiedDiff;
+// }
+// /**
+//  * Converts the unified diff to HTML.
+//  *
+//  * Example:
+//  *
+//  * ```html
+//  * <bolt_file_modifications>
+//  * <diff path="/home/project/index.js">
+//  * - console.log('Hello, World!');
+//  * + console.log('Hello, Bolt!');
+//  * </diff>
+//  * </bolt_file_modifications>
+//  * ```
+//  */
+// export function fileModificationsToHTML(modifications: FileModifications) {
+//     const entries = Object.entries(modifications);
+//     if (entries.length === 0) {
+//         return undefined;
+//     }
+//     const result: Array<string> = [`<${MODIFICATIONS_TAG_NAME}>`];
+//     for (const [filePath, { type, content }] of entries) {
+//         result.push(`<${type} path=${JSON.stringify(filePath)}>`, content, `</${type}>`);
+//     }
+//     result.push(`</${MODIFICATIONS_TAG_NAME}>`);
+//     return result.join('\n');
+// }
+//# sourceMappingURL=DiffService.js.map

package/Services/DiffService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DiffService.js","sourceRoot":"","sources":["../../src/Services/DiffService.ts"],"names":[],"mappings":";AAAA,8CAA8C;AAE9C,2BAA2B;AAC3B,6BAA6B;AAC7B,uBAAuB;AACvB,IAAI;AAEJ,yDAAyD;AAEzD,yFAAyF;AACzF,mDAAmD;AAEnD,oCAAoC;AAEpC,iEAAiE;AACjE,wCAAwC;AAExC,uCAAuC;AACvC,wBAAwB;AACxB,YAAY;AAEZ,kFAAkF;AAElF,8BAA8B;AAC9B,qCAAqC;AACrC,wBAAwB;AACxB,YAAY;AAEZ,mCAAmC;AAEnC,0DAA0D;AAC1D,uHAAuH;AACvH,0CAA0C;AAC1C,gCAAgC;AAChC,wCAAwC;AACxC,iBAAiB;AACjB,mBAAmB;AACnB,8DAA8D;AAC9D,0CAA0C;AAC1C,gCAAgC;AAChC,uCAAuC;AACvC,iBAAiB;AACjB,YAAY;AACZ,QAAQ;AAER,+BAA+B;AAC/B,4BAA4B;AAC5B,QAAQ;AAER,4BAA4B;AAC5B,IAAI;AAEJ,MAAM;AACN,8FAA8F;AAC9F,2FAA2F;AAC3F,yEAAyE;AACzE,KAAK;AACL,sFAAsF;AACtF,MAAM;AACN,gGAAgG;AAChG,iGAAiG;AAEjG,mEAAmE;AACnE,kEAAkE;AAElE,iCAAiC;AACjC,mFAAmF;AACnF,QAAQ;AAER,gCAAgC;AAChC,4BAA4B;AAC5B,QAAQ;AAER,0BAA0B;AAC1B,IAAI;AAEJ,MAAM;AACN,wCAAwC;AACxC,KAAK;AACL,cAAc;AACd,KAAK;AACL,aAAa;AACb,+BAA+B;AAC/B,0CAA0C;AAC1C,qCAAqC;AACrC,oCAAoC;AACpC,aAAa;AACb,gCAAgC;AAChC,SAAS;AACT,MAAM;AACN,8EAA8E;AAC9E,qDAAqD;AAErD,kCAAkC;AAClC,4BAA4B;AAC5B,QAAQ;AAER,qEAAqE;AAErE,6DAA6D;AAC7D,4FAA4F;AAC5F,QAAQ;AAER,mDAAmD;AAEnD,gCAAgC;AAChC,IAAI"}

package/Services/KeyGenerator.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Service for generating keys from string values.
+ *
+ * @public
+ */
+export declare class KeyGenerator {
+    /**
+     * Generates a unique key based on the string value.
+     *
+     * @public
+     * @param value - The string value to generate a key for.
+     * @returns The generated key in dot notation.
+     * @example
+     * ```typescript
+     * const key = KeyGeneratorService.generate("Facts Title 🎉");
+     * console.log(key); // "facts.title"
+     * ```
+     */
+    generate(value: string): string;
+}
+//# sourceMappingURL=KeyGenerator.d.ts.map

package/Services/KeyGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyGenerator.d.ts","sourceRoot":"","sources":["../../src/Services/KeyGenerator.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,qBAAa,YAAY;IAErB;;;;;;;;;;;OAWG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAWzC"}

package/Services/KeyGenerator.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyGenerator = void 0;
+/**
+ * Service for generating keys from string values.
+ *
+ * @public
+ */
+class KeyGenerator {
+    /**
+     * Generates a unique key based on the string value.
+     *
+     * @public
+     * @param value - The string value to generate a key for.
+     * @returns The generated key in dot notation.
+     * @example
+     * ```typescript
+     * const key = KeyGeneratorService.generate("Facts Title 🎉");
+     * console.log(key); // "facts.title"
+     * ```
+     */
+    generate(value) {
+        return value
+            .toLowerCase()
+            .replace(/[\p{Emoji_Presentation}\p{Emoji}\u200D]+/gu, '') // Remove emojis
+            .replace(/\s+/g, '.') // Replace spaces with dots
+            .replace(/[^\w.]/g, '') // Remove non-alphanumeric characters except dots
+            .replace(/\.+/g, '.') // Collapse multiple dots into one
+            .replace(/^\./, '') // Remove leading dot if any
+            .replace(/\.$/, ''); // Remove trailing dot if any
+    }
+}
+exports.KeyGenerator = KeyGenerator;
+//# sourceMappingURL=KeyGenerator.js.map

package/Services/KeyGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyGenerator.js","sourceRoot":"","sources":["../../src/Services/KeyGenerator.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACH,MAAa,YAAY;IAErB;;;;;;;;;;;OAWG;IACI,QAAQ,CAAC,KAAa;QACzB,OAAO,KAAK;aACP,WAAW,EAAE;aACb,OAAO,CAAC,4CAA4C,EAAE,EAAE,CAAC,CAAC,gBAAgB;aAC1E,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,2BAA2B;aAChD,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,iDAAiD;aACxE,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,kCAAkC;aACvD,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,4BAA4B;aAC/C,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,6BAA6B;IAC1D,CAAC;CAEJ;AAzBD,oCAyBC"}

package/Services/LocalizationProcessor.d.ts

@@ -0,0 +1,83 @@
+import type { IFrameworkPreset } from '../Presets/Interfaces/IFrameworkPreset.js';
+import { type IFileSystem } from '@breadstone-infrastructure/utilities';
+import { EventEmitter } from 'events';
+import type { IDetectOptions, IDetectorResult } from '../Detectors/Interfaces/IDetector.js';
+import type { IFormatter } from '../Formatters/Interfaces/IFormatter.js';
+/**
+ * Result of a localization processor extraction.
+ *
+ * @public
+ */
+export interface ILocalizationProcessorResult {
+    /**
+     * The file path of the processed file.
+     */
+    filePath: string;
+    /**
+     * The extraction result
+     */
+    extraction: {
+        content: string;
+        changes: Record<string, string>;
+    };
+    /**
+     * The parsing results.
+     */
+    parsings: Array<IDetectorResult>;
+}
+/**
+ * Event map for the `LocalizationProcessor`.
+ *
+ * @public
+ */
+export interface ILocalizationProcessorEventMap {
+    /**
+     * The detected event.
+     */
+    detected: [change: IDetectorResult];
+    /**
+     * The failed event.
+     */
+    failed: [error: any];
+}
+/**
+ * The `IProcessOptions` interface.
+ *
+ * @public
+ */
+export interface IProcessOptions extends IDetectOptions {
+}
+/**
+ * The `LocalizationProcessor` class.
+ *
+ * @public
+ */
+export declare class LocalizationProcessor extends EventEmitter<ILocalizationProcessorEventMap> {
+    private readonly _fileSystem;
+    private readonly _formatter;
+    /**
+     * Constructs a new instance of the `LocalizationProcessor` class.
+     *
+     * @public
+     */
+    constructor(formatter: IFormatter, fileSystem: IFileSystem);
+    /**
+     * Processes the localization of a directory.
+     *
+     * @public
+     * @param rootDir - The root directory to process.
+     * @param preset - The preset to use for processing.
+     * @param options - The optional processing options.
+     * @returns The results of the localization process.
+     */
+    process(rootDir: string, preset: IFrameworkPreset, options?: IProcessOptions): Array<ILocalizationProcessorResult>;
+    /**
+     * Extracts strings from a value.
+     *
+     * @public
+     * @param values - The values to extract.
+     * @returns The extraction result.
+     */
+    private format;
+}
+//# sourceMappingURL=LocalizationProcessor.d.ts.map

package/Services/LocalizationProcessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalizationProcessor.d.ts","sourceRoot":"","sources":["../../src/Services/LocalizationProcessor.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAClF,OAAO,EAAE,KAAK,WAAW,EAAQ,MAAM,sCAAsC,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,KAAK,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,sCAAsC,CAAC;AAC5F,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,wCAAwC,CAAC;AAKzE;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAIzC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE;QACR,OAAO,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACnC,CAAC;IAEF;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAGpC;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAI3C;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAEpC;;OAEG;IACH,MAAM,EAAE,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;CAIxB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAgB,SAAQ,cAAc;CACtD;AAED;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,YAAY,CAAC,8BAA8B,CAAC;IAInF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAc;IAC1C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IAMxC;;;;OAIG;gBACgB,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW;IAWjE;;;;;;;;OAQG;IACI,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,KAAK,CAAC,4BAA4B,CAAC;IAyCzH;;;;;;OAMG;IACH,OAAO,CAAC,MAAM;CAgBjB"}

package/Services/LocalizationProcessor.js

@@ -0,0 +1,90 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalizationProcessor = void 0;
+const utilities_1 = require("@breadstone-infrastructure/utilities");
+const events_1 = require("events");
+const KeyGenerator_js_1 = require("./KeyGenerator.js");
+/**
+ * The `LocalizationProcessor` class.
+ *
+ * @public
+ */
+class LocalizationProcessor extends events_1.EventEmitter {
+    // #region Fields
+    _fileSystem;
+    _formatter;
+    // #endregion
+    // #region Ctor
+    /**
+     * Constructs a new instance of the `LocalizationProcessor` class.
+     *
+     * @public
+     */
+    constructor(formatter, fileSystem) {
+        super({ captureRejections: true });
+        this._formatter = formatter;
+        this._fileSystem = fileSystem;
+    }
+    // #endregion
+    // #region Methods
+    /**
+     * Processes the localization of a directory.
+     *
+     * @public
+     * @param rootDir - The root directory to process.
+     * @param preset - The preset to use for processing.
+     * @param options - The optional processing options.
+     * @returns The results of the localization process.
+     */
+    process(rootDir, preset, options) {
+        if (!rootDir.length) {
+            return [];
+        }
+        if (!this._fileSystem.exists(rootDir)) {
+            throw new Error('The specified directory does not exist.');
+        }
+        Object.entries(preset.getParsers()).forEach(([_, x]) => {
+            x.on('detected', (args) => {
+                this.emit('detected', args);
+            });
+            x.on('failed', (args) => {
+                this.emit('failed', args);
+            });
+        });
+        const extensions = preset.getExtensions().map((x) => utilities_1.Path.combine(rootDir, `**/*${x}`));
+        const results = new Array();
+        this._fileSystem.glob(extensions).forEach((file) => {
+            const ext = utilities_1.Path.getExtension(file, true);
+            const content = this._fileSystem.readAllText(file);
+            const parser = preset.getParser(ext);
+            const parsings = parser.detect(content, options);
+            const extraction = this.format(parsings);
+            // if (Object.keys(extraction.changes).length > 0) {
+            results.push({
+                filePath: file,
+                parsings: parsings,
+                extraction: extraction
+            });
+            // }
+        });
+        return results;
+    }
+    /**
+     * Extracts strings from a value.
+     *
+     * @public
+     * @param values - The values to extract.
+     * @returns The extraction result.
+     */
+    format(values) {
+        const keyValueMap = {};
+        values.forEach((x) => {
+            const key = x.isStatic ? new KeyGenerator_js_1.KeyGenerator().generate(x.match.value ?? '') : x.match.value ?? '';
+            keyValueMap[key] = x.match.value ?? '';
+        });
+        return this._formatter.format(keyValueMap);
+    }
+}
+exports.LocalizationProcessor = LocalizationProcessor;
+//# sourceMappingURL=LocalizationProcessor.js.map

package/Services/LocalizationProcessor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LocalizationProcessor.js","sourceRoot":"","sources":["../../src/Services/LocalizationProcessor.ts"],"names":[],"mappings":";AAAA,kBAAkB;;;AAGlB,oEAA8E;AAC9E,mCAAsC;AAGtC,uDAAiD;AAiEjD;;;;GAIG;AACH,MAAa,qBAAsB,SAAQ,qBAA4C;IAEnF,iBAAiB;IAEA,WAAW,CAAc;IACzB,UAAU,CAAa;IAExC,aAAa;IAEb,eAAe;IAEf;;;;OAIG;IACH,YAAmB,SAAqB,EAAE,UAAuB;QAC7D,KAAK,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAAC,CAAC;QAEnC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAClC,CAAC;IAED,aAAa;IAEb,kBAAkB;IAElB;;;;;;;;OAQG;IACI,OAAO,CAAC,OAAe,EAAE,MAAwB,EAAE,OAAyB;QAC/E,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAClB,OAAO,EAAE,CAAC;QACd,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;YACnD,CAAC,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE;gBACtB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;YAEH,CAAC,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,EAAE;gBACpB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAI,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACxF,MAAM,OAAO,GAAG,IAAI,KAAK,EAAgC,CAAC;QAE1D,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/C,MAAM,GAAG,GAAG,gBAAI,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACrC,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACjD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAEzC,oDAAoD;YACpD,OAAO,CAAC,IAAI,CAAC;gBACT,QAAQ,EAAE,IAAI;gBACd,QAAQ,EAAE,QAAQ;gBAClB,UAAU,EAAE,UAAU;aACzB,CAAC,CAAC;YACH,IAAI;QACR,CAAC,CAAC,CAAC;QAEH,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACK,MAAM,CAAC,MAA8B;QAIzC,MAAM,WAAW,GAA2B,EAAE,CAAC;QAE/C,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACjB,MAAM,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,8BAAY,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;YAChG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC;CAIJ;AApGD,sDAoGC"}

package/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "@breadstone-tools/localizator-core",
+    "description": "Localizator core library",
+    "version": "0.0.12-beta.0",
+    "license": "MIT",
+    "author": "andre.wehlert <awehlert@breadstone.de> (https://www.breadstone.de)",
+    "repository": {
+        "url": "git+ssh://git@github.com/RueDeRennes/mosaik.git"
+    },
+    "type": "commonjs",
+    "main": "./Index.js",
+    "commonjs": "./Index.js",
+    "module": "./Index.js",
+    "types": "./Index.d.ts",
+    "dependencies": {
+        "@breadstone-infrastructure/utilities": "^0.0.12-beta.0",
+        "cheerio": "^1.0.0"
+    }
+}