@itwin/ecschema-locaters 4.1.0-dev.8 → 4.1.0-dev.80

package/CHANGELOG.md

@@ -1,6 +1,79 @@
 # Change Log - @itwin/ecschema-locaters
 
-This log was last generated on Tue, 25 Apr 2023 17:50:35 GMT and should not be manually modified.
+This log was last generated on Mon, 24 Jul 2023 12:35:20 GMT and should not be manually modified.
+
+## 4.0.6
+Mon, 24 Jul 2023 05:07:33 GMT
+
+_Version update only_
+
+## 4.0.5
+Tue, 18 Jul 2023 12:21:56 GMT
+
+_Version update only_
+
+## 4.0.4
+Wed, 12 Jul 2023 15:50:01 GMT
+
+_Version update only_
+
+## 4.0.3
+Mon, 03 Jul 2023 15:28:41 GMT
+
+_Version update only_
+
+## 4.0.2
+Wed, 21 Jun 2023 22:04:43 GMT
+
+_Version update only_
+
+## 4.0.1
+Wed, 21 Jun 2023 20:29:13 GMT
+
+_Version update only_
+
+## 4.0.0
+Mon, 22 May 2023 15:34:14 GMT
+
+### Updates
+
+- Updated to support changes to async schema loading and `ISchemaLocater`
+- Update to eslint@8
+
+## 3.7.11
+Tue, 11 Jul 2023 17:17:21 GMT
+
+_Version update only_
+
+## 3.7.10
+Wed, 05 Jul 2023 13:41:21 GMT
+
+_Version update only_
+
+## 3.7.9
+Tue, 20 Jun 2023 12:51:02 GMT
+
+_Version update only_
+
+## 3.7.8
+Thu, 01 Jun 2023 17:00:39 GMT
+
+_Version update only_
+
+## 3.7.7
+Wed, 24 May 2023 17:27:09 GMT
+
+_Version update only_
+
+## 3.7.6
+Mon, 15 May 2023 18:23:41 GMT
+
+_Version update only_
+
+## 3.7.5
+Thu, 04 May 2023 19:43:18 GMT
+
+_Version update only_
 
 ## 3.7.4
 Tue, 25 Apr 2023 17:50:35 GMT

package/lib/cjs/SchemaFileLocater.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaFileLocater.js","sourceRoot":"","sources":["../../src/SchemaFileLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,yBAAyB;AACzB,6BAA6B;AAC7B,6BAA6B;AAC7B,gEAA6F;AAE7F;;GAEG;AAEH,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,GAAG,IAAc,EAAE,EAAE;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACrD,OAAO,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,WAAW;YAC3C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACjB,CAAC,CAAC,KAAK,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,YAAoB,EAAE,SAAiB,EAAE,EAAE;IAC1E,YAAY,GAAG,YAAY,IAAI,CAAC,CAAC,CAAC,iDAAiD;IACnF,SAAS,GAAG,MAAM,CAAC,CAAC,OAAO,SAAS,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACzE,IAAI,GAAG,CAAC,MAAM,GAAG,YAAY,EAAE;QAC7B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;KACpB;SAAM;QACL,YAAY,GAAG,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC;QACzC,IAAI,YAAY,GAAG,SAAS,CAAC,MAAM,EAAE;YACnC,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,yDAAyD;SAC1H;QACD,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,GAAG,GAAG,CAAC;KAC/C;AACH,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAa,aAAc,SAAQ,6BAAS;IAM1C;;;;;;OAMG;IACH,YAAY,GAAc,EAAE,QAAgB,EAAE,UAAmB;QAC/D,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAlBD,sCAkBC;AAED;;;GAGG;AACH,MAAsB,iBAAiB;IAGrC;QAkKA;;;;;WAKG;QACI,8BAAyB,GAAG,CAAC,GAAkB,EAAE,GAAkB,EAAU,EAAE;YACpF,OAAO,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC,CAAC;QAzKA,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QAChD,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzD,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC3C,IAAI,GAAG;oBACL,MAAM,CAAC,GAAG,CAAC,CAAC;;oBAEZ,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,wBAAwB,CAAC,QAAgB;QAC9C,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,QAAgB;QACtC,OAAO,IAAI,OAAO,CAAsB,CAAC,OAAO,EAAE,EAAE;YAClD,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC7C,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,cAAc,CAAC,QAAgB;QACpC,OAAO,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,WAAqB;QAC/C,sDAAsD;QACtD,KAAK,MAAM,UAAU,IAAI,WAAW;YAClC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,UAAkB;QAC3C,sDAAsD;QACtD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC;YACzD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;;;OASG;IACK,0BAA0B,CAAC,UAA2B,EAAE,UAAkB,EAAE,UAAkB,EAAE,UAA+B,EAAE,SAA0B,EAAE,MAAc;QACjL,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,UAAU,aAAa,MAAM,EAAE,CAAC,CAAC;QAE3E,kCAAkC;QAClC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC1B,OAAO;QAET,gBAAgB;QAChB,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI;YACP,OAAO;QAET,qBAAqB;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE/C,2CAA2C;QAC3C,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;YACpC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACK,sBAAsB,CAAC,UAA2B,EAAE,UAAkB,EAAE,UAAkB,EAAE,UAA+B,EAAE,SAA0B,EAAE,MAAc;QAC7K,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE;YAChC,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,aAAa,MAAM,EAAE,CAAC,CAAC,CAAC;YAC7D,mDAAmD;YACnD,wFAAwF;YACxF,IAAI,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACzB,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC5B;YAED,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI;gBACP,SAAS;YAEX,MAAM,SAAS,GAAG,6BAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAClD,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;gBAC1C,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;SACzE;IACH,CAAC;IAED;;;;;;OAMG;IACO,sBAAsB,CAAC,UAA+B,EAAE,SAA0B,EAAE,MAAc;QAC1G,MAAM,UAAU,GAAG,IAAI,KAAK,EAAiB,CAAC;QAE9C,IAAI,gBAAwB,CAAC;QAC7B,IAAI,kBAA0B,CAAC;QAC/B,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;QACtD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAExD,IAAI,SAAS,KAAK,mCAAe,CAAC,MAAM,EAAE;YACxC,gBAAgB,GAAG,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC;YAC/C,kBAAkB,GAAG,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;SACpD;aAAM,IAAI,SAAS,KAAK,mCAAe,CAAC,qBAAqB,EAAE;YAC9D,gBAAgB,GAAG,YAAY,CAAC,mBAAmB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,CAAC,uBAAuB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SACvI;aAAM,IAAI,SAAS,KAAK,mCAAe,CAAC,oBAAoB,EAAE;YAC7D,gBAAgB,GAAG,YAAY,CAAC,mBAAmB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,CAAC,qBAAqB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SACnG;aAAM;YACL,gBAAgB,GAAG,YAAY,CAAC,qBAAqB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAClI,kBAAkB,GAAG,YAAY,CAAC,yBAAyB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SAC3K;QAED,MAAM,oBAAoB,GAAG,UAAU,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAChE,MAAM,sBAAsB,GAAG,UAAU,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAEpE,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACzC,IAAI,CAAC,0BAA0B,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACxG,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,oBAAoB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACzG,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,sBAAsB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;SAC5G;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CAaF;AA9KD,8CA8KC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport * as fs from \"fs\";\r\nimport * as glob from \"glob\";\r\nimport * as path from \"path\";\r\nimport { Schema, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\n\r\n/** @packageDocumentation\r\n * @module Locaters\r\n */\r\n\r\nconst formatString = (format: string, ...args: string[]) => {\r\n  return format.replace(/{(\\d+)}/g, (match, theNumber) => {\r\n    return typeof args[theNumber] !== \"undefined\"\r\n      ? args[theNumber]\r\n      : match;\r\n  });\r\n};\r\n\r\nconst padStartEx = (str: string, targetLength: number, padString: string) => {\r\n  targetLength = targetLength >> 0; // truncate if number or convert non-number to 0;\r\n  padString = String((typeof padString !== \"undefined\" ? padString : \" \"));\r\n  if (str.length > targetLength) {\r\n    return String(str);\r\n  } else {\r\n    targetLength = targetLength - str.length;\r\n    if (targetLength > padString.length) {\r\n      padString += padString.repeat(targetLength / padString.length); // append to original to ensure we are longer than needed\r\n    }\r\n    return padString.slice(0, targetLength) + str;\r\n  }\r\n};\r\n\r\n/**\r\n * A SchemaKey implementation that aids in identifying Schema files via the\r\n * addition of two properties: fileName and schemaText.  The fileName contains the\r\n * full path to the file on disk and schemaText is the full string representation\r\n * of the Schema.\r\n * @beta\r\n */\r\nexport class FileSchemaKey extends SchemaKey {\r\n  // The schema file associated with the SchemaKey\r\n  public fileName: string;\r\n  // The JSON text for the schema loaded\r\n  public schemaText?: string;\r\n\r\n  /**\r\n   * Initializes a new FileSchemaKey object.\r\n   * @param key The EC SchemaKey identifying the Schema.\r\n   * @param fileName The full path to the Schema file.\r\n   * @param schemaText The string representation of the Schema\r\n   * loaded from disk. Optional.\r\n   */\r\n  constructor(key: SchemaKey, fileName: string, schemaJson?: string) {\r\n    super(key.name, key.version);\r\n    this.fileName = fileName;\r\n    this.schemaText = schemaJson;\r\n  }\r\n}\r\n\r\n/**\r\n * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater\r\n * @beta - Needs further testing and possibly moved to a separate package.\r\n */\r\nexport abstract class SchemaFileLocater {\r\n  public searchPaths: string[];\r\n\r\n  constructor() {\r\n    this.searchPaths = [];\r\n  }\r\n\r\n  public async readUtf8FileToString(filePath: string): Promise<string | undefined> {\r\n    return new Promise<string | undefined>((resolve, reject) => {\r\n      fs.readFile(filePath, \"utf-8\", (err, data) => {\r\n        if (err)\r\n          reject(err);\r\n        else\r\n          resolve(data);\r\n      });\r\n    });\r\n  }\r\n\r\n  public readUtf8FileToStringSync(filePath: string): string | undefined {\r\n    return fs.readFileSync(filePath, \"utf-8\");\r\n  }\r\n\r\n  public async fileExists(filePath: string): Promise<boolean | undefined> {\r\n    return new Promise<boolean | undefined>((resolve) => {\r\n      fs.access(filePath, fs.constants.F_OK, (err) => {\r\n        resolve(err ? false : true);\r\n      });\r\n    });\r\n  }\r\n\r\n  public fileExistsSync(filePath: string): boolean | undefined {\r\n    return fs.existsSync(filePath);\r\n  }\r\n\r\n  /**\r\n   * Adds more search paths used by this locator to find the\r\n   * Schema files.\r\n   * @param schemaPaths An array of search paths to add\r\n   */\r\n  public addSchemaSearchPaths(schemaPaths: string[]) {\r\n    // If the path is not in the schemaPaths array, add it\r\n    for (const schemaPath of schemaPaths)\r\n      this.addSchemaSearchPath(schemaPath);\r\n  }\r\n\r\n  /**\r\n   * Add one search path used by this locator to find the\r\n   * Schema files.\r\n   * @param schemaPath A search path to add\r\n   */\r\n  public addSchemaSearchPath(schemaPath: string) {\r\n    // If the path is not in the schemaPaths array, add it\r\n    if (!this.searchPaths.find((entry) => entry === schemaPath))\r\n      this.searchPaths.push(schemaPath);\r\n  }\r\n\r\n  protected abstract getSchemaKey(data: string): SchemaKey;\r\n\r\n  /**\r\n   * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method\r\n   * only attempts to find schema files that have no version in the file name.\r\n   * @param foundFiles The collection of SchemaKeys found in the given directory.\r\n   * @param schemaPath The directory in which to search for the Schemas.\r\n   * @param schemaName The short name of the Schema (without version).\r\n   * @param desiredKey The SchemaKey used to find matching Schema files.\r\n   * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.\r\n   * @param format The type of file that the schema key refers to. json or xml\r\n   */\r\n  private addCandidateNoExtSchemaKey(foundFiles: FileSchemaKey[], schemaPath: string, schemaName: string, desiredKey: Readonly<SchemaKey>, matchType: SchemaMatchType, format: string) {\r\n    const fullPath = path.join(schemaPath, `${schemaName}.ecschema.${format}`);\r\n\r\n    // If the file does not exist, end\r\n    if (!fs.existsSync(fullPath))\r\n      return;\r\n\r\n    // Read the file\r\n    const file = fs.readFileSync(fullPath);\r\n    if (!file)\r\n      return;\r\n\r\n    // Get the schema key\r\n    const key = this.getSchemaKey(file.toString());\r\n\r\n    // If the key matches, put it in foundFiles\r\n    if (key.matches(desiredKey, matchType))\r\n      foundFiles.push(new FileSchemaKey(key, fullPath, file.toString()));\r\n  }\r\n\r\n  /**\r\n   * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey\r\n   * @param foundFiles The collection of SchemaKeys found in the given directory\r\n   * @param schemaPath The directory in which to search for the Schemas\r\n   * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.\r\n   * @param desiredKey The schemaKey used to find matching Schema files\r\n   * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.\r\n   * @param format The type of file that the schema key refers to. json or xml\r\n   */\r\n  private addCandidateSchemaKeys(foundFiles: FileSchemaKey[], schemaPath: string, fileFilter: string, desiredKey: Readonly<SchemaKey>, matchType: SchemaMatchType, format: string) {\r\n    const fullPath = path.join(schemaPath, fileFilter);\r\n\r\n    const result = new glob.GlobSync(fullPath, { sync: true });\r\n    for (const match of result.found) {\r\n      let fileName = path.basename(match, (`.ecschema.${format}`));\r\n      // TODO: should this be moved or handled elsewhere?\r\n      // Handles two version file names - SchemaKey.parseString supports only 3 version names.\r\n      if (/[^\\d]\\.\\d?\\d\\.\\d?\\d$/.test(fileName)) {\r\n        const parts = fileName.split(\".\");\r\n        parts.splice(2, 0, \"00\");\r\n        fileName = parts.join(\".\");\r\n      }\r\n\r\n      const file = fs.readFileSync(match);\r\n      if (!file)\r\n        continue;\r\n\r\n      const schemaKey = SchemaKey.parseString(fileName);\r\n      if (schemaKey.matches(desiredKey, matchType))\r\n        foundFiles.push(new FileSchemaKey(schemaKey, match, file.toString()));\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Attempts to find all Schema files in the configurable search paths that match\r\n   * the desired SchemaKey.\r\n   * @param desiredKey The SchemaKey to match.\r\n   * @param matchType The SchemaMatchType.\r\n   * @param format The type of file that the schema key refers to. json or xml\r\n   */\r\n  protected findEligibleSchemaKeys(desiredKey: Readonly<SchemaKey>, matchType: SchemaMatchType, format: string): FileSchemaKey[] {\r\n    const foundFiles = new Array<FileSchemaKey>();\r\n\r\n    let twoVersionSuffix: string;\r\n    let threeVersionSuffix: string;\r\n    const readVersion = desiredKey.readVersion.toString();\r\n    const writeVersion = desiredKey.writeVersion.toString();\r\n    const minorVersion = desiredKey.minorVersion.toString();\r\n\r\n    if (matchType === SchemaMatchType.Latest) {\r\n      twoVersionSuffix = (`.*.*.ecschema.${format}`);\r\n      threeVersionSuffix = (`.*.*.*.ecschema.${format}`);\r\n    } else if (matchType === SchemaMatchType.LatestWriteCompatible) {\r\n      twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\r\n      threeVersionSuffix = formatString(`.{0}.{1}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"));\r\n    } else if (matchType === SchemaMatchType.LatestReadCompatible) {\r\n      twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\r\n      threeVersionSuffix = formatString(`.{0}.*.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\r\n    } else {\r\n      twoVersionSuffix = formatString(`.{0}.{1}.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"));\r\n      threeVersionSuffix = formatString(`.{0}.{1}.{2}.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"), padStartEx(minorVersion, 2, \"0\"));\r\n    }\r\n\r\n    const twoVersionExpression = desiredKey.name + twoVersionSuffix;\r\n    const threeVersionExpression = desiredKey.name + threeVersionSuffix;\r\n\r\n    for (const searchPath of this.searchPaths) {\r\n      this.addCandidateNoExtSchemaKey(foundFiles, searchPath, desiredKey.name, desiredKey, matchType, format);\r\n      this.addCandidateSchemaKeys(foundFiles, searchPath, twoVersionExpression, desiredKey, matchType, format);\r\n      this.addCandidateSchemaKeys(foundFiles, searchPath, threeVersionExpression, desiredKey, matchType, format);\r\n    }\r\n\r\n    return foundFiles;\r\n  }\r\n\r\n  public abstract getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;\r\n\r\n  /**\r\n   * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the\r\n   * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.\r\n   * @param lhs The 'left-hand' FileSchemaKey.\r\n   * @param rhs The 'right-hand' FileSchemaKey.\r\n   */\r\n  public compareSchemaKeyByVersion = (lhs: FileSchemaKey, rhs: FileSchemaKey): number => {\r\n    return lhs.compareByVersion(rhs);\r\n  };\r\n}\r\n"]}
+{"version":3,"file":"SchemaFileLocater.js","sourceRoot":"","sources":["../../src/SchemaFileLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,yBAAyB;AACzB,6BAA6B;AAC7B,6BAA6B;AAC7B,gEAA6F;AAE7F;;GAEG;AAEH,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,GAAG,IAAc,EAAE,EAAE;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACrD,OAAO,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,WAAW;YAC3C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACjB,CAAC,CAAC,KAAK,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,YAAoB,EAAE,SAAiB,EAAE,EAAE;IAC1E,YAAY,GAAG,YAAY,IAAI,CAAC,CAAC,CAAC,iDAAiD;IACnF,SAAS,GAAG,MAAM,CAAC,CAAC,OAAO,SAAS,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACzE,IAAI,GAAG,CAAC,MAAM,GAAG,YAAY,EAAE;QAC7B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;KACpB;SAAM;QACL,YAAY,GAAG,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC;QACzC,IAAI,YAAY,GAAG,SAAS,CAAC,MAAM,EAAE;YACnC,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,yDAAyD;SAC1H;QACD,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,GAAG,GAAG,CAAC;KAC/C;AACH,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAa,aAAc,SAAQ,6BAAS;IAM1C;;;;;;OAMG;IACH,YAAY,GAAc,EAAE,QAAgB,EAAE,UAAmB;QAC/D,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAlBD,sCAkBC;AAED;;;GAGG;AACH,MAAsB,iBAAiB;IAGrC;QAkKA;;;;;WAKG;QACI,8BAAyB,GAAG,CAAC,GAAkB,EAAE,GAAkB,EAAU,EAAE;YACpF,OAAO,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC,CAAC;QAzKA,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QAChD,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzD,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC3C,IAAI,GAAG;oBACL,MAAM,CAAC,GAAG,CAAC,CAAC;;oBAEZ,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,wBAAwB,CAAC,QAAgB;QAC9C,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,QAAgB;QACtC,OAAO,IAAI,OAAO,CAAsB,CAAC,OAAO,EAAE,EAAE;YAClD,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC7C,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,cAAc,CAAC,QAAgB;QACpC,OAAO,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,WAAqB;QAC/C,sDAAsD;QACtD,KAAK,MAAM,UAAU,IAAI,WAAW;YAClC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,UAAkB;QAC3C,sDAAsD;QACtD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC;YACzD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;;;OASG;IACK,0BAA0B,CAAC,UAA2B,EAAE,UAAkB,EAAE,UAAkB,EAAE,UAA+B,EAAE,SAA0B,EAAE,MAAc;QACjL,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,UAAU,aAAa,MAAM,EAAE,CAAC,CAAC;QAE3E,kCAAkC;QAClC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC1B,OAAO;QAET,gBAAgB;QAChB,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI;YACP,OAAO;QAET,qBAAqB;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE/C,2CAA2C;QAC3C,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;YACpC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACK,sBAAsB,CAAC,UAA2B,EAAE,UAAkB,EAAE,UAAkB,EAAE,UAA+B,EAAE,SAA0B,EAAE,MAAc;QAC7K,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3D,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE;YAChC,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,aAAa,MAAM,EAAE,CAAC,CAAC,CAAC;YAC7D,mDAAmD;YACnD,wFAAwF;YACxF,IAAI,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;gBACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACzB,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aAC5B;YAED,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI;gBACP,SAAS;YAEX,MAAM,SAAS,GAAG,6BAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAClD,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;gBAC1C,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;SACzE;IACH,CAAC;IAED;;;;;;OAMG;IACO,sBAAsB,CAAC,UAA+B,EAAE,SAA0B,EAAE,MAAc;QAC1G,MAAM,UAAU,GAAG,IAAI,KAAK,EAAiB,CAAC;QAE9C,IAAI,gBAAwB,CAAC;QAC7B,IAAI,kBAA0B,CAAC;QAC/B,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;QACtD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAExD,IAAI,SAAS,KAAK,mCAAe,CAAC,MAAM,EAAE;YACxC,gBAAgB,GAAG,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC;YAC/C,kBAAkB,GAAG,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;SACpD;aAAM,IAAI,SAAS,KAAK,mCAAe,CAAC,qBAAqB,EAAE;YAC9D,gBAAgB,GAAG,YAAY,CAAC,mBAAmB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,CAAC,uBAAuB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SACvI;aAAM,IAAI,SAAS,KAAK,mCAAe,CAAC,oBAAoB,EAAE;YAC7D,gBAAgB,GAAG,YAAY,CAAC,mBAAmB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,CAAC,qBAAqB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SACnG;aAAM;YACL,gBAAgB,GAAG,YAAY,CAAC,qBAAqB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAClI,kBAAkB,GAAG,YAAY,CAAC,yBAAyB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;SAC3K;QAED,MAAM,oBAAoB,GAAG,UAAU,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAChE,MAAM,sBAAsB,GAAG,UAAU,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAEpE,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE;YACzC,IAAI,CAAC,0BAA0B,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACxG,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,oBAAoB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACzG,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,sBAAsB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;SAC5G;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;CAaF;AA9KD,8CA8KC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport * as fs from \"fs\";\nimport * as glob from \"glob\";\nimport * as path from \"path\";\nimport { Schema, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\n\n/** @packageDocumentation\n * @module Locaters\n */\n\nconst formatString = (format: string, ...args: string[]) => {\n  return format.replace(/{(\\d+)}/g, (match, theNumber) => {\n    return typeof args[theNumber] !== \"undefined\"\n      ? args[theNumber]\n      : match;\n  });\n};\n\nconst padStartEx = (str: string, targetLength: number, padString: string) => {\n  targetLength = targetLength >> 0; // truncate if number or convert non-number to 0;\n  padString = String((typeof padString !== \"undefined\" ? padString : \" \"));\n  if (str.length > targetLength) {\n    return String(str);\n  } else {\n    targetLength = targetLength - str.length;\n    if (targetLength > padString.length) {\n      padString += padString.repeat(targetLength / padString.length); // append to original to ensure we are longer than needed\n    }\n    return padString.slice(0, targetLength) + str;\n  }\n};\n\n/**\n * A SchemaKey implementation that aids in identifying Schema files via the\n * addition of two properties: fileName and schemaText.  The fileName contains the\n * full path to the file on disk and schemaText is the full string representation\n * of the Schema.\n * @beta\n */\nexport class FileSchemaKey extends SchemaKey {\n  // The schema file associated with the SchemaKey\n  public fileName: string;\n  // The JSON text for the schema loaded\n  public schemaText?: string;\n\n  /**\n   * Initializes a new FileSchemaKey object.\n   * @param key The EC SchemaKey identifying the Schema.\n   * @param fileName The full path to the Schema file.\n   * @param schemaText The string representation of the Schema\n   * loaded from disk. Optional.\n   */\n  constructor(key: SchemaKey, fileName: string, schemaJson?: string) {\n    super(key.name, key.version);\n    this.fileName = fileName;\n    this.schemaText = schemaJson;\n  }\n}\n\n/**\n * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater\n * @beta - Needs further testing and possibly moved to a separate package.\n */\nexport abstract class SchemaFileLocater {\n  public searchPaths: string[];\n\n  constructor() {\n    this.searchPaths = [];\n  }\n\n  public async readUtf8FileToString(filePath: string): Promise<string | undefined> {\n    return new Promise<string | undefined>((resolve, reject) => {\n      fs.readFile(filePath, \"utf-8\", (err, data) => {\n        if (err)\n          reject(err);\n        else\n          resolve(data);\n      });\n    });\n  }\n\n  public readUtf8FileToStringSync(filePath: string): string | undefined {\n    return fs.readFileSync(filePath, \"utf-8\");\n  }\n\n  public async fileExists(filePath: string): Promise<boolean | undefined> {\n    return new Promise<boolean | undefined>((resolve) => {\n      fs.access(filePath, fs.constants.F_OK, (err) => {\n        resolve(err ? false : true);\n      });\n    });\n  }\n\n  public fileExistsSync(filePath: string): boolean | undefined {\n    return fs.existsSync(filePath);\n  }\n\n  /**\n   * Adds more search paths used by this locator to find the\n   * Schema files.\n   * @param schemaPaths An array of search paths to add\n   */\n  public addSchemaSearchPaths(schemaPaths: string[]) {\n    // If the path is not in the schemaPaths array, add it\n    for (const schemaPath of schemaPaths)\n      this.addSchemaSearchPath(schemaPath);\n  }\n\n  /**\n   * Add one search path used by this locator to find the\n   * Schema files.\n   * @param schemaPath A search path to add\n   */\n  public addSchemaSearchPath(schemaPath: string) {\n    // If the path is not in the schemaPaths array, add it\n    if (!this.searchPaths.find((entry) => entry === schemaPath))\n      this.searchPaths.push(schemaPath);\n  }\n\n  protected abstract getSchemaKey(data: string): SchemaKey;\n\n  /**\n   * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method\n   * only attempts to find schema files that have no version in the file name.\n   * @param foundFiles The collection of SchemaKeys found in the given directory.\n   * @param schemaPath The directory in which to search for the Schemas.\n   * @param schemaName The short name of the Schema (without version).\n   * @param desiredKey The SchemaKey used to find matching Schema files.\n   * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.\n   * @param format The type of file that the schema key refers to. json or xml\n   */\n  private addCandidateNoExtSchemaKey(foundFiles: FileSchemaKey[], schemaPath: string, schemaName: string, desiredKey: Readonly<SchemaKey>, matchType: SchemaMatchType, format: string) {\n    const fullPath = path.join(schemaPath, `${schemaName}.ecschema.${format}`);\n\n    // If the file does not exist, end\n    if (!fs.existsSync(fullPath))\n      return;\n\n    // Read the file\n    const file = fs.readFileSync(fullPath);\n    if (!file)\n      return;\n\n    // Get the schema key\n    const key = this.getSchemaKey(file.toString());\n\n    // If the key matches, put it in foundFiles\n    if (key.matches(desiredKey, matchType))\n      foundFiles.push(new FileSchemaKey(key, fullPath, file.toString()));\n  }\n\n  /**\n   * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey\n   * @param foundFiles The collection of SchemaKeys found in the given directory\n   * @param schemaPath The directory in which to search for the Schemas\n   * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.\n   * @param desiredKey The schemaKey used to find matching Schema files\n   * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.\n   * @param format The type of file that the schema key refers to. json or xml\n   */\n  private addCandidateSchemaKeys(foundFiles: FileSchemaKey[], schemaPath: string, fileFilter: string, desiredKey: Readonly<SchemaKey>, matchType: SchemaMatchType, format: string) {\n    const fullPath = path.join(schemaPath, fileFilter);\n\n    const result = new glob.GlobSync(fullPath, { sync: true });\n    for (const match of result.found) {\n      let fileName = path.basename(match, (`.ecschema.${format}`));\n      // TODO: should this be moved or handled elsewhere?\n      // Handles two version file names - SchemaKey.parseString supports only 3 version names.\n      if (/[^\\d]\\.\\d?\\d\\.\\d?\\d$/.test(fileName)) {\n        const parts = fileName.split(\".\");\n        parts.splice(2, 0, \"00\");\n        fileName = parts.join(\".\");\n      }\n\n      const file = fs.readFileSync(match);\n      if (!file)\n        continue;\n\n      const schemaKey = SchemaKey.parseString(fileName);\n      if (schemaKey.matches(desiredKey, matchType))\n        foundFiles.push(new FileSchemaKey(schemaKey, match, file.toString()));\n    }\n  }\n\n  /**\n   * Attempts to find all Schema files in the configurable search paths that match\n   * the desired SchemaKey.\n   * @param desiredKey The SchemaKey to match.\n   * @param matchType The SchemaMatchType.\n   * @param format The type of file that the schema key refers to. json or xml\n   */\n  protected findEligibleSchemaKeys(desiredKey: Readonly<SchemaKey>, matchType: SchemaMatchType, format: string): FileSchemaKey[] {\n    const foundFiles = new Array<FileSchemaKey>();\n\n    let twoVersionSuffix: string;\n    let threeVersionSuffix: string;\n    const readVersion = desiredKey.readVersion.toString();\n    const writeVersion = desiredKey.writeVersion.toString();\n    const minorVersion = desiredKey.minorVersion.toString();\n\n    if (matchType === SchemaMatchType.Latest) {\n      twoVersionSuffix = (`.*.*.ecschema.${format}`);\n      threeVersionSuffix = (`.*.*.*.ecschema.${format}`);\n    } else if (matchType === SchemaMatchType.LatestWriteCompatible) {\n      twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\n      threeVersionSuffix = formatString(`.{0}.{1}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"));\n    } else if (matchType === SchemaMatchType.LatestReadCompatible) {\n      twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\n      threeVersionSuffix = formatString(`.{0}.*.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\n    } else {\n      twoVersionSuffix = formatString(`.{0}.{1}.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"));\n      threeVersionSuffix = formatString(`.{0}.{1}.{2}.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"), padStartEx(minorVersion, 2, \"0\"));\n    }\n\n    const twoVersionExpression = desiredKey.name + twoVersionSuffix;\n    const threeVersionExpression = desiredKey.name + threeVersionSuffix;\n\n    for (const searchPath of this.searchPaths) {\n      this.addCandidateNoExtSchemaKey(foundFiles, searchPath, desiredKey.name, desiredKey, matchType, format);\n      this.addCandidateSchemaKeys(foundFiles, searchPath, twoVersionExpression, desiredKey, matchType, format);\n      this.addCandidateSchemaKeys(foundFiles, searchPath, threeVersionExpression, desiredKey, matchType, format);\n    }\n\n    return foundFiles;\n  }\n\n  public abstract getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;\n\n  /**\n   * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the\n   * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.\n   * @param lhs The 'left-hand' FileSchemaKey.\n   * @param rhs The 'right-hand' FileSchemaKey.\n   */\n  public compareSchemaKeyByVersion = (lhs: FileSchemaKey, rhs: FileSchemaKey): number => {\n    return lhs.compareByVersion(rhs);\n  };\n}\n"]}

package/lib/cjs/SchemaFileUtility.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaFileUtility.js","sourceRoot":"","sources":["../../src/SchemaFileUtility.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,+BAA+B;AAC/B,6BAA6B;AAC7B,2CAA0D;AAG1D;;GAEG;AAEH;;;GAGG;AACH,MAAa,iBAAiB;IAE5B;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAc,EAAE,UAAkB;QACvE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QAEtD,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACxD,IAAI;YACF,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,GAAG,GAAG,sCAAsC,QAAQ,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;SACtB;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,MAAc;QACvD,IAAI,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,wCAAwC,EAAE,iBAAiB,CAAC,CAAC;QAE1G,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,UAAU,GAAG,IAAI,sBAAa,EAAE,CAAC;QACvC,OAAO,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,MAAc,EAAE,UAAkB;QAC7D,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,GAAG,GAAG,yBAAyB,OAAO,mBAAmB,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;SACtB;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,IAAI,eAAe,CAAC,CAAC;IAC9D,CAAC;CACF;AAzCD,8CAyCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport * as fs from \"fs-extra\";\r\nimport * as path from \"path\";\r\nimport { DOMParser, XMLSerializer } from \"@xmldom/xmldom\";\r\nimport { Schema } from \"@itwin/ecschema-metadata\";\r\n\r\n/** @packageDocumentation\r\n * @module Utils\r\n */\r\n\r\n/**\r\n * Utility class to assist in creating serialized EC Schemas on the file system.\r\n * @beta\r\n */\r\nexport class SchemaFileUtility {\r\n\r\n  /**\r\n   * Writes a Schema to an xml file to the specified output path.\r\n   * @param schema The Schema to serialize.\r\n   * @param outputPath The directory in which to create the file.\r\n   */\r\n  public static async writeSchemaXmlFile(schema: Schema, outputPath: string) {\r\n    const xml = await this.writeSchemaToXmlString(schema);\r\n\r\n    const baseFile = this.getSchemaPath(schema, outputPath);\r\n    try {\r\n      await fs.writeFile(baseFile, xml);\r\n    } catch (err: any) {\r\n      const msg = `An error occurred writing to file '${baseFile}': ${err.message}`;\r\n      throw new Error(msg);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Writes a Schema to an xml string.\r\n   * @param schema The Schema to serialize.\r\n   */\r\n  public static async writeSchemaToXmlString(schema: Schema): Promise<string> {\r\n    let xmlDoc = new DOMParser().parseFromString(`<?xml version=\"1.0\" encoding=\"UTF-8\"?>`, \"application/xml\");\r\n\r\n    xmlDoc = await schema.toXml(xmlDoc);\r\n    const serializer = new XMLSerializer();\r\n    return serializer.serializeToString(xmlDoc);\r\n  }\r\n\r\n  private static getSchemaPath(schema: Schema, outputPath: string): string {\r\n    const realDir = path.normalize(outputPath);\r\n    const test = fs.pathExistsSync(realDir);\r\n    if (!test) {\r\n      const msg = `The output directory '${realDir}' does not exist.`;\r\n      throw new Error(msg);\r\n    }\r\n\r\n    return path.resolve(realDir, `${schema.name}.ecschema.xml`);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SchemaFileUtility.js","sourceRoot":"","sources":["../../src/SchemaFileUtility.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,+BAA+B;AAC/B,6BAA6B;AAC7B,2CAA0D;AAG1D;;GAEG;AAEH;;;GAGG;AACH,MAAa,iBAAiB;IAE5B;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAc,EAAE,UAAkB;QACvE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;QAEtD,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACxD,IAAI;YACF,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,GAAG,GAAG,sCAAsC,QAAQ,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;SACtB;IACH,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,MAAc;QACvD,IAAI,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,wCAAwC,EAAE,iBAAiB,CAAC,CAAC;QAE1G,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,UAAU,GAAG,IAAI,sBAAa,EAAE,CAAC;QACvC,OAAO,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,MAAc,EAAE,UAAkB;QAC7D,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,EAAE;YACT,MAAM,GAAG,GAAG,yBAAyB,OAAO,mBAAmB,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;SACtB;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,IAAI,eAAe,CAAC,CAAC;IAC9D,CAAC;CACF;AAzCD,8CAyCC","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*--------------------------------------------------------------------------------------------*/\nimport * as fs from \"fs-extra\";\nimport * as path from \"path\";\nimport { DOMParser, XMLSerializer } from \"@xmldom/xmldom\";\nimport { Schema } from \"@itwin/ecschema-metadata\";\n\n/** @packageDocumentation\n * @module Utils\n */\n\n/**\n * Utility class to assist in creating serialized EC Schemas on the file system.\n * @beta\n */\nexport class SchemaFileUtility {\n\n  /**\n   * Writes a Schema to an xml file to the specified output path.\n   * @param schema The Schema to serialize.\n   * @param outputPath The directory in which to create the file.\n   */\n  public static async writeSchemaXmlFile(schema: Schema, outputPath: string) {\n    const xml = await this.writeSchemaToXmlString(schema);\n\n    const baseFile = this.getSchemaPath(schema, outputPath);\n    try {\n      await fs.writeFile(baseFile, xml);\n    } catch (err: any) {\n      const msg = `An error occurred writing to file '${baseFile}': ${err.message}`;\n      throw new Error(msg);\n    }\n  }\n\n  /**\n   * Writes a Schema to an xml string.\n   * @param schema The Schema to serialize.\n   */\n  public static async writeSchemaToXmlString(schema: Schema): Promise<string> {\n    let xmlDoc = new DOMParser().parseFromString(`<?xml version=\"1.0\" encoding=\"UTF-8\"?>`, \"application/xml\");\n\n    xmlDoc = await schema.toXml(xmlDoc);\n    const serializer = new XMLSerializer();\n    return serializer.serializeToString(xmlDoc);\n  }\n\n  private static getSchemaPath(schema: Schema, outputPath: string): string {\n    const realDir = path.normalize(outputPath);\n    const test = fs.pathExistsSync(realDir);\n    if (!test) {\n      const msg = `The output directory '${realDir}' does not exist.`;\n      throw new Error(msg);\n    }\n\n    return path.resolve(realDir, `${schema.name}.ecschema.xml`);\n  }\n}\n"]}

package/lib/cjs/SchemaJsonFileLocater.js.map

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

package/lib/cjs/SchemaStringLocater.d.ts

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

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

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

package/lib/cjs/SchemaStringLocater.js

@@ -0,0 +1,85 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaStringLocater = exports.StringSchemaKey = void 0;
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+/** @packageDocumentation
+ * @module Locaters
+ */
+/**
+ * A SchemaKey implementation that aids in identifying Schema strings via the
+ * addition of the schemaText property. The schemaText is the full XML string
+ * representation of the Schema.
+ * @beta
+ */
+class StringSchemaKey extends ecschema_metadata_1.SchemaKey {
+    /**
+     * Initializes a new StringSchemaKey object.
+     * @param key The EC SchemaKey identifying the Schema.
+     * @param schemaText The string representation of the Schema
+     */
+    constructor(key, schemaText) {
+        super(key.name, key.version);
+        this.schemaText = schemaText;
+    }
+}
+exports.StringSchemaKey = StringSchemaKey;
+/**
+ * Abstract class to hold common/overlapping functionality between SchemaJsonStringLocater and SchemaXmlStringLocater
+ * @beta
+ */
+class SchemaStringLocater {
+    constructor() {
+        /**
+         * Compares two Schema versions.  If the left-hand version is greater, 1 is returned. If the
+         * left-hand version is less, -1 us returned.  If the versions are an exact match, 0 is returned.
+         * @param lhs The 'left-hand' StringSchemaKey.
+         * @param rhs The 'right-hand' StringSchemaKey.
+         */
+        this.compareSchemaKeyByVersion = (lhs, rhs) => {
+            return lhs.compareByVersion(rhs);
+        };
+        this.schemaStrings = [];
+    }
+    /**
+     * Adds schema strings used by this locator to find the
+     * Schemas.
+     * @param schemaPaths An array of Schema strings to add
+     */
+    addSchemaStrings(schemaStrings) {
+        // If the path is not in the schemaPaths array, add it
+        for (const schemaString of schemaStrings)
+            this.addSchemaString(schemaString);
+    }
+    /**
+     * Adds a schema string used by this locator to locate and load Schemas.
+     * @param schemaText The text of the Schema
+     */
+    addSchemaString(schemaString) {
+        const schemaKey = this.getSchemaKey(schemaString);
+        // If the string is not in the schemaStrings array, add it
+        if (!this.schemaStrings.find((entry) => this.getSchemaKey(entry).matches(schemaKey, ecschema_metadata_1.SchemaMatchType.Exact)))
+            this.schemaStrings.push(schemaString);
+    }
+    /**
+     * Attempts to find all Schema strings that match the desired SchemaKey.
+     * @param desiredKey The SchemaKey to match.
+     * @param matchType The SchemaMatchType.
+     */
+    findEligibleSchemaKeys(desiredKey, matchType) {
+        const foundStrings = new Array();
+        for (const schemaString of this.schemaStrings) {
+            // Get the schema key
+            const key = this.getSchemaKey(schemaString);
+            // If the key matches, put it in foundFiles
+            if (key.matches(desiredKey, matchType))
+                foundStrings.push(new StringSchemaKey(key, schemaString));
+        }
+        return foundStrings;
+    }
+}
+exports.SchemaStringLocater = SchemaStringLocater;
+//# sourceMappingURL=SchemaStringLocater.js.map

package/lib/cjs/SchemaStringLocater.js.map

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

package/lib/cjs/SchemaXmlFileLocater.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaXmlFileLocater.js","sourceRoot":"","sources":["../../src/SchemaXmlFileLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,6BAA6B;AAC7B,2CAA2C;AAC3C,gEAEkC;AAClC,2DAAuE;AAEvE;;GAEG;AAEH;;;;GAIG;AACH,MAAa,oBAAqB,SAAQ,qCAAiB;IACzD;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAmB,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACzG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC7D,OAAO,MAAW,CAAC;IACrB,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,MAAM,UAAU,GAAoB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAE7F,IAAI,CAAC,KAAK,UAAU,CAAC,MAAM;YACzB,OAAO,SAAS,CAAC;QAEnB,6DAA6D;QAC7D,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC;QAEzC,gBAAgB;QAChB,IAAI,SAAS,KAAK,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjD,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,SAAS,KAAK,UAAU;YAC1B,OAAO,SAAS,CAAC;QAEnB,MAAM,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,oCAAgB,CAAC,6BAAS,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,IAAI,0BAAM,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAmB,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACvG,MAAM,UAAU,GAAoB,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAEvF,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,6DAA6D;QAC7D,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC;QAEzC,gBAAgB;QAChB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC;YAClC,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU;YACb,OAAO,SAAS,CAAC;QAEnB,MAAM,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,oCAAgB,CAAC,6BAAS,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,MAAM,GAAW,IAAI,0BAAM,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEjD,OAAO,MAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,IAAY;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;QAElH,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAChE,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,6EAA6E,CAAC,CAAC;QAE5I,MAAM,GAAG,GAAG,IAAI,6BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,6BAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrE,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAvGD,oDAuGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport * as path from \"path\";\r\nimport { DOMParser } from \"@xmldom/xmldom\";\r\nimport {\r\n  ECObjectsError, ECObjectsStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType, SchemaReadHelper, XmlParser,\r\n} from \"@itwin/ecschema-metadata\";\r\nimport { FileSchemaKey, SchemaFileLocater } from \"./SchemaFileLocater\";\r\n\r\n/** @packageDocumentation\r\n * @module Locaters\r\n */\r\n\r\n/**\r\n * A SchemaLocater implementation for locating XML Schema files\r\n * from the file system using configurable search paths.\r\n * @beta This is a workaround the current lack of a full xml parser.\r\n */\r\nexport class SchemaXmlFileLocater extends SchemaFileLocater implements ISchemaLocater {\r\n  /**\r\n   * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths\r\n   * to locate the XML Schema file from the file system.\r\n   * @param key The SchemaKey of the Schema to retrieve.\r\n   * @param matchType The SchemaMatchType.\r\n   * @param context The SchemaContext that will control the lifetime of the schema.\r\n   */\r\n  public async getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined> {\r\n    await this.getSchemaInfo(key, matchType, context);\r\n\r\n    const schema = await context.getCachedSchema(key, matchType);\r\n    return schema as T;\r\n  }\r\n\r\n  /**\r\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\r\n    * The fully loaded schema can be gotten later from the context using the getCachedSchema method.\r\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n    * @param matchType The match type to use when locating the schema\r\n    * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\r\n    */\r\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\r\n    const candidates: FileSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType, \"xml\");\r\n\r\n    if (0 === candidates.length)\r\n      return undefined;\r\n\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\r\n    const schemaPath = maxCandidate.fileName;\r\n\r\n    // Load the file\r\n    if (undefined === await this.fileExists(schemaPath))\r\n      return undefined;\r\n\r\n    const schemaText = await this.readUtf8FileToString(schemaPath);\r\n    if (undefined === schemaText)\r\n      return undefined;\r\n\r\n    const parser = new DOMParser();\r\n    const document = parser.parseFromString(schemaText);\r\n\r\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\r\n    const reader = new SchemaReadHelper(XmlParser, context);\r\n    const schema = new Schema(context);\r\n\r\n    return reader.readSchemaInfo(schema, document);\r\n  }\r\n\r\n  /**\r\n   * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths\r\n   * to locate the XML Schema file from the file system.\r\n   * @param key The SchemaKey of the Schema to retrieve.\r\n   * @param matchType The SchemaMatchType.\r\n   * @param context The SchemaContext that will control the lifetime of the schema.\r\n   */\r\n  public getSchemaSync<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined {\r\n    const candidates: FileSchemaKey[] = this.findEligibleSchemaKeys(key, matchType, \"xml\");\r\n\r\n    if (!candidates || candidates.length === 0)\r\n      return undefined;\r\n\r\n    // eslint-disable-next-line @typescript-eslint/unbound-method\r\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\r\n    const schemaPath = maxCandidate.fileName;\r\n\r\n    // Load the file\r\n    if (!this.fileExistsSync(schemaPath))\r\n      return undefined;\r\n\r\n    const schemaText = this.readUtf8FileToStringSync(schemaPath);\r\n    if (!schemaText)\r\n      return undefined;\r\n\r\n    const parser = new DOMParser();\r\n    const document = parser.parseFromString(schemaText);\r\n\r\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\r\n    const reader = new SchemaReadHelper(XmlParser, context);\r\n    let schema: Schema = new Schema(context);\r\n    schema = reader.readSchemaSync(schema, document);\r\n\r\n    return schema as T;\r\n  }\r\n\r\n  /**\r\n   * Constructs a SchemaKey based on the information in the Schema XML.\r\n   * @param data The Schema XML as a string.\r\n   */\r\n  public getSchemaKey(data: string): SchemaKey {\r\n    const matches = data.match(/<ECSchema ([^]+?)>/g);\r\n    if (!matches || matches.length !== 1)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given file`);\r\n\r\n    const name = matches[0].match(/schemaName=\"(.+?)\"/);\r\n    const version = matches[0].match(/version=\"(.+?)\"/);\r\n    if (!name || name.length !== 2 || !version || version.length !== 2)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\r\n\r\n    const key = new SchemaKey(name[1], ECVersion.fromString(version[1]));\r\n    return key;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SchemaXmlFileLocater.js","sourceRoot":"","sources":["../../src/SchemaXmlFileLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,6BAA6B;AAC7B,2CAA2C;AAC3C,gEAEkC;AAClC,2DAAuE;AAEvE;;GAEG;AAEH;;;;GAIG;AACH,MAAa,oBAAqB,SAAQ,qCAAiB;IACzD;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAmB,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACzG,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC7D,OAAO,MAAW,CAAC;IACrB,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,MAAM,UAAU,GAAoB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAE7F,IAAI,CAAC,KAAK,UAAU,CAAC,MAAM;YACzB,OAAO,SAAS,CAAC;QAEnB,6DAA6D;QAC7D,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC;QAEzC,gBAAgB;QAChB,IAAI,SAAS,KAAK,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjD,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,SAAS,KAAK,UAAU;YAC1B,OAAO,SAAS,CAAC;QAEnB,MAAM,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,oCAAgB,CAAC,6BAAS,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,IAAI,0BAAM,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAmB,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACvG,MAAM,UAAU,GAAoB,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAEvF,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,6DAA6D;QAC7D,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC;QAEzC,gBAAgB;QAChB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC;YAClC,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU;YACb,OAAO,SAAS,CAAC;QAEnB,MAAM,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,oCAAgB,CAAC,6BAAS,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,MAAM,GAAW,IAAI,0BAAM,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEjD,OAAO,MAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,IAAY;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;QAElH,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAChE,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,6EAA6E,CAAC,CAAC;QAE5I,MAAM,GAAG,GAAG,IAAI,6BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,6BAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrE,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAvGD,oDAuGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport * as path from \"path\";\nimport { DOMParser } from \"@xmldom/xmldom\";\nimport {\n  ECObjectsError, ECObjectsStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType, SchemaReadHelper, XmlParser,\n} from \"@itwin/ecschema-metadata\";\nimport { FileSchemaKey, SchemaFileLocater } from \"./SchemaFileLocater\";\n\n/** @packageDocumentation\n * @module Locaters\n */\n\n/**\n * A SchemaLocater implementation for locating XML Schema files\n * from the file system using configurable search paths.\n * @beta This is a workaround the current lack of a full xml parser.\n */\nexport class SchemaXmlFileLocater extends SchemaFileLocater implements ISchemaLocater {\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.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema.\n   */\n  public async getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined> {\n    await this.getSchemaInfo(key, matchType, context);\n\n    const schema = await context.getCachedSchema(key, matchType);\n    return schema as T;\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    const candidates: FileSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType, \"xml\");\n\n    if (0 === candidates.length)\n      return undefined;\n\n    // eslint-disable-next-line @typescript-eslint/unbound-method\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\n    const schemaPath = maxCandidate.fileName;\n\n    // Load the file\n    if (undefined === await this.fileExists(schemaPath))\n      return undefined;\n\n    const schemaText = await this.readUtf8FileToString(schemaPath);\n    if (undefined === schemaText)\n      return undefined;\n\n    const parser = new DOMParser();\n    const document = parser.parseFromString(schemaText);\n\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\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 using the configured search paths\n   * to locate the XML Schema file from the file system.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema.\n   */\n  public getSchemaSync<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined {\n    const candidates: FileSchemaKey[] = this.findEligibleSchemaKeys(key, matchType, \"xml\");\n\n    if (!candidates || candidates.length === 0)\n      return undefined;\n\n    // eslint-disable-next-line @typescript-eslint/unbound-method\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\n    const schemaPath = maxCandidate.fileName;\n\n    // Load the file\n    if (!this.fileExistsSync(schemaPath))\n      return undefined;\n\n    const schemaText = this.readUtf8FileToStringSync(schemaPath);\n    if (!schemaText)\n      return undefined;\n\n    const parser = new DOMParser();\n    const document = parser.parseFromString(schemaText);\n\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\n    const reader = new SchemaReadHelper(XmlParser, context);\n    let schema: Schema = new Schema(context);\n    schema = reader.readSchemaSync(schema, document);\n\n    return schema as T;\n  }\n\n  /**\n   * Constructs a SchemaKey based on the information in the Schema XML.\n   * @param data The Schema XML as a string.\n   */\n  public getSchemaKey(data: string): SchemaKey {\n    const matches = data.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    const key = new SchemaKey(name[1], ECVersion.fromString(version[1]));\n    return key;\n  }\n}\n"]}

package/lib/cjs/SchemaXmlStringLocater.d.ts

@@ -0,0 +1,48 @@
+import { ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaStringLocater } from "./SchemaStringLocater";
+/** @packageDocumentation
+ * @module Locaters
+ */
+/**
+ * A SchemaLocator implementation for locating and deserializing EC Schemas from XML strings
+ * loaded in memory.
+ * @beta
+ */
+export declare class SchemaXmlStringLocater extends SchemaStringLocater implements ISchemaLocater {
+    /**
+     * Constructs a SchemaKey based on the information in the Schema XML.
+     * @param schemaXml The Schema XML as a string.
+     */
+    getSchemaKey(schemaXml: string): SchemaKey;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by searching the configured
+     * Schema strings.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+     */
+    getSchema<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by searching the configured
+     * Schema strings.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+     */
+    getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
+    /**
+     * Parses a valid EC 2.0 version string and returns an ECVersion object. The second digit becomes the minor version,
+     * and a zero is inserted as the 'write' digit. Example: "1.1" -> "1.0.1".
+     * @param versionString A valid EC 2.0 version string of the format, 'RR.mm'.
+     */
+    private fromECv2String;
+}
+//# sourceMappingURL=SchemaXmlStringLocater.d.ts.map

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

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

package/lib/cjs/SchemaXmlStringLocater.js

@@ -0,0 +1,106 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaXmlStringLocater = void 0;
+const xmldom_1 = require("@xmldom/xmldom");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const SchemaStringLocater_1 = require("./SchemaStringLocater");
+/** @packageDocumentation
+ * @module Locaters
+ */
+/**
+ * A SchemaLocator implementation for locating and deserializing EC Schemas from XML strings
+ * loaded in memory.
+ * @beta
+ */
+class SchemaXmlStringLocater extends SchemaStringLocater_1.SchemaStringLocater {
+    /**
+     * Constructs a SchemaKey based on the information in the Schema XML.
+     * @param schemaXml The Schema XML as a string.
+     */
+    getSchemaKey(schemaXml) {
+        const matches = schemaXml.match(/<ECSchema ([^]+?)>/g);
+        if (!matches || matches.length !== 1)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given string`);
+        const name = matches[0].match(/schemaName="(.+?)"/);
+        const version = matches[0].match(/version="(.+?)"/);
+        if (!name || name.length !== 2 || !version || version.length !== 2)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);
+        const ecVersion = ecschema_metadata_1.ECVersion.fromString(version[1]);
+        const key = new ecschema_metadata_1.SchemaKey(name[1], ecVersion);
+        return key;
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by searching the configured
+     * Schema strings.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+     */
+    async getSchema(schemaKey, matchType, context) {
+        await this.getSchemaInfo(schemaKey, matchType, context);
+        const schema = await context.getCachedSchema(schemaKey, matchType);
+        return schema;
+    }
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    async getSchemaInfo(schemaKey, matchType, context) {
+        // Grab all schema strings that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType);
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaText = maxCandidate.schemaText;
+        const parser = new xmldom_1.DOMParser();
+        const document = parser.parseFromString(schemaText);
+        const reader = new ecschema_metadata_1.SchemaReadHelper(ecschema_metadata_1.XmlParser, context);
+        const schema = new ecschema_metadata_1.Schema(context);
+        return reader.readSchemaInfo(schema, document);
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by searching the configured
+     * Schema strings.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+     */
+    getSchemaSync(schemaKey, matchType, context) {
+        // Grab all schema strings that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType);
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaText = maxCandidate.schemaText;
+        const parser = new xmldom_1.DOMParser();
+        const document = parser.parseFromString(schemaText);
+        const reader = new ecschema_metadata_1.SchemaReadHelper(ecschema_metadata_1.XmlParser, context);
+        let schema = new ecschema_metadata_1.Schema(context);
+        schema = reader.readSchemaSync(schema, document);
+        return schema;
+    }
+    /**
+     * Parses a valid EC 2.0 version string and returns an ECVersion object. The second digit becomes the minor version,
+     * and a zero is inserted as the 'write' digit. Example: "1.1" -> "1.0.1".
+     * @param versionString A valid EC 2.0 version string of the format, 'RR.mm'.
+     */
+    fromECv2String(versionString) {
+        const [read, minor] = versionString.split(".");
+        if (!read)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);
+        if (!minor)
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);
+        return new ecschema_metadata_1.ECVersion(+read, 0, +minor);
+    }
+}
+exports.SchemaXmlStringLocater = SchemaXmlStringLocater;
+//# sourceMappingURL=SchemaXmlStringLocater.js.map

package/lib/cjs/SchemaXmlStringLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlStringLocater.js","sourceRoot":"","sources":["../../src/SchemaXmlStringLocater.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,2CAA2C;AAC3C,gEAEkC;AAClC,+DAA6E;AAE7E;;GAEG;AAEH;;;;GAIG;AACH,MAAa,sBAAuB,SAAQ,yCAAmB;IAE7D;;;OAGG;IACI,YAAY,CAAC,SAAiB;QACnC,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,qDAAqD,CAAC,CAAC;QAEpH,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAChE,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,+EAA+E,CAAC,CAAC;QAE9I,MAAM,SAAS,GAAG,6BAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,GAAG,GAAG,IAAI,6BAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAC9C,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAmB,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC/G,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAExD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnE,OAAO,MAAW,CAAC;IACrB,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,oDAAoD;QACpD,MAAM,UAAU,GAAsB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACxF,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,6DAA6D;QAC7D,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3C,MAAM,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,oCAAgB,CAAC,6BAAS,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,IAAI,0BAAM,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAmB,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7G,oDAAoD;QACpD,MAAM,UAAU,GAAsB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACxF,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,6DAA6D;QAC7D,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3C,MAAM,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,oCAAgB,CAAC,6BAAS,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,MAAM,GAAW,IAAI,0BAAM,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEjD,OAAO,MAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,aAAqB;QAC1C,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE/C,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,oDAAoD,aAAa,EAAE,CAAC,CAAC;QAElI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,kCAAc,CAAC,mCAAe,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEnI,OAAO,IAAI,6BAAS,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CAEF;AAzGD,wDAyGC","sourcesContent":["/*---------------------------------------------------------------------------------------------\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 { DOMParser } from \"@xmldom/xmldom\";\nimport {\n  ECObjectsError, ECObjectsStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType, SchemaReadHelper, XmlParser,\n} from \"@itwin/ecschema-metadata\";\nimport { SchemaStringLocater, StringSchemaKey } from \"./SchemaStringLocater\";\n\n/** @packageDocumentation\n * @module Locaters\n */\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 ECObjectsError(ECObjectsStatus.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 ECObjectsError(ECObjectsStatus.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<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined> {\n    await this.getSchemaInfo(schemaKey, matchType, context);\n\n    const schema = await context.getCachedSchema(schemaKey, matchType);\n    return schema as T;\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    // eslint-disable-next-line @typescript-eslint/unbound-method\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<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | 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    // eslint-disable-next-line @typescript-eslint/unbound-method\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 as T;\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}\n"]}