@itwin/ecschema-locaters 5.0.0-dev.9 → 5.0.0-dev.92

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 { ECObjectsError, ECObjectsStatus, 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 ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to locate schema XML file at ${schemaPath}`);
+        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
+        const key = this.getSchemaKey(schemaText);
+        const alias = this.getSchemaAlias(schemaText);
+        const context = new 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 ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given file`);
+        const name = matches[0].match(/schemaName="(.+?)"/);
+        const version = matches[0].match(/version="(.+?)"/);
+        if (!name || name.length !== 2 || !version || version.length !== 2)
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
+        let ecVersion;
+        if (isECv2Schema(schemaXml))
+            ecVersion = this.fromECv2String(version[1]);
+        else
+            ecVersion = 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 ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to locate referenced schema: ${key.name}.${key.readVersion}.${key.writeVersion}.${key.minorVersion}`);
+            schema.references.push(refSchema);
+        }
+    }
+    /**
+     * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.
+     * @param data The Schema XML string.
+     */
+    _getSchemaReferenceKeys(xmlSchemaKey) {
+        const file = xmlSchemaKey.schemaText;
+        if (!file)
+            throw new ECObjectsError(ECObjectsStatus.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 ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Invalid ECSchemaReference xml encountered in the schema file`);
+            // write version maybe missing, so insert "0"
+            let versionString = versionMatch[1];
+            const versionParts = versionString.split(".");
+            if (versionParts.length === 2)
+                versionParts.splice(1, 0, "0");
+            versionString = versionParts.join(".");
+            const key = new 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 ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'alias' tag in the given file.`);
+        }
+        return match.groups.alias;
+    }
+    /**
+     * Parses a valid EC 2.0 version string and returns an ECVersion object. The second digit becomes the minor version,
+     * and a zero is inserted as the 'write' digit. Example: "1.1" -> "1.0.1".
+     * @param versionString A valid EC 2.0 version string of the format, 'RR.mm'.
+     */
+    fromECv2String(versionString) {
+        const [read, minor] = versionString.split(".");
+        if (!read)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);
+        if (!minor)
+            throw new ECObjectsError(ECObjectsStatus.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,cAAc,EAAE,eAAe,EAAE,SAAS,EAAkB,MAAM,EAAE,aAAa,EAAc,SAAS,EAAE,eAAe,GAC1H,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,cAAc,CAAC,eAAe,CAAC,oBAAoB,EAAE,uCAAuC,UAAU,EAAE,CAAC,CAAC;QAEtH,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,IAAI,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,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;QAElH,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAChE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,6EAA6E,CAAC,CAAC;QAE5I,IAAI,SAAoB,CAAC;QACzB,IAAI,YAAY,CAAC,SAAS,CAAC;YACzB,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;;YAE5C,SAAS,GAAG,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,cAAc,CAAC,eAAe,CAAC,oBAAoB,EAAE,uCAAuC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,YAAY,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC;YAE/K,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;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,cAAc,CAAC,eAAe,CAAC,oBAAoB,EAAE,qCAAqC,YAAY,CAAC,QAAQ,oBAAoB,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;QAEpK,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,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,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,8DAA8D,CAAC,CAAC;YAE7H,6CAA6C;YAC7C,IAAI,aAAa,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YACpC,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9C,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC;gBAC3B,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;YAEjC,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAEvC,MAAM,GAAG,GAAG,IAAI,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,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,4DAA4D,CAAC,CAAC;QAC3H,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,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,oDAAoD,aAAa,EAAE,CAAC,CAAC;QAElI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEnI,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  ECObjectsError, ECObjectsStatus, 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 ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to locate schema XML file at ${schemaPath}`);\n\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\n    const key = this.getSchemaKey(schemaText);\n    const alias = this.getSchemaAlias(schemaText);\n    const context = new SchemaContext();\n    context.addLocater(this);\n\n    // Load the schema and return it\n    const schema = new Schema(context, new FileSchemaKey(key, schemaPath, schemaText), alias);\n    this.addSchemaReferences(schema, context, SchemaMatchType.LatestWriteCompatible);\n    return schema;\n  }\n\n  /**\n   * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths\n   * to locate the XML Schema file from the file system. Returns only Schemas from XML files with\n   * their keys populated.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema.\n   */\n  public async getSchema(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 ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given file`);\n\n    const name = matches[0].match(/schemaName=\"(.+?)\"/);\n    const version = matches[0].match(/version=\"(.+?)\"/);\n    if (!name || name.length !== 2 || !version || version.length !== 2)\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\n\n    let ecVersion: ECVersion;\n    if (isECv2Schema(schemaXml))\n      ecVersion = this.fromECv2String(version[1]);\n    else\n      ecVersion = ECVersion.fromString(version[1]);\n\n    const key = new SchemaKey(name[1], ecVersion);\n    return key;\n  }\n\n  /**\n   * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.\n   * @param xmlSchemaKey The SchemaKey of the parent Schema containing the references.\n   */\n  private getSchemaReferenceKeys(schemaKey: FileSchemaKey): SchemaKey[] {\n    return this._getSchemaReferenceKeys(schemaKey);\n  }\n\n  /**\n   * Adds schemas to the references collection for the given Schema by locating\n   * the referenced schemas.\n   * @param schema The schema for which to add the references.\n   * @param context The SchemaContext that will control the lifetime of the schema.\n   * @param refMatchType The SchemaMatchType to use when locating schema references.\n   */\n  private addSchemaReferences(schema: Schema, context: SchemaContext, refMatchType: SchemaMatchType): void {\n    const refKeys = this.getSchemaReferenceKeys(schema.schemaKey as FileSchemaKey);\n\n    for (const key of refKeys) {\n      const refSchema = context ? context.getSchemaSync(key, refMatchType) : undefined;\n      if (!refSchema)\n        throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to locate referenced schema: ${key.name}.${key.readVersion}.${key.writeVersion}.${key.minorVersion}`);\n\n      schema.references.push(refSchema);\n    }\n  }\n\n  /**\n   * Gets an array of SchemaKeys of the Schemas referenced by the given Schema.\n   * @param data The Schema XML string.\n   */\n  private _getSchemaReferenceKeys(xmlSchemaKey: FileSchemaKey): SchemaKey[] {\n    const file = xmlSchemaKey.schemaText;\n\n    if (!file)\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Could not locate the schema file, ${xmlSchemaKey.fileName}, for the schema ${xmlSchemaKey.name}`);\n\n    const data = file.toString().replace(/(\\s*)<!--[\\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 ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Invalid ECSchemaReference xml encountered in the schema file`);\n\n      // write version maybe missing, so insert \"0\"\n      let versionString = versionMatch[1];\n      const versionParts = versionString.split(\".\");\n      if (versionParts.length === 2)\n        versionParts.splice(1, 0, \"0\");\n\n      versionString = versionParts.join(\".\");\n\n      const key = new SchemaKey(name[1], ECVersion.fromString(versionString));\n      keys.push(key);\n    }\n\n    return keys;\n  }\n\n  /**\n   * Gets the Schema alias from the Schema XML.\n   * @param data The Schema XML as a string.\n   */\n  private getSchemaAlias(schemaXml: string): string {\n    let match: any;\n\n    if (isECv2Schema(schemaXml)) {\n      match = schemaXml.match(/<ECSchema.*nameSpacePrefix=\"(?<alias>\\w+)\"/) as any;\n    } else {\n      match = schemaXml.match(/<ECSchema.*alias=\"(?<alias>\\w+)\"/) as any;\n    }\n\n    if (!match || !match.groups.alias) {\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'alias' tag in the given file.`);\n    }\n\n    return match.groups.alias;\n  }\n\n  /**\n   * Parses a valid EC 2.0 version string and returns an ECVersion object. The second digit becomes the minor version,\n   * and a zero is inserted as the 'write' digit. Example: \"1.1\" -> \"1.0.1\".\n   * @param versionString A valid EC 2.0 version string of the format, 'RR.mm'.\n   */\n  private fromECv2String(versionString: string): ECVersion {\n    const [read, minor] = versionString.split(\".\");\n\n    if (!read)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);\n\n    if (!minor)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);\n\n    return new ECVersion(+read, 0, +minor);\n  }\n}\n"]}

package/lib/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":""}

package/lib/esm/test/ConcurrentGetSchemaJson.test.js

@@ -0,0 +1,249 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { assert, expect } from "chai";
+import * as fs from "fs";
+import * as path from "path";
+import { ECVersion, SchemaContext, SchemaJsonLocater, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaJsonFileLocater } from "../SchemaJsonFileLocater";
+describe("Concurrent schema JSON deserialization", () => {
+    const assetDir = path.join(__dirname, "assets");
+    const schemaFolder = path.join(__dirname, "assets", "json");
+    const schemaKeys = [];
+    let context;
+    let contextSync;
+    let syncSchemas = [];
+    const locater = new SchemaJsonFileLocater();
+    before(() => {
+        if (!fs.existsSync(assetDir))
+            fs.mkdirSync(assetDir);
+        if (!fs.existsSync(schemaFolder))
+            fs.mkdirSync(schemaFolder);
+        copySchemasToAssetsDir();
+        // Deserialize schemas synchronously/serially as standard to compare to
+        contextSync = new SchemaContext();
+        locater.addSchemaSearchPath(schemaFolder);
+        contextSync.addLocater(locater);
+        const schemaFiles = fs.readdirSync(schemaFolder);
+        schemaFiles.forEach((fileName) => {
+            const schemaFile = path.join(schemaFolder, fileName);
+            const schemaJson = JSON.parse(fs.readFileSync(schemaFile, "utf-8"));
+            const schemaName = schemaJson.name;
+            const schemaVersion = schemaJson.version;
+            const key = new SchemaKey(schemaName.toString(), ECVersion.fromString(schemaVersion.toString()));
+            schemaKeys.push(key);
+        });
+        syncSchemas = schemaKeys.map((key) => {
+            if (!key)
+                return undefined;
+            const schema = contextSync.getSchemaSync(key, SchemaMatchType.Latest);
+            return schema;
+        });
+    });
+    beforeEach(() => {
+        context = new SchemaContext();
+        context.addLocater(locater);
+    });
+    function getSchemaPathFromPackage(packageName, schemaFileName) {
+        const schemaFile = path.join(__dirname, "..", "..", "..", "node_modules", "@bentley", packageName, schemaFileName);
+        return schemaFile;
+    }
+    function copySchemasToAssetsDir() {
+        // Copy Schemas that we need for testing
+        fs.copyFileSync(getSchemaPathFromPackage("aec-units-schema", "AecUnits.ecschema.json"), path.join(schemaFolder, "AecUnits.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("architectural-physical-schema", "ArchitecturalPhysical.ecschema.json"), path.join(schemaFolder, "ArchitecturalPhysical.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("bis-core-schema", "BisCore.ecschema.json"), path.join(schemaFolder, "BisCore.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("bis-custom-attributes-schema", "BisCustomAttributes.ecschema.json"), path.join(schemaFolder, "BisCustomAttributes.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("construction-schema", "Construction.ecschema.json"), path.join(schemaFolder, "Construction.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("core-custom-attributes-schema", "CoreCustomAttributes.ecschema.json"), path.join(schemaFolder, "CoreCustomAttributes.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("ecdb-map-schema", "ECDbMap.ecschema.json"), path.join(schemaFolder, "ECDbMap.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("ecdb-schema-policies-schema", "ECDbSchemaPolicies.ecschema.json"), path.join(schemaFolder, "ECDbSchemaPolicies.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("formats-schema", "Formats.ecschema.json"), path.join(schemaFolder, "Formats.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("linear-referencing-schema", "LinearReferencing.ecschema.json"), path.join(schemaFolder, "LinearReferencing.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("physical-material-schema", "PhysicalMaterial.ecschema.json"), path.join(schemaFolder, "PhysicalMaterial.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("plant-custom-attributes-schema", "PlantCustomAttributes.ecschema.json"), path.join(schemaFolder, "PlantCustomAttributes.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("quantity-takeoffs-aspects-schema", "QuantityTakeoffsAspects.ecschema.json"), path.join(schemaFolder, "QuantityTakeoffsAspects.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("spatial-composition-schema", "SpatialComposition.ecschema.json"), path.join(schemaFolder, "SpatialComposition.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("structural-physical-schema", "StructuralPhysical.ecschema.json"), path.join(schemaFolder, "StructuralPhysical.ecschema.json"));
+        fs.copyFileSync(getSchemaPathFromPackage("units-schema", "Units.ecschema.json"), path.join(schemaFolder, "Units.ecschema.json"));
+    }
+    it("should match schemas deserialized concurrently with schemas deserialized serially", async () => {
+        const schemaPromises = schemaKeys.map(async (key) => {
+            if (!key)
+                return undefined;
+            const schema = await context.getSchema(key, SchemaMatchType.Latest);
+            return schema;
+        });
+        const asyncSchemas = await Promise.all(schemaPromises);
+        for (let i = 0; i < schemaKeys.length; i++) {
+            const syncSchema = syncSchemas[i];
+            expect(syncSchema).not.to.be.undefined;
+            const syncJSON = syncSchema.toJSON();
+            const asyncSchema = asyncSchemas[i];
+            expect(asyncSchema).not.to.be.undefined;
+            const asyncJSON = asyncSchema.toJSON();
+            expect(asyncJSON).to.deep.equal(syncJSON);
+        }
+    });
+    it("should be able to mix getSchema and getSchemaSync", async () => {
+        const schemaPromises = schemaKeys.map(async (key, index) => {
+            if (index % 2 === 0) {
+                // Use getSchema() for even indices
+                if (!key)
+                    return undefined;
+                const schema = await context.getSchema(key, SchemaMatchType.Latest);
+                return schema;
+            }
+            else {
+                // Use getSchemaSync() for odd indices
+                if (!key)
+                    return undefined;
+                const schema = context.getSchemaSync(key, SchemaMatchType.Latest);
+                return schema;
+            }
+        });
+        const schemas = await Promise.all(schemaPromises);
+        for (let i = 0; i < schemaKeys.length; i++) {
+            const syncSchema = syncSchemas[i];
+            expect(syncSchema).not.to.be.undefined;
+            const syncJSON = syncSchema.toJSON();
+            const schema = schemas[i];
+            expect(schema).not.to.be.undefined;
+            const schemaJSON = schema.toJSON();
+            expect(schemaJSON).to.deep.equal(syncJSON);
+        }
+    });
+    /* Run these tests below one at a time. Running them together doesn't get accurate performance likely bc of disk access caching */
+    it.skip("should measure regular deserialization performance", async () => {
+        const schemaPromises = schemaKeys.map(async (key) => {
+            if (!key)
+                return undefined;
+            const schema = await context.getSchema(key, SchemaMatchType.Latest);
+            return schema;
+        });
+        for (const promise of schemaPromises) {
+            await promise;
+        }
+        expect(schemaPromises.length).to.equal(schemaKeys.length);
+    });
+    it.skip("should measure concurrent deserialization performance", async () => {
+        const schemaPromises = schemaKeys.map(async (key) => {
+            if (!key)
+                return undefined;
+            const schema = await context.getSchema(key, SchemaMatchType.Latest);
+            return schema;
+        });
+        const asyncSchemas = await Promise.all(schemaPromises);
+        expect(asyncSchemas.length).to.equal(schemaKeys.length);
+    });
+    it("Concurrently get BisCore with SchemaJsonFileLocater", async () => {
+        const schemaContext = new SchemaContext();
+        const jsonFileLocater = new SchemaJsonFileLocater();
+        jsonFileLocater.addSchemaSearchPath(schemaFolder);
+        schemaContext.addLocater(jsonFileLocater);
+        const schemas = await Promise.all([...Array(100).keys()].map(async () => {
+            return schemaContext.getSchema(new SchemaKey("BisCore"));
+        }));
+        expect(schemas.length).to.equal(100);
+        schemas.forEach((schema) => {
+            assert(schema !== undefined);
+            expect(schema.fullName).to.equal("BisCore");
+        });
+    });
+    it("Concurrently get a schema and it's referenced schema with SchemaJsonFileLocater", async () => {
+        const schemaContext = new SchemaContext();
+        const jsonFileLocater = new SchemaJsonFileLocater();
+        jsonFileLocater.addSchemaSearchPath(schemaFolder);
+        schemaContext.addLocater(jsonFileLocater);
+        let getBisCoreFirst = 0;
+        const schemas = await Promise.all([...Array(2).keys()].map(async () => {
+            if (getBisCoreFirst === 0) {
+                getBisCoreFirst = 1;
+                return schemaContext.getSchema(new SchemaKey("BisCore"));
+            }
+            return schemaContext.getSchema(new SchemaKey("CoreCustomAttributes"));
+        }));
+        expect(schemas.length).to.equal(2);
+        schemas.forEach((schema) => {
+            expect(schema).to.not.be.undefined;
+        });
+    });
+    const getSchemaProps = (schemaName) => {
+        if (schemaName === "BisCore") {
+            return {
+                $schema: "https://dev.bentley.com/json_schemas/ec/32/ecschema",
+                alias: "bis",
+                description: "The BIS core schema contains classes that all other domain schemas extend.",
+                label: "BIS Core",
+                name: "BisCore",
+                version: "01.00.15",
+                references: [{ name: "CoreCustomAttributes", version: "01.00.04" }, { name: "ECDbMap", version: "02.00.00" }, { name: "ECDbSchemaPolicies", version: "01.00.00" }],
+            };
+        }
+        if (schemaName === "CoreCustomAttributes") {
+            return {
+                $schema: "https://dev.bentley.com/json_schemas/ec/32/ecschema",
+                alias: "CoreCA",
+                description: "Custom attributes to indicate core EC concepts, may include struct classes intended for use in core custom attributes.",
+                label: "Core Custom Attributes",
+                name: "CoreCustomAttributes",
+                version: "01.00.04",
+            };
+        }
+        if (schemaName === "ECDbMap") {
+            return {
+                $schema: "https://dev.bentley.com/json_schemas/ec/32/ecschema",
+                alias: "ECDbMap",
+                description: "ECDbMap Desc",
+                label: "ECDbMap",
+                name: "ECDbMap",
+                version: "02.00.00",
+            };
+        }
+        if (schemaName === "ECDbSchemaPolicies") {
+            return {
+                $schema: "https://dev.bentley.com/json_schemas/ec/32/ecschema",
+                alias: "ECDbSchemaPolicies",
+                description: "ECDbSchemaPolicies Desc",
+                label: "ECDbSchemaPolicies",
+                name: "ECDbSchemaPolicies",
+                version: "01.00.00",
+            };
+        }
+        return undefined;
+    };
+    it("Concurrently get BisCore with SchemaJsonLocater", async () => {
+        const schemaContext = new SchemaContext();
+        const jsonLocater = new SchemaJsonLocater(getSchemaProps);
+        schemaContext.addLocater(jsonLocater);
+        const schemaCount = 1000;
+        const schemas = await Promise.all([...Array(schemaCount).keys()].map(async () => {
+            return schemaContext.getSchema(new SchemaKey("BisCore"));
+        }));
+        expect(schemas.length).to.equal(schemaCount);
+        schemas.forEach((schema) => {
+            assert(schema !== undefined);
+            expect(schema.fullName).to.equal("BisCore");
+        });
+    });
+    it("Concurrently get a schema and it's referenced schema with SchemaJsonLocater", async () => {
+        const schemaContext = new SchemaContext();
+        const jsonLocater = new SchemaJsonLocater(getSchemaProps);
+        schemaContext.addLocater(jsonLocater);
+        let getBisCoreFirst = 0;
+        const schemaCount = 1000;
+        const schemas = await Promise.all([...Array(schemaCount).keys()].map(async () => {
+            if (getBisCoreFirst === 0) {
+                getBisCoreFirst = 1;
+                return schemaContext.getSchema(new SchemaKey("BisCore"));
+            }
+            return schemaContext.getSchema(new SchemaKey("CoreCustomAttributes"));
+        }));
+        expect(schemas.length).to.equal(schemaCount);
+        schemas.forEach((schema) => {
+            expect(schema).to.not.be.undefined;
+        });
+    });
+});
+//# sourceMappingURL=ConcurrentGetSchemaJson.test.js.map

package/lib/esm/test/ConcurrentGetSchemaJson.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConcurrentGetSchemaJson.test.js","sourceRoot":"","sources":["../../../src/test/ConcurrentGetSchemaJson.test.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AACtC,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAU,aAAa,EAAE,iBAAiB,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3H,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,QAAQ,CAAC,wCAAwC,EAAE,GAAG,EAAE;IACtD,MAAM,QAAQ,GAAW,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACxD,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAE5D,MAAM,UAAU,GAAgB,EAAE,CAAC;IACnC,IAAI,OAAsB,CAAC;IAC3B,IAAI,WAA0B,CAAC;IAC/B,IAAI,WAAW,GAA8B,EAAE,CAAC;IAEhD,MAAM,OAAO,GAAG,IAAI,qBAAqB,EAAE,CAAC;IAE5C,MAAM,CAAC,GAAG,EAAE;QACV,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC1B,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACzB,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC;YAC9B,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAE7B,sBAAsB,EAAE,CAAC;QAEzB,uEAAuE;QACvE,WAAW,GAAG,IAAI,aAAa,EAAE,CAAC;QAClC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QAC1C,WAAW,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhC,MAAM,WAAW,GAAG,EAAE,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACjD,WAAW,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC/B,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YACrD,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;YACpE,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC;YACnC,MAAM,aAAa,GAAG,UAAU,CAAC,OAAO,CAAC;YAEzC,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,UAAU,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;YACjG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC,CAAC,CAAC;QAEH,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAsB,EAAE;YACvD,IAAI,CAAC,GAAG;gBACN,OAAO,SAAS,CAAC;YAEnB,MAAM,MAAM,GAAG,WAAW,CAAC,aAAa,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;YACtE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QAC9B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,SAAS,wBAAwB,CAAC,WAAmB,EAAE,cAAsB;QAC3E,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;QACnH,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,SAAS,sBAAsB;QAC7B,wCAAwC;QACxC,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,kBAAkB,EAAE,wBAAwB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,wBAAwB,CAAC,CAAC,CAAC;QAC3I,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,+BAA+B,EAAE,qCAAqC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,qCAAqC,CAAC,CAAC,CAAC;QAClL,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,iBAAiB,EAAE,uBAAuB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,uBAAuB,CAAC,CAAC,CAAC;QACxI,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,8BAA8B,EAAE,mCAAmC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,mCAAmC,CAAC,CAAC,CAAC;QAC7K,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,qBAAqB,EAAE,4BAA4B,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,4BAA4B,CAAC,CAAC,CAAC;QACtJ,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,+BAA+B,EAAE,oCAAoC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,oCAAoC,CAAC,CAAC,CAAC;QAChL,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,iBAAiB,EAAE,uBAAuB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,uBAAuB,CAAC,CAAC,CAAC;QACxI,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,6BAA6B,EAAE,kCAAkC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,kCAAkC,CAAC,CAAC,CAAC;QAC1K,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,uBAAuB,CAAC,CAAC,CAAC;QACvI,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,2BAA2B,EAAE,iCAAiC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,iCAAiC,CAAC,CAAC,CAAC;QACtK,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,0BAA0B,EAAE,gCAAgC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,gCAAgC,CAAC,CAAC,CAAC;QACnK,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,gCAAgC,EAAE,qCAAqC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,qCAAqC,CAAC,CAAC,CAAC;QACnL,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,kCAAkC,EAAE,uCAAuC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,uCAAuC,CAAC,CAAC,CAAC;QACzL,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,4BAA4B,EAAE,kCAAkC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,kCAAkC,CAAC,CAAC,CAAC;QACzK,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,4BAA4B,EAAE,kCAAkC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,kCAAkC,CAAC,CAAC,CAAC;QACzK,EAAE,CAAC,YAAY,CAAC,wBAAwB,CAAC,cAAc,EAAE,qBAAqB,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,qBAAqB,CAAC,CAAC,CAAC;IACnI,CAAC;IAED,EAAE,CAAC,mFAAmF,EAAE,KAAK,IAAI,EAAE;QACjG,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAA+B,EAAE;YAC/E,IAAI,CAAC,GAAG;gBACN,OAAO,SAAS,CAAC;YAEnB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;YACpE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAEvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YAClC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;YACvC,MAAM,QAAQ,GAAG,UAAW,CAAC,MAAM,EAAE,CAAC;YAEtC,MAAM,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;YACpC,MAAM,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;YACxC,MAAM,SAAS,GAAG,WAAY,CAAC,MAAM,EAAE,CAAC;YACxC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAA+B,EAAE;YACtF,IAAI,KAAK,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBACpB,mCAAmC;gBACnC,IAAI,CAAC,GAAG;oBACN,OAAO,SAAS,CAAC;gBAEnB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;gBACpE,OAAO,MAAM,CAAC;YAChB,CAAC;iBAAM,CAAC;gBACN,sCAAsC;gBACtC,IAAI,CAAC,GAAG;oBACN,OAAO,SAAS,CAAC;gBAEnB,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;gBAClE,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAElD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3C,MAAM,UAAU,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;YAClC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;YACvC,MAAM,QAAQ,GAAG,UAAW,CAAC,MAAM,EAAE,CAAC;YAEtC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;YACnC,MAAM,UAAU,GAAG,MAAO,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,kIAAkI;IAClI,EAAE,CAAC,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QACvE,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAA+B,EAAE;YAC/E,IAAI,CAAC,GAAG;gBACN,OAAO,SAAS,CAAC;YAEnB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;YACpE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;YACrC,MAAM,OAAO,CAAC;QAChB,CAAC;QAED,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,EAA+B,EAAE;YAC/E,IAAI,CAAC,GAAG;gBACN,OAAO,SAAS,CAAC;YAEnB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,GAAG,EAAE,eAAe,CAAC,MAAM,CAAC,CAAC;YACpE,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAEvD,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,MAAM,eAAe,GAAG,IAAI,qBAAqB,EAAE,CAAC;QACpD,eAAe,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QAClD,aAAa,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QAE1C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YACpC,OAAO,aAAa,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAC,CACH,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iFAAiF,EAAE,KAAK,IAAI,EAAE;QAC/F,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,MAAM,eAAe,GAAG,IAAI,qBAAqB,EAAE,CAAC;QACpD,eAAe,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QAClD,aAAa,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;QAE1C,IAAI,eAAe,GAAG,CAAC,CAAC;QACxB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAClC,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;gBAC1B,eAAe,GAAG,CAAC,CAAC;gBACpB,OAAO,aAAa,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,aAAa,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACxE,CAAC,CAAC,CACH,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACnC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,cAAc,GAAG,CAAC,UAAkB,EAAE,EAAE;QAC5C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO;gBACL,OAAO,EAAE,qDAAqD;gBAC9D,KAAK,EAAE,KAAK;gBACZ,WAAW,EAAE,4EAA4E;gBACzF,KAAK,EAAE,UAAU;gBACjB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,UAAU;gBACnB,UAAU,EAAC,CAAC,EAAC,IAAI,EAAC,sBAAsB,EAAE,OAAO,EAAC,UAAU,EAAC,EAAC,EAAC,IAAI,EAAC,SAAS,EAAE,OAAO,EAAC,UAAU,EAAC,EAAC,EAAC,IAAI,EAAC,oBAAoB,EAAE,OAAO,EAAC,UAAU,EAAC,CAAC;aACpJ,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,KAAK,sBAAsB,EAAE,CAAC;YAC1C,OAAO;gBACL,OAAO,EAAE,qDAAqD;gBAC9D,KAAK,EAAE,QAAQ;gBACf,WAAW,EAAE,wHAAwH;gBACrI,KAAK,EAAE,wBAAwB;gBAC/B,IAAI,EAAE,sBAAsB;gBAC5B,OAAO,EAAE,UAAU;aACpB,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO;gBACL,OAAO,EAAE,qDAAqD;gBAC9D,KAAK,EAAE,SAAS;gBAChB,WAAW,EAAE,cAAc;gBAC3B,KAAK,EAAE,SAAS;gBAChB,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,UAAU;aACpB,CAAC;QACJ,CAAC;QACD,IAAI,UAAU,KAAK,oBAAoB,EAAE,CAAC;YACxC,OAAO;gBACL,OAAO,EAAE,qDAAqD;gBAC9D,KAAK,EAAE,oBAAoB;gBAC3B,WAAW,EAAE,yBAAyB;gBACtC,KAAK,EAAE,oBAAoB;gBAC3B,IAAI,EAAE,oBAAoB;gBAC1B,OAAO,EAAE,UAAU;aACpB,CAAC;QACJ,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,iBAAiB,CAAC,cAAc,CAAC,CAAC;QAC1D,aAAa,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAEtC,MAAM,WAAW,GAAG,IAAI,CAAC;QACzB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAC5C,OAAO,aAAa,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;QAC3D,CAAC,CAAC,CACH,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC7C,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC;YAC7B,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6EAA6E,EAAE,KAAK,IAAI,EAAE;QAC3F,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,MAAM,WAAW,GAAG,IAAI,iBAAiB,CAAC,cAAc,CAAC,CAAC;QAC1D,aAAa,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAEtC,IAAI,eAAe,GAAG,CAAC,CAAC;QACxB,MAAM,WAAW,GAAG,IAAI,CAAC;QACzB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAC5C,IAAI,eAAe,KAAK,CAAC,EAAE,CAAC;gBAC1B,eAAe,GAAG,CAAC,CAAC;gBACpB,OAAO,aAAa,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;YAC3D,CAAC;YACD,OAAO,aAAa,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACxE,CAAC,CAAC,CACH,CAAC;QACF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;QAC7C,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport { assert, expect } from \"chai\";\nimport * as fs from \"fs\";\nimport * as path from \"path\";\nimport { ECVersion, Schema, SchemaContext, SchemaJsonLocater, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\nimport { SchemaJsonFileLocater } from \"../SchemaJsonFileLocater\";\n\ndescribe(\"Concurrent schema JSON deserialization\", () => {\n  const assetDir: string = path.join(__dirname, \"assets\");\n  const schemaFolder = path.join(__dirname, \"assets\", \"json\");\n\n  const schemaKeys: SchemaKey[] = [];\n  let context: SchemaContext;\n  let contextSync: SchemaContext;\n  let syncSchemas: Array<Schema | undefined> = [];\n\n  const locater = new SchemaJsonFileLocater();\n\n  before(() => {\n    if (!fs.existsSync(assetDir))\n      fs.mkdirSync(assetDir);\n    if (!fs.existsSync(schemaFolder))\n      fs.mkdirSync(schemaFolder);\n\n    copySchemasToAssetsDir();\n\n    // Deserialize schemas synchronously/serially as standard to compare to\n    contextSync = new SchemaContext();\n    locater.addSchemaSearchPath(schemaFolder);\n    contextSync.addLocater(locater);\n\n    const schemaFiles = fs.readdirSync(schemaFolder);\n    schemaFiles.forEach((fileName) => {\n      const schemaFile = path.join(schemaFolder, fileName);\n      const schemaJson = JSON.parse(fs.readFileSync(schemaFile, \"utf-8\"));\n      const schemaName = schemaJson.name;\n      const schemaVersion = schemaJson.version;\n\n      const key = new SchemaKey(schemaName.toString(), ECVersion.fromString(schemaVersion.toString()));\n      schemaKeys.push(key);\n    });\n\n    syncSchemas = schemaKeys.map((key): Schema | undefined => {\n      if (!key)\n        return undefined;\n\n      const schema = contextSync.getSchemaSync(key, SchemaMatchType.Latest);\n      return schema;\n    });\n  });\n\n  beforeEach(() => {\n    context = new SchemaContext();\n    context.addLocater(locater);\n  });\n\n  function getSchemaPathFromPackage(packageName: string, schemaFileName: string): string {\n    const schemaFile = path.join(__dirname, \"..\", \"..\", \"..\", \"node_modules\", \"@bentley\", packageName, schemaFileName);\n    return schemaFile;\n  }\n\n  function copySchemasToAssetsDir() {\n    // Copy Schemas that we need for testing\n    fs.copyFileSync(getSchemaPathFromPackage(\"aec-units-schema\", \"AecUnits.ecschema.json\"), path.join(schemaFolder, \"AecUnits.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"architectural-physical-schema\", \"ArchitecturalPhysical.ecschema.json\"), path.join(schemaFolder, \"ArchitecturalPhysical.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"bis-core-schema\", \"BisCore.ecschema.json\"), path.join(schemaFolder, \"BisCore.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"bis-custom-attributes-schema\", \"BisCustomAttributes.ecschema.json\"), path.join(schemaFolder, \"BisCustomAttributes.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"construction-schema\", \"Construction.ecschema.json\"), path.join(schemaFolder, \"Construction.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"core-custom-attributes-schema\", \"CoreCustomAttributes.ecschema.json\"), path.join(schemaFolder, \"CoreCustomAttributes.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"ecdb-map-schema\", \"ECDbMap.ecschema.json\"), path.join(schemaFolder, \"ECDbMap.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"ecdb-schema-policies-schema\", \"ECDbSchemaPolicies.ecschema.json\"), path.join(schemaFolder, \"ECDbSchemaPolicies.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"formats-schema\", \"Formats.ecschema.json\"), path.join(schemaFolder, \"Formats.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"linear-referencing-schema\", \"LinearReferencing.ecschema.json\"), path.join(schemaFolder, \"LinearReferencing.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"physical-material-schema\", \"PhysicalMaterial.ecschema.json\"), path.join(schemaFolder, \"PhysicalMaterial.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"plant-custom-attributes-schema\", \"PlantCustomAttributes.ecschema.json\"), path.join(schemaFolder, \"PlantCustomAttributes.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"quantity-takeoffs-aspects-schema\", \"QuantityTakeoffsAspects.ecschema.json\"), path.join(schemaFolder, \"QuantityTakeoffsAspects.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"spatial-composition-schema\", \"SpatialComposition.ecschema.json\"), path.join(schemaFolder, \"SpatialComposition.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"structural-physical-schema\", \"StructuralPhysical.ecschema.json\"), path.join(schemaFolder, \"StructuralPhysical.ecschema.json\"));\n    fs.copyFileSync(getSchemaPathFromPackage(\"units-schema\", \"Units.ecschema.json\"), path.join(schemaFolder, \"Units.ecschema.json\"));\n  }\n\n  it(\"should match schemas deserialized concurrently with schemas deserialized serially\", async () => {\n    const schemaPromises = schemaKeys.map(async (key): Promise<Schema | undefined> => {\n      if (!key)\n        return undefined;\n\n      const schema = await context.getSchema(key, SchemaMatchType.Latest);\n      return schema;\n    });\n    const asyncSchemas = await Promise.all(schemaPromises);\n\n    for (let i = 0; i < schemaKeys.length; i++) {\n      const syncSchema = syncSchemas[i];\n      expect(syncSchema).not.to.be.undefined;\n      const syncJSON = syncSchema!.toJSON();\n\n      const asyncSchema = asyncSchemas[i];\n      expect(asyncSchema).not.to.be.undefined;\n      const asyncJSON = asyncSchema!.toJSON();\n      expect(asyncJSON).to.deep.equal(syncJSON);\n    }\n  });\n\n  it(\"should be able to mix getSchema and getSchemaSync\", async () => {\n    const schemaPromises = schemaKeys.map(async (key, index): Promise<Schema | undefined> => {\n      if (index % 2 === 0) {\n        // Use getSchema() for even indices\n        if (!key)\n          return undefined;\n\n        const schema = await context.getSchema(key, SchemaMatchType.Latest);\n        return schema;\n      } else {\n        // Use getSchemaSync() for odd indices\n        if (!key)\n          return undefined;\n\n        const schema = context.getSchemaSync(key, SchemaMatchType.Latest);\n        return schema;\n      }\n    });\n    const schemas = await Promise.all(schemaPromises);\n\n    for (let i = 0; i < schemaKeys.length; i++) {\n      const syncSchema = syncSchemas[i];\n      expect(syncSchema).not.to.be.undefined;\n      const syncJSON = syncSchema!.toJSON();\n\n      const schema = schemas[i];\n      expect(schema).not.to.be.undefined;\n      const schemaJSON = schema!.toJSON();\n      expect(schemaJSON).to.deep.equal(syncJSON);\n    }\n  });\n\n  /* Run these tests below one at a time. Running them together doesn't get accurate performance likely bc of disk access caching */\n  it.skip(\"should measure regular deserialization performance\", async () => {\n    const schemaPromises = schemaKeys.map(async (key): Promise<Schema | undefined> => {\n      if (!key)\n        return undefined;\n\n      const schema = await context.getSchema(key, SchemaMatchType.Latest);\n      return schema;\n    });\n\n    for (const promise of schemaPromises) {\n      await promise;\n    }\n\n    expect(schemaPromises.length).to.equal(schemaKeys.length);\n  });\n\n  it.skip(\"should measure concurrent deserialization performance\", async () => {\n    const schemaPromises = schemaKeys.map(async (key): Promise<Schema | undefined> => {\n      if (!key)\n        return undefined;\n\n      const schema = await context.getSchema(key, SchemaMatchType.Latest);\n      return schema;\n    });\n    const asyncSchemas = await Promise.all(schemaPromises);\n\n    expect(asyncSchemas.length).to.equal(schemaKeys.length);\n  });\n\n  it(\"Concurrently get BisCore with SchemaJsonFileLocater\", async () => {\n    const schemaContext = new SchemaContext();\n    const jsonFileLocater = new SchemaJsonFileLocater();\n    jsonFileLocater.addSchemaSearchPath(schemaFolder);\n    schemaContext.addLocater(jsonFileLocater);\n\n    const schemas = await Promise.all(\n      [...Array(100).keys()].map(async () => {\n        return schemaContext.getSchema(new SchemaKey(\"BisCore\"));\n      }),\n    );\n    expect(schemas.length).to.equal(100);\n    schemas.forEach((schema) => {\n      assert(schema !== undefined);\n      expect(schema.fullName).to.equal(\"BisCore\");\n    });\n  });\n\n  it(\"Concurrently get a schema and it's referenced schema with SchemaJsonFileLocater\", async () => {\n    const schemaContext = new SchemaContext();\n    const jsonFileLocater = new SchemaJsonFileLocater();\n    jsonFileLocater.addSchemaSearchPath(schemaFolder);\n    schemaContext.addLocater(jsonFileLocater);\n\n    let getBisCoreFirst = 0;\n    const schemas = await Promise.all(\n      [...Array(2).keys()].map(async () => {\n        if (getBisCoreFirst === 0) {\n          getBisCoreFirst = 1;\n          return schemaContext.getSchema(new SchemaKey(\"BisCore\"));\n        }\n        return schemaContext.getSchema(new SchemaKey(\"CoreCustomAttributes\"));\n      }),\n    );\n    expect(schemas.length).to.equal(2);\n    schemas.forEach((schema) => {\n      expect(schema).to.not.be.undefined;\n    });\n  });\n\n  const getSchemaProps = (schemaName: string) => {\n    if (schemaName === \"BisCore\") {\n      return {\n        $schema: \"https://dev.bentley.com/json_schemas/ec/32/ecschema\",\n        alias: \"bis\",\n        description: \"The BIS core schema contains classes that all other domain schemas extend.\",\n        label: \"BIS Core\",\n        name: \"BisCore\",\n        version: \"01.00.15\",\n        references:[{name:\"CoreCustomAttributes\", version:\"01.00.04\"},{name:\"ECDbMap\", version:\"02.00.00\"},{name:\"ECDbSchemaPolicies\", version:\"01.00.00\"}],\n      };\n    }\n    if (schemaName === \"CoreCustomAttributes\") {\n      return {\n        $schema: \"https://dev.bentley.com/json_schemas/ec/32/ecschema\",\n        alias: \"CoreCA\",\n        description: \"Custom attributes to indicate core EC concepts, may include struct classes intended for use in core custom attributes.\",\n        label: \"Core Custom Attributes\",\n        name: \"CoreCustomAttributes\",\n        version: \"01.00.04\",\n      };\n    }\n    if (schemaName === \"ECDbMap\") {\n      return {\n        $schema: \"https://dev.bentley.com/json_schemas/ec/32/ecschema\",\n        alias: \"ECDbMap\",\n        description: \"ECDbMap Desc\",\n        label: \"ECDbMap\",\n        name: \"ECDbMap\",\n        version: \"02.00.00\",\n      };\n    }\n    if (schemaName === \"ECDbSchemaPolicies\") {\n      return {\n        $schema: \"https://dev.bentley.com/json_schemas/ec/32/ecschema\",\n        alias: \"ECDbSchemaPolicies\",\n        description: \"ECDbSchemaPolicies Desc\",\n        label: \"ECDbSchemaPolicies\",\n        name: \"ECDbSchemaPolicies\",\n        version: \"01.00.00\",\n      };\n    }\n\n    return undefined;\n  };\n\n  it(\"Concurrently get BisCore with SchemaJsonLocater\", async () => {\n    const schemaContext = new SchemaContext();\n    const jsonLocater = new SchemaJsonLocater(getSchemaProps);\n    schemaContext.addLocater(jsonLocater);\n\n    const schemaCount = 1000;\n    const schemas = await Promise.all(\n      [...Array(schemaCount).keys()].map(async () => {\n        return schemaContext.getSchema(new SchemaKey(\"BisCore\"));\n      }),\n    );\n    expect(schemas.length).to.equal(schemaCount);\n    schemas.forEach((schema) => {\n      assert(schema !== undefined);\n      expect(schema.fullName).to.equal(\"BisCore\");\n    });\n  });\n\n  it(\"Concurrently get a schema and it's referenced schema with SchemaJsonLocater\", async () => {\n    const schemaContext = new SchemaContext();\n    const jsonLocater = new SchemaJsonLocater(getSchemaProps);\n    schemaContext.addLocater(jsonLocater);\n\n    let getBisCoreFirst = 0;\n    const schemaCount = 1000;\n    const schemas = await Promise.all(\n      [...Array(schemaCount).keys()].map(async () => {\n        if (getBisCoreFirst === 0) {\n          getBisCoreFirst = 1;\n          return schemaContext.getSchema(new SchemaKey(\"BisCore\"));\n        }\n        return schemaContext.getSchema(new SchemaKey(\"CoreCustomAttributes\"));\n      }),\n    );\n    expect(schemas.length).to.equal(schemaCount);\n    schemas.forEach((schema) => {\n      expect(schema).to.not.be.undefined;\n    });\n  });\n});\n"]}

package/lib/esm/test/ConcurrentGetSchemaXml.test.d.ts

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

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

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