@itwin/ecschema-metadata 5.1.0-dev.9 → 5.2.0-dev.2

package/lib/cjs/IncrementalLoading/IncrementalSchemaLocater.d.ts

@@ -0,0 +1,109 @@
+import { ISchemaLocater, SchemaContext } from "../Context";
+import { SchemaProps } from "../Deserialization/JsonProps";
+import { SchemaMatchType } from "../ECObjects";
+import { SchemaInfo } from "../Interfaces";
+import { Schema } from "../Metadata/Schema";
+import { SchemaKey } from "../SchemaKey";
+/**
+ * Defines the SchemaLocater Options which determine how each schema is to be loaded.
+ * All options are optional.
+ * @beta
+ */
+export interface SchemaLocaterOptions {
+    /** Only load partial schemas. Full schema information will not be retrieved. Defaults to false. */
+    readonly loadPartialSchemaOnly?: boolean;
+}
+/**
+ * A [[ISchemaLocater]] implementation for locating and retrieving EC [[Schema]]
+ * objects incrementally instead of the full schema and it's references at once. This is useful for large schemas that
+ * take a long time to load, but clients need a rough skeleton of the schema as fast as possible.
+ *
+ * The IncrementalSchemaLocater is a locater around the [[IncrementalSchemaLocater]] to be used in a
+ * [[SchemaContext]].
+ * @internal
+ */
+export declare abstract class IncrementalSchemaLocater implements ISchemaLocater {
+    private readonly _options;
+    private readonly _schemaInfoCache;
+    /**
+     * Initializes a new instance of the IncrementalSchemaLocater class.
+     * @param options  The [[SchemaLocaterOptions]] that control the loading of the schema.
+     */
+    constructor(options?: SchemaLocaterOptions);
+    /** Gets the options how the schema locater load the schemas. */
+    protected get options(): SchemaLocaterOptions;
+    /**
+     * Gets the [[SchemaInfo]] which matches the provided SchemaKey.  The SchemaInfo may be returned
+     * before the schema is fully loaded. May return the entire Schema so long as it is completely loaded as it satisfies
+     * the SchemaInfo interface.
+     * @param schemaKey   The [[SchemaKey]] to look up.
+     * @param matchType   The [[SchemaMatchType]] to use against candidate schemas.
+     * @param context     The [[SchemaContext]] for loading schema references.
+     */
+    getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
+    /**
+     * Attempts to get a [[Schema]] from the locater. Yields undefined if no matching schema is found.
+     * For schemas that may have references, construct and call through a SchemaContext instead.
+     * @param schemaKey   The [[SchemaKey]] to look up.
+     * @param matchType   The [[SchemaMatchType]] to use against candidate schemas.
+     * @param context     The [[SchemaContext]] for loading schema references.
+     */
+    getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
+    /**
+     * Attempts to get a [[Schema]] from the locater. Yields undefined if no matching schema is found.
+     * For schemas that may have references, construct and call through a SchemaContext instead.
+     * NOT IMPLEMENTED IN THIS LOCATER - ALWAYS RETURNS UNDEFINED.
+     * @param schemaKey   The [[SchemaKey]] to look up.
+     * @param matchType   The [[SchemaMatchType]] to use against candidate schemas.
+     * @param context     The [[SchemaContext]] for loading schema references.
+     * @returns           Incremental schema loading does not work synchronously, this will always return undefined.
+     */
+    getSchemaSync(_schemaKey: Readonly<SchemaKey>, _matchType: SchemaMatchType, _context: SchemaContext): Schema | undefined;
+    /**
+     * Gets the schema partials for the given schema key. The first item in the array is the
+     * actual schema props of the schema to load, the following items are partial schema props
+     * of referenced schemas.
+     * @param schemaKey   The schema key of the requested schema.
+     * @param context     The schema context.
+     */
+    protected abstract getSchemaPartials(schemaKey: SchemaKey, context: SchemaContext): Promise<ReadonlyArray<SchemaProps> | undefined>;
+    /**
+     * Gets the full schema json for the requested schema key.
+     * @param schemaKey   The schema key of the requested schema.
+     * @param context     The schema context.
+     */
+    protected abstract getSchemaJson(schemaKey: SchemaKey, context: SchemaContext): Promise<SchemaProps | undefined>;
+    /**
+     * Loads the schema info objects for the given context.
+     * @param context   The schema context to load the schema infos for.
+     * @returns         A promise that resolves to an iterable of schema infos.
+     */
+    abstract loadSchemaInfos(context: SchemaContext): Promise<Iterable<SchemaInfo>>;
+    /**
+     * Checks if the context contains the right schemas to support incremental schema loading.
+     * @param context   The schema context to check.
+     * @returns         true if incremental schema loading is supported, false otherwise.
+     */
+    protected abstract supportPartialSchemaLoading(context: SchemaContext): Promise<boolean>;
+    /**
+     * Start loading the schema for the given schema info incrementally. The schema is returned
+     * as soon as the schema stub is loaded while the schema fully resolves in the background. It should
+     * only be called by the IncrementalSchemaLocater if a schema has not been loaded or started to
+     * load yet.
+     * @param schemaInfo    The schema info of the schema to load.
+     * @param schemaContext The schema context to load the schema into.
+     */
+    loadSchema(schemaInfo: SchemaInfo, schemaContext: SchemaContext): Promise<Schema>;
+    /**
+     * Creates a SchemaProps object by loading the Schema information from the given SchemaContext.
+     * @param schemaKey The SchemaKey of the Schema whose props are to be retrieved.
+     * @param schemaContext The SchemaContext holding the Schema.
+     * @returns The SchemaProps object.
+     */
+    protected createSchemaProps(schemaKey: SchemaKey, schemaContext: SchemaContext): Promise<SchemaProps>;
+    private startLoadingPartialSchema;
+    private loadFullSchema;
+    private startLoadingFullSchema;
+    private sortSchemaPartials;
+}
+//# sourceMappingURL=IncrementalSchemaLocater.d.ts.map

package/lib/cjs/IncrementalLoading/IncrementalSchemaLocater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncrementalSchemaLocater.d.ts","sourceRoot":"","sources":["../../../src/IncrementalLoading/IncrementalSchemaLocater.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAE3D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAMzC;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,mGAAmG;IACnG,QAAQ,CAAC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CAC1C;AAED;;;;;;;;GAQG;AACH,8BAAsB,wBAAyB,YAAW,cAAc;IACtE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAuB;IAChD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAkB;IAEnD;;;OAGG;gBACS,OAAO,CAAC,EAAE,oBAAoB;IAQ1C,gEAAgE;IAChE,SAAS,KAAK,OAAO,IAAI,oBAAoB,CAE5C;IAED;;;;;;;OAOG;IACU,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAIrI;;;;;;OAMG;IACU,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO7H;;;;;;;;OAQG;IACI,aAAa,CAAC,UAAU,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS;IAI/H;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;IAEnI;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAEhH;;;;OAIG;aACa,eAAe,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IAEtF;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,2BAA2B,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAExF;;;;;;;OAOG;IACU,UAAU,CAAC,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IA+B9F;;;;;OAKG;cACa,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,CAAC;YAuB7F,yBAAyB;YAgBzB,cAAc;YAMd,sBAAsB;YAsBtB,kBAAkB;CAcjC"}

package/lib/cjs/IncrementalLoading/IncrementalSchemaLocater.js

@@ -0,0 +1,219 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IncrementalSchemaLocater = void 0;
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+const Constants_1 = require("../Constants");
+const SchemaGraphUtil_1 = require("../Deserialization/SchemaGraphUtil");
+const ECObjects_1 = require("../ECObjects");
+const Exception_1 = require("../Exception");
+const Schema_1 = require("../Metadata/Schema");
+const SchemaKey_1 = require("../SchemaKey");
+const SchemaLoadingController_1 = require("../utils/SchemaLoadingController");
+const IncrementalSchemaReader_1 = require("./IncrementalSchemaReader");
+/**
+ * A [[ISchemaLocater]] implementation for locating and retrieving EC [[Schema]]
+ * objects incrementally instead of the full schema and it's references at once. This is useful for large schemas that
+ * take a long time to load, but clients need a rough skeleton of the schema as fast as possible.
+ *
+ * The IncrementalSchemaLocater is a locater around the [[IncrementalSchemaLocater]] to be used in a
+ * [[SchemaContext]].
+ * @internal
+ */
+class IncrementalSchemaLocater {
+    _options;
+    _schemaInfoCache;
+    /**
+     * Initializes a new instance of the IncrementalSchemaLocater class.
+     * @param options  The [[SchemaLocaterOptions]] that control the loading of the schema.
+     */
+    constructor(options) {
+        this._options = options || {};
+        this._schemaInfoCache = new SchemaInfoCache(async (context) => {
+            return this.loadSchemaInfos(context);
+        });
+    }
+    /** Gets the options how the schema locater load the schemas. */
+    get options() {
+        return this._options;
+    }
+    /**
+     * Gets the [[SchemaInfo]] which matches the provided SchemaKey.  The SchemaInfo may be returned
+     * before the schema is fully loaded. May return the entire Schema so long as it is completely loaded as it satisfies
+     * the SchemaInfo interface.
+     * @param schemaKey   The [[SchemaKey]] to look up.
+     * @param matchType   The [[SchemaMatchType]] to use against candidate schemas.
+     * @param context     The [[SchemaContext]] for loading schema references.
+     */
+    async getSchemaInfo(schemaKey, matchType, context) {
+        return this._schemaInfoCache.lookup(schemaKey, matchType, context);
+    }
+    /**
+     * Attempts to get a [[Schema]] from the locater. Yields undefined if no matching schema is found.
+     * For schemas that may have references, construct and call through a SchemaContext instead.
+     * @param schemaKey   The [[SchemaKey]] to look up.
+     * @param matchType   The [[SchemaMatchType]] to use against candidate schemas.
+     * @param context     The [[SchemaContext]] for loading schema references.
+     */
+    async getSchema(schemaKey, matchType, context) {
+        const schemaInfo = await this.getSchemaInfo(schemaKey, matchType, context);
+        return schemaInfo
+            ? this.loadSchema(schemaInfo, context)
+            : undefined;
+    }
+    /**
+     * Attempts to get a [[Schema]] from the locater. Yields undefined if no matching schema is found.
+     * For schemas that may have references, construct and call through a SchemaContext instead.
+     * NOT IMPLEMENTED IN THIS LOCATER - ALWAYS RETURNS UNDEFINED.
+     * @param schemaKey   The [[SchemaKey]] to look up.
+     * @param matchType   The [[SchemaMatchType]] to use against candidate schemas.
+     * @param context     The [[SchemaContext]] for loading schema references.
+     * @returns           Incremental schema loading does not work synchronously, this will always return undefined.
+     */
+    getSchemaSync(_schemaKey, _matchType, _context) {
+        return undefined;
+    }
+    /**
+     * Start loading the schema for the given schema info incrementally. The schema is returned
+     * as soon as the schema stub is loaded while the schema fully resolves in the background. It should
+     * only be called by the IncrementalSchemaLocater if a schema has not been loaded or started to
+     * load yet.
+     * @param schemaInfo    The schema info of the schema to load.
+     * @param schemaContext The schema context to load the schema into.
+     */
+    async loadSchema(schemaInfo, schemaContext) {
+        // If the meta schema is an earlier version than 4.0.3, we can't use the ECSql query interface to get the schema
+        // information required to load the schema entirely. In this case, we fallback to use the ECSchema RPC interface
+        // to fetch the whole schema json.
+        if (!await this.supportPartialSchemaLoading(schemaContext)) {
+            const schemaJson = await this.getSchemaJson(schemaInfo.schemaKey, schemaContext);
+            return Schema_1.Schema.fromJson(schemaJson, schemaContext);
+        }
+        // Fetches the schema partials for the given schema key. The first item in the array is the
+        // actual schema props of the schema to load, the following items are schema props of referenced
+        // schema items that are needed to resolve the schema properly.
+        const schemaPartials = await this.getSchemaPartials(schemaInfo.schemaKey, schemaContext);
+        if (schemaPartials === undefined)
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.UnableToLocateSchema, `Could not locate the schema, ${schemaInfo.schemaKey.name}.${schemaInfo.schemaKey.version.toString()}`);
+        // Sort the partials in dependency order to ensure referenced schemas exist in the schema context
+        // when they get requested. Otherwise the context would call this method again and for referenced
+        // schemas, we would not want to request the whole schema props.
+        const sortedPartials = await this.sortSchemaPartials(schemaPartials, schemaContext);
+        for (const schemaProps of sortedPartials) {
+            await this.startLoadingPartialSchema(schemaProps, schemaContext);
+        }
+        const schema = await schemaContext.getCachedSchema(schemaInfo.schemaKey);
+        if (!schema)
+            throw new Error(`Schema ${schemaInfo.schemaKey.name} could not be found.`);
+        return schema;
+    }
+    /**
+     * Creates a SchemaProps object by loading the Schema information from the given SchemaContext.
+     * @param schemaKey The SchemaKey of the Schema whose props are to be retrieved.
+     * @param schemaContext The SchemaContext holding the Schema.
+     * @returns The SchemaProps object.
+     */
+    async createSchemaProps(schemaKey, schemaContext) {
+        const schemaInfo = await schemaContext.getSchemaInfo(schemaKey, ECObjects_1.SchemaMatchType.Latest);
+        if (!schemaInfo)
+            throw new Error(`Schema ${schemaKey.name} could not be found.`);
+        const schemaProps = {
+            $schema: Constants_1.ECSchemaNamespaceUris.SCHEMAURL3_2_JSON,
+            name: schemaKey.name,
+            alias: schemaInfo.alias,
+            version: schemaInfo.schemaKey.version.toString(),
+            references: [],
+            items: {}
+        };
+        if (!schemaProps.references)
+            throw new Error(`Schema references is undefined for the Schema ${schemaInfo.schemaKey.name}`);
+        schemaInfo.references.forEach((ref) => {
+            schemaProps.references.push({ name: ref.schemaKey.name, version: ref.schemaKey.version.toString() });
+        });
+        return schemaProps;
+    }
+    async startLoadingPartialSchema(schemaProps, schemaContext) {
+        if (schemaContext.schemaExists(SchemaKey_1.SchemaKey.parseString(`${schemaProps.name}.${schemaProps.version}`))) {
+            return;
+        }
+        const controller = new SchemaLoadingController_1.SchemaLoadingController();
+        const schemaReader = new IncrementalSchemaReader_1.IncrementalSchemaReader(schemaContext, true);
+        const schema = new Schema_1.Schema(schemaContext);
+        schema.setLoadingController(controller);
+        await schemaReader.readSchema(schema, schemaProps);
+        if (!this._options.loadPartialSchemaOnly)
+            controller.start(this.startLoadingFullSchema(schema));
+    }
+    async loadFullSchema(schema) {
+        const fullSchemaProps = await this.getSchemaJson(schema.schemaKey, schema.context);
+        const reader = new IncrementalSchemaReader_1.IncrementalSchemaReader(schema.context, false);
+        await reader.readSchema(schema, fullSchemaProps, false);
+    }
+    async startLoadingFullSchema(schema) {
+        if (!schema.loadingController)
+            return;
+        // If the schema is already resolved, return it directly.
+        if (schema.loadingController.isComplete || schema.loadingController.inProgress) {
+            return;
+        }
+        // Since the schema relies on it's references, they get triggered to be resolved
+        // first by recursively calling this method. After all references has been resolved
+        // the schema itself gets resolved.
+        await Promise.all(schema.references.map(async (referenceSchema) => {
+            if (referenceSchema.loadingController && referenceSchema.loadingController.inProgress)
+                return referenceSchema.loadingController.wait();
+            else
+                return this.startLoadingFullSchema(referenceSchema);
+        }));
+        return this.loadFullSchema(schema);
+    }
+    async sortSchemaPartials(schemaPartials, schemaContext) {
+        const schemaInfos = [];
+        for (const schemaProps of schemaPartials) {
+            const schemaKey = SchemaKey_1.SchemaKey.parseString(`${schemaProps.name}.${schemaProps.version}`);
+            const schemaInfo = await schemaContext.getSchemaInfo(schemaKey, ECObjects_1.SchemaMatchType.Latest);
+            if (!schemaInfo)
+                throw new Error(`Schema ${schemaKey.name} could not be found.`);
+            schemaInfos.push({ ...schemaInfo, props: schemaProps });
+        }
+        const orderedSchemaInfos = SchemaGraphUtil_1.SchemaGraphUtil.buildDependencyOrderedSchemaInfoList(schemaInfos);
+        return orderedSchemaInfos.map((schemaInfo) => schemaInfo.props);
+    }
+}
+exports.IncrementalSchemaLocater = IncrementalSchemaLocater;
+/**
+ * Helper class to manage schema infos for a schema context.
+ */
+class SchemaInfoCache {
+    _schemaInfoCache;
+    _schemaInfoLoader;
+    constructor(schemaInfoLoader) {
+        this._schemaInfoCache = new WeakMap();
+        this._schemaInfoLoader = schemaInfoLoader;
+    }
+    async getSchemasByContext(context) {
+        if (!this._schemaInfoCache.has(context)) {
+            const schemaInfos = await this._schemaInfoLoader(context);
+            this._schemaInfoCache.set(context, Array.from(schemaInfos));
+        }
+        return this._schemaInfoCache.get(context);
+    }
+    async lookup(schemaKey, matchType, context) {
+        const contextSchemaInfos = await this.getSchemasByContext(context);
+        return contextSchemaInfos
+            ? contextSchemaInfos.find((schemaInfo) => schemaInfo.schemaKey.matches(schemaKey, matchType))
+            : undefined;
+    }
+    remove(schemaKey, context) {
+        const contextSchemaInfos = this._schemaInfoCache.get(context);
+        if (!contextSchemaInfos)
+            return;
+        const index = contextSchemaInfos.findIndex((schemaInfo) => schemaInfo.schemaKey.name === schemaKey.name);
+        if (index !== -1) {
+            contextSchemaInfos.splice(index, 1);
+        }
+    }
+}
+//# sourceMappingURL=IncrementalSchemaLocater.js.map

package/lib/cjs/IncrementalLoading/IncrementalSchemaLocater.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncrementalSchemaLocater.js","sourceRoot":"","sources":["../../../src/IncrementalLoading/IncrementalSchemaLocater.ts"],"names":[],"mappings":";;;AAAA;;;gGAGgG;AAChG,4CAAqD;AAGrD,wEAAqE;AACrE,4CAA+C;AAC/C,4CAA6D;AAE7D,+CAA4C;AAC5C,4CAAyC;AACzC,8EAA2E;AAC3E,uEAAoE;AAcpE;;;;;;;;GAQG;AACH,MAAsB,wBAAwB;IAC3B,QAAQ,CAAuB;IAC/B,gBAAgB,CAAkB;IAEnD;;;OAGG;IACH,YAAY,OAA8B;QACxC,IAAI,CAAC,QAAQ,GAAG,OAAO,IAAI,EAAE,CAAC;QAE9B,IAAI,CAAC,gBAAgB,GAAG,IAAI,eAAe,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YAC5D,OAAO,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gEAAgE;IAChE,IAAc,OAAO;QACnB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QACjG,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC7F,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAC3E,OAAO,UAAU;YACf,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC;YACtC,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAED;;;;;;;;OAQG;IACI,aAAa,CAAC,UAA+B,EAAE,UAA2B,EAAE,QAAuB;QACxG,OAAO,SAAS,CAAC;IACnB,CAAC;IAgCD;;;;;;;OAOG;IACI,KAAK,CAAC,UAAU,CAAC,UAAsB,EAAE,aAA4B;QAC1E,gHAAgH;QAChH,gHAAgH;QAChH,kCAAkC;QAClC,IAAI,CAAC,MAAM,IAAI,CAAC,2BAA2B,CAAC,aAAa,CAAC,EAAE,CAAC;YAC3D,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;YACjF,OAAO,eAAM,CAAC,QAAQ,CAAC,UAAW,EAAE,aAAa,CAAC,CAAC;QACrD,CAAC;QAED,2FAA2F;QAC3F,gGAAgG;QAChG,+DAA+D;QAC/D,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACzF,IAAI,cAAc,KAAK,SAAS;YAC9B,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,oBAAoB,EAAE,gCAAgC,UAAU,CAAC,SAAS,CAAC,IAAI,IAAI,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAEvK,iGAAiG;QACjG,iGAAiG;QACjG,gEAAgE;QAChE,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC;QACpF,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;YACzC,MAAM,IAAI,CAAC,yBAAyB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QACnE,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,eAAe,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QACzE,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,KAAK,CAAC,UAAU,UAAU,CAAC,SAAS,CAAC,IAAI,sBAAsB,CAAC,CAAC;QAE7E,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,iBAAiB,CAAC,SAAoB,EAAE,aAA4B;QAClF,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,CAAC;QACxF,IAAI,CAAC,UAAU;YACb,MAAM,IAAI,KAAK,CAAC,UAAU,SAAS,CAAC,IAAI,sBAAsB,CAAC,CAAC;QAClE,MAAM,WAAW,GAAgB;YAC/B,OAAO,EAAE,iCAAqB,CAAC,iBAAiB;YAChD,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,KAAK,EAAE,UAAU,CAAC,KAAK;YACvB,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE;YAChD,UAAU,EAAE,EAAE;YACd,KAAK,EAAE,EAAE;SACV,CAAC;QAEF,IAAI,CAAC,WAAW,CAAC,UAAU;YACzB,MAAM,IAAI,KAAK,CAAC,iDAAiD,UAAU,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;QAEhG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACpC,WAAW,CAAC,UAAW,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACxG,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,yBAAyB,CAAC,WAAwB,EAAE,aAA4B;QAC5F,IAAI,aAAa,CAAC,YAAY,CAAC,qBAAS,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC;YACpG,OAAO;QACT,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,iDAAuB,EAAE,CAAC;QACjD,MAAM,YAAY,GAAG,IAAI,iDAAuB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC,aAAa,CAAC,CAAC;QACzC,MAAM,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAExC,MAAM,YAAY,CAAC,UAAU,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,qBAAqB;YACtC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC1D,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,MAAc;QACzC,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;QAClF,MAAM,MAAM,GAAG,IAAI,iDAAuB,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAClE,MAAM,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,eAAe,EAAE,KAAK,CAAC,CAAC;IAC1D,CAAC;IAEO,KAAK,CAAC,sBAAsB,CAAC,MAAc;QACjD,IAAI,CAAC,MAAM,CAAC,iBAAiB;YAC3B,OAAO;QAET,yDAAyD;QACzD,IAAI,MAAM,CAAC,iBAAiB,CAAC,UAAU,IAAI,MAAM,CAAC,iBAAiB,CAAC,UAAU,EAAE,CAAC;YAC/E,OAAO;QACT,CAAC;QAED,gFAAgF;QAChF,mFAAmF;QACnF,mCAAmC;QACnC,MAAM,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,eAAe,EAAE,EAAE;YAChE,IAAI,eAAe,CAAC,iBAAiB,IAAI,eAAe,CAAC,iBAAiB,CAAC,UAAU;gBACnF,OAAO,eAAe,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC;;gBAEhD,OAAO,IAAI,CAAC,sBAAsB,CAAC,eAAe,CAAC,CAAC;QACxD,CAAC,CAAC,CAAC,CAAC;QAEJ,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,cAA0C,EAAE,aAA4B;QACvG,MAAM,WAAW,GAA+C,EAAE,CAAC;QACnE,KAAK,MAAM,WAAW,IAAI,cAAc,EAAE,CAAC;YACzC,MAAM,SAAS,GAAG,qBAAS,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC;YACtF,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,aAAa,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,CAAC;YACxF,IAAI,CAAC,UAAU;gBACb,MAAM,IAAI,KAAK,CAAC,UAAU,SAAS,CAAC,IAAI,sBAAsB,CAAC,CAAC;YAElE,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,kBAAkB,GAAG,iCAAe,CAAC,oCAAoC,CAAC,WAAW,CAA+C,CAAC;QAC3I,OAAO,kBAAkB,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAClE,CAAC;CACF;AAxND,4DAwNC;AAED;;GAEG;AACH,MAAM,eAAe;IACF,gBAAgB,CAA4C;IAC5D,iBAAiB,CAAwB;IAE1D,YAAY,gBAAuC;QACjD,IAAI,CAAC,gBAAgB,GAAG,IAAI,OAAO,EAAoC,CAAC;QACxE,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,OAAsB;QACrD,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACxC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAC1D,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,SAA0B,EAAE,OAAsB;QAC1F,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACnE,OAAO,kBAAkB;YACvB,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YAC7F,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAEM,MAAM,CAAC,SAAoB,EAAE,OAAsB;QACxD,MAAM,kBAAkB,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9D,IAAI,CAAC,kBAAkB;YACrB,OAAO;QAET,MAAM,KAAK,GAAG,kBAAkB,CAAC,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,CAAC;QACzG,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,kBAAkB,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACtC,CAAC;IACH,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 *--------------------------------------------------------------------------------------------*/\nimport { ECSchemaNamespaceUris } from \"../Constants\";\nimport { ISchemaLocater, SchemaContext } from \"../Context\";\nimport { SchemaProps } from \"../Deserialization/JsonProps\";\nimport { SchemaGraphUtil } from \"../Deserialization/SchemaGraphUtil\";\nimport { SchemaMatchType } from \"../ECObjects\";\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\nimport { SchemaInfo } from \"../Interfaces\";\nimport { Schema } from \"../Metadata/Schema\";\nimport { SchemaKey } from \"../SchemaKey\";\nimport { SchemaLoadingController } from \"../utils/SchemaLoadingController\";\nimport { IncrementalSchemaReader } from \"./IncrementalSchemaReader\";\n\ntype LoadSchemaInfoHandler = (context: SchemaContext) => Promise<Iterable<SchemaInfo>>;\n\n/**\n * Defines the SchemaLocater Options which determine how each schema is to be loaded.\n * All options are optional.\n * @beta\n */\nexport interface SchemaLocaterOptions {\n  /** Only load partial schemas. Full schema information will not be retrieved. Defaults to false. */\n  readonly loadPartialSchemaOnly?: boolean;\n}\n\n/**\n * A [[ISchemaLocater]] implementation for locating and retrieving EC [[Schema]]\n * objects incrementally instead of the full schema and it's references at once. This is useful for large schemas that\n * take a long time to load, but clients need a rough skeleton of the schema as fast as possible.\n *\n * The IncrementalSchemaLocater is a locater around the [[IncrementalSchemaLocater]] to be used in a\n * [[SchemaContext]].\n * @internal\n */\nexport abstract class IncrementalSchemaLocater implements ISchemaLocater {\n  private readonly _options: SchemaLocaterOptions;\n  private readonly _schemaInfoCache: SchemaInfoCache;\n\n  /**\n   * Initializes a new instance of the IncrementalSchemaLocater class.\n   * @param options  The [[SchemaLocaterOptions]] that control the loading of the schema.\n   */\n  constructor(options?: SchemaLocaterOptions) {\n    this._options = options || {};\n\n    this._schemaInfoCache = new SchemaInfoCache(async (context) => {\n      return this.loadSchemaInfos(context);\n    });\n  }\n\n  /** Gets the options how the schema locater load the schemas. */\n  protected get options(): SchemaLocaterOptions {\n    return this._options;\n  }\n\n  /**\n   * Gets the [[SchemaInfo]] which matches the provided SchemaKey.  The SchemaInfo may be returned\n   * before the schema is fully loaded. May return the entire Schema so long as it is completely loaded as it satisfies\n   * the SchemaInfo interface.\n   * @param schemaKey   The [[SchemaKey]] to look up.\n   * @param matchType   The [[SchemaMatchType]] to use against candidate schemas.\n   * @param context     The [[SchemaContext]] for loading schema references.\n   */\n  public async getSchemaInfo(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    return this._schemaInfoCache.lookup(schemaKey, matchType, context);\n  }\n\n  /**\n   * Attempts to get a [[Schema]] from the locater. Yields undefined if no matching schema is found.\n   * For schemas that may have references, construct and call through a SchemaContext instead.\n   * @param schemaKey   The [[SchemaKey]] to look up.\n   * @param matchType   The [[SchemaMatchType]] to use against candidate schemas.\n   * @param context     The [[SchemaContext]] for loading schema references.\n   */\n  public async getSchema(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined> {\n    const schemaInfo = await this.getSchemaInfo(schemaKey, matchType, context);\n    return schemaInfo\n      ? this.loadSchema(schemaInfo, context)\n      : undefined;\n  }\n\n  /**\n   * Attempts to get a [[Schema]] from the locater. Yields undefined if no matching schema is found.\n   * For schemas that may have references, construct and call through a SchemaContext instead.\n   * NOT IMPLEMENTED IN THIS LOCATER - ALWAYS RETURNS UNDEFINED.\n   * @param schemaKey   The [[SchemaKey]] to look up.\n   * @param matchType   The [[SchemaMatchType]] to use against candidate schemas.\n   * @param context     The [[SchemaContext]] for loading schema references.\n   * @returns           Incremental schema loading does not work synchronously, this will always return undefined.\n   */\n  public getSchemaSync(_schemaKey: Readonly<SchemaKey>, _matchType: SchemaMatchType, _context: SchemaContext): Schema | undefined {\n    return undefined;\n  }\n\n  /**\n   * Gets the schema partials for the given schema key. The first item in the array is the\n   * actual schema props of the schema to load, the following items are partial schema props\n   * of referenced schemas.\n   * @param schemaKey   The schema key of the requested schema.\n   * @param context     The schema context.\n   */\n  protected abstract getSchemaPartials(schemaKey: SchemaKey, context: SchemaContext): Promise<ReadonlyArray<SchemaProps> | undefined>;\n\n  /**\n   * Gets the full schema json for the requested schema key.\n   * @param schemaKey   The schema key of the requested schema.\n   * @param context     The schema context.\n   */\n  protected abstract getSchemaJson(schemaKey: SchemaKey, context: SchemaContext): Promise<SchemaProps | undefined>;\n\n  /**\n   * Loads the schema info objects for the given context.\n   * @param context   The schema context to load the schema infos for.\n   * @returns         A promise that resolves to an iterable of schema infos.\n   */\n  public abstract loadSchemaInfos(context: SchemaContext): Promise<Iterable<SchemaInfo>>;\n\n  /**\n   * Checks if the context contains the right schemas to support incremental schema loading.\n   * @param context   The schema context to check.\n   * @returns         true if incremental schema loading is supported, false otherwise.\n   */\n  protected abstract supportPartialSchemaLoading(context: SchemaContext): Promise<boolean>;\n\n  /**\n   * Start loading the schema for the given schema info incrementally. The schema is returned\n   * as soon as the schema stub is loaded while the schema fully resolves in the background. It should\n   * only be called by the IncrementalSchemaLocater if a schema has not been loaded or started to\n   * load yet.\n   * @param schemaInfo    The schema info of the schema to load.\n   * @param schemaContext The schema context to load the schema into.\n   */\n  public async loadSchema(schemaInfo: SchemaInfo, schemaContext: SchemaContext): Promise<Schema> {\n    // If the meta schema is an earlier version than 4.0.3, we can't use the ECSql query interface to get the schema\n    // information required to load the schema entirely. In this case, we fallback to use the ECSchema RPC interface\n    // to fetch the whole schema json.\n    if (!await this.supportPartialSchemaLoading(schemaContext)) {\n      const schemaJson = await this.getSchemaJson(schemaInfo.schemaKey, schemaContext);\n      return Schema.fromJson(schemaJson!, schemaContext);\n    }\n\n    // Fetches the schema partials for the given schema key. The first item in the array is the\n    // actual schema props of the schema to load, the following items are schema props of referenced\n    // schema items that are needed to resolve the schema properly.\n    const schemaPartials = await this.getSchemaPartials(schemaInfo.schemaKey, schemaContext);\n    if (schemaPartials === undefined)\n      throw new ECSchemaError(ECSchemaStatus.UnableToLocateSchema, `Could not locate the schema, ${schemaInfo.schemaKey.name}.${schemaInfo.schemaKey.version.toString()}`);\n\n    // Sort the partials in dependency order to ensure referenced schemas exist in the schema context\n    // when they get requested. Otherwise the context would call this method again and for referenced\n    // schemas, we would not want to request the whole schema props.\n    const sortedPartials = await this.sortSchemaPartials(schemaPartials, schemaContext);\n    for (const schemaProps of sortedPartials) {\n      await this.startLoadingPartialSchema(schemaProps, schemaContext);\n    }\n\n    const schema = await schemaContext.getCachedSchema(schemaInfo.schemaKey);\n    if (!schema)\n      throw new Error(`Schema ${schemaInfo.schemaKey.name} could not be found.`);\n\n    return schema;\n  }\n\n  /**\n   * Creates a SchemaProps object by loading the Schema information from the given SchemaContext.\n   * @param schemaKey The SchemaKey of the Schema whose props are to be retrieved.\n   * @param schemaContext The SchemaContext holding the Schema.\n   * @returns The SchemaProps object.\n   */\n  protected async createSchemaProps(schemaKey: SchemaKey, schemaContext: SchemaContext): Promise<SchemaProps> {\n    const schemaInfo = await schemaContext.getSchemaInfo(schemaKey, SchemaMatchType.Latest);\n    if (!schemaInfo)\n      throw new Error(`Schema ${schemaKey.name} could not be found.`);\n    const schemaProps: SchemaProps = {\n      $schema: ECSchemaNamespaceUris.SCHEMAURL3_2_JSON,\n      name: schemaKey.name,\n      alias: schemaInfo.alias,\n      version: schemaInfo.schemaKey.version.toString(),\n      references: [],\n      items: {}\n    };\n\n    if (!schemaProps.references)\n      throw new Error(`Schema references is undefined for the Schema ${schemaInfo.schemaKey.name}`);\n\n    schemaInfo.references.forEach((ref) => {\n      schemaProps.references!.push({ name: ref.schemaKey.name, version: ref.schemaKey.version.toString() });\n    });\n\n    return schemaProps;\n  }\n\n  private async startLoadingPartialSchema(schemaProps: SchemaProps, schemaContext: SchemaContext): Promise<void> {\n    if (schemaContext.schemaExists(SchemaKey.parseString(`${schemaProps.name}.${schemaProps.version}`))) {\n      return;\n    }\n\n    const controller = new SchemaLoadingController();\n    const schemaReader = new IncrementalSchemaReader(schemaContext, true);\n    const schema = new Schema(schemaContext);\n    schema.setLoadingController(controller);\n\n    await schemaReader.readSchema(schema, schemaProps);\n\n    if (!this._options.loadPartialSchemaOnly)\n      controller.start(this.startLoadingFullSchema(schema));\n  }\n\n  private async loadFullSchema(schema: Schema): Promise<void> {\n    const fullSchemaProps = await this.getSchemaJson(schema.schemaKey, schema.context)\n    const reader = new IncrementalSchemaReader(schema.context, false);\n    await reader.readSchema(schema, fullSchemaProps, false);\n  }\n\n  private async startLoadingFullSchema(schema: Schema): Promise<void> {\n    if (!schema.loadingController)\n      return;\n\n    // If the schema is already resolved, return it directly.\n    if (schema.loadingController.isComplete || schema.loadingController.inProgress) {\n      return;\n    }\n\n    // Since the schema relies on it's references, they get triggered to be resolved\n    // first by recursively calling this method. After all references has been resolved\n    // the schema itself gets resolved.\n    await Promise.all(schema.references.map(async (referenceSchema) => {\n      if (referenceSchema.loadingController && referenceSchema.loadingController.inProgress)\n        return referenceSchema.loadingController.wait();\n      else\n        return this.startLoadingFullSchema(referenceSchema);\n    }));\n\n    return this.loadFullSchema(schema);\n  }\n\n  private async sortSchemaPartials(schemaPartials: ReadonlyArray<SchemaProps>, schemaContext: SchemaContext): Promise<ReadonlyArray<SchemaProps>> {\n    const schemaInfos: Array<SchemaInfo & { props: SchemaProps }> = [];\n    for (const schemaProps of schemaPartials) {\n      const schemaKey = SchemaKey.parseString(`${schemaProps.name}.${schemaProps.version}`);\n      const schemaInfo = await schemaContext.getSchemaInfo(schemaKey, SchemaMatchType.Latest);\n      if (!schemaInfo)\n        throw new Error(`Schema ${schemaKey.name} could not be found.`);\n\n      schemaInfos.push({ ...schemaInfo, props: schemaProps });\n    }\n\n    const orderedSchemaInfos = SchemaGraphUtil.buildDependencyOrderedSchemaInfoList(schemaInfos) as Array<SchemaInfo & { props: SchemaProps }>;\n    return orderedSchemaInfos.map((schemaInfo) => schemaInfo.props);\n  }\n}\n\n/**\n * Helper class to manage schema infos for a schema context.\n */\nclass SchemaInfoCache {\n  private readonly _schemaInfoCache: WeakMap<SchemaContext, Array<SchemaInfo>>;\n  private readonly _schemaInfoLoader: LoadSchemaInfoHandler;\n\n  constructor(schemaInfoLoader: LoadSchemaInfoHandler) {\n    this._schemaInfoCache = new WeakMap<SchemaContext, Array<SchemaInfo>>();\n    this._schemaInfoLoader = schemaInfoLoader;\n  }\n\n  public async getSchemasByContext(context: SchemaContext): Promise<SchemaInfo[] | undefined> {\n    if (!this._schemaInfoCache.has(context)) {\n      const schemaInfos = await this._schemaInfoLoader(context);\n      this._schemaInfoCache.set(context, Array.from(schemaInfos));\n    }\n    return this._schemaInfoCache.get(context);\n  }\n\n  public async lookup(schemaKey: SchemaKey, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined> {\n    const contextSchemaInfos = await this.getSchemasByContext(context);\n    return contextSchemaInfos\n      ? contextSchemaInfos.find((schemaInfo) => schemaInfo.schemaKey.matches(schemaKey, matchType))\n      : undefined;\n  }\n\n  public remove(schemaKey: SchemaKey, context: SchemaContext): void {\n    const contextSchemaInfos = this._schemaInfoCache.get(context);\n    if (!contextSchemaInfos)\n      return;\n\n    const index = contextSchemaInfos.findIndex((schemaInfo) => schemaInfo.schemaKey.name === schemaKey.name);\n    if (index !== -1) {\n      contextSchemaInfos.splice(index, 1);\n    }\n  }\n}\n"]}

package/lib/cjs/IncrementalLoading/IncrementalSchemaReader.d.ts

@@ -0,0 +1,36 @@
+import { SchemaContext } from "../Context";
+import { SchemaReadHelper } from "../Deserialization/Helper";
+import { Schema } from "../Metadata/Schema";
+import { SchemaItem } from "../Metadata/SchemaItem";
+/**
+ * Internal helper class to read schema information incrementally. It's based on the [[SchemaReadHelper]]
+ * but overrides a few methods to support the incremental schema loading case.
+ * @internal
+ */
+export declare class IncrementalSchemaReader extends SchemaReadHelper {
+    private readonly _incremental;
+    /**
+     * Initializes a new [[IncrementalSchemaReader]] instance.
+     * @param schemaContext The [[SchemaContext]] used to load the schemas.
+     * @param incremental Indicates that the Schema should be read incrementally.
+     * Pass false to load the full schema without an incremental/partial load.
+     */
+    constructor(schemaContext: SchemaContext, incremental: boolean);
+    /**
+     * Indicates that a given [[SchemaItem]] has been fully loaded.
+     * @param schemaItem The SchemaItem to check.
+     * @returns True if the item has been loaded, false if still in progress.
+     */
+    protected isSchemaItemLoaded(schemaItem: SchemaItem | undefined): boolean;
+    /**
+     * Starts loading the [[SchemaItem]] identified by the given name and itemType.
+     * @param schema The [[Schema]] that contains the SchemaItem.
+     * @param name The name of the SchemaItem to load.
+     * @param itemType The SchemaItem type name of the item to load.
+     * @param schemaItemObject The object accepting the SchemaItem data.
+     * @returns A promise that resolves to the loaded SchemaItem instance. Can be undefined.
+     */
+    loadSchemaItem(schema: Schema, name: string, itemType: string, schemaItemObject: Readonly<unknown>): Promise<SchemaItem | undefined>;
+    private schemaItemLoading;
+}
+//# sourceMappingURL=IncrementalSchemaReader.d.ts.map

package/lib/cjs/IncrementalLoading/IncrementalSchemaReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncrementalSchemaReader.d.ts","sourceRoot":"","sources":["../../../src/IncrementalLoading/IncrementalSchemaReader.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAI7D,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AAGpD;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAU;IAEvC;;;;;OAKG;gBACS,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,OAAO;IAK9D;;;;OAIG;cACgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,GAAG,OAAO;IAMlF;;;;;;;OAOG;IACmB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAkB1J,OAAO,CAAC,iBAAiB;CAgB1B"}

package/lib/cjs/IncrementalLoading/IncrementalSchemaReader.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IncrementalSchemaReader = void 0;
+const Helper_1 = require("../Deserialization/Helper");
+const JsonParser_1 = require("../Deserialization/JsonParser");
+const ECObjects_1 = require("../ECObjects");
+const Class_1 = require("../Metadata/Class");
+const SchemaItem_1 = require("../Metadata/SchemaItem");
+const SchemaLoadingController_1 = require("../utils/SchemaLoadingController");
+/**
+ * Internal helper class to read schema information incrementally. It's based on the [[SchemaReadHelper]]
+ * but overrides a few methods to support the incremental schema loading case.
+ * @internal
+ */
+class IncrementalSchemaReader extends Helper_1.SchemaReadHelper {
+    _incremental;
+    /**
+     * Initializes a new [[IncrementalSchemaReader]] instance.
+     * @param schemaContext The [[SchemaContext]] used to load the schemas.
+     * @param incremental Indicates that the Schema should be read incrementally.
+     * Pass false to load the full schema without an incremental/partial load.
+     */
+    constructor(schemaContext, incremental) {
+        super(JsonParser_1.JsonParser, schemaContext);
+        this._incremental = incremental;
+    }
+    /**
+     * Indicates that a given [[SchemaItem]] has been fully loaded.
+     * @param schemaItem The SchemaItem to check.
+     * @returns True if the item has been loaded, false if still in progress.
+     */
+    isSchemaItemLoaded(schemaItem) {
+        return schemaItem !== undefined
+            && schemaItem.loadingController !== undefined
+            && schemaItem.loadingController.isComplete;
+    }
+    /**
+     * Starts loading the [[SchemaItem]] identified by the given name and itemType.
+     * @param schema The [[Schema]] that contains the SchemaItem.
+     * @param name The name of the SchemaItem to load.
+     * @param itemType The SchemaItem type name of the item to load.
+     * @param schemaItemObject The object accepting the SchemaItem data.
+     * @returns A promise that resolves to the loaded SchemaItem instance. Can be undefined.
+     */
+    async loadSchemaItem(schema, name, itemType, schemaItemObject) {
+        const schemaItem = await super.loadSchemaItem(schema, name, itemType, this._incremental ? undefined : schemaItemObject);
+        // In incremental mode, we only load the stubs of the classes. These include the modifier and base classes.
+        // The fromJSON method of the actual class instances may complain about missing properties in the props, so
+        // calling the fromJSON on the ECClass ensures only the bare minimum is loaded.
+        if (this._incremental && schemaItemObject && schemaItem) {
+            if (schemaItem.schemaItemType === ECObjects_1.SchemaItemType.KindOfQuantity) {
+                SchemaItem_1.SchemaItem.prototype.fromJSONSync.call(schemaItem, schemaItemObject);
+            }
+            else {
+                schemaItem.fromJSONSync(schemaItemObject);
+            }
+        }
+        this.schemaItemLoading(schemaItem);
+        return schemaItem;
+    }
+    schemaItemLoading(schemaItem) {
+        if (schemaItem === undefined)
+            return;
+        if (schemaItem.loadingController === undefined) {
+            const controller = new SchemaLoadingController_1.SchemaLoadingController();
+            schemaItem.setLoadingController(controller);
+        }
+        if (Class_1.ECClass.isECClass(schemaItem)
+            || schemaItem.schemaItemType === ECObjects_1.SchemaItemType.KindOfQuantity
+            || schemaItem.schemaItemType === ECObjects_1.SchemaItemType.Format)
+            schemaItem.loadingController.isComplete = !this._incremental;
+        else
+            schemaItem.loadingController.isComplete = true;
+    }
+}
+exports.IncrementalSchemaReader = IncrementalSchemaReader;
+//# sourceMappingURL=IncrementalSchemaReader.js.map

package/lib/cjs/IncrementalLoading/IncrementalSchemaReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IncrementalSchemaReader.js","sourceRoot":"","sources":["../../../src/IncrementalLoading/IncrementalSchemaReader.ts"],"names":[],"mappings":";;;AAKA,sDAA6D;AAC7D,8DAA2D;AAC3D,4CAA8C;AAC9C,6CAA4C;AAE5C,uDAAoD;AACpD,8EAA2E;AAE3E;;;;GAIG;AACH,MAAa,uBAAwB,SAAQ,yBAAgB;IAC1C,YAAY,CAAU;IAEvC;;;;;OAKG;IACH,YAAY,aAA4B,EAAE,WAAoB;QAC5D,KAAK,CAAC,uBAAU,EAAE,aAAa,CAAC,CAAC;QACjC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACgB,kBAAkB,CAAC,UAAkC;QACtE,OAAO,UAAU,KAAK,SAAS;eAC1B,UAAU,CAAC,iBAAiB,KAAK,SAAS;eAC1C,UAAU,CAAC,iBAAiB,CAAC,UAAU,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACa,KAAK,CAAC,cAAc,CAAC,MAAc,EAAE,IAAY,EAAE,QAAgB,EAAE,gBAAmC;QACtH,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC;QAExH,2GAA2G;QAC3G,2GAA2G;QAC3G,+EAA+E;QAC/E,IAAI,IAAI,CAAC,YAAY,IAAI,gBAAgB,IAAI,UAAU,EAAE,CAAC;YACxD,IAAI,UAAU,CAAC,cAAc,KAAK,0BAAc,CAAC,cAAc,EAAE,CAAC;gBAChE,uBAAU,CAAC,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC;YACvE,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC;QAED,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;QACnC,OAAO,UAAU,CAAC;IACpB,CAAC;IAEO,iBAAiB,CAAC,UAAkC;QAC1D,IAAI,UAAU,KAAK,SAAS;YAC1B,OAAO;QAET,IAAI,UAAU,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAC/C,MAAM,UAAU,GAAG,IAAI,iDAAuB,EAAE,CAAC;YACjD,UAAU,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAC9C,CAAC;QAED,IAAI,eAAO,CAAC,SAAS,CAAC,UAAU,CAAC;eAC5B,UAAU,CAAC,cAAc,KAAK,0BAAc,CAAC,cAAc;eAC3D,UAAU,CAAC,cAAc,KAAK,0BAAc,CAAC,MAAM;YACtD,UAAU,CAAC,iBAAkB,CAAC,UAAU,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC;;YAE9D,UAAU,CAAC,iBAAkB,CAAC,UAAU,GAAG,IAAI,CAAC;IACpD,CAAC;CACF;AAnED,0DAmEC","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 *--------------------------------------------------------------------------------------------*/\nimport { SchemaContext } from \"../Context\";\nimport { SchemaReadHelper } from \"../Deserialization/Helper\";\nimport { JsonParser } from \"../Deserialization/JsonParser\";\nimport { SchemaItemType } from \"../ECObjects\";\nimport { ECClass } from \"../Metadata/Class\";\nimport { Schema } from \"../Metadata/Schema\";\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\nimport { SchemaLoadingController } from \"../utils/SchemaLoadingController\";\n\n/**\n * Internal helper class to read schema information incrementally. It's based on the [[SchemaReadHelper]]\n * but overrides a few methods to support the incremental schema loading case.\n * @internal\n */\nexport class IncrementalSchemaReader extends SchemaReadHelper {\n  private readonly _incremental: boolean;\n\n  /**\n   * Initializes a new [[IncrementalSchemaReader]] instance.\n   * @param schemaContext The [[SchemaContext]] used to load the schemas.\n   * @param incremental Indicates that the Schema should be read incrementally.\n   * Pass false to load the full schema without an incremental/partial load.\n   */\n  constructor(schemaContext: SchemaContext, incremental: boolean) {\n    super(JsonParser, schemaContext);\n    this._incremental = incremental;\n  }\n\n  /**\n   * Indicates that a given [[SchemaItem]] has been fully loaded.\n   * @param schemaItem The SchemaItem to check.\n   * @returns True if the item has been loaded, false if still in progress.\n   */\n  protected override isSchemaItemLoaded(schemaItem: SchemaItem | undefined): boolean {\n    return schemaItem !== undefined\n      && schemaItem.loadingController !== undefined\n      && schemaItem.loadingController.isComplete;\n  }\n\n  /**\n   * Starts loading the [[SchemaItem]] identified by the given name and itemType.\n   * @param schema The [[Schema]] that contains the SchemaItem.\n   * @param name The name of the SchemaItem to load.\n   * @param itemType The SchemaItem type name of the item to load.\n   * @param schemaItemObject The object accepting the SchemaItem data.\n   * @returns A promise that resolves to the loaded SchemaItem instance. Can be undefined.\n   */\n  public override async loadSchemaItem(schema: Schema, name: string, itemType: string, schemaItemObject: Readonly<unknown>): Promise<SchemaItem | undefined> {\n    const schemaItem = await super.loadSchemaItem(schema, name, itemType, this._incremental ? undefined : schemaItemObject);\n\n    // In incremental mode, we only load the stubs of the classes. These include the modifier and base classes.\n    // The fromJSON method of the actual class instances may complain about missing properties in the props, so\n    // calling the fromJSON on the ECClass ensures only the bare minimum is loaded.\n    if (this._incremental && schemaItemObject && schemaItem) {\n      if (schemaItem.schemaItemType === SchemaItemType.KindOfQuantity) {\n        SchemaItem.prototype.fromJSONSync.call(schemaItem, schemaItemObject);\n      } else {\n        schemaItem.fromJSONSync(schemaItemObject);\n      }\n    }\n\n    this.schemaItemLoading(schemaItem);\n    return schemaItem;\n  }\n\n  private schemaItemLoading(schemaItem: SchemaItem | undefined) {\n    if (schemaItem === undefined)\n      return;\n\n    if (schemaItem.loadingController === undefined) {\n      const controller = new SchemaLoadingController();\n      schemaItem.setLoadingController(controller);\n    }\n\n    if (ECClass.isECClass(schemaItem)\n      || schemaItem.schemaItemType === SchemaItemType.KindOfQuantity\n      || schemaItem.schemaItemType === SchemaItemType.Format)\n      schemaItem.loadingController!.isComplete = !this._incremental;\n    else\n      schemaItem.loadingController!.isComplete = true;\n  }\n}"]}

package/lib/cjs/IncrementalLoading/PerformanceLogger.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Contains the properties needed to track load times
+ * for SchemaItem queries.
+ * @internal
+ */
+export interface SchemaItemLoadData {
+    loadTime: number;
+    itemCount: number;
+}
+/**
+ * Contains the properties needed to track load times
+ * for Schema queries.
+ * @internal
+ */
+export interface SchemaLoadData {
+    loadTime?: number;
+    schemaItemMap: Map<string, SchemaItemLoadData>;
+}
+/**
+ * Utility class used to log query load times for Schema and
+ * SchemaItem queries.
+ * @internal
+ */
+export declare class PerformanceLogger {
+    private _iModelItems;
+    private _label;
+    disableLogging: boolean;
+    /**
+     * Initializes a new PerformanceLogger instance.
+     * @param label Arbitrary label used to tag this logging session (ex. IModel name)
+     */
+    constructor(label?: string);
+    /**
+     * Gets the Map of logged Schema entries. The Map key is the iModel name. The Map
+     * value is a second Map whose key is a Schema name and value is a SchemaLoadData
+     * object.
+     */
+    get logItems(): Map<string, Map<string, SchemaLoadData>>;
+    /**
+     * Adds a new log entry to the Schema Map.
+     * @param startTime The start time of the entry to be logged (end time/duration is handled in this method).
+     * @param schemaName The Schema being queried.
+     */
+    logSchema(startTime: number, schemaName: string): void;
+    /**
+     * Adds a new log entry to the SchemaItem Map.
+     * @param startTime The start time of the entry to be logged (end time/duration is handled in this method).
+     * @param schemaName The name of the Schema being queried.
+     * @param schemaItemType The SchemaItemType name of the type being queried.
+     * @param itemCount The number of items retrieved in the query.
+     */
+    logSchemaItem(startTime: number, schemaName: string, schemaItemType: string, itemCount: number): void;
+    /**
+     * Clears all log entries from the Map.
+     */
+    clearLogs(): void;
+    private getSchemaMap;
+    private getSchemaLoadData;
+}
+//# sourceMappingURL=PerformanceLogger.d.ts.map

package/lib/cjs/IncrementalLoading/PerformanceLogger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PerformanceLogger.d.ts","sourceRoot":"","sources":["../../../src/IncrementalLoading/PerformanceLogger.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;CAChD;AAED;;;;GAIG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,YAAY,CAAuD;IAC3E,OAAO,CAAC,MAAM,CAAS;IAGhB,cAAc,UAAS;IAE9B;;;OAGG;gBACS,KAAK,CAAC,EAAE,MAAM;IAI1B;;;;OAIG;IACH,IAAW,QAAQ,IAAI,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAE9D;IAED;;;;OAIG;IACI,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAYtD;;;;;;OAMG;IACI,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAerG;;OAEG;IACI,SAAS;IAIhB,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,iBAAiB;CAM1B"}