@itwin/ecschema-locaters 5.0.0-dev.10 → 5.0.0-dev.102

package/lib/esm/test/SchemaJsonFileLocator.test.js

@@ -0,0 +1,118 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { assert } from "chai";
+import * as path from "path";
+import * as EC from "@itwin/ecschema-metadata";
+import { SchemaJsonFileLocater } from "../SchemaJsonFileLocater";
+describe("SchemaJsonFileLocater tests: ", () => {
+    let locater;
+    let context;
+    beforeEach(() => {
+        locater = new SchemaJsonFileLocater();
+        locater.addSchemaSearchPath(path.join(__dirname, "assets"));
+        context = new EC.SchemaContext();
+        context.addLocater(locater);
+    });
+    it("locate valid schema with multiple references", async () => {
+        const schemaKey = new EC.SchemaKey("SchemaA", 1, 1, 1);
+        const schema = await context.getSchema(schemaKey, EC.SchemaMatchType.Exact);
+        assert.isDefined(schema);
+        assert.strictEqual(schema.schemaKey.name, "SchemaA");
+        assert.strictEqual(schema.schemaKey.version.toString(), "01.01.01");
+    });
+    it("locate valid schema with multiple references synchronously", () => {
+        const schemaKey = new EC.SchemaKey("SchemaA", 1, 1, 1);
+        const schema = context.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact);
+        assert.isDefined(schema);
+        assert.strictEqual(schema.schemaKey.name, "SchemaA");
+        assert.strictEqual(schema.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchema called multiple times for same schema", async () => {
+        const schemaKey = new EC.SchemaKey("SchemaD", 4, 4, 4);
+        const locater1 = await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, new EC.SchemaContext());
+        const locater2 = await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, new EC.SchemaContext());
+        const context1 = await context.getSchema(schemaKey, EC.SchemaMatchType.Exact);
+        const context2 = await context.getSchema(schemaKey, EC.SchemaMatchType.Exact);
+        // locater should not cache, but context should cache
+        assert.notEqual(locater1, locater2);
+        assert.notEqual(locater1, context1);
+        assert.strictEqual(context1, context2);
+    });
+    it("getSchema called multiple times for same schema synchronously", () => {
+        const schemaKey = new EC.SchemaKey("SchemaD", 4, 4, 4);
+        const locater1 = locater.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact, new EC.SchemaContext());
+        const locater2 = locater.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact, new EC.SchemaContext());
+        const context1 = context.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact);
+        const context2 = context.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact);
+        // locater should not cache, but context should cache
+        assert.notEqual(locater1, locater2);
+        assert.notEqual(locater1, context1);
+        assert.strictEqual(context1, context2);
+    });
+    it("getSchema which does not exist, returns undefined", async () => {
+        const schemaKey = new EC.SchemaKey("DoesNotExist");
+        const result = await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context);
+        assert.isUndefined(result);
+    });
+    it("loadSchema from file, bad schema name, throws", async () => {
+        const schemaKey = new EC.SchemaKey("BadSchemaName");
+        try {
+            await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context);
+        }
+        catch (e) {
+            const error = e;
+            assert.strictEqual(error.errorNumber, EC.ECObjectsStatus.InvalidECJson);
+            return;
+        }
+        assert.fail(0, 1, "Expected ECObjects exception");
+    });
+    it("loadSchema from file, bad schema version, throws", async () => {
+        const schemaKey = new EC.SchemaKey("BadSchemaVersion");
+        try {
+            await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context);
+        }
+        catch (e) {
+            const error = e;
+            assert.strictEqual(error.errorNumber, EC.ECObjectsStatus.InvalidECJson);
+            return;
+        }
+        assert.fail(0, 1, "Expected ECObjects exception");
+    });
+    it("getSchema, full version, succeeds", async () => {
+        const stub = await locater.getSchema(new EC.SchemaKey("SchemaA", 1, 1, 1), EC.SchemaMatchType.Exact, context);
+        assert.isDefined(stub);
+        const key = stub.schemaKey;
+        assert.strictEqual(key.name, "SchemaA");
+        assert.strictEqual(key.version.toString(), "01.01.01");
+    });
+    it("getSchema, exact version, wrong minor, fails", async () => {
+        assert.isUndefined(await locater.getSchema(new EC.SchemaKey("SchemaA", 1, 1, 2), EC.SchemaMatchType.Exact, context));
+    });
+    it("getSchema, latest, succeeds", async () => {
+        const schema = await locater.getSchema(new EC.SchemaKey("SchemaA", 1, 1, 0), EC.SchemaMatchType.Latest, context);
+        assert.isDefined(schema);
+        assert.strictEqual(schema.schemaKey.name, "SchemaA");
+        assert.strictEqual(schema.schemaKey.version.toString(), "02.00.02");
+    });
+    it("getSchema, latest write compatible, succeeds", async () => {
+        const stub = await locater.getSchema(new EC.SchemaKey("SchemaA", 1, 1, 0), EC.SchemaMatchType.LatestWriteCompatible, context);
+        assert.isDefined(stub);
+        assert.strictEqual(stub.schemaKey.name, "SchemaA");
+        assert.strictEqual(stub.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchema, latest write compatible, write version wrong, fails", async () => {
+        assert.isUndefined(await locater.getSchema(new EC.SchemaKey("SchemaA", 1, 2, 0), EC.SchemaMatchType.LatestWriteCompatible, context));
+    });
+    it("getSchema, latest read compatible, succeeds", async () => {
+        const stub = await locater.getSchema(new EC.SchemaKey("SchemaA", 1, 0, 0), EC.SchemaMatchType.LatestReadCompatible, context);
+        assert.isDefined(stub);
+        assert.strictEqual(stub.schemaKey.name, "SchemaA");
+        assert.strictEqual(stub.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchema, latest read compatible, read version wrong, fails", async () => {
+        assert.isUndefined(await locater.getSchema(new EC.SchemaKey("SchemaA", 2, 1, 1), EC.SchemaMatchType.LatestReadCompatible, context));
+    });
+});
+//# sourceMappingURL=SchemaJsonFileLocator.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaJsonFileLocator.test.js","sourceRoot":"","sources":["../../../src/test/SchemaJsonFileLocator.test.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,0BAA0B,CAAC;AAE/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,IAAI,OAA8B,CAAC;IACnC,IAAI,OAAyB,CAAC;IAE9B,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,GAAG,IAAI,qBAAqB,EAAE,CAAC;QAEtC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC5D,OAAO,GAAG,IAAI,EAAE,CAAC,aAAa,EAAE,CAAC;QACjC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAE5E,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACvD,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAE1E,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAEvD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;QACtG,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;QACtG,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC9E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAE9E,qDAAqD;QACrD,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAEvD,MAAM,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;QACpG,MAAM,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;QACpG,MAAM,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5E,MAAM,QAAQ,GAAG,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAE5E,qDAAqD;QACrD,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACrF,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAEpD,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACxE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,CAAsB,CAAC;YACrC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;YACxE,OAAO;QACT,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,8BAA8B,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAEvD,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACxE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,CAAsB,CAAC;YACrC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;YACxE,OAAO;QACT,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,8BAA8B,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAE9G,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,GAAG,GAAG,IAAK,CAAC,SAA0B,CAAC;QAC7C,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACxC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IACvH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACjH,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QAE9H,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpD,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC,CAAC;IACvI,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;QAE7H,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpD,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,CAAC;IACtI,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { assert } from \"chai\";\r\nimport * as path from \"path\";\r\nimport * as EC from \"@itwin/ecschema-metadata\";\r\nimport { FileSchemaKey } from \"../SchemaFileLocater\";\r\nimport { SchemaJsonFileLocater } from \"../SchemaJsonFileLocater\";\r\n\r\ndescribe(\"SchemaJsonFileLocater tests: \", () => {\r\n  let locater: SchemaJsonFileLocater;\r\n  let context: EC.SchemaContext;\r\n\r\n  beforeEach(() => {\r\n    locater = new SchemaJsonFileLocater();\r\n\r\n    locater.addSchemaSearchPath(path.join(__dirname, \"assets\"));\r\n    context = new EC.SchemaContext();\r\n    context.addLocater(locater);\r\n  });\r\n\r\n  it(\"locate valid schema with multiple references\", async () => {\r\n    const schemaKey = new EC.SchemaKey(\"SchemaA\", 1, 1, 1);\r\n    const schema = await context.getSchema(schemaKey, EC.SchemaMatchType.Exact);\r\n\r\n    assert.isDefined(schema);\r\n    assert.strictEqual(schema!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(schema!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"locate valid schema with multiple references synchronously\", () => {\r\n    const schemaKey = new EC.SchemaKey(\"SchemaA\", 1, 1, 1);\r\n    const schema = context.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact);\r\n\r\n    assert.isDefined(schema);\r\n    assert.strictEqual(schema!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(schema!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema called multiple times for same schema\", async () => {\r\n    const schemaKey = new EC.SchemaKey(\"SchemaD\", 4, 4, 4);\r\n\r\n    const locater1 = await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, new EC.SchemaContext());\r\n    const locater2 = await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, new EC.SchemaContext());\r\n    const context1 = await context.getSchema(schemaKey, EC.SchemaMatchType.Exact);\r\n    const context2 = await context.getSchema(schemaKey, EC.SchemaMatchType.Exact);\r\n\r\n    // locater should not cache, but context should cache\r\n    assert.notEqual(locater1, locater2);\r\n    assert.notEqual(locater1, context1);\r\n    assert.strictEqual(context1, context2);\r\n  });\r\n\r\n  it(\"getSchema called multiple times for same schema synchronously\", () => {\r\n    const schemaKey = new EC.SchemaKey(\"SchemaD\", 4, 4, 4);\r\n\r\n    const locater1 = locater.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact, new EC.SchemaContext());\r\n    const locater2 = locater.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact, new EC.SchemaContext());\r\n    const context1 = context.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact);\r\n    const context2 = context.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact);\r\n\r\n    // locater should not cache, but context should cache\r\n    assert.notEqual(locater1, locater2);\r\n    assert.notEqual(locater1, context1);\r\n    assert.strictEqual(context1, context2);\r\n  });\r\n\r\n  it(\"getSchema which does not exist, returns undefined\", async () => {\r\n    const schemaKey = new EC.SchemaKey(\"DoesNotExist\");\r\n    const result = await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context);\r\n    assert.isUndefined(result);\r\n  });\r\n\r\n  it(\"loadSchema from file, bad schema name, throws\", async () => {\r\n    const schemaKey = new EC.SchemaKey(\"BadSchemaName\");\r\n\r\n    try {\r\n      await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context);\r\n    } catch (e) {\r\n      const error = e as EC.ECObjectsError;\r\n      assert.strictEqual(error.errorNumber, EC.ECObjectsStatus.InvalidECJson);\r\n      return;\r\n    }\r\n\r\n    assert.fail(0, 1, \"Expected ECObjects exception\");\r\n  });\r\n\r\n  it(\"loadSchema from file, bad schema version, throws\", async () => {\r\n    const schemaKey = new EC.SchemaKey(\"BadSchemaVersion\");\r\n\r\n    try {\r\n      await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context);\r\n    } catch (e) {\r\n      const error = e as EC.ECObjectsError;\r\n      assert.strictEqual(error.errorNumber, EC.ECObjectsStatus.InvalidECJson);\r\n      return;\r\n    }\r\n\r\n    assert.fail(0, 1, \"Expected ECObjects exception\");\r\n  });\r\n\r\n  it(\"getSchema, full version, succeeds\", async () => {\r\n    const stub = await locater.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 1), EC.SchemaMatchType.Exact, context);\r\n\r\n    assert.isDefined(stub);\r\n    const key = stub!.schemaKey as FileSchemaKey;\r\n    assert.strictEqual(key.name, \"SchemaA\");\r\n    assert.strictEqual(key.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema, exact version, wrong minor, fails\", async () => {\r\n    assert.isUndefined(await locater.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 2), EC.SchemaMatchType.Exact, context));\r\n  });\r\n\r\n  it(\"getSchema, latest, succeeds\", async () => {\r\n    const schema = await locater.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 0), EC.SchemaMatchType.Latest, context);\r\n    assert.isDefined(schema);\r\n    assert.strictEqual(schema!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(schema!.schemaKey.version.toString(), \"02.00.02\");\r\n  });\r\n\r\n  it(\"getSchema, latest write compatible, succeeds\", async () => {\r\n    const stub = await locater.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 0), EC.SchemaMatchType.LatestWriteCompatible, context);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema, latest write compatible, write version wrong, fails\", async () => {\r\n    assert.isUndefined(await locater.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 2, 0), EC.SchemaMatchType.LatestWriteCompatible, context));\r\n  });\r\n\r\n  it(\"getSchema, latest read compatible, succeeds\", async () => {\r\n    const stub = await locater.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 0, 0), EC.SchemaMatchType.LatestReadCompatible, context);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema, latest read compatible, read version wrong, fails\", async () => {\r\n    assert.isUndefined(await locater.getSchema(new EC.SchemaKey(\"SchemaA\", 2, 1, 1), EC.SchemaMatchType.LatestReadCompatible, context));\r\n  });\r\n});\r\n"]}

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

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

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

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

package/lib/esm/test/SchemaXml.test.js

@@ -0,0 +1,55 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { expect } from "chai";
+import * as path from "path";
+import * as fs from "fs-extra";
+import * as sinon from "sinon";
+import { SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaXmlFileLocater } from "../SchemaXmlFileLocater";
+import { SchemaXml } from "../SchemaXml";
+describe("SchemaXml tests:", () => {
+    let locater;
+    let resultLocater;
+    let context;
+    let resultContext;
+    const outDir = path.join(__dirname, "output");
+    before(() => {
+        fs.ensureDirSync(outDir);
+    });
+    beforeEach(() => {
+        locater = new SchemaXmlFileLocater();
+        locater.addSchemaSearchPath(path.join(__dirname, "assets"));
+        context = new SchemaContext();
+        context.addLocater(locater);
+        resultLocater = new SchemaXmlFileLocater();
+        resultLocater.addSchemaSearchPath(path.join(__dirname, "output"));
+        resultContext = new SchemaContext();
+        resultContext.addLocater(resultLocater);
+    });
+    afterEach(() => {
+        sinon.restore();
+    });
+    it("writeFile creates schema xml file successfully.", async () => {
+        const schemaKey = new SchemaKey("SchemaD", 4, 4, 4);
+        const schema = await context.getSchema(schemaKey, SchemaMatchType.Exact);
+        await SchemaXml.writeFile(schema, outDir);
+        const resultSchema = await resultContext.getSchema(schemaKey, SchemaMatchType.Exact);
+        expect(resultSchema).to.not.be.undefined;
+        expect(resultSchema?.schemaKey.matches(schema?.schemaKey)).to.be.true;
+    });
+    it("writeFile with bad path specified, should fail.", async () => {
+        const schemaKey = new SchemaKey("SchemaD", 4, 4, 4);
+        const schema = await context.getSchema(schemaKey, SchemaMatchType.Exact);
+        await expect(SchemaXml.writeFile(schema, "badPath")).to.be.rejectedWith(`The output directory 'badPath' does not exist.`);
+    });
+    it("writeFile, writeFile fails, failure handled properly.", async () => {
+        const schemaKey = new SchemaKey("SchemaD", 4, 4, 4);
+        const schema = await context.getSchema(schemaKey, SchemaMatchType.Exact);
+        sinon.stub(fs, "writeFile").rejects(new Error("SomeError"));
+        const outFile = path.resolve(outDir, `${schema.name}.ecschema.xml`);
+        await expect(SchemaXml.writeFile(schema, outDir)).to.be.rejectedWith(`An error occurred writing to file '${outFile}': SomeError`);
+    });
+});
+//# sourceMappingURL=SchemaXml.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXml.test.js","sourceRoot":"","sources":["../../../src/test/SchemaXml.test.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACrF,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,OAA6B,CAAC;IAClC,IAAI,aAAmC,CAAC;IACxC,IAAI,OAAsB,CAAC;IAC3B,IAAI,aAA4B,CAAC;IACjC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAE9C,MAAM,CAAC,GAAG,EAAE;QACV,EAAE,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QACrC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC5D,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QAC9B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAE5B,aAAa,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC3C,aAAa,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;QAClE,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,aAAa,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,CAAC,OAAO,EAAE,CAAC;IAClB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAEzE,MAAM,SAAS,CAAC,SAAS,CAAC,MAAO,EAAE,MAAM,CAAC,CAAC;QAE3C,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAErF,MAAM,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,SAAS,CAAC;QACzC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,SAAsB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACrF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAEzE,MAAM,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,MAAO,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,gDAAgD,CAAC,CAAC;IAC7H,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QACzE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;QAC5D,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,MAAO,CAAC,IAAI,eAAe,CAAC,CAAC;QAErE,MAAM,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC,MAAO,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,sCAAsC,OAAO,cAAc,CAAC,CAAC;IACrI,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { expect } from \"chai\";\r\nimport * as path from \"path\";\r\nimport * as fs from \"fs-extra\";\r\nimport * as sinon from \"sinon\";\r\nimport { SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\nimport { SchemaXmlFileLocater } from \"../SchemaXmlFileLocater\";\r\nimport { SchemaXml } from \"../SchemaXml\";\r\n\r\ndescribe(\"SchemaXml tests:\", () => {\r\n  let locater: SchemaXmlFileLocater;\r\n  let resultLocater: SchemaXmlFileLocater;\r\n  let context: SchemaContext;\r\n  let resultContext: SchemaContext;\r\n  const outDir = path.join(__dirname, \"output\");\r\n\r\n  before(() => {\r\n    fs.ensureDirSync(outDir);\r\n  });\r\n\r\n  beforeEach(() => {\r\n    locater = new SchemaXmlFileLocater();\r\n    locater.addSchemaSearchPath(path.join(__dirname, \"assets\"));\r\n    context = new SchemaContext();\r\n    context.addLocater(locater);\r\n\r\n    resultLocater = new SchemaXmlFileLocater();\r\n    resultLocater.addSchemaSearchPath(path.join(__dirname, \"output\"));\r\n    resultContext = new SchemaContext();\r\n    resultContext.addLocater(resultLocater);\r\n  });\r\n\r\n  afterEach(() => {\r\n    sinon.restore();\r\n  });\r\n\r\n  it(\"writeFile creates schema xml file successfully.\", async () => {\r\n    const schemaKey = new SchemaKey(\"SchemaD\", 4, 4, 4);\r\n    const schema = await context.getSchema(schemaKey, SchemaMatchType.Exact);\r\n\r\n    await SchemaXml.writeFile(schema!, outDir);\r\n\r\n    const resultSchema = await resultContext.getSchema(schemaKey, SchemaMatchType.Exact);\r\n\r\n    expect(resultSchema).to.not.be.undefined;\r\n    expect(resultSchema?.schemaKey.matches(schema?.schemaKey as SchemaKey)).to.be.true;\r\n  });\r\n\r\n  it(\"writeFile with bad path specified, should fail.\", async () => {\r\n    const schemaKey = new SchemaKey(\"SchemaD\", 4, 4, 4);\r\n    const schema = await context.getSchema(schemaKey, SchemaMatchType.Exact);\r\n\r\n    await expect(SchemaXml.writeFile(schema!, \"badPath\")).to.be.rejectedWith(`The output directory 'badPath' does not exist.`);\r\n  });\r\n\r\n  it(\"writeFile, writeFile fails, failure handled properly.\", async () => {\r\n    const schemaKey = new SchemaKey(\"SchemaD\", 4, 4, 4);\r\n    const schema = await context.getSchema(schemaKey, SchemaMatchType.Exact);\r\n    sinon.stub(fs, \"writeFile\").rejects(new Error(\"SomeError\"));\r\n    const outFile = path.resolve(outDir, `${schema!.name}.ecschema.xml`);\r\n\r\n    await expect(SchemaXml.writeFile(schema!, outDir)).to.be.rejectedWith(`An error occurred writing to file '${outFile}': SomeError`);\r\n  });\r\n});\r\n"]}

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

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

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

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

package/lib/esm/test/SchemaXmlFileLocator.test.js

@@ -0,0 +1,182 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { assert, expect } from "chai";
+import * as path from "path";
+import { ECObjectsError, ECObjectsStatus, ECVersion, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { PublishedSchemaXmlFileLocater, SchemaXmlFileLocater } from "../SchemaXmlFileLocater";
+describe("SchemaXmlFileLocater tests:", () => {
+    let locater;
+    let context;
+    beforeEach(() => {
+        locater = new SchemaXmlFileLocater();
+        locater.addSchemaSearchPath(path.join(__dirname, "assets"));
+        context = new SchemaContext();
+        context.addLocater(locater);
+    });
+    it("locate valid schema with multiple references", async () => {
+        const schemaKey = new SchemaKey("SchemaA", 1, 1, 1);
+        const schema = await context.getSchema(schemaKey, SchemaMatchType.Exact);
+        assert.isDefined(schema);
+        assert.strictEqual(schema.schemaKey.name, "SchemaA");
+        assert.strictEqual(schema.schemaKey.version.toString(), "01.01.01");
+    });
+    it("locate valid schema with multiple references synchronously", () => {
+        const schemaKey = new SchemaKey("SchemaA", 1, 1, 1);
+        const schema = context.getSchemaSync(schemaKey, SchemaMatchType.Exact);
+        assert.isDefined(schema);
+        assert.strictEqual(schema.schemaKey.name, "SchemaA");
+        assert.strictEqual(schema.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchema called multiple times for same schema", async () => {
+        const schemaKey = new SchemaKey("SchemaD", 4, 4, 4);
+        const locater1 = await locater.getSchema(schemaKey, SchemaMatchType.Exact, new SchemaContext());
+        const locater2 = await locater.getSchema(schemaKey, SchemaMatchType.Exact, new SchemaContext());
+        const context1 = await context.getSchema(schemaKey, SchemaMatchType.Exact);
+        const context2 = await context.getSchema(schemaKey, SchemaMatchType.Exact);
+        // locater should not cache, but context should cache
+        assert.notEqual(locater1, locater2);
+        assert.notEqual(locater1, context1);
+        assert.strictEqual(context1, context2);
+    });
+    it("getSchema which does not exist, returns undefined", async () => {
+        const schemaKey = new SchemaKey("DoesNotExist");
+        assert.isUndefined(await locater.getSchema(schemaKey, SchemaMatchType.Exact, context));
+    });
+    it("loadSchema from file, bad schema tag, throws", async () => {
+        const schemaKey = new SchemaKey("BadSchemaTag");
+        try {
+            await locater.getSchema(schemaKey, SchemaMatchType.Latest, context);
+        }
+        catch (e) {
+            const error = e;
+            assert.strictEqual(error.errorNumber, ECObjectsStatus.InvalidSchemaXML);
+            return;
+        }
+        assert.fail(0, 1, "Expected ECObjects exception");
+    });
+    it("loadSchema from file, bad schema name tag, throws", async () => {
+        const schemaKey = new SchemaKey("BadSchemaNameTag");
+        try {
+            await locater.getSchema(schemaKey, SchemaMatchType.Latest, context);
+        }
+        catch (e) {
+            const error = e;
+            assert.strictEqual(error.errorNumber, ECObjectsStatus.InvalidSchemaXML);
+            return;
+        }
+        assert.fail(0, 1, "Expected ECObjects exception");
+    });
+    it("loadSchema from file, bad schema version tag, throws", async () => {
+        const schemaKey = new SchemaKey("BadSchemaVersionTag");
+        try {
+            await locater.getSchema(schemaKey, SchemaMatchType.Latest, context);
+        }
+        catch (e) {
+            const error = e;
+            assert.strictEqual(error.errorNumber, ECObjectsStatus.InvalidSchemaXML);
+            return;
+        }
+        assert.fail(0, 1, "Expected ECObjects exception");
+    });
+    it("getSchema, full version, succeeds", async () => {
+        const stub = await locater.getSchema(new SchemaKey("SchemaA", 1, 1, 1), SchemaMatchType.Exact, context);
+        assert.isDefined(stub);
+        const key = stub.schemaKey;
+        assert.strictEqual(key.name, "SchemaA");
+        assert.strictEqual(key.version.toString(), "01.01.01");
+    });
+    it("getSchema, reference does not exist, throws.", async () => {
+        try {
+            await locater.getSchema(new SchemaKey("RefDoesNotExist", 1, 1, 1), SchemaMatchType.Exact, context);
+        }
+        catch (e) {
+            const error = e;
+            assert.strictEqual(error.errorNumber, ECObjectsStatus.UnableToLocateSchema);
+            return;
+        }
+        assert.fail();
+    });
+    it("getSchema, references set", async () => {
+        const schemaA = await context.getSchema(new SchemaKey("SchemaA", 1, 1, 1), SchemaMatchType.Exact);
+        const schemaB = await context.getSchema(new SchemaKey("SchemaB", 2, 2, 2), SchemaMatchType.Exact);
+        const schemaC = await context.getSchema(new SchemaKey("SchemaC", 3, 3, 3), SchemaMatchType.Exact);
+        const schemaD = await context.getSchema(new SchemaKey("SchemaD", 4, 4, 4), SchemaMatchType.Exact);
+        assert.isDefined(schemaA);
+        assert.strictEqual(schemaA.references.length, 2);
+        assert.deepEqual(schemaA.references[0], schemaC);
+        assert.deepEqual(schemaA.references[1], schemaB);
+        assert.deepEqual(schemaA.references[0].references[0], schemaD);
+        assert.deepEqual(schemaA.references[1].references[0], schemaC);
+        assert.deepEqual(schemaA.references[1].references[1], schemaD);
+    });
+    it("getSchema, exact version, wrong minor, fails", async () => {
+        assert.isUndefined(await context.getSchema(new SchemaKey("SchemaA", 1, 1, 2), SchemaMatchType.Exact));
+    });
+    it("getSchema, latest, succeeds", async () => {
+        const stub = await locater.getSchema(new SchemaKey("SchemaA", 1, 1, 0), SchemaMatchType.Latest, context);
+        assert.isDefined(stub);
+        assert.strictEqual(stub.schemaKey.name, "SchemaA");
+        assert.strictEqual(stub.schemaKey.version.toString(), "02.00.02");
+    });
+    it("getSchema, latest write compatible, succeeds", async () => {
+        const stub = await context.getSchema(new SchemaKey("SchemaA", 1, 1, 0), SchemaMatchType.LatestWriteCompatible);
+        assert.isDefined(stub);
+        assert.strictEqual(stub.schemaKey.name, "SchemaA");
+        assert.strictEqual(stub.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchema, latest write compatible, write version wrong, fails", async () => {
+        assert.isUndefined(await context.getSchema(new SchemaKey("SchemaA", 1, 2, 0), SchemaMatchType.LatestWriteCompatible));
+    });
+    it("getSchema, latest read compatible, succeeds", async () => {
+        const stub = await context.getSchema(new SchemaKey("SchemaA", 1, 0, 0), SchemaMatchType.LatestReadCompatible);
+        assert.isDefined(stub);
+        assert.strictEqual(stub.schemaKey.name, "SchemaA");
+        assert.strictEqual(stub.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchema, latest read compatible, read version wrong, fails", async () => {
+        assert.isUndefined(await context.getSchema(new SchemaKey("SchemaA", 2, 1, 1), SchemaMatchType.LatestReadCompatible));
+    });
+    it("sync - should ignore commented out schema references", () => {
+        const stub = context.getSchemaSync(new SchemaKey("RefCommentedOut", 1, 1, 1), SchemaMatchType.LatestReadCompatible);
+        assert.isDefined(stub);
+        assert.strictEqual(stub.schemaKey.name, "RefCommentedOut");
+        assert.strictEqual(stub.schemaKey.version.toString(), "01.01.01");
+    });
+    it("async - should ignore commented out schema references", async () => {
+        const stub = await context.getSchema(new SchemaKey("RefCommentedOut", 1, 1, 1), SchemaMatchType.LatestReadCompatible);
+        assert.isDefined(stub);
+        assert.strictEqual(stub.schemaKey.name, "RefCommentedOut");
+        assert.strictEqual(stub.schemaKey.version.toString(), "01.01.01");
+    });
+    it("getSchemaKey, valid version and name, succeeds", () => {
+        const schemaXml = `<ECSchema schemaName="SchemaA" version="1.1.1"> </ECSchema>`;
+        const key = locater.getSchemaKey(schemaXml);
+        assert.deepEqual(key, new SchemaKey("SchemaA", new ECVersion(1, 1, 1)));
+    });
+    it("getSchemaKey, invalid xml, throws", () => {
+        const schemaXml = `<ECSchemaBad schemaName="SchemaA" version="1.1.1"> </ECSchemaBad>`;
+        expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find '<ECSchema>' tag in the given file`);
+    });
+    it("getSchemaKey, invalid schemaName attribute, throws", () => {
+        const schemaXml = `<ECSchema schemaNameBad="SchemaA" version="1.1.1"> </ECSchema>`;
+        expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
+    });
+    it("getSchemaKey, invalid schemaName, throws", () => {
+        const schemaXml = `<ECSchema version="1.1.1" schemaName=""> </ECSchema>`;
+        expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
+    });
+    it("getSchemaKey, invalid version attribute, throws", () => {
+        const schemaXml = `<ECSchema schemaName="SchemaA" versionBad="1.1.1"> </ECSchema>`;
+        expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
+    });
+    it("getSchemaKey, invalid version, throws", () => {
+        const schemaXml = `<ECSchema schemaName="SchemaA" version=""> </ECSchema>`;
+        expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
+    });
+    it("PublishedSchemaXmlFileLocater - should throw with incorrect argument", async () => {
+        assert.throw(() => new PublishedSchemaXmlFileLocater(__dirname), Error, `The directory ${path.join(__dirname, "ECSchemas")} containing standard schemas does not exist.`);
+    });
+});
+//# sourceMappingURL=SchemaXmlFileLocator.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlFileLocator.test.js","sourceRoot":"","sources":["../../../src/test/SchemaXmlFileLocator.test.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AACtC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,SAAS,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEjI,OAAO,EAAE,6BAA6B,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAE9F,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC3C,IAAI,OAA6B,CAAC;IAClC,IAAI,OAAsB,CAAC;IAE3B,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,GAAG,IAAI,oBAAoB,EAAE,CAAC;QACrC,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC5D,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QAC9B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAEzE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAEvE,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACzB,MAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtD,MAAM,CAAC,WAAW,CAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAEpD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,EAAE,IAAI,aAAa,EAAE,CAAC,CAAC;QAChG,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,EAAE,IAAI,aAAa,EAAE,CAAC,CAAC;QAChG,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAE3E,qDAAqD;QACrD,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,cAAc,CAAC,CAAC;QAEhD,MAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,cAAc,CAAC,CAAC;QAChD,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,CAAmB,CAAC;YAClC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;YACxE,OAAO;QACT,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,8BAA8B,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,kBAAkB,CAAC,CAAC;QACpD,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,CAAmB,CAAC;YAClC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;YACxE,OAAO;QACT,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,8BAA8B,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,qBAAqB,CAAC,CAAC;QAEvD,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtE,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,CAAmB,CAAC;YAClC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,eAAe,CAAC,gBAAgB,CAAC,CAAC;YACxE,OAAO;QACT,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,8BAA8B,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACxG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,GAAG,GAAG,IAAK,CAAC,SAA0B,CAAC;QAC7C,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACxC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,IAAI,CAAC;YACH,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACrG,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,KAAK,GAAG,CAAmB,CAAC;YAClC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,WAAW,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;YAC5E,OAAO;QACT,CAAC;QAED,MAAM,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAClG,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAClG,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAClG,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;QAElG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC1B,MAAM,CAAC,WAAW,CAAC,OAAQ,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAClD,MAAM,CAAC,SAAS,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,CAAC,SAAS,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAClD,MAAM,CAAC,SAAS,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAChE,MAAM,CAAC,SAAS,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QAChE,MAAM,CAAC,SAAS,CAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IACxG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEzG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpD,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,qBAAqB,CAAC,CAAC;QAE/G,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpD,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,qBAAqB,CAAC,CAAC,CAAC;IACxH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;QAE9G,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACpD,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,CAAC,WAAW,CAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC,CAAC;IACvH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;QAEpH,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;QAC5D,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,CAAC,oBAAoB,CAAC,CAAC;QAEtH,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACvB,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;QAC5D,MAAM,CAAC,WAAW,CAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,UAAU,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,SAAS,GAAG,6DAA6D,CAAC;QAChF,MAAM,GAAG,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC5C,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,SAAS,CAAC,SAAS,EAAE,IAAI,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,SAAS,GAAG,mEAAmE,CAAC;QACtF,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,mDAAmD,CAAC,CAAC;IAC9H,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,SAAS,GAAG,gEAAgE,CAAC;QACnF,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,6EAA6E,CAAC,CAAC;IACxJ,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,SAAS,GAAG,sDAAsD,CAAC;QACzE,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,6EAA6E,CAAC,CAAC;IACxJ,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,SAAS,GAAG,gEAAgE,CAAC;QACnF,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,6EAA6E,CAAC,CAAC;IACxJ,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,SAAS,GAAG,wDAAwD,CAAC;QAC3E,MAAM,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,cAAc,EAAE,6EAA6E,CAAC,CAAC;IACxJ,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,6BAA6B,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,iBAAiB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,8CAA8C,CAAC,CAAC;IAC5K,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { assert, expect } from \"chai\";\r\nimport * as path from \"path\";\r\nimport { ECObjectsError, ECObjectsStatus, ECVersion, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\r\nimport { FileSchemaKey } from \"../SchemaFileLocater\";\r\nimport { PublishedSchemaXmlFileLocater, SchemaXmlFileLocater } from \"../SchemaXmlFileLocater\";\r\n\r\ndescribe(\"SchemaXmlFileLocater tests:\", () => {\r\n  let locater: SchemaXmlFileLocater;\r\n  let context: SchemaContext;\r\n\r\n  beforeEach(() => {\r\n    locater = new SchemaXmlFileLocater();\r\n    locater.addSchemaSearchPath(path.join(__dirname, \"assets\"));\r\n    context = new SchemaContext();\r\n    context.addLocater(locater);\r\n  });\r\n\r\n  it(\"locate valid schema with multiple references\", async () => {\r\n    const schemaKey = new SchemaKey(\"SchemaA\", 1, 1, 1);\r\n    const schema = await context.getSchema(schemaKey, SchemaMatchType.Exact);\r\n\r\n    assert.isDefined(schema);\r\n    assert.strictEqual(schema!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(schema!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"locate valid schema with multiple references synchronously\", () => {\r\n    const schemaKey = new SchemaKey(\"SchemaA\", 1, 1, 1);\r\n    const schema = context.getSchemaSync(schemaKey, SchemaMatchType.Exact);\r\n\r\n    assert.isDefined(schema);\r\n    assert.strictEqual(schema!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(schema!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema called multiple times for same schema\", async () => {\r\n    const schemaKey = new SchemaKey(\"SchemaD\", 4, 4, 4);\r\n\r\n    const locater1 = await locater.getSchema(schemaKey, SchemaMatchType.Exact, new SchemaContext());\r\n    const locater2 = await locater.getSchema(schemaKey, SchemaMatchType.Exact, new SchemaContext());\r\n    const context1 = await context.getSchema(schemaKey, SchemaMatchType.Exact);\r\n    const context2 = await context.getSchema(schemaKey, SchemaMatchType.Exact);\r\n\r\n    // locater should not cache, but context should cache\r\n    assert.notEqual(locater1, locater2);\r\n    assert.notEqual(locater1, context1);\r\n    assert.strictEqual(context1, context2);\r\n  });\r\n\r\n  it(\"getSchema which does not exist, returns undefined\", async () => {\r\n    const schemaKey = new SchemaKey(\"DoesNotExist\");\r\n\r\n    assert.isUndefined(await locater.getSchema(schemaKey, SchemaMatchType.Exact, context));\r\n  });\r\n\r\n  it(\"loadSchema from file, bad schema tag, throws\", async () => {\r\n    const schemaKey = new SchemaKey(\"BadSchemaTag\");\r\n    try {\r\n      await locater.getSchema(schemaKey, SchemaMatchType.Latest, context);\r\n    } catch (e) {\r\n      const error = e as ECObjectsError;\r\n      assert.strictEqual(error.errorNumber, ECObjectsStatus.InvalidSchemaXML);\r\n      return;\r\n    }\r\n\r\n    assert.fail(0, 1, \"Expected ECObjects exception\");\r\n  });\r\n\r\n  it(\"loadSchema from file, bad schema name tag, throws\", async () => {\r\n    const schemaKey = new SchemaKey(\"BadSchemaNameTag\");\r\n    try {\r\n      await locater.getSchema(schemaKey, SchemaMatchType.Latest, context);\r\n    } catch (e) {\r\n      const error = e as ECObjectsError;\r\n      assert.strictEqual(error.errorNumber, ECObjectsStatus.InvalidSchemaXML);\r\n      return;\r\n    }\r\n\r\n    assert.fail(0, 1, \"Expected ECObjects exception\");\r\n  });\r\n\r\n  it(\"loadSchema from file, bad schema version tag, throws\", async () => {\r\n    const schemaKey = new SchemaKey(\"BadSchemaVersionTag\");\r\n\r\n    try {\r\n      await locater.getSchema(schemaKey, SchemaMatchType.Latest, context);\r\n    } catch (e) {\r\n      const error = e as ECObjectsError;\r\n      assert.strictEqual(error.errorNumber, ECObjectsStatus.InvalidSchemaXML);\r\n      return;\r\n    }\r\n\r\n    assert.fail(0, 1, \"Expected ECObjects exception\");\r\n  });\r\n\r\n  it(\"getSchema, full version, succeeds\", async () => {\r\n    const stub = await locater.getSchema(new SchemaKey(\"SchemaA\", 1, 1, 1), SchemaMatchType.Exact, context);\r\n    assert.isDefined(stub);\r\n    const key = stub!.schemaKey as FileSchemaKey;\r\n    assert.strictEqual(key.name, \"SchemaA\");\r\n    assert.strictEqual(key.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema, reference does not exist, throws.\", async () => {\r\n    try {\r\n      await locater.getSchema(new SchemaKey(\"RefDoesNotExist\", 1, 1, 1), SchemaMatchType.Exact, context);\r\n    } catch (e) {\r\n      const error = e as ECObjectsError;\r\n      assert.strictEqual(error.errorNumber, ECObjectsStatus.UnableToLocateSchema);\r\n      return;\r\n    }\r\n\r\n    assert.fail();\r\n  });\r\n\r\n  it(\"getSchema, references set\", async () => {\r\n    const schemaA = await context.getSchema(new SchemaKey(\"SchemaA\", 1, 1, 1), SchemaMatchType.Exact);\r\n    const schemaB = await context.getSchema(new SchemaKey(\"SchemaB\", 2, 2, 2), SchemaMatchType.Exact);\r\n    const schemaC = await context.getSchema(new SchemaKey(\"SchemaC\", 3, 3, 3), SchemaMatchType.Exact);\r\n    const schemaD = await context.getSchema(new SchemaKey(\"SchemaD\", 4, 4, 4), SchemaMatchType.Exact);\r\n\r\n    assert.isDefined(schemaA);\r\n    assert.strictEqual(schemaA!.references.length, 2);\r\n    assert.deepEqual(schemaA!.references[0], schemaC);\r\n    assert.deepEqual(schemaA!.references[1], schemaB);\r\n    assert.deepEqual(schemaA!.references[0].references[0], schemaD);\r\n    assert.deepEqual(schemaA!.references[1].references[0], schemaC);\r\n    assert.deepEqual(schemaA!.references[1].references[1], schemaD);\r\n  });\r\n\r\n  it(\"getSchema, exact version, wrong minor, fails\", async () => {\r\n    assert.isUndefined(await context.getSchema(new SchemaKey(\"SchemaA\", 1, 1, 2), SchemaMatchType.Exact));\r\n  });\r\n\r\n  it(\"getSchema, latest, succeeds\", async () => {\r\n    const stub = await locater.getSchema(new SchemaKey(\"SchemaA\", 1, 1, 0), SchemaMatchType.Latest, context);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"02.00.02\");\r\n  });\r\n\r\n  it(\"getSchema, latest write compatible, succeeds\", async () => {\r\n    const stub = await context.getSchema(new SchemaKey(\"SchemaA\", 1, 1, 0), SchemaMatchType.LatestWriteCompatible);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema, latest write compatible, write version wrong, fails\", async () => {\r\n    assert.isUndefined(await context.getSchema(new SchemaKey(\"SchemaA\", 1, 2, 0), SchemaMatchType.LatestWriteCompatible));\r\n  });\r\n\r\n  it(\"getSchema, latest read compatible, succeeds\", async () => {\r\n    const stub = await context.getSchema(new SchemaKey(\"SchemaA\", 1, 0, 0), SchemaMatchType.LatestReadCompatible);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"SchemaA\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchema, latest read compatible, read version wrong, fails\", async () => {\r\n    assert.isUndefined(await context.getSchema(new SchemaKey(\"SchemaA\", 2, 1, 1), SchemaMatchType.LatestReadCompatible));\r\n  });\r\n\r\n  it(\"sync - should ignore commented out schema references\", () => {\r\n    const stub = context.getSchemaSync(new SchemaKey(\"RefCommentedOut\", 1, 1, 1), SchemaMatchType.LatestReadCompatible);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"RefCommentedOut\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"async - should ignore commented out schema references\", async () => {\r\n    const stub = await context.getSchema(new SchemaKey(\"RefCommentedOut\", 1, 1, 1), SchemaMatchType.LatestReadCompatible);\r\n\r\n    assert.isDefined(stub);\r\n    assert.strictEqual(stub!.schemaKey.name, \"RefCommentedOut\");\r\n    assert.strictEqual(stub!.schemaKey.version.toString(), \"01.01.01\");\r\n  });\r\n\r\n  it(\"getSchemaKey, valid version and name, succeeds\", () => {\r\n    const schemaXml = `<ECSchema schemaName=\"SchemaA\" version=\"1.1.1\"> </ECSchema>`;\r\n    const key = locater.getSchemaKey(schemaXml);\r\n    assert.deepEqual(key, new SchemaKey(\"SchemaA\", new ECVersion(1, 1, 1)));\r\n  });\r\n  it(\"getSchemaKey, invalid xml, throws\", () => {\r\n    const schemaXml = `<ECSchemaBad schemaName=\"SchemaA\" version=\"1.1.1\"> </ECSchemaBad>`;\r\n    expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find '<ECSchema>' tag in the given file`);\r\n  });\r\n  it(\"getSchemaKey, invalid schemaName attribute, throws\", () => {\r\n    const schemaXml = `<ECSchema schemaNameBad=\"SchemaA\" version=\"1.1.1\"> </ECSchema>`;\r\n    expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\r\n  });\r\n  it(\"getSchemaKey, invalid schemaName, throws\", () => {\r\n    const schemaXml = `<ECSchema version=\"1.1.1\" schemaName=\"\"> </ECSchema>`;\r\n    expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\r\n  });\r\n  it(\"getSchemaKey, invalid version attribute, throws\", () => {\r\n    const schemaXml = `<ECSchema schemaName=\"SchemaA\" versionBad=\"1.1.1\"> </ECSchema>`;\r\n    expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\r\n  });\r\n  it(\"getSchemaKey, invalid version, throws\", () => {\r\n    const schemaXml = `<ECSchema schemaName=\"SchemaA\" version=\"\"> </ECSchema>`;\r\n    expect(() => locater.getSchemaKey(schemaXml)).to.throw(ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\r\n  });\r\n  it(\"PublishedSchemaXmlFileLocater - should throw with incorrect argument\", async () => {\r\n    assert.throw(() => new PublishedSchemaXmlFileLocater(__dirname), Error, `The directory ${path.join(__dirname, \"ECSchemas\")} containing standard schemas does not exist.`);\r\n  });\r\n});\r\n"]}

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

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

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

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