@itwin/ecschema-metadata 5.2.0-dev.8 → 5.3.0-dev.1

package/lib/esm/{SchemaFormatsProvider.js → Formatting/SchemaFormatsProvider.js}

@@ -5,13 +5,13 @@
 /** @packageDocumentation
  * @module Metadata
  */
-import { SchemaContext } from "./Context";
-import { SchemaItemKey, SchemaKey } from "./SchemaKey";
-import { SchemaItem } from "./Metadata/SchemaItem";
-import { Format } from "./Metadata/Format";
+import { SchemaContext } from "../Context";
+import { SchemaItemKey, SchemaKey } from "../SchemaKey";
+import { SchemaItem } from "../Metadata/SchemaItem";
+import { Format } from "../Metadata/Format";
 import { BeEvent, Logger } from "@itwin/core-bentley";
-import { KindOfQuantity } from "./Metadata/KindOfQuantity";
-import { getFormatProps } from "./Metadata/OverrideFormat";
+import { KindOfQuantity } from "../Metadata/KindOfQuantity";
+import { getFormatProps } from "../Metadata/OverrideFormat";
 const loggerCategory = "SchemaFormatsProvider";
 /**
  * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.

package/lib/esm/Formatting/SchemaFormatsProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchemaFormatsProvider.js","sourceRoot":"","sources":["../../../src/Formatting/SchemaFormatsProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAkB,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAM5D,MAAM,cAAc,GAAG,uBAAuB,CAAC;AAC/C;;;GAGG;AACH,MAAM,OAAO,qBAAqB;IACxB,QAAQ,CAAgB;IACxB,WAAW,CAAgB;IAC3B,iBAAiB,GAAgB,IAAI,GAAG,EAAE,CAAC;IAC5C,gBAAgB,GAAG,IAAI,OAAO,EAAsC,CAAC;IAC5E;;;;;;OAMG;IACH,YAAY,gBAAgC,EAAE,UAAyB;QACrE,IAAI,gBAAgB,YAAY,aAAa,EAAE,CAAC;YAC9C,IAAI,CAAC,QAAQ,GAAG,gBAAgB,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;IAChC,CAAC;IAED,IAAW,OAAO,KAAK,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,IAAW,UAAU,KAAK,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAEpD,IAAW,UAAU,CAAC,UAAyB;QAC7C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEO,KAAK;QACX,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC1D,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,CAAC;QAC/B,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC;IACvD,CAAC;IAED,0HAA0H;IAClH,yBAAyB,CAAC,MAA6B,EAAE,cAA8B;QAC7F,2CAA2C;QAC3C,6DAA6D;QAC7D,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,cAAc;QAC9E,6DAA6D;QAC7D,gBAAgB,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAE/F,OAAO;YACL,GAAG,IAAI;YACP,IAAI,EAAE,cAAc,CAAC,QAAQ;YAC7B,KAAK,EAAE,cAAc,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK;YAC3C,WAAW,EAAE,cAAc,CAAC,WAAW,IAAI,MAAM,CAAC,WAAW;SAC9D,CAAA;IACH,CAAC;IAEO,KAAK,CAAC,iCAAiC,CAAC,OAAsB;QACpE,IAAI,cAA0C,CAAC;QAC/C,IAAI,CAAC;YACH,cAAc,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QAC9E,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iCAAiC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;YACrF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,CAAC,cAAc,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,4EAA4E;QAC5E,MAAM,kBAAkB,GAAG,0BAA0B,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,MAAM,mBAAmB,GAAG,cAAc,CAAC,mBAAmB,CAAC;QAC/D,KAAK,MAAM,OAAO,IAAI,kBAAkB,EAAE,CAAC;YACzC,KAAK,MAAM,UAAU,IAAI,mBAAmB,EAAE,CAAC;gBAC7C,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC;gBAChC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBACxD,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,SAAS;gBACX,CAAC;gBACD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC;gBAChD,IAAI,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;oBACpD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC7C,MAAM,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;oBACrC,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;gBAC/D,CAAC;YACH,CAAC;QACH,CAAC;QAED,uGAAuG;QACvG,MAAM,eAAe,GAAG,MAAM,cAAc,CAAC,eAAe,CAAC;QAC7D,MAAM,qBAAqB,GAAG,MAAM,eAAe,EAAE,UAAU,CAAC;QAChE,IAAI,qBAAqB,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,EAAE,CAAC;YAClG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAC7C,MAAM,KAAK,GAAG,6BAA6B,CAAC,eAAgB,CAAC,CAAC;YAC9D,OAAO,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,aAAa,GAAG,cAAc,CAAC,yBAAyB,CAAC;QAC/D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAC7C,MAAM,YAAY,GAAG,cAAc,CAAC,MAAM,aAAa,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC,yBAAyB,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IACtE,CAAC;IAGD;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CAAC,IAAY;QACjC,MAAM,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACpE,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,MAA0B,CAAC;QAC/B,IAAI,CAAC;YACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,UAAU,EAAE,CAAC,CAAC;YACvE,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,aAAa,CAAC,cAAc,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QAEpE,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9B,IAAI,MAA0B,CAAC;YAC/B,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAC9D,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,yBAAyB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC7E,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC,iCAAiC,CAAC,OAAO,CAAC,CAAC;IACzD,CAAC;CACF;AAED,SAAS,0BAA0B,CAAC,QAAwB;IAC1D,SAAS,aAAa,CAAC,IAAuB;QAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAClD,OAAO,CAAC,UAAsB,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC5F,CAAC;IACD,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACjF,KAAK,QAAQ;YACX,OAAO,CAAC,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAC3E,KAAK,aAAa;YAChB,OAAO,CAAC,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QACrE,KAAK,UAAU;YACb,OAAO,CAAC,UAAU,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACnF,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,SAAS,6BAA6B,CAAC,eAAoC;IACzE,oDAAoD;IACpD,OAAO;QACL,YAAY,EAAE,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,eAAe,CAAC;QACrE,SAAS,EAAE,CAAC;QACZ,IAAI,EAAE,SAAS;QACf,SAAS,EAAE;YACT,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,eAAe,CAAC,QAAQ;oBAC9B,KAAK,EAAE,eAAe,CAAC,KAAK;iBAC7B;aACF;SACF;KACF,CAAC;AACJ,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Metadata\n */\n\nimport { ISchemaLocater, SchemaContext } from \"../Context\";\nimport { SchemaItemKey, SchemaKey } from \"../SchemaKey\";\nimport { SchemaItem } from \"../Metadata/SchemaItem\";\nimport { Format } from \"../Metadata/Format\";\nimport { SchemaItemFormatProps } from \"../Deserialization/JsonProps\";\nimport { BeEvent, Logger } from \"@itwin/core-bentley\";\nimport { KindOfQuantity } from \"../Metadata/KindOfQuantity\";\nimport { getFormatProps } from \"../Metadata/OverrideFormat\";\nimport { FormatDefinition, FormatProps, FormatsChangedArgs, FormatsProvider, UnitSystemKey } from \"@itwin/core-quantity\";\nimport { Unit } from \"../Metadata/Unit\";\nimport { InvertedUnit } from \"../Metadata/InvertedUnit\";\nimport { Schema } from \"../Metadata/Schema\";\nimport { UnitSystem } from \"../Metadata/UnitSystem\";\nconst loggerCategory = \"SchemaFormatsProvider\";\n/**\n * Provides default formats and kind of quantities from a given SchemaContext or SchemaLocater.\n * @beta\n */\nexport class SchemaFormatsProvider implements FormatsProvider {\n  private _context: SchemaContext;\n  private _unitSystem: UnitSystemKey;\n  private _formatsRetrieved: Set<string> = new Set();\n  public onFormatsChanged = new BeEvent<(args: FormatsChangedArgs) => void>();\n  /**\n   *\n   * @param contextOrLocater The SchemaContext or a different ISchemaLocater implementation used to retrieve the schema. The SchemaContext\n   * class implements the ISchemaLocater interface. If the provided locater is not a SchemaContext instance a new SchemaContext will be\n   * created and the locater will be added.\n   * @param unitSystem Used to lookup a default format through a schema specific algorithm, when the format retrieved is associated with a KindOfQuantity.\n   */\n  constructor(contextOrLocater: ISchemaLocater, unitSystem: UnitSystemKey) {\n    if (contextOrLocater instanceof SchemaContext) {\n      this._context = contextOrLocater;\n    } else {\n      this._context = new SchemaContext();\n      this._context.addLocater(contextOrLocater);\n    }\n    this._unitSystem = unitSystem;\n  }\n\n  public get context() { return this._context; }\n  public get unitSystem() { return this._unitSystem; }\n\n  public set unitSystem(unitSystem: UnitSystemKey) {\n    this._unitSystem = unitSystem;\n    this.clear();\n  }\n\n  private clear(): void {\n    const formatsChanged = Array.from(this._formatsRetrieved);\n    this._formatsRetrieved.clear();\n    this.onFormatsChanged.raiseEvent({ formatsChanged });\n  }\n\n  /** When using a presentation unit from a KindOfQuantity, the label and description should come from the KindOfQuantity */\n  private convertToFormatDefinition(format: SchemaItemFormatProps, kindOfQuantity: KindOfQuantity): FormatDefinition {\n    // Destructure all properties except 'rest'\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { name, label, description, $schema, schema, schemaVersion, schemaItemType,\n      // eslint-disable-next-line @typescript-eslint/no-unused-vars\n      customAttributes, originalECSpecMajorVersion, originalECSpecMinorVersion, ...rest } = format;\n\n    return {\n      ...rest,\n      name: kindOfQuantity.fullName,\n      label: kindOfQuantity.label ?? format.label,\n      description: kindOfQuantity.description ?? format.description,\n    }\n  }\n\n  private async getKindOfQuantityFormatFromSchema(itemKey: SchemaItemKey): Promise<FormatDefinition | undefined> {\n    let kindOfQuantity: KindOfQuantity | undefined;\n    try {\n      kindOfQuantity = await this._context.getSchemaItem(itemKey, KindOfQuantity);\n    } catch {\n      Logger.logError(loggerCategory, `Failed to find KindOfQuantity ${itemKey.fullName}`);\n      return undefined;\n    }\n\n    if (!kindOfQuantity) {\n      return undefined;\n    }\n\n    // Find the first presentation format that matches the provided unit system.\n    const unitSystemMatchers = getUnitSystemGroupMatchers(this._unitSystem);\n    const presentationFormats = kindOfQuantity.presentationFormats;\n    for (const matcher of unitSystemMatchers) {\n      for (const lazyFormat of presentationFormats) {\n        const format = await lazyFormat;\n        const unit = await (format.units && format.units[0][0]);\n        if (!unit) {\n          continue;\n        }\n        const currentUnitSystem = await unit.unitSystem;\n        if (currentUnitSystem && matcher(currentUnitSystem)) {\n          this._formatsRetrieved.add(itemKey.fullName);\n          const props = getFormatProps(format);\n          return this.convertToFormatDefinition(props, kindOfQuantity);\n        }\n      }\n    }\n\n    // If no matching presentation format was found, use persistence unit format if it matches unit system.\n    const persistenceUnit = await kindOfQuantity.persistenceUnit;\n    const persistenceUnitSystem = await persistenceUnit?.unitSystem;\n    if (persistenceUnitSystem && unitSystemMatchers.some((matcher) => matcher(persistenceUnitSystem))) {\n      this._formatsRetrieved.add(itemKey.fullName);\n      const props = getPersistenceUnitFormatProps(persistenceUnit!);\n      return this.convertToFormatDefinition(props, kindOfQuantity);\n    }\n\n    const defaultFormat = kindOfQuantity.defaultPresentationFormat;\n    if (!defaultFormat) {\n      return undefined;\n    }\n    this._formatsRetrieved.add(itemKey.fullName);\n    const defaultProps = getFormatProps(await defaultFormat);\n    return this.convertToFormatDefinition(defaultProps, kindOfQuantity);\n  }\n\n\n  /**\n   * Retrieves a Format from a SchemaContext. If the format is part of a KindOfQuantity, the first presentation format in the KindOfQuantity that matches the current unit system will be retrieved.\n   * If no presentation format matches the current unit system, the persistence unit format will be retrieved if it matches the current unit system.\n   * Else, the default presentation format will be retrieved.\n   * @param name The full name of the Format or KindOfQuantity.\n   * @returns\n   */\n  public async getFormat(name: string): Promise<FormatDefinition | undefined> {\n    const [schemaName, schemaItemName] = SchemaItem.parseFullName(name);\n    const schemaKey = new SchemaKey(schemaName);\n    let schema: Schema | undefined;\n    try {\n      schema = await this._context.getSchema(schemaKey);\n    } catch {\n      Logger.logError(loggerCategory, `Failed to find schema ${schemaName}`);\n      return undefined;\n    }\n    if (!schema) {\n      return undefined;\n    }\n    const itemKey = new SchemaItemKey(schemaItemName, schema.schemaKey);\n\n    if (schema.name === \"Formats\") {\n      let format: Format | undefined;\n      try {\n        format = await this._context.getSchemaItem(itemKey, Format);\n      } catch {\n        Logger.logError(loggerCategory, `Failed to find Format ${itemKey.fullName}`);\n        return undefined;\n      }\n      if (!format) {\n        return undefined;\n      }\n      return format.toJSON(true);\n    }\n    return this.getKindOfQuantityFormatFromSchema(itemKey);\n  }\n}\n\nfunction getUnitSystemGroupMatchers(groupKey?: UnitSystemKey) {\n  function createMatcher(name: string | string[]) {\n    const names = Array.isArray(name) ? name : [name];\n    return (unitSystem: UnitSystem) => names.some((n) => n === unitSystem.name.toUpperCase());\n  }\n  switch (groupKey) {\n    case \"imperial\":\n      return [\"IMPERIAL\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"metric\":\n      return [[\"SI\", \"METRIC\"], \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usCustomary\":\n      return [\"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n    case \"usSurvey\":\n      return [\"USSURVEY\", \"USCUSTOM\", \"INTERNATIONAL\", \"FINANCE\"].map(createMatcher);\n  }\n  return [];\n}\n\nfunction getPersistenceUnitFormatProps(persistenceUnit: Unit | InvertedUnit): FormatProps {\n  // Same as Format \"DefaultRealU\" in Formats ecschema\n  return {\n    formatTraits: [\"keepSingleZero\", \"keepDecimalPoint\", \"showUnitLabel\"],\n    precision: 6,\n    type: \"Decimal\",\n    composite: {\n      units: [\n        {\n          name: persistenceUnit.fullName,\n          label: persistenceUnit.label,\n        },\n      ],\n    },\n  };\n}"]}

package/lib/esm/IncrementalLoading/ECSqlSchemaLocater.d.ts

@@ -3,7 +3,6 @@ import { ConstantProps, CustomAttributeClassProps, EntityClassProps, Enumeration
 import { SchemaInfo } from "../Interfaces";
 import { SchemaKey } from "../SchemaKey";
 import { IncrementalSchemaLocater, SchemaLocaterOptions } from "./IncrementalSchemaLocater";
-import { PerformanceLogger } from "./PerformanceLogger";
 interface QueryParameters {
     [parameterName: string]: string | number;
 }
@@ -23,8 +22,6 @@ export interface ECSqlQueryOptions {
 export interface ECSqlSchemaLocaterOptions extends SchemaLocaterOptions {
     /** Query for Schemas using multiple queries. Defaults to false. */
     readonly useMultipleQueries?: boolean;
-    /** Collects query execution performance data. Defaults to false. */
-    readonly performanceLogger?: PerformanceLogger;
 }
 /**
  * An abstract [[IncrementalSchemaLocater]] implementation for loading
@@ -60,10 +57,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @param context     The [[SchemaContext]] to use for resolving references.
      * @internal
      */
-    getSchemaJson(schemaKey: SchemaKey, context: SchemaContext): Promise<SchemaProps | undefined>;
-    /**
-     * Gets the [[SchemaProps]] without schemaItems.
-     */
+    protected getSchemaJson(schemaKey: SchemaKey, context: SchemaContext): Promise<SchemaProps | undefined>;
     /**
      * Gets the [[SchemaProps]] without schemaItems for the given schema name.
      * @param schemaName The name of the Schema.
@@ -71,7 +65,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns
      * @internal
      */
-    getSchemaNoItems(schemaName: string, context: SchemaContext): Promise<SchemaProps | undefined>;
+    private getSchemaNoItems;
     /**
      * Checks if the [[SchemaContext]] has the right Meta Schema version to support the incremental schema loading.
      * @param context   The schema context to lookup the meta schema.
@@ -85,7 +79,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a EntityClassProps array. Maybe empty of no entities are found.
      * @internal
      */
-    getEntities(schema: string, context: SchemaContext, queryOverride?: string): Promise<EntityClassProps[]>;
+    protected getEntities(schema: string, context: SchemaContext, queryOverride?: string): Promise<EntityClassProps[]>;
     /**
      * Gets all the Schema's Mixin classes as [[MixinProps]] JSON objects.
      * @param schemaName The name of the Schema.
@@ -93,7 +87,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a MixinProps array. Maybe empty of no entities are found.
      * @internal
      */
-    getMixins(schema: string, context: SchemaContext, queryOverride?: string): Promise<MixinProps[]>;
+    protected getMixins(schema: string, context: SchemaContext, queryOverride?: string): Promise<MixinProps[]>;
     /**
      * Gets all the Schema's Relationship classes as [[RelationshipClassProps]] JSON objects.
      * @param schemaName The name of the Schema.
@@ -101,7 +95,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a RelationshipClassProps array. Maybe empty if no items are found.
      * @internal
      */
-    getRelationships(schema: string, context: SchemaContext, queryOverride?: string): Promise<RelationshipClassProps[]>;
+    protected getRelationships(schema: string, context: SchemaContext, queryOverride?: string): Promise<RelationshipClassProps[]>;
     /**
      * Gets all the Schema's CustomAttributeClass items as [[CustomAttributeClassProps]] JSON objects.
      * @param schemaName The name of the Schema.
@@ -109,7 +103,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a CustomAttributeClassProps array. Maybe empty if not items are found.
      * @internal
      */
-    getCustomAttributeClasses(schema: string, context: SchemaContext, queryOverride?: string): Promise<CustomAttributeClassProps[]>;
+    protected getCustomAttributeClasses(schema: string, context: SchemaContext, queryOverride?: string): Promise<CustomAttributeClassProps[]>;
     /**
      * Gets all the Schema's StructClass items as [[StructClassProps]] JSON objects.
      * @param schemaName The name of the Schema.
@@ -117,7 +111,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a StructClassProps array. Maybe empty if not items are found.
      * @internal
      */
-    getStructs(schema: string, context: SchemaContext, queryOverride?: string): Promise<StructClassProps[]>;
+    protected getStructs(schema: string, context: SchemaContext, queryOverride?: string): Promise<StructClassProps[]>;
     /**
      * Gets all the Schema's KindOfQuantity items as [[KindOfQuantityProps]] JSON objects.
      * @param schema The name of the Schema.
@@ -125,7 +119,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a KindOfQuantityProps array. Maybe empty if not items are found.
      * @internal
      */
-    getKindOfQuantities(schema: string, context: SchemaContext): Promise<KindOfQuantityProps[]>;
+    protected getKindOfQuantities(schema: string, context: SchemaContext): Promise<KindOfQuantityProps[]>;
     /**
      * Gets all the Schema's PropertyCategory items as [[PropertyCategoryProps]] JSON objects.
      * @param schema The name of the Schema.
@@ -133,7 +127,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a PropertyCategoryProps array. Maybe empty if not items are found.
      * @internal
      */
-    getPropertyCategories(schema: string, context: SchemaContext): Promise<PropertyCategoryProps[]>;
+    protected getPropertyCategories(schema: string, context: SchemaContext): Promise<PropertyCategoryProps[]>;
     /**
      * Gets all the Schema's Enumeration items as [[EnumerationProps]] JSON objects.
      * @param schema The name of the Schema.
@@ -141,7 +135,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a EnumerationProps array. Maybe empty if not items are found.
      * @internal
      */
-    getEnumerations(schema: string, context: SchemaContext): Promise<EnumerationProps[]>;
+    protected getEnumerations(schema: string, context: SchemaContext): Promise<EnumerationProps[]>;
     /**
      * Gets all the Schema's Unit items as [[SchemaItemUnitProps]] JSON objects.
      * @param schema The name of the Schema.
@@ -149,7 +143,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a SchemaItemUnitProps array. Maybe empty if not items are found.
      * @internal
      */
-    getUnits(schema: string, context: SchemaContext): Promise<SchemaItemUnitProps[]>;
+    protected getUnits(schema: string, context: SchemaContext): Promise<SchemaItemUnitProps[]>;
     /**
      * Gets all the Schema's InvertedUnit items as [[InvertedUnitProps]] JSON objects.
      * @param schema The name of the Schema.
@@ -157,7 +151,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a InvertedUnitProps array. Maybe empty if not items are found.
      * @internal
      */
-    getInvertedUnits(schema: string, context: SchemaContext): Promise<InvertedUnitProps[]>;
+    protected getInvertedUnits(schema: string, context: SchemaContext): Promise<InvertedUnitProps[]>;
     /**
      * Gets all the Schema's Constant items as [[ConstantProps]] JSON objects.
      * @param schema The name of the Schema.
@@ -165,7 +159,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a ConstantProps array. Maybe empty if not items are found.
      * @internal
      */
-    getConstants(schema: string, context: SchemaContext): Promise<ConstantProps[]>;
+    protected getConstants(schema: string, context: SchemaContext): Promise<ConstantProps[]>;
     /**
      * Gets all the Schema's UnitSystem items as [[UnitSystemProps]] JSON objects.
      * @param schema The name of the Schema.
@@ -173,7 +167,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a UnitSystemProps array. Maybe empty if not items are found.
      * @internal
      */
-    getUnitSystems(schema: string, context: SchemaContext): Promise<UnitSystemProps[]>;
+    protected getUnitSystems(schema: string, context: SchemaContext): Promise<UnitSystemProps[]>;
     /**
      * Gets all the Schema's Phenomenon items as [[PhenomenonProps]] JSON objects.
      * @param schema The name of the Schema.
@@ -181,7 +175,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a PhenomenonProps array. Maybe empty if not items are found.
      * @internal
      */
-    getPhenomenon(schema: string, context: SchemaContext): Promise<PhenomenonProps[]>;
+    protected getPhenomenon(schema: string, context: SchemaContext): Promise<PhenomenonProps[]>;
     /**
      * Gets all the Schema's Format items as [[SchemaItemFormatProps]] JSON objects.
      * @param schema The name of the Schema.
@@ -189,12 +183,12 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to a SchemaItemFormatProps array. Maybe empty if not items are found.
      * @internal
      */
-    getFormats(schema: string, context: SchemaContext): Promise<SchemaItemFormatProps[]>;
+    protected getFormats(schema: string, context: SchemaContext): Promise<SchemaItemFormatProps[]>;
     /**
      * Gets [[SchemaInfo]] objects for all schemas including their direct schema references.
      * @internal
      */
-    loadSchemaInfos(): Promise<ReadonlyArray<SchemaInfo>>;
+    protected loadSchemaInfos(): Promise<ReadonlyArray<SchemaInfo>>;
     /**
      * Gets the [[SchemaProps]] to create the basic schema skeleton. Depending on which options are set, the schema items or class hierarchy
      * can be included in the initial fetch.
@@ -202,7 +196,7 @@ export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocate
      * @returns A promise that resolves to the schema partials, which is an array of [[SchemaProps]].
      * @internal
      */
-    getSchemaPartials(schemaKey: SchemaKey, context: SchemaContext): Promise<ReadonlyArray<SchemaProps> | undefined>;
+    protected getSchemaPartials(schemaKey: SchemaKey, context: SchemaContext): Promise<ReadonlyArray<SchemaProps> | undefined>;
     private querySchemaItem;
     private getFullSchema;
     private getFullSchemaMultipleQueries;

package/lib/esm/IncrementalLoading/ECSqlSchemaLocater.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ECSqlSchemaLocater.d.ts","sourceRoot":"","sources":["../../../src/IncrementalLoading/ECSqlSchemaLocater.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,UAAU,EACvI,eAAe,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,qBAAqB,EAAmB,mBAAmB,EAAE,WAAW,EACxI,gBAAgB,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,UAAU,EAAiB,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAC5F,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AA8DxD,UAAU,eAAe;IACvB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,mEAAmE;IACnE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IACtC,oEAAoE;IACpE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;CAChD;AAED;;;;GAIG;AACH,8BAAsB,kBAAmB,SAAQ,wBAAwB;IACvE;;OAEG;IACH,cAAuB,OAAO,IAAI,yBAAyB,CAE1D;IAED;;;OAGG;gBACS,OAAO,CAAC,EAAE,yBAAyB;IAI/C;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAE/G;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAEzF;;;;;;OAMG;IACU,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAiB1G;;OAEG;IACH;;;;;;OAMG;IACU,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAU3G;;;;OAIG;cACa,2BAA2B,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAMrF;;;;;;OAMG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAKrH;;;;;;OAMG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAK7G;;;;;;OAMG;IACU,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAKhI;;;;;;OAMG;IACU,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAM5I;;;;;;OAMG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAKpH;;;;;;OAMG;IACU,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAIxG;;;;;;OAMG;IACU,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAI5G;;;;;;OAMG;IACU,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAIjG;;;;;;OAMG;IACU,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAI7F;;;;;;OAMG;IACU,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAInG;;;;;;OAMG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI3F;;;;;;OAMG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAI/F;;;;;;OAMG;IACU,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAI9F;;;;;;OAMG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAIjG;;;OAGG;IACU,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAWlE;;;;;;OAMG;IACU,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;YAqD/G,eAAe;YAef,aAAa;YAeb,4BAA4B;CA8B3C"}
+{"version":3,"file":"ECSqlSchemaLocater.d.ts","sourceRoot":"","sources":["../../../src/IncrementalLoading/ECSqlSchemaLocater.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,UAAU,EACvI,eAAe,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,qBAAqB,EAAmB,mBAAmB,EAAE,WAAW,EACxI,gBAAgB,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,UAAU,EAAiB,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AA0D5F,UAAU,eAAe;IACvB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAC1C;AAID;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,mEAAmE;IACnE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;CACvC;AAED;;;;GAIG;AACH,8BAAsB,kBAAmB,SAAQ,wBAAwB;IACvE;;OAEG;IACH,cAAuB,OAAO,IAAI,yBAAyB,CAE1D;IAED;;;OAGG;gBACS,OAAO,CAAC,EAAE,yBAAyB;IAI/C;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAE/G;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAEzF;;;;;;OAMG;cACa,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAsB7G;;;;;;OAMG;YACW,gBAAgB;IAW9B;;;;OAIG;cACa,2BAA2B,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAMrF;;;;;;OAMG;cACa,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAKxH;;;;;;OAMG;cACa,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAKhH;;;;;;OAMG;cACa,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAKnI;;;;;;OAMG;cACa,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAM/I;;;;;;OAMG;cACa,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAKvH;;;;;;OAMG;cACa,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAI3G;;;;;;OAMG;cACa,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAI/G;;;;;;OAMG;cACa,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAIpG;;;;;;OAMG;cACa,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAIhG;;;;;;OAMG;cACa,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAItG;;;;;;OAMG;cACa,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI9F;;;;;;OAMG;cACa,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAIlG;;;;;;OAMG;cACa,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAIjG;;;;;;OAMG;cACa,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAIpG;;;OAGG;cACa,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAarE;;;;;;OAMG;cACa,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;YA8DlH,eAAe;YAuBf,aAAa;YAgBb,4BAA4B;CAmC3C"}

package/lib/esm/IncrementalLoading/ECSqlSchemaLocater.js

@@ -2,13 +2,15 @@
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
  * See LICENSE.md in the project root for license terms and full copyright notice.
  *--------------------------------------------------------------------------------------------*/
-import { parseSchemaItemType, SchemaMatchType } from "../ECObjects";
+import { Logger } from "@itwin/core-bentley";
+import { SchemaMatchType } from "../ECObjects";
 import { SchemaKey } from "../SchemaKey";
 import { FullSchemaQueries } from "./FullSchemaQueries";
 import { IncrementalSchemaLocater } from "./IncrementalSchemaLocater";
 import { SchemaItemQueries } from "./SchemaItemQueries";
 import { SchemaParser } from "./SchemaParser";
 import { ecsqlQueries } from "./SchemaStubQueries";
+const LOGGER_CATEGORY = "IncrementalSchemaLoading.Performance";
 /**
  * An abstract [[IncrementalSchemaLocater]] implementation for loading
  * EC [Schema] instances from an iModelDb using ECSql queries.
@@ -41,17 +43,19 @@ export class ECSqlSchemaLocater extends IncrementalSchemaLocater {
         // to fetch the whole schema json.
         if (!await this.supportPartialSchemaLoading(context))
             return this.getSchemaProps(schemaKey);
-        const start = Date.now();
+        const queryStart = Date.now();
         const schemaProps = this.options.useMultipleQueries
             ? await this.getFullSchemaMultipleQueries(schemaKey, context)
             : await this.getFullSchema(schemaKey, context);
-        this.options.performanceLogger?.logSchema(start, schemaKey.name);
+        const queryDuration = Date.now() - queryStart;
+        Logger.logTrace(LOGGER_CATEGORY, `Recieved SchemaProps for ${schemaKey.name} in ${queryDuration}ms`, {
+            schemaName: schemaKey.name,
+            queryMode: this.options.useMultipleQueries ? "parallel" : "single",
+            duration: queryDuration,
+        });
         return schemaProps;
     }
     ;
-    /**
-     * Gets the [[SchemaProps]] without schemaItems.
-     */
     /**
      * Gets the [[SchemaProps]] without schemaItems for the given schema name.
      * @param schemaName The name of the Schema.
@@ -65,7 +69,8 @@ export class ECSqlSchemaLocater extends IncrementalSchemaLocater {
         if (schemaRow === undefined)
             return undefined;
         const schema = JSON.parse(schemaRow.schema);
-        return SchemaParser.parse(schema, context);
+        const schemaInfos = await this._schemaInfoCache.getSchemasByContext(context) ?? [];
+        return SchemaParser.parse(schema, schemaInfos);
     }
     /**
      * Checks if the [[SchemaContext]] has the right Meta Schema version to support the incremental schema loading.
@@ -231,6 +236,8 @@ export class ECSqlSchemaLocater extends IncrementalSchemaLocater {
         const schemaRows = await this.executeQuery(ecsqlQueries.schemaInfoQuery);
         return schemaRows.map((schemaRow) => ({
             alias: schemaRow.alias,
+            description: schemaRow.description,
+            label: schemaRow.label,
             schemaKey: SchemaKey.parseString(`${schemaRow.name}.${schemaRow.version}`),
             references: Array.from(JSON.parse(schemaRow.references), parseSchemaReference),
         }));
@@ -243,11 +250,17 @@ export class ECSqlSchemaLocater extends IncrementalSchemaLocater {
      * @internal
      */
     async getSchemaPartials(schemaKey, context) {
-        const [schemaRow] = await this.executeQuery(ecsqlQueries.schemaStubQuery, {
-            parameters: { schemaName: schemaKey.name },
-            limit: 1
+        const queryStart = Date.now();
+        const itemRows = await this.executeQuery(ecsqlQueries.schemaStubQuery, {
+            parameters: { schemaName: schemaKey.name }
+        });
+        const queryDuration = Date.now() - queryStart;
+        Logger.logTrace(LOGGER_CATEGORY, `Recieved PartialSchema for ${schemaKey.name} in ${queryDuration}ms`, {
+            schemaName: schemaKey.name,
+            itemCount: itemRows.length,
+            duration: queryDuration,
         });
-        if (!schemaRow)
+        if (itemRows.length === 0)
             return undefined;
         const schemaPartials = [];
         const addSchema = async (key) => {
@@ -267,32 +280,41 @@ export class ECSqlSchemaLocater extends IncrementalSchemaLocater {
             if (!schemaStub) {
                 schemaStub = await addSchema(SchemaKey.parseString(`${schemaName}.0.0.0`));
             }
-            if (!schemaStub.items) {
-                Object.assign(schemaStub, { items: {} });
+            let items = schemaStub.items;
+            if (!items) {
+                Object.assign(schemaStub, items = { items: {} });
             }
-            const existingItem = schemaStub.items[itemInfo.name] || {};
-            Object.assign(schemaStub.items, { [itemInfo.name]: Object.assign(existingItem, itemInfo) });
+            const existingItem = items[itemInfo.name] || {};
+            Object.assign(items, { [itemInfo.name]: Object.assign(existingItem, itemInfo) });
         };
         const reviver = (_key, value) => {
-            if (value === null) {
-                return undefined;
-            }
-            return value;
+            return value === null ? undefined : value;
         };
         await addSchema(schemaKey);
-        await parseSchemaItemStubs(schemaKey.name, context, JSON.parse(schemaRow.items, reviver), addItems);
+        const schemaInfos = await this._schemaInfoCache.getSchemasByContext(context) ?? [];
+        const stubItems = itemRows.map((itemRow) => {
+            return JSON.parse(itemRow.item, reviver);
+        });
+        await parseSchemaItemStubs(schemaKey.name, stubItems, addItems, schemaInfos);
         return schemaPartials;
     }
     async querySchemaItem(context, schemaName, query, schemaType) {
         const start = Date.now();
         const itemRows = await this.executeQuery(query, { parameters: { schemaName } });
-        this.options.performanceLogger?.logSchemaItem(start, schemaName, schemaType, itemRows.length);
+        const queryDuration = Date.now() - start;
+        Logger.logTrace(LOGGER_CATEGORY, `Recieved rows of ${schemaType} items for ${schemaName} in ${queryDuration}ms`, {
+            schemaName,
+            itemCount: itemRows.length,
+            itemType: schemaType,
+            duration: queryDuration,
+        });
         if (itemRows.length === 0)
             return [];
         const items = itemRows.map((itemRow) => {
             return "string" === typeof itemRow.item ? JSON.parse(itemRow.item) : itemRow.item;
         });
-        return await SchemaParser.parseSchemaItems(items, schemaName, context) ?? [];
+        const schemaInfos = await this._schemaInfoCache.getSchemasByContext(context) ?? [];
+        return await SchemaParser.parseSchemaItems(items, schemaName, schemaInfos) ?? [];
     }
     async getFullSchema(schemaKey, context) {
         const schemaRows = await this.executeQuery(FullSchemaQueries.schemaQuery, { parameters: { schemaName: schemaKey.name } });
@@ -304,13 +326,14 @@ export class ECSqlSchemaLocater extends IncrementalSchemaLocater {
         if (schema.items) {
             schema.items = schema.items.map((itemRow) => { return itemRow.item; });
         }
-        return SchemaParser.parse(schema, context);
+        const schemaInfos = await this._schemaInfoCache.getSchemasByContext(context) ?? [];
+        return SchemaParser.parse(schema, schemaInfos);
     }
     async getFullSchemaMultipleQueries(schemaKey, context) {
         const schema = await this.getSchemaNoItems(schemaKey.name, context);
         if (!schema)
             return undefined;
-        schema.items = {};
+        const items = schema.items || (schema.items = {});
         await Promise.all([
             this.getEntities(schemaKey.name, context),
             this.getMixins(schemaKey.name, context),
@@ -327,9 +350,14 @@ export class ECSqlSchemaLocater extends IncrementalSchemaLocater {
             this.getPhenomenon(schemaKey.name, context),
             this.getFormats(schemaKey.name, context)
         ]).then((itemResults) => {
-            const flatItemList = itemResults.reduce((acc, item) => acc.concat(item));
+            const flatItemList = itemResults.reduce((acc, result) => acc.concat(result));
             flatItemList.forEach((schemaItem) => {
-                schema.items[schemaItem.name] = schemaItem;
+                if (!schemaItem.name) {
+                    // This should never be happen, as we query the schema items by name from the database, but since the SchemaProps
+                    // have name optional, we need the check here to make the compiler happy.
+                    throw new Error(`SchemaItem with no name encountered in schema ${schemaKey.name}`);
+                }
+                items[schemaItem.name] = schemaItem;
             });
         });
         return schema;
@@ -338,7 +366,7 @@ export class ECSqlSchemaLocater extends IncrementalSchemaLocater {
 function parseSchemaReference(referenceName) {
     return { schemaKey: SchemaKey.parseString(referenceName) };
 }
-async function parseSchemaItemStubs(schemaName, context, itemRows, addItemsHandler) {
+async function parseSchemaItemStubs(schemaName, itemRows, addItemsHandler, schemaInfos) {
     if (!itemRows || itemRows.length === 0) {
         return;
     }
@@ -349,32 +377,32 @@ async function parseSchemaItemStubs(schemaName, context, itemRows, addItemsHandl
             const currentItem = baseClasses[index--];
             const baseClassItem = baseClasses[index];
             const baseClassName = baseClassItem ? `${baseClassItem.schema}.${baseClassItem.name}` : undefined;
-            const schemaItem = await SchemaParser.parseItem(currentItem, currentItem.schema, context);
+            const schemaItem = await SchemaParser.parseItem(currentItem, currentItem.schema, schemaInfos);
             await addItemsHandler(currentItem.schema, {
                 ...schemaItem,
                 name: schemaItem.name,
-                schemaItemType: parseSchemaItemType(schemaItem.schemaItemType),
+                schemaItemType: schemaItem.schemaItemType,
                 baseClass: baseClassName,
             });
         }
     };
     for (const itemRow of itemRows) {
-        const schemaItem = await SchemaParser.parseItem(itemRow, schemaName, context);
+        const schemaItem = await SchemaParser.parseItem(itemRow, schemaName, schemaInfos);
         await addItemsHandler(schemaName, {
             ...schemaItem,
             name: schemaItem.name,
-            schemaItemType: parseSchemaItemType(schemaItem.schemaItemType),
+            schemaItemType: schemaItem.schemaItemType,
             mixins: itemRow.mixins
                 ? itemRow.mixins.map(mixin => { return `${mixin.schema}.${mixin.name}`; })
                 : undefined,
         });
         await parseBaseClasses(itemRow.baseClasses);
         for (const mixinRow of itemRow.mixins || []) {
-            const mixinItem = await SchemaParser.parseItem(mixinRow, mixinRow.schema, context);
+            const mixinItem = await SchemaParser.parseItem(mixinRow, mixinRow.schema, schemaInfos);
             await addItemsHandler(mixinRow.schema, {
                 ...mixinItem,
                 name: mixinItem.name,
-                schemaItemType: parseSchemaItemType(mixinItem.schemaItemType),
+                schemaItemType: mixinItem.schemaItemType,
             });
             await parseBaseClasses(mixinRow.baseClasses);
         }