@itwin/ecschema-metadata 3.4.0-dev.50 → 3.4.0-dev.56

package/lib/cjs/SchemaLoader.js

@@ -1,48 +1,48 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaLoader = void 0;
-const Context_1 = require("./Context");
-const ECObjects_1 = require("./ECObjects");
-const Exception_1 = require("./Exception");
-const SchemaJsonLocater_1 = require("./SchemaJsonLocater");
-const SchemaKey_1 = require("./SchemaKey");
-/**
- * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.
- * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.
- * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]
- * is a possibility, thereby avoiding unnecessary schema retrievals from the function.
- * @alpha
- */
-class SchemaLoader {
-    constructor(getSchema) {
-        this._context = new Context_1.SchemaContext();
-        const locater = new SchemaJsonLocater_1.SchemaJsonLocater(getSchema);
-        this._context.addLocater(locater);
-    }
-    /** Get a schema by name
-     * @param schemaName a string with the name of the schema to load.
-     * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.
-     */
-    getSchema(schemaName) {
-        const schema = this.tryGetSchema(schemaName);
-        if (!schema)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLocateSchema, `reading schema=${schemaName}`);
-        return schema;
-    }
-    /** Attempts to get a schema by name
-     * @param schemaName a string with the name of the schema to load.
-     * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
-     */
-    tryGetSchema(schemaName) {
-        // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.
-        const key = new SchemaKey_1.SchemaKey(schemaName, new SchemaKey_1.ECVersion(1, 0, 0));
-        const schema = this._context.getSchemaSync(key, ECObjects_1.SchemaMatchType.Latest);
-        return schema;
-    }
-}
-exports.SchemaLoader = SchemaLoader;
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaLoader = void 0;
+const Context_1 = require("./Context");
+const ECObjects_1 = require("./ECObjects");
+const Exception_1 = require("./Exception");
+const SchemaJsonLocater_1 = require("./SchemaJsonLocater");
+const SchemaKey_1 = require("./SchemaKey");
+/**
+ * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.
+ * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.
+ * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]
+ * is a possibility, thereby avoiding unnecessary schema retrievals from the function.
+ * @alpha
+ */
+class SchemaLoader {
+    constructor(getSchema) {
+        this._context = new Context_1.SchemaContext();
+        const locater = new SchemaJsonLocater_1.SchemaJsonLocater(getSchema);
+        this._context.addLocater(locater);
+    }
+    /** Get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.
+     */
+    getSchema(schemaName) {
+        const schema = this.tryGetSchema(schemaName);
+        if (!schema)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLocateSchema, `reading schema=${schemaName}`);
+        return schema;
+    }
+    /** Attempts to get a schema by name
+     * @param schemaName a string with the name of the schema to load.
+     * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.
+     */
+    tryGetSchema(schemaName) {
+        // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.
+        const key = new SchemaKey_1.SchemaKey(schemaName, new SchemaKey_1.ECVersion(1, 0, 0));
+        const schema = this._context.getSchemaSync(key, ECObjects_1.SchemaMatchType.Latest);
+        return schema;
+    }
+}
+exports.SchemaLoader = SchemaLoader;
 //# sourceMappingURL=SchemaLoader.js.map

package/lib/cjs/SchemaLoader.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemaLoader.js","sourceRoot":"","sources":["../../src/SchemaLoader.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,uCAA0C;AAC1C,2CAA8C;AAC9C,2CAA8D;AAE9D,2DAA2E;AAC3E,2CAAmD;AAEnD;;;;;;GAMG;AACH,MAAa,YAAY;IAGvB,YAAmB,SAA4B;QAC7C,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAa,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,qCAAiB,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,SAAS,CAAmB,UAAkB;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,oBAAoB,EAAE,kBAAkB,UAAU,EAAE,CAAC,CAAC;QAEjG,OAAO,MAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAmB,UAAkB;QACtD,gGAAgG;QAChG,MAAM,GAAG,GAAG,IAAI,qBAAS,CAAC,UAAU,EAAE,IAAI,qBAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE,2BAAe,CAAC,MAAM,CAAC,CAAC;QACxE,OAAO,MAAW,CAAC;IACrB,CAAC;CACF;AA/BD,oCA+BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { SchemaContext } from \"./Context\";\r\nimport { SchemaMatchType } from \"./ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\r\nimport { Schema } from \"./Metadata/Schema\";\r\nimport { SchemaJsonLocater, SchemaPropsGetter } from \"./SchemaJsonLocater\";\r\nimport { ECVersion, SchemaKey } from \"./SchemaKey\";\r\n\r\n/**\r\n * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.\r\n * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.\r\n * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]\r\n * is a possibility, thereby avoiding unnecessary schema retrievals from the function.\r\n * @alpha\r\n */\r\nexport class SchemaLoader {\r\n  private _context: SchemaContext;\r\n\r\n  public constructor(getSchema: SchemaPropsGetter) {\r\n    this._context = new SchemaContext();\r\n    const locater = new SchemaJsonLocater(getSchema);\r\n    this._context.addLocater(locater);\r\n  }\r\n\r\n  /** Get a schema by name\r\n   * @param schemaName a string with the name of the schema to load.\r\n   * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.\r\n   */\r\n  public getSchema<T extends Schema>(schemaName: string): T {\r\n    const schema = this.tryGetSchema(schemaName);\r\n    if (!schema)\r\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `reading schema=${schemaName}`);\r\n\r\n    return schema as T;\r\n  }\r\n\r\n  /** Attempts to get a schema by name\r\n   * @param schemaName a string with the name of the schema to load.\r\n   * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.\r\n   */\r\n  public tryGetSchema<T extends Schema>(schemaName: string): T | undefined {\r\n    // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.\r\n    const key = new SchemaKey(schemaName, new ECVersion(1, 0, 0));\r\n    const schema = this._context.getSchemaSync(key, SchemaMatchType.Latest);\r\n    return schema as T;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"SchemaLoader.js","sourceRoot":"","sources":["../../src/SchemaLoader.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,uCAA0C;AAC1C,2CAA8C;AAC9C,2CAA8D;AAE9D,2DAA2E;AAC3E,2CAAmD;AAEnD;;;;;;GAMG;AACH,MAAa,YAAY;IAGvB,YAAmB,SAA4B;QAC7C,IAAI,CAAC,QAAQ,GAAG,IAAI,uBAAa,EAAE,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,qCAAiB,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;;OAGG;IACI,SAAS,CAAmB,UAAkB;QACnD,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QAC7C,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,oBAAoB,EAAE,kBAAkB,UAAU,EAAE,CAAC,CAAC;QAEjG,OAAO,MAAW,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,YAAY,CAAmB,UAAkB;QACtD,gGAAgG;QAChG,MAAM,GAAG,GAAG,IAAI,qBAAS,CAAC,UAAU,EAAE,IAAI,qBAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAC9D,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE,2BAAe,CAAC,MAAM,CAAC,CAAC;QACxE,OAAO,MAAW,CAAC;IACrB,CAAC;CACF;AA/BD,oCA+BC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport { SchemaContext } from \"./Context\";\nimport { SchemaMatchType } from \"./ECObjects\";\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\nimport { Schema } from \"./Metadata/Schema\";\nimport { SchemaJsonLocater, SchemaPropsGetter } from \"./SchemaJsonLocater\";\nimport { ECVersion, SchemaKey } from \"./SchemaKey\";\n\n/**\n * A utility class for loading EC Schema objects using a function that returns schema json for a given schema name.\n * Loaded schemas are held in memory within  a schema context managed by SchemaLoader.\n * The SchemaLoader object should be held in memory if multiple calls to [[getSchema]] or [[tryGetSchema]]\n * is a possibility, thereby avoiding unnecessary schema retrievals from the function.\n * @alpha\n */\nexport class SchemaLoader {\n  private _context: SchemaContext;\n\n  public constructor(getSchema: SchemaPropsGetter) {\n    this._context = new SchemaContext();\n    const locater = new SchemaJsonLocater(getSchema);\n    this._context.addLocater(locater);\n  }\n\n  /** Get a schema by name\n   * @param schemaName a string with the name of the schema to load.\n   * @throws [ECObjectsError]($ecschema-metadata) if the schema is not found or cannot be loaded.\n   */\n  public getSchema<T extends Schema>(schemaName: string): T {\n    const schema = this.tryGetSchema(schemaName);\n    if (!schema)\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `reading schema=${schemaName}`);\n\n    return schema as T;\n  }\n\n  /** Attempts to get a schema by name\n   * @param schemaName a string with the name of the schema to load.\n   * @throws [ECObjectsError]($ecschema-metadata) if the schema exists, but cannot be loaded.\n   */\n  public tryGetSchema<T extends Schema>(schemaName: string): T | undefined {\n    // SchemaKey version is not used when locating schema in an iModel, so the version is arbitrary.\n    const key = new SchemaKey(schemaName, new ECVersion(1, 0, 0));\n    const schema = this._context.getSchemaSync(key, SchemaMatchType.Latest);\n    return schema as T;\n  }\n}\n"]}