@itwin/ecschema-locaters 3.4.0-dev.9 → 3.5.0-dev.4

package/lib/cjs/SchemaFileUtility.js

@@ -1,46 +1,49 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaFileUtility = void 0;
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-const fs = require("fs-extra");
-const path = require("path");
-const xmldom_1 = require("@xmldom/xmldom");
-/**
- * Utility class to assist in creating serialized EC Schemas on the file system.
- * @beta
- */
-class SchemaFileUtility {
-    /**
-     * Writes a Schema to an xml file to the specified output path.
-     * @param schema The Schema to serialize.
-     * @param outputPath The directory in which to create the file.
-     */
-    static async writeSchemaXmlFile(schema, outputPath) {
-        let xmlDoc = new xmldom_1.DOMParser().parseFromString(`<?xml version="1.0" encoding="UTF-8"?>`, "application/xml");
-        const baseFile = this.getSchemaPath(schema, outputPath);
-        xmlDoc = await schema.toXml(xmlDoc);
-        const serializer = new xmldom_1.XMLSerializer();
-        const xml = serializer.serializeToString(xmlDoc);
-        try {
-            await fs.writeFile(baseFile, xml);
-        }
-        catch (err) {
-            const msg = `An error occurred writing to file '${baseFile}': ${err.message}`;
-            throw new Error(msg);
-        }
-    }
-    static getSchemaPath(schema, outputPath) {
-        const realDir = path.normalize(outputPath);
-        const test = fs.pathExistsSync(realDir);
-        if (!test) {
-            const msg = `The output directory '${realDir}' does not exist.`;
-            throw new Error(msg);
-        }
-        return path.resolve(realDir, `${schema.name}.ecschema.xml`);
-    }
-}
-exports.SchemaFileUtility = SchemaFileUtility;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaFileUtility = void 0;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+const fs = require("fs-extra");
+const path = require("path");
+const xmldom_1 = require("@xmldom/xmldom");
+/** @packageDocumentation
+ * @module Utils
+ */
+/**
+ * Utility class to assist in creating serialized EC Schemas on the file system.
+ * @beta
+ */
+class SchemaFileUtility {
+    /**
+     * Writes a Schema to an xml file to the specified output path.
+     * @param schema The Schema to serialize.
+     * @param outputPath The directory in which to create the file.
+     */
+    static async writeSchemaXmlFile(schema, outputPath) {
+        let xmlDoc = new xmldom_1.DOMParser().parseFromString(`<?xml version="1.0" encoding="UTF-8"?>`, "application/xml");
+        const baseFile = this.getSchemaPath(schema, outputPath);
+        xmlDoc = await schema.toXml(xmlDoc);
+        const serializer = new xmldom_1.XMLSerializer();
+        const xml = serializer.serializeToString(xmlDoc);
+        try {
+            await fs.writeFile(baseFile, xml);
+        }
+        catch (err) {
+            const msg = `An error occurred writing to file '${baseFile}': ${err.message}`;
+            throw new Error(msg);
+        }
+    }
+    static getSchemaPath(schema, outputPath) {
+        const realDir = path.normalize(outputPath);
+        const test = fs.pathExistsSync(realDir);
+        if (!test) {
+            const msg = `The output directory '${realDir}' does not exist.`;
+            throw new Error(msg);
+        }
+        return path.resolve(realDir, `${schema.name}.ecschema.xml`);
+    }
+}
+exports.SchemaFileUtility = SchemaFileUtility;
 //# sourceMappingURL=SchemaFileUtility.js.map

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;;;GAGG;AACH,MAAa,iBAAiB;IAE5B;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,MAAc,EAAE,UAAkB;QACvE,IAAI,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,wCAAwC,EAAE,iBAAiB,CAAC,CAAC;QAC1G,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAExD,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,UAAU,GAAG,IAAI,sBAAa,EAAE,CAAC;QACvC,MAAM,GAAG,GAAG,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAEjD,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;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;AAjCD,8CAiCC","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/**\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    let xmlDoc = new DOMParser().parseFromString(`<?xml version=\"1.0\" encoding=\"UTF-8\"?>`, \"application/xml\");\r\n    const baseFile = this.getSchemaPath(schema, outputPath);\r\n\r\n    xmlDoc = await schema.toXml(xmlDoc);\r\n    const serializer = new XMLSerializer();\r\n    const xml = serializer.serializeToString(xmlDoc);\r\n\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  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,IAAI,MAAM,GAAG,IAAI,kBAAS,EAAE,CAAC,eAAe,CAAC,wCAAwC,EAAE,iBAAiB,CAAC,CAAC;QAC1G,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QAExD,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,UAAU,GAAG,IAAI,sBAAa,EAAE,CAAC;QACvC,MAAM,GAAG,GAAG,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAEjD,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;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;AAjCD,8CAiCC","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    let xmlDoc = new DOMParser().parseFromString(`<?xml version=\"1.0\" encoding=\"UTF-8\"?>`, \"application/xml\");\n    const baseFile = this.getSchemaPath(schema, outputPath);\n\n    xmlDoc = await schema.toXml(xmlDoc);\n    const serializer = new XMLSerializer();\n    const xml = serializer.serializeToString(xmlDoc);\n\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  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.d.ts

@@ -1,31 +1,34 @@
-import { ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
-import { SchemaFileLocater } from "./SchemaFileLocater";
-/**
- * A SchemaLocator implementation for locating JSON Schema files
- * from the file system using configurable search paths.
- * @beta
- */
-export declare class SchemaJsonFileLocater extends SchemaFileLocater implements ISchemaLocater {
-    /**
-     * Constructs a SchemaKey based on the information in the Schema JSON
-     * @param data The Schema JSON as a string
-     */
-    protected getSchemaKey(data: string): SchemaKey;
-    /**
-     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
-     * search paths to locate the JSON schema file from the file system.
-     * @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>;
-    /**
-     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
-     * search paths to locate the JSON schema file from the file system.
-     * @param key The SchemaKey of the Schema to retrieve.
-     * @param matchType The SchemaMatchType
-     * @param context The SchemaContext that will control the lifetime of the schema.
-     */
-    getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
-}
+import { ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaFileLocater } from "./SchemaFileLocater";
+/** @packageDocumentation
+ * @module Locaters
+ */
+/**
+ * A SchemaLocator implementation for locating JSON Schema files
+ * from the file system using configurable search paths.
+ * @beta
+ */
+export declare class SchemaJsonFileLocater extends SchemaFileLocater implements ISchemaLocater {
+    /**
+     * Constructs a SchemaKey based on the information in the Schema JSON
+     * @param data The Schema JSON as a string
+     */
+    protected getSchemaKey(data: string): SchemaKey;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @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>;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
+}
 //# sourceMappingURL=SchemaJsonFileLocater.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaJsonFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaJsonFileLocater.ts"],"names":[],"mappings":"AAOA,OAAO,EACuC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAC9G,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEvE;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,iBAAkB,YAAW,cAAc;IAEpF;;;OAGG;IACH,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAmB/C;;;;;;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;IAwB1I;;;;;;OAMG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS;CAuBhI"}
+{"version":3,"file":"SchemaJsonFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaJsonFileLocater.ts"],"names":[],"mappings":"AAOA,OAAO,EACuC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAC9G,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEvE;;GAEG;AAEH;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,iBAAkB,YAAW,cAAc;IAEpF;;;OAGG;IACH,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAmB/C;;;;;;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;IAwB1I;;;;;;OAMG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS;CAuBhI"}

package/lib/cjs/SchemaJsonFileLocater.js

@@ -1,88 +1,91 @@
-"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.SchemaJsonFileLocater = void 0;
-const fs = require("fs");
-const path = require("path");
-const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
-const SchemaFileLocater_1 = require("./SchemaFileLocater");
-/**
- * A SchemaLocator implementation for locating JSON Schema files
- * from the file system using configurable search paths.
- * @beta
- */
-class SchemaJsonFileLocater extends SchemaFileLocater_1.SchemaFileLocater {
-    /**
-     * Constructs a SchemaKey based on the information in the Schema JSON
-     * @param data The Schema JSON as a string
-     */
-    getSchemaKey(data) {
-        const dataJson = JSON.parse(data);
-        // Check if the name is present
-        if (!(dataJson.name))
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidECJson, `Could not retrieve the ECSchema name in the given file.`);
-        // Check if versions is present
-        if (!(dataJson.version))
-            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidECJson, `Could not parse the ECSchema version in the given file.`);
-        // Get the name and version from the JSON
-        const schemaName = dataJson.name;
-        const schemaVersion = dataJson.version;
-        const key = new ecschema_metadata_1.SchemaKey(schemaName.toString(), ecschema_metadata_1.ECVersion.fromString(schemaVersion.toString()));
-        return key;
-    }
-    /**
-     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
-     * search paths to locate the JSON schema file from the file system.
-     * @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) {
-        // Grab all schema files that match the schema key
-        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType, "json");
-        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 schemaPath = maxCandidate.fileName;
-        // Load the file
-        if (!await this.fileExists(schemaPath))
-            return undefined;
-        const schemaText = await this.readUtf8FileToString(schemaPath);
-        if (!schemaText)
-            return undefined;
-        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
-        const schema = await ecschema_metadata_1.Schema.fromJson(schemaText, context);
-        return schema;
-    }
-    /**
-     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
-     * search paths to locate the JSON schema file from the file system.
-     * @param key The SchemaKey of the Schema to retrieve.
-     * @param matchType The SchemaMatchType
-     * @param context The SchemaContext that will control the lifetime of the schema.
-     */
-    getSchemaSync(schemaKey, matchType, context) {
-        // Grab all schema files that match the schema key
-        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType, "json");
-        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 schemaPath = maxCandidate.fileName;
-        // Load the file
-        if (!fs.existsSync(schemaPath))
-            return undefined;
-        const schemaText = fs.readFileSync(schemaPath, "utf-8");
-        if (!schemaText)
-            return undefined;
-        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
-        const schema = ecschema_metadata_1.Schema.fromJsonSync(schemaText, context);
-        return schema;
-    }
-}
-exports.SchemaJsonFileLocater = SchemaJsonFileLocater;
+"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.SchemaJsonFileLocater = void 0;
+const fs = require("fs");
+const path = require("path");
+const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
+const SchemaFileLocater_1 = require("./SchemaFileLocater");
+/** @packageDocumentation
+ * @module Locaters
+ */
+/**
+ * A SchemaLocator implementation for locating JSON Schema files
+ * from the file system using configurable search paths.
+ * @beta
+ */
+class SchemaJsonFileLocater extends SchemaFileLocater_1.SchemaFileLocater {
+    /**
+     * Constructs a SchemaKey based on the information in the Schema JSON
+     * @param data The Schema JSON as a string
+     */
+    getSchemaKey(data) {
+        const dataJson = JSON.parse(data);
+        // Check if the name is present
+        if (!(dataJson.name))
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidECJson, `Could not retrieve the ECSchema name in the given file.`);
+        // Check if versions is present
+        if (!(dataJson.version))
+            throw new ecschema_metadata_1.ECObjectsError(ecschema_metadata_1.ECObjectsStatus.InvalidECJson, `Could not parse the ECSchema version in the given file.`);
+        // Get the name and version from the JSON
+        const schemaName = dataJson.name;
+        const schemaVersion = dataJson.version;
+        const key = new ecschema_metadata_1.SchemaKey(schemaName.toString(), ecschema_metadata_1.ECVersion.fromString(schemaVersion.toString()));
+        return key;
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @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) {
+        // Grab all schema files that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType, "json");
+        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 schemaPath = maxCandidate.fileName;
+        // Load the file
+        if (!await this.fileExists(schemaPath))
+            return undefined;
+        const schemaText = await this.readUtf8FileToString(schemaPath);
+        if (!schemaText)
+            return undefined;
+        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
+        const schema = await ecschema_metadata_1.Schema.fromJson(schemaText, context);
+        return schema;
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchemaSync(schemaKey, matchType, context) {
+        // Grab all schema files that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType, "json");
+        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 schemaPath = maxCandidate.fileName;
+        // Load the file
+        if (!fs.existsSync(schemaPath))
+            return undefined;
+        const schemaText = fs.readFileSync(schemaPath, "utf-8");
+        if (!schemaText)
+            return undefined;
+        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
+        const schema = ecschema_metadata_1.Schema.fromJsonSync(schemaText, context);
+        return schema;
+    }
+}
+exports.SchemaJsonFileLocater = SchemaJsonFileLocater;
 //# sourceMappingURL=SchemaJsonFileLocater.js.map

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;;;;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,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,MAAM,MAAM,GAAG,MAAM,0BAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,MAAW,CAAC;IACrB,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;AAtFD,sDAsFC","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, SchemaKey, SchemaMatchType,\r\n} from \"@itwin/ecschema-metadata\";\r\nimport { FileSchemaKey, SchemaFileLocater } from \"./SchemaFileLocater\";\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    // 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    const schema = await Schema.fromJson(schemaText, context);\r\n    return schema as T;\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,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,MAAM,MAAM,GAAG,MAAM,0BAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC1D,OAAO,MAAW,CAAC;IACrB,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;AAtFD,sDAsFC","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, 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    // 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    const schema = await Schema.fromJson(schemaText, context);\n    return schema as T;\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/SchemaXmlFileLocater.d.ts

@@ -1,31 +1,34 @@
-import { ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
-import { SchemaFileLocater } from "./SchemaFileLocater";
-/**
- * A SchemaLocater implementation for locating XML Schema files
- * from the file system using configurable search paths.
- * @beta This is a workaround the current lack of a full xml parser.
- */
-export declare class SchemaXmlFileLocater extends SchemaFileLocater implements ISchemaLocater {
-    /**
-     * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
-     * to locate the XML Schema file from the file system.
-     * @param key The SchemaKey of the Schema to retrieve.
-     * @param matchType The SchemaMatchType.
-     * @param context The SchemaContext that will control the lifetime of the schema.
-     */
-    getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;
-    /**
-     * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
-     * to locate the XML Schema file from the file system.
-     * @param key The SchemaKey of the Schema to retrieve.
-     * @param matchType The SchemaMatchType.
-     * @param context The SchemaContext that will control the lifetime of the schema.
-     */
-    getSchemaSync<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
-    /**
-     * Constructs a SchemaKey based on the information in the Schema XML.
-     * @param data The Schema XML as a string.
-     */
-    getSchemaKey(data: string): SchemaKey;
-}
+import { ISchemaLocater, Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaFileLocater } from "./SchemaFileLocater";
+/** @packageDocumentation
+ * @module Locaters
+ */
+/**
+ * A SchemaLocater implementation for locating XML Schema files
+ * from the file system using configurable search paths.
+ * @beta This is a workaround the current lack of a full xml parser.
+ */
+export declare class SchemaXmlFileLocater extends SchemaFileLocater implements ISchemaLocater {
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
+     * to locate the XML Schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchema<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
+     * to locate the XML Schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchemaSync<T extends Schema>(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
+    /**
+     * Constructs a SchemaKey based on the information in the Schema XML.
+     * @param data The Schema XML as a string.
+     */
+    getSchemaKey(data: string): SchemaKey;
+}
 //# sourceMappingURL=SchemaXmlFileLocater.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SchemaXmlFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaXmlFileLocater.ts"],"names":[],"mappings":"AAOA,OAAO,EACuC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAC9G,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEvE;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,iBAAkB,YAAW,cAAc;IACnF;;;;;;OAMG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IA6BpI;;;;;;OAMG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS;IA6BzH;;;OAGG;IACI,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;CAa7C"}
+{"version":3,"file":"SchemaXmlFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaXmlFileLocater.ts"],"names":[],"mappings":"AAOA,OAAO,EACuC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAC9G,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEvE;;GAEG;AAEH;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,iBAAkB,YAAW,cAAc;IACnF;;;;;;OAMG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IA6BpI;;;;;;OAMG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS;IA6BzH;;;OAGG;IACI,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;CAa7C"}