@itwin/ecschema-locaters 4.1.0-dev.75 → 4.1.0-dev.76

package/lib/cjs/SchemaStringLocater.d.ts

@@ -0,0 +1,54 @@
+import { Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+/** @packageDocumentation
+ * @module Locaters
+ */
+/**
+ * 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: Readonly<SchemaKey>, matchType: SchemaMatchType): StringSchemaKey[];
+    abstract getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | 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/cjs/SchemaStringLocater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaStringLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaStringLocater.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE7F;;GAEG;AAEH;;;;;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,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,GAAG,eAAe,EAAE;aAehG,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAEvI;;;;;OAKG;IACI,yBAAyB,QAAS,eAAe,OAAO,eAAe,KAAG,MAAM,CAErF;CACH"}

package/lib/cjs/SchemaStringLocater.js

@@ -0,0 +1,85 @@
+"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.SchemaStringLocater = exports.StringSchemaKey = void 0;
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+/** @packageDocumentation
+ * @module Locaters
+ */
+/**
+ * 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
+ */
+class StringSchemaKey extends ecschema_metadata_1.SchemaKey {
+    /**
+     * Initializes a new StringSchemaKey object.
+     * @param key The EC SchemaKey identifying the Schema.
+     * @param schemaText The string representation of the Schema
+     */
+    constructor(key, schemaText) {
+        super(key.name, key.version);
+        this.schemaText = schemaText;
+    }
+}
+exports.StringSchemaKey = StringSchemaKey;
+/**
+ * Abstract class to hold common/overlapping functionality between SchemaJsonStringLocater and SchemaXmlStringLocater
+ * @beta
+ */
+class SchemaStringLocater {
+    constructor() {
+        /**
+         * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the
+         * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.
+         * @param lhs The 'left-hand' StringSchemaKey.
+         * @param rhs The 'right-hand' StringSchemaKey.
+         */
+        this.compareSchemaKeyByVersion = (lhs, rhs) => {
+            return lhs.compareByVersion(rhs);
+        };
+        this.schemaStrings = [];
+    }
+    /**
+     * Adds schema strings used by this locator to find the
+     * Schemas.
+     * @param schemaPaths An array of Schema strings to add
+     */
+    addSchemaStrings(schemaStrings) {
+        // If the path is not in the schemaPaths array, add it
+        for (const schemaString of schemaStrings)
+            this.addSchemaString(schemaString);
+    }
+    /**
+     * Adds a schema string used by this locator to locate and load Schemas.
+     * @param schemaText The text of the Schema
+     */
+    addSchemaString(schemaString) {
+        const schemaKey = this.getSchemaKey(schemaString);
+        // If the string is not in the schemaStrings array, add it
+        if (!this.schemaStrings.find((entry) => this.getSchemaKey(entry).matches(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact)))
+            this.schemaStrings.push(schemaString);
+    }
+    /**
+     * Attempts to find all Schema strings that match the desired SchemaKey.
+     * @param desiredKey The SchemaKey to match.
+     * @param matchType The SchemaMatchType.
+     */
+    findEligibleSchemaKeys(desiredKey, matchType) {
+        const foundStrings = new Array();
+        for (const schemaString of this.schemaStrings) {
+            // Get the schema key
+            const key = this.getSchemaKey(schemaString);
+            // If the key matches, put it in foundFiles
+            if (key.matches(desiredKey, matchType))
+                foundStrings.push(new StringSchemaKey(key, schemaString));
+        }
+        return foundStrings;
+    }
+}
+exports.SchemaStringLocater = SchemaStringLocater;
+//# sourceMappingURL=SchemaStringLocater.js.map

package/lib/cjs/SchemaStringLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaStringLocater.js","sourceRoot":"","sources":["../../src/SchemaStringLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,gEAA6F;AAE7F;;GAEG;AAEH;;;;;GAKG;AACH,MAAa,eAAgB,SAAQ,6BAAS;IAI5C;;;;OAIG;IACH,YAAY,GAAc,EAAE,UAAkB;QAC5C,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAbD,0CAaC;AAED;;;GAGG;AACH,MAAsB,mBAAmB;IAGvC;QAkDA;;;;;WAKG;QACI,8BAAyB,GAAG,CAAC,GAAoB,EAAE,GAAoB,EAAU,EAAE;YACxF,OAAO,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC,CAAC;QAzDA,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;IAC1B,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,aAAuB;QAC7C,sDAAsD;QACtD,KAAK,MAAM,YAAY,IAAI,aAAa;YACtC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,eAAe,CAAC,YAAoB;QACzC,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAClD,0DAA0D;QAC1D,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC;YACzG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC;IAID;;;;OAIG;IACO,sBAAsB,CAAC,UAA+B,EAAE,SAA0B;QAC1F,MAAM,YAAY,GAAG,IAAI,KAAK,EAAmB,CAAC;QAElD,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,aAAa,EAAE;YAC7C,qBAAqB;YACrB,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;YAE5C,2CAA2C;YAC3C,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;gBACpC,YAAY,CAAC,IAAI,CAAC,IAAI,eAAe,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAC;SAC7D;QAED,OAAO,YAAY,CAAC;IACtB,CAAC;CAaF;AA9DD,kDA8DC","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 { Schema, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\n\r\n/** @packageDocumentation\r\n * @module Locaters\r\n */\r\n\r\n/**\r\n * A SchemaKey implementation that aids in identifying Schema strings via the\r\n * addition of the schemaText property. The schemaText is the full XML string\r\n * representation of the Schema.\r\n * @beta\r\n */\r\nexport class StringSchemaKey extends SchemaKey {\r\n  // The text for the schema loaded\r\n  public schemaText: string;\r\n\r\n  /**\r\n   * Initializes a new StringSchemaKey object.\r\n   * @param key The EC SchemaKey identifying the Schema.\r\n   * @param schemaText The string representation of the Schema\r\n   */\r\n  constructor(key: SchemaKey, schemaText: string) {\r\n    super(key.name, key.version);\r\n    this.schemaText = schemaText;\r\n  }\r\n}\r\n\r\n/**\r\n * Abstract class to hold common/overlapping functionality between SchemaJsonStringLocater and SchemaXmlStringLocater\r\n * @beta\r\n */\r\nexport abstract class SchemaStringLocater {\r\n  public schemaStrings: string[];\r\n\r\n  constructor() {\r\n    this.schemaStrings = [];\r\n  }\r\n\r\n  /**\r\n   * Adds schema strings used by this locator to find the\r\n   * Schemas.\r\n   * @param schemaPaths An array of Schema strings to add\r\n   */\r\n  public addSchemaStrings(schemaStrings: string[]) {\r\n    // If the path is not in the schemaPaths array, add it\r\n    for (const schemaString of schemaStrings)\r\n      this.addSchemaString(schemaString);\r\n  }\r\n\r\n  /**\r\n   * Adds a schema string used by this locator to locate and load Schemas.\r\n   * @param schemaText The text of the Schema\r\n   */\r\n  public addSchemaString(schemaString: string) {\r\n    const schemaKey = this.getSchemaKey(schemaString);\r\n    // If the string is not in the schemaStrings array, add it\r\n    if (!this.schemaStrings.find((entry) => this.getSchemaKey(entry).matches(schemaKey, SchemaMatchType.Exact)))\r\n      this.schemaStrings.push(schemaString);\r\n  }\r\n\r\n  protected abstract getSchemaKey(data: string): SchemaKey;\r\n\r\n  /**\r\n   * Attempts to find all Schema strings that match the desired SchemaKey.\r\n   * @param desiredKey The SchemaKey to match.\r\n   * @param matchType The SchemaMatchType.\r\n   */\r\n  protected findEligibleSchemaKeys(desiredKey: Readonly<SchemaKey>, matchType: SchemaMatchType): StringSchemaKey[] {\r\n    const foundStrings = new Array<StringSchemaKey>();\r\n\r\n    for (const schemaString of this.schemaStrings) {\r\n      // Get the schema key\r\n      const key = this.getSchemaKey(schemaString);\r\n\r\n      // If the key matches, put it in foundFiles\r\n      if (key.matches(desiredKey, matchType))\r\n        foundStrings.push(new StringSchemaKey(key, schemaString));\r\n    }\r\n\r\n    return foundStrings;\r\n  }\r\n\r\n  public abstract getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;\r\n\r\n  /**\r\n   * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the\r\n   * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.\r\n   * @param lhs The 'left-hand' StringSchemaKey.\r\n   * @param rhs The 'right-hand' StringSchemaKey.\r\n   */\r\n  public compareSchemaKeyByVersion = (lhs: StringSchemaKey, rhs: StringSchemaKey): number => {\r\n    return lhs.compareByVersion(rhs);\r\n  };\r\n}\r\n"]}

package/lib/cjs/SchemaXmlStringLocater.d.ts

@@ -0,0 +1,48 @@
+import { ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaStringLocater } from "./SchemaStringLocater";
+/** @packageDocumentation
+ * @module Locaters
+ */
+/**
+ * A SchemaLocator implementation for locating and deserializing EC Schemas from XML strings
+ * loaded in memory.
+ * @beta
+ */
+export declare class SchemaXmlStringLocater extends SchemaStringLocater implements ISchemaLocater {
+    /**
+     * Constructs a SchemaKey based on the information in the Schema XML.
+     * @param schemaXml The Schema XML as a string.
+     */
+    getSchemaKey(schemaXml: string): SchemaKey;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by searching the configured
+     * Schema strings.
+     * @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<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | 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 searching the configured
+     * Schema strings.
+     * @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.
+     */
+    getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
+    /**
+     * 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'.
+     */
+    private fromECv2String;
+}
+//# sourceMappingURL=SchemaXmlStringLocater.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlStringLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaXmlStringLocater.ts"],"names":[],"mappings":"AAMA,OAAO,EACuC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAC1H,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAmB,MAAM,uBAAuB,CAAC;AAE7E;;GAEG;AAEH;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,mBAAoB,YAAW,cAAc;IAEvF;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IAejD;;;;;;OAMG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAO1I;;;;;;QAMI;IACS,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAmBrI;;;;;;OAMG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS;IAoB/H;;;;OAIG;IACH,OAAO,CAAC,cAAc;CAYvB"}

package/lib/cjs/SchemaXmlStringLocater.js

@@ -0,0 +1,106 @@
+"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.SchemaXmlStringLocater = void 0;
+const xmldom_1 = require("@xmldom/xmldom");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const SchemaStringLocater_1 = require("./SchemaStringLocater");
+/** @packageDocumentation
+ * @module Locaters
+ */
+/**
+ * A SchemaLocator implementation for locating and deserializing EC Schemas from XML strings
+ * loaded in memory.
+ * @beta
+ */
+class SchemaXmlStringLocater extends SchemaStringLocater_1.SchemaStringLocater {
+    /**
+     * 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 string`);
+        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 string`);
+        const ecVersion = ecschema_metadata_1.ECVersion.fromString(version[1]);
+        const key = new ecschema_metadata_1.SchemaKey(name[1], ecVersion);
+        return key;
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by searching the configured
+     * Schema strings.
+     * @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 strings that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType);
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaText = maxCandidate.schemaText;
+        const parser = new xmldom_1.DOMParser();
+        const document = parser.parseFromString(schemaText);
+        const reader = new ecschema_metadata_1.SchemaReadHelper(ecschema_metadata_1.XmlParser, context);
+        const schema = new ecschema_metadata_1.Schema(context);
+        return reader.readSchemaInfo(schema, document);
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by searching the configured
+     * Schema strings.
+     * @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.
+     */
+    getSchemaSync(schemaKey, matchType, context) {
+        // Grab all schema strings that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType);
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaText = maxCandidate.schemaText;
+        const parser = new xmldom_1.DOMParser();
+        const document = parser.parseFromString(schemaText);
+        const reader = new ecschema_metadata_1.SchemaReadHelper(ecschema_metadata_1.XmlParser, context);
+        let schema = new ecschema_metadata_1.Schema(context);
+        schema = reader.readSchemaSync(schema, document);
+        return schema;
+    }
+    /**
+     * 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.SchemaXmlStringLocater = SchemaXmlStringLocater;
+//# sourceMappingURL=SchemaXmlStringLocater.js.map

package/lib/cjs/SchemaXmlStringLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlStringLocater.js","sourceRoot":"","sources":["../../src/SchemaXmlStringLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,2CAA2C;AAC3C,gEAEkC;AAClC,+DAA6E;AAE7E;;GAEG;AAEH;;;;GAIG;AACH,MAAa,sBAAuB,SAAQ,yCAAmB;IAE7D;;;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,qDAAqD,CAAC,CAAC;QAEpH,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,+EAA+E,CAAC,CAAC;QAE9I,MAAM,SAAS,GAAG,6BAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,GAAG,GAAG,IAAI,6BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAC9C,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAmB,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC/G,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,MAAW,CAAC;IACrB,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,oDAAoD;QACpD,MAAM,UAAU,GAAsB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACxF,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,6DAA6D;QAC7D,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,UAAU,CAAC;QAE3C,MAAM,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,oCAAgB,CAAC,6BAAS,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,IAAI,0BAAM,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAmB,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7G,oDAAoD;QACpD,MAAM,UAAU,GAAsB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACxF,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,6DAA6D;QAC7D,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,UAAU,CAAC;QAE3C,MAAM,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,oCAAgB,CAAC,6BAAS,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,MAAM,GAAW,IAAI,0BAAM,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEjD,OAAO,MAAW,CAAC;IACrB,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;CAEF;AAzGD,wDAyGC","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 { DOMParser } from \"@xmldom/xmldom\";\r\nimport {\r\n  ECObjectsError, ECObjectsStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType, SchemaReadHelper, XmlParser,\r\n} from \"@itwin/ecschema-metadata\";\r\nimport { SchemaStringLocater, StringSchemaKey } from \"./SchemaStringLocater\";\r\n\r\n/** @packageDocumentation\r\n * @module Locaters\r\n */\r\n\r\n/**\r\n * A SchemaLocator implementation for locating and deserializing EC Schemas from XML strings\r\n * loaded in memory.\r\n * @beta\r\n */\r\nexport class SchemaXmlStringLocater extends SchemaStringLocater implements ISchemaLocater {\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 string`);\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 string`);\r\n\r\n    const ecVersion = ECVersion.fromString(version[1]);\r\n    const key = new SchemaKey(name[1], ecVersion);\r\n    return key;\r\n  }\r\n\r\n  /**\r\n   * Attempts to retrieve a Schema with the given SchemaKey by searching the configured\r\n   * Schema strings.\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 and holds the schema's references, if they exist.\r\n   */\r\n  public async getSchema<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined> {\r\n    await this.getSchemaInfo(schemaKey, matchType, context);\r\n\r\n    const schema = await context.getCachedSchema(schemaKey, matchType);\r\n    return schema as T;\r\n  }\r\n\r\n  /**\r\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\r\n    * The fully loaded schema can be gotten later from the context using the getCachedSchema method.\r\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n    * @param matchType The match type to use when locating the schema\r\n    * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\r\n    */\r\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\r\n    // Grab all schema strings that match the schema key\r\n    const candidates: StringSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType);\r\n    if (!candidates || candidates.length === 0)\r\n      return undefined;\r\n\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\r\n    const schemaText = maxCandidate.schemaText;\r\n\r\n    const parser = new DOMParser();\r\n    const document = parser.parseFromString(schemaText);\r\n\r\n    const reader = new SchemaReadHelper(XmlParser, context);\r\n    const schema = new Schema(context);\r\n\r\n    return reader.readSchemaInfo(schema, document);\r\n  }\r\n\r\n  /**\r\n   * Attempts to retrieve a Schema with the given SchemaKey by searching the configured\r\n   * Schema strings.\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 and holds the schema's references, if they exist.\r\n   */\r\n  public getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined {\r\n    // Grab all schema strings that match the schema key\r\n    const candidates: StringSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType);\r\n    if (!candidates || candidates.length === 0)\r\n      return undefined;\r\n\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\r\n    const schemaText = maxCandidate.schemaText;\r\n\r\n    const parser = new DOMParser();\r\n    const document = parser.parseFromString(schemaText);\r\n\r\n    const reader = new SchemaReadHelper(XmlParser, context);\r\n    let schema: Schema = new Schema(context);\r\n    schema = reader.readSchemaSync(schema, document);\r\n\r\n    return schema as T;\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}\r\n"]}

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

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

package/lib/cjs/test/SchemaXmlStringLocater.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlStringLocater.test.d.ts","sourceRoot":"","sources":["../../../src/test/SchemaXmlStringLocater.test.ts"],"names":[],"mappings":""}

package/lib/cjs/test/SchemaXmlStringLocater.test.js

@@ -0,0 +1,221 @@
+"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 });
+const chai_1 = require("chai");
+const path = require("path");
+const fs = require("fs");
+const glob = require("glob");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const SchemaXmlStringLocater_1 = require("../SchemaXmlStringLocater");
+describe("SchemaXmlStringLocater tests:", () => {
+    let locater;
+    let context;
+    let schemaStrings;
+    const loadSchemaString = (schemaName) => {
+        const searchPath = path.join(__dirname, "assets", `${schemaName}.ecschema.xml`);
+        const file = fs.readFileSync(searchPath);
+        return file.toString();
+    };
+    const loadSchemaStrings = () => {
+        const schemas = [];
+        const searchPath = path.join(__dirname, "assets", "Schema*.ecschema.xml");
+        const result = new glob.GlobSync(searchPath, { sync: true });
+        for (const match of result.found) {
+            const file = fs.readFileSync(match);
+            if (!file)
+                continue;
+            schemas.push(file.toString());
+        }
+        return schemas;
+    };
+    beforeEach(() => {
+        schemaStrings = loadSchemaStrings();
+        locater = new SchemaXmlStringLocater_1.SchemaXmlStringLocater();
+        context = new ecschema_metadata_1.SchemaContext();
+        context.addLocater(locater);
+    });
+    it("locate valid schema with multiple references", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        const schemaKey = new ecschema_metadata_1.SchemaKey("SchemaA", 1, 1, 1);
+        const schema = await context.getSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact);
+        chai_1.assert.isDefined(schema);
+        chai_1.assert.strictEqual(schema.schemaKey.name, "SchemaA");
+        chai_1.assert.strictEqual(schema.schemaKey.version.toString(), "01.01.01");
+    });
+    it("locate valid schema with multiple references synchronously", () => {
+        locater.addSchemaStrings(schemaStrings);
+        const schemaKey = new ecschema_metadata_1.SchemaKey("SchemaA", 1, 1, 1);
+        const schema = context.getSchemaSync(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact);
+        chai_1.assert.isDefined(schema);
+        chai_1.assert.strictEqual(schema.schemaKey.name, "SchemaA");
+        chai_1.assert.strictEqual(schema.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchema called multiple times for same schema", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        const schemaKey = new ecschema_metadata_1.SchemaKey("SchemaD", 4, 4, 4);
+        const locater1 = await locater.getSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact, new ecschema_metadata_1.SchemaContext());
+        const locater2 = await locater.getSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact, new ecschema_metadata_1.SchemaContext());
+        const context1 = await context.getSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact);
+        const context2 = await context.getSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact);
+        // locater should not cache, but context should cache
+        chai_1.assert.notEqual(locater1, locater2);
+        chai_1.assert.notEqual(locater1, context1);
+        chai_1.assert.strictEqual(context1, context2);
+    });
+    it("getSchema which does not exist, returns undefined", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        const schemaKey = new ecschema_metadata_1.SchemaKey("DoesNotExist");
+        chai_1.assert.isUndefined(await locater.getSchema(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact, context));
+    });
+    it("addSchemaString, bad schema tag, throws", async () => {
+        const schemaString = loadSchemaString("BadSchemaTag");
+        try {
+            locater.addSchemaString(schemaString);
+        }
+        catch (e) {
+            const error = e;
+            chai_1.assert.strictEqual(error.errorNumber, ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML);
+            return;
+        }
+        chai_1.assert.fail(0, 1, "Expected ECObjects exception");
+    });
+    it("addSchemaString, bad schema name tag, throws", async () => {
+        const schemaString = loadSchemaString("BadSchemaNameTag");
+        try {
+            locater.addSchemaString(schemaString);
+        }
+        catch (e) {
+            const error = e;
+            chai_1.assert.strictEqual(error.errorNumber, ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML);
+            return;
+        }
+        chai_1.assert.fail(0, 1, "Expected ECObjects exception");
+    });
+    it("addSchemaString, bad schema version tag, throws", async () => {
+        const schemaString = loadSchemaString("BadSchemaVersionTag");
+        try {
+            locater.addSchemaString(schemaString);
+        }
+        catch (e) {
+            const error = e;
+            chai_1.assert.strictEqual(error.errorNumber, ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML);
+            return;
+        }
+        chai_1.assert.fail(0, 1, "Expected ECObjects exception");
+    });
+    it("getSchema, full version, succeeds", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        const stub = await locater.getSchema(new ecschema_metadata_1.SchemaKey("SchemaA", 1, 1, 1), ecschema_metadata_1.SchemaMatchType.Exact, context);
+        chai_1.assert.isDefined(stub);
+        const key = stub.schemaKey;
+        chai_1.assert.strictEqual(key.name, "SchemaA");
+        chai_1.assert.strictEqual(key.version.toString(), "01.01.01");
+    });
+    it("getSchema, reference does not exist, throws.", async () => {
+        const schemaString = loadSchemaString("RefDoesNotExist");
+        locater.addSchemaString(schemaString);
+        try {
+            await locater.getSchema(new ecschema_metadata_1.SchemaKey("RefDoesNotExist", 1, 1, 1), ecschema_metadata_1.SchemaMatchType.Exact, context);
+        }
+        catch (e) {
+            const error = e;
+            chai_1.assert.strictEqual(error.errorNumber, ecschema_metadata_1.ECObjectsStatus.UnableToLocateSchema);
+            return;
+        }
+        chai_1.assert.fail();
+    });
+    it("getSchema, references set", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        const schemaA = await context.getSchema(new ecschema_metadata_1.SchemaKey("SchemaA", 1, 1, 1), ecschema_metadata_1.SchemaMatchType.Exact);
+        const schemaB = await context.getSchema(new ecschema_metadata_1.SchemaKey("SchemaB", 2, 2, 2), ecschema_metadata_1.SchemaMatchType.Exact);
+        const schemaC = await context.getSchema(new ecschema_metadata_1.SchemaKey("SchemaC", 3, 3, 3), ecschema_metadata_1.SchemaMatchType.Exact);
+        const schemaD = await context.getSchema(new ecschema_metadata_1.SchemaKey("SchemaD", 4, 4, 4), ecschema_metadata_1.SchemaMatchType.Exact);
+        chai_1.assert.isDefined(schemaA);
+        chai_1.assert.strictEqual(schemaA.references.length, 2);
+        chai_1.assert.deepEqual(schemaA.references[0], schemaC);
+        chai_1.assert.deepEqual(schemaA.references[1], schemaB);
+        chai_1.assert.deepEqual(schemaA.references[0].references[0], schemaD);
+        chai_1.assert.deepEqual(schemaA.references[1].references[0], schemaC);
+        chai_1.assert.deepEqual(schemaA.references[1].references[1], schemaD);
+    });
+    it("getSchema, exact version, wrong minor, fails", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        chai_1.assert.isUndefined(await context.getSchema(new ecschema_metadata_1.SchemaKey("SchemaA", 1, 1, 2), ecschema_metadata_1.SchemaMatchType.Exact));
+    });
+    it("getSchema, latest, succeeds", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        const stub = await locater.getSchema(new ecschema_metadata_1.SchemaKey("SchemaA", 1, 1, 0), ecschema_metadata_1.SchemaMatchType.Latest, context);
+        chai_1.assert.isDefined(stub);
+        chai_1.assert.strictEqual(stub.schemaKey.name, "SchemaA");
+        chai_1.assert.strictEqual(stub.schemaKey.version.toString(), "02.00.02");
+    });
+    it("getSchema, latest write compatible, succeeds", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        const stub = await context.getSchema(new ecschema_metadata_1.SchemaKey("SchemaA", 1, 1, 0), ecschema_metadata_1.SchemaMatchType.LatestWriteCompatible);
+        chai_1.assert.isDefined(stub);
+        chai_1.assert.strictEqual(stub.schemaKey.name, "SchemaA");
+        chai_1.assert.strictEqual(stub.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchema, latest write compatible, write version wrong, fails", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        chai_1.assert.isUndefined(await context.getSchema(new ecschema_metadata_1.SchemaKey("SchemaA", 1, 2, 0), ecschema_metadata_1.SchemaMatchType.LatestWriteCompatible));
+    });
+    it("getSchema, latest read compatible, succeeds", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        const stub = await context.getSchema(new ecschema_metadata_1.SchemaKey("SchemaA", 1, 0, 0), ecschema_metadata_1.SchemaMatchType.LatestReadCompatible);
+        chai_1.assert.isDefined(stub);
+        chai_1.assert.strictEqual(stub.schemaKey.name, "SchemaA");
+        chai_1.assert.strictEqual(stub.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchema, latest read compatible, read version wrong, fails", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        chai_1.assert.isUndefined(await context.getSchema(new ecschema_metadata_1.SchemaKey("SchemaA", 2, 1, 1), ecschema_metadata_1.SchemaMatchType.LatestReadCompatible));
+    });
+    it("sync - should ignore commented out schema references", () => {
+        locater.addSchemaStrings(schemaStrings);
+        const schemaString = loadSchemaString("RefCommentedOut");
+        locater.addSchemaString(schemaString);
+        const stub = context.getSchemaSync(new ecschema_metadata_1.SchemaKey("RefCommentedOut", 1, 1, 1), ecschema_metadata_1.SchemaMatchType.LatestReadCompatible);
+        chai_1.assert.isDefined(stub);
+        chai_1.assert.strictEqual(stub.schemaKey.name, "RefCommentedOut");
+        chai_1.assert.strictEqual(stub.schemaKey.version.toString(), "01.01.01");
+    });
+    it("async - should ignore commented out schema references", async () => {
+        locater.addSchemaStrings(schemaStrings);
+        const schemaString = loadSchemaString("RefCommentedOut");
+        locater.addSchemaString(schemaString);
+        const stub = await context.getSchema(new ecschema_metadata_1.SchemaKey("RefCommentedOut", 1, 1, 1), ecschema_metadata_1.SchemaMatchType.LatestReadCompatible);
+        chai_1.assert.isDefined(stub);
+        chai_1.assert.strictEqual(stub.schemaKey.name, "RefCommentedOut");
+        chai_1.assert.strictEqual(stub.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchemaKey, valid version and name, succeeds", () => {
+        const schemaXml = `<ECSchema schemaName="SchemaA" version="1.1.1"> </ECSchema>`;
+        const key = locater.getSchemaKey(schemaXml);
+        chai_1.assert.deepEqual(key, new ecschema_metadata_1.SchemaKey("SchemaA", new ecschema_metadata_1.ECVersion(1, 1, 1)));
+    });
+    it("getSchemaKey, invalid xml, throws", () => {
+        const schemaXml = `<ECSchemaBad schemaName="SchemaA" version="1.1.1"> </ECSchemaBad>`;
+        (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(ecschema_metadata_1.ECObjectsError, `Could not find '<ECSchema>' tag in the given string`);
+    });
+    it("getSchemaKey, invalid schemaName attribute, throws", () => {
+        const schemaXml = `<ECSchema schemaNameBad="SchemaA" version="1.1.1"> </ECSchema>`;
+        (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(ecschema_metadata_1.ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);
+    });
+    it("getSchemaKey, invalid schemaName, throws", () => {
+        const schemaXml = `<ECSchema version="1.1.1" schemaName=""> </ECSchema>`;
+        (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(ecschema_metadata_1.ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);
+    });
+    it("getSchemaKey, invalid version attribute, throws", () => {
+        const schemaXml = `<ECSchema schemaName="SchemaA" versionBad="1.1.1"> </ECSchema>`;
+        (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(ecschema_metadata_1.ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);
+    });
+    it("getSchemaKey, invalid version, throws", () => {
+        const schemaXml = `<ECSchema schemaName="SchemaA" version=""> </ECSchema>`;
+        (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(ecschema_metadata_1.ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);
+    });
+});
+//# sourceMappingURL=SchemaXmlStringLocater.test.js.map

package/lib/cjs/test/SchemaXmlStringLocater.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlStringLocater.test.js","sourceRoot":"","sources":["../../../src/test/SchemaXmlStringLocater.test.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;AAE/F,+BAAsC;AACtC,6BAA6B;AAC7B,yBAAyB;AACzB,6BAA6B;AAC7B,gEAAiI;AACjI,sEAAmE;AAGnE,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,IAAI,OAA+B,CAAC;IACpC,IAAI,OAAsB,CAAC;IAC3B,IAAI,aAAwB,CAAC;IAE7B,MAAM,gBAAgB,GAAG,CAAC,UAAkB,EAAE,EAAE;QAC9C,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,UAAU,eAAe,CAAC,CAAC;QAChF,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC,CAAC;IAEF,MAAM,iBAAiB,GAAG,GAAG,EAAE;QAC7B,MAAM,OAAO,GAAc,EAAE,CAAC;QAC9B,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,sBAAsB,CAAC,CAAC;QAC1E,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE;YAChC,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI;gBACP,SAAS;YACX,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;SAC/B;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,aAAa,GAAG,iBAAiB,EAAE,CAAC;QACpC,OAAO,GAAG,IAAI,+CAAsB,EAAE,CAAC;QACvC,OAAO,GAAG,IAAI,iCAAa,EAAE,CAAC;QAC9B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC;QAEzE,aAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACzB,aAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtD,aAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC;QAEvE,aAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACzB,aAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtD,aAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAEpD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,KAAK,EAAE,IAAI,iCAAa,EAAE,CAAC,CAAC;QAChG,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,KAAK,EAAE,IAAI,iCAAa,EAAE,CAAC,CAAC;QAChG,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC;QAE3E,qDAAqD;QACrD,aAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,aAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,aAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,SAAS,GAAG,IAAI,6BAAS,CAAC,cAAc,CAAC,CAAC;QAEhD,aAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,mCAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,YAAY,GAAG,gBAAgB,CAAC,cAAc,CAAC,CAAC;QACtD,IAAI;YACF,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;SACvC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,KAAK,GAAG,CAAmB,CAAC;YAClC,aAAM,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,mCAAe,CAAC,gBAAgB,CAAC,CAAC;YACxE,OAAO;SACR;QAED,aAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,8BAA8B,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,YAAY,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,CAAC;QAC1D,IAAI;YACF,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;SACvC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,KAAK,GAAG,CAAmB,CAAC;YAClC,aAAM,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,mCAAe,CAAC,gBAAgB,CAAC,CAAC;YACxE,OAAO;SACR;QAED,aAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,8BAA8B,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,YAAY,GAAG,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;QAC7D,IAAI;YACF,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;SACvC;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,KAAK,GAAG,CAAmB,CAAC;YAClC,aAAM,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,mCAAe,CAAC,gBAAgB,CAAC,CAAC;YACxE,OAAO;SACR;QAED,aAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,8BAA8B,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACxG,aAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,GAAG,GAAG,IAAK,CAAC,SAA4B,CAAC;QAC/C,aAAM,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACxC,aAAM,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,YAAY,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QACzD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACtC,IAAI;YACF,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;SACpG;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,KAAK,GAAG,CAAmB,CAAC;YAClC,aAAM,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,mCAAe,CAAC,oBAAoB,CAAC,CAAC;YAC5E,OAAO;SACR;QAED,aAAM,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC;QAClG,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC;QAClG,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC;QAClG,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC;QAElG,aAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC1B,aAAM,CAAC,WAAW,CAAC,OAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClD,aAAM,CAAC,SAAS,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAClD,aAAM,CAAC,SAAS,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAClD,aAAM,CAAC,SAAS,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAChE,aAAM,CAAC,SAAS,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAChE,aAAM,CAAC,SAAS,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,aAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IACxG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzG,aAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,aAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpD,aAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,qBAAqB,CAAC,CAAC;QAE/G,aAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,aAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpD,aAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,aAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACxH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,oBAAoB,CAAC,CAAC;QAE9G,aAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,aAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpD,aAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,aAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACvH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,YAAY,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QACzD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEtC,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,6BAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,oBAAoB,CAAC,CAAC;QAEpH,aAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,aAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;QAC5D,aAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,YAAY,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QACzD,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QAEtC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,6BAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,mCAAe,CAAC,oBAAoB,CAAC,CAAC;QAEtH,aAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,aAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;QAC5D,aAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,SAAS,GAAG,6DAA6D,CAAC;QAChF,MAAM,GAAG,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC5C,aAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,6BAAS,CAAC,SAAS,EAAE,IAAI,6BAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,SAAS,GAAG,mEAAmE,CAAC;QACtF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kCAAc,EAAE,qDAAqD,CAAC,CAAC;IAChI,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,SAAS,GAAG,gEAAgE,CAAC;QACnF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kCAAc,EAAE,+EAA+E,CAAC,CAAC;IAC1J,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,SAAS,GAAG,sDAAsD,CAAC;QACzE,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kCAAc,EAAE,+EAA+E,CAAC,CAAC;IAC1J,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,SAAS,GAAG,gEAAgE,CAAC;QACnF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kCAAc,EAAE,+EAA+E,CAAC,CAAC;IAC1J,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,SAAS,GAAG,wDAAwD,CAAC;QAC3E,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,kCAAc,EAAE,+EAA+E,CAAC,CAAC;IAC1J,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","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 { assert, expect } from \"chai\";\r\nimport * as path from \"path\";\r\nimport * as fs from \"fs\";\r\nimport * as glob from \"glob\";\r\nimport { ECObjectsError, ECObjectsStatus, ECVersion, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\nimport { SchemaXmlStringLocater } from \"../SchemaXmlStringLocater\";\r\nimport { StringSchemaKey } from \"../SchemaStringLocater\";\r\n\r\ndescribe(\"SchemaXmlStringLocater tests:\", () => {\r\n  let locater: SchemaXmlStringLocater;\r\n  let context: SchemaContext;\r\n  let schemaStrings: string [];\r\n\r\n  const loadSchemaString = (schemaName: string) => {\r\n    const searchPath = path.join(__dirname, \"assets\", `${schemaName}.ecschema.xml`);\r\n    const file = fs.readFileSync(searchPath);\r\n    return file.toString();\r\n  };\r\n\r\n  const loadSchemaStrings = () => {\r\n    const schemas: string [] = [];\r\n    const searchPath = path.join(__dirname, \"assets\", \"Schema*.ecschema.xml\");\r\n    const result = new glob.GlobSync(searchPath, { sync: true });\r\n    for (const match of result.found) {\r\n      const file = fs.readFileSync(match);\r\n      if (!file)\r\n        continue;\r\n      schemas.push(file.toString());\r\n    }\r\n    return schemas;\r\n  };\r\n\r\n  beforeEach(() => {\r\n    schemaStrings = loadSchemaStrings();\r\n    locater = new SchemaXmlStringLocater();\r\n    context = new SchemaContext();\r\n    context.addLocater(locater);\r\n  });\r\n\r\n  it(\"locate valid schema with multiple references\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    const schemaKey = new SchemaKey(\"SchemaA\", 1, 1, 1);\r\n    const schema = await context.getSchema(schemaKey, SchemaMatchType.Exact);\r\n\r\n    assert.isDefined(schema);\r\n    assert.strictEqual(schema!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(schema!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"locate valid schema with multiple references synchronously\", () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    const schemaKey = new SchemaKey(\"SchemaA\", 1, 1, 1);\r\n    const schema = context.getSchemaSync(schemaKey, SchemaMatchType.Exact);\r\n\r\n    assert.isDefined(schema);\r\n    assert.strictEqual(schema!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(schema!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema called multiple times for same schema\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    const schemaKey = new SchemaKey(\"SchemaD\", 4, 4, 4);\r\n\r\n    const locater1 = await locater.getSchema(schemaKey, SchemaMatchType.Exact, new SchemaContext());\r\n    const locater2 = await locater.getSchema(schemaKey, SchemaMatchType.Exact, new SchemaContext());\r\n    const context1 = await context.getSchema(schemaKey, SchemaMatchType.Exact);\r\n    const context2 = await context.getSchema(schemaKey, SchemaMatchType.Exact);\r\n\r\n    // locater should not cache, but context should cache\r\n    assert.notEqual(locater1, locater2);\r\n    assert.notEqual(locater1, context1);\r\n    assert.strictEqual(context1, context2);\r\n  });\r\n\r\n  it(\"getSchema which does not exist, returns undefined\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    const schemaKey = new SchemaKey(\"DoesNotExist\");\r\n\r\n    assert.isUndefined(await locater.getSchema(schemaKey, SchemaMatchType.Exact, context));\r\n  });\r\n\r\n  it(\"addSchemaString, bad schema tag, throws\", async () => {\r\n    const schemaString = loadSchemaString(\"BadSchemaTag\");\r\n    try {\r\n      locater.addSchemaString(schemaString);\r\n    } catch (e) {\r\n      const error = e as ECObjectsError;\r\n      assert.strictEqual(error.errorNumber, ECObjectsStatus.InvalidSchemaXML);\r\n      return;\r\n    }\r\n\r\n    assert.fail(0, 1, \"Expected ECObjects exception\");\r\n  });\r\n\r\n  it(\"addSchemaString, bad schema name tag, throws\", async () => {\r\n    const schemaString = loadSchemaString(\"BadSchemaNameTag\");\r\n    try {\r\n      locater.addSchemaString(schemaString);\r\n    } catch (e) {\r\n      const error = e as ECObjectsError;\r\n      assert.strictEqual(error.errorNumber, ECObjectsStatus.InvalidSchemaXML);\r\n      return;\r\n    }\r\n\r\n    assert.fail(0, 1, \"Expected ECObjects exception\");\r\n  });\r\n\r\n  it(\"addSchemaString, bad schema version tag, throws\", async () => {\r\n    const schemaString = loadSchemaString(\"BadSchemaVersionTag\");\r\n    try {\r\n      locater.addSchemaString(schemaString);\r\n    } catch (e) {\r\n      const error = e as ECObjectsError;\r\n      assert.strictEqual(error.errorNumber, ECObjectsStatus.InvalidSchemaXML);\r\n      return;\r\n    }\r\n\r\n    assert.fail(0, 1, \"Expected ECObjects exception\");\r\n  });\r\n\r\n  it(\"getSchema, full version, succeeds\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    const stub = await locater.getSchema(new SchemaKey(\"SchemaA\", 1, 1, 1), SchemaMatchType.Exact, context);\r\n    assert.isDefined(stub);\r\n    const key = stub!.schemaKey as StringSchemaKey;\r\n    assert.strictEqual(key.name, \"SchemaA\");\r\n    assert.strictEqual(key.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema, reference does not exist, throws.\", async () => {\r\n    const schemaString = loadSchemaString(\"RefDoesNotExist\");\r\n    locater.addSchemaString(schemaString);\r\n    try {\r\n      await locater.getSchema(new SchemaKey(\"RefDoesNotExist\", 1, 1, 1), SchemaMatchType.Exact, context);\r\n    } catch (e) {\r\n      const error = e as ECObjectsError;\r\n      assert.strictEqual(error.errorNumber, ECObjectsStatus.UnableToLocateSchema);\r\n      return;\r\n    }\r\n\r\n    assert.fail();\r\n  });\r\n\r\n  it(\"getSchema, references set\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n\r\n    const schemaA = await context.getSchema(new SchemaKey(\"SchemaA\", 1, 1, 1), SchemaMatchType.Exact);\r\n    const schemaB = await context.getSchema(new SchemaKey(\"SchemaB\", 2, 2, 2), SchemaMatchType.Exact);\r\n    const schemaC = await context.getSchema(new SchemaKey(\"SchemaC\", 3, 3, 3), SchemaMatchType.Exact);\r\n    const schemaD = await context.getSchema(new SchemaKey(\"SchemaD\", 4, 4, 4), SchemaMatchType.Exact);\r\n\r\n    assert.isDefined(schemaA);\r\n    assert.strictEqual(schemaA!.references.length, 2);\r\n    assert.deepEqual(schemaA!.references[0], schemaC);\r\n    assert.deepEqual(schemaA!.references[1], schemaB);\r\n    assert.deepEqual(schemaA!.references[0].references[0], schemaD);\r\n    assert.deepEqual(schemaA!.references[1].references[0], schemaC);\r\n    assert.deepEqual(schemaA!.references[1].references[1], schemaD);\r\n  });\r\n\r\n  it(\"getSchema, exact version, wrong minor, fails\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    assert.isUndefined(await context.getSchema(new SchemaKey(\"SchemaA\", 1, 1, 2), SchemaMatchType.Exact));\r\n  });\r\n\r\n  it(\"getSchema, latest, succeeds\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    const stub = await locater.getSchema(new SchemaKey(\"SchemaA\", 1, 1, 0), SchemaMatchType.Latest, context);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"02.00.02\");\r\n  });\r\n\r\n  it(\"getSchema, latest write compatible, succeeds\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    const stub = await context.getSchema(new SchemaKey(\"SchemaA\", 1, 1, 0), SchemaMatchType.LatestWriteCompatible);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema, latest write compatible, write version wrong, fails\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    assert.isUndefined(await context.getSchema(new SchemaKey(\"SchemaA\", 1, 2, 0), SchemaMatchType.LatestWriteCompatible));\r\n  });\r\n\r\n  it(\"getSchema, latest read compatible, succeeds\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    const stub = await context.getSchema(new SchemaKey(\"SchemaA\", 1, 0, 0), SchemaMatchType.LatestReadCompatible);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema, latest read compatible, read version wrong, fails\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    assert.isUndefined(await context.getSchema(new SchemaKey(\"SchemaA\", 2, 1, 1), SchemaMatchType.LatestReadCompatible));\r\n  });\r\n\r\n  it(\"sync - should ignore commented out schema references\", () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    const schemaString = loadSchemaString(\"RefCommentedOut\");\r\n    locater.addSchemaString(schemaString);\r\n\r\n    const stub = context.getSchemaSync(new SchemaKey(\"RefCommentedOut\", 1, 1, 1), SchemaMatchType.LatestReadCompatible);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"RefCommentedOut\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"async - should ignore commented out schema references\", async () => {\r\n    locater.addSchemaStrings(schemaStrings);\r\n    const schemaString = loadSchemaString(\"RefCommentedOut\");\r\n    locater.addSchemaString(schemaString);\r\n\r\n    const stub = await context.getSchema(new SchemaKey(\"RefCommentedOut\", 1, 1, 1), SchemaMatchType.LatestReadCompatible);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"RefCommentedOut\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchemaKey, valid version and name, succeeds\", () => {\r\n    const schemaXml = `<ECSchema schemaName=\"SchemaA\" version=\"1.1.1\"> </ECSchema>`;\r\n    const key = locater.getSchemaKey(schemaXml);\r\n    assert.deepEqual(key, new SchemaKey(\"SchemaA\", new ECVersion(1, 1, 1)));\r\n  });\r\n\r\n  it(\"getSchemaKey, invalid xml, throws\", () => {\r\n    const schemaXml = `<ECSchemaBad schemaName=\"SchemaA\" version=\"1.1.1\"> </ECSchemaBad>`;\r\n    expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find '<ECSchema>' tag in the given string`);\r\n  });\r\n\r\n  it(\"getSchemaKey, invalid schemaName attribute, throws\", () => {\r\n    const schemaXml = `<ECSchema schemaNameBad=\"SchemaA\" version=\"1.1.1\"> </ECSchema>`;\r\n    expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);\r\n  });\r\n\r\n  it(\"getSchemaKey, invalid schemaName, throws\", () => {\r\n    const schemaXml = `<ECSchema version=\"1.1.1\" schemaName=\"\"> </ECSchema>`;\r\n    expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);\r\n  });\r\n\r\n  it(\"getSchemaKey, invalid version attribute, throws\", () => {\r\n    const schemaXml = `<ECSchema schemaName=\"SchemaA\" versionBad=\"1.1.1\"> </ECSchema>`;\r\n    expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);\r\n  });\r\n\r\n  it(\"getSchemaKey, invalid version, throws\", () => {\r\n    const schemaXml = `<ECSchema schemaName=\"SchemaA\" version=\"\"> </ECSchema>`;\r\n    expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);\r\n  });\r\n});\r\n\r\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/ecschema-locaters",
-  "version": "4.1.0-dev.75",
+  "version": "4.1.0-dev.76",
   "description": "EC Schema file locaters",
   "license": "MIT",
   "main": "lib/cjs/ecschema-locaters.js",
@@ -54,8 +54,8 @@
     "rimraf": "^3.0.2",
     "sinon": "^15.0.4",
     "typescript": "~5.0.2",
-    "@itwin/build-tools": "4.1.0-dev.75",
-    "@itwin/ecschema-metadata": "4.1.0-dev.75"
+    "@itwin/build-tools": "4.1.0-dev.76",
+    "@itwin/ecschema-metadata": "4.1.0-dev.76"
   },
   "dependencies": {
     "glob": "^7.1.2",
@@ -63,7 +63,7 @@
     "@xmldom/xmldom": "~0.8.5"
   },
   "peerDependencies": {
-    "@itwin/ecschema-metadata": "^4.1.0-dev.75"
+    "@itwin/ecschema-metadata": "^4.1.0-dev.76"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc",