@itwin/ecschema-locaters 5.0.0-dev.11 → 5.0.0-dev.111

package/lib/esm/SchemaXmlStringLocater.d.ts

@@ -0,0 +1,48 @@
+/** @packageDocumentation
+ * @module Locaters
+ */
+import { ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaStringLocater } from "./SchemaStringLocater";
+/**
+ * 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(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by 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: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | 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/esm/SchemaXmlStringLocater.d.ts.map

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

package/lib/esm/SchemaXmlStringLocater.js

@@ -0,0 +1,100 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Locaters
+ */
+import { DOMParser } from "@xmldom/xmldom";
+import { ECSchemaError, ECSchemaStatus, ECVersion, Schema, SchemaKey, SchemaReadHelper, XmlParser, } from "@itwin/ecschema-metadata";
+import { SchemaStringLocater } from "./SchemaStringLocater";
+/**
+ * A SchemaLocator implementation for locating and deserializing EC Schemas from XML strings
+ * loaded in memory.
+ * @beta
+ */
+export class SchemaXmlStringLocater extends 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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);
+        const ecVersion = ECVersion.fromString(version[1]);
+        const key = new 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;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaText = maxCandidate.schemaText;
+        const parser = new DOMParser();
+        const document = parser.parseFromString(schemaText);
+        const reader = new SchemaReadHelper(XmlParser, context);
+        const schema = new 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;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaText = maxCandidate.schemaText;
+        const parser = new DOMParser();
+        const document = parser.parseFromString(schemaText);
+        const reader = new SchemaReadHelper(XmlParser, context);
+        let schema = new 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 ECSchemaError(ECSchemaStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);
+        if (!minor)
+            throw new ECSchemaError(ECSchemaStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);
+        return new ECVersion(+read, 0, +minor);
+    }
+}
+//# sourceMappingURL=SchemaXmlStringLocater.js.map

package/lib/esm/SchemaXmlStringLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlStringLocater.js","sourceRoot":"","sources":["../../src/SchemaXmlStringLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACL,aAAa,EAAE,cAAc,EAAE,SAAS,EAAkB,MAAM,EAA6B,SAAS,EAAmB,gBAAgB,EAAE,SAAS,GACrJ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAmB,MAAM,uBAAuB,CAAC;AAE7E;;;;GAIG;AACH,MAAM,OAAO,sBAAuB,SAAQ,mBAAmB;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,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,qDAAqD,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,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,+EAA+E,CAAC,CAAC;QAE5I,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAC9C,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7F,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAExD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnE,OAAO,MAAgB,CAAC;IAC1B,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,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,SAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC3F,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,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,SAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,MAAM,GAAW,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEjD,OAAO,MAAM,CAAC;IAChB,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,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,oDAAoD,aAAa,EAAE,CAAC,CAAC;QAEhI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEjI,OAAO,IAAI,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CAEF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Locaters\n */\n\nimport { DOMParser } from \"@xmldom/xmldom\";\nimport {\n  ECSchemaError, ECSchemaStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType, SchemaReadHelper, XmlParser,\n} from \"@itwin/ecschema-metadata\";\nimport { SchemaStringLocater, StringSchemaKey } from \"./SchemaStringLocater\";\n\n/**\n * A SchemaLocator implementation for locating and deserializing EC Schemas from XML strings\n * loaded in memory.\n * @beta\n */\nexport class SchemaXmlStringLocater extends SchemaStringLocater implements ISchemaLocater {\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 ECSchemaError(ECSchemaStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given string`);\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 ECSchemaError(ECSchemaStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);\n\n    const ecVersion = ECVersion.fromString(version[1]);\n    const key = new SchemaKey(name[1], ecVersion);\n    return key;\n  }\n\n  /**\n   * Attempts to retrieve a Schema with the given SchemaKey by searching the configured\n   * Schema strings.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n   */\n  public async getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    await this.getSchemaInfo(schemaKey, matchType, context);\n\n    const schema = await context.getCachedSchema(schemaKey, matchType);\n    return schema as Schema;\n  }\n\n  /**\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\n    * The fully loaded schema can be gotten later from the context using the getCachedSchema method.\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\n    * @param matchType The match type to use when locating the schema\n    * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n    */\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    // Grab all schema strings that match the schema key\n    const candidates: StringSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType);\n    if (!candidates || candidates.length === 0)\n      return undefined;\n\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\n    const schemaText = maxCandidate.schemaText;\n\n    const parser = new DOMParser();\n    const document = parser.parseFromString(schemaText);\n\n    const reader = new SchemaReadHelper(XmlParser, context);\n    const schema = new Schema(context);\n\n    return reader.readSchemaInfo(schema, document);\n  }\n\n  /**\n   * Attempts to retrieve a Schema with the given SchemaKey by searching the configured\n   * Schema strings.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n   */\n  public getSchemaSync(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined {\n    // Grab all schema strings that match the schema key\n    const candidates: StringSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType);\n    if (!candidates || candidates.length === 0)\n      return undefined;\n\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\n    const schemaText = maxCandidate.schemaText;\n\n    const parser = new DOMParser();\n    const document = parser.parseFromString(schemaText);\n\n    const reader = new SchemaReadHelper(XmlParser, context);\n    let schema: Schema = new Schema(context);\n    schema = reader.readSchemaSync(schema, document);\n\n    return schema;\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 ECSchemaError(ECSchemaStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);\n\n    if (!minor)\n      throw new ECSchemaError(ECSchemaStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);\n\n    return new ECVersion(+read, 0, +minor);\n  }\n\n}\n"]}

package/lib/esm/StubSchemaXmlFileLocater.d.ts

@@ -0,0 +1,81 @@
+/** @packageDocumentation
+ * @module Locaters
+ */
+import { ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaFileLocater } from "./SchemaFileLocater";
+/**
+ * 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
+ */
+export declare class StubSchemaXmlFileLocater extends SchemaFileLocater implements ISchemaLocater {
+    /**
+     * 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: string, schemaText?: string): 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.
+     */
+    getSchema(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    getSchemaInfo(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
+     * to locate the 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: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined;
+    /**
+     * Constructs a SchemaKey based on the information in the Schema XML.
+     * @param schemaXml The Schema XML as a string.
+     */
+    getSchemaKey(schemaXml: string): SchemaKey;
+    /**
+     * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.
+     * @param xmlSchemaKey The SchemaKey of the parent Schema containing the references.
+     */
+    private getSchemaReferenceKeys;
+    /**
+     * 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.
+     */
+    private addSchemaReferences;
+    /**
+     * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.
+     * @param data The Schema XML string.
+     */
+    private _getSchemaReferenceKeys;
+    /**
+     * Gets the Schema alias from the Schema XML.
+     * @param data The Schema XML as a string.
+     */
+    private getSchemaAlias;
+    /**
+     * 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=StubSchemaXmlFileLocater.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"StubSchemaXmlFileLocater.d.ts","sourceRoot":"","sources":["../../src/StubSchemaXmlFileLocater.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EACqC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EACxH,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAMvE;;;;;GAKG;AACH,qBAAa,wBAAyB,SAAQ,iBAAkB,YAAW,cAAc;IACvF;;;;;OAKG;IACI,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM;IAiBlE;;;;;;;OAOG;IACU,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAIvH;;;;;;QAMI;IACS,aAAa,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAI/H;;;;;;;OAOG;IACI,aAAa,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;IAe5G;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IAoBjD;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAI9B;;;;;;OAMG;IACH,OAAO,CAAC,mBAAmB;IAY3B;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAkC/B;;;OAGG;IACH,OAAO,CAAC,cAAc;IAgBtB;;;;OAIG;IACH,OAAO,CAAC,cAAc;CAWvB"}

package/lib/esm/StubSchemaXmlFileLocater.js

@@ -0,0 +1,184 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Locaters
+ */
+import * as path from "path";
+import { ECSchemaError, ECSchemaStatus, ECVersion, Schema, SchemaContext, SchemaKey, SchemaMatchType, } from "@itwin/ecschema-metadata";
+import { FileSchemaKey, SchemaFileLocater } from "./SchemaFileLocater";
+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
+ */
+export class StubSchemaXmlFileLocater extends 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 ECSchemaError(ECSchemaStatus.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 SchemaContext();
+        context.addLocater(this);
+        // Load the schema and return it
+        const schema = new Schema(context, new FileSchemaKey(key, schemaPath, schemaText), alias);
+        this.addSchemaReferences(schema, context, 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);
+    }
+    /**
+      * 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(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];
+        const alias = this.getSchemaAlias(maxCandidate.schemaText);
+        const schema = new Schema(context, maxCandidate, alias);
+        context.addSchemaSync(schema);
+        this.addSchemaReferences(schema, context, 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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.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 = ECVersion.fromString(version[1]);
+        const key = new 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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.UnableToLocateSchema, `Could not locate the schema file, ${xmlSchemaKey.fileName}, for the schema ${xmlSchemaKey.name}`);
+        const data = file.toString().replace(/(\s*)<!--[\s\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 ECSchemaError(ECSchemaStatus.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 SchemaKey(name[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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);
+        if (!minor)
+            throw new ECSchemaError(ECSchemaStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);
+        return new ECVersion(+read, 0, +minor);
+    }
+}
+//# sourceMappingURL=StubSchemaXmlFileLocater.js.map

package/lib/esm/StubSchemaXmlFileLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StubSchemaXmlFileLocater.js","sourceRoot":"","sources":["../../src/StubSchemaXmlFileLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EACL,aAAa,EAAE,cAAc,EAAE,SAAS,EAAkB,MAAM,EAAE,aAAa,EAAc,SAAS,EAAE,eAAe,GACxH,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEvE,SAAS,YAAY,CAAC,UAAkB;IACtC,OAAO,mCAAmC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;GAKG;AACH,MAAM,OAAO,wBAAyB,SAAQ,iBAAiB;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,aAAa,CAAC,cAAc,CAAC,oBAAoB,EAAE,uCAAuC,UAAU,EAAE,CAAC,CAAC;QAEpH,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,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEzB,gCAAgC;QAChC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,EAAE,IAAI,aAAa,CAAC,GAAG,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,KAAK,CAAC,CAAC;QAC1F,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,eAAe,CAAC,qBAAqB,CAAC,CAAC;QACjF,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CAAC,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACvF,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,aAAa,CAAC,GAAc,EAAE,SAA0B,EAAE,OAAsB;QAC3F,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAe,CAAC;IACnE,CAAC;IAED;;;;;;;OAOG;IACI,aAAa,CAAC,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACrF,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;QAC5F,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,UAAW,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC;QACxD,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAE9B,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE,OAAO,EAAE,eAAe,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,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;QAEhH,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,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,6EAA6E,CAAC,CAAC;QAE1I,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,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/C,MAAM,GAAG,GAAG,IAAI,SAAS,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,CAAC;YAC1B,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,aAAa,CAAC,cAAc,CAAC,oBAAoB,EAAE,uCAAuC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC;YAE7K,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,uBAAuB,CAAC,YAA2B;QACzD,MAAM,IAAI,GAAG,YAAY,CAAC,UAAU,CAAC;QAErC,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,oBAAoB,EAAE,qCAAqC,YAAY,CAAC,QAAQ,oBAAoB,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;QAElK,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC,CAAC,2EAA2E;QAEhJ,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,CAAC;YAC5B,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,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,8DAA8D,CAAC,CAAC;YAE3H,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,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;YACxE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACK,cAAc,CAAC,SAAiB;QACtC,IAAI,KAAU,CAAC;QAEf,IAAI,YAAY,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5B,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,4CAA4C,CAAQ,CAAC;QAC/E,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,kCAAkC,CAAQ,CAAC;QACrE,CAAC;QAED,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YAClC,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,4DAA4D,CAAC,CAAC;QACzH,CAAC;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,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,oDAAoD,aAAa,EAAE,CAAC,CAAC;QAEhI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,aAAa,CAAC,cAAc,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEjI,OAAO,IAAI,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Locaters\n */\n\nimport * as path from \"path\";\nimport {\n  ECSchemaError, ECSchemaStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType,\n} from \"@itwin/ecschema-metadata\";\nimport { FileSchemaKey, SchemaFileLocater } from \"./SchemaFileLocater\";\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 ECSchemaError(ECSchemaStatus.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(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    return this.getSchemaSync(key, matchType, context);\n  }\n\n  /**\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\n    * The fully loaded schema can be gotten later from the context using the getCachedSchema method.\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\n    * @param matchType The match type to use when locating the schema\n    * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n    */\n  public async getSchemaInfo(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    return this.getSchemaSync(key, matchType, context) as SchemaInfo;\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(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | 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];\n    const alias = this.getSchemaAlias(maxCandidate.schemaText!);\n    const schema = new Schema(context, maxCandidate, alias);\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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.UnableToLocateSchema, `Could not locate the schema file, ${xmlSchemaKey.fileName}, for the schema ${xmlSchemaKey.name}`);\n\n    const data = file.toString().replace(/(\\s*)<!--[\\s\\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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.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 ECSchemaError(ECSchemaStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);\n\n    if (!minor)\n      throw new ECSchemaError(ECSchemaStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);\n\n    return new ECVersion(+read, 0, +minor);\n  }\n}\n"]}

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

@@ -0,0 +1,20 @@
+export * from "./SchemaFileLocater";
+export * from "./SchemaXml";
+export * from "./SchemaJsonFileLocater";
+export * from "./SchemaXmlFileLocater";
+export * from "./StubSchemaXmlFileLocater";
+export * from "./SchemaXmlStringLocater";
+/** @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/esm/ecschema-locaters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecschema-locaters.d.ts","sourceRoot":"","sources":["../../src/ecschema-locaters.ts"],"names":[],"mappings":"AAKA,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AAEzC;;;;GAIG;AACH;;;GAGG;AACH;;;GAGG"}

package/lib/esm/ecschema-locaters.js

@@ -0,0 +1,24 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+export * from "./SchemaFileLocater";
+export * from "./SchemaXml";
+export * from "./SchemaJsonFileLocater";
+export * from "./SchemaXmlFileLocater";
+export * from "./StubSchemaXmlFileLocater";
+export * from "./SchemaXmlStringLocater";
+/** @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/esm/ecschema-locaters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ecschema-locaters.js","sourceRoot":"","sources":["../../src/ecschema-locaters.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,0BAA0B,CAAC;AAEzC;;;;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 \"./SchemaXml\";\nexport * from \"./SchemaJsonFileLocater\";\nexport * from \"./SchemaXmlFileLocater\";\nexport * from \"./StubSchemaXmlFileLocater\";\nexport * from \"./SchemaXmlStringLocater\";\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/esm/test/ConcurrentGetSchemaJson.test.d.ts

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

package/lib/esm/test/ConcurrentGetSchemaJson.test.d.ts.map

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