@itwin/ecschema-locaters 5.0.0-dev.90 → 5.0.0-dev.92

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":["/*---------------------------------------------------------------------------------------------\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 { Schema, SchemaContext, SchemaKey, SchemaMatchType } from \"@itwin/ecschema-metadata\";\n\n/**\n * A SchemaKey implementation that aids in identifying Schema strings via the\n * addition of the schemaText property. The schemaText is the full XML string\n * representation of the Schema.\n * @beta\n */\nexport class StringSchemaKey extends SchemaKey {\n  // The text for the schema loaded\n  public schemaText: string;\n\n  /**\n   * Initializes a new StringSchemaKey object.\n   * @param key The EC SchemaKey identifying the Schema.\n   * @param schemaText The string representation of the Schema\n   */\n  constructor(key: SchemaKey, schemaText: string) {\n    super(key.name, key.version);\n    this.schemaText = schemaText;\n  }\n}\n\n/**\n * Abstract class to hold common/overlapping functionality between SchemaJsonStringLocater and SchemaXmlStringLocater\n * @beta\n */\nexport abstract class SchemaStringLocater {\n  public schemaStrings: string[];\n\n  constructor() {\n    this.schemaStrings = [];\n  }\n\n  /**\n   * Adds schema strings used by this locator to find the\n   * Schemas.\n   * @param schemaPaths An array of Schema strings to add\n   */\n  public addSchemaStrings(schemaStrings: string[]) {\n    // If the path is not in the schemaPaths array, add it\n    for (const schemaString of schemaStrings)\n      this.addSchemaString(schemaString);\n  }\n\n  /**\n   * Adds a schema string used by this locator to locate and load Schemas.\n   * @param schemaText The text of the Schema\n   */\n  public addSchemaString(schemaString: string) {\n    const schemaKey = this.getSchemaKey(schemaString);\n    // If the string is not in the schemaStrings array, add it\n    if (!this.schemaStrings.find((entry) => this.getSchemaKey(entry).matches(schemaKey, SchemaMatchType.Exact)))\n      this.schemaStrings.push(schemaString);\n  }\n\n  protected abstract getSchemaKey(data: string): SchemaKey;\n\n  /**\n   * Attempts to find all Schema strings that match the desired SchemaKey.\n   * @param desiredKey The SchemaKey to match.\n   * @param matchType The SchemaMatchType.\n   */\n  protected findEligibleSchemaKeys(desiredKey: SchemaKey, matchType: SchemaMatchType): StringSchemaKey[] {\n    const foundStrings = new Array<StringSchemaKey>();\n\n    for (const schemaString of this.schemaStrings) {\n      // Get the schema key\n      const key = this.getSchemaKey(schemaString);\n\n      // If the key matches, put it in foundFiles\n      if (key.matches(desiredKey, matchType))\n        foundStrings.push(new StringSchemaKey(key, schemaString));\n    }\n\n    return foundStrings;\n  }\n\n  public abstract getSchema(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' StringSchemaKey.\n   * @param rhs The 'right-hand' StringSchemaKey.\n   */\n  public compareSchemaKeyByVersion = (lhs: StringSchemaKey, rhs: StringSchemaKey): number => {\n    return lhs.compareByVersion(rhs);\n  };\n}\n"]}

package/lib/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":["/*---------------------------------------------------------------------------------------------\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 Utils\n */\n\nimport * as fs from \"fs-extra\";\nimport * as path from \"path\";\nimport { DOMParser, XMLSerializer } from \"@xmldom/xmldom\";\nimport { Schema } from \"@itwin/ecschema-metadata\";\n\n/**\n * Utility class to assist in creating serialized EC Schemas on the file system.\n * @beta\n */\nexport namespace SchemaXml {\n\n  /**\n   * Writes a Schema to an xml file to the specified output path.\n   * @param schema The Schema to serialize.\n   * @param outputPath The directory in which to create the file.\n   */\n  export async function writeFile(schema: Schema, outputPath: string) {\n    const xml = await writeString(schema);\n\n    const baseFile = getSchemaPath(schema, outputPath);\n    try {\n      await fs.writeFile(baseFile, xml);\n    } catch (err: any) {\n      const msg = `An error occurred writing to file '${baseFile}': ${err.message}`;\n      throw new Error(msg);\n    }\n  }\n\n  /**\n   * Writes a Schema to an xml string.\n   * @param schema The Schema to serialize.\n   */\n  export async function writeString(schema: Schema): Promise<string> {\n    let xmlDoc = new DOMParser().parseFromString(`<?xml version=\"1.0\" encoding=\"UTF-8\"?>`, \"application/xml\");\n\n    xmlDoc = await schema.toXml(xmlDoc);\n    const serializer = new XMLSerializer();\n    return serializer.serializeToString(xmlDoc);\n  }\n\n  function getSchemaPath(schema: Schema, outputPath: string): string {\n    const realDir = path.normalize(outputPath);\n    const test = fs.pathExistsSync(realDir);\n    if (!test) {\n      const msg = `The output directory '${realDir}' does not exist.`;\n      throw new Error(msg);\n    }\n\n    return path.resolve(realDir, `${schema.name}.ecschema.xml`);\n  }\n}\n"]}

package/lib/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

package/lib/esm/SchemaXmlFileLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlFileLocater.js","sourceRoot":"","sources":["../../src/SchemaXmlFileLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACL,cAAc,EAAE,eAAe,EAAE,SAAS,EAAkB,MAAM,EAA6B,SAAS,EAAmB,gBAAgB,EAAE,SAAS,GACvJ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAiB,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC;;;;GAIG;AACH,MAAM,OAAO,oBAAqB,SAAQ,iBAAiB;IACzD;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACvF,MAAM,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAElD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC7D,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,MAAM,UAAU,GAAoB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAE7F,IAAI,CAAC,KAAK,UAAU,CAAC,MAAM;YACzB,OAAO,SAAS,CAAC;QAEnB,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC;QAEzC,gBAAgB;QAChB,IAAI,SAAS,KAAK,MAAM,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjD,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,SAAS,KAAK,UAAU;YAC1B,OAAO,SAAS,CAAC;QAEnB,MAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,GAAc,EAAE,SAA0B,EAAE,OAAsB;QACrF,MAAM,UAAU,GAAoB,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;QAEvF,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC;QAEzC,gBAAgB;QAChB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC;YAClC,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU;YACb,OAAO,SAAS,CAAC;QAEnB,MAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,IAAI,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,MAAM,GAAW,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEjD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,IAAY;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAClD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,mDAAmD,CAAC,CAAC;QAElH,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAChE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,6EAA6E,CAAC,CAAC;QAE5I,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrE,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,6BAA8B,SAAQ,oBAAoB;IACrE;;;OAGG;IACH,YAAmB,qBAA6B;QAC9C,KAAK,EAAE,CAAC;QAER,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,qBAAqB,EAAE,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,iBAAiB,WAAW,8CAA8C,CAAC,CAAC;QAE9F,kDAAkD;QAClD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAC;IACzH,CAAC;IAED;;;;OAIG;IACa,mBAAmB,CAAC,WAAmB;QACrD,OAAO,CAAC,0CAA0C;IACpD,CAAC;IAED;;;;OAIG;IACa,oBAAoB,CAAC,YAAsB;QACzD,OAAO,CAAC,0CAA0C;IACpD,CAAC;CACF","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 path from \"path\";\nimport * as fs from \"fs\";\nimport { DOMParser } from \"@xmldom/xmldom\";\nimport {\n  ECObjectsError, ECObjectsStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType, SchemaReadHelper, XmlParser,\n} from \"@itwin/ecschema-metadata\";\nimport { FileSchemaKey, SchemaFileLocater } from \"./SchemaFileLocater\";\nimport { globSync } from \"glob\";\n\n/**\n * A SchemaLocater implementation for locating XML Schema files\n * from the file system using configurable search paths.\n * @beta This is a workaround the current lack of a full xml parser.\n */\nexport class SchemaXmlFileLocater extends SchemaFileLocater implements ISchemaLocater {\n  /**\n   * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths\n   * to locate the XML Schema file from the file system.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema.\n   */\n  public async getSchema(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    await this.getSchemaInfo(key, matchType, context);\n\n    const schema = await context.getCachedSchema(key, matchType);\n    return schema;\n  }\n\n  /**\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\n    * The fully loaded schema can be gotten later from the context using the getCachedSchema method.\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\n    * @param matchType The match type to use when locating the schema\n    * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n    */\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    const candidates: FileSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType, \"xml\");\n\n    if (0 === candidates.length)\n      return undefined;\n\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\n    const schemaPath = maxCandidate.fileName;\n\n    // Load the file\n    if (undefined === await this.fileExists(schemaPath))\n      return undefined;\n\n    const schemaText = await this.readUtf8FileToString(schemaPath);\n    if (undefined === schemaText)\n      return undefined;\n\n    const parser = new DOMParser();\n    const document = parser.parseFromString(schemaText);\n\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\n    const reader = new SchemaReadHelper(XmlParser, context);\n    const schema = new Schema(context);\n\n    return reader.readSchemaInfo(schema, document);\n  }\n\n  /**\n   * Attempts to retrieve a Schema with the given SchemaKey by using the configured search paths\n   * to locate the XML Schema file from the file system.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema.\n   */\n  public getSchemaSync(key: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined {\n    const candidates: FileSchemaKey[] = this.findEligibleSchemaKeys(key, matchType, \"xml\");\n\n    if (!candidates || candidates.length === 0)\n      return undefined;\n\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\n    const schemaPath = maxCandidate.fileName;\n\n    // Load the file\n    if (!this.fileExistsSync(schemaPath))\n      return undefined;\n\n    const schemaText = this.readUtf8FileToStringSync(schemaPath);\n    if (!schemaText)\n      return undefined;\n\n    const parser = new DOMParser();\n    const document = parser.parseFromString(schemaText);\n\n    this.addSchemaSearchPaths([path.dirname(schemaPath)]);\n    const reader = new SchemaReadHelper(XmlParser, context);\n    let schema: Schema = new Schema(context);\n    schema = reader.readSchemaSync(schema, document);\n\n    return schema;\n  }\n\n  /**\n   * Constructs a SchemaKey based on the information in the Schema XML.\n   * @param data The Schema XML as a string.\n   */\n  public getSchemaKey(data: string): SchemaKey {\n    const matches = data.match(/<ECSchema ([^]+?)>/g);\n    if (!matches || matches.length !== 1)\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given file`);\n\n    const name = matches[0].match(/schemaName=\"(.+?)\"/);\n    const version = matches[0].match(/version=\"(.+?)\"/);\n    if (!name || name.length !== 2 || !version || version.length !== 2)\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given file`);\n\n    const key = new SchemaKey(name[1], ECVersion.fromString(version[1]));\n    return key;\n  }\n}\n\n/**\n * This locater is responsible for locating standard schema files that are released by the core-backend package.\n * The locater needs an argument to the known backend assets directory where the core-backend package is installed.\n * This can be accessed by the KnownLocations.nativeAssetsDir getter provided by core-backend.\n *\n * @note This locater is read-only and does not allow adding new schema search paths.\n * @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.\n * @beta This is a workaround due to the current lack of a full xml parser.\n */\nexport class PublishedSchemaXmlFileLocater extends SchemaXmlFileLocater implements ISchemaLocater {\n  /**\n   * Constructs a new PublishedSchemaXmlFileLocater\n   * @param knownBackendAssetsDir The assets directory where the core-backend package is installed. Can be accessed by the KnownLocations.nativeAssetsDir getter provided by core-backend.\n   */\n  public constructor(knownBackendAssetsDir: string) {\n    super();\n\n    const ecSchemaDir = path.join(knownBackendAssetsDir, \"ECSchemas\");\n    if (!fs.existsSync(ecSchemaDir))\n      throw new Error(`The directory ${ecSchemaDir} containing standard schemas does not exist.`);\n\n    // Pre-defined set of standard schema search paths\n    this.searchPaths.push(...globSync(path.join(ecSchemaDir, \"*/\"), { windowsPathsNoEscape: true }).filter(fs.existsSync));\n  }\n\n  /**\n   * Overrides the addSchemaSearchPath method to prevent adding new schema search paths.\n   *\n   * @param _schemaPath - The schema path to add (ignored).\n   */\n  public override addSchemaSearchPath(_schemaPath: string): void {\n    return; // Do nothing, this is a read-only locator\n  }\n\n  /**\n   * Overrides the addSchemaSearchPaths method to prevent adding new schema search paths.\n   *\n   * @param _schemaPaths - The schema paths to add (ignored).\n   */\n  public override addSchemaSearchPaths(_schemaPaths: string[]): void {\n    return; // Do nothing, this is a read-only locator\n  }\n}\n"]}

package/lib/esm/SchemaXmlStringLocater.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlStringLocater.d.ts","sourceRoot":"","sources":["../../src/SchemaXmlStringLocater.ts"],"names":[],"mappings":"AAIA;;GAEG;AAGH,OAAO,EACuC,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,eAAe,EAC1H,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAmB,MAAM,uBAAuB,CAAC;AAE7E;;;;GAIG;AACH,qBAAa,sBAAuB,SAAQ,mBAAoB,YAAW,cAAc;IAEvF;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IAejD;;;;;;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;IAkBrI;;;;;;OAMG;IACI,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;IAmBlH;;;;OAIG;IACH,OAAO,CAAC,cAAc;CAYvB"}

package/lib/esm/SchemaXmlStringLocater.js

@@ -0,0 +1,100 @@
+/*---------------------------------------------------------------------------------------------
+* 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 { DOMParser } from "@xmldom/xmldom";
+import { ECObjectsError, ECObjectsStatus, ECVersion, Schema, SchemaKey, SchemaReadHelper, XmlParser, } from "@itwin/ecschema-metadata";
+import { SchemaStringLocater } from "./SchemaStringLocater";
+/**
+ * A SchemaLocator implementation for locating and deserializing EC Schemas from XML strings
+ * loaded in memory.
+ * @beta
+ */
+export class SchemaXmlStringLocater extends SchemaStringLocater {
+    /**
+     * Constructs a SchemaKey based on the information in the Schema XML.
+     * @param schemaXml The Schema XML as a string.
+     */
+    getSchemaKey(schemaXml) {
+        const matches = schemaXml.match(/<ECSchema ([^]+?)>/g);
+        if (!matches || matches.length !== 1)
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given string`);
+        const name = matches[0].match(/schemaName="(.+?)"/);
+        const version = matches[0].match(/version="(.+?)"/);
+        if (!name || name.length !== 2 || !version || version.length !== 2)
+            throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);
+        const ecVersion = ECVersion.fromString(version[1]);
+        const key = new SchemaKey(name[1], ecVersion);
+        return key;
+    }
+    /**
+     * Attempts to retrieve a Schema with the given SchemaKey by searching the configured
+     * Schema strings.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+     */
+    async getSchema(schemaKey, matchType, context) {
+        await this.getSchemaInfo(schemaKey, matchType, context);
+        const schema = await context.getCachedSchema(schemaKey, matchType);
+        return schema;
+    }
+    /**
+      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+      * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+      * @param schemaKey The SchemaKey describing the schema to get from the cache.
+      * @param matchType The match type to use when locating the schema
+      * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+      */
+    async getSchemaInfo(schemaKey, matchType, context) {
+        // Grab all schema strings that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType);
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaText = maxCandidate.schemaText;
+        const parser = new DOMParser();
+        const document = parser.parseFromString(schemaText);
+        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 searching the configured
+     * Schema strings.
+     * @param key The SchemaKey of the Schema to retrieve.
+     * @param matchType The SchemaMatchType.
+     * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.
+     */
+    getSchemaSync(schemaKey, matchType, context) {
+        // Grab all schema strings that match the schema key
+        const candidates = this.findEligibleSchemaKeys(schemaKey, matchType);
+        if (!candidates || candidates.length === 0)
+            return undefined;
+        const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];
+        const schemaText = maxCandidate.schemaText;
+        const parser = new DOMParser();
+        const document = parser.parseFromString(schemaText);
+        const reader = new SchemaReadHelper(XmlParser, context);
+        let schema = new Schema(context);
+        schema = reader.readSchemaSync(schema, document);
+        return schema;
+    }
+    /**
+     * Parses a valid EC 2.0 version string and returns an ECVersion object. The second digit becomes the minor version,
+     * and a zero is inserted as the 'write' digit. Example: "1.1" -> "1.0.1".
+     * @param versionString A valid EC 2.0 version string of the format, 'RR.mm'.
+     */
+    fromECv2String(versionString) {
+        const [read, minor] = versionString.split(".");
+        if (!read)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);
+        if (!minor)
+            throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);
+        return new ECVersion(+read, 0, +minor);
+    }
+}
+//# sourceMappingURL=SchemaXmlStringLocater.js.map

package/lib/esm/SchemaXmlStringLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaXmlStringLocater.js","sourceRoot":"","sources":["../../src/SchemaXmlStringLocater.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EACL,cAAc,EAAE,eAAe,EAAE,SAAS,EAAkB,MAAM,EAA6B,SAAS,EAAmB,gBAAgB,EAAE,SAAS,GACvJ,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,mBAAmB,EAAmB,MAAM,uBAAuB,CAAC;AAE7E;;;;GAIG;AACH,MAAM,OAAO,sBAAuB,SAAQ,mBAAmB;IAE7D;;;OAGG;IACI,YAAY,CAAC,SAAiB;QACnC,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAClC,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,qDAAqD,CAAC,CAAC;QAEpH,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAChE,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,+EAA+E,CAAC,CAAC;QAE9I,MAAM,SAAS,GAAG,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,GAAG,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QAC9C,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,MAAgB,CAAC;IAC1B,CAAC;IAED;;;;;;QAMI;IACG,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,oDAAoD;QACpD,MAAM,UAAU,GAAsB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACxF,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3C,MAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACxD,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;QAEnC,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;OAMG;IACI,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC3F,oDAAoD;QACpD,MAAM,UAAU,GAAsB,IAAI,CAAC,sBAAsB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACxF,IAAI,CAAC,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACxC,OAAO,SAAS,CAAC;QAEnB,MAAM,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC5F,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC;QAE3C,MAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEpD,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QACxD,IAAI,MAAM,GAAW,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;QACzC,MAAM,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAEjD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACK,cAAc,CAAC,aAAqB;QAC1C,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE/C,IAAI,CAAC,IAAI;YACP,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,oDAAoD,aAAa,EAAE,CAAC,CAAC;QAElI,IAAI,CAAC,KAAK;YACR,MAAM,IAAI,cAAc,CAAC,eAAe,CAAC,gBAAgB,EAAE,qDAAqD,aAAa,EAAE,CAAC,CAAC;QAEnI,OAAO,IAAI,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CAEF","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 { DOMParser } from \"@xmldom/xmldom\";\nimport {\n  ECObjectsError, ECObjectsStatus, ECVersion, ISchemaLocater, Schema, SchemaContext, SchemaInfo, SchemaKey, SchemaMatchType, SchemaReadHelper, XmlParser,\n} from \"@itwin/ecschema-metadata\";\nimport { SchemaStringLocater, StringSchemaKey } from \"./SchemaStringLocater\";\n\n/**\n * A SchemaLocator implementation for locating and deserializing EC Schemas from XML strings\n * loaded in memory.\n * @beta\n */\nexport class SchemaXmlStringLocater extends SchemaStringLocater implements ISchemaLocater {\n\n  /**\n   * Constructs a SchemaKey based on the information in the Schema XML.\n   * @param schemaXml The Schema XML as a string.\n   */\n  public getSchemaKey(schemaXml: string): SchemaKey {\n    const matches = schemaXml.match(/<ECSchema ([^]+?)>/g);\n    if (!matches || matches.length !== 1)\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find '<ECSchema>' tag in the given string`);\n\n    const name = matches[0].match(/schemaName=\"(.+?)\"/);\n    const version = matches[0].match(/version=\"(.+?)\"/);\n    if (!name || name.length !== 2 || !version || version.length !== 2)\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaXML, `Could not find the ECSchema 'schemaName' or 'version' tag in the given string`);\n\n    const ecVersion = ECVersion.fromString(version[1]);\n    const key = new SchemaKey(name[1], ecVersion);\n    return key;\n  }\n\n  /**\n   * Attempts to retrieve a Schema with the given SchemaKey by searching the configured\n   * Schema strings.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n   */\n  public async getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    await this.getSchemaInfo(schemaKey, matchType, context);\n\n    const schema = await context.getCachedSchema(schemaKey, matchType);\n    return schema as Schema;\n  }\n\n  /**\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\n    * The fully loaded schema can be gotten later from the context using the getCachedSchema method.\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\n    * @param matchType The match type to use when locating the schema\n    * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n    */\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    // Grab all schema strings that match the schema key\n    const candidates: StringSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType);\n    if (!candidates || candidates.length === 0)\n      return undefined;\n\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\n    const schemaText = maxCandidate.schemaText;\n\n    const parser = new DOMParser();\n    const document = parser.parseFromString(schemaText);\n\n    const reader = new SchemaReadHelper(XmlParser, context);\n    const schema = new Schema(context);\n\n    return reader.readSchemaInfo(schema, document);\n  }\n\n  /**\n   * Attempts to retrieve a Schema with the given SchemaKey by searching the configured\n   * Schema strings.\n   * @param key The SchemaKey of the Schema to retrieve.\n   * @param matchType The SchemaMatchType.\n   * @param context The SchemaContext that will control the lifetime of the schema and holds the schema's references, if they exist.\n   */\n  public getSchemaSync(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined {\n    // Grab all schema strings that match the schema key\n    const candidates: StringSchemaKey[] = this.findEligibleSchemaKeys(schemaKey, matchType);\n    if (!candidates || candidates.length === 0)\n      return undefined;\n\n    const maxCandidate = candidates.sort(this.compareSchemaKeyByVersion)[candidates.length - 1];\n    const schemaText = maxCandidate.schemaText;\n\n    const parser = new DOMParser();\n    const document = parser.parseFromString(schemaText);\n\n    const reader = new SchemaReadHelper(XmlParser, context);\n    let schema: Schema = new Schema(context);\n    schema = reader.readSchemaSync(schema, document);\n\n    return schema;\n  }\n\n  /**\n   * Parses a valid EC 2.0 version string and returns an ECVersion object. The second digit becomes the minor version,\n   * and a zero is inserted as the 'write' digit. Example: \"1.1\" -> \"1.0.1\".\n   * @param versionString A valid EC 2.0 version string of the format, 'RR.mm'.\n   */\n  private fromECv2String(versionString: string): ECVersion {\n    const [read, minor] = versionString.split(\".\");\n\n    if (!read)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The read version is missing from version string, ${versionString}`);\n\n    if (!minor)\n      throw new ECObjectsError(ECObjectsStatus.InvalidECVersion, `The minor version is missing from version string, ${versionString}`);\n\n    return new ECVersion(+read, 0, +minor);\n  }\n\n}\n"]}