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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. package/CHANGELOG.md +71 -1
  2. package/lib/cjs/SchemaFileLocater.d.ts +23 -8
  3. package/lib/cjs/SchemaFileLocater.d.ts.map +1 -1
  4. package/lib/cjs/SchemaFileLocater.js +23 -11
  5. package/lib/cjs/SchemaFileLocater.js.map +1 -1
  6. package/lib/cjs/SchemaJsonFileLocater.d.ts +4 -3
  7. package/lib/cjs/SchemaJsonFileLocater.d.ts.map +1 -1
  8. package/lib/cjs/SchemaJsonFileLocater.js +4 -3
  9. package/lib/cjs/SchemaJsonFileLocater.js.map +1 -1
  10. package/lib/cjs/SchemaStringLocater.d.ts +2 -2
  11. package/lib/cjs/SchemaStringLocater.d.ts.map +1 -1
  12. package/lib/cjs/SchemaStringLocater.js +12 -9
  13. package/lib/cjs/SchemaStringLocater.js.map +1 -1
  14. package/lib/cjs/SchemaXml.d.ts +1 -1
  15. package/lib/cjs/SchemaXml.js +1 -1
  16. package/lib/cjs/SchemaXml.js.map +1 -1
  17. package/lib/cjs/SchemaXmlFileLocater.d.ts +31 -3
  18. package/lib/cjs/SchemaXmlFileLocater.d.ts.map +1 -1
  19. package/lib/cjs/SchemaXmlFileLocater.js +46 -4
  20. package/lib/cjs/SchemaXmlFileLocater.js.map +1 -1
  21. package/lib/cjs/SchemaXmlStringLocater.d.ts +2 -2
  22. package/lib/cjs/SchemaXmlStringLocater.d.ts.map +1 -1
  23. package/lib/cjs/SchemaXmlStringLocater.js +4 -4
  24. package/lib/cjs/SchemaXmlStringLocater.js.map +1 -1
  25. package/lib/cjs/StubSchemaXmlFileLocater.d.ts +2 -2
  26. package/lib/cjs/StubSchemaXmlFileLocater.d.ts.map +1 -1
  27. package/lib/cjs/StubSchemaXmlFileLocater.js +9 -9
  28. package/lib/cjs/StubSchemaXmlFileLocater.js.map +1 -1
  29. package/lib/cjs/ecschema-locaters.js.map +1 -1
  30. package/lib/cjs/test/ConcurrentGetSchemaJson.test.js.map +1 -1
  31. package/lib/cjs/test/ConcurrentGetSchemaXml.test.js.map +1 -1
  32. package/lib/cjs/test/SchemaJsonFileLocator.test.js +2 -2
  33. package/lib/cjs/test/SchemaJsonFileLocator.test.js.map +1 -1
  34. package/lib/cjs/test/SchemaXml.test.js.map +1 -1
  35. package/lib/cjs/test/SchemaXmlFileLocator.test.js +12 -9
  36. package/lib/cjs/test/SchemaXmlFileLocator.test.js.map +1 -1
  37. package/lib/cjs/test/SchemaXmlStringLocater.test.js +9 -9
  38. package/lib/cjs/test/SchemaXmlStringLocater.test.js.map +1 -1
  39. package/lib/cjs/test/StubSchemaXmlFileLocater.test.js +9 -8
  40. package/lib/cjs/test/StubSchemaXmlFileLocater.test.js.map +1 -1
  41. package/lib/esm/SchemaFileLocater.d.ts +101 -0
  42. package/lib/esm/SchemaFileLocater.d.ts.map +1 -0
  43. package/lib/esm/SchemaFileLocater.js +220 -0
  44. package/lib/esm/SchemaFileLocater.js.map +1 -0
  45. package/lib/esm/SchemaJsonFileLocater.d.ts +43 -0
  46. package/lib/esm/SchemaJsonFileLocater.d.ts.map +1 -0
  47. package/lib/esm/SchemaJsonFileLocater.js +97 -0
  48. package/lib/esm/SchemaJsonFileLocater.js.map +1 -0
  49. package/lib/esm/SchemaStringLocater.d.ts +54 -0
  50. package/lib/esm/SchemaStringLocater.d.ts.map +1 -0
  51. package/lib/esm/SchemaStringLocater.js +83 -0
  52. package/lib/esm/SchemaStringLocater.js.map +1 -0
  53. package/lib/esm/SchemaXml.d.ts +22 -0
  54. package/lib/esm/SchemaXml.d.ts.map +1 -0
  55. package/lib/esm/SchemaXml.js +55 -0
  56. package/lib/esm/SchemaXml.js.map +1 -0
  57. package/lib/esm/SchemaXmlFileLocater.d.ts +70 -0
  58. package/lib/esm/SchemaXmlFileLocater.d.ts.map +1 -0
  59. package/lib/esm/SchemaXmlFileLocater.js +140 -0
  60. package/lib/esm/SchemaXmlFileLocater.js.map +1 -0
  61. package/lib/esm/SchemaXmlStringLocater.d.ts +48 -0
  62. package/lib/esm/SchemaXmlStringLocater.d.ts.map +1 -0
  63. package/lib/esm/SchemaXmlStringLocater.js +100 -0
  64. package/lib/esm/SchemaXmlStringLocater.js.map +1 -0
  65. package/lib/esm/StubSchemaXmlFileLocater.d.ts +81 -0
  66. package/lib/esm/StubSchemaXmlFileLocater.d.ts.map +1 -0
  67. package/lib/esm/StubSchemaXmlFileLocater.js +184 -0
  68. package/lib/esm/StubSchemaXmlFileLocater.js.map +1 -0
  69. package/lib/esm/ecschema-locaters.d.ts +20 -0
  70. package/lib/esm/ecschema-locaters.d.ts.map +1 -0
  71. package/lib/esm/ecschema-locaters.js +24 -0
  72. package/lib/esm/ecschema-locaters.js.map +1 -0
  73. package/lib/esm/test/ConcurrentGetSchemaJson.test.d.ts +2 -0
  74. package/lib/esm/test/ConcurrentGetSchemaJson.test.d.ts.map +1 -0
  75. package/lib/esm/test/ConcurrentGetSchemaJson.test.js +249 -0
  76. package/lib/esm/test/ConcurrentGetSchemaJson.test.js.map +1 -0
  77. package/lib/esm/test/ConcurrentGetSchemaXml.test.d.ts +2 -0
  78. package/lib/esm/test/ConcurrentGetSchemaXml.test.d.ts.map +1 -0
  79. package/lib/esm/test/ConcurrentGetSchemaXml.test.js +186 -0
  80. package/lib/esm/test/ConcurrentGetSchemaXml.test.js.map +1 -0
  81. package/lib/esm/test/SchemaJsonFileLocator.test.d.ts +2 -0
  82. package/lib/esm/test/SchemaJsonFileLocator.test.d.ts.map +1 -0
  83. package/lib/esm/test/SchemaJsonFileLocator.test.js +118 -0
  84. package/lib/esm/test/SchemaJsonFileLocator.test.js.map +1 -0
  85. package/lib/esm/test/SchemaXml.test.d.ts +2 -0
  86. package/lib/esm/test/SchemaXml.test.d.ts.map +1 -0
  87. package/lib/esm/test/SchemaXml.test.js +55 -0
  88. package/lib/esm/test/SchemaXml.test.js.map +1 -0
  89. package/lib/esm/test/SchemaXmlFileLocator.test.d.ts +2 -0
  90. package/lib/esm/test/SchemaXmlFileLocator.test.d.ts.map +1 -0
  91. package/lib/esm/test/SchemaXmlFileLocator.test.js +182 -0
  92. package/lib/esm/test/SchemaXmlFileLocator.test.js.map +1 -0
  93. package/lib/esm/test/SchemaXmlStringLocater.test.d.ts +2 -0
  94. package/lib/esm/test/SchemaXmlStringLocater.test.d.ts.map +1 -0
  95. package/lib/esm/test/SchemaXmlStringLocater.test.js +219 -0
  96. package/lib/esm/test/SchemaXmlStringLocater.test.js.map +1 -0
  97. package/lib/esm/test/StubSchemaXmlFileLocater.test.d.ts +2 -0
  98. package/lib/esm/test/StubSchemaXmlFileLocater.test.d.ts.map +1 -0
  99. package/lib/esm/test/StubSchemaXmlFileLocater.test.js +170 -0
  100. package/lib/esm/test/StubSchemaXmlFileLocater.test.js.map +1 -0
  101. package/package.json +14 -12
@@ -10,6 +10,7 @@ const path = require("path");
10
10
  const EC = require("@itwin/ecschema-metadata");
11
11
  const SchemaFileLocater_1 = require("../SchemaFileLocater");
12
12
  const StubSchemaXmlFileLocater_1 = require("../StubSchemaXmlFileLocater");
13
+ const fs = require("fs");
13
14
  (0, chai_1.use)(chaiAsPromised);
14
15
  describe("StubSchemaXmlFileLocater tests:", () => {
15
16
  let locater;
@@ -23,14 +24,14 @@ describe("StubSchemaXmlFileLocater tests:", () => {
23
24
  it("loadSchema, schema text not provided, schema loaded successfully", async () => {
24
25
  const schemaPath = path.join(__dirname, "assets", "SchemaA.02.00.02.ecschema.xml");
25
26
  const schemaKey = new SchemaFileLocater_1.FileSchemaKey(new EC.SchemaKey("SchemaA", 2, 0, 2), schemaPath);
26
- schemaKey.schemaText = locater.readUtf8FileToStringSync(schemaPath);
27
+ schemaKey.schemaText = fs.readFileSync(schemaPath, "utf-8");
27
28
  const schema = locater.loadSchema(schemaPath);
28
29
  (0, chai_1.expect)(schema).is.not.undefined;
29
30
  (0, chai_1.expect)(schema.schemaKey).to.deep.equal(schemaKey);
30
31
  });
31
32
  it("loadSchema, schema text provided, schema loaded successfully", async () => {
32
33
  const schemaPath = path.join(__dirname, "assets", "SchemaA.02.00.02.ecschema.xml");
33
- const schemaText = locater.readUtf8FileToStringSync(schemaPath);
34
+ const schemaText = fs.readFileSync(schemaPath, "utf-8");
34
35
  const schemaKey = new SchemaFileLocater_1.FileSchemaKey(new EC.SchemaKey("SchemaA", 2, 0, 2), schemaPath);
35
36
  schemaKey.schemaText = schemaText;
36
37
  const schema = locater.loadSchema(schemaPath, schemaText);
@@ -79,7 +80,7 @@ describe("StubSchemaXmlFileLocater tests:", () => {
79
80
  });
80
81
  it("getSchema, reference does not exist, throws.", async () => {
81
82
  const schemaKey = new EC.SchemaKey("RefDoesNotExist", 1, 1, 1);
82
- await (0, chai_1.expect)(locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context)).to.be.rejectedWith(EC.ECObjectsError, "Unable to locate referenced schema: DoesNotExist.3.3.3");
83
+ await (0, chai_1.expect)(locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context)).to.be.rejectedWith(EC.ECSchemaError, "Unable to locate referenced schema: DoesNotExist.3.3.3");
83
84
  });
84
85
  it("getSchema, references set", async () => {
85
86
  const schemaA = await context.getSchema(new EC.SchemaKey("SchemaA", 1, 1, 1), EC.SchemaMatchType.Exact);
@@ -144,23 +145,23 @@ describe("StubSchemaXmlFileLocater tests:", () => {
144
145
  });
145
146
  it("getSchemaKey, invalid xml, throws", () => {
146
147
  const schemaXml = `<ECSchemaBad schemaName="SchemaA" version="1.1.1"> </ECSchemaBad>`;
147
- (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECObjectsError, `Could not find '<ECSchema>' tag in the given file`);
148
+ (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECSchemaError, `Could not find '<ECSchema>' tag in the given file`);
148
149
  });
149
150
  it("getSchemaKey, invalid schemaName attribute, throws", () => {
150
151
  const schemaXml = `<ECSchema schemaNameBad="SchemaA" version="1.1.1"> </ECSchema>`;
151
- (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
152
+ (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECSchemaError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
152
153
  });
153
154
  it("getSchemaKey, invalid schemaName, throws", () => {
154
155
  const schemaXml = `<ECSchema version="1.1.1" schemaName=""> </ECSchema>`;
155
- (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
156
+ (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECSchemaError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
156
157
  });
157
158
  it("getSchemaKey, invalid version attribute, throws", () => {
158
159
  const schemaXml = `<ECSchema schemaName="SchemaA" versionBad="1.1.1"> </ECSchema>`;
159
- (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
160
+ (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECSchemaError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
160
161
  });
161
162
  it("getSchemaKey, invalid version, throws", () => {
162
163
  const schemaXml = `<ECSchema schemaName="SchemaA" version=""> </ECSchema>`;
163
- (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
164
+ (0, chai_1.expect)(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECSchemaError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
164
165
  });
165
166
  it("getSchemaKey, ECv2 schema, valid version set", () => {
166
167
  const schemaXml = `<ECSchema schemaName="ECv2Schema" version="1.1" nameSpacePrefix="v2" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.2.0"> </ECSchema>`;
@@ -1 +1 @@
1
- {"version":3,"file":"StubSchemaXmlFileLocater.test.js","sourceRoot":"","sources":["../../../src/test/StubSchemaXmlFileLocater.test.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;AAE/F,+BAAmC;AACnC,mDAAmD;AACnD,6BAA6B;AAC7B,+CAA+C;AAC/C,4DAAqD;AACrD,0EAAuE;AAEvE,IAAA,UAAG,EAAC,cAAc,CAAC,CAAC;AAEpB,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAI,OAAiC,CAAC;IACtC,IAAI,OAAyB,CAAC;IAE9B,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,GAAG,IAAI,mDAAwB,EAAE,CAAC;QACzC,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,kEAAkE,EAAE,KAAK,IAAI,EAAE;QAChF,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,+BAA+B,CAAC,CAAC;QACnF,MAAM,SAAS,GAAG,IAAI,iCAAa,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;QACtF,SAAS,CAAC,UAAU,GAAG,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,IAAA,aAAM,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,+BAA+B,CAAC,CAAC;QACnF,MAAM,UAAU,GAAG,OAAO,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QAChE,MAAM,SAAS,GAAG,IAAI,iCAAa,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;QACtF,SAAS,CAAC,UAAU,GAAG,UAAU,CAAC;QAElC,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAC1D,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,IAAA,aAAM,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,oCAAoC,CAAC,CAAC;QACxF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,4CAA4C,UAAU,GAAG,CAAC,CAAC;IAC1H,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,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,IAAA,aAAM,EAAC,MAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACpE,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,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,IAAA,aAAM,EAAC,MAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACpE,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,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACnD,IAAA,aAAM,EAAC,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAChG,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;QAC9G,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,MAAM,GAAG,GAAG,IAAK,CAAC,SAA0B,CAAC;QAC7C,IAAA,aAAM,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrC,IAAA,aAAM,EAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,IAAA,aAAM,EAAC,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,cAAc,EAAE,wDAAwD,CAAC,CAAC;IAChL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,OAAO,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,CAAC,CAAC;QACxG,MAAM,OAAO,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,CAAC,CAAC;QACxG,MAAM,OAAO,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,CAAC,CAAC;QACxG,MAAM,OAAO,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,CAAC,CAAC;QAExG,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QACjC,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpE,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpE,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,IAAA,aAAM,EAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAClH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,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,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/G,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,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,CAAC,CAAC;QAErH,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,IAAA,aAAM,EAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAClI,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,CAAC,CAAC;QAEpH,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,IAAA,aAAM,EAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAClI,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACnH,IAAA,aAAM,EAAC,MAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;QAE1H,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACzD,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;QAE5H,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACzD,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,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,IAAA,aAAM,EAAC,GAAG,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACpF,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,SAAS,GAAG,mEAAmE,CAAC;QACtF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,cAAc,EAAE,mDAAmD,CAAC,CAAC;IACjI,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,SAAS,GAAG,gEAAgE,CAAC;QACnF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,cAAc,EAAE,6EAA6E,CAAC,CAAC;IAC3J,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,SAAS,GAAG,sDAAsD,CAAC;QACzE,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,cAAc,EAAE,6EAA6E,CAAC,CAAC;IAC3J,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,SAAS,GAAG,gEAAgE,CAAC;QACnF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,cAAc,EAAE,6EAA6E,CAAC,CAAC;IAC3J,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,SAAS,GAAG,wDAAwD,CAAC;QAC3E,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,cAAc,EAAE,6EAA6E,CAAC,CAAC;IAC3J,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,SAAS,GAAG,4IAA4I,CAAC;QAC/J,MAAM,GAAG,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAA,aAAM,EAAC,GAAG,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACvF,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 { expect, use } from \"chai\";\r\nimport * as chaiAsPromised from \"chai-as-promised\";\r\nimport * as path from \"path\";\r\nimport * as EC from \"@itwin/ecschema-metadata\";\r\nimport { FileSchemaKey } from \"../SchemaFileLocater\";\r\nimport { StubSchemaXmlFileLocater } from \"../StubSchemaXmlFileLocater\";\r\n\r\nuse(chaiAsPromised);\r\n\r\ndescribe(\"StubSchemaXmlFileLocater tests:\", () => {\r\n let locater: StubSchemaXmlFileLocater;\r\n let context: EC.SchemaContext;\r\n\r\n beforeEach(() => {\r\n locater = new StubSchemaXmlFileLocater();\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(\"loadSchema, schema text not provided, schema loaded successfully\", async () => {\r\n const schemaPath = path.join(__dirname, \"assets\", \"SchemaA.02.00.02.ecschema.xml\");\r\n const schemaKey = new FileSchemaKey(new EC.SchemaKey(\"SchemaA\", 2, 0, 2), schemaPath);\r\n schemaKey.schemaText = locater.readUtf8FileToStringSync(schemaPath);\r\n const schema = locater.loadSchema(schemaPath);\r\n expect(schema).is.not.undefined;\r\n expect(schema.schemaKey).to.deep.equal(schemaKey);\r\n });\r\n\r\n it(\"loadSchema, schema text provided, schema loaded successfully\", async () => {\r\n const schemaPath = path.join(__dirname, \"assets\", \"SchemaA.02.00.02.ecschema.xml\");\r\n const schemaText = locater.readUtf8FileToStringSync(schemaPath);\r\n const schemaKey = new FileSchemaKey(new EC.SchemaKey(\"SchemaA\", 2, 0, 2), schemaPath);\r\n schemaKey.schemaText = schemaText;\r\n\r\n const schema = locater.loadSchema(schemaPath, schemaText);\r\n expect(schema).is.not.undefined;\r\n expect(schema.schemaKey).to.deep.equal(schemaKey);\r\n });\r\n\r\n it(\"loadSchema, schema can't be found, throws\", async () => {\r\n const schemaPath = path.join(__dirname, \"assets\", \"DoesNotExist.01.00.00.ecschema.xml\");\r\n expect(() => locater.loadSchema(schemaPath)).to.throw(Error, `ENOENT: no such file or directory, open '${schemaPath}'`);\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 expect(schema).is.not.undefined;\r\n expect(schema!.name).to.equal(\"SchemaA\");\r\n expect(schema!.schemaKey.version.toString()).to.equal(\"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 expect(schema).is.not.undefined;\r\n expect(schema!.name).to.equal(\"SchemaA\");\r\n expect(schema!.schemaKey.version.toString()).to.equal(\"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 expect(locater1).not.equal(locater2);\r\n expect(locater1).not.equal(context1);\r\n expect(context1).to.equal(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 expect(await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context)).to.be.undefined;\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 expect(stub).is.not.undefined;\r\n const key = stub!.schemaKey as FileSchemaKey;\r\n expect(key.name).to.equal(\"SchemaA\");\r\n expect(key.version.toString()).to.equal(\"01.01.01\");\r\n });\r\n\r\n it(\"getSchema, reference does not exist, throws.\", async () => {\r\n const schemaKey = new EC.SchemaKey(\"RefDoesNotExist\", 1, 1, 1);\r\n await expect(locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context)).to.be.rejectedWith(EC.ECObjectsError, \"Unable to locate referenced schema: DoesNotExist.3.3.3\");\r\n });\r\n\r\n it(\"getSchema, references set\", async () => {\r\n const schemaA = await context.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 1), EC.SchemaMatchType.Exact);\r\n const schemaB = await context.getSchema(new EC.SchemaKey(\"SchemaB\", 2, 2, 2), EC.SchemaMatchType.Exact);\r\n const schemaC = await context.getSchema(new EC.SchemaKey(\"SchemaC\", 3, 3, 3), EC.SchemaMatchType.Exact);\r\n const schemaD = await context.getSchema(new EC.SchemaKey(\"SchemaD\", 4, 4, 4), EC.SchemaMatchType.Exact);\r\n\r\n expect(schemaA).is.not.undefined;\r\n expect(schemaA!.references.length).to.equal(2);\r\n expect(schemaA!.references[0]).to.deep.equal(schemaC);\r\n expect(schemaA!.references[1]).to.deep.equal(schemaB);\r\n expect(schemaA!.references[0].references[0]).to.deep.equal(schemaD);\r\n expect(schemaA!.references[1].references[0]).to.deep.equal(schemaC);\r\n expect(schemaA!.references[1].references[1]).to.deep.equal(schemaD);\r\n });\r\n\r\n it(\"getSchema, exact version, wrong minor, fails\", async () => {\r\n expect(await context.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 2), EC.SchemaMatchType.Exact)).to.be.undefined;\r\n });\r\n\r\n it(\"getSchema, latest, succeeds\", async () => {\r\n const stub = await locater.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 0), EC.SchemaMatchType.Latest, context);\r\n\r\n expect(stub).is.not.undefined;\r\n expect(stub!.schemaKey.name).to.equal(\"SchemaA\");\r\n expect(stub!.schemaKey.version.toString()).to.equal(\"02.00.02\");\r\n });\r\n\r\n it(\"getSchema, latest write compatible, succeeds\", async () => {\r\n const stub = await context.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 0), EC.SchemaMatchType.LatestWriteCompatible);\r\n\r\n expect(stub).is.not.undefined;\r\n expect(stub!.schemaKey.name).to.equal(\"SchemaA\");\r\n expect(stub!.schemaKey.version.toString()).to.equal(\"01.01.01\");\r\n });\r\n\r\n it(\"getSchema, latest write compatible, write version wrong, fails\", async () => {\r\n expect(await context.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 2, 0), EC.SchemaMatchType.LatestWriteCompatible)).to.be.undefined;\r\n });\r\n\r\n it(\"getSchema, latest read compatible, succeeds\", async () => {\r\n const stub = await context.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 0, 0), EC.SchemaMatchType.LatestReadCompatible);\r\n\r\n expect(stub).is.not.undefined;\r\n expect(stub!.schemaKey.name).to.equal(\"SchemaA\");\r\n expect(stub!.schemaKey.version.toString()).to.equal(\"01.01.01\");\r\n });\r\n\r\n it(\"getSchema, latest read compatible, read version wrong, fails\", async () => {\r\n expect(await context.getSchema(new EC.SchemaKey(\"SchemaA\", 2, 1, 1), EC.SchemaMatchType.LatestWriteCompatible)).to.be.undefined;\r\n });\r\n\r\n it(\"Schema XML has EC v2 nameSpacePrefix, alias set properly on deserialized schema.\", async () => {\r\n const schema = await locater.getSchema(new EC.SchemaKey(\"ECv2Schema\", 1, 0, 1), EC.SchemaMatchType.Exact, context);\r\n expect(schema!.alias).to.equal(\"v2\");\r\n });\r\n\r\n it(\"sync - should ignore commented out schema references\", () => {\r\n const stub = context.getSchemaSync(new EC.SchemaKey(\"RefCommentedOut\", 1, 1, 1), EC.SchemaMatchType.LatestReadCompatible);\r\n\r\n expect(stub).is.not.undefined;\r\n expect(stub!.schemaKey.name).to.equal(\"RefCommentedOut\");\r\n expect(stub!.schemaKey.version.toString()).to.equal(\"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 EC.SchemaKey(\"RefCommentedOut\", 1, 1, 1), EC.SchemaMatchType.LatestReadCompatible);\r\n\r\n expect(stub).is.not.undefined;\r\n expect(stub!.schemaKey.name).to.equal(\"RefCommentedOut\");\r\n expect(stub!.schemaKey.version.toString()).to.equal(\"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 expect(key).to.deep.equal(new EC.SchemaKey(\"SchemaA\", new EC.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(EC.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(EC.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(EC.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(EC.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(EC.ECObjectsError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\r\n });\r\n it(\"getSchemaKey, ECv2 schema, valid version set\", () => {\r\n const schemaXml = `<ECSchema schemaName=\"ECv2Schema\" version=\"1.1\" nameSpacePrefix=\"v2\" xmlns=\"http://www.bentley.com/schemas/Bentley.ECXML.2.0\"> </ECSchema>`;\r\n const key = locater.getSchemaKey(schemaXml);\r\n expect(key).to.deep.equal(new EC.SchemaKey(\"ECv2Schema\", new EC.ECVersion(1, 0, 1)));\r\n });\r\n});\r\n"]}
1
+ {"version":3,"file":"StubSchemaXmlFileLocater.test.js","sourceRoot":"","sources":["../../../src/test/StubSchemaXmlFileLocater.test.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;AAE/F,+BAAmC;AACnC,mDAAmD;AACnD,6BAA6B;AAC7B,+CAA+C;AAC/C,4DAAqD;AACrD,0EAAuE;AACvE,yBAAyB;AAEzB,IAAA,UAAG,EAAC,cAAc,CAAC,CAAC;AAEpB,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAI,OAAiC,CAAC;IACtC,IAAI,OAAyB,CAAC;IAE9B,UAAU,CAAC,GAAG,EAAE;QACd,OAAO,GAAG,IAAI,mDAAwB,EAAE,CAAC;QACzC,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,kEAAkE,EAAE,KAAK,IAAI,EAAE;QAChF,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,+BAA+B,CAAC,CAAC;QACnF,MAAM,SAAS,GAAG,IAAI,iCAAa,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;QACtF,SAAS,CAAC,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,IAAA,aAAM,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,+BAA+B,CAAC,CAAC;QACnF,MAAM,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,SAAS,GAAG,IAAI,iCAAa,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;QACtF,SAAS,CAAC,UAAU,GAAG,UAAU,CAAC;QAElC,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAC1D,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,IAAA,aAAM,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,oCAAoC,CAAC,CAAC;QACxF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,EAAE,4CAA4C,UAAU,GAAG,CAAC,CAAC;IAC1H,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,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,IAAA,aAAM,EAAC,MAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACpE,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,IAAA,aAAM,EAAC,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAChC,IAAA,aAAM,EAAC,MAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACzC,IAAA,aAAM,EAAC,MAAO,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACpE,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,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACrC,IAAA,aAAM,EAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACnD,IAAA,aAAM,EAAC,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAChG,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;QAC9G,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,MAAM,GAAG,GAAG,IAAK,CAAC,SAA0B,CAAC;QAC7C,IAAA,aAAM,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrC,IAAA,aAAM,EAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,SAAS,GAAG,IAAI,EAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QAC/D,MAAM,IAAA,aAAM,EAAC,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,aAAa,EAAE,wDAAwD,CAAC,CAAC;IAC/K,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,OAAO,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,CAAC,CAAC;QACxG,MAAM,OAAO,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,CAAC,CAAC;QACxG,MAAM,OAAO,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,CAAC,CAAC;QACxG,MAAM,OAAO,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,CAAC,CAAC;QAExG,IAAA,aAAM,EAAC,OAAO,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QACjC,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACtD,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpE,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACpE,IAAA,aAAM,EAAC,OAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC5D,IAAA,aAAM,EAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAClH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QAC3C,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,MAAM,EAAE,OAAO,CAAC,CAAC;QAE/G,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,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,CAAC,CAAC;QAErH,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,IAAA,aAAM,EAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAClI,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,CAAC,CAAC;QAEpH,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,KAAK,IAAI,EAAE;QAC5E,IAAA,aAAM,EAAC,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;IAClI,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;QAChG,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACnH,IAAA,aAAM,EAAC,MAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,IAAI,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;QAE1H,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACzD,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;QAE5H,IAAA,aAAM,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC;QAC9B,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACzD,IAAA,aAAM,EAAC,IAAK,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAClE,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,IAAA,aAAM,EAAC,GAAG,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACpF,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,SAAS,GAAG,mEAAmE,CAAC;QACtF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,aAAa,EAAE,mDAAmD,CAAC,CAAC;IAChI,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,SAAS,GAAG,gEAAgE,CAAC;QACnF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,aAAa,EAAE,6EAA6E,CAAC,CAAC;IAC1J,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,SAAS,GAAG,sDAAsD,CAAC;QACzE,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,aAAa,EAAE,6EAA6E,CAAC,CAAC;IAC1J,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,SAAS,GAAG,gEAAgE,CAAC;QACnF,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,aAAa,EAAE,6EAA6E,CAAC,CAAC;IAC1J,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,SAAS,GAAG,wDAAwD,CAAC;QAC3E,IAAA,aAAM,EAAC,GAAG,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,aAAa,EAAE,6EAA6E,CAAC,CAAC;IAC1J,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,SAAS,GAAG,4IAA4I,CAAC;QAC/J,MAAM,GAAG,GAAG,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC5C,IAAA,aAAM,EAAC,GAAG,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport { expect, use } from \"chai\";\nimport * as chaiAsPromised from \"chai-as-promised\";\nimport * as path from \"path\";\nimport * as EC from \"@itwin/ecschema-metadata\";\nimport { FileSchemaKey } from \"../SchemaFileLocater\";\nimport { StubSchemaXmlFileLocater } from \"../StubSchemaXmlFileLocater\";\nimport * as fs from \"fs\";\n\nuse(chaiAsPromised);\n\ndescribe(\"StubSchemaXmlFileLocater tests:\", () => {\n let locater: StubSchemaXmlFileLocater;\n let context: EC.SchemaContext;\n\n beforeEach(() => {\n locater = new StubSchemaXmlFileLocater();\n locater.addSchemaSearchPath(path.join(__dirname, \"assets\"));\n context = new EC.SchemaContext();\n context.addLocater(locater);\n });\n\n it(\"loadSchema, schema text not provided, schema loaded successfully\", async () => {\n const schemaPath = path.join(__dirname, \"assets\", \"SchemaA.02.00.02.ecschema.xml\");\n const schemaKey = new FileSchemaKey(new EC.SchemaKey(\"SchemaA\", 2, 0, 2), schemaPath);\n schemaKey.schemaText = fs.readFileSync(schemaPath, \"utf-8\");\n const schema = locater.loadSchema(schemaPath);\n expect(schema).is.not.undefined;\n expect(schema.schemaKey).to.deep.equal(schemaKey);\n });\n\n it(\"loadSchema, schema text provided, schema loaded successfully\", async () => {\n const schemaPath = path.join(__dirname, \"assets\", \"SchemaA.02.00.02.ecschema.xml\");\n const schemaText = fs.readFileSync(schemaPath, \"utf-8\");\n const schemaKey = new FileSchemaKey(new EC.SchemaKey(\"SchemaA\", 2, 0, 2), schemaPath);\n schemaKey.schemaText = schemaText;\n\n const schema = locater.loadSchema(schemaPath, schemaText);\n expect(schema).is.not.undefined;\n expect(schema.schemaKey).to.deep.equal(schemaKey);\n });\n\n it(\"loadSchema, schema can't be found, throws\", async () => {\n const schemaPath = path.join(__dirname, \"assets\", \"DoesNotExist.01.00.00.ecschema.xml\");\n expect(() => locater.loadSchema(schemaPath)).to.throw(Error, `ENOENT: no such file or directory, open '${schemaPath}'`);\n });\n\n it(\"locate valid schema with multiple references\", async () => {\n const schemaKey = new EC.SchemaKey(\"SchemaA\", 1, 1, 1);\n const schema = await context.getSchema(schemaKey, EC.SchemaMatchType.Exact);\n\n expect(schema).is.not.undefined;\n expect(schema!.name).to.equal(\"SchemaA\");\n expect(schema!.schemaKey.version.toString()).to.equal(\"01.01.01\");\n });\n\n it(\"locate valid schema with multiple references synchronously\", () => {\n const schemaKey = new EC.SchemaKey(\"SchemaA\", 1, 1, 1);\n const schema = context.getSchemaSync(schemaKey, EC.SchemaMatchType.Exact);\n\n expect(schema).is.not.undefined;\n expect(schema!.name).to.equal(\"SchemaA\");\n expect(schema!.schemaKey.version.toString()).to.equal(\"01.01.01\");\n });\n\n it(\"getSchema called multiple times for same schema\", async () => {\n const schemaKey = new EC.SchemaKey(\"SchemaD\", 4, 4, 4);\n\n const locater1 = await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, new EC.SchemaContext());\n const locater2 = await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, new EC.SchemaContext());\n const context1 = await context.getSchema(schemaKey, EC.SchemaMatchType.Exact);\n const context2 = await context.getSchema(schemaKey, EC.SchemaMatchType.Exact);\n\n // locater should not cache, but context should cache\n expect(locater1).not.equal(locater2);\n expect(locater1).not.equal(context1);\n expect(context1).to.equal(context2);\n });\n\n it(\"getSchema which does not exist, returns undefined\", async () => {\n const schemaKey = new EC.SchemaKey(\"DoesNotExist\");\n expect(await locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context)).to.be.undefined;\n });\n\n it(\"getSchema, full version, succeeds\", async () => {\n const stub = await locater.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 1), EC.SchemaMatchType.Exact, context);\n expect(stub).is.not.undefined;\n const key = stub!.schemaKey as FileSchemaKey;\n expect(key.name).to.equal(\"SchemaA\");\n expect(key.version.toString()).to.equal(\"01.01.01\");\n });\n\n it(\"getSchema, reference does not exist, throws.\", async () => {\n const schemaKey = new EC.SchemaKey(\"RefDoesNotExist\", 1, 1, 1);\n await expect(locater.getSchema(schemaKey, EC.SchemaMatchType.Exact, context)).to.be.rejectedWith(EC.ECSchemaError, \"Unable to locate referenced schema: DoesNotExist.3.3.3\");\n });\n\n it(\"getSchema, references set\", async () => {\n const schemaA = await context.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 1), EC.SchemaMatchType.Exact);\n const schemaB = await context.getSchema(new EC.SchemaKey(\"SchemaB\", 2, 2, 2), EC.SchemaMatchType.Exact);\n const schemaC = await context.getSchema(new EC.SchemaKey(\"SchemaC\", 3, 3, 3), EC.SchemaMatchType.Exact);\n const schemaD = await context.getSchema(new EC.SchemaKey(\"SchemaD\", 4, 4, 4), EC.SchemaMatchType.Exact);\n\n expect(schemaA).is.not.undefined;\n expect(schemaA!.references.length).to.equal(2);\n expect(schemaA!.references[0]).to.deep.equal(schemaC);\n expect(schemaA!.references[1]).to.deep.equal(schemaB);\n expect(schemaA!.references[0].references[0]).to.deep.equal(schemaD);\n expect(schemaA!.references[1].references[0]).to.deep.equal(schemaC);\n expect(schemaA!.references[1].references[1]).to.deep.equal(schemaD);\n });\n\n it(\"getSchema, exact version, wrong minor, fails\", async () => {\n expect(await context.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 2), EC.SchemaMatchType.Exact)).to.be.undefined;\n });\n\n it(\"getSchema, latest, succeeds\", async () => {\n const stub = await locater.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 0), EC.SchemaMatchType.Latest, context);\n\n expect(stub).is.not.undefined;\n expect(stub!.schemaKey.name).to.equal(\"SchemaA\");\n expect(stub!.schemaKey.version.toString()).to.equal(\"02.00.02\");\n });\n\n it(\"getSchema, latest write compatible, succeeds\", async () => {\n const stub = await context.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 1, 0), EC.SchemaMatchType.LatestWriteCompatible);\n\n expect(stub).is.not.undefined;\n expect(stub!.schemaKey.name).to.equal(\"SchemaA\");\n expect(stub!.schemaKey.version.toString()).to.equal(\"01.01.01\");\n });\n\n it(\"getSchema, latest write compatible, write version wrong, fails\", async () => {\n expect(await context.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 2, 0), EC.SchemaMatchType.LatestWriteCompatible)).to.be.undefined;\n });\n\n it(\"getSchema, latest read compatible, succeeds\", async () => {\n const stub = await context.getSchema(new EC.SchemaKey(\"SchemaA\", 1, 0, 0), EC.SchemaMatchType.LatestReadCompatible);\n\n expect(stub).is.not.undefined;\n expect(stub!.schemaKey.name).to.equal(\"SchemaA\");\n expect(stub!.schemaKey.version.toString()).to.equal(\"01.01.01\");\n });\n\n it(\"getSchema, latest read compatible, read version wrong, fails\", async () => {\n expect(await context.getSchema(new EC.SchemaKey(\"SchemaA\", 2, 1, 1), EC.SchemaMatchType.LatestWriteCompatible)).to.be.undefined;\n });\n\n it(\"Schema XML has EC v2 nameSpacePrefix, alias set properly on deserialized schema.\", async () => {\n const schema = await locater.getSchema(new EC.SchemaKey(\"ECv2Schema\", 1, 0, 1), EC.SchemaMatchType.Exact, context);\n expect(schema!.alias).to.equal(\"v2\");\n });\n\n it(\"sync - should ignore commented out schema references\", () => {\n const stub = context.getSchemaSync(new EC.SchemaKey(\"RefCommentedOut\", 1, 1, 1), EC.SchemaMatchType.LatestReadCompatible);\n\n expect(stub).is.not.undefined;\n expect(stub!.schemaKey.name).to.equal(\"RefCommentedOut\");\n expect(stub!.schemaKey.version.toString()).to.equal(\"01.01.01\");\n });\n\n it(\"async - should ignore commented out schema references\", async () => {\n const stub = await context.getSchema(new EC.SchemaKey(\"RefCommentedOut\", 1, 1, 1), EC.SchemaMatchType.LatestReadCompatible);\n\n expect(stub).is.not.undefined;\n expect(stub!.schemaKey.name).to.equal(\"RefCommentedOut\");\n expect(stub!.schemaKey.version.toString()).to.equal(\"01.01.01\");\n });\n\n it(\"getSchemaKey, valid version and name, succeeds\", () => {\n const schemaXml = `<ECSchema schemaName=\"SchemaA\" version=\"1.1.1\"> </ECSchema>`;\n const key = locater.getSchemaKey(schemaXml);\n expect(key).to.deep.equal(new EC.SchemaKey(\"SchemaA\", new EC.ECVersion(1, 1, 1)));\n });\n it(\"getSchemaKey, invalid xml, throws\", () => {\n const schemaXml = `<ECSchemaBad schemaName=\"SchemaA\" version=\"1.1.1\"> </ECSchemaBad>`;\n expect(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECSchemaError, `Could not find '<ECSchema>' tag in the given file`);\n });\n it(\"getSchemaKey, invalid schemaName attribute, throws\", () => {\n const schemaXml = `<ECSchema schemaNameBad=\"SchemaA\" version=\"1.1.1\"> </ECSchema>`;\n expect(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECSchemaError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\n });\n it(\"getSchemaKey, invalid schemaName, throws\", () => {\n const schemaXml = `<ECSchema version=\"1.1.1\" schemaName=\"\"> </ECSchema>`;\n expect(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECSchemaError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\n });\n it(\"getSchemaKey, invalid version attribute, throws\", () => {\n const schemaXml = `<ECSchema schemaName=\"SchemaA\" versionBad=\"1.1.1\"> </ECSchema>`;\n expect(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECSchemaError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\n });\n it(\"getSchemaKey, invalid version, throws\", () => {\n const schemaXml = `<ECSchema schemaName=\"SchemaA\" version=\"\"> </ECSchema>`;\n expect(() => locater.getSchemaKey(schemaXml)).to.throw(EC.ECSchemaError, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\n });\n it(\"getSchemaKey, ECv2 schema, valid version set\", () => {\n const schemaXml = `<ECSchema schemaName=\"ECv2Schema\" version=\"1.1\" nameSpacePrefix=\"v2\" xmlns=\"http://www.bentley.com/schemas/Bentley.ECXML.2.0\"> </ECSchema>`;\n const key = locater.getSchemaKey(schemaXml);\n expect(key).to.deep.equal(new EC.SchemaKey(\"ECv2Schema\", new EC.ECVersion(1, 0, 1)));\n });\n});\n"]}
@@ -0,0 +1,101 @@
1
+ /** @packageDocumentation
2
+ * @module Locaters
3
+ */
4
+ import { Schema, SchemaContext, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
5
+ /**
6
+ * A SchemaKey implementation that aids in identifying Schema files via the
7
+ * addition of two properties: fileName and schemaText. The fileName contains the
8
+ * full path to the file on disk and schemaText is the full string representation
9
+ * of the Schema.
10
+ * @internal
11
+ */
12
+ export declare class FileSchemaKey extends SchemaKey {
13
+ fileName: string;
14
+ schemaText?: string;
15
+ /**
16
+ * Initializes a new FileSchemaKey object.
17
+ * @param key The EC SchemaKey identifying the Schema.
18
+ * @param fileName The full path to the Schema file.
19
+ * @param schemaText The string representation of the Schema
20
+ * loaded from disk. Optional.
21
+ */
22
+ constructor(key: SchemaKey, fileName: string, schemaJson?: string);
23
+ }
24
+ /**
25
+ * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater
26
+ * @public @preview
27
+ */
28
+ export declare abstract class SchemaFileLocater {
29
+ /** @internal */
30
+ searchPaths: string[];
31
+ constructor();
32
+ /** @internal */
33
+ protected readUtf8FileToString(filePath: string): Promise<string | undefined>;
34
+ /** @internal */
35
+ protected readUtf8FileToStringSync(filePath: string): string | undefined;
36
+ /** @internal */
37
+ protected fileExists(filePath: string): Promise<boolean | undefined>;
38
+ /** @internal */
39
+ protected fileExistsSync(filePath: string): boolean | undefined;
40
+ /**
41
+ * Adds more search paths used by this locator to find the
42
+ * Schema files.
43
+ * @param schemaPaths An array of search paths to add
44
+ */
45
+ addSchemaSearchPaths(schemaPaths: string[]): void;
46
+ /**
47
+ * Add one search path used by this locator to find the
48
+ * Schema files.
49
+ * @param schemaPath A search path to add
50
+ */
51
+ addSchemaSearchPath(schemaPath: string): void;
52
+ protected abstract getSchemaKey(data: string): SchemaKey;
53
+ /**
54
+ * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method
55
+ * only attempts to find schema files that have no version in the file name.
56
+ * @param foundFiles The collection of SchemaKeys found in the given directory.
57
+ * @param schemaPath The directory in which to search for the Schemas.
58
+ * @param schemaName The short name of the Schema (without version).
59
+ * @param desiredKey The SchemaKey used to find matching Schema files.
60
+ * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.
61
+ * @param format The type of file that the schema key refers to. json or xml
62
+ */
63
+ private addCandidateNoExtSchemaKey;
64
+ /**
65
+ * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey
66
+ * @param foundFiles The collection of SchemaKeys found in the given directory
67
+ * @param schemaPath The directory in which to search for the Schemas
68
+ * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.
69
+ * @param desiredKey The schemaKey used to find matching Schema files
70
+ * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.
71
+ * @param format The type of file that the schema key refers to. json or xml
72
+ */
73
+ private addCandidateSchemaKeys;
74
+ /**
75
+ * Attempts to find all Schema files in the configurable search paths that match
76
+ * the desired SchemaKey.
77
+ * @param desiredKey The SchemaKey to match.
78
+ * @param matchType The SchemaMatchType.
79
+ * @param format The type of file that the schema key refers to. json or xml
80
+ * @internal
81
+ */
82
+ protected findEligibleSchemaKeys(desiredKey: SchemaKey, matchType: SchemaMatchType, format: string): FileSchemaKey[];
83
+ /**
84
+ * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
85
+ * to locate the XML Schema file from the file system. Returns only Schemas from XML files with
86
+ * their keys populated.
87
+ * @param key The SchemaKey of the Schema to retrieve.
88
+ * @param matchType The SchemaMatchType.
89
+ * @param context The SchemaContext that will control the lifetime of the schema.
90
+ */
91
+ abstract getSchema(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
92
+ /**
93
+ * Compares two Schema versions. If the left-hand version is greater, 1 is returned. If the
94
+ * left-hand version is less, -1 us returned. If the versions are an exact match, 0 is returned.
95
+ * @param lhs The 'left-hand' FileSchemaKey.
96
+ * @param rhs The 'right-hand' FileSchemaKey.
97
+ * @internal
98
+ */
99
+ compareSchemaKeyByVersion: (lhs: FileSchemaKey, rhs: FileSchemaKey) => number;
100
+ }
101
+ //# sourceMappingURL=SchemaFileLocater.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SchemaFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaFileLocater.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAwB7F;;;;;;GAMG;AACH,qBAAa,aAAc,SAAQ,SAAS;IAEnC,QAAQ,EAAE,MAAM,CAAC;IAEjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;;;OAMG;gBACS,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM;CAKlE;AAED;;;GAGG;AACH,8BAAsB,iBAAiB;IACrC,gBAAgB;IACT,WAAW,EAAE,MAAM,EAAE,CAAC;;IAM7B,gBAAgB;cACA,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAWnF,gBAAgB;IAChB,SAAS,CAAC,wBAAwB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAIxE,gBAAgB;cACA,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC;IAQ1E,gBAAgB;IAChB,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAI/D;;;;OAIG;IACI,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE;IAMjD;;;;OAIG;IACI,mBAAmB,CAAC,UAAU,EAAE,MAAM;IAM7C,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAExD;;;;;;;;;OASG;IACH,OAAO,CAAC,0BAA0B;IAoBlC;;;;;;;;OAQG;IACH,OAAO,CAAC,sBAAsB;IAwB9B;;;;;;;OAOG;IACH,SAAS,CAAC,sBAAsB,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,EAAE,MAAM,GAAG,aAAa,EAAE;IAmCpH;;;;;;;OAOG;aACa,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAE1H;;;;;;OAMG;IACI,yBAAyB,QAAS,aAAa,OAAO,aAAa,KAAG,MAAM,CAEjF;CACH"}
@@ -0,0 +1,220 @@
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module Locaters
7
+ */
8
+ import * as fs from "fs";
9
+ import { globSync } from "glob";
10
+ import * as path from "path";
11
+ import { SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
12
+ const formatString = (format, ...args) => {
13
+ return format.replace(/{(\d+)}/g, (match, theNumber) => {
14
+ return typeof args[theNumber] !== "undefined"
15
+ ? args[theNumber]
16
+ : match;
17
+ });
18
+ };
19
+ const padStartEx = (str, targetLength, padString) => {
20
+ targetLength = targetLength >> 0; // truncate if number or convert non-number to 0;
21
+ padString = String((typeof padString !== "undefined" ? padString : " "));
22
+ if (str.length > targetLength) {
23
+ return String(str);
24
+ }
25
+ else {
26
+ targetLength = targetLength - str.length;
27
+ if (targetLength > padString.length) {
28
+ padString += padString.repeat(targetLength / padString.length); // append to original to ensure we are longer than needed
29
+ }
30
+ return padString.slice(0, targetLength) + str;
31
+ }
32
+ };
33
+ /**
34
+ * A SchemaKey implementation that aids in identifying Schema files via the
35
+ * addition of two properties: fileName and schemaText. The fileName contains the
36
+ * full path to the file on disk and schemaText is the full string representation
37
+ * of the Schema.
38
+ * @internal
39
+ */
40
+ export class FileSchemaKey extends SchemaKey {
41
+ // The schema file associated with the SchemaKey
42
+ fileName;
43
+ // The JSON text for the schema loaded
44
+ schemaText;
45
+ /**
46
+ * Initializes a new FileSchemaKey object.
47
+ * @param key The EC SchemaKey identifying the Schema.
48
+ * @param fileName The full path to the Schema file.
49
+ * @param schemaText The string representation of the Schema
50
+ * loaded from disk. Optional.
51
+ */
52
+ constructor(key, fileName, schemaJson) {
53
+ super(key.name, key.version);
54
+ this.fileName = fileName;
55
+ this.schemaText = schemaJson;
56
+ }
57
+ }
58
+ /**
59
+ * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater
60
+ * @public @preview
61
+ */
62
+ export class SchemaFileLocater {
63
+ /** @internal */
64
+ searchPaths;
65
+ constructor() {
66
+ this.searchPaths = [];
67
+ }
68
+ /** @internal */
69
+ async readUtf8FileToString(filePath) {
70
+ return new Promise((resolve, reject) => {
71
+ fs.readFile(filePath, "utf-8", (err, data) => {
72
+ if (err)
73
+ reject(err);
74
+ else
75
+ resolve(data);
76
+ });
77
+ });
78
+ }
79
+ /** @internal */
80
+ readUtf8FileToStringSync(filePath) {
81
+ return fs.readFileSync(filePath, "utf-8");
82
+ }
83
+ /** @internal */
84
+ async fileExists(filePath) {
85
+ return new Promise((resolve) => {
86
+ fs.access(filePath, fs.constants.F_OK, (err) => {
87
+ resolve(err ? false : true);
88
+ });
89
+ });
90
+ }
91
+ /** @internal */
92
+ fileExistsSync(filePath) {
93
+ return fs.existsSync(filePath);
94
+ }
95
+ /**
96
+ * Adds more search paths used by this locator to find the
97
+ * Schema files.
98
+ * @param schemaPaths An array of search paths to add
99
+ */
100
+ addSchemaSearchPaths(schemaPaths) {
101
+ // If the path is not in the schemaPaths array, add it
102
+ for (const schemaPath of schemaPaths)
103
+ this.addSchemaSearchPath(schemaPath);
104
+ }
105
+ /**
106
+ * Add one search path used by this locator to find the
107
+ * Schema files.
108
+ * @param schemaPath A search path to add
109
+ */
110
+ addSchemaSearchPath(schemaPath) {
111
+ // If the path is not in the schemaPaths array, add it
112
+ if (!this.searchPaths.find((entry) => entry === schemaPath))
113
+ this.searchPaths.push(schemaPath);
114
+ }
115
+ /**
116
+ * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method
117
+ * only attempts to find schema files that have no version in the file name.
118
+ * @param foundFiles The collection of SchemaKeys found in the given directory.
119
+ * @param schemaPath The directory in which to search for the Schemas.
120
+ * @param schemaName The short name of the Schema (without version).
121
+ * @param desiredKey The SchemaKey used to find matching Schema files.
122
+ * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.
123
+ * @param format The type of file that the schema key refers to. json or xml
124
+ */
125
+ addCandidateNoExtSchemaKey(foundFiles, schemaPath, schemaName, desiredKey, matchType, format) {
126
+ const fullPath = path.join(schemaPath, `${schemaName}.ecschema.${format}`);
127
+ // If the file does not exist, end
128
+ if (!fs.existsSync(fullPath))
129
+ return;
130
+ // Read the file
131
+ const file = fs.readFileSync(fullPath);
132
+ if (!file)
133
+ return;
134
+ // Get the schema key
135
+ const key = this.getSchemaKey(file.toString());
136
+ // If the key matches, put it in foundFiles
137
+ if (key.matches(desiredKey, matchType))
138
+ foundFiles.push(new FileSchemaKey(key, fullPath, file.toString()));
139
+ }
140
+ /**
141
+ * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey
142
+ * @param foundFiles The collection of SchemaKeys found in the given directory
143
+ * @param schemaPath The directory in which to search for the Schemas
144
+ * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.
145
+ * @param desiredKey The schemaKey used to find matching Schema files
146
+ * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.
147
+ * @param format The type of file that the schema key refers to. json or xml
148
+ */
149
+ addCandidateSchemaKeys(foundFiles, schemaPath, fileFilter, desiredKey, matchType, format) {
150
+ const fullPath = path.join(schemaPath, fileFilter);
151
+ const result = globSync(fullPath, { windowsPathsNoEscape: true });
152
+ for (const match of result) {
153
+ let fileName = path.basename(match, (`.ecschema.${format}`));
154
+ // TODO: should this be moved or handled elsewhere?
155
+ // Handles two version file names - SchemaKey.parseString supports only 3 version names.
156
+ if (/[^\d]\.\d?\d\.\d?\d$/.test(fileName)) {
157
+ const parts = fileName.split(".");
158
+ parts.splice(2, 0, "00");
159
+ fileName = parts.join(".");
160
+ }
161
+ const file = fs.readFileSync(match);
162
+ if (!file)
163
+ continue;
164
+ const schemaKey = SchemaKey.parseString(fileName);
165
+ if (schemaKey.matches(desiredKey, matchType))
166
+ foundFiles.push(new FileSchemaKey(schemaKey, match, file.toString()));
167
+ }
168
+ }
169
+ /**
170
+ * Attempts to find all Schema files in the configurable search paths that match
171
+ * the desired SchemaKey.
172
+ * @param desiredKey The SchemaKey to match.
173
+ * @param matchType The SchemaMatchType.
174
+ * @param format The type of file that the schema key refers to. json or xml
175
+ * @internal
176
+ */
177
+ findEligibleSchemaKeys(desiredKey, matchType, format) {
178
+ const foundFiles = new Array();
179
+ let twoVersionSuffix;
180
+ let threeVersionSuffix;
181
+ const readVersion = desiredKey.readVersion.toString();
182
+ const writeVersion = desiredKey.writeVersion.toString();
183
+ const minorVersion = desiredKey.minorVersion.toString();
184
+ if (matchType === SchemaMatchType.Latest) {
185
+ twoVersionSuffix = (`.*.*.ecschema.${format}`);
186
+ threeVersionSuffix = (`.*.*.*.ecschema.${format}`);
187
+ }
188
+ else if (matchType === SchemaMatchType.LatestWriteCompatible) {
189
+ twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"));
190
+ threeVersionSuffix = formatString(`.{0}.{1}.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"), padStartEx(writeVersion, 2, "0"));
191
+ }
192
+ else if (matchType === SchemaMatchType.LatestReadCompatible) {
193
+ twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"));
194
+ threeVersionSuffix = formatString(`.{0}.*.*.ecschema.${format}`, padStartEx(readVersion, 2, "0"));
195
+ }
196
+ else {
197
+ twoVersionSuffix = formatString(`.{0}.{1}.ecschema.${format}`, padStartEx(readVersion, 2, "0"), padStartEx(writeVersion, 2, "0"));
198
+ threeVersionSuffix = formatString(`.{0}.{1}.{2}.ecschema.${format}`, padStartEx(readVersion, 2, "0"), padStartEx(writeVersion, 2, "0"), padStartEx(minorVersion, 2, "0"));
199
+ }
200
+ const twoVersionExpression = desiredKey.name + twoVersionSuffix;
201
+ const threeVersionExpression = desiredKey.name + threeVersionSuffix;
202
+ for (const searchPath of this.searchPaths) {
203
+ this.addCandidateNoExtSchemaKey(foundFiles, searchPath, desiredKey.name, desiredKey, matchType, format);
204
+ this.addCandidateSchemaKeys(foundFiles, searchPath, twoVersionExpression, desiredKey, matchType, format);
205
+ this.addCandidateSchemaKeys(foundFiles, searchPath, threeVersionExpression, desiredKey, matchType, format);
206
+ }
207
+ return foundFiles;
208
+ }
209
+ /**
210
+ * Compares two Schema versions. If the left-hand version is greater, 1 is returned. If the
211
+ * left-hand version is less, -1 us returned. If the versions are an exact match, 0 is returned.
212
+ * @param lhs The 'left-hand' FileSchemaKey.
213
+ * @param rhs The 'right-hand' FileSchemaKey.
214
+ * @internal
215
+ */
216
+ compareSchemaKeyByVersion = (lhs, rhs) => {
217
+ return lhs.compareByVersion(rhs);
218
+ };
219
+ }
220
+ //# sourceMappingURL=SchemaFileLocater.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SchemaFileLocater.js","sourceRoot":"","sources":["../../src/SchemaFileLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAyB,SAAS,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE7F,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,GAAG,IAAc,EAAE,EAAE;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACrD,OAAO,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,WAAW;YAC3C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACjB,CAAC,CAAC,KAAK,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,YAAoB,EAAE,SAAiB,EAAE,EAAE;IAC1E,YAAY,GAAG,YAAY,IAAI,CAAC,CAAC,CAAC,iDAAiD;IACnF,SAAS,GAAG,MAAM,CAAC,CAAC,OAAO,SAAS,KAAK,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACzE,IAAI,GAAG,CAAC,MAAM,GAAG,YAAY,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;IACrB,CAAC;SAAM,CAAC;QACN,YAAY,GAAG,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC;QACzC,IAAI,YAAY,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;YACpC,SAAS,IAAI,SAAS,CAAC,MAAM,CAAC,YAAY,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,yDAAyD;QAC3H,CAAC;QACD,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,GAAG,GAAG,CAAC;IAChD,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;IAC1C,gDAAgD;IACzC,QAAQ,CAAS;IACxB,sCAAsC;IAC/B,UAAU,CAAU;IAE3B;;;;;;OAMG;IACH,YAAY,GAAc,EAAE,QAAgB,EAAE,UAAmB;QAC/D,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,OAAgB,iBAAiB;IACrC,gBAAgB;IACT,WAAW,CAAW;IAE7B;QACE,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,gBAAgB;IACN,KAAK,CAAC,oBAAoB,CAAC,QAAgB;QACnD,OAAO,IAAI,OAAO,CAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACzD,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;gBAC3C,IAAI,GAAG;oBACL,MAAM,CAAC,GAAG,CAAC,CAAC;;oBAEZ,OAAO,CAAC,IAAI,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB;IACN,wBAAwB,CAAC,QAAgB;QACjD,OAAO,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACN,KAAK,CAAC,UAAU,CAAC,QAAgB;QACzC,OAAO,IAAI,OAAO,CAAsB,CAAC,OAAO,EAAE,EAAE;YAClD,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC7C,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB;IACN,cAAc,CAAC,QAAgB;QACvC,OAAO,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACI,oBAAoB,CAAC,WAAqB;QAC/C,sDAAsD;QACtD,KAAK,MAAM,UAAU,IAAI,WAAW;YAClC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;IACzC,CAAC;IAED;;;;OAIG;IACI,mBAAmB,CAAC,UAAkB;QAC3C,sDAAsD;QACtD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC;YACzD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;;;OASG;IACK,0BAA0B,CAAC,UAA2B,EAAE,UAAkB,EAAE,UAAkB,EAAE,UAAqB,EAAE,SAA0B,EAAE,MAAc;QACvK,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,UAAU,aAAa,MAAM,EAAE,CAAC,CAAC;QAE3E,kCAAkC;QAClC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC1B,OAAO;QAET,gBAAgB;QAChB,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI;YACP,OAAO;QAET,qBAAqB;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE/C,2CAA2C;QAC3C,IAAI,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;YACpC,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACK,sBAAsB,CAAC,UAA2B,EAAE,UAAkB,EAAE,UAAkB,EAAE,UAAqB,EAAE,SAA0B,EAAE,MAAc;QACnK,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,EAAE,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC;QAClE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,IAAI,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,aAAa,MAAM,EAAE,CAAC,CAAC,CAAC;YAC7D,mDAAmD;YACnD,wFAAwF;YACxF,IAAI,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC1C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;gBACzB,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC;YAED,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI;gBACP,SAAS;YAEX,MAAM,SAAS,GAAG,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAClD,IAAI,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC;gBAC1C,UAAU,CAAC,IAAI,CAAC,IAAI,aAAa,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QAC1E,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACO,sBAAsB,CAAC,UAAqB,EAAE,SAA0B,EAAE,MAAc;QAChG,MAAM,UAAU,GAAG,IAAI,KAAK,EAAiB,CAAC;QAE9C,IAAI,gBAAwB,CAAC;QAC7B,IAAI,kBAA0B,CAAC;QAC/B,MAAM,WAAW,GAAG,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;QACtD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QACxD,MAAM,YAAY,GAAG,UAAU,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC;QAExD,IAAI,SAAS,KAAK,eAAe,CAAC,MAAM,EAAE,CAAC;YACzC,gBAAgB,GAAG,CAAC,iBAAiB,MAAM,EAAE,CAAC,CAAC;YAC/C,kBAAkB,GAAG,CAAC,mBAAmB,MAAM,EAAE,CAAC,CAAC;QACrD,CAAC;aAAM,IAAI,SAAS,KAAK,eAAe,CAAC,qBAAqB,EAAE,CAAC;YAC/D,gBAAgB,GAAG,YAAY,CAAC,mBAAmB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,CAAC,uBAAuB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QACxI,CAAC;aAAM,IAAI,SAAS,KAAK,eAAe,CAAC,oBAAoB,EAAE,CAAC;YAC9D,gBAAgB,GAAG,YAAY,CAAC,mBAAmB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,CAAC,qBAAqB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QACpG,CAAC;aAAM,CAAC;YACN,gBAAgB,GAAG,YAAY,CAAC,qBAAqB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAClI,kBAAkB,GAAG,YAAY,CAAC,yBAAyB,MAAM,EAAE,EAAE,UAAU,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QAC5K,CAAC;QAED,MAAM,oBAAoB,GAAG,UAAU,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAChE,MAAM,sBAAsB,GAAG,UAAU,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAEpE,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YAC1C,IAAI,CAAC,0BAA0B,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACxG,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,oBAAoB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;YACzG,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE,UAAU,EAAE,sBAAsB,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7G,CAAC;QAED,OAAO,UAAU,CAAC;IACpB,CAAC;IAYD;;;;;;OAMG;IACI,yBAAyB,GAAG,CAAC,GAAkB,EAAE,GAAkB,EAAU,EAAE;QACpF,OAAO,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC,CAAC;CACH","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Locaters\n */\n\nimport * as fs from \"fs\";\nimport { globSync } from \"glob\";\nimport * as path from \"path\";\nimport { Schema, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\n\nconst formatString = (format: string, ...args: string[]) => {\n return format.replace(/{(\\d+)}/g, (match, theNumber) => {\n return typeof args[theNumber] !== \"undefined\"\n ? args[theNumber]\n : match;\n });\n};\n\nconst padStartEx = (str: string, targetLength: number, padString: string) => {\n targetLength = targetLength >> 0; // truncate if number or convert non-number to 0;\n padString = String((typeof padString !== \"undefined\" ? padString : \" \"));\n if (str.length > targetLength) {\n return String(str);\n } else {\n targetLength = targetLength - str.length;\n if (targetLength > padString.length) {\n padString += padString.repeat(targetLength / padString.length); // append to original to ensure we are longer than needed\n }\n return padString.slice(0, targetLength) + str;\n }\n};\n\n/**\n * A SchemaKey implementation that aids in identifying Schema files via the\n * addition of two properties: fileName and schemaText. The fileName contains the\n * full path to the file on disk and schemaText is the full string representation\n * of the Schema.\n * @internal\n */\nexport class FileSchemaKey extends SchemaKey {\n // The schema file associated with the SchemaKey\n public fileName: string;\n // The JSON text for the schema loaded\n public schemaText?: string;\n\n /**\n * Initializes a new FileSchemaKey object.\n * @param key The EC SchemaKey identifying the Schema.\n * @param fileName The full path to the Schema file.\n * @param schemaText The string representation of the Schema\n * loaded from disk. Optional.\n */\n constructor(key: SchemaKey, fileName: string, schemaJson?: string) {\n super(key.name, key.version);\n this.fileName = fileName;\n this.schemaText = schemaJson;\n }\n}\n\n/**\n * Abstract class to hold common/overlapping functionality between SchemaJsonFileLocater and SchemaXmlFileLocater\n * @public @preview\n */\nexport abstract class SchemaFileLocater {\n /** @internal */\n public searchPaths: string[];\n\n constructor() {\n this.searchPaths = [];\n }\n\n /** @internal */\n protected async readUtf8FileToString(filePath: string): Promise<string | undefined> {\n return new Promise<string | undefined>((resolve, reject) => {\n fs.readFile(filePath, \"utf-8\", (err, data) => {\n if (err)\n reject(err);\n else\n resolve(data);\n });\n });\n }\n\n /** @internal */\n protected readUtf8FileToStringSync(filePath: string): string | undefined {\n return fs.readFileSync(filePath, \"utf-8\");\n }\n\n /** @internal */\n protected async fileExists(filePath: string): Promise<boolean | undefined> {\n return new Promise<boolean | undefined>((resolve) => {\n fs.access(filePath, fs.constants.F_OK, (err) => {\n resolve(err ? false : true);\n });\n });\n }\n\n /** @internal */\n protected fileExistsSync(filePath: string): boolean | undefined {\n return fs.existsSync(filePath);\n }\n\n /**\n * Adds more search paths used by this locator to find the\n * Schema files.\n * @param schemaPaths An array of search paths to add\n */\n public addSchemaSearchPaths(schemaPaths: string[]) {\n // If the path is not in the schemaPaths array, add it\n for (const schemaPath of schemaPaths)\n this.addSchemaSearchPath(schemaPath);\n }\n\n /**\n * Add one search path used by this locator to find the\n * Schema files.\n * @param schemaPath A search path to add\n */\n public addSchemaSearchPath(schemaPath: string) {\n // If the path is not in the schemaPaths array, add it\n if (!this.searchPaths.find((entry) => entry === schemaPath))\n this.searchPaths.push(schemaPath);\n }\n\n protected abstract getSchemaKey(data: string): SchemaKey;\n\n /**\n * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey. This method\n * only attempts to find schema files that have no version in the file name.\n * @param foundFiles The collection of SchemaKeys found in the given directory.\n * @param schemaPath The directory in which to search for the Schemas.\n * @param schemaName The short name of the Schema (without version).\n * @param desiredKey The SchemaKey used to find matching Schema files.\n * @param matchType The SchemaMatchType to use when comparing the desiredKey and the keys found during the search.\n * @param format The type of file that the schema key refers to. json or xml\n */\n private addCandidateNoExtSchemaKey(foundFiles: FileSchemaKey[], schemaPath: string, schemaName: string, desiredKey: SchemaKey, matchType: SchemaMatchType, format: string) {\n const fullPath = path.join(schemaPath, `${schemaName}.ecschema.${format}`);\n\n // If the file does not exist, end\n if (!fs.existsSync(fullPath))\n return;\n\n // Read the file\n const file = fs.readFileSync(fullPath);\n if (!file)\n return;\n\n // Get the schema key\n const key = this.getSchemaKey(file.toString());\n\n // If the key matches, put it in foundFiles\n if (key.matches(desiredKey, matchType))\n foundFiles.push(new FileSchemaKey(key, fullPath, file.toString()));\n }\n\n /**\n * Adds SchemaKeys to the provided foundFiles collection that match the desired SchemaKey\n * @param foundFiles The collection of SchemaKeys found in the given directory\n * @param schemaPath The directory in which to search for the Schemas\n * @param fileFilter The file filter, potentially with wildcards, used to locate the Schema files.\n * @param desiredKey The schemaKey used to find matching Schema files\n * @param matchType The SchemaMatchType to use when comparing the desired Key and the keys found during the search.\n * @param format The type of file that the schema key refers to. json or xml\n */\n private addCandidateSchemaKeys(foundFiles: FileSchemaKey[], schemaPath: string, fileFilter: string, desiredKey: SchemaKey, matchType: SchemaMatchType, format: string) {\n const fullPath = path.join(schemaPath, fileFilter);\n\n const result = globSync(fullPath, { windowsPathsNoEscape: true });\n for (const match of result) {\n let fileName = path.basename(match, (`.ecschema.${format}`));\n // TODO: should this be moved or handled elsewhere?\n // Handles two version file names - SchemaKey.parseString supports only 3 version names.\n if (/[^\\d]\\.\\d?\\d\\.\\d?\\d$/.test(fileName)) {\n const parts = fileName.split(\".\");\n parts.splice(2, 0, \"00\");\n fileName = parts.join(\".\");\n }\n\n const file = fs.readFileSync(match);\n if (!file)\n continue;\n\n const schemaKey = SchemaKey.parseString(fileName);\n if (schemaKey.matches(desiredKey, matchType))\n foundFiles.push(new FileSchemaKey(schemaKey, match, file.toString()));\n }\n }\n\n /**\n * Attempts to find all Schema files in the configurable search paths that match\n * the desired SchemaKey.\n * @param desiredKey The SchemaKey to match.\n * @param matchType The SchemaMatchType.\n * @param format The type of file that the schema key refers to. json or xml\n * @internal\n */\n protected findEligibleSchemaKeys(desiredKey: SchemaKey, matchType: SchemaMatchType, format: string): FileSchemaKey[] {\n const foundFiles = new Array<FileSchemaKey>();\n\n let twoVersionSuffix: string;\n let threeVersionSuffix: string;\n const readVersion = desiredKey.readVersion.toString();\n const writeVersion = desiredKey.writeVersion.toString();\n const minorVersion = desiredKey.minorVersion.toString();\n\n if (matchType === SchemaMatchType.Latest) {\n twoVersionSuffix = (`.*.*.ecschema.${format}`);\n threeVersionSuffix = (`.*.*.*.ecschema.${format}`);\n } else if (matchType === SchemaMatchType.LatestWriteCompatible) {\n twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\n threeVersionSuffix = formatString(`.{0}.{1}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"));\n } else if (matchType === SchemaMatchType.LatestReadCompatible) {\n twoVersionSuffix = formatString(`.{0}.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\n threeVersionSuffix = formatString(`.{0}.*.*.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"));\n } else {\n twoVersionSuffix = formatString(`.{0}.{1}.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"));\n threeVersionSuffix = formatString(`.{0}.{1}.{2}.ecschema.${format}`, padStartEx(readVersion, 2, \"0\"), padStartEx(writeVersion, 2, \"0\"), padStartEx(minorVersion, 2, \"0\"));\n }\n\n const twoVersionExpression = desiredKey.name + twoVersionSuffix;\n const threeVersionExpression = desiredKey.name + threeVersionSuffix;\n\n for (const searchPath of this.searchPaths) {\n this.addCandidateNoExtSchemaKey(foundFiles, searchPath, desiredKey.name, desiredKey, matchType, format);\n this.addCandidateSchemaKeys(foundFiles, searchPath, twoVersionExpression, desiredKey, matchType, format);\n this.addCandidateSchemaKeys(foundFiles, searchPath, threeVersionExpression, desiredKey, matchType, format);\n }\n\n return foundFiles;\n }\n\n /**\n * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths\n * to locate the XML Schema file from the file system. Returns only Schemas from XML files with\n * their keys populated.\n * @param key The SchemaKey of the Schema to retrieve.\n * @param matchType The SchemaMatchType.\n * @param context The SchemaContext that will control the lifetime of the schema.\n */\n public abstract getSchema(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;\n\n /**\n * Compares two Schema versions. If the left-hand version is greater, 1 is returned. If the\n * left-hand version is less, -1 us returned. If the versions are an exact match, 0 is returned.\n * @param lhs The 'left-hand' FileSchemaKey.\n * @param rhs The 'right-hand' FileSchemaKey.\n * @internal\n */\n public compareSchemaKeyByVersion = (lhs: FileSchemaKey, rhs: FileSchemaKey): number => {\n return lhs.compareByVersion(rhs);\n };\n}\n"]}
@@ -0,0 +1,43 @@
1
+ /** @packageDocumentation
2
+ * @module Locaters
3
+ */
4
+ import { ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
5
+ import { SchemaFileLocater } from "./SchemaFileLocater";
6
+ /**
7
+ * A SchemaLocator implementation for locating JSON Schema files
8
+ * from the file system using configurable search paths.
9
+ * @public @preview
10
+ */
11
+ export declare class SchemaJsonFileLocater extends SchemaFileLocater implements ISchemaLocater {
12
+ /**
13
+ * Constructs a SchemaKey based on the information in the Schema JSON
14
+ * @param data The Schema JSON as a string
15
+ * @internal
16
+ */
17
+ protected getSchemaKey(data: string): SchemaKey;
18
+ /**
19
+ * Attempts to retrieve a Schema with the given SchemaKey by using the configured
20
+ * search paths to locate the JSON schema file from the file system.
21
+ * @param key The SchemaKey of the Schema to retrieve.
22
+ * @param matchType The SchemaMatchType.
23
+ * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
24
+ */
25
+ getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
26
+ /**
27
+ * Gets the schema info which matches the provided SchemaKey. The schema info may be returned before the schema is fully loaded.
28
+ * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
29
+ * @param schemaKey The SchemaKey describing the schema to get from the cache.
30
+ * @param matchType The match type to use when locating the schema
31
+ * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
32
+ */
33
+ getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
34
+ /**
35
+ * Attempts to retrieve a Schema with the given SchemaKey by using the configured
36
+ * search paths to locate the JSON schema file from the file system.
37
+ * @param key The SchemaKey of the Schema to retrieve.
38
+ * @param matchType The SchemaMatchType
39
+ * @param context The SchemaContext that will control the lifetime of the schema.
40
+ */
41
+ getSchemaSync(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined;
42
+ }
43
+ //# sourceMappingURL=SchemaJsonFileLocater.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SchemaJsonFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaJsonFileLocater.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EACqC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EACxH,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAEvE;;;;GAIG;AACH,qBAAa,qBAAsB,SAAQ,iBAAkB,YAAW,cAAc;IAEpF;;;;OAIG;IACH,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;IAmB/C;;;;;;OAMG;IACU,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO7H;;;;;;QAMI;IACS,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAsBrI;;;;;;OAMG;IACI,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;CAsBnH"}