@breadstone-infrastructure/utilities 0.0.12-beta.0

package/IO/Path.js

@@ -0,0 +1,283 @@
+"use strict";
+/* eslint-disable no-control-regex */
+// #region Imports
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Path = void 0;
+const crypto = __importStar(require("crypto"));
+const p = __importStar(require("path"));
+const Glob_1 = require("./Glob");
+// #endregion
+class Path {
+    // #region Properties
+    /**
+     * Gets the path separator
+     * @public
+     * @static
+     * @returns {string}
+     */
+    static get separator() {
+        return p.sep;
+    }
+    // #endregion
+    // #region Methods
+    /**
+     * Changes the extension of a file path. The path parameter specifies a file path, and the extension parameter specifies a file extension (with a leading period, such as ".json" or ".js").
+     * @public
+     * @static
+     * @param {string} path The path
+     * @param {string} extension The extenison
+     * @returns {string} The function returns a file path with the same root, directory, and base name parts as path, but with the file extension changed to the specified extension. If path is null, the function returns null. If path does not contain a file extension, the new file extension is appended to the path. If extension is null, any exsiting extension is removed from path.
+     */
+    static changeExtension(path, extension) {
+        if (path) {
+            let s = path;
+            for (let i = path.length; (i -= 1) >= 0;) {
+                const ch = path[i];
+                if (ch === '.') {
+                    s = path.substring(0, i);
+                    break;
+                }
+                if (ch === '\\' || ch === '/' || ch === ':') {
+                    break;
+                }
+            }
+            if (extension && path.length !== 0) {
+                if (extension.length === 0 || !extension.startsWith('.')) {
+                    s = `${s}.`;
+                }
+                s += extension;
+            }
+            return s;
+        }
+        return '';
+    }
+    /**
+     * Get the directory name of the given path.
+     * @public
+     * @static
+     * @param {string} path The path
+     * @returns {string} This method effectively removes the last element of the given file path, i.e. it returns a string consisting of all characters up to but not including the last backslash ("\") in the file path. The returned value is null if the file path is null or if the file path denotes a root (such as "\", "C:", or "\\server\share").
+     */
+    static getDirectoryName(path) {
+        return p.dirname(path);
+    }
+    /**
+     * Get a string array of the given path.
+     * @public
+     * @static
+     * @param {string} path The path
+     * @returns {Array<string>}
+     */
+    static getDirectorySegments(path) {
+        return p.dirname(p.normalize(path)).split(Path.separator);
+    }
+    /**
+     * @public
+     * @static
+     * @param {string} path The path
+     * @returns {string} The name and extension parts of the given path. The resulting string contains the characters of path that follow the last backslash ("\"), slash ("/"), or colon (":") character in  path. The resulting string is the entire path if path  contains no backslash after removing trailing slashes, slash, or colon characters. The resulting  string is null if path is null.
+     */
+    static getFileName(path) {
+        return p.basename(path);
+    }
+    /**
+     * @public
+     * @static
+     * @param {string} path The path
+     * @returns {string} Returns the file name of the specified path string without the extension.
+     */
+    static getFileNameWithoutExtension(path) {
+        path = Path.getFileName(path);
+        if (path) {
+            const i = path.lastIndexOf('.');
+            if (i === -1) {
+                return path;
+            }
+            return path.substring(0, i);
+        }
+        return '';
+    }
+    /**
+     * @public
+     * @static
+     * @param {string} path The path
+     * @param {boolean} includeDot If true, the returned string includes the period (.) before the extension. If false or omitted, the period is not included.
+     * @returns {string} Returns the extension of the specified path string.
+     */
+    static getExtension(path, includeDot) {
+        const ext = p.extname(path);
+        return includeDot ? ext : ext.substring(1);
+    }
+    /**
+     * @public
+     * @static
+     * @param {boolean} alphanumeric If true, the generated name will only contain alphanumeric characters.
+     * @returns {string} Returns a cryptographically strong random 8.3 string that can be used as either a folder name or a file name.
+     */
+    static getRandomFileName(alphanumeric) {
+        // For generating random file names
+        // 8 random bytes provides 12 chars in our encoding for the 8.3 name.
+        const keyLength = 8;
+        const buffer = crypto.randomBytes(keyLength);
+        let bufferStr = buffer.toString('base64');
+        if (alphanumeric) {
+            bufferStr = bufferStr.replace(/[\W_]+/g, '');
+        }
+        else {
+            bufferStr = bufferStr.replace(/\//g, '_').replace(/\+/g, '-');
+        }
+        return bufferStr.substring(0, keyLength);
+    }
+    /**
+     * @public
+     * @static
+     * @param {Array<string>} path Array of path strings
+     * @returns {string}
+     */
+    static combine(...path) {
+        const segments = [];
+        for (const segment of path) {
+            segments.push(segment);
+        }
+        return p.join.apply(null, segments);
+    }
+    /**
+     * Normalize file path slashes to be unix-like forward slashes.
+     * @public
+     * @static
+     * @param {string} path Path string
+     * @param {boolean} stripTrailing By default trailing slashes are removed. Pass false as the last argument to disable this behavior and keep trailing slashes
+     * @returns {string}
+     */
+    static normalize(path, stripTrailing) {
+        if (typeof path !== 'string') {
+            throw new TypeError('expected path to be a string');
+        }
+        if (path === '\\' || path === '/') {
+            return '/';
+        }
+        const len = path.length;
+        if (len <= 1) {
+            return path;
+        }
+        // Ensure that win32 namespaces has two leading slashes, so that the path is
+        // Handled properly by the win32 version of path.parse() after being normalized
+        // https://msdn.microsoft.com/library/windows/desktop/aa365247(v=vs.85).aspx#namespaces
+        let prefix = '';
+        // @ts-ignore fix suppressImplicitAnyIndexErrors
+        if (len > 4 && p[3] === '\\') {
+            // @ts-ignore fix suppressImplicitAnyIndexErrors
+            const ch = p[2];
+            if ((ch === '?' || ch === '.') && path.startsWith('\\\\')) {
+                path = path.slice(2);
+                prefix = '//';
+            }
+        }
+        const segments = path.split(/[/\\]+/);
+        if (stripTrailing !== false && segments[segments.length - 1] === '') {
+            segments.pop();
+        }
+        return prefix + segments.join('/');
+    }
+    /**
+     * Converts a relative path to an absolute path based on a given base path.
+     *
+     * @public
+     * @static
+     * @param {string} paths Path string
+     * @returns {string}
+     */
+    static resolve(...paths) {
+        return p.resolve(...paths);
+    }
+    /**
+     * Determines whether path is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory.
+     * @public
+     * @static
+     * @param {string} path Path string
+     * @returns {boolean}
+     */
+    static isAbsolute(path) {
+        return p.isAbsolute(path);
+    }
+    /**
+     * Find files and directories using glob patterns.
+     *
+     * @public
+     * @static
+     * @param {string | string[]} pattern - The globbing pattern
+     * @param {object} options The globbing options.
+     * @returns {string[]} The Files
+     */
+    static glob(pattern, options) {
+        let normalizedPattern = null;
+        if (Array.isArray(pattern)) {
+            normalizedPattern = pattern.map((x) => {
+                const isExtendedLengthPath = x.startsWith('\\\\?\\');
+                const hasNonAscii = (/[^\u0000-\u0080]+/u).test(x);
+                if (!isExtendedLengthPath || !hasNonAscii) {
+                    x = x.replace(/\\/g, '/');
+                }
+                return x;
+            });
+        }
+        else {
+            const isExtendedLengthPath = pattern.startsWith('\\\\?\\');
+            const hasNonAscii = (/[^\u0000-\u0080]+/).test(pattern);
+            if (!isExtendedLengthPath || !hasNonAscii) {
+                pattern = pattern.replace(/\\/g, '/');
+            }
+            normalizedPattern = pattern;
+        }
+        return Glob_1.Glob.matchSync(normalizedPattern, options).map((x) => {
+            if (typeof x === 'string') {
+                return x;
+            }
+            return x.path;
+        });
+    }
+    /**
+     * Solve the relative path from {from} to {to} based on the current working directory.
+     * At times we have two absolute paths, and we need to derive the relative path from one to the other.
+     * This is actually the reverse transform of path.resolve.
+     *
+     * @public
+     * @static
+     * @param {string} from The from path.
+     * @param {string} to The to options.
+     * @returns {string} The relative Files
+     * @example
+     * ```typescript
+     * Path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb');
+     * // Returns: '../../impl/bbb'
+     * ```
+     */
+    static relative(from, to) {
+        return p.relative(from, to);
+    }
+}
+exports.Path = Path;
+//# sourceMappingURL=Path.js.map

package/IO/Path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Path.js","sourceRoot":"","sources":["../../src/IO/Path.ts"],"names":[],"mappings":";AAAA,qCAAqC;AACrC,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;AAElB,+CAAiC;AACjC,wCAA0B;AAC1B,iCAAiD;AAEjD,aAAa;AAEb,MAAa,IAAI;IAEb,qBAAqB;IAErB;;;;;OAKG;IACI,MAAM,KAAK,SAAS;QACvB,OAAO,CAAC,CAAC,GAAG,CAAC;IACjB,CAAC;IAED,aAAa;IAEb,kBAAkB;IAElB;;;;;;;OAOG;IACI,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,SAAiB;QACzD,IAAI,IAAI,EAAE,CAAC;YACP,IAAI,CAAC,GAAG,IAAI,CAAC;YACb,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;gBACvC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACnB,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;oBACb,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBACzB,MAAM;gBACV,CAAC;gBACD,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;oBAC1C,MAAM;gBACV,CAAC;YACL,CAAC;YACD,IAAI,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACjC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvD,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC;gBAChB,CAAC;gBACD,CAAC,IAAI,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,CAAC,CAAC;QACb,CAAC;QACD,OAAO,EAAE,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAY;QACvC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,oBAAoB,CAAC,IAAY;QAC3C,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY;QAClC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,2BAA2B,CAAC,IAAY;QAClD,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,IAAI,EAAE,CAAC;YACP,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;gBACX,OAAO,IAAI,CAAC;YAChB,CAAC;YACD,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,EAAE,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,YAAY,CAAC,IAAY,EAAE,UAAoB;QACzD,MAAM,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAAC,YAAsB;QAClD,mCAAmC;QACnC,qEAAqE;QACrE,MAAM,SAAS,GAAW,CAAC,CAAC;QAE5B,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAI,SAAS,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAE1C,IAAI,YAAY,EAAE,CAAC;YACf,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACJ,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAClE,CAAC;QAED,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CAAC,GAAG,IAAmB;QACxC,MAAM,QAAQ,GAAG,EAAE,CAAC;QAEpB,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE,CAAC;YACzB,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;QAED,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,SAAS,CAAC,IAAY,EAAE,aAAuB;QACzD,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,IAAI,SAAS,CAAC,8BAA8B,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YAChC,OAAO,GAAG,CAAC;QACf,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC;QACxB,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC;YACX,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,4EAA4E;QAC5E,+EAA+E;QAC/E,uFAAuF;QACvF,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,gDAAgD;QAChD,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;YAC3B,gDAAgD;YAChD,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YAChB,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,EAAE,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxD,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBACrB,MAAM,GAAG,IAAI,CAAC;YAClB,CAAC;QACL,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACtC,IAAI,aAAa,KAAK,KAAK,IAAI,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC;YAClE,QAAQ,CAAC,GAAG,EAAE,CAAC;QACnB,CAAC;QACD,OAAO,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,OAAO,CAAC,GAAG,KAAoB;QACzC,OAAO,CAAC,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,IAAY;QACjC,OAAO,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,IAAI,CAAC,OAA+B,EAAE,OAAsB;QACtE,IAAI,iBAAiB,GAAkC,IAAI,CAAC;QAE5D,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACzB,iBAAiB,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBAClC,MAAM,oBAAoB,GAAG,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;gBACrD,MAAM,WAAW,GAAG,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAEnD,IAAI,CAAC,oBAAoB,IAAI,CAAC,WAAW,EAAE,CAAC;oBACxC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;gBAC9B,CAAC;gBAED,OAAO,CAAC,CAAC;YACb,CAAC,CAAC,CAAC;QACP,CAAC;aAAM,CAAC;YACJ,MAAM,oBAAoB,GAAG,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;YAC3D,MAAM,WAAW,GAAG,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAExD,IAAI,CAAC,oBAAoB,IAAI,CAAC,WAAW,EAAE,CAAC;gBACxC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAC1C,CAAC;YAED,iBAAiB,GAAG,OAAO,CAAC;QAChC,CAAC;QAED,OAAO,WAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACxD,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACxB,OAAO,CAAC,CAAC;YACb,CAAC;YAED,OAAO,CAAC,CAAC,IAAI,CAAC;QAClB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAY,EAAE,EAAU;QAC3C,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;CAIJ;AA1RD,oBA0RC"}

package/IO/PcfControlManifest.d.ts

@@ -0,0 +1,79 @@
+export declare namespace PcfControlManifest {
+    interface IManifest {
+        control: IControl;
+    }
+    interface IControl {
+        namespace: string;
+        constructor: string;
+        version: string;
+        displayNameKey: string;
+        descriptionKey: string;
+        controlType: string;
+        externalServiceUsage: IExternalServiceUsage;
+        property: Array<IProperty>;
+        resources?: IResources;
+        featureUsage?: IFeatureUsage;
+    }
+    interface IExternalServiceUsage {
+        enabled: boolean;
+        domain?: Array<string>;
+    }
+    interface IProperty {
+        name: string;
+        displayNameKey: string;
+        descriptionKey: string;
+        ofType?: 'SingleLine.Text' | 'SingleLine.Email' | 'SingleLine.Phone' | 'SingleLine.TextArea' | 'SingleLine.Ticker' | 'SingleLine.URL' | 'Multiple' | 'Currency' | 'DateAndTime.DateOnly' | 'DateAndTime.DateAndTime' | 'Decimal' | 'Enum' | 'FP' | 'OptionSet' | 'TwoOptions' | 'Whole.None';
+        ofTypeGroup?: ITypeGroup;
+        usage: string;
+        required: boolean;
+    }
+    interface ITypeGroup {
+        name: string;
+        type: Array<string>;
+    }
+    interface IResources {
+        code: ICodeResource;
+        css?: Array<ICSSResource>;
+        resx?: Array<IResxResource>;
+    }
+    interface ICodeResource {
+        path: string;
+        order: number;
+    }
+    interface ICSSResource {
+        path: string;
+        order: number;
+    }
+    interface IResxResource {
+        path: string;
+        version: string;
+    }
+    interface IFeatureUsage {
+        usesFeature: Array<IUsesFeature>;
+    }
+    interface IUsesFeature {
+        name: string;
+        required: boolean;
+    }
+}
+/**
+ * The `PcfControlManifest` class.
+ *
+ * @public
+ */
+export declare class PcfControlManifest {
+    /**
+     * Reads a control manifest from a file.
+     */
+    static read(filePath: string): Promise<PcfControlManifest.IManifest>;
+    /**
+     * Writes a control manifest to a file.
+     */
+    static write(filePath: string, manifest: PcfControlManifest.IManifest, options?: {
+        prologue?: string;
+        appendix?: string;
+        newLine?: boolean;
+    }): Promise<void>;
+    static addProperty(manifest: PcfControlManifest.IManifest, property: PcfControlManifest.IProperty): PcfControlManifest.IManifest;
+}
+//# sourceMappingURL=PcfControlManifest.d.ts.map

package/IO/PcfControlManifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PcfControlManifest.d.ts","sourceRoot":"","sources":["../../src/IO/PcfControlManifest.ts"],"names":[],"mappings":"AAQA,yBAAiB,kBAAkB,CAAC;IAChC,UAAiB,SAAS;QACtB,OAAO,EAAE,QAAQ,CAAC;KACrB;IAED,UAAiB,QAAQ;QACrB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,WAAW,EAAE,MAAM,CAAC;QACpB,oBAAoB,EAAE,qBAAqB,CAAC;QAC5C,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;QAC3B,SAAS,CAAC,EAAE,UAAU,CAAC;QACvB,YAAY,CAAC,EAAE,aAAa,CAAC;KAChC;IAED,UAAiB,qBAAqB;QAClC,OAAO,EAAE,OAAO,CAAC;QACjB,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC1B;IAED,UAAiB,SAAS;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,cAAc,EAAE,MAAM,CAAC;QACvB,cAAc,EAAE,MAAM,CAAC;QACvB,MAAM,CAAC,EAAE,iBAAiB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,qBAAqB,GAAG,mBAAmB,GAAG,gBAAgB,GAAG,UAAU,GAAG,UAAU,GAAG,sBAAsB,GAAG,yBAAyB,GAAG,SAAS,GAAG,MAAM,GAAG,IAAI,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC;QAC7R,WAAW,CAAC,EAAE,UAAU,CAAC;QACzB,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,OAAO,CAAC;KACrB;IAED,UAAiB,UAAU;QACvB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACvB;IAED,UAAiB,UAAU;QACvB,IAAI,EAAE,aAAa,CAAC;QACpB,GAAG,CAAC,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;QAC1B,IAAI,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;KAC/B;IAED,UAAiB,aAAa;QAC1B,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACjB;IAED,UAAiB,YAAY;QACzB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACjB;IAED,UAAiB,aAAa;QAC1B,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACnB;IAED,UAAiB,aAAa;QAC1B,WAAW,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;KACpC;IAED,UAAiB,YAAY;QACzB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,OAAO,CAAC;KACrB;CACJ;AAED;;;;GAIG;AAEH,qBAAa,kBAAkB;IAI3B;;OAEG;WACiB,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,SAAS,CAAC;IAOjF;;OAEG;WACiB,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE;QAC1F,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;KACrB,GAAG,OAAO,CAAC,IAAI,CAAC;WAyBH,WAAW,CAAC,QAAQ,EAAE,kBAAkB,CAAC,SAAS,EAAE,QAAQ,EAAE,kBAAkB,CAAC,SAAS,GAAG,kBAAkB,CAAC,SAAS;CA2B1I"}

package/IO/PcfControlManifest.js

@@ -0,0 +1,93 @@
+"use strict";
+// #region Imports
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PcfControlManifest = void 0;
+const compat_1 = require("es-toolkit/compat");
+const xml2js = __importStar(require("xml2js"));
+const File_1 = require("./File");
+/**
+ * The `PcfControlManifest` class.
+ *
+ * @public
+ */
+class PcfControlManifest {
+    // #region Methods
+    /**
+     * Reads a control manifest from a file.
+     */
+    static async read(filePath) {
+        const xml = File_1.File.readAllText(filePath);
+        const parser = new xml2js.Parser({ explicitArray: false });
+        const result = await parser.parseStringPromise(xml);
+        return result.manifest;
+    }
+    /**
+     * Writes a control manifest to a file.
+     */
+    static async write(filePath, manifest, options) {
+        const builder = new xml2js.Builder({ headless: false });
+        let xml = builder.buildObject({ manifest });
+        if (options?.prologue) {
+            // New line
+            if (options.newLine) {
+                options.prologue += `${options.appendix}\n`;
+            }
+            xml = options.prologue + xml;
+        }
+        if (options?.appendix) {
+            // New line
+            if (options.newLine) {
+                options.appendix = `\n${options.appendix}`;
+            }
+            xml += options.appendix;
+        }
+        File_1.File.writeAllText(filePath, xml);
+    }
+    static addProperty(manifest, property) {
+        let singleProp = null;
+        if (!(0, compat_1.isArray)(manifest.control.property)) {
+            singleProp = manifest.control.property;
+        }
+        if (singleProp) {
+            manifest.control.property = [
+                singleProp,
+                property
+            ];
+        }
+        else {
+            manifest.control.property.push({
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                $: {
+                    ...property
+                }
+            });
+        }
+        return manifest;
+    }
+}
+exports.PcfControlManifest = PcfControlManifest;
+//# sourceMappingURL=PcfControlManifest.js.map

package/IO/PcfControlManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PcfControlManifest.js","sourceRoot":"","sources":["../../src/IO/PcfControlManifest.ts"],"names":[],"mappings":";AAAA,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;AAElB,8CAA4C;AAC5C,+CAAiC;AACjC,iCAA8B;AAyE9B;;;;GAIG;AAEH,MAAa,kBAAkB;IAE3B,kBAAkB;IAElB;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAgB;QACrC,MAAM,GAAG,GAAG,WAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3D,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACpD,OAAO,MAAM,CAAC,QAAwC,CAAC;IAC3D,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,QAAgB,EAAE,QAAsC,EAAE,OAInF;QACG,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QACxD,IAAI,GAAG,GAAG,OAAO,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAE5C,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC;YACpB,WAAW;YACX,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO,CAAC,QAAQ,IAAI,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC;YAChD,CAAC;YAED,GAAG,GAAG,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC;QACjC,CAAC;QAED,IAAI,OAAO,EAAE,QAAQ,EAAE,CAAC;YACpB,WAAW;YACX,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO,CAAC,QAAQ,GAAG,KAAK,OAAO,CAAC,QAAQ,EAAE,CAAC;YAC/C,CAAC;YAED,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC;QAC5B,CAAC;QAED,WAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,WAAW,CAAC,QAAsC,EAAE,QAAsC;QACpG,IAAI,UAAU,GAAwC,IAAI,CAAC;QAE3D,IAAI,CAAC,IAAA,gBAAO,EAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtC,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAwC,CAAC;QAC3E,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACb,QAAQ,CAAC,OAAO,CAAC,QAAQ,GAAG;gBACxB,UAAU;gBACV,QAAQ;aACX,CAAC;QACN,CAAC;aAAM,CAAC;YACJ,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC;gBAC3B,6DAA6D;gBAC7D,aAAa;gBACb,CAAC,EAAE;oBACC,GAAG,QAAQ;iBACd;aACJ,CAAC,CAAC;QACP,CAAC;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;CAIJ;AAzED,gDAyEC"}

package/IO/Reader/Interfaces/IFileReader.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Interface for a generic file reader.
+ *
+ * @public
+ */
+export interface IFileReader {
+    /**
+     * Disposes the reader and releases resources.
+     */
+    dispose(): void;
+    /**
+     * Reads the next character from the file.
+     *
+     * @returns A promise resolving to the character as a string, or `null` if at the end of the file.
+     */
+    read(): Promise<string | null>;
+    /**
+     * Reads a single line from the file.
+     *
+     * @returns A promise resolving to the line content as a string.
+     */
+    readLine(): Promise<string>;
+    /**
+     * Reads the entire file content.
+     *
+     * @returns A promise resolving to the file content as a string.
+     */
+    readToEnd(): Promise<string>;
+}
+//# sourceMappingURL=IFileReader.d.ts.map

package/IO/Reader/Interfaces/IFileReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileReader.d.ts","sourceRoot":"","sources":["../../../../src/IO/Reader/Interfaces/IFileReader.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAIxB;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;OAIG;IACH,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5B;;;;OAIG;IACH,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CAGhC"}

package/IO/Reader/Interfaces/IFileReader.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IFileReader.js.map

package/IO/Reader/Interfaces/IFileReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IFileReader.js","sourceRoot":"","sources":["../../../../src/IO/Reader/Interfaces/IFileReader.ts"],"names":[],"mappings":""}

package/IO/Reader/TextFileReader.d.ts

@@ -0,0 +1,53 @@
+import type { IFileReader } from './Interfaces/IFileReader';
+/**
+ * Class for reading text files with optional XML support.
+ *
+ * @public
+ */
+export declare class TextFileReader implements IFileReader {
+    private readonly _fileName;
+    private readonly _encoding;
+    private _reader;
+    private _isDisposed;
+    /**
+     * Constructs a new instance of the `TextFileReader` class.
+     *
+     * @param fileName - The file name to read.
+     * @param encoding - The file encoding.
+     */
+    constructor(fileName: string, encoding?: BufferEncoding);
+    /**
+     * Disposes the reader and releases resources.
+     */
+    dispose(): void;
+    /**
+     * Reads the next character from the file.
+     *
+     * @returns A promise resolving to the character as a string, or `null` if at the end of the file.
+     */
+    read(): Promise<string | null>;
+    /**
+     * Reads a single line from the file.
+     *
+     * @returns A promise resolving to the line content as a string.
+     */
+    readLine(): Promise<string>;
+    /**
+     * Reads the entire file content.
+     *
+     * @returns A promise resolving to the file content as a string.
+     */
+    readToEnd(): Promise<string>;
+    /**
+     * Provides a readable stream for advanced use cases.
+     */
+    private ensureReader;
+    /**
+     * Provides a fallback mechanism for encoding with replacement fallbacks.
+     *
+     * @param encoding - The desired encoding.
+     * @returns The fallback-safe encoding.
+     */
+    private getEncodingWithFallback;
+}
+//# sourceMappingURL=TextFileReader.d.ts.map

package/IO/Reader/TextFileReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TextFileReader.d.ts","sourceRoot":"","sources":["../../../src/IO/Reader/TextFileReader.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAI5D;;;;GAIG;AACH,qBAAa,cAAe,YAAW,WAAW;IAI9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAiB;IAC3C,OAAO,CAAC,OAAO,CAA8B;IAC7C,OAAO,CAAC,WAAW,CAAkB;IAMrC;;;;;OAKG;gBACgB,QAAQ,EAAE,MAAM,EAAE,QAAQ,GAAE,cAAwB;IASvE;;OAEG;IACI,OAAO,IAAI,IAAI;IAUtB;;;;OAIG;IACU,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IA0B3C;;;;OAIG;IACU,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAiBxC;;;;OAIG;IACU,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAezC;;OAEG;IACH,OAAO,CAAC,YAAY;IAgBpB;;;;;OAKG;IACH,OAAO,CAAC,uBAAuB;CASlC"}