@itwin/ecschema-locaters 3.4.0-dev.9 → 3.5.0-dev.12

package/lib/cjs/SchemaFileLocater.js

@@ -1,210 +1,213 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaFileLocater = exports.FileSchemaKey = void 0;
-const fs = require("fs");
-const glob = require("glob");
-const path = require("path");
-const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
-const formatString = (format, ...args) => {
-    return format.replace(/{(\d+)}/g, (match, theNumber) => {
-        return typeof args[theNumber] !== "undefined"
-            ? args[theNumber]
-            : match;
-    });
-};
-const padStartEx = (str, targetLength, padString) => {
-    targetLength = targetLength >> 0; // truncate if number or convert non-number to 0;
-    padString = String((typeof padString !== "undefined" ? padString : " "));
-    if (str.length > targetLength) {
-        return String(str);
-    }
-    else {
-        targetLength = targetLength - str.length;
-        if (targetLength > padString.length) {
-            padString += padString.repeat(targetLength / padString.length); // append to original to ensure we are longer than needed
-        }
-        return padString.slice(0, targetLength) + str;
-    }
-};
-/**
- * A SchemaKey implementation that aids in identifying Schema files via the
- * addition of two properties: fileName and schemaText.  The fileName contains the
- * full path to the file on disk and schemaText is the full string representation
- * of the Schema.
- * @beta
- */
-class FileSchemaKey extends ecschema_metadata_1.SchemaKey {
-    /**
-     * Initializes a new FileSchemaKey object.
-     * @param key The EC SchemaKey identifying the Schema.
-     * @param fileName The full path to the Schema file.
-     * @param schemaText The string representation of the Schema
-     * loaded from disk. Optional.
-     */
-    constructor(key, fileName, schemaJson) {
-        super(key.name, key.version);
-        this.fileName = fileName;
-        this.schemaText = schemaJson;
-    }
-}
-exports.FileSchemaKey = FileSchemaKey;
-/**
- * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater
- * @beta - Needs further testing and possibly moved to a separate package.
- */
-class SchemaFileLocater {
-    constructor() {
-        /**
-         * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the
-         * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.
-         * @param lhs The 'left-hand' FileSchemaKey.
-         * @param rhs The 'right-hand' FileSchemaKey.
-         */
-        this.compareSchemaKeyByVersion = (lhs, rhs) => {
-            return lhs.compareByVersion(rhs);
-        };
-        this.searchPaths = [];
-    }
-    async readUtf8FileToString(filePath) {
-        return new Promise((resolve, reject) => {
-            fs.readFile(filePath, "utf-8", (err, data) => {
-                if (err)
-                    reject(err);
-                else
-                    resolve(data);
-            });
-        });
-    }
-    readUtf8FileToStringSync(filePath) {
-        return fs.readFileSync(filePath, "utf-8");
-    }
-    async fileExists(filePath) {
-        return new Promise((resolve) => {
-            fs.access(filePath, fs.constants.F_OK, (err) => {
-                resolve(err ? false : true);
-            });
-        });
-    }
-    fileExistsSync(filePath) {
-        return fs.existsSync(filePath);
-    }
-    /**
-     * Adds more search paths used by this locator to find the
-     * Schema files.
-     * @param schemaPaths An array of search paths to add
-     */
-    addSchemaSearchPaths(schemaPaths) {
-        // If the path is not in the schemaPaths array, add it
-        for (const schemaPath of schemaPaths)
-            this.addSchemaSearchPath(schemaPath);
-    }
-    /**
-     * Add one search path used by this locator to find the
-     * Schema files.
-     * @param schemaPath A search path to add
-     */
-    addSchemaSearchPath(schemaPath) {
-        // If the path is not in the schemaPaths array, add it
-        if (!this.searchPaths.find((entry) => entry === schemaPath))
-            this.searchPaths.push(schemaPath);
-    }
-    /**
-     * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method
-     * only attempts to find schema files that have no version in the file name.
-     * @param foundFiles The collection of SchemaKeys found in the given directory.
-     * @param schemaPath The directory in which to search for the Schemas.
-     * @param schemaName The short name of the Schema (without version).
-     * @param desiredKey The SchemaKey used to find matching Schema files.
-     * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.
-     * @param format The type of file that the schema key refers to. json or xml
-     */
-    addCandidateNoExtSchemaKey(foundFiles, schemaPath, schemaName, desiredKey, matchType, format) {
-        const fullPath = path.join(schemaPath, `${schemaName}.ecschema.${format}`);
-        // If the file does not exist, end
-        if (!fs.existsSync(fullPath))
-            return;
-        // Read the file
-        const file = fs.readFileSync(fullPath);
-        if (!file)
-            return;
-        // Get the schema key
-        const key = this.getSchemaKey(file.toString());
-        // If the key matches, put it in foundFiles
-        if (key.matches(desiredKey, matchType))
-            foundFiles.push(new FileSchemaKey(key, fullPath, file.toString()));
-    }
-    /**
-     * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey
-     * @param foundFiles The collection of SchemaKeys found in the given directory
-     * @param schemaPath The directory in which to search for the Schemas
-     * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.
-     * @param desiredKey The schemaKey used to find matching Schema files
-     * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.
-     * @param format The type of file that the schema key refers to. json or xml
-     */
-    addCandidateSchemaKeys(foundFiles, schemaPath, fileFilter, desiredKey, matchType, format) {
-        const fullPath = path.join(schemaPath, fileFilter);
-        const result = new glob.GlobSync(fullPath, { sync: true });
-        for (const match of result.found) {
-            let fileName = path.basename(match, (`.ecschema.${format}`));
-            // TODO: should this be moved or handled elsewhere?
-            // Handles two version file names - SchemaKey.parseString supports only 3 version names.
-            if (/[^\d]\.\d?\d\.\d?\d$/.test(fileName)) {
-                const parts = fileName.split(".");
-                parts.splice(2, 0, "00");
-                fileName = parts.join(".");
-            }
-            const file = fs.readFileSync(match);
-            if (!file)
-                continue;
-            const schemaKey = ecschema_metadata_1.SchemaKey.parseString(fileName);
-            if (schemaKey.matches(desiredKey, matchType))
-                foundFiles.push(new FileSchemaKey(schemaKey, match, file.toString()));
-        }
-    }
-    /**
-     * Attempts to find all Schema files in the configurable search paths that match
-     * the desired SchemaKey.
-     * @param desiredKey The SchemaKey to match.
-     * @param matchType The SchemaMatchType.
-     * @param format The type of file that the schema key refers to. json or xml
-     */
-    findEligibleSchemaKeys(desiredKey, matchType, format) {
-        const foundFiles = new Array();
-        let twoVersionSuffix;
-        let threeVersionSuffix;
-        const readVersion = desiredKey.readVersion.toString();
-        const writeVersion = desiredKey.writeVersion.toString();
-        const minorVersion = desiredKey.minorVersion.toString();
-        if (matchType === ecschema_metadata_1.SchemaMatchType.Latest) {
-            twoVersionSuffix = (`.*.*.ecschema.${format}`);
-            threeVersionSuffix = (`.*.*.*.ecschema.${format}`);
-        }
-        else if (matchType === ecschema_metadata_1.SchemaMatchType.LatestWriteCompatible) {
-            twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"));
-            threeVersionSuffix = formatString(`.{0}.{1}.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"), padStartEx(writeVersion, 2, "0"));
-        }
-        else if (matchType === ecschema_metadata_1.SchemaMatchType.LatestReadCompatible) {
-            twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"));
-            threeVersionSuffix = formatString(`.{0}.*.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"));
-        }
-        else {
-            twoVersionSuffix = formatString(`.{0}.{1}.ecschema.${format}`, padStartEx(readVersion, 2, "0"), padStartEx(writeVersion, 2, "0"));
-            threeVersionSuffix = formatString(`.{0}.{1}.{2}.ecschema.${format}`, padStartEx(readVersion, 2, "0"), padStartEx(writeVersion, 2, "0"), padStartEx(minorVersion, 2, "0"));
-        }
-        const twoVersionExpression = desiredKey.name + twoVersionSuffix;
-        const threeVersionExpression = desiredKey.name + threeVersionSuffix;
-        for (const searchPath of this.searchPaths) {
-            this.addCandidateNoExtSchemaKey(foundFiles, searchPath, desiredKey.name, desiredKey, matchType, format);
-            this.addCandidateSchemaKeys(foundFiles, searchPath, twoVersionExpression, desiredKey, matchType, format);
-            this.addCandidateSchemaKeys(foundFiles, searchPath, threeVersionExpression, desiredKey, matchType, format);
-        }
-        return foundFiles;
-    }
-}
-exports.SchemaFileLocater = SchemaFileLocater;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaFileLocater = exports.FileSchemaKey = void 0;
+const fs = require("fs");
+const glob = require("glob");
+const path = require("path");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+/** @packageDocumentation
+ * @module Locaters
+ */
+const formatString = (format, ...args) => {
+    return format.replace(/{(\d+)}/g, (match, theNumber) => {
+        return typeof args[theNumber] !== "undefined"
+            ? args[theNumber]
+            : match;
+    });
+};
+const padStartEx = (str, targetLength, padString) => {
+    targetLength = targetLength >> 0; // truncate if number or convert non-number to 0;
+    padString = String((typeof padString !== "undefined" ? padString : " "));
+    if (str.length > targetLength) {
+        return String(str);
+    }
+    else {
+        targetLength = targetLength - str.length;
+        if (targetLength > padString.length) {
+            padString += padString.repeat(targetLength / padString.length); // append to original to ensure we are longer than needed
+        }
+        return padString.slice(0, targetLength) + str;
+    }
+};
+/**
+ * A SchemaKey implementation that aids in identifying Schema files via the
+ * addition of two properties: fileName and schemaText.  The fileName contains the
+ * full path to the file on disk and schemaText is the full string representation
+ * of the Schema.
+ * @beta
+ */
+class FileSchemaKey extends ecschema_metadata_1.SchemaKey {
+    /**
+     * Initializes a new FileSchemaKey object.
+     * @param key The EC SchemaKey identifying the Schema.
+     * @param fileName The full path to the Schema file.
+     * @param schemaText The string representation of the Schema
+     * loaded from disk. Optional.
+     */
+    constructor(key, fileName, schemaJson) {
+        super(key.name, key.version);
+        this.fileName = fileName;
+        this.schemaText = schemaJson;
+    }
+}
+exports.FileSchemaKey = FileSchemaKey;
+/**
+ * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater
+ * @beta - Needs further testing and possibly moved to a separate package.
+ */
+class SchemaFileLocater {
+    constructor() {
+        /**
+         * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the
+         * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.
+         * @param lhs The 'left-hand' FileSchemaKey.
+         * @param rhs The 'right-hand' FileSchemaKey.
+         */
+        this.compareSchemaKeyByVersion = (lhs, rhs) => {
+            return lhs.compareByVersion(rhs);
+        };
+        this.searchPaths = [];
+    }
+    async readUtf8FileToString(filePath) {
+        return new Promise((resolve, reject) => {
+            fs.readFile(filePath, "utf-8", (err, data) => {
+                if (err)
+                    reject(err);
+                else
+                    resolve(data);
+            });
+        });
+    }
+    readUtf8FileToStringSync(filePath) {
+        return fs.readFileSync(filePath, "utf-8");
+    }
+    async fileExists(filePath) {
+        return new Promise((resolve) => {
+            fs.access(filePath, fs.constants.F_OK, (err) => {
+                resolve(err ? false : true);
+            });
+        });
+    }
+    fileExistsSync(filePath) {
+        return fs.existsSync(filePath);
+    }
+    /**
+     * Adds more search paths used by this locator to find the
+     * Schema files.
+     * @param schemaPaths An array of search paths to add
+     */
+    addSchemaSearchPaths(schemaPaths) {
+        // If the path is not in the schemaPaths array, add it
+        for (const schemaPath of schemaPaths)
+            this.addSchemaSearchPath(schemaPath);
+    }
+    /**
+     * Add one search path used by this locator to find the
+     * Schema files.
+     * @param schemaPath A search path to add
+     */
+    addSchemaSearchPath(schemaPath) {
+        // If the path is not in the schemaPaths array, add it
+        if (!this.searchPaths.find((entry) => entry === schemaPath))
+            this.searchPaths.push(schemaPath);
+    }
+    /**
+     * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method
+     * only attempts to find schema files that have no version in the file name.
+     * @param foundFiles The collection of SchemaKeys found in the given directory.
+     * @param schemaPath The directory in which to search for the Schemas.
+     * @param schemaName The short name of the Schema (without version).
+     * @param desiredKey The SchemaKey used to find matching Schema files.
+     * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.
+     * @param format The type of file that the schema key refers to. json or xml
+     */
+    addCandidateNoExtSchemaKey(foundFiles, schemaPath, schemaName, desiredKey, matchType, format) {
+        const fullPath = path.join(schemaPath, `${schemaName}.ecschema.${format}`);
+        // If the file does not exist, end
+        if (!fs.existsSync(fullPath))
+            return;
+        // Read the file
+        const file = fs.readFileSync(fullPath);
+        if (!file)
+            return;
+        // Get the schema key
+        const key = this.getSchemaKey(file.toString());
+        // If the key matches, put it in foundFiles
+        if (key.matches(desiredKey, matchType))
+            foundFiles.push(new FileSchemaKey(key, fullPath, file.toString()));
+    }
+    /**
+     * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey
+     * @param foundFiles The collection of SchemaKeys found in the given directory
+     * @param schemaPath The directory in which to search for the Schemas
+     * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.
+     * @param desiredKey The schemaKey used to find matching Schema files
+     * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.
+     * @param format The type of file that the schema key refers to. json or xml
+     */
+    addCandidateSchemaKeys(foundFiles, schemaPath, fileFilter, desiredKey, matchType, format) {
+        const fullPath = path.join(schemaPath, fileFilter);
+        const result = new glob.GlobSync(fullPath, { sync: true });
+        for (const match of result.found) {
+            let fileName = path.basename(match, (`.ecschema.${format}`));
+            // TODO: should this be moved or handled elsewhere?
+            // Handles two version file names - SchemaKey.parseString supports only 3 version names.
+            if (/[^\d]\.\d?\d\.\d?\d$/.test(fileName)) {
+                const parts = fileName.split(".");
+                parts.splice(2, 0, "00");
+                fileName = parts.join(".");
+            }
+            const file = fs.readFileSync(match);
+            if (!file)
+                continue;
+            const schemaKey = ecschema_metadata_1.SchemaKey.parseString(fileName);
+            if (schemaKey.matches(desiredKey, matchType))
+                foundFiles.push(new FileSchemaKey(schemaKey, match, file.toString()));
+        }
+    }
+    /**
+     * Attempts to find all Schema files in the configurable search paths that match
+     * the desired SchemaKey.
+     * @param desiredKey The SchemaKey to match.
+     * @param matchType The SchemaMatchType.
+     * @param format The type of file that the schema key refers to. json or xml
+     */
+    findEligibleSchemaKeys(desiredKey, matchType, format) {
+        const foundFiles = new Array();
+        let twoVersionSuffix;
+        let threeVersionSuffix;
+        const readVersion = desiredKey.readVersion.toString();
+        const writeVersion = desiredKey.writeVersion.toString();
+        const minorVersion = desiredKey.minorVersion.toString();
+        if (matchType === ecschema_metadata_1.SchemaMatchType.Latest) {
+            twoVersionSuffix = (`.*.*.ecschema.${format}`);
+            threeVersionSuffix = (`.*.*.*.ecschema.${format}`);
+        }
+        else if (matchType === ecschema_metadata_1.SchemaMatchType.LatestWriteCompatible) {
+            twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"));
+            threeVersionSuffix = formatString(`.{0}.{1}.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"), padStartEx(writeVersion, 2, "0"));
+        }
+        else if (matchType === ecschema_metadata_1.SchemaMatchType.LatestReadCompatible) {
+            twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"));
+            threeVersionSuffix = formatString(`.{0}.*.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"));
+        }
+        else {
+            twoVersionSuffix = formatString(`.{0}.{1}.ecschema.${format}`, padStartEx(readVersion, 2, "0"), padStartEx(writeVersion, 2, "0"));
+            threeVersionSuffix = formatString(`.{0}.{1}.{2}.ecschema.${format}`, padStartEx(readVersion, 2, "0"), padStartEx(writeVersion, 2, "0"), padStartEx(minorVersion, 2, "0"));
+        }
+        const twoVersionExpression = desiredKey.name + twoVersionSuffix;
+        const threeVersionExpression = desiredKey.name + threeVersionSuffix;
+        for (const searchPath of this.searchPaths) {
+            this.addCandidateNoExtSchemaKey(foundFiles, searchPath, desiredKey.name, desiredKey, matchType, format);
+            this.addCandidateSchemaKeys(foundFiles, searchPath, twoVersionExpression, desiredKey, matchType, format);
+            this.addCandidateSchemaKeys(foundFiles, searchPath, threeVersionExpression, desiredKey, matchType, format);
+        }
+        return foundFiles;
+    }
+}
+exports.SchemaFileLocater = SchemaFileLocater;
 //# sourceMappingURL=SchemaFileLocater.js.map

package/lib/cjs/SchemaFileLocater.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaFileLocater.js","sourceRoot":"","sources":["../../src/SchemaFileLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,yBAAyB;AACzB,6BAA6B;AAC7B,6BAA6B;AAC7B,gEAA6F;AAE7F,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,GAAG,IAAc,EAAE,EAAE;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACrD,OAAO,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,WAAW;YAC3C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACjB,CAAC,CAAC,KAAK,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,YAAoB,EAAE,SAAiB,EAAE,EAAE;IAC1E,YAAY,GAAG,YAAY,IAAI,CAAC,CAAC,CAAC,iDAAiD;IACnF,SAAS,GAAG,MAAM,CAAC,CAAC,OAAO,SAAS,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACzE,IAAI,GAAG,CAAC,MAAM,GAAG,YAAY,EAAE;QAC7B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;KACpB;SAAM;QACL,YAAY,GAAG,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC;QACzC,IAAI,YAAY,GAAG,SAAS,CAAC,MAAM,EAAE;YACnC,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,yDAAyD;SAC1H;QACD,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,GAAG,GAAG,CAAC;KAC/C;AACH,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAa,aAAc,SAAQ,6BAAS;IAM1C;;;;;;OAMG;IACH,YAAY,GAAc,EAAE,QAAgB,EAAE,UAAmB;QAC/D,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAlBD,sCAkBC;AAED;;;GAGG;AACH,MAAsB,iBAAiB;IAGrC;QAgKA;;;;;WAKG;QACI,8BAAyB,GAAG,CAAC,GAAkB,EAAE,GAAkB,EAAU,EAAE;YACpF,OAAO,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC,CAAC;QAvKA,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QAChD,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzD,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC3C,IAAI,GAAG;oBACL,MAAM,CAAC,GAAG,CAAC,CAAC;;oBAEZ,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,wBAAwB,CAAC,QAAgB;QAC9C,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,QAAgB;QACtC,OAAO,IAAI,OAAO,CAAsB,CAAC,OAAO,EAAE,EAAE;YAClD,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC7C,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,cAAc,CAAC,QAAgB;QACpC,OAAO,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,WAAqB;QAC/C,sDAAsD;QACtD,KAAK,MAAM,UAAU,IAAI,WAAW;YAClC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,UAAkB;QAC3C,sDAAsD;QACtD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC;YACzD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;;;OASG;IACK,0BAA0B,CAAC,UAA2B,EAAE,UAAkB,EAAE,UAAkB,EAAE,UAAqB,EAAE,SAA0B,EAAE,MAAc;QACvK,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,UAAU,aAAa,MAAM,EAAE,CAAC,CAAC;QAE3E,kCAAkC;QAClC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YAAE,OAAO;QAErC,gBAAgB;QAChB,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI;YAAE,OAAO;QAElB,qBAAqB;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE/C,2CAA2C;QAC3C,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;YACpC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACK,sBAAsB,CAAC,UAA2B,EAAE,UAAkB,EAAE,UAAkB,EAAE,UAAqB,EAAE,SAA0B,EAAE,MAAc;QACnK,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE;YAChC,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,aAAa,MAAM,EAAE,CAAC,CAAC,CAAC;YAC7D,mDAAmD;YACnD,wFAAwF;YACxF,IAAI,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACzB,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC5B;YAED,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI;gBACP,SAAS;YAEX,MAAM,SAAS,GAAG,6BAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAClD,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;gBAC1C,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;SACzE;IACH,CAAC;IAED;;;;;;OAMG;IACO,sBAAsB,CAAC,UAAqB,EAAE,SAA0B,EAAE,MAAc;QAChG,MAAM,UAAU,GAAG,IAAI,KAAK,EAAiB,CAAC;QAE9C,IAAI,gBAAwB,CAAC;QAC7B,IAAI,kBAA0B,CAAC;QAC/B,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;QACtD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAExD,IAAI,SAAS,KAAK,mCAAe,CAAC,MAAM,EAAE;YACxC,gBAAgB,GAAG,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC;YAC/C,kBAAkB,GAAG,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;SACpD;aAAM,IAAI,SAAS,KAAK,mCAAe,CAAC,qBAAqB,EAAE;YAC9D,gBAAgB,GAAG,YAAY,CAAC,mBAAmB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,CAAC,uBAAuB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SACvI;aAAM,IAAI,SAAS,KAAK,mCAAe,CAAC,oBAAoB,EAAE;YAC7D,gBAAgB,GAAG,YAAY,CAAC,mBAAmB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,CAAC,qBAAqB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SACnG;aAAM;YACL,gBAAgB,GAAG,YAAY,CAAC,qBAAqB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAClI,kBAAkB,GAAG,YAAY,CAAC,yBAAyB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SAC3K;QAED,MAAM,oBAAoB,GAAG,UAAU,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAChE,MAAM,sBAAsB,GAAG,UAAU,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAEpE,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACzC,IAAI,CAAC,0BAA0B,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACxG,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,oBAAoB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACzG,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,sBAAsB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;SAC5G;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CAaF;AA5KD,8CA4KC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport * as fs from \"fs\";\r\nimport * as glob from \"glob\";\r\nimport * as path from \"path\";\r\nimport { Schema, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\n\r\nconst formatString = (format: string, ...args: string[]) => {\r\n  return format.replace(/{(\\d+)}/g, (match, theNumber) => {\r\n    return typeof args[theNumber] !== \"undefined\"\r\n      ? args[theNumber]\r\n      : match;\r\n  });\r\n};\r\n\r\nconst padStartEx = (str: string, targetLength: number, padString: string) => {\r\n  targetLength = targetLength >> 0; // truncate if number or convert non-number to 0;\r\n  padString = String((typeof padString !== \"undefined\" ? padString : \" \"));\r\n  if (str.length > targetLength) {\r\n    return String(str);\r\n  } else {\r\n    targetLength = targetLength - str.length;\r\n    if (targetLength > padString.length) {\r\n      padString += padString.repeat(targetLength / padString.length); // append to original to ensure we are longer than needed\r\n    }\r\n    return padString.slice(0, targetLength) + str;\r\n  }\r\n};\r\n\r\n/**\r\n * A SchemaKey implementation that aids in identifying Schema files via the\r\n * addition of two properties: fileName and schemaText.  The fileName contains the\r\n * full path to the file on disk and schemaText is the full string representation\r\n * of the Schema.\r\n * @beta\r\n */\r\nexport class FileSchemaKey extends SchemaKey {\r\n  // The schema file associated with the SchemaKey\r\n  public fileName: string;\r\n  // The JSON text for the schema loaded\r\n  public schemaText?: string;\r\n\r\n  /**\r\n   * Initializes a new FileSchemaKey object.\r\n   * @param key The EC SchemaKey identifying the Schema.\r\n   * @param fileName The full path to the Schema file.\r\n   * @param schemaText The string representation of the Schema\r\n   * loaded from disk. Optional.\r\n   */\r\n  constructor(key: SchemaKey, fileName: string, schemaJson?: string) {\r\n    super(key.name, key.version);\r\n    this.fileName = fileName;\r\n    this.schemaText = schemaJson;\r\n  }\r\n}\r\n\r\n/**\r\n * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater\r\n * @beta - Needs further testing and possibly moved to a separate package.\r\n */\r\nexport abstract class SchemaFileLocater {\r\n  public searchPaths: string[];\r\n\r\n  constructor() {\r\n    this.searchPaths = [];\r\n  }\r\n\r\n  public async readUtf8FileToString(filePath: string): Promise<string | undefined> {\r\n    return new Promise<string | undefined>((resolve, reject) => {\r\n      fs.readFile(filePath, \"utf-8\", (err, data) => {\r\n        if (err)\r\n          reject(err);\r\n        else\r\n          resolve(data);\r\n      });\r\n    });\r\n  }\r\n\r\n  public readUtf8FileToStringSync(filePath: string): string | undefined {\r\n    return fs.readFileSync(filePath, \"utf-8\");\r\n  }\r\n\r\n  public async fileExists(filePath: string): Promise<boolean | undefined> {\r\n    return new Promise<boolean | undefined>((resolve) => {\r\n      fs.access(filePath, fs.constants.F_OK, (err) => {\r\n        resolve(err ? false : true);\r\n      });\r\n    });\r\n  }\r\n\r\n  public fileExistsSync(filePath: string): boolean | undefined {\r\n    return fs.existsSync(filePath);\r\n  }\r\n\r\n  /**\r\n   * Adds more search paths used by this locator to find the\r\n   * Schema files.\r\n   * @param schemaPaths An array of search paths to add\r\n   */\r\n  public addSchemaSearchPaths(schemaPaths: string[]) {\r\n    // If the path is not in the schemaPaths array, add it\r\n    for (const schemaPath of schemaPaths)\r\n      this.addSchemaSearchPath(schemaPath);\r\n  }\r\n\r\n  /**\r\n   * Add one search path used by this locator to find the\r\n   * Schema files.\r\n   * @param schemaPath A search path to add\r\n   */\r\n  public addSchemaSearchPath(schemaPath: string) {\r\n    // If the path is not in the schemaPaths array, add it\r\n    if (!this.searchPaths.find((entry) => entry === schemaPath))\r\n      this.searchPaths.push(schemaPath);\r\n  }\r\n\r\n  protected abstract getSchemaKey(data: string): SchemaKey;\r\n\r\n  /**\r\n   * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method\r\n   * only attempts to find schema files that have no version in the file name.\r\n   * @param foundFiles The collection of SchemaKeys found in the given directory.\r\n   * @param schemaPath The directory in which to search for the Schemas.\r\n   * @param schemaName The short name of the Schema (without version).\r\n   * @param desiredKey The SchemaKey used to find matching Schema files.\r\n   * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.\r\n   * @param format The type of file that the schema key refers to. json or xml\r\n   */\r\n  private addCandidateNoExtSchemaKey(foundFiles: FileSchemaKey[], schemaPath: string, schemaName: string, desiredKey: SchemaKey, matchType: SchemaMatchType, format: string) {\r\n    const fullPath = path.join(schemaPath, `${schemaName}.ecschema.${format}`);\r\n\r\n    // If the file does not exist, end\r\n    if (!fs.existsSync(fullPath)) return;\r\n\r\n    // Read the file\r\n    const file = fs.readFileSync(fullPath);\r\n    if (!file) return;\r\n\r\n    // Get the schema key\r\n    const key = this.getSchemaKey(file.toString());\r\n\r\n    // If the key matches, put it in foundFiles\r\n    if (key.matches(desiredKey, matchType))\r\n      foundFiles.push(new FileSchemaKey(key, fullPath, file.toString()));\r\n  }\r\n\r\n  /**\r\n   * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey\r\n   * @param foundFiles The collection of SchemaKeys found in the given directory\r\n   * @param schemaPath The directory in which to search for the Schemas\r\n   * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.\r\n   * @param desiredKey The schemaKey used to find matching Schema files\r\n   * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.\r\n   * @param format The type of file that the schema key refers to. json or xml\r\n   */\r\n  private addCandidateSchemaKeys(foundFiles: FileSchemaKey[], schemaPath: string, fileFilter: string, desiredKey: SchemaKey, matchType: SchemaMatchType, format: string) {\r\n    const fullPath = path.join(schemaPath, fileFilter);\r\n\r\n    const result = new glob.GlobSync(fullPath, { sync: true });\r\n    for (const match of result.found) {\r\n      let fileName = path.basename(match, (`.ecschema.${format}`));\r\n      // TODO: should this be moved or handled elsewhere?\r\n      // Handles two version file names - SchemaKey.parseString supports only 3 version names.\r\n      if (/[^\\d]\\.\\d?\\d\\.\\d?\\d$/.test(fileName)) {\r\n        const parts = fileName.split(\".\");\r\n        parts.splice(2, 0, \"00\");\r\n        fileName = parts.join(\".\");\r\n      }\r\n\r\n      const file = fs.readFileSync(match);\r\n      if (!file)\r\n        continue;\r\n\r\n      const schemaKey = SchemaKey.parseString(fileName);\r\n      if (schemaKey.matches(desiredKey, matchType))\r\n        foundFiles.push(new FileSchemaKey(schemaKey, match, file.toString()));\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Attempts to find all Schema files in the configurable search paths that match\r\n   * the desired SchemaKey.\r\n   * @param desiredKey The SchemaKey to match.\r\n   * @param matchType The SchemaMatchType.\r\n   * @param format The type of file that the schema key refers to. json or xml\r\n   */\r\n  protected findEligibleSchemaKeys(desiredKey: SchemaKey, matchType: SchemaMatchType, format: string): FileSchemaKey[] {\r\n    const foundFiles = new Array<FileSchemaKey>();\r\n\r\n    let twoVersionSuffix: string;\r\n    let threeVersionSuffix: string;\r\n    const readVersion = desiredKey.readVersion.toString();\r\n    const writeVersion = desiredKey.writeVersion.toString();\r\n    const minorVersion = desiredKey.minorVersion.toString();\r\n\r\n    if (matchType === SchemaMatchType.Latest) {\r\n      twoVersionSuffix = (`.*.*.ecschema.${format}`);\r\n      threeVersionSuffix = (`.*.*.*.ecschema.${format}`);\r\n    } else if (matchType === SchemaMatchType.LatestWriteCompatible) {\r\n      twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\r\n      threeVersionSuffix = formatString(`.{0}.{1}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"));\r\n    } else if (matchType === SchemaMatchType.LatestReadCompatible) {\r\n      twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\r\n      threeVersionSuffix = formatString(`.{0}.*.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\r\n    } else {\r\n      twoVersionSuffix = formatString(`.{0}.{1}.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"));\r\n      threeVersionSuffix = formatString(`.{0}.{1}.{2}.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"), padStartEx(minorVersion, 2, \"0\"));\r\n    }\r\n\r\n    const twoVersionExpression = desiredKey.name + twoVersionSuffix;\r\n    const threeVersionExpression = desiredKey.name + threeVersionSuffix;\r\n\r\n    for (const searchPath of this.searchPaths) {\r\n      this.addCandidateNoExtSchemaKey(foundFiles, searchPath, desiredKey.name, desiredKey, matchType, format);\r\n      this.addCandidateSchemaKeys(foundFiles, searchPath, twoVersionExpression, desiredKey, matchType, format);\r\n      this.addCandidateSchemaKeys(foundFiles, searchPath, threeVersionExpression, desiredKey, matchType, format);\r\n    }\r\n\r\n    return foundFiles;\r\n  }\r\n\r\n  public abstract getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;\r\n\r\n  /**\r\n   * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the\r\n   * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.\r\n   * @param lhs The 'left-hand' FileSchemaKey.\r\n   * @param rhs The 'right-hand' FileSchemaKey.\r\n   */\r\n  public compareSchemaKeyByVersion = (lhs: FileSchemaKey, rhs: FileSchemaKey): number => {\r\n    return lhs.compareByVersion(rhs);\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"SchemaFileLocater.js","sourceRoot":"","sources":["../../src/SchemaFileLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,yBAAyB;AACzB,6BAA6B;AAC7B,6BAA6B;AAC7B,gEAA6F;AAE7F;;GAEG;AAEH,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,GAAG,IAAc,EAAE,EAAE;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACrD,OAAO,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,WAAW;YAC3C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACjB,CAAC,CAAC,KAAK,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,YAAoB,EAAE,SAAiB,EAAE,EAAE;IAC1E,YAAY,GAAG,YAAY,IAAI,CAAC,CAAC,CAAC,iDAAiD;IACnF,SAAS,GAAG,MAAM,CAAC,CAAC,OAAO,SAAS,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACzE,IAAI,GAAG,CAAC,MAAM,GAAG,YAAY,EAAE;QAC7B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;KACpB;SAAM;QACL,YAAY,GAAG,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC;QACzC,IAAI,YAAY,GAAG,SAAS,CAAC,MAAM,EAAE;YACnC,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,yDAAyD;SAC1H;QACD,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,GAAG,GAAG,CAAC;KAC/C;AACH,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAa,aAAc,SAAQ,6BAAS;IAM1C;;;;;;OAMG;IACH,YAAY,GAAc,EAAE,QAAgB,EAAE,UAAmB;QAC/D,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAlBD,sCAkBC;AAED;;;GAGG;AACH,MAAsB,iBAAiB;IAGrC;QAkKA;;;;;WAKG;QACI,8BAAyB,GAAG,CAAC,GAAkB,EAAE,GAAkB,EAAU,EAAE;YACpF,OAAO,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC,CAAC;QAzKA,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QAChD,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzD,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC3C,IAAI,GAAG;oBACL,MAAM,CAAC,GAAG,CAAC,CAAC;;oBAEZ,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,wBAAwB,CAAC,QAAgB;QAC9C,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,QAAgB;QACtC,OAAO,IAAI,OAAO,CAAsB,CAAC,OAAO,EAAE,EAAE;YAClD,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC7C,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,cAAc,CAAC,QAAgB;QACpC,OAAO,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,WAAqB;QAC/C,sDAAsD;QACtD,KAAK,MAAM,UAAU,IAAI,WAAW;YAClC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,UAAkB;QAC3C,sDAAsD;QACtD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC;YACzD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;;;OASG;IACK,0BAA0B,CAAC,UAA2B,EAAE,UAAkB,EAAE,UAAkB,EAAE,UAAqB,EAAE,SAA0B,EAAE,MAAc;QACvK,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,UAAU,aAAa,MAAM,EAAE,CAAC,CAAC;QAE3E,kCAAkC;QAClC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC1B,OAAO;QAET,gBAAgB;QAChB,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI;YACP,OAAO;QAET,qBAAqB;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE/C,2CAA2C;QAC3C,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;YACpC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACK,sBAAsB,CAAC,UAA2B,EAAE,UAAkB,EAAE,UAAkB,EAAE,UAAqB,EAAE,SAA0B,EAAE,MAAc;QACnK,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE;YAChC,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,aAAa,MAAM,EAAE,CAAC,CAAC,CAAC;YAC7D,mDAAmD;YACnD,wFAAwF;YACxF,IAAI,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACzB,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC5B;YAED,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI;gBACP,SAAS;YAEX,MAAM,SAAS,GAAG,6BAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAClD,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;gBAC1C,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;SACzE;IACH,CAAC;IAED;;;;;;OAMG;IACO,sBAAsB,CAAC,UAAqB,EAAE,SAA0B,EAAE,MAAc;QAChG,MAAM,UAAU,GAAG,IAAI,KAAK,EAAiB,CAAC;QAE9C,IAAI,gBAAwB,CAAC;QAC7B,IAAI,kBAA0B,CAAC;QAC/B,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;QACtD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAExD,IAAI,SAAS,KAAK,mCAAe,CAAC,MAAM,EAAE;YACxC,gBAAgB,GAAG,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC;YAC/C,kBAAkB,GAAG,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;SACpD;aAAM,IAAI,SAAS,KAAK,mCAAe,CAAC,qBAAqB,EAAE;YAC9D,gBAAgB,GAAG,YAAY,CAAC,mBAAmB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,CAAC,uBAAuB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SACvI;aAAM,IAAI,SAAS,KAAK,mCAAe,CAAC,oBAAoB,EAAE;YAC7D,gBAAgB,GAAG,YAAY,CAAC,mBAAmB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,CAAC,qBAAqB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SACnG;aAAM;YACL,gBAAgB,GAAG,YAAY,CAAC,qBAAqB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAClI,kBAAkB,GAAG,YAAY,CAAC,yBAAyB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SAC3K;QAED,MAAM,oBAAoB,GAAG,UAAU,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAChE,MAAM,sBAAsB,GAAG,UAAU,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAEpE,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACzC,IAAI,CAAC,0BAA0B,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACxG,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,oBAAoB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACzG,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,sBAAsB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;SAC5G;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CAaF;AA9KD,8CA8KC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport * as fs from \"fs\";\nimport * as glob from \"glob\";\nimport * as path from \"path\";\nimport { Schema, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\n\n/** @packageDocumentation\n * @module Locaters\n */\n\nconst formatString = (format: string, ...args: string[]) => {\n  return format.replace(/{(\\d+)}/g, (match, theNumber) => {\n    return typeof args[theNumber] !== \"undefined\"\n      ? args[theNumber]\n      : match;\n  });\n};\n\nconst padStartEx = (str: string, targetLength: number, padString: string) => {\n  targetLength = targetLength >> 0; // truncate if number or convert non-number to 0;\n  padString = String((typeof padString !== \"undefined\" ? padString : \" \"));\n  if (str.length > targetLength) {\n    return String(str);\n  } else {\n    targetLength = targetLength - str.length;\n    if (targetLength > padString.length) {\n      padString += padString.repeat(targetLength / padString.length); // append to original to ensure we are longer than needed\n    }\n    return padString.slice(0, targetLength) + str;\n  }\n};\n\n/**\n * A SchemaKey implementation that aids in identifying Schema files via the\n * addition of two properties: fileName and schemaText.  The fileName contains the\n * full path to the file on disk and schemaText is the full string representation\n * of the Schema.\n * @beta\n */\nexport class FileSchemaKey extends SchemaKey {\n  // The schema file associated with the SchemaKey\n  public fileName: string;\n  // The JSON text for the schema loaded\n  public schemaText?: string;\n\n  /**\n   * Initializes a new FileSchemaKey object.\n   * @param key The EC SchemaKey identifying the Schema.\n   * @param fileName The full path to the Schema file.\n   * @param schemaText The string representation of the Schema\n   * loaded from disk. Optional.\n   */\n  constructor(key: SchemaKey, fileName: string, schemaJson?: string) {\n    super(key.name, key.version);\n    this.fileName = fileName;\n    this.schemaText = schemaJson;\n  }\n}\n\n/**\n * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater\n * @beta - Needs further testing and possibly moved to a separate package.\n */\nexport abstract class SchemaFileLocater {\n  public searchPaths: string[];\n\n  constructor() {\n    this.searchPaths = [];\n  }\n\n  public async readUtf8FileToString(filePath: string): Promise<string | undefined> {\n    return new Promise<string | undefined>((resolve, reject) => {\n      fs.readFile(filePath, \"utf-8\", (err, data) => {\n        if (err)\n          reject(err);\n        else\n          resolve(data);\n      });\n    });\n  }\n\n  public readUtf8FileToStringSync(filePath: string): string | undefined {\n    return fs.readFileSync(filePath, \"utf-8\");\n  }\n\n  public async fileExists(filePath: string): Promise<boolean | undefined> {\n    return new Promise<boolean | undefined>((resolve) => {\n      fs.access(filePath, fs.constants.F_OK, (err) => {\n        resolve(err ? false : true);\n      });\n    });\n  }\n\n  public fileExistsSync(filePath: string): boolean | undefined {\n    return fs.existsSync(filePath);\n  }\n\n  /**\n   * Adds more search paths used by this locator to find the\n   * Schema files.\n   * @param schemaPaths An array of search paths to add\n   */\n  public addSchemaSearchPaths(schemaPaths: string[]) {\n    // If the path is not in the schemaPaths array, add it\n    for (const schemaPath of schemaPaths)\n      this.addSchemaSearchPath(schemaPath);\n  }\n\n  /**\n   * Add one search path used by this locator to find the\n   * Schema files.\n   * @param schemaPath A search path to add\n   */\n  public addSchemaSearchPath(schemaPath: string) {\n    // If the path is not in the schemaPaths array, add it\n    if (!this.searchPaths.find((entry) => entry === schemaPath))\n      this.searchPaths.push(schemaPath);\n  }\n\n  protected abstract getSchemaKey(data: string): SchemaKey;\n\n  /**\n   * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method\n   * only attempts to find schema files that have no version in the file name.\n   * @param foundFiles The collection of SchemaKeys found in the given directory.\n   * @param schemaPath The directory in which to search for the Schemas.\n   * @param schemaName The short name of the Schema (without version).\n   * @param desiredKey The SchemaKey used to find matching Schema files.\n   * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.\n   * @param format The type of file that the schema key refers to. json or xml\n   */\n  private addCandidateNoExtSchemaKey(foundFiles: FileSchemaKey[], schemaPath: string, schemaName: string, desiredKey: SchemaKey, matchType: SchemaMatchType, format: string) {\n    const fullPath = path.join(schemaPath, `${schemaName}.ecschema.${format}`);\n\n    // If the file does not exist, end\n    if (!fs.existsSync(fullPath))\n      return;\n\n    // Read the file\n    const file = fs.readFileSync(fullPath);\n    if (!file)\n      return;\n\n    // Get the schema key\n    const key = this.getSchemaKey(file.toString());\n\n    // If the key matches, put it in foundFiles\n    if (key.matches(desiredKey, matchType))\n      foundFiles.push(new FileSchemaKey(key, fullPath, file.toString()));\n  }\n\n  /**\n   * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey\n   * @param foundFiles The collection of SchemaKeys found in the given directory\n   * @param schemaPath The directory in which to search for the Schemas\n   * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.\n   * @param desiredKey The schemaKey used to find matching Schema files\n   * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.\n   * @param format The type of file that the schema key refers to. json or xml\n   */\n  private addCandidateSchemaKeys(foundFiles: FileSchemaKey[], schemaPath: string, fileFilter: string, desiredKey: SchemaKey, matchType: SchemaMatchType, format: string) {\n    const fullPath = path.join(schemaPath, fileFilter);\n\n    const result = new glob.GlobSync(fullPath, { sync: true });\n    for (const match of result.found) {\n      let fileName = path.basename(match, (`.ecschema.${format}`));\n      // TODO: should this be moved or handled elsewhere?\n      // Handles two version file names - SchemaKey.parseString supports only 3 version names.\n      if (/[^\\d]\\.\\d?\\d\\.\\d?\\d$/.test(fileName)) {\n        const parts = fileName.split(\".\");\n        parts.splice(2, 0, \"00\");\n        fileName = parts.join(\".\");\n      }\n\n      const file = fs.readFileSync(match);\n      if (!file)\n        continue;\n\n      const schemaKey = SchemaKey.parseString(fileName);\n      if (schemaKey.matches(desiredKey, matchType))\n        foundFiles.push(new FileSchemaKey(schemaKey, match, file.toString()));\n    }\n  }\n\n  /**\n   * Attempts to find all Schema files in the configurable search paths that match\n   * the desired SchemaKey.\n   * @param desiredKey The SchemaKey to match.\n   * @param matchType The SchemaMatchType.\n   * @param format The type of file that the schema key refers to. json or xml\n   */\n  protected findEligibleSchemaKeys(desiredKey: SchemaKey, matchType: SchemaMatchType, format: string): FileSchemaKey[] {\n    const foundFiles = new Array<FileSchemaKey>();\n\n    let twoVersionSuffix: string;\n    let threeVersionSuffix: string;\n    const readVersion = desiredKey.readVersion.toString();\n    const writeVersion = desiredKey.writeVersion.toString();\n    const minorVersion = desiredKey.minorVersion.toString();\n\n    if (matchType === SchemaMatchType.Latest) {\n      twoVersionSuffix = (`.*.*.ecschema.${format}`);\n      threeVersionSuffix = (`.*.*.*.ecschema.${format}`);\n    } else if (matchType === SchemaMatchType.LatestWriteCompatible) {\n      twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\n      threeVersionSuffix = formatString(`.{0}.{1}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"));\n    } else if (matchType === SchemaMatchType.LatestReadCompatible) {\n      twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\n      threeVersionSuffix = formatString(`.{0}.*.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\n    } else {\n      twoVersionSuffix = formatString(`.{0}.{1}.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"));\n      threeVersionSuffix = formatString(`.{0}.{1}.{2}.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"), padStartEx(minorVersion, 2, \"0\"));\n    }\n\n    const twoVersionExpression = desiredKey.name + twoVersionSuffix;\n    const threeVersionExpression = desiredKey.name + threeVersionSuffix;\n\n    for (const searchPath of this.searchPaths) {\n      this.addCandidateNoExtSchemaKey(foundFiles, searchPath, desiredKey.name, desiredKey, matchType, format);\n      this.addCandidateSchemaKeys(foundFiles, searchPath, twoVersionExpression, desiredKey, matchType, format);\n      this.addCandidateSchemaKeys(foundFiles, searchPath, threeVersionExpression, desiredKey, matchType, format);\n    }\n\n    return foundFiles;\n  }\n\n  public abstract getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;\n\n  /**\n   * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the\n   * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.\n   * @param lhs The 'left-hand' FileSchemaKey.\n   * @param rhs The 'right-hand' FileSchemaKey.\n   */\n  public compareSchemaKeyByVersion = (lhs: FileSchemaKey, rhs: FileSchemaKey): number => {\n    return lhs.compareByVersion(rhs);\n  };\n}\n"]}

package/lib/cjs/SchemaFileUtility.d.ts

@@ -1,15 +1,18 @@
-import { Schema } from "@itwin/ecschema-metadata";
-/**
- * Utility class to assist in creating serialized EC Schemas on the file system.
- * @beta
- */
-export declare class SchemaFileUtility {
-    /**
-     * Writes a Schema to an xml file to the specified output path.
-     * @param schema The Schema to serialize.
-     * @param outputPath The directory in which to create the file.
-     */
-    static writeSchemaXmlFile(schema: Schema, outputPath: string): Promise<void>;
-    private static getSchemaPath;
-}
+import { Schema } from "@itwin/ecschema-metadata";
+/** @packageDocumentation
+ * @module Utils
+ */
+/**
+ * Utility class to assist in creating serialized EC Schemas on the file system.
+ * @beta
+ */
+export declare class SchemaFileUtility {
+    /**
+     * Writes a Schema to an xml file to the specified output path.
+     * @param schema The Schema to serialize.
+     * @param outputPath The directory in which to create the file.
+     */
+    static writeSchemaXmlFile(schema: Schema, outputPath: string): Promise<void>;
+    private static getSchemaPath;
+}
 //# sourceMappingURL=SchemaFileUtility.d.ts.map

package/lib/cjs/SchemaFileUtility.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaFileUtility.d.ts","sourceRoot":"","sources":["../../src/SchemaFileUtility.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAElD;;;GAGG;AACH,qBAAa,iBAAiB;IAE5B;;;;OAIG;WACiB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAgBzE,OAAO,CAAC,MAAM,CAAC,aAAa;CAU7B"}
+{"version":3,"file":"SchemaFileUtility.d.ts","sourceRoot":"","sources":["../../src/SchemaFileUtility.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAElD;;GAEG;AAEH;;;GAGG;AACH,qBAAa,iBAAiB;IAE5B;;;;OAIG;WACiB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAgBzE,OAAO,CAAC,MAAM,CAAC,aAAa;CAU7B"}