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

package/lib/esm/SchemaJsonFileLocater.d.ts

@@ -0,0 +1,42 @@
+/** @packageDocumentation
+ * @module Locaters
+ */
+import { ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaFileLocater } from "./SchemaFileLocater";
+/**
+ * A SchemaLocator implementation for locating JSON Schema files
+ * from the file system using configurable search paths.
+ * @beta
+ */
+export declare class SchemaJsonFileLocater extends SchemaFileLocater implements ISchemaLocater {
+    /**
+     * Constructs a SchemaKey based on the information in the Schema JSON
+     * @param data The Schema JSON as a string
+     */
+    protected getSchemaKey(data: string): SchemaKey;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+     */
+    getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchemaSync(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined;
+}
+//# sourceMappingURL=SchemaJsonFileLocater.d.ts.map

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

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

package/lib/esm/SchemaJsonFileLocater.js

@@ -0,0 +1,96 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Locaters
+ */
+import * as fs from "fs";
+import * as path from "path";
+import { ECObjectsError, ECObjectsStatus, ECVersion, Schema, SchemaKey, } from "@itwin/ecschema-metadata";
+import { SchemaFileLocater } from "./SchemaFileLocater";
+/**
+ * A SchemaLocator implementation for locating JSON Schema files
+ * from the file system using configurable search paths.
+ * @beta
+ */
+export class SchemaJsonFileLocater extends SchemaFileLocater {
+    /**
+     * Constructs a SchemaKey based on the information in the Schema JSON
+     * @param data The Schema JSON as a string
+     */
+    getSchemaKey(data) {
+        const dataJson = JSON.parse(data);
+        // Check if the name is present
+        if (!(dataJson.name))
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Could not retrieve the ECSchema name in the given file.`);
+        // Check if versions is present
+        if (!(dataJson.version))
+            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Could not parse the ECSchema version in the given file.`);
+        // Get the name and version from the JSON
+        const schemaName = dataJson.name;
+        const schemaVersion = dataJson.version;
+        const key = new SchemaKey(schemaName.toString(), ECVersion.fromString(schemaVersion.toString()));
+        return key;
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+     */
+    async getSchema(schemaKey, matchType, context) {
+        await this.getSchemaInfo(schemaKey, matchType, context);
+        const schema = await context.getCachedSchema(schemaKey, matchType);
+        return schema;
+    }
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    async getSchemaInfo(schemaKey, matchType, context) {
+        // Grab all schema files that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType, "json");
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaPath = maxCandidate.fileName;
+        // Load the file
+        if (!await this.fileExists(schemaPath))
+            return undefined;
+        const schemaText = await this.readUtf8FileToString(schemaPath);
+        if (!schemaText)
+            return undefined;
+        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
+        return Schema.startLoadingFromJson(schemaText, context);
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured
+     * search paths to locate the JSON schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchemaSync(schemaKey, matchType, context) {
+        // Grab all schema files that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType, "json");
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaPath = maxCandidate.fileName;
+        // Load the file
+        if (!fs.existsSync(schemaPath))
+            return undefined;
+        const schemaText = fs.readFileSync(schemaPath, "utf-8");
+        if (!schemaText)
+            return undefined;
+        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
+        const schema = Schema.fromJsonSync(schemaText, context);
+        return schema;
+    }
+}
+//# sourceMappingURL=SchemaJsonFileLocater.js.map

package/lib/esm/SchemaJsonFileLocater.js.map

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

package/lib/esm/SchemaStringLocater.d.ts

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

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

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

package/lib/esm/SchemaStringLocater.js

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

package/lib/esm/SchemaStringLocater.js.map

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

package/lib/esm/SchemaXml.d.ts

@@ -0,0 +1,22 @@
+/** @packageDocumentation
+ * @module Utils
+ */
+import { Schema } from "@itwin/ecschema-metadata";
+/**
+ * Utility class to assist in creating serialized EC Schemas on the file system.
+ * @beta
+ */
+export declare namespace SchemaXml {
+    /**
+     * Writes a Schema to an xml file to the specified output path.
+     * @param schema The Schema to serialize.
+     * @param outputPath The directory in which to create the file.
+     */
+    function writeFile(schema: Schema, outputPath: string): Promise<void>;
+    /**
+     * Writes a Schema to an xml string.
+     * @param schema The Schema to serialize.
+     */
+    function writeString(schema: Schema): Promise<string>;
+}
+//# sourceMappingURL=SchemaXml.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXml.d.ts","sourceRoot":"","sources":["../../src/SchemaXml.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAElD;;;GAGG;AACH,yBAAiB,SAAS,CAAC;IAEzB;;;;OAIG;IACH,SAAsB,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,iBAUjE;IAED;;;OAGG;IACH,SAAsB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAMjE;CAYF"}

package/lib/esm/SchemaXml.js

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

package/lib/esm/SchemaXml.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXml.js","sourceRoot":"","sources":["../../src/SchemaXml.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAG1D;;;GAGG;AACH,MAAM,KAAW,SAAS,CAyCzB;AAzCD,WAAiB,SAAS;IAExB;;;;OAIG;IACI,KAAK,UAAU,SAAS,CAAC,MAAc,EAAE,UAAkB;QAChE,MAAM,GAAG,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;QAEtC,MAAM,QAAQ,GAAG,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACnD,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,MAAM,GAAG,GAAG,sCAAsC,QAAQ,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;IACH,CAAC;IAVqB,mBAAS,YAU9B,CAAA;IAED;;;OAGG;IACI,KAAK,UAAU,WAAW,CAAC,MAAc;QAC9C,IAAI,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC,eAAe,CAAC,wCAAwC,EAAE,iBAAiB,CAAC,CAAC;QAE1G,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,UAAU,GAAG,IAAI,aAAa,EAAE,CAAC;QACvC,OAAO,UAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IANqB,qBAAW,cAMhC,CAAA;IAED,SAAS,aAAa,CAAC,MAAc,EAAE,UAAkB;QACvD,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,GAAG,GAAG,yBAAyB,OAAO,mBAAmB,CAAC;YAChE,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;QACvB,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,IAAI,eAAe,CAAC,CAAC;IAC9D,CAAC;AACH,CAAC,EAzCgB,SAAS,KAAT,SAAS,QAyCzB","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/** @packageDocumentation\r\n * @module Utils\r\n */\r\n\r\nimport * as fs from \"fs-extra\";\r\nimport * as path from \"path\";\r\nimport { DOMParser, XMLSerializer } from \"@xmldom/xmldom\";\r\nimport { Schema } from \"@itwin/ecschema-metadata\";\r\n\r\n/**\r\n * Utility class to assist in creating serialized EC Schemas on the file system.\r\n * @beta\r\n */\r\nexport namespace SchemaXml {\r\n\r\n  /**\r\n   * Writes a Schema to an xml file to the specified output path.\r\n   * @param schema The Schema to serialize.\r\n   * @param outputPath The directory in which to create the file.\r\n   */\r\n  export async function writeFile(schema: Schema, outputPath: string) {\r\n    const xml = await writeString(schema);\r\n\r\n    const baseFile = getSchemaPath(schema, outputPath);\r\n    try {\r\n      await fs.writeFile(baseFile, xml);\r\n    } catch (err: any) {\r\n      const msg = `An error occurred writing to file '${baseFile}': ${err.message}`;\r\n      throw new Error(msg);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Writes a Schema to an xml string.\r\n   * @param schema The Schema to serialize.\r\n   */\r\n  export async function writeString(schema: Schema): Promise<string> {\r\n    let xmlDoc = new DOMParser().parseFromString(`<?xml version=\"1.0\" encoding=\"UTF-8\"?>`, \"application/xml\");\r\n\r\n    xmlDoc = await schema.toXml(xmlDoc);\r\n    const serializer = new XMLSerializer();\r\n    return serializer.serializeToString(xmlDoc);\r\n  }\r\n\r\n  function getSchemaPath(schema: Schema, outputPath: string): string {\r\n    const realDir = path.normalize(outputPath);\r\n    const test = fs.pathExistsSync(realDir);\r\n    if (!test) {\r\n      const msg = `The output directory '${realDir}' does not exist.`;\r\n      throw new Error(msg);\r\n    }\r\n\r\n    return path.resolve(realDir, `${schema.name}.ecschema.xml`);\r\n  }\r\n}\r\n"]}

package/lib/esm/SchemaXmlFileLocater.d.ts

@@ -0,0 +1,70 @@
+/** @packageDocumentation
+ * @module Locaters
+ */
+import { ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType } from "@itwin/ecschema-metadata";
+import { SchemaFileLocater } from "./SchemaFileLocater";
+/**
+ * A SchemaLocater implementation for locating XML Schema files
+ * from the file system using configurable search paths.
+ * @beta This is a workaround the current lack of a full xml parser.
+ */
+export declare class SchemaXmlFileLocater extends SchemaFileLocater implements ISchemaLocater {
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
+     * to locate the XML Schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchema(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
+     * to locate the XML Schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchemaSync(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined;
+    /**
+     * Constructs a SchemaKey based on the information in the Schema XML.
+     * @param data The Schema XML as a string.
+     */
+    getSchemaKey(data: string): SchemaKey;
+}
+/**
+ * This locater is responsible for locating standard schema files that are released by the core-backend package.
+ * The locater needs an argument to the known backend assets directory where the core-backend package is installed.
+ * This can be accessed by the KnownLocations.nativeAssetsDir getter provided by core-backend.
+ *
+ * @note This locater is read-only and does not allow adding new schema search paths.
+ * @note This locater should be used as a fallback/last chance locater in the schema context as any user defined schema should have higher precedence over the standard schema.
+ * @beta This is a workaround due to the current lack of a full xml parser.
+ */
+export declare class PublishedSchemaXmlFileLocater extends SchemaXmlFileLocater implements ISchemaLocater {
+    /**
+     * Constructs a new PublishedSchemaXmlFileLocater
+     * @param knownBackendAssetsDir The assets directory where the core-backend package is installed. Can be accessed by the KnownLocations.nativeAssetsDir getter provided by core-backend.
+     */
+    constructor(knownBackendAssetsDir: string);
+    /**
+     * Overrides the addSchemaSearchPath method to prevent adding new schema search paths.
+     *
+     * @param _schemaPath - The schema path to add (ignored).
+     */
+    addSchemaSearchPath(_schemaPath: string): void;
+    /**
+     * Overrides the addSchemaSearchPaths method to prevent adding new schema search paths.
+     *
+     * @param _schemaPaths - The schema paths to add (ignored).
+     */
+    addSchemaSearchPaths(_schemaPaths: string[]): void;
+}
+//# sourceMappingURL=SchemaXmlFileLocater.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlFileLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaXmlFileLocater.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EACuC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAC1H,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAGvE;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,iBAAkB,YAAW,cAAc;IACnF;;;;;;OAMG;IACU,SAAS,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAOvH;;;;;;QAMI;IACS,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IA2BrI;;;;;;OAMG;IACI,aAAa,CAAC,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;IA4B5G;;;OAGG;IACI,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;CAa7C;AAED;;;;;;;;GAQG;AACH,qBAAa,6BAA8B,SAAQ,oBAAqB,YAAW,cAAc;IAC/F;;;OAGG;gBACgB,qBAAqB,EAAE,MAAM;IAWhD;;;;OAIG;IACa,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI;IAI9D;;;;OAIG;IACa,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,IAAI;CAGnE"}

package/lib/esm/SchemaXmlFileLocater.js

@@ -0,0 +1,140 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Locaters
+ */
+import * as path from "path";
+import * as fs from "fs";
+import { DOMParser } from "@xmldom/xmldom";
+import { ECObjectsError, ECObjectsStatus, ECVersion, Schema, SchemaKey, SchemaReadHelper, XmlParser, } from "@itwin/ecschema-metadata";
+import { SchemaFileLocater } from "./SchemaFileLocater";
+import { globSync } from "glob";
+/**
+ * A SchemaLocater implementation for locating XML Schema files
+ * from the file system using configurable search paths.
+ * @beta This is a workaround the current lack of a full xml parser.
+ */
+export class SchemaXmlFileLocater extends SchemaFileLocater {
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
+     * to locate the XML Schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    async getSchema(key, matchType, context) {
+        await this.getSchemaInfo(key, matchType, context);
+        const schema = await context.getCachedSchema(key, matchType);
+        return schema;
+    }
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    async getSchemaInfo(schemaKey, matchType, context) {
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType, "xml");
+        if (0 === candidates.length)
+            return undefined;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaPath = maxCandidate.fileName;
+        // Load the file
+        if (undefined === await this.fileExists(schemaPath))
+            return undefined;
+        const schemaText = await this.readUtf8FileToString(schemaPath);
+        if (undefined === schemaText)
+            return undefined;
+        const parser = new DOMParser();
+        const document = parser.parseFromString(schemaText);
+        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
+        const reader = new SchemaReadHelper(XmlParser, context);
+        const schema = new Schema(context);
+        return reader.readSchemaInfo(schema, document);
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths
+     * to locate the XML Schema file from the file system.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema.
+     */
+    getSchemaSync(key, matchType, context) {
+        const candidates = this.findEligibleSchemaKeys(key, matchType, "xml");
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaPath = maxCandidate.fileName;
+        // Load the file
+        if (!this.fileExistsSync(schemaPath))
+            return undefined;
+        const schemaText = this.readUtf8FileToStringSync(schemaPath);
+        if (!schemaText)
+            return undefined;
+        const parser = new DOMParser();
+        const document = parser.parseFromString(schemaText);
+        this.addSchemaSearchPaths([path.dirname(schemaPath)]);
+        const reader = new SchemaReadHelper(XmlParser, context);
+        let schema = new Schema(context);
+        schema = reader.readSchemaSync(schema, document);
+        return schema;
+    }
+    /**
+     * Constructs a SchemaKey based on the information in the Schema XML.
+     * @param data The Schema XML as a string.
+     */
+    getSchemaKey(data) {
+        const matches = data.match(/<ECSchema ([^]+?)>/g);
+        if (!matches || matches.length !== 1)
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given file`);
+        const name = matches[0].match(/schemaName="(.+?)"/);
+        const version = matches[0].match(/version="(.+?)"/);
+        if (!name || name.length !== 2 || !version || version.length !== 2)
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);
+        const key = new SchemaKey(name[1], ECVersion.fromString(version[1]));
+        return key;
+    }
+}
+/**
+ * This locater is responsible for locating standard schema files that are released by the core-backend package.
+ * The locater needs an argument to the known backend assets directory where the core-backend package is installed.
+ * This can be accessed by the KnownLocations.nativeAssetsDir getter provided by core-backend.
+ *
+ * @note This locater is read-only and does not allow adding new schema search paths.
+ * @note This locater should be used as a fallback/last chance locater in the schema context as any user defined schema should have higher precedence over the standard schema.
+ * @beta This is a workaround due to the current lack of a full xml parser.
+ */
+export class PublishedSchemaXmlFileLocater extends SchemaXmlFileLocater {
+    /**
+     * Constructs a new PublishedSchemaXmlFileLocater
+     * @param knownBackendAssetsDir The assets directory where the core-backend package is installed. Can be accessed by the KnownLocations.nativeAssetsDir getter provided by core-backend.
+     */
+    constructor(knownBackendAssetsDir) {
+        super();
+        const ecSchemaDir = path.join(knownBackendAssetsDir, "ECSchemas");
+        if (!fs.existsSync(ecSchemaDir))
+            throw new Error(`The directory ${ecSchemaDir} containing standard schemas does not exist.`);
+        // Pre-defined set of standard schema search paths
+        this.searchPaths.push(...globSync(path.join(ecSchemaDir, "*/"), { windowsPathsNoEscape: true }).filter(fs.existsSync));
+    }
+    /**
+     * Overrides the addSchemaSearchPath method to prevent adding new schema search paths.
+     *
+     * @param _schemaPath - The schema path to add (ignored).
+     */
+    addSchemaSearchPath(_schemaPath) {
+        return; // Do nothing, this is a read-only locator
+    }
+    /**
+     * Overrides the addSchemaSearchPaths method to prevent adding new schema search paths.
+     *
+     * @param _schemaPaths - The schema paths to add (ignored).
+     */
+    addSchemaSearchPaths(_schemaPaths) {
+        return; // Do nothing, this is a read-only locator
+    }
+}
+//# sourceMappingURL=SchemaXmlFileLocater.js.map