@itwin/ecschema-locaters 5.0.0-dev.90 → 5.0.0-dev.93

package/lib/esm/SchemaFileLocater.d.ts

@@ -0,0 +1,94 @@
+/** @packageDocumentation
+ * @module Locaters
+ */
+import { Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+/**
+ * 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
+ */
+export declare class FileSchemaKey extends SchemaKey {
+    fileName: string;
+    schemaText?: string;
+    /**
+     * 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: SchemaKey, fileName: string, schemaJson?: string);
+}
+/**
+ * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater
+ * @beta - Needs further testing and possibly moved to a separate package.
+ */
+export declare abstract class SchemaFileLocater {
+    searchPaths: string[];
+    constructor();
+    readUtf8FileToString(filePath: string): Promise<string | undefined>;
+    readUtf8FileToStringSync(filePath: string): string | undefined;
+    fileExists(filePath: string): Promise<boolean | undefined>;
+    fileExistsSync(filePath: string): boolean | undefined;
+    /**
+     * Adds more search paths used by this locator to find the
+     * Schema files.
+     * @param schemaPaths An array of search paths to add
+     */
+    addSchemaSearchPaths(schemaPaths: string[]): void;
+    /**
+     * Add one search path used by this locator to find the
+     * Schema files.
+     * @param schemaPath A search path to add
+     */
+    addSchemaSearchPath(schemaPath: string): void;
+    protected abstract getSchemaKey(data: string): SchemaKey;
+    /**
+     * 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
+     */
+    private addCandidateNoExtSchemaKey;
+    /**
+     * 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
+     */
+    private addCandidateSchemaKeys;
+    /**
+     * 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
+     */
+    protected findEligibleSchemaKeys(desiredKey: SchemaKey, matchType: SchemaMatchType, format: string): FileSchemaKey[];
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
+     * to locate the XML Schema file from the file system. Returns only Schemas from XML files with
+     * their keys populated.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    abstract getSchema(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
+    /**
+     * 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.
+     */
+    compareSchemaKeyByVersion: (lhs: FileSchemaKey, rhs: FileSchemaKey) => number;
+}
+//# sourceMappingURL=SchemaFileLocater.d.ts.map

package/lib/esm/SchemaFileLocater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaFileLocater.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAwB7F;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAEnC,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;OAMG;gBACS,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;CAKlE;AAED;;;GAGG;AACH,8BAAsB,iBAAiB;IAC9B,WAAW,EAAE,MAAM,EAAE,CAAC;;IAMhB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAWzE,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIxD,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAQhE,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI5D;;;;OAIG;IACI,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE;IAMjD;;;;OAIG;IACI,mBAAmB,CAAC,UAAU,EAAE,MAAM;IAM7C,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAExD;;;;;;;;;OASG;IACH,OAAO,CAAC,0BAA0B;IAoBlC;;;;;;;;OAQG;IACH,OAAO,CAAC,sBAAsB;IAwB9B;;;;;;OAMG;IACH,SAAS,CAAC,sBAAsB,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE;IAmCpH;;;;;;;OAOG;aACa,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAE1H;;;;;OAKG;IACI,yBAAyB,QAAS,aAAa,OAAO,aAAa,KAAG,MAAM,CAEjF;CACH"}

package/lib/esm/SchemaFileLocater.js

@@ -0,0 +1,213 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Locaters
+ */
+import * as fs from "fs";
+import { globSync } from "glob";
+import * as path from "path";
+import { SchemaKey, SchemaMatchType } from "@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
+ */
+export class FileSchemaKey extends SchemaKey {
+    // The schema file associated with the SchemaKey
+    fileName;
+    // The JSON text for the schema loaded
+    schemaText;
+    /**
+     * 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;
+    }
+}
+/**
+ * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater
+ * @beta - Needs further testing and possibly moved to a separate package.
+ */
+export class SchemaFileLocater {
+    searchPaths;
+    constructor() {
+        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 = globSync(fullPath, { windowsPathsNoEscape: true });
+        for (const match of result) {
+            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 = 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 === SchemaMatchType.Latest) {
+            twoVersionSuffix = (`.*.*.ecschema.${format}`);
+            threeVersionSuffix = (`.*.*.*.ecschema.${format}`);
+        }
+        else if (matchType === 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 === 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;
+    }
+    /**
+     * 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.
+     */
+    compareSchemaKeyByVersion = (lhs, rhs) => {
+        return lhs.compareByVersion(rhs);
+    };
+}
+//# sourceMappingURL=SchemaFileLocater.js.map

package/lib/esm/SchemaFileLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaFileLocater.js","sourceRoot":"","sources":["../../src/SchemaFileLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAyB,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;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,CAAC;QAC9B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,YAAY,GAAG,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC;QACzC,IAAI,YAAY,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;YACpC,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,yDAAyD;QAC3H,CAAC;QACD,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,GAAG,GAAG,CAAC;IAChD,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC1C,gDAAgD;IACzC,QAAQ,CAAS;IACxB,sCAAsC;IAC/B,UAAU,CAAU;IAE3B;;;;;;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;AAED;;;GAGG;AACH,MAAM,OAAgB,iBAAiB;IAC9B,WAAW,CAAW;IAE7B;QACE,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,QAAQ,CAAC,QAAQ,EAAE,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,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,CAAC;gBAC1C,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;YAC7B,CAAC;YAED,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI;gBACP,SAAS;YAEX,MAAM,SAAS,GAAG,SAAS,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;QAC1E,CAAC;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,eAAe,CAAC,MAAM,EAAE,CAAC;YACzC,gBAAgB,GAAG,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC;YAC/C,kBAAkB,GAAG,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;QACrD,CAAC;aAAM,IAAI,SAAS,KAAK,eAAe,CAAC,qBAAqB,EAAE,CAAC;YAC/D,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;QACxI,CAAC;aAAM,IAAI,SAAS,KAAK,eAAe,CAAC,oBAAoB,EAAE,CAAC;YAC9D,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;QACpG,CAAC;aAAM,CAAC;YACN,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;QAC5K,CAAC;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,CAAC;YAC1C,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;QAC7G,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAYD;;;;;OAKG;IACI,yBAAyB,GAAG,CAAC,GAAkB,EAAE,GAAkB,EAAU,EAAE;QACpF,OAAO,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC,CAAC;CACH","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/** @packageDocumentation\n * @module Locaters\n */\n\nimport * as fs from \"fs\";\nimport { globSync } from \"glob\";\nimport * as path from \"path\";\nimport { Schema, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\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 = globSync(fullPath, { windowsPathsNoEscape: true });\n    for (const match of result) {\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  /**\n   * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths\n   * to locate the XML Schema file from the file system. Returns only Schemas from XML files with\n   * their keys populated.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema.\n   */\n  public abstract getSchema(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | 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/esm/SchemaJsonFileLocater.d.ts

@@ -0,0 +1,42 @@
+/** @packageDocumentation
+ * @module Locaters
+ */
+import { ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaFileLocater } from "./SchemaFileLocater";
+/**
+ * A SchemaLocator implementation for locating JSON Schema files
+ * from the file system using configurable search paths.
+ * @beta
+ */
+export declare class SchemaJsonFileLocater extends SchemaFileLocater implements ISchemaLocater {
+    /**
+     * Constructs a SchemaKey based on the information in the Schema JSON
+     * @param data The Schema JSON as a string
+     */
+    protected getSchemaKey(data: string): SchemaKey;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+     */
+    getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchemaSync(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined;
+}
+//# sourceMappingURL=SchemaJsonFileLocater.d.ts.map

package/lib/esm/SchemaJsonFileLocater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaJsonFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaJsonFileLocater.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EACuC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAC1H,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEvE;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,iBAAkB,YAAW,cAAc;IAEpF;;;OAGG;IACH,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAmB/C;;;;;;OAMG;IACU,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO7H;;;;;;QAMI;IACS,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAsBrI;;;;;;OAMG;IACI,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;CAsBnH"}

package/lib/esm/SchemaJsonFileLocater.js

@@ -0,0 +1,96 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Locaters
+ */
+import * as fs from "fs";
+import * as path from "path";
+import { ECObjectsError, ECObjectsStatus, ECVersion, Schema, SchemaKey, } from "@itwin/ecschema-metadata";
+import { SchemaFileLocater } from "./SchemaFileLocater";
+/**
+ * A SchemaLocator implementation for locating JSON Schema files
+ * from the file system using configurable search paths.
+ * @beta
+ */
+export class SchemaJsonFileLocater extends SchemaFileLocater {
+    /**
+     * Constructs a SchemaKey based on the information in the Schema JSON
+     * @param data The Schema JSON as a string
+     */
+    getSchemaKey(data) {
+        const dataJson = JSON.parse(data);
+        // Check if the name is present
+        if (!(dataJson.name))
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Could not retrieve the ECSchema name in the given file.`);
+        // Check if versions is present
+        if (!(dataJson.version))
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Could not parse the ECSchema version in the given file.`);
+        // Get the name and version from the JSON
+        const schemaName = dataJson.name;
+        const schemaVersion = dataJson.version;
+        const key = new SchemaKey(schemaName.toString(), ECVersion.fromString(schemaVersion.toString()));
+        return key;
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+     */
+    async getSchema(schemaKey, matchType, context) {
+        await this.getSchemaInfo(schemaKey, matchType, context);
+        const schema = await context.getCachedSchema(schemaKey, matchType);
+        return schema;
+    }
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    async getSchemaInfo(schemaKey, matchType, context) {
+        // Grab all schema files that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType, "json");
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaPath = maxCandidate.fileName;
+        // Load the file
+        if (!await this.fileExists(schemaPath))
+            return undefined;
+        const schemaText = await this.readUtf8FileToString(schemaPath);
+        if (!schemaText)
+            return undefined;
+        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
+        return Schema.startLoadingFromJson(schemaText, context);
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchemaSync(schemaKey, matchType, context) {
+        // Grab all schema files that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType, "json");
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaPath = maxCandidate.fileName;
+        // Load the file
+        if (!fs.existsSync(schemaPath))
+            return undefined;
+        const schemaText = fs.readFileSync(schemaPath, "utf-8");
+        if (!schemaText)
+            return undefined;
+        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
+        const schema = Schema.fromJsonSync(schemaText, context);
+        return schema;
+    }
+}
+//# sourceMappingURL=SchemaJsonFileLocater.js.map

package/lib/esm/SchemaJsonFileLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaJsonFileLocater.js","sourceRoot":"","sources":["../../src/SchemaJsonFileLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EACL,cAAc,EAAE,eAAe,EAAE,SAAS,EAAkB,MAAM,EAA6B,SAAS,GACzG,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEvE;;;;GAIG;AACH,MAAM,OAAO,qBAAsB,SAAQ,iBAAiB;IAE1D;;;OAGG;IACO,YAAY,CAAC,IAAY;QACjC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAElC,+BAA+B;QAC/B,IAAI,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC;YAClB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,yDAAyD,CAAC,CAAC;QAErH,+BAA+B;QAC/B,IAAI,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;YACrB,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,aAAa,EAAE,yDAAyD,CAAC,CAAC;QAErH,yCAAyC;QACzC,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,CAAC;QACjC,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC;QAEvC,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QACjG,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7F,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAExD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,kDAAkD;QAClD,MAAM,UAAU,GAAoB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC9F,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC;QAEzC,gBAAgB;QAChB,IAAI,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACpC,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU;YACb,OAAO,SAAS,CAAC;QAEnB,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAEtD,OAAO,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC3F,kDAAkD;QAClD,MAAM,UAAU,GAAoB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC9F,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC;QAEzC,gBAAgB;QAChB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC;YAC5B,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,CAAC,UAAU;YACb,OAAO,SAAS,CAAC;QAEnB,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAEtD,MAAM,MAAM,GAAG,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACxD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF","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/** @packageDocumentation\n * @module Locaters\n */\n\nimport * as fs from \"fs\";\nimport * as path from \"path\";\nimport {\n  ECObjectsError, ECObjectsStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType,\n} from \"@itwin/ecschema-metadata\";\nimport { FileSchemaKey, SchemaFileLocater } from \"./SchemaFileLocater\";\n\n/**\n * A SchemaLocator implementation for locating JSON Schema files\n * from the file system using configurable search paths.\n * @beta\n */\nexport class SchemaJsonFileLocater extends SchemaFileLocater implements ISchemaLocater {\n\n  /**\n   * Constructs a SchemaKey based on the information in the Schema JSON\n   * @param data The Schema JSON as a string\n   */\n  protected getSchemaKey(data: string): SchemaKey {\n    const dataJson = JSON.parse(data);\n\n    // Check if the name is present\n    if (!(dataJson.name))\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Could not retrieve the ECSchema name in the given file.`);\n\n    // Check if versions is present\n    if (!(dataJson.version))\n      throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Could not parse the ECSchema version in the given file.`);\n\n    // Get the name and version from the JSON\n    const schemaName = dataJson.name;\n    const schemaVersion = dataJson.version;\n\n    const key = new SchemaKey(schemaName.toString(), ECVersion.fromString(schemaVersion.toString()));\n    return key;\n  }\n\n  /**\n   * Attempts to retrieve a Schema with the given SchemaKey by using the configured\n   * search paths to locate the JSON schema file from the file system.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n   */\n  public async getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    await this.getSchemaInfo(schemaKey, matchType, context);\n\n    const schema = await context.getCachedSchema(schemaKey, matchType);\n    return schema;\n  }\n\n  /**\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\n    * The fully loaded schema can be gotten later from the context using the getCachedSchema method.\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\n    * @param matchType The match type to use when locating the schema\n    * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n    */\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    // Grab all schema files that match the schema key\n    const candidates: FileSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType, \"json\");\n    if (!candidates || candidates.length === 0)\n      return undefined;\n\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\n    const schemaPath = maxCandidate.fileName;\n\n    // Load the file\n    if (!await this.fileExists(schemaPath))\n      return undefined;\n\n    const schemaText = await this.readUtf8FileToString(schemaPath);\n    if (!schemaText)\n      return undefined;\n\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\n\n    return Schema.startLoadingFromJson(schemaText, context);\n  }\n\n  /**\n   * Attempts to retrieve a Schema with the given SchemaKey by using the configured\n   * search paths to locate the JSON schema file from the file system.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType\n   * @param context The SchemaContext that will control the lifetime of the schema.\n   */\n  public getSchemaSync(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined {\n    // Grab all schema files that match the schema key\n    const candidates: FileSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType, \"json\");\n    if (!candidates || candidates.length === 0)\n      return undefined;\n\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\n    const schemaPath = maxCandidate.fileName;\n\n    // Load the file\n    if (!fs.existsSync(schemaPath))\n      return undefined;\n\n    const schemaText = fs.readFileSync(schemaPath, \"utf-8\");\n    if (!schemaText)\n      return undefined;\n\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\n\n    const schema = Schema.fromJsonSync(schemaText, context);\n    return schema;\n  }\n}\n"]}

package/lib/esm/SchemaStringLocater.d.ts

@@ -0,0 +1,54 @@
+/** @packageDocumentation
+ * @module Locaters
+ */
+import { Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+/**
+ * A SchemaKey implementation that aids in identifying Schema strings via the
+ * addition of the schemaText property. The schemaText is the full XML string
+ * representation of the Schema.
+ * @beta
+ */
+export declare class StringSchemaKey extends SchemaKey {
+    schemaText: string;
+    /**
+     * Initializes a new StringSchemaKey object.
+     * @param key The EC SchemaKey identifying the Schema.
+     * @param schemaText The string representation of the Schema
+     */
+    constructor(key: SchemaKey, schemaText: string);
+}
+/**
+ * Abstract class to hold common/overlapping functionality between SchemaJsonStringLocater and SchemaXmlStringLocater
+ * @beta
+ */
+export declare abstract class SchemaStringLocater {
+    schemaStrings: string[];
+    constructor();
+    /**
+     * Adds schema strings used by this locator to find the
+     * Schemas.
+     * @param schemaPaths An array of Schema strings to add
+     */
+    addSchemaStrings(schemaStrings: string[]): void;
+    /**
+     * Adds a schema string used by this locator to locate and load Schemas.
+     * @param schemaText The text of the Schema
+     */
+    addSchemaString(schemaString: string): void;
+    protected abstract getSchemaKey(data: string): SchemaKey;
+    /**
+     * Attempts to find all Schema strings that match the desired SchemaKey.
+     * @param desiredKey The SchemaKey to match.
+     * @param matchType The SchemaMatchType.
+     */
+    protected findEligibleSchemaKeys(desiredKey: SchemaKey, matchType: SchemaMatchType): StringSchemaKey[];
+    abstract getSchema(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
+    /**
+     * 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' StringSchemaKey.
+     * @param rhs The 'right-hand' StringSchemaKey.
+     */
+    compareSchemaKeyByVersion: (lhs: StringSchemaKey, rhs: StringSchemaKey) => number;
+}
+//# sourceMappingURL=SchemaStringLocater.d.ts.map

package/lib/esm/SchemaStringLocater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaStringLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaStringLocater.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE7F;;;;;GAKG;AACH,qBAAa,eAAgB,SAAQ,SAAS;IAErC,UAAU,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;gBACS,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM;CAI/C;AAED;;;GAGG;AACH,8BAAsB,mBAAmB;IAChC,aAAa,EAAE,MAAM,EAAE,CAAC;;IAM/B;;;;OAIG;IACI,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE;IAM/C;;;OAGG;IACI,eAAe,CAAC,YAAY,EAAE,MAAM;IAO3C,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAExD;;;;OAIG;IACH,SAAS,CAAC,sBAAsB,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,GAAG,eAAe,EAAE;aAetF,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAE1H;;;;;OAKG;IACI,yBAAyB,QAAS,eAAe,OAAO,eAAe,KAAG,MAAM,CAErF;CACH"}