@itwin/ecschema-locaters 4.0.0-dev.6 → 4.0.0-dev.60

package/lib/cjs/StubSchemaXmlFileLocater.js

@@ -1,178 +1,178 @@
-"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.StubSchemaXmlFileLocater = void 0;
-const path = require("path");
-const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
-const SchemaFileLocater_1 = require("./SchemaFileLocater");
-/** @packageDocumentation
- * @module Locaters
- */
-function isECv2Schema(schemaText) {
-    return /<ECSchema[^>]*xmlns=".*ECXML.2.0"/.test(schemaText);
-}
-/**
- * A SchemaLocater implementation for locating XML Schema files
- * from the file system using configurable search paths. Returns only
- * Schemas from XML files with their keys populated.
- * @internal
- */
-class StubSchemaXmlFileLocater extends SchemaFileLocater_1.SchemaFileLocater {
-    /**
-     * Loads a Schema from an XML file on the file system.
-     * @param schemaPath The path to the Schema file.
-     * @param schemaText Optionally pass in the schema text read from the schema file. If undefined,
-     * the schema will be read from the provided schemaPath.
-     */
-    loadSchema(schemaPath, schemaText) {
-        schemaText = schemaText || this.readUtf8FileToStringSync(schemaPath);
-        if (!schemaText)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.UnableToLocateSchema, `Unable to locate schema XML file at ${schemaPath}`);
-        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
-        const key = this.getSchemaKey(schemaText);
-        const alias = this.getSchemaAlias(schemaText);
-        const context = new ecschema_metadata_1.SchemaContext();
-        context.addLocater(this);
-        // Load the schema and return it
-        const schema = new ecschema_metadata_1.Schema(context, new SchemaFileLocater_1.FileSchemaKey(key, schemaPath, schemaText), alias);
-        this.addSchemaReferences(schema, context, ecschema_metadata_1.SchemaMatchType.LatestWriteCompatible);
-        return schema;
-    }
-    /**
-     * 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.
-     */
-    async getSchema(key, matchType, context) {
-        return this.getSchemaSync(key, matchType, context);
-    }
-    /**
-     * 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.
-     */
-    getSchemaSync(key, matchType, context) {
-        const candidates = this.findEligibleSchemaKeys(key, matchType, "xml");
-        if (!candidates || candidates.length === 0)
-            return undefined;
-        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1]; // eslint-disable-line @typescript-eslint/unbound-method
-        const alias = this.getSchemaAlias(maxCandidate.schemaText);
-        const schema = new ecschema_metadata_1.Schema(context, maxCandidate, alias);
-        context.addSchemaSync(schema);
-        this.addSchemaReferences(schema, context, ecschema_metadata_1.SchemaMatchType.LatestWriteCompatible);
-        return schema;
-    }
-    /**
-     * Constructs a SchemaKey based on the information in the Schema XML.
-     * @param schemaXml The Schema XML as a string.
-     */
-    getSchemaKey(schemaXml) {
-        const matches = schemaXml.match(/<ECSchema ([^]+?)>/g);
-        if (!matches || matches.length !== 1)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given file`);
-        const name = matches[0].match(/schemaName="(.+?)"/);
-        const version = matches[0].match(/version="(.+?)"/);
-        if (!name || name.length !== 2 || !version || version.length !== 2)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
-        let ecVersion;
-        if (isECv2Schema(schemaXml))
-            ecVersion = this.fromECv2String(version[1]);
-        else
-            ecVersion = ecschema_metadata_1.ECVersion.fromString(version[1]);
-        const key = new ecschema_metadata_1.SchemaKey(name[1], ecVersion);
-        return key;
-    }
-    /**
-     * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.
-     * @param xmlSchemaKey The SchemaKey of the parent Schema containing the references.
-     */
-    getSchemaReferenceKeys(schemaKey) {
-        return this._getSchemaReferenceKeys(schemaKey);
-    }
-    /**
-     * Adds schemas to the references collection for the given Schema by locating
-     * the referenced schemas.
-     * @param schema The schema for which to add the references.
-     * @param context The SchemaContext that will control the lifetime of the schema.
-     * @param refMatchType The SchemaMatchType to use when locating schema references.
-     */
-    addSchemaReferences(schema, context, refMatchType) {
-        const refKeys = this.getSchemaReferenceKeys(schema.schemaKey);
-        for (const key of refKeys) {
-            const refSchema = context ? context.getSchemaSync(key, refMatchType) : undefined;
-            if (!refSchema)
-                throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.UnableToLocateSchema, `Unable to locate referenced schema: ${key.name}.${key.readVersion}.${key.writeVersion}.${key.minorVersion}`);
-            schema.references.push(refSchema);
-        }
-    }
-    /**
-     * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.
-     * @param data The Schema XML string.
-     */
-    _getSchemaReferenceKeys(xmlSchemaKey) {
-        const file = xmlSchemaKey.schemaText;
-        if (!file)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.UnableToLocateSchema, `Could not locate the schema file, ${xmlSchemaKey.fileName}, for the schema ${xmlSchemaKey.name}`);
-        const data = file.toString().replace(/(\s*)<!--.*?-->/g, ""); // ignore any comments in the XML file when getting the array of SchemaKeys
-        const keys = [];
-        const matches = data.match(/<ECSchemaReference ([^]+?)\/>/g);
-        if (!matches)
-            return keys;
-        for (const match of matches) {
-            const name = match.match(/name="(.+?)"/);
-            const versionMatch = match.match(/version="(.+?)"/);
-            if (!name || name.length !== 2 || !versionMatch || versionMatch.length !== 2)
-                throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML, `Invalid ECSchemaReference xml encountered in the schema file`);
-            // write version maybe missing, so insert "0"
-            let versionString = versionMatch[1];
-            const versionParts = versionString.split(".");
-            if (versionParts.length === 2)
-                versionParts.splice(1, 0, "0");
-            versionString = versionParts.join(".");
-            const key = new ecschema_metadata_1.SchemaKey(name[1], ecschema_metadata_1.ECVersion.fromString(versionString));
-            keys.push(key);
-        }
-        return keys;
-    }
-    /**
-     * Gets the Schema alias from the Schema XML.
-     * @param data The Schema XML as a string.
-     */
-    getSchemaAlias(schemaXml) {
-        let match;
-        if (isECv2Schema(schemaXml)) {
-            match = schemaXml.match(/<ECSchema.*nameSpacePrefix="(?<alias>\w+)"/);
-        }
-        else {
-            match = schemaXml.match(/<ECSchema.*alias="(?<alias>\w+)"/);
-        }
-        if (!match || !match.groups.alias) {
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'alias' tag in the given file.`);
-        }
-        return match.groups.alias;
-    }
-    /**
-     * Parses a valid EC 2.0 version string and returns an ECVersion object. The second digit becomes the minor version,
-     * and a zero is inserted as the 'write' digit. Example: "1.1" -> "1.0.1".
-     * @param versionString A valid EC 2.0 version string of the format, 'RR.mm'.
-     */
-    fromECv2String(versionString) {
-        const [read, minor] = versionString.split(".");
-        if (!read)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);
-        if (!minor)
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);
-        return new ecschema_metadata_1.ECVersion(+read, 0, +minor);
-    }
-}
-exports.StubSchemaXmlFileLocater = StubSchemaXmlFileLocater;
+"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.StubSchemaXmlFileLocater = void 0;
+const path = require("path");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const SchemaFileLocater_1 = require("./SchemaFileLocater");
+/** @packageDocumentation
+ * @module Locaters
+ */
+function isECv2Schema(schemaText) {
+    return /<ECSchema[^>]*xmlns=".*ECXML.2.0"/.test(schemaText);
+}
+/**
+ * A SchemaLocater implementation for locating XML Schema files
+ * from the file system using configurable search paths. Returns only
+ * Schemas from XML files with their keys populated.
+ * @internal
+ */
+class StubSchemaXmlFileLocater extends SchemaFileLocater_1.SchemaFileLocater {
+    /**
+     * Loads a Schema from an XML file on the file system.
+     * @param schemaPath The path to the Schema file.
+     * @param schemaText Optionally pass in the schema text read from the schema file. If undefined,
+     * the schema will be read from the provided schemaPath.
+     */
+    loadSchema(schemaPath, schemaText) {
+        schemaText = schemaText || this.readUtf8FileToStringSync(schemaPath);
+        if (!schemaText)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.UnableToLocateSchema, `Unable to locate schema XML file at ${schemaPath}`);
+        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
+        const key = this.getSchemaKey(schemaText);
+        const alias = this.getSchemaAlias(schemaText);
+        const context = new ecschema_metadata_1.SchemaContext();
+        context.addLocater(this);
+        // Load the schema and return it
+        const schema = new ecschema_metadata_1.Schema(context, new SchemaFileLocater_1.FileSchemaKey(key, schemaPath, schemaText), alias);
+        this.addSchemaReferences(schema, context, ecschema_metadata_1.SchemaMatchType.LatestWriteCompatible);
+        return schema;
+    }
+    /**
+     * 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.
+     */
+    async getSchema(key, matchType, context) {
+        return this.getSchemaSync(key, matchType, context);
+    }
+    /**
+     * 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.
+     */
+    getSchemaSync(key, matchType, context) {
+        const candidates = this.findEligibleSchemaKeys(key, matchType, "xml");
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1]; // eslint-disable-line @typescript-eslint/unbound-method
+        const alias = this.getSchemaAlias(maxCandidate.schemaText);
+        const schema = new ecschema_metadata_1.Schema(context, maxCandidate, alias);
+        context.addSchemaSync(schema);
+        this.addSchemaReferences(schema, context, ecschema_metadata_1.SchemaMatchType.LatestWriteCompatible);
+        return schema;
+    }
+    /**
+     * Constructs a SchemaKey based on the information in the Schema XML.
+     * @param schemaXml The Schema XML as a string.
+     */
+    getSchemaKey(schemaXml) {
+        const matches = schemaXml.match(/<ECSchema ([^]+?)>/g);
+        if (!matches || matches.length !== 1)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given file`);
+        const name = matches[0].match(/schemaName="(.+?)"/);
+        const version = matches[0].match(/version="(.+?)"/);
+        if (!name || name.length !== 2 || !version || version.length !== 2)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
+        let ecVersion;
+        if (isECv2Schema(schemaXml))
+            ecVersion = this.fromECv2String(version[1]);
+        else
+            ecVersion = ecschema_metadata_1.ECVersion.fromString(version[1]);
+        const key = new ecschema_metadata_1.SchemaKey(name[1], ecVersion);
+        return key;
+    }
+    /**
+     * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.
+     * @param xmlSchemaKey The SchemaKey of the parent Schema containing the references.
+     */
+    getSchemaReferenceKeys(schemaKey) {
+        return this._getSchemaReferenceKeys(schemaKey);
+    }
+    /**
+     * Adds schemas to the references collection for the given Schema by locating
+     * the referenced schemas.
+     * @param schema The schema for which to add the references.
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     * @param refMatchType The SchemaMatchType to use when locating schema references.
+     */
+    addSchemaReferences(schema, context, refMatchType) {
+        const refKeys = this.getSchemaReferenceKeys(schema.schemaKey);
+        for (const key of refKeys) {
+            const refSchema = context ? context.getSchemaSync(key, refMatchType) : undefined;
+            if (!refSchema)
+                throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.UnableToLocateSchema, `Unable to locate referenced schema: ${key.name}.${key.readVersion}.${key.writeVersion}.${key.minorVersion}`);
+            schema.references.push(refSchema);
+        }
+    }
+    /**
+     * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.
+     * @param data The Schema XML string.
+     */
+    _getSchemaReferenceKeys(xmlSchemaKey) {
+        const file = xmlSchemaKey.schemaText;
+        if (!file)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.UnableToLocateSchema, `Could not locate the schema file, ${xmlSchemaKey.fileName}, for the schema ${xmlSchemaKey.name}`);
+        const data = file.toString().replace(/(\s*)<!--.*?-->/g, ""); // ignore any comments in the XML file when getting the array of SchemaKeys
+        const keys = [];
+        const matches = data.match(/<ECSchemaReference ([^]+?)\/>/g);
+        if (!matches)
+            return keys;
+        for (const match of matches) {
+            const name = match.match(/name="(.+?)"/);
+            const versionMatch = match.match(/version="(.+?)"/);
+            if (!name || name.length !== 2 || !versionMatch || versionMatch.length !== 2)
+                throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML, `Invalid ECSchemaReference xml encountered in the schema file`);
+            // write version maybe missing, so insert "0"
+            let versionString = versionMatch[1];
+            const versionParts = versionString.split(".");
+            if (versionParts.length === 2)
+                versionParts.splice(1, 0, "0");
+            versionString = versionParts.join(".");
+            const key = new ecschema_metadata_1.SchemaKey(name[1], ecschema_metadata_1.ECVersion.fromString(versionString));
+            keys.push(key);
+        }
+        return keys;
+    }
+    /**
+     * Gets the Schema alias from the Schema XML.
+     * @param data The Schema XML as a string.
+     */
+    getSchemaAlias(schemaXml) {
+        let match;
+        if (isECv2Schema(schemaXml)) {
+            match = schemaXml.match(/<ECSchema.*nameSpacePrefix="(?<alias>\w+)"/);
+        }
+        else {
+            match = schemaXml.match(/<ECSchema.*alias="(?<alias>\w+)"/);
+        }
+        if (!match || !match.groups.alias) {
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'alias' tag in the given file.`);
+        }
+        return match.groups.alias;
+    }
+    /**
+     * Parses a valid EC 2.0 version string and returns an ECVersion object. The second digit becomes the minor version,
+     * and a zero is inserted as the 'write' digit. Example: "1.1" -> "1.0.1".
+     * @param versionString A valid EC 2.0 version string of the format, 'RR.mm'.
+     */
+    fromECv2String(versionString) {
+        const [read, minor] = versionString.split(".");
+        if (!read)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);
+        if (!minor)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);
+        return new ecschema_metadata_1.ECVersion(+read, 0, +minor);
+    }
+}
+exports.StubSchemaXmlFileLocater = StubSchemaXmlFileLocater;
 //# sourceMappingURL=StubSchemaXmlFileLocater.js.map

package/lib/cjs/StubSchemaXmlFileLocater.js.map

@@ -1 +1 @@
-{"version":3,"file":"StubSchemaXmlFileLocater.js","sourceRoot":"","sources":["../../src/StubSchemaXmlFileLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,6BAA6B;AAC7B,gEAEkC;AAClC,2DAAuE;AAEvE;;GAEG;AAEH,SAAS,YAAY,CAAC,UAAkB;IACtC,OAAO,mCAAmC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;GAKG;AACH,MAAa,wBAAyB,SAAQ,qCAAiB;IAC7D;;;;;OAKG;IACI,UAAU,CAAC,UAAkB,EAAE,UAAmB;QACvD,UAAU,GAAG,UAAU,IAAI,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QACrE,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAE,uCAAuC,UAAU,EAAE,CAAC,CAAC;QAEtH,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,iCAAa,EAAE,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEzB,gCAAgC;QAChC,MAAM,MAAM,GAAG,IAAI,0BAAM,CAAC,OAAO,EAAE,IAAI,iCAAa,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,CAAC;QAC1F,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,mCAAe,CAAC,qBAAqB,CAAC,CAAC;QACjF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CAAmB,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACzG,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAM,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACI,aAAa,CAAmB,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACvG,MAAM,UAAU,GAAoB,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAEvF,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,CAAC,wDAAwD;QACrJ,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,UAAW,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,IAAI,0BAAM,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,CAAM,CAAC;QAC7D,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAE9B,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,mCAAe,CAAC,qBAAqB,CAAC,CAAC;QACjF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,SAAiB;QACnC,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;QAElH,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAChE,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,6EAA6E,CAAC,CAAC;QAE5I,IAAI,SAAoB,CAAC;QACzB,IAAI,YAAY,CAAC,SAAS,CAAC;YACzB,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;;YAE5C,SAAS,GAAG,6BAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/C,MAAM,GAAG,GAAG,IAAI,6BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAC9C,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACK,sBAAsB,CAAC,SAAwB;QACrD,OAAO,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACK,mBAAmB,CAAC,MAAc,EAAE,OAAsB,EAAE,YAA6B;QAC/F,MAAM,OAAO,GAAG,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,SAA0B,CAAC,CAAC;QAE/E,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;YACzB,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,IAAI,CAAC,SAAS;gBACZ,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAE,uCAAuC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC;YAE/K,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACnC;IACH,CAAC;IAED;;;OAGG;IACK,uBAAuB,CAAC,YAA2B;QACzD,MAAM,IAAI,GAAG,YAAY,CAAC,UAAU,CAAC;QAErC,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAE,qCAAqC,YAAY,CAAC,QAAQ,oBAAoB,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;QAEpK,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC,CAAC,2EAA2E;QAEzI,MAAM,IAAI,GAAgB,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAC7D,IAAI,CAAC,OAAO;YACV,OAAO,IAAI,CAAC;QAEd,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;YAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YACzC,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;gBAC1E,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,8DAA8D,CAAC,CAAC;YAE7H,6CAA6C;YAC7C,IAAI,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YACpC,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9C,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;gBAC3B,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;YAEjC,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEvC,MAAM,GAAG,GAAG,IAAI,6BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,6BAAS,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;YACxE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAChB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACK,cAAc,CAAC,SAAiB;QACtC,IAAI,KAAU,CAAC;QAEf,IAAI,YAAY,CAAC,SAAS,CAAC,EAAE;YAC3B,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,4CAA4C,CAAQ,CAAC;SAC9E;aAAM;YACL,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,kCAAkC,CAAQ,CAAC;SACpE;QAED,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE;YACjC,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,4DAA4D,CAAC,CAAC;SAC1H;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,aAAqB;QAC1C,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE/C,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,oDAAoD,aAAa,EAAE,CAAC,CAAC;QAElI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEnI,OAAO,IAAI,6BAAS,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CACF;AAxLD,4DAwLC","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 path from \"path\";\r\nimport {\r\n  ECObjectsError, ECObjectsStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType,\r\n} from \"@itwin/ecschema-metadata\";\r\nimport { FileSchemaKey, SchemaFileLocater } from \"./SchemaFileLocater\";\r\n\r\n/** @packageDocumentation\r\n * @module Locaters\r\n */\r\n\r\nfunction isECv2Schema(schemaText: string): boolean {\r\n  return /<ECSchema[^>]*xmlns=\".*ECXML.2.0\"/.test(schemaText);\r\n}\r\n\r\n/**\r\n * A SchemaLocater implementation for locating XML Schema files\r\n * from the file system using configurable search paths. Returns only\r\n * Schemas from XML files with their keys populated.\r\n * @internal\r\n */\r\nexport class StubSchemaXmlFileLocater extends SchemaFileLocater implements ISchemaLocater {\r\n  /**\r\n   * Loads a Schema from an XML file on the file system.\r\n   * @param schemaPath The path to the Schema file.\r\n   * @param schemaText Optionally pass in the schema text read from the schema file. If undefined,\r\n   * the schema will be read from the provided schemaPath.\r\n   */\r\n  public loadSchema(schemaPath: string, schemaText?: string): Schema {\r\n    schemaText = schemaText || this.readUtf8FileToStringSync(schemaPath);\r\n    if (!schemaText)\r\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to locate schema XML file at ${schemaPath}`);\r\n\r\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\r\n    const key = this.getSchemaKey(schemaText);\r\n    const alias = this.getSchemaAlias(schemaText);\r\n    const context = new SchemaContext();\r\n    context.addLocater(this);\r\n\r\n    // Load the schema and return it\r\n    const schema = new Schema(context, new FileSchemaKey(key, schemaPath, schemaText), alias);\r\n    this.addSchemaReferences(schema, context, SchemaMatchType.LatestWriteCompatible);\r\n    return schema;\r\n  }\r\n\r\n  /**\r\n   * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths\r\n   * to locate the XML Schema file from the file system. Returns only Schemas from XML files with\r\n   * their keys populated.\r\n   * @param key The SchemaKey of the Schema to retrieve.\r\n   * @param matchType The SchemaMatchType.\r\n   * @param context The SchemaContext that will control the lifetime of the schema.\r\n   */\r\n  public async getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined> {\r\n    return this.getSchemaSync(key, matchType, context) as T;\r\n  }\r\n\r\n  /**\r\n   * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths\r\n   * to locate the XML Schema file from the file system. Returns only Schemas from XML files with\r\n   * their keys populated.\r\n   * @param key The SchemaKey of the Schema to retrieve.\r\n   * @param matchType The SchemaMatchType.\r\n   * @param context The SchemaContext that will control the lifetime of the schema.\r\n   */\r\n  public getSchemaSync<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined {\r\n    const candidates: FileSchemaKey[] = this.findEligibleSchemaKeys(key, matchType, \"xml\");\r\n\r\n    if (!candidates || candidates.length === 0)\r\n      return undefined;\r\n\r\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1]; // eslint-disable-line @typescript-eslint/unbound-method\r\n    const alias = this.getSchemaAlias(maxCandidate.schemaText!);\r\n    const schema = new Schema(context, maxCandidate, alias) as T;\r\n    context.addSchemaSync(schema);\r\n\r\n    this.addSchemaReferences(schema, context, SchemaMatchType.LatestWriteCompatible);\r\n    return schema;\r\n  }\r\n\r\n  /**\r\n   * Constructs a SchemaKey based on the information in the Schema XML.\r\n   * @param schemaXml The Schema XML as a string.\r\n   */\r\n  public getSchemaKey(schemaXml: string): SchemaKey {\r\n    const matches = schemaXml.match(/<ECSchema ([^]+?)>/g);\r\n    if (!matches || matches.length !== 1)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given file`);\r\n\r\n    const name = matches[0].match(/schemaName=\"(.+?)\"/);\r\n    const version = matches[0].match(/version=\"(.+?)\"/);\r\n    if (!name || name.length !== 2 || !version || version.length !== 2)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\r\n\r\n    let ecVersion: ECVersion;\r\n    if (isECv2Schema(schemaXml))\r\n      ecVersion = this.fromECv2String(version[1]);\r\n    else\r\n      ecVersion = ECVersion.fromString(version[1]);\r\n\r\n    const key = new SchemaKey(name[1], ecVersion);\r\n    return key;\r\n  }\r\n\r\n  /**\r\n   * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.\r\n   * @param xmlSchemaKey The SchemaKey of the parent Schema containing the references.\r\n   */\r\n  private getSchemaReferenceKeys(schemaKey: FileSchemaKey): SchemaKey[] {\r\n    return this._getSchemaReferenceKeys(schemaKey);\r\n  }\r\n\r\n  /**\r\n   * Adds schemas to the references collection for the given Schema by locating\r\n   * the referenced schemas.\r\n   * @param schema The schema for which to add the references.\r\n   * @param context The SchemaContext that will control the lifetime of the schema.\r\n   * @param refMatchType The SchemaMatchType to use when locating schema references.\r\n   */\r\n  private addSchemaReferences(schema: Schema, context: SchemaContext, refMatchType: SchemaMatchType): void {\r\n    const refKeys = this.getSchemaReferenceKeys(schema.schemaKey as FileSchemaKey);\r\n\r\n    for (const key of refKeys) {\r\n      const refSchema = context ? context.getSchemaSync(key, refMatchType) : undefined;\r\n      if (!refSchema)\r\n        throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to locate referenced schema: ${key.name}.${key.readVersion}.${key.writeVersion}.${key.minorVersion}`);\r\n\r\n      schema.references.push(refSchema);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.\r\n   * @param data The Schema XML string.\r\n   */\r\n  private _getSchemaReferenceKeys(xmlSchemaKey: FileSchemaKey): SchemaKey[] {\r\n    const file = xmlSchemaKey.schemaText;\r\n\r\n    if (!file)\r\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Could not locate the schema file, ${xmlSchemaKey.fileName}, for the schema ${xmlSchemaKey.name}`);\r\n\r\n    const data = file.toString().replace(/(\\s*)<!--.*?-->/g, \"\"); // ignore any comments in the XML file when getting the array of SchemaKeys\r\n\r\n    const keys: SchemaKey[] = [];\r\n    const matches = data.match(/<ECSchemaReference ([^]+?)\\/>/g);\r\n    if (!matches)\r\n      return keys;\r\n\r\n    for (const match of matches) {\r\n      const name = match.match(/name=\"(.+?)\"/);\r\n      const versionMatch = match.match(/version=\"(.+?)\"/);\r\n      if (!name || name.length !== 2 || !versionMatch || versionMatch.length !== 2)\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Invalid ECSchemaReference xml encountered in the schema file`);\r\n\r\n      // write version maybe missing, so insert \"0\"\r\n      let versionString = versionMatch[1];\r\n      const versionParts = versionString.split(\".\");\r\n      if (versionParts.length === 2)\r\n        versionParts.splice(1, 0, \"0\");\r\n\r\n      versionString = versionParts.join(\".\");\r\n\r\n      const key = new SchemaKey(name[1], ECVersion.fromString(versionString));\r\n      keys.push(key);\r\n    }\r\n\r\n    return keys;\r\n  }\r\n\r\n  /**\r\n   * Gets the Schema alias from the Schema XML.\r\n   * @param data The Schema XML as a string.\r\n   */\r\n  private getSchemaAlias(schemaXml: string): string {\r\n    let match: any;\r\n\r\n    if (isECv2Schema(schemaXml)) {\r\n      match = schemaXml.match(/<ECSchema.*nameSpacePrefix=\"(?<alias>\\w+)\"/) as any;\r\n    } else {\r\n      match = schemaXml.match(/<ECSchema.*alias=\"(?<alias>\\w+)\"/) as any;\r\n    }\r\n\r\n    if (!match || !match.groups.alias) {\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'alias' tag in the given file.`);\r\n    }\r\n\r\n    return match.groups.alias;\r\n  }\r\n\r\n  /**\r\n   * Parses a valid EC 2.0 version string and returns an ECVersion object. The second digit becomes the minor version,\r\n   * and a zero is inserted as the 'write' digit. Example: \"1.1\" -> \"1.0.1\".\r\n   * @param versionString A valid EC 2.0 version string of the format, 'RR.mm'.\r\n   */\r\n  private fromECv2String(versionString: string): ECVersion {\r\n    const [read, minor] = versionString.split(\".\");\r\n\r\n    if (!read)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);\r\n\r\n    if (!minor)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);\r\n\r\n    return new ECVersion(+read, 0, +minor);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"StubSchemaXmlFileLocater.js","sourceRoot":"","sources":["../../src/StubSchemaXmlFileLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,6BAA6B;AAC7B,gEAEkC;AAClC,2DAAuE;AAEvE;;GAEG;AAEH,SAAS,YAAY,CAAC,UAAkB;IACtC,OAAO,mCAAmC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;GAKG;AACH,MAAa,wBAAyB,SAAQ,qCAAiB;IAC7D;;;;;OAKG;IACI,UAAU,CAAC,UAAkB,EAAE,UAAmB;QACvD,UAAU,GAAG,UAAU,IAAI,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QACrE,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAE,uCAAuC,UAAU,EAAE,CAAC,CAAC;QAEtH,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,iCAAa,EAAE,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEzB,gCAAgC;QAChC,MAAM,MAAM,GAAG,IAAI,0BAAM,CAAC,OAAO,EAAE,IAAI,iCAAa,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,CAAC;QAC1F,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,mCAAe,CAAC,qBAAqB,CAAC,CAAC;QACjF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CAAmB,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACzG,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAM,CAAC;IAC1D,CAAC;IAED;;;;;;;OAOG;IACI,aAAa,CAAmB,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACvG,MAAM,UAAU,GAAoB,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAEvF,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,CAAC,wDAAwD;QACrJ,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,UAAW,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,IAAI,0BAAM,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,CAAM,CAAC;QAC7D,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAE9B,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,mCAAe,CAAC,qBAAqB,CAAC,CAAC;QACjF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,SAAiB;QACnC,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;QAElH,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAChE,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,6EAA6E,CAAC,CAAC;QAE5I,IAAI,SAAoB,CAAC;QACzB,IAAI,YAAY,CAAC,SAAS,CAAC;YACzB,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;;YAE5C,SAAS,GAAG,6BAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/C,MAAM,GAAG,GAAG,IAAI,6BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAC9C,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;OAGG;IACK,sBAAsB,CAAC,SAAwB;QACrD,OAAO,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACK,mBAAmB,CAAC,MAAc,EAAE,OAAsB,EAAE,YAA6B;QAC/F,MAAM,OAAO,GAAG,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,SAA0B,CAAC,CAAC;QAE/E,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE;YACzB,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACjF,IAAI,CAAC,SAAS;gBACZ,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAE,uCAAuC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC;YAE/K,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SACnC;IACH,CAAC;IAED;;;OAGG;IACK,uBAAuB,CAAC,YAA2B;QACzD,MAAM,IAAI,GAAG,YAAY,CAAC,UAAU,CAAC;QAErC,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,oBAAoB,EAAE,qCAAqC,YAAY,CAAC,QAAQ,oBAAoB,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;QAEpK,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC,CAAC,2EAA2E;QAEzI,MAAM,IAAI,GAAgB,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;QAC7D,IAAI,CAAC,OAAO;YACV,OAAO,IAAI,CAAC;QAEd,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;YAC3B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YACzC,MAAM,YAAY,GAAG,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;gBAC1E,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,8DAA8D,CAAC,CAAC;YAE7H,6CAA6C;YAC7C,IAAI,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YACpC,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9C,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;gBAC3B,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;YAEjC,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEvC,MAAM,GAAG,GAAG,IAAI,6BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,6BAAS,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;YACxE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAChB;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACK,cAAc,CAAC,SAAiB;QACtC,IAAI,KAAU,CAAC;QAEf,IAAI,YAAY,CAAC,SAAS,CAAC,EAAE;YAC3B,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,4CAA4C,CAAQ,CAAC;SAC9E;aAAM;YACL,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,kCAAkC,CAAQ,CAAC;SACpE;QAED,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE;YACjC,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,4DAA4D,CAAC,CAAC;SAC1H;QAED,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,aAAqB;QAC1C,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE/C,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,oDAAoD,aAAa,EAAE,CAAC,CAAC;QAElI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEnI,OAAO,IAAI,6BAAS,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CACF;AAxLD,4DAwLC","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 path from \"path\";\nimport {\n  ECObjectsError, ECObjectsStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType,\n} from \"@itwin/ecschema-metadata\";\nimport { FileSchemaKey, SchemaFileLocater } from \"./SchemaFileLocater\";\n\n/** @packageDocumentation\n * @module Locaters\n */\n\nfunction isECv2Schema(schemaText: string): boolean {\n  return /<ECSchema[^>]*xmlns=\".*ECXML.2.0\"/.test(schemaText);\n}\n\n/**\n * A SchemaLocater implementation for locating XML Schema files\n * from the file system using configurable search paths. Returns only\n * Schemas from XML files with their keys populated.\n * @internal\n */\nexport class StubSchemaXmlFileLocater extends SchemaFileLocater implements ISchemaLocater {\n  /**\n   * Loads a Schema from an XML file on the file system.\n   * @param schemaPath The path to the Schema file.\n   * @param schemaText Optionally pass in the schema text read from the schema file. If undefined,\n   * the schema will be read from the provided schemaPath.\n   */\n  public loadSchema(schemaPath: string, schemaText?: string): Schema {\n    schemaText = schemaText || this.readUtf8FileToStringSync(schemaPath);\n    if (!schemaText)\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to locate schema XML file at ${schemaPath}`);\n\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\n    const key = this.getSchemaKey(schemaText);\n    const alias = this.getSchemaAlias(schemaText);\n    const context = new SchemaContext();\n    context.addLocater(this);\n\n    // Load the schema and return it\n    const schema = new Schema(context, new FileSchemaKey(key, schemaPath, schemaText), alias);\n    this.addSchemaReferences(schema, context, SchemaMatchType.LatestWriteCompatible);\n    return schema;\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 async getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined> {\n    return this.getSchemaSync(key, matchType, context) as T;\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 getSchemaSync<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined {\n    const candidates: FileSchemaKey[] = this.findEligibleSchemaKeys(key, matchType, \"xml\");\n\n    if (!candidates || candidates.length === 0)\n      return undefined;\n\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1]; // eslint-disable-line @typescript-eslint/unbound-method\n    const alias = this.getSchemaAlias(maxCandidate.schemaText!);\n    const schema = new Schema(context, maxCandidate, alias) as T;\n    context.addSchemaSync(schema);\n\n    this.addSchemaReferences(schema, context, SchemaMatchType.LatestWriteCompatible);\n    return schema;\n  }\n\n  /**\n   * Constructs a SchemaKey based on the information in the Schema XML.\n   * @param schemaXml The Schema XML as a string.\n   */\n  public getSchemaKey(schemaXml: string): SchemaKey {\n    const matches = schemaXml.match(/<ECSchema ([^]+?)>/g);\n    if (!matches || matches.length !== 1)\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given file`);\n\n    const name = matches[0].match(/schemaName=\"(.+?)\"/);\n    const version = matches[0].match(/version=\"(.+?)\"/);\n    if (!name || name.length !== 2 || !version || version.length !== 2)\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\n\n    let ecVersion: ECVersion;\n    if (isECv2Schema(schemaXml))\n      ecVersion = this.fromECv2String(version[1]);\n    else\n      ecVersion = ECVersion.fromString(version[1]);\n\n    const key = new SchemaKey(name[1], ecVersion);\n    return key;\n  }\n\n  /**\n   * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.\n   * @param xmlSchemaKey The SchemaKey of the parent Schema containing the references.\n   */\n  private getSchemaReferenceKeys(schemaKey: FileSchemaKey): SchemaKey[] {\n    return this._getSchemaReferenceKeys(schemaKey);\n  }\n\n  /**\n   * Adds schemas to the references collection for the given Schema by locating\n   * the referenced schemas.\n   * @param schema The schema for which to add the references.\n   * @param context The SchemaContext that will control the lifetime of the schema.\n   * @param refMatchType The SchemaMatchType to use when locating schema references.\n   */\n  private addSchemaReferences(schema: Schema, context: SchemaContext, refMatchType: SchemaMatchType): void {\n    const refKeys = this.getSchemaReferenceKeys(schema.schemaKey as FileSchemaKey);\n\n    for (const key of refKeys) {\n      const refSchema = context ? context.getSchemaSync(key, refMatchType) : undefined;\n      if (!refSchema)\n        throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to locate referenced schema: ${key.name}.${key.readVersion}.${key.writeVersion}.${key.minorVersion}`);\n\n      schema.references.push(refSchema);\n    }\n  }\n\n  /**\n   * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.\n   * @param data The Schema XML string.\n   */\n  private _getSchemaReferenceKeys(xmlSchemaKey: FileSchemaKey): SchemaKey[] {\n    const file = xmlSchemaKey.schemaText;\n\n    if (!file)\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Could not locate the schema file, ${xmlSchemaKey.fileName}, for the schema ${xmlSchemaKey.name}`);\n\n    const data = file.toString().replace(/(\\s*)<!--.*?-->/g, \"\"); // ignore any comments in the XML file when getting the array of SchemaKeys\n\n    const keys: SchemaKey[] = [];\n    const matches = data.match(/<ECSchemaReference ([^]+?)\\/>/g);\n    if (!matches)\n      return keys;\n\n    for (const match of matches) {\n      const name = match.match(/name=\"(.+?)\"/);\n      const versionMatch = match.match(/version=\"(.+?)\"/);\n      if (!name || name.length !== 2 || !versionMatch || versionMatch.length !== 2)\n        throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Invalid ECSchemaReference xml encountered in the schema file`);\n\n      // write version maybe missing, so insert \"0\"\n      let versionString = versionMatch[1];\n      const versionParts = versionString.split(\".\");\n      if (versionParts.length === 2)\n        versionParts.splice(1, 0, \"0\");\n\n      versionString = versionParts.join(\".\");\n\n      const key = new SchemaKey(name[1], ECVersion.fromString(versionString));\n      keys.push(key);\n    }\n\n    return keys;\n  }\n\n  /**\n   * Gets the Schema alias from the Schema XML.\n   * @param data The Schema XML as a string.\n   */\n  private getSchemaAlias(schemaXml: string): string {\n    let match: any;\n\n    if (isECv2Schema(schemaXml)) {\n      match = schemaXml.match(/<ECSchema.*nameSpacePrefix=\"(?<alias>\\w+)\"/) as any;\n    } else {\n      match = schemaXml.match(/<ECSchema.*alias=\"(?<alias>\\w+)\"/) as any;\n    }\n\n    if (!match || !match.groups.alias) {\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'alias' tag in the given file.`);\n    }\n\n    return match.groups.alias;\n  }\n\n  /**\n   * Parses a valid EC 2.0 version string and returns an ECVersion object. The second digit becomes the minor version,\n   * and a zero is inserted as the 'write' digit. Example: \"1.1\" -> \"1.0.1\".\n   * @param versionString A valid EC 2.0 version string of the format, 'RR.mm'.\n   */\n  private fromECv2String(versionString: string): ECVersion {\n    const [read, minor] = versionString.split(\".\");\n\n    if (!read)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);\n\n    if (!minor)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);\n\n    return new ECVersion(+read, 0, +minor);\n  }\n}\n"]}

package/lib/cjs/ecschema-locaters.d.ts

@@ -1,18 +1,18 @@
-export * from "./SchemaFileLocater";
-export * from "./SchemaJsonFileLocater";
-export * from "./SchemaXmlFileLocater";
-export * from "./StubSchemaXmlFileLocater";
-/** @docs-package-description
- * The ecschema-locaters package contains classes for locating ECSchemas within a given
- * [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext). Each locater
- * implements the [ISchemaLocater interface](https://www.itwinjs.org/reference/ecschema-metadata/context/ischemalocater/).
- */
-/**
- * @docs-group-description Locaters
- * ISchemaLocater implementations used to locate schemas in a given [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext).
- */
-/**
- * @docs-group-description Utils
- * A set of utility classes used throughout the package.
- */
+export * from "./SchemaFileLocater";
+export * from "./SchemaJsonFileLocater";
+export * from "./SchemaXmlFileLocater";
+export * from "./StubSchemaXmlFileLocater";
+/** @docs-package-description
+ * The ecschema-locaters package contains classes for locating ECSchemas within a given
+ * [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext). Each locater
+ * implements the [ISchemaLocater interface](https://www.itwinjs.org/reference/ecschema-metadata/context/ischemalocater/).
+ */
+/**
+ * @docs-group-description Locaters
+ * ISchemaLocater implementations used to locate schemas in a given [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext).
+ */
+/**
+ * @docs-group-description Utils
+ * A set of utility classes used throughout the package.
+ */
 //# sourceMappingURL=ecschema-locaters.d.ts.map

package/lib/cjs/ecschema-locaters.js

@@ -1,34 +1,38 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./SchemaFileLocater"), exports);
-__exportStar(require("./SchemaJsonFileLocater"), exports);
-__exportStar(require("./SchemaXmlFileLocater"), exports);
-__exportStar(require("./StubSchemaXmlFileLocater"), exports);
-/** @docs-package-description
- * The ecschema-locaters package contains classes for locating ECSchemas within a given
- * [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext). Each locater
- * implements the [ISchemaLocater interface](https://www.itwinjs.org/reference/ecschema-metadata/context/ischemalocater/).
- */
-/**
- * @docs-group-description Locaters
- * ISchemaLocater implementations used to locate schemas in a given [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext).
- */
-/**
- * @docs-group-description Utils
- * A set of utility classes used throughout the package.
- */
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./SchemaFileLocater"), exports);
+__exportStar(require("./SchemaJsonFileLocater"), exports);
+__exportStar(require("./SchemaXmlFileLocater"), exports);
+__exportStar(require("./StubSchemaXmlFileLocater"), exports);
+/** @docs-package-description
+ * The ecschema-locaters package contains classes for locating ECSchemas within a given
+ * [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext). Each locater
+ * implements the [ISchemaLocater interface](https://www.itwinjs.org/reference/ecschema-metadata/context/ischemalocater/).
+ */
+/**
+ * @docs-group-description Locaters
+ * ISchemaLocater implementations used to locate schemas in a given [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext).
+ */
+/**
+ * @docs-group-description Utils
+ * A set of utility classes used throughout the package.
+ */
 //# sourceMappingURL=ecschema-locaters.js.map

package/lib/cjs/ecschema-locaters.js.map

@@ -1 +1 @@
-{"version":3,"file":"ecschema-locaters.js","sourceRoot":"","sources":["../../src/ecschema-locaters.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;AAE/F,sDAAoC;AACpC,0DAAwC;AACxC,yDAAuC;AACvC,6DAA2C;AAE3C;;;;GAIG;AACH;;;GAGG;AACH;;;GAGG","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\nexport * from \"./SchemaFileLocater\";\r\nexport * from \"./SchemaJsonFileLocater\";\r\nexport * from \"./SchemaXmlFileLocater\";\r\nexport * from \"./StubSchemaXmlFileLocater\";\r\n\r\n/** @docs-package-description\r\n * The ecschema-locaters package contains classes for locating ECSchemas within a given\r\n * [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext). Each locater\r\n * implements the [ISchemaLocater interface](https://www.itwinjs.org/reference/ecschema-metadata/context/ischemalocater/).\r\n */\r\n/**\r\n * @docs-group-description Locaters\r\n * ISchemaLocater implementations used to locate schemas in a given [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext).\r\n */\r\n/**\r\n * @docs-group-description Utils\r\n * A set of utility classes used throughout the package.\r\n */\r\n"]}
+{"version":3,"file":"ecschema-locaters.js","sourceRoot":"","sources":["../../src/ecschema-locaters.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;;;;;AAE/F,sDAAoC;AACpC,0DAAwC;AACxC,yDAAuC;AACvC,6DAA2C;AAE3C;;;;GAIG;AACH;;;GAGG;AACH;;;GAGG","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\nexport * from \"./SchemaFileLocater\";\nexport * from \"./SchemaJsonFileLocater\";\nexport * from \"./SchemaXmlFileLocater\";\nexport * from \"./StubSchemaXmlFileLocater\";\n\n/** @docs-package-description\n * The ecschema-locaters package contains classes for locating ECSchemas within a given\n * [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext). Each locater\n * implements the [ISchemaLocater interface](https://www.itwinjs.org/reference/ecschema-metadata/context/ischemalocater/).\n */\n/**\n * @docs-group-description Locaters\n * ISchemaLocater implementations used to locate schemas in a given [SchemaContext](https://www.itwinjs.org/reference/ecschema-metadata/context/schemacontext).\n */\n/**\n * @docs-group-description Utils\n * A set of utility classes used throughout the package.\n */\n"]}

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

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=SchemaFileUtility.test.d.ts.map