@itwin/ecschema-metadata 5.0.0-dev.59 → 5.0.0-dev.61

package/lib/cjs/Context.d.ts

@@ -19,7 +19,7 @@ export interface ISchemaLocater {
      * @param matchType how to match key against candidate schemas
      * @param context context for loading schema references
      */
-    getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;
+    getSchema(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;
     /**
     * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
     * May return the entire Schema so long as it is completely loaded as it satisfies the SchemaInfo interface.
@@ -34,13 +34,30 @@ export interface ISchemaLocater {
      * @param matchType how to match key against candidate schemas
      * @param context context for loading schema references
      */
-    getSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
+    getSchemaSync(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined;
 }
 /**
+ * Base interface for types that allow location of items inside a schema
  * @beta
  */
 export interface ISchemaItemLocater {
-    getSchemaItem<T extends SchemaItem>(schemaItemKey: SchemaItemKey): Promise<T | undefined>;
+    /**
+     * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].
+     * Will await a partially loaded schema then look in it for the requested item.
+     * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.
+     * @returns The requested schema item.
+     */
+    getSchemaItem(schemaItemKey: SchemaItemKey): Promise<SchemaItem | undefined>;
+    getSchemaItem<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): Promise<InstanceType<T> | undefined>;
+    /**
+     * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].
+     * Will skip a partially loaded schema and return undefined if the item belongs to that schema. Use the async method to await partially loaded schemas.
+     * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.
+     * @param itemConstructor The constructor of the item to return.
+     * @returns The requested schema item.
+     */
+    getSchemaItemSync(schemaItemKey: SchemaItemKey): SchemaItem | undefined;
+    getSchemaItemSync<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): InstanceType<T> | undefined;
 }
 /**
  * @internal
@@ -71,18 +88,18 @@ export declare class SchemaCache implements ISchemaLocater {
      * Adds a schema to the cache. Does not allow for duplicate schemas, checks using SchemaMatchType.Latest.
      * @param schema The schema to add to the cache.
      */
-    addSchema<T extends Schema>(schema: T): Promise<void>;
+    addSchema(schema: Schema): Promise<void>;
     /**
      * Adds a schema to the cache. Does not allow for duplicate schemas, checks using SchemaMatchType.Latest.
      * @param schema The schema to add to the cache.
      */
-    addSchemaSync<T extends Schema>(schema: T): void;
+    addSchemaSync(schema: Schema): void;
     /**
      * Gets the schema which matches the provided SchemaKey.
      * @param schemaKey The SchemaKey describing the schema to get from the cache.
      * @param matchType The match type to use when locating the schema
      */
-    getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined>;
+    getSchema(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<Schema | undefined>;
     /**
       * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
       * @param schemaKey The SchemaKey describing the schema to get from the cache.
@@ -94,7 +111,7 @@ export declare class SchemaCache implements ISchemaLocater {
      * @param schemaKey The SchemaKey describing the schema to get from the cache.
      * @param matchType The match type to use when locating the schema
      */
-    getSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): T | undefined;
+    getSchemaSync(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Schema | undefined;
     /**
      * Generator function that can iterate through each schema in _schema SchemaMap and items for each Schema.
      * Does not include schema items from schemas that are not completely loaded yet.
@@ -174,7 +191,7 @@ export declare class SchemaContext implements ISchemaItemLocater {
      * @param matchType Criteria by which to identify potentially matching schemas.
      * @returns the schema matching the input criteria, or `undefined` if no such schema could be located.
      */
-    getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined>;
+    getSchema(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<Schema | undefined>;
     /**
      * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
      * The fully loaded schema can be gotten later from the context using [[getSchema]].
@@ -188,7 +205,7 @@ export declare class SchemaContext implements ISchemaItemLocater {
      * @param matchType Criteria by which to identify potentially matching schemas.
      * @returns the schema matching the input criteria, or `undefined` if no such schema could be located.
      */
-    getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType?: SchemaMatchType): T | undefined;
+    getSchemaSync(schemaKey: SchemaKey, matchType?: SchemaMatchType): Schema | undefined;
     /**
      * Attempts to get a Schema from the context's cache.
      * Will await a partially loaded schema then return when it is completely loaded.
@@ -196,7 +213,7 @@ export declare class SchemaContext implements ISchemaItemLocater {
      * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.
      * @internal
      */
-    getCachedSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined>;
+    getCachedSchema(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<Schema | undefined>;
     /**
      * Attempts to get a Schema from the context's cache.
      * Will return undefined if the cached schema is partially loaded.  Use [[getCachedSchema]] to await until the schema is completely loaded.
@@ -204,21 +221,25 @@ export declare class SchemaContext implements ISchemaItemLocater {
      * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.
      * @internal
      */
-    getCachedSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): T | undefined;
+    getCachedSchemaSync(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Schema | undefined;
     /**
      * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].
      * Will await a partially loaded schema then look in it for the requested item
      * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.
+     * @param itemConstructor The constructor of the item to return.
      * @returns The requested schema item
      */
-    getSchemaItem<T extends SchemaItem>(schemaItemKey: SchemaItemKey): Promise<T | undefined>;
+    getSchemaItem(schemaItemKey: SchemaItemKey): Promise<SchemaItem | undefined>;
+    getSchemaItem<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): Promise<InstanceType<T> | undefined>;
     /**
      * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].
-     * Will skip a partially loaded schema and return undefined if the item belongs to that schema.  Use the async method to await partially loaded schemas.
-     * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.
+     * Will return undefined if the cached schema is partially loaded. Use [[getSchemaItem]] to await until the schema is completely loaded.
+     * @param schemaItemKey The SchemaItemKey identifying the item to return. SchemaMatchType.Latest is used to match the schema.
+     * @param itemConstructor The constructor of the item to return.
      * @returns The requested schema item
      */
-    getSchemaItemSync<T extends SchemaItem>(schemaItemKey: SchemaItemKey): T | undefined;
+    getSchemaItemSync(schemaItemKey: SchemaItemKey): SchemaItem | undefined;
+    getSchemaItemSync<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): InstanceType<T> | undefined;
     /**
      * Iterates through the items of each schema known to the context.  This includes schemas added to the
      * context using [[SchemaContext.addSchema]]. This does not include schemas that

package/lib/cjs/Context.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../src/Context.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAiB,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAgBvD;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAExI;;;;;MAKE;IACF,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAEnI;;;;;;OAMG;IACH,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS,CAAC;CACpI;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;CAC3F;AAED;;GAEG;AACH,qBAAa,WAAY,YAAW,cAAc;IAChD,OAAO,CAAC,OAAO,CAAY;;IAM3B,IAAW,KAAK,WAAkC;IAElD,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,mBAAmB;IAM3B,OAAO,CAAC,WAAW;IAInB;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO;IAI5D;;;;;;OAMG;IACU,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC;IAepG;;;OAGG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC;IAOlD;;;OAGG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC;IAOhD;;;;OAIG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAqBrJ;;;;QAII;IACS,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAWhJ;;;;OAIG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,CAAC,GAAG,SAAS;IAe1I;;;OAGG;IACM,cAAc,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAQvD;;;;OAIG;IACI,aAAa,IAAI,MAAM,EAAE;CAGjC;AAED;;;;;;;GAOG;AACH,qBAAa,aAAc,YAAW,kBAAkB;IACtD,OAAO,CAAC,SAAS,CAAmB;IAEpC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,uBAAuB,CAAU;;IAUzC,IAAW,QAAQ,IAAI,cAAc,EAAE,CAA2B;IAElE;;;;;;;OAOG;IACI,UAAU,CAAC,OAAO,EAAE,cAAc;IAKzC;;;;;;;OAOG;IACI,kBAAkB,CAAC,OAAO,EAAE,cAAc;IASjD;;;OAGG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM;IAIrC;;;OAGG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM;IAInC;;;;OAIG;IACU,aAAa,CAAC,UAAU,EAAE,UAAU;IAQjD;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO;IAI5D;;;;;;;OAOG;IACU,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC;IAIpG;;;;OAIG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAWrJ;;;;;OAKG;IACU,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAUvH;;;;;OAKG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAE,eAAwC,GAAG,CAAC,GAAG,SAAS;IAWhI;;;;;;OAMG;IACU,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAI3J;;;;;;OAMG;IACI,mBAAmB,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,CAAC,GAAG,SAAS;IAIhJ;;;;;OAKG;IACU,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAOtG;;;;;OAKG;IACI,iBAAiB,CAAC,CAAC,SAAS,UAAU,EAAE,aAAa,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS;IAO3F;;;;;OAKG;IACI,cAAc,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAIrD;;;;;;OAMG;IACI,eAAe,IAAI,MAAM,EAAE;CAGnC"}
+{"version":3,"file":"Context.d.ts","sourceRoot":"","sources":["../../src/Context.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE9C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAiB,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAgBvD;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAE3H;;;;;MAKE;IACF,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAEnI;;;;;;OAMG;IACH,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,EAAE,aAAa,GAAG,MAAM,GAAG,SAAS,CAAC;CACvH;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;IAC7E,aAAa,CAAC,CAAC,SAAS,OAAO,UAAU,EAAE,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAEnI;;;;;;OAMG;IACH,iBAAiB,CAAC,aAAa,EAAE,aAAa,GAAG,UAAU,GAAG,SAAS,CAAC;IACxE,iBAAiB,CAAC,CAAC,SAAS,OAAO,UAAU,EAAE,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;CAC/H;AAED;;GAEG;AACH,qBAAa,WAAY,YAAW,cAAc;IAChD,OAAO,CAAC,OAAO,CAAY;;IAM3B,IAAW,KAAK,WAAkC;IAElD,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,mBAAmB;IAM3B,OAAO,CAAC,WAAW;IAInB;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO;IAI5D;;;;;;OAMG;IACU,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC;IAepG;;;OAGG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM;IAOrC;;;OAGG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM;IAOnC;;;;OAIG;IACU,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAqBxI;;;;QAII;IACS,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAWhJ;;;;OAIG;IACI,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,MAAM,GAAG,SAAS;IAe7H;;;OAGG;IACM,cAAc,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAQvD;;;;OAIG;IACI,aAAa,IAAI,MAAM,EAAE;CAGjC;AAED;;;;;;;GAOG;AACH,qBAAa,aAAc,YAAW,kBAAkB;IACtD,OAAO,CAAC,SAAS,CAAmB;IAEpC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,uBAAuB,CAAU;;IAUzC,IAAW,QAAQ,IAAI,cAAc,EAAE,CAA2B;IAElE;;;;;;;OAOG;IACI,UAAU,CAAC,OAAO,EAAE,cAAc;IAKzC;;;;;;;OAOG;IACI,kBAAkB,CAAC,OAAO,EAAE,cAAc;IASjD;;;OAGG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM;IAIrC;;;OAGG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM;IAInC;;;;OAIG;IACU,aAAa,CAAC,UAAU,EAAE,UAAU;IAQjD;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,OAAO;IAI5D;;;;;;;OAOG;IACU,gBAAgB,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC;IAIpG;;;;OAIG;IACU,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAWxI;;;;;OAKG;IACU,aAAa,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,eAAe,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAUvH;;;;;OAKG;IACI,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,GAAE,eAAwC,GAAG,MAAM,GAAG,SAAS;IAWnH;;;;;;OAMG;IACU,eAAe,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAI9I;;;;;;OAMG;IACI,mBAAmB,CAAC,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,GAAE,eAAwC,GAAG,MAAM,GAAG,SAAS;IAInI;;;;;;OAMG;IACU,aAAa,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAC5E,aAAa,CAAC,CAAC,SAAS,OAAO,UAAU,EAAE,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAY/I;;;;;;OAMG;IACI,iBAAiB,CAAC,aAAa,EAAE,aAAa,GAAG,UAAU,GAAG,SAAS;IACvE,iBAAiB,CAAC,CAAC,SAAS,OAAO,UAAU,EAAE,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS;IAYpI;;;;;OAKG;IACI,cAAc,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAIrD;;;;;;OAMG;IACI,eAAe,IAAI,MAAM,EAAE;CAGnC"}

package/lib/cjs/Context.js

@@ -1,10 +1,10 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaContext = exports.SchemaCache = void 0;
 /*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaContext = exports.SchemaCache = void 0;
 const ECObjects_1 = require("./ECObjects");
 const Exception_1 = require("./Exception");
 /**
@@ -310,29 +310,21 @@ class SchemaContext {
     getCachedSchemaSync(schemaKey, matchType = ECObjects_1.SchemaMatchType.Latest) {
         return this._knownSchemas.getSchemaSync(schemaKey, matchType);
     }
-    /**
-     * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].
-     * Will await a partially loaded schema then look in it for the requested item
-     * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.
-     * @returns The requested schema item
-     */
-    async getSchemaItem(schemaItemKey) {
+    async getSchemaItem(schemaItemKey, itemConstructor) {
         const schema = await this.getSchema(schemaItemKey.schemaKey, ECObjects_1.SchemaMatchType.Latest);
         if (undefined === schema)
             return undefined;
-        return schema.getItem(schemaItemKey.name);
+        if (undefined === itemConstructor)
+            return schema.getItem(schemaItemKey.name);
+        return schema.getItem(schemaItemKey.name, itemConstructor);
     }
-    /**
-     * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].
-     * Will skip a partially loaded schema and return undefined if the item belongs to that schema.  Use the async method to await partially loaded schemas.
-     * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.
-     * @returns The requested schema item
-     */
-    getSchemaItemSync(schemaItemKey) {
+    getSchemaItemSync(schemaItemKey, itemConstructor) {
         const schema = this.getSchemaSync(schemaItemKey.schemaKey, ECObjects_1.SchemaMatchType.Latest);
         if (undefined === schema)
             return undefined;
-        return schema.getItemSync(schemaItemKey.name);
+        if (undefined === itemConstructor)
+            return schema.getItemSync(schemaItemKey.name);
+        return schema.getItemSync(schemaItemKey.name, itemConstructor);
     }
     /**
      * Iterates through the items of each schema known to the context.  This includes schemas added to the

package/lib/cjs/Context.js.map

@@ -1 +1 @@
-{"version":3,"file":"Context.js","sourceRoot":"","sources":["../../src/Context.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,2CAA8C;AAC9C,2CAA8D;AAM9D;;GAEG;AACH,MAAM,SAAU,SAAQ,KAAkB;CAAI;AAuD9C;;GAEG;AACH,MAAa,WAAW;IACd,OAAO,CAAY;IAE3B;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,SAAS,EAAE,CAAC;IACjC,CAAC;IAED,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAE1C,kBAAkB,CAAC,SAA8B;QACvD,OAAO,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAChK,CAAC;IAEO,mBAAmB,CAAC,SAA8B;QACxD,OAAO,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,IAAI,SAAS,KAAK,KAAK,CAAC,aAAa,CAAC,CAAC;IAC7K,CAAC;IAEO,SAAS,CAAC,SAA8B,EAAE,SAA0B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7G,CAAC;IAEO,mBAAmB,CAAC,SAA8B;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,CAAC;QAChE,IAAI,KAAK;YACP,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;IACpC,CAAC;IAEO,WAAW,CAAC,SAA8B;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7G,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,SAA8B;QAChD,OAAO,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,gBAAgB,CAAC,UAAsB,EAAE,MAAc,EAAE,aAA8B;QAClG,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC;YACzC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,eAAe,EAAE,eAAe,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAEjJ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QAEzD,qFAAqF;QACrF,6GAA6G;QAC7G,yFAAyF;QACzF,mEAAmE;QACnE,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE;YACtB,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAmB,MAAS;QAChD,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC;YACrC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,eAAe,EAAE,eAAe,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAE7I,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,aAAa,CAAmB,MAAS;QAC9C,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC;YACrC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,eAAe,EAAE,eAAe,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAE7I,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAmB,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QAC1H,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAClB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,KAAK;YACR,OAAO,SAAS,CAAC;QAEnB,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,aAAkB,CAAC;gBAC9C,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBAC5B,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,MAAW,CAAC;IAC3B,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,aAAa,CAAC,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QAC5G,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAClB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnD,IAAI,KAAK;YACP,OAAO,KAAK,CAAC,UAAU,CAAC;QAE1B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAmB,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QACxH,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAClB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;gBACxB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,kBAAkB,EAAE,cAAc,SAAS,CAAC,QAAQ,EAAE,yDAAyD,CAAC,CAAC;YAC5J,CAAC;YACD,OAAO,KAAK,CAAC,MAAW,CAAC;QAC3B,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,CAAE,cAAc;QACrB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACjD,MAAM,UAAU,CAAC;YACnB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;CACF;AArKD,kCAqKC;AAED;;;;;;;GAOG;AACH,MAAa,aAAa;IAChB,SAAS,CAAmB;IAE5B,aAAa,CAAc;IAC3B,uBAAuB,CAAU;IAEzC;QACE,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC;QACvC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACxC,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC;IACvC,CAAC;IAED,IAAW,QAAQ,KAAuB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAElE;;;;;;;OAOG;IACI,UAAU,CAAC,OAAuB;QACvC,MAAM,WAAW,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QACvI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACI,kBAAkB,CAAC,OAAuB;QAC/C,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC7B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,MAAc;QACnC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,MAAc;QACjC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,UAAsB;QAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,2BAAe,CAAC,KAAK,CAAC,CAAC;QACrF,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,oBAAoB,EAAE,iCAAiC,UAAU,CAAC,IAAI,kBAAkB,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,2CAA2C,CAAC,CAAC;QAElN,MAAwB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,SAA8B;QAChD,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,gBAAgB,CAAC,UAAsB,EAAE,MAAc,EAAE,aAA8B;QAClG,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IAChF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAmB,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QAC1H,0FAA0F;QAC1F,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAI,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YACtE,IAAI,SAAS,KAAK,MAAM;gBACtB,OAAO,MAAM,CAAC;QAClB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,SAA8B,EAAE,SAA0B;QACnF,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC3E,IAAI,SAAS,KAAK,UAAU;gBAC1B,OAAO,UAAU,CAAC;QACtB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAmB,SAAoB,EAAE,YAA6B,2BAAe,CAAC,MAAM;QAC9G,0FAA0F;QAC1F,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAI,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YACpE,IAAI,SAAS,KAAK,MAAM;gBACtB,OAAO,MAAM,CAAC;QAClB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,eAAe,CAAmB,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QAChI,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAI,SAAS,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAAmB,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QAC9H,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,CAAI,SAAS,EAAE,SAAS,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAuB,aAA4B;QAC3E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,CAAC;QACrF,IAAI,SAAS,KAAK,MAAM;YACtB,OAAO,SAAS,CAAC;QACnB,OAAO,MAAM,CAAC,OAAO,CAAI,aAAa,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,iBAAiB,CAAuB,aAA4B;QACzE,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,MAAM;YACtB,OAAO,SAAS,CAAC;QACnB,OAAO,MAAM,CAAC,WAAW,CAAI,aAAa,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACI,eAAe;QACpB,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC;IAC5C,CAAC;CACF;AApND,sCAoNC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { SchemaMatchType } from \"./ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\r\nimport { SchemaInfo } from \"./Interfaces\";\r\nimport { MutableSchema, Schema } from \"./Metadata/Schema\";\r\nimport { SchemaItem } from \"./Metadata/SchemaItem\";\r\nimport { SchemaItemKey, SchemaKey } from \"./SchemaKey\";\r\n\r\n/**\r\n * @internal\r\n */\r\nclass SchemaMap extends Array<SchemaEntry> { }\r\n\r\n/**\r\n * @internal\r\n */\r\ninterface SchemaEntry {\r\n  schemaInfo: SchemaInfo;\r\n  schema: Schema;\r\n  schemaPromise?: Promise<Schema>;\r\n}\r\n\r\n/**\r\n * The interface defines what is needed to be an `ISchemaLocater`.\r\n * A Schema Locater loads the requested schema if it can or returns undefined.\r\n * Schema Locaters should always load the schema on each request and should not hold a cache of schemas.\r\n * Schema locaters should never be used directly to load a schema, they should be added to a `SchemaContext`\r\n * and the context should be used to load schemas.  The `SchemaContext` caches schemas and manages schema life time.\r\n * @beta\r\n */\r\nexport interface ISchemaLocater {\r\n\r\n  /**\r\n   * Attempts to get a schema from the locater. Yields undefined if no matching schema is found.\r\n   * For schemas that may have references, construct and call through a SchemaContext instead.\r\n   * @param schemaKey key to look up\r\n   * @param matchType how to match key against candidate schemas\r\n   * @param context context for loading schema references\r\n   */\r\n  getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<T | undefined>;\r\n\r\n  /**\r\n  * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\r\n  * May return the entire Schema so long as it is completely loaded as it satisfies the SchemaInfo interface.\r\n  * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n  * @param matchType The match type to use when locating the schema\r\n  */\r\n  getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;\r\n\r\n  /**\r\n   * Attempts to get a schema from the locater. Yields undefined if no matching schema is found.\r\n   * For schemas that may have references, construct and call through a SchemaContext instead.\r\n   * @param schemaKey key to look up\r\n   * @param matchType how to match key against candidate schemas\r\n   * @param context context for loading schema references\r\n   */\r\n  getSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): T | undefined;\r\n}\r\n\r\n/**\r\n * @beta\r\n */\r\nexport interface ISchemaItemLocater {\r\n  getSchemaItem<T extends SchemaItem>(schemaItemKey: SchemaItemKey): Promise<T | undefined>;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport class SchemaCache implements ISchemaLocater {\r\n  private _schema: SchemaMap;\r\n\r\n  constructor() {\r\n    this._schema = new SchemaMap();\r\n  }\r\n\r\n  public get count() { return this._schema.length; }\r\n\r\n  private loadedSchemaExists(schemaKey: Readonly<SchemaKey>): boolean {\r\n    return undefined !== this._schema.find((entry: SchemaEntry) => entry.schemaInfo.schemaKey.matches(schemaKey, SchemaMatchType.Latest) && !entry.schemaPromise);\r\n  }\r\n\r\n  private schemaPromiseExists(schemaKey: Readonly<SchemaKey>): boolean {\r\n    return undefined !== this._schema.find((entry: SchemaEntry) => entry.schemaInfo.schemaKey.matches(schemaKey, SchemaMatchType.Latest) && undefined !== entry.schemaPromise);\r\n  }\r\n\r\n  private findEntry(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType): SchemaEntry | undefined {\r\n    return this._schema.find((entry: SchemaEntry) => entry.schemaInfo.schemaKey.matches(schemaKey, matchType));\r\n  }\r\n\r\n  private removeSchemaPromise(schemaKey: Readonly<SchemaKey>) {\r\n    const entry = this.findEntry(schemaKey, SchemaMatchType.Latest);\r\n    if (entry)\r\n      entry.schemaPromise = undefined;\r\n  }\r\n\r\n  private removeEntry(schemaKey: Readonly<SchemaKey>) {\r\n    this._schema = this._schema.filter((entry: SchemaEntry) => !entry.schemaInfo.schemaKey.matches(schemaKey));\r\n  }\r\n\r\n  /**\r\n   * Returns true if the schema exists in either the schema cache or the promise cache.  SchemaMatchType.Latest used.\r\n   * @param schemaKey The key to search for.\r\n   */\r\n  public schemaExists(schemaKey: Readonly<SchemaKey>): boolean {\r\n    return this.loadedSchemaExists(schemaKey) || this.schemaPromiseExists(schemaKey);\r\n  }\r\n\r\n  /**\r\n   * Adds a promise to load the schema to the cache. Does not allow for duplicate schemas in the cache of schemas or cache of promises, checks using SchemaMatchType.Latest.\r\n   * When the promise completes the schema will be added to the schema cache and the promise will be removed from the promise cache\r\n   * @param schemaInfo An object with the schema key for the schema being loaded and it's references\r\n   * @param schema The partially loaded schema that the promise will fulfill\r\n   * @param schemaPromise The schema promise to add to the cache.\r\n   */\r\n  public async addSchemaPromise(schemaInfo: SchemaInfo, schema: Schema, schemaPromise: Promise<Schema>) {\r\n    if (this.schemaExists(schemaInfo.schemaKey))\r\n      throw new ECObjectsError(ECObjectsStatus.DuplicateSchema, `The schema, ${schemaInfo.schemaKey.toString()}, already exists within this cache.`);\r\n\r\n    this._schema.push({ schemaInfo, schema, schemaPromise });\r\n\r\n    // This promise is cached and will be awaited when the user requests the full schema.\r\n    // If the promise competes successfully before the user requests the schema it will be removed from the cache\r\n    // If it fails it will remain in the cache until the user awaits it and handles the error\r\n    // eslint-disable-next-line @typescript-eslint/no-floating-promises\r\n    schemaPromise.then(() => {\r\n      this.removeSchemaPromise(schemaInfo.schemaKey);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Adds a schema to the cache. Does not allow for duplicate schemas, checks using SchemaMatchType.Latest.\r\n   * @param schema The schema to add to the cache.\r\n   */\r\n  public async addSchema<T extends Schema>(schema: T) {\r\n    if (this.schemaExists(schema.schemaKey))\r\n      throw new ECObjectsError(ECObjectsStatus.DuplicateSchema, `The schema, ${schema.schemaKey.toString()}, already exists within this cache.`);\r\n\r\n    this._schema.push({ schemaInfo: schema, schema });\r\n  }\r\n\r\n  /**\r\n   * Adds a schema to the cache. Does not allow for duplicate schemas, checks using SchemaMatchType.Latest.\r\n   * @param schema The schema to add to the cache.\r\n   */\r\n  public addSchemaSync<T extends Schema>(schema: T) {\r\n    if (this.schemaExists(schema.schemaKey))\r\n      throw new ECObjectsError(ECObjectsStatus.DuplicateSchema, `The schema, ${schema.schemaKey.toString()}, already exists within this cache.`);\r\n\r\n    this._schema.push({ schemaInfo: schema, schema });\r\n  }\r\n\r\n  /**\r\n   * Gets the schema which matches the provided SchemaKey.\r\n   * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n   * @param matchType The match type to use when locating the schema\r\n   */\r\n  public async getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<T | undefined> {\r\n    if (this.count === 0)\r\n      return undefined;\r\n\r\n    const entry = this.findEntry(schemaKey, matchType);\r\n    if (!entry)\r\n      return undefined;\r\n\r\n    if (entry.schemaPromise) {\r\n      try {\r\n        const schema = await entry.schemaPromise as T;\r\n        return schema;\r\n      } catch (e) {\r\n        this.removeEntry(schemaKey);\r\n        throw e;\r\n      }\r\n    }\r\n\r\n    return entry.schema as T;\r\n  }\r\n\r\n  /**\r\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\r\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n    * @param matchType The match type to use when locating the schema\r\n    */\r\n  public async getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<SchemaInfo | undefined> {\r\n    if (this.count === 0)\r\n      return undefined;\r\n\r\n    const entry = this.findEntry(schemaKey, matchType);\r\n    if (entry)\r\n      return entry.schemaInfo;\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Gets the schema which matches the provided SchemaKey.  If the schema is partially loaded an exception will be thrown.\r\n   * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n   * @param matchType The match type to use when locating the schema\r\n   */\r\n  public getSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): T | undefined {\r\n    if (this.count === 0)\r\n      return undefined;\r\n\r\n    const entry = this.findEntry(schemaKey, matchType);\r\n    if (entry) {\r\n      if (entry.schemaPromise) {\r\n        throw new ECObjectsError(ECObjectsStatus.UnableToLoadSchema, `The Schema ${schemaKey.toString()} is partially loaded so cannot be loaded synchronously.`);\r\n      }\r\n      return entry.schema as T;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Generator function that can iterate through each schema in _schema SchemaMap and items for each Schema.\r\n   * Does not include schema items from schemas that are not completely loaded yet.\r\n   */\r\n  public * getSchemaItems(): IterableIterator<SchemaItem> {\r\n    for (const entry of this._schema) {\r\n      for (const schemaItem of entry.schema.getItems()) {\r\n        yield schemaItem;\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets all the schemas from the schema cache.\r\n   * Does not include schemas from schemas that are not completely loaded yet.\r\n   * @returns An array of Schema objects.\r\n   */\r\n  public getAllSchemas(): Schema[] {\r\n    return this._schema.map((entry: SchemaEntry) => entry.schema);\r\n  }\r\n}\r\n\r\n/**\r\n * The SchemaContext, context object is used to facilitate schema and schema item location.\r\n *\r\n * The context controls the lifetime of each schema that it knows about. It has to be explicitly removed from the context to delete a schema object.\r\n *\r\n * The context is made up of a group of Schema Locators.\r\n * @beta\r\n */\r\nexport class SchemaContext implements ISchemaItemLocater {\r\n  private _locaters: ISchemaLocater[];\r\n\r\n  private _knownSchemas: SchemaCache;\r\n  private _fallbackLocaterDefined: boolean;\r\n\r\n  constructor() {\r\n    this._locaters = [];\r\n\r\n    this._knownSchemas = new SchemaCache();\r\n    this._locaters.push(this._knownSchemas);\r\n    this._fallbackLocaterDefined = false;\r\n  }\r\n\r\n  public get locaters(): ISchemaLocater[] { return this._locaters; }\r\n\r\n  /**\r\n   * Adds a locater to the context.\r\n   *\r\n   * If no locaters are defined or a fallback locater is not defined, the new locater is added at the end of the locaters array.\r\n   * If a fallback locater is already defined, the new locater is inserted before the fallback locater.\r\n   *\r\n   * @param locater - The locater to be added.\r\n   */\r\n  public addLocater(locater: ISchemaLocater) {\r\n    const insertIndex = (this._locaters.length === 0 || !this._fallbackLocaterDefined) ? this._locaters.length : this._locaters.length - 1;\r\n    this._locaters.splice(insertIndex, 0, locater);\r\n  }\r\n\r\n  /**\r\n   * Adds a fallback locater to the context.\r\n   *\r\n   * If a fallback locater is already defined, it replaces the existing one.\r\n   * Otherwise, it adds the new locater to the end of the locaters array and marks the fallback locater as defined.\r\n   *\r\n   * @param locater - The locater to be added as a fallback.\r\n   */\r\n  public addFallbackLocater(locater: ISchemaLocater) {\r\n    if (this._fallbackLocaterDefined) {\r\n      this._locaters[this._locaters.length - 1] = locater;\r\n    } else {\r\n      this._locaters.push(locater);\r\n      this._fallbackLocaterDefined = true;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Adds the schema to this context.  Use addSchemaPromise instead when asynchronously loading schemas.\r\n   * @param schema The schema to add to this context\r\n   */\r\n  public async addSchema(schema: Schema) {\r\n    this.addSchemaSync(schema);\r\n  }\r\n\r\n  /**\r\n   * Adds the schema to this context\r\n   * @param schema The schema to add to this context\r\n   */\r\n  public addSchemaSync(schema: Schema) {\r\n    this._knownSchemas.addSchemaSync(schema);\r\n  }\r\n\r\n  /**\r\n   * Adds the given SchemaItem to the the SchemaContext by locating the schema, with the best match of SchemaMatchType.Exact, and\r\n   * @param schemaItem The SchemaItem to add\r\n   * @deprecated in 4.0 use ecschema-editing package\r\n   */\r\n  public async addSchemaItem(schemaItem: SchemaItem) {\r\n    const schema = await this.getSchema(schemaItem.key.schemaKey, SchemaMatchType.Exact);\r\n    if (!schema)\r\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to add the schema item ${schemaItem.name} to the schema ${schemaItem.key.schemaKey.toString()} because the schema could not be located.`);\r\n\r\n    (schema as MutableSchema).addItem(schemaItem);\r\n  }\r\n\r\n  /**\r\n   * Returns true if the schema is already in the context.  SchemaMatchType.Latest is used to find a match.\r\n   * @param schemaKey\r\n   */\r\n  public schemaExists(schemaKey: Readonly<SchemaKey>): boolean {\r\n    return this._knownSchemas.schemaExists(schemaKey);\r\n  }\r\n\r\n  /**\r\n   * Adds a promise to load the schema to the cache. Does not allow for duplicate schemas in the cache of schemas or cache of promises, checks using SchemaMatchType.Latest.\r\n   * When the promise completes the schema will be added to the schema cache and the promise will be removed from the promise cache.\r\n   * Use this method over addSchema when asynchronously loading schemas\r\n   * @param schemaInfo An object with the schema key for the schema being loaded and it's references\r\n   * @param schema The partially loaded schema that the promise will fulfill\r\n   * @param schemaPromise The schema promise to add to the cache.\r\n   */\r\n  public async addSchemaPromise(schemaInfo: SchemaInfo, schema: Schema, schemaPromise: Promise<Schema>) {\r\n    return this._knownSchemas.addSchemaPromise(schemaInfo, schema, schemaPromise);\r\n  }\r\n\r\n  /** Attempts to obtain a schema from this context that matches the specified criteria.\r\n   * @param schemaKey Identifies the schema to obtain.\r\n   * @param matchType Criteria by which to identify potentially matching schemas.\r\n   * @returns the schema matching the input criteria, or `undefined` if no such schema could be located.\r\n   */\r\n  public async getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<T | undefined> {\r\n    // the first locater is _knownSchemas, so we don't have to check the cache explicitly here\r\n    for (const locater of this._locaters) {\r\n      const schema = await locater.getSchema<T>(schemaKey, matchType, this);\r\n      if (undefined !== schema)\r\n        return schema;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\r\n   * The fully loaded schema can be gotten later from the context using [[getSchema]].\r\n   * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n   * @param matchType The match type to use when locating the schema\r\n   */\r\n  public async getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType): Promise<SchemaInfo | undefined> {\r\n    for (const locater of this._locaters) {\r\n      const schemaInfo = await locater.getSchemaInfo(schemaKey, matchType, this);\r\n      if (undefined !== schemaInfo)\r\n        return schemaInfo;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /** Attempts to obtain a schema from this context that matches the specified criteria.\r\n   * Will return undefined if the schema is partially loaded.  Use [[getSchema]] to await until the schema is completely loaded.\r\n   * @param schemaKey Identifies the schema to obtain.\r\n   * @param matchType Criteria by which to identify potentially matching schemas.\r\n   * @returns the schema matching the input criteria, or `undefined` if no such schema could be located.\r\n   */\r\n  public getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType = SchemaMatchType.Latest): T | undefined {\r\n    // the first locater is _knownSchemas, so we don't have to check the cache explicitly here\r\n    for (const locater of this._locaters) {\r\n      const schema = locater.getSchemaSync<T>(schemaKey, matchType, this);\r\n      if (undefined !== schema)\r\n        return schema;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Attempts to get a Schema from the context's cache.\r\n   * Will await a partially loaded schema then return when it is completely loaded.\r\n   * @param schemaKey The SchemaKey to identify the Schema.\r\n   * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.\r\n   * @internal\r\n   */\r\n  public async getCachedSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<T | undefined> {\r\n    return this._knownSchemas.getSchema<T>(schemaKey, matchType);\r\n  }\r\n\r\n  /**\r\n   * Attempts to get a Schema from the context's cache.\r\n   * Will return undefined if the cached schema is partially loaded.  Use [[getCachedSchema]] to await until the schema is completely loaded.\r\n   * @param schemaKey The SchemaKey to identify the Schema.\r\n   * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.\r\n   * @internal\r\n   */\r\n  public getCachedSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): T | undefined {\r\n    return this._knownSchemas.getSchemaSync<T>(schemaKey, matchType);\r\n  }\r\n\r\n  /**\r\n   * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].\r\n   * Will await a partially loaded schema then look in it for the requested item\r\n   * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.\r\n   * @returns The requested schema item\r\n   */\r\n  public async getSchemaItem<T extends SchemaItem>(schemaItemKey: SchemaItemKey): Promise<T | undefined> {\r\n    const schema = await this.getSchema(schemaItemKey.schemaKey, SchemaMatchType.Latest);\r\n    if (undefined === schema)\r\n      return undefined;\r\n    return schema.getItem<T>(schemaItemKey.name);\r\n  }\r\n\r\n  /**\r\n   * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].\r\n   * Will skip a partially loaded schema and return undefined if the item belongs to that schema.  Use the async method to await partially loaded schemas.\r\n   * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.\r\n   * @returns The requested schema item\r\n   */\r\n  public getSchemaItemSync<T extends SchemaItem>(schemaItemKey: SchemaItemKey): T | undefined {\r\n    const schema = this.getSchemaSync(schemaItemKey.schemaKey, SchemaMatchType.Latest);\r\n    if (undefined === schema)\r\n      return undefined;\r\n    return schema.getItemSync<T>(schemaItemKey.name);\r\n  }\r\n\r\n  /**\r\n   * Iterates through the items of each schema known to the context.  This includes schemas added to the\r\n   * context using [[SchemaContext.addSchema]]. This does not include schemas that\r\n   * can be located by an ISchemaLocater instance added to the context.\r\n   * Does not include schema items from schemas that are not completely loaded yet.\r\n   */\r\n  public getSchemaItems(): IterableIterator<SchemaItem> {\r\n    return this._knownSchemas.getSchemaItems();\r\n  }\r\n\r\n  /**\r\n   * Gets all the Schemas known by the context. This includes schemas added to the\r\n   * context using [[SchemaContext.addSchema]]. This does not include schemas that\r\n   * can be located by an ISchemaLocater instance added to the context.  Does not\r\n   * include schemas that are partially loaded.\r\n   * @returns An array of Schema objects.\r\n   */\r\n  public getKnownSchemas(): Schema[] {\r\n    return this._knownSchemas.getAllSchemas();\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Context.js","sourceRoot":"","sources":["../../src/Context.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F,2CAA8C;AAC9C,2CAA8D;AAM9D;;GAEG;AACH,MAAM,SAAU,SAAQ,KAAkB;CAAI;AAyE9C;;GAEG;AACH,MAAa,WAAW;IACd,OAAO,CAAY;IAE3B;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,SAAS,EAAE,CAAC;IACjC,CAAC;IAED,IAAW,KAAK,KAAK,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAE1C,kBAAkB,CAAC,SAA8B;QACvD,OAAO,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAChK,CAAC;IAEO,mBAAmB,CAAC,SAA8B;QACxD,OAAO,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,IAAI,SAAS,KAAK,KAAK,CAAC,aAAa,CAAC,CAAC;IAC7K,CAAC;IAEO,SAAS,CAAC,SAA8B,EAAE,SAA0B;QAC1E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7G,CAAC;IAEO,mBAAmB,CAAC,SAA8B;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,CAAC;QAChE,IAAI,KAAK;YACP,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC;IACpC,CAAC;IAEO,WAAW,CAAC,SAA8B;QAChD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAC7G,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,SAA8B;QAChD,OAAO,IAAI,CAAC,kBAAkB,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,gBAAgB,CAAC,UAAsB,EAAE,MAAc,EAAE,aAA8B;QAClG,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC;YACzC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,eAAe,EAAE,eAAe,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAEjJ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC;QAEzD,qFAAqF;QACrF,6GAA6G;QAC7G,yFAAyF;QACzF,mEAAmE;QACnE,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE;YACtB,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,MAAc;QACnC,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC;YACrC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,eAAe,EAAE,eAAe,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAE7I,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,MAAc;QACjC,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC;YACrC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,eAAe,EAAE,eAAe,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,qCAAqC,CAAC,CAAC;QAE7I,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QACxG,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAClB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnD,IAAI,CAAC,KAAK;YACR,OAAO,SAAS,CAAC;QAEnB,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;YACxB,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,aAAa,CAAC;gBACzC,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;gBAC5B,MAAM,CAAC,CAAC;YACV,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,CAAC;IACtB,CAAC;IAED;;;;QAII;IACG,KAAK,CAAC,aAAa,CAAC,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QAC5G,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAClB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnD,IAAI,KAAK;YACP,OAAO,KAAK,CAAC,UAAU,CAAC;QAE1B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QACtG,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAClB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACnD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;gBACxB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,kBAAkB,EAAE,cAAc,SAAS,CAAC,QAAQ,EAAE,yDAAyD,CAAC,CAAC;YAC5J,CAAC;YACD,OAAO,KAAK,CAAC,MAAM,CAAC;QACtB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;OAGG;IACI,CAAE,cAAc;QACrB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjC,KAAK,MAAM,UAAU,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;gBACjD,MAAM,UAAU,CAAC;YACnB,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAChE,CAAC;CACF;AArKD,kCAqKC;AAED;;;;;;;GAOG;AACH,MAAa,aAAa;IAChB,SAAS,CAAmB;IAE5B,aAAa,CAAc;IAC3B,uBAAuB,CAAU;IAEzC;QACE,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;QAEpB,IAAI,CAAC,aAAa,GAAG,IAAI,WAAW,EAAE,CAAC;QACvC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACxC,IAAI,CAAC,uBAAuB,GAAG,KAAK,CAAC;IACvC,CAAC;IAED,IAAW,QAAQ,KAAuB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAElE;;;;;;;OAOG;IACI,UAAU,CAAC,OAAuB;QACvC,MAAM,WAAW,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;QACvI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACI,kBAAkB,CAAC,OAAuB;QAC/C,IAAI,IAAI,CAAC,uBAAuB,EAAE,CAAC;YACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC7B,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,MAAc;QACnC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,MAAc;QACjC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa,CAAC,UAAsB;QAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,2BAAe,CAAC,KAAK,CAAC,CAAC;QACrF,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,oBAAoB,EAAE,iCAAiC,UAAU,CAAC,IAAI,kBAAkB,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,2CAA2C,CAAC,CAAC;QAElN,MAAwB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,SAA8B;QAChD,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,gBAAgB,CAAC,UAAsB,EAAE,MAAc,EAAE,aAA8B;QAClG,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IAChF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QACxG,0FAA0F;QAC1F,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YACnE,IAAI,SAAS,KAAK,MAAM;gBACtB,OAAO,MAAM,CAAC;QAClB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,SAA8B,EAAE,SAA0B;QACnF,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,UAAU,GAAG,MAAM,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YAC3E,IAAI,SAAS,KAAK,UAAU;gBAC1B,OAAO,UAAU,CAAC;QACtB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,SAAoB,EAAE,YAA6B,2BAAe,CAAC,MAAM;QAC5F,0FAA0F;QAC1F,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;YACjE,IAAI,SAAS,KAAK,MAAM;gBACtB,OAAO,MAAM,CAAC;QAClB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,eAAe,CAAC,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QAC9G,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CAAC,SAA8B,EAAE,YAA6B,2BAAe,CAAC,MAAM;QAC5G,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAChE,CAAC;IAWM,KAAK,CAAC,aAAa,CAA8B,aAA4B,EAAE,eAAmB;QACvG,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,CAAC;QACrF,IAAI,SAAS,KAAK,MAAM;YACtB,OAAO,SAAS,CAAC;QAEnB,IAAG,SAAS,KAAK,eAAe;YAC9B,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAE5C,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IAC7D,CAAC;IAWM,iBAAiB,CAA8B,aAA4B,EAAE,eAAmB;QACrG,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,SAAS,EAAE,2BAAe,CAAC,MAAM,CAAC,CAAC;QACnF,IAAI,SAAS,KAAK,MAAM;YACtB,OAAO,SAAS,CAAC;QAEnB,IAAG,SAAS,KAAK,eAAe;YAC9B,OAAO,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAEhD,OAAO,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC;IAC7C,CAAC;IAED;;;;;;OAMG;IACI,eAAe;QACpB,OAAO,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE,CAAC;IAC5C,CAAC;CACF;AAlOD,sCAkOC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { SchemaMatchType } from \"./ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\r\nimport { SchemaInfo } from \"./Interfaces\";\r\nimport { MutableSchema, Schema } from \"./Metadata/Schema\";\r\nimport { SchemaItem } from \"./Metadata/SchemaItem\";\r\nimport { SchemaItemKey, SchemaKey } from \"./SchemaKey\";\r\n\r\n/**\r\n * @internal\r\n */\r\nclass SchemaMap extends Array<SchemaEntry> { }\r\n\r\n/**\r\n * @internal\r\n */\r\ninterface SchemaEntry {\r\n  schemaInfo: SchemaInfo;\r\n  schema: Schema;\r\n  schemaPromise?: Promise<Schema>;\r\n}\r\n\r\n/**\r\n * The interface defines what is needed to be an `ISchemaLocater`.\r\n * A Schema Locater loads the requested schema if it can or returns undefined.\r\n * Schema Locaters should always load the schema on each request and should not hold a cache of schemas.\r\n * Schema locaters should never be used directly to load a schema, they should be added to a `SchemaContext`\r\n * and the context should be used to load schemas.  The `SchemaContext` caches schemas and manages schema life time.\r\n * @beta\r\n */\r\nexport interface ISchemaLocater {\r\n\r\n  /**\r\n   * Attempts to get a schema from the locater. Yields undefined if no matching schema is found.\r\n   * For schemas that may have references, construct and call through a SchemaContext instead.\r\n   * @param schemaKey key to look up\r\n   * @param matchType how to match key against candidate schemas\r\n   * @param context context for loading schema references\r\n   */\r\n  getSchema(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<Schema | undefined>;\r\n\r\n  /**\r\n  * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\r\n  * May return the entire Schema so long as it is completely loaded as it satisfies the SchemaInfo interface.\r\n  * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n  * @param matchType The match type to use when locating the schema\r\n  */\r\n  getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;\r\n\r\n  /**\r\n   * Attempts to get a schema from the locater. Yields undefined if no matching schema is found.\r\n   * For schemas that may have references, construct and call through a SchemaContext instead.\r\n   * @param schemaKey key to look up\r\n   * @param matchType how to match key against candidate schemas\r\n   * @param context context for loading schema references\r\n   */\r\n  getSchemaSync(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Schema | undefined;\r\n}\r\n\r\n/**\r\n * Base interface for types that allow location of items inside a schema\r\n * @beta\r\n */\r\nexport interface ISchemaItemLocater {\r\n  /**\r\n   * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].\r\n   * Will await a partially loaded schema then look in it for the requested item.\r\n   * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.\r\n   * @returns The requested schema item.\r\n   */\r\n  getSchemaItem(schemaItemKey: SchemaItemKey): Promise<SchemaItem | undefined>;\r\n  getSchemaItem<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): Promise<InstanceType<T> | undefined>;\r\n\r\n  /**\r\n   * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].\r\n   * Will skip a partially loaded schema and return undefined if the item belongs to that schema. Use the async method to await partially loaded schemas.\r\n   * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.\r\n   * @param itemConstructor The constructor of the item to return.\r\n   * @returns The requested schema item.\r\n   */\r\n  getSchemaItemSync(schemaItemKey: SchemaItemKey): SchemaItem | undefined;\r\n  getSchemaItemSync<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): InstanceType<T> | undefined;\r\n}\r\n\r\n/**\r\n * @internal\r\n */\r\nexport class SchemaCache implements ISchemaLocater {\r\n  private _schema: SchemaMap;\r\n\r\n  constructor() {\r\n    this._schema = new SchemaMap();\r\n  }\r\n\r\n  public get count() { return this._schema.length; }\r\n\r\n  private loadedSchemaExists(schemaKey: Readonly<SchemaKey>): boolean {\r\n    return undefined !== this._schema.find((entry: SchemaEntry) => entry.schemaInfo.schemaKey.matches(schemaKey, SchemaMatchType.Latest) && !entry.schemaPromise);\r\n  }\r\n\r\n  private schemaPromiseExists(schemaKey: Readonly<SchemaKey>): boolean {\r\n    return undefined !== this._schema.find((entry: SchemaEntry) => entry.schemaInfo.schemaKey.matches(schemaKey, SchemaMatchType.Latest) && undefined !== entry.schemaPromise);\r\n  }\r\n\r\n  private findEntry(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType): SchemaEntry | undefined {\r\n    return this._schema.find((entry: SchemaEntry) => entry.schemaInfo.schemaKey.matches(schemaKey, matchType));\r\n  }\r\n\r\n  private removeSchemaPromise(schemaKey: Readonly<SchemaKey>) {\r\n    const entry = this.findEntry(schemaKey, SchemaMatchType.Latest);\r\n    if (entry)\r\n      entry.schemaPromise = undefined;\r\n  }\r\n\r\n  private removeEntry(schemaKey: Readonly<SchemaKey>) {\r\n    this._schema = this._schema.filter((entry: SchemaEntry) => !entry.schemaInfo.schemaKey.matches(schemaKey));\r\n  }\r\n\r\n  /**\r\n   * Returns true if the schema exists in either the schema cache or the promise cache.  SchemaMatchType.Latest used.\r\n   * @param schemaKey The key to search for.\r\n   */\r\n  public schemaExists(schemaKey: Readonly<SchemaKey>): boolean {\r\n    return this.loadedSchemaExists(schemaKey) || this.schemaPromiseExists(schemaKey);\r\n  }\r\n\r\n  /**\r\n   * Adds a promise to load the schema to the cache. Does not allow for duplicate schemas in the cache of schemas or cache of promises, checks using SchemaMatchType.Latest.\r\n   * When the promise completes the schema will be added to the schema cache and the promise will be removed from the promise cache\r\n   * @param schemaInfo An object with the schema key for the schema being loaded and it's references\r\n   * @param schema The partially loaded schema that the promise will fulfill\r\n   * @param schemaPromise The schema promise to add to the cache.\r\n   */\r\n  public async addSchemaPromise(schemaInfo: SchemaInfo, schema: Schema, schemaPromise: Promise<Schema>) {\r\n    if (this.schemaExists(schemaInfo.schemaKey))\r\n      throw new ECObjectsError(ECObjectsStatus.DuplicateSchema, `The schema, ${schemaInfo.schemaKey.toString()}, already exists within this cache.`);\r\n\r\n    this._schema.push({ schemaInfo, schema, schemaPromise });\r\n\r\n    // This promise is cached and will be awaited when the user requests the full schema.\r\n    // If the promise competes successfully before the user requests the schema it will be removed from the cache\r\n    // If it fails it will remain in the cache until the user awaits it and handles the error\r\n    // eslint-disable-next-line @typescript-eslint/no-floating-promises\r\n    schemaPromise.then(() => {\r\n      this.removeSchemaPromise(schemaInfo.schemaKey);\r\n    });\r\n  }\r\n\r\n  /**\r\n   * Adds a schema to the cache. Does not allow for duplicate schemas, checks using SchemaMatchType.Latest.\r\n   * @param schema The schema to add to the cache.\r\n   */\r\n  public async addSchema(schema: Schema) {\r\n    if (this.schemaExists(schema.schemaKey))\r\n      throw new ECObjectsError(ECObjectsStatus.DuplicateSchema, `The schema, ${schema.schemaKey.toString()}, already exists within this cache.`);\r\n\r\n    this._schema.push({ schemaInfo: schema, schema });\r\n  }\r\n\r\n  /**\r\n   * Adds a schema to the cache. Does not allow for duplicate schemas, checks using SchemaMatchType.Latest.\r\n   * @param schema The schema to add to the cache.\r\n   */\r\n  public addSchemaSync(schema: Schema) {\r\n    if (this.schemaExists(schema.schemaKey))\r\n      throw new ECObjectsError(ECObjectsStatus.DuplicateSchema, `The schema, ${schema.schemaKey.toString()}, already exists within this cache.`);\r\n\r\n    this._schema.push({ schemaInfo: schema, schema });\r\n  }\r\n\r\n  /**\r\n   * Gets the schema which matches the provided SchemaKey.\r\n   * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n   * @param matchType The match type to use when locating the schema\r\n   */\r\n  public async getSchema(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<Schema | undefined> {\r\n    if (this.count === 0)\r\n      return undefined;\r\n\r\n    const entry = this.findEntry(schemaKey, matchType);\r\n    if (!entry)\r\n      return undefined;\r\n\r\n    if (entry.schemaPromise) {\r\n      try {\r\n        const schema = await entry.schemaPromise;\r\n        return schema;\r\n      } catch (e) {\r\n        this.removeEntry(schemaKey);\r\n        throw e;\r\n      }\r\n    }\r\n\r\n    return entry.schema;\r\n  }\r\n\r\n  /**\r\n    * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\r\n    * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n    * @param matchType The match type to use when locating the schema\r\n    */\r\n  public async getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<SchemaInfo | undefined> {\r\n    if (this.count === 0)\r\n      return undefined;\r\n\r\n    const entry = this.findEntry(schemaKey, matchType);\r\n    if (entry)\r\n      return entry.schemaInfo;\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Gets the schema which matches the provided SchemaKey.  If the schema is partially loaded an exception will be thrown.\r\n   * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n   * @param matchType The match type to use when locating the schema\r\n   */\r\n  public getSchemaSync(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Schema | undefined {\r\n    if (this.count === 0)\r\n      return undefined;\r\n\r\n    const entry = this.findEntry(schemaKey, matchType);\r\n    if (entry) {\r\n      if (entry.schemaPromise) {\r\n        throw new ECObjectsError(ECObjectsStatus.UnableToLoadSchema, `The Schema ${schemaKey.toString()} is partially loaded so cannot be loaded synchronously.`);\r\n      }\r\n      return entry.schema;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Generator function that can iterate through each schema in _schema SchemaMap and items for each Schema.\r\n   * Does not include schema items from schemas that are not completely loaded yet.\r\n   */\r\n  public * getSchemaItems(): IterableIterator<SchemaItem> {\r\n    for (const entry of this._schema) {\r\n      for (const schemaItem of entry.schema.getItems()) {\r\n        yield schemaItem;\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Gets all the schemas from the schema cache.\r\n   * Does not include schemas from schemas that are not completely loaded yet.\r\n   * @returns An array of Schema objects.\r\n   */\r\n  public getAllSchemas(): Schema[] {\r\n    return this._schema.map((entry: SchemaEntry) => entry.schema);\r\n  }\r\n}\r\n\r\n/**\r\n * The SchemaContext, context object is used to facilitate schema and schema item location.\r\n *\r\n * The context controls the lifetime of each schema that it knows about. It has to be explicitly removed from the context to delete a schema object.\r\n *\r\n * The context is made up of a group of Schema Locators.\r\n * @beta\r\n */\r\nexport class SchemaContext implements ISchemaItemLocater {\r\n  private _locaters: ISchemaLocater[];\r\n\r\n  private _knownSchemas: SchemaCache;\r\n  private _fallbackLocaterDefined: boolean;\r\n\r\n  constructor() {\r\n    this._locaters = [];\r\n\r\n    this._knownSchemas = new SchemaCache();\r\n    this._locaters.push(this._knownSchemas);\r\n    this._fallbackLocaterDefined = false;\r\n  }\r\n\r\n  public get locaters(): ISchemaLocater[] { return this._locaters; }\r\n\r\n  /**\r\n   * Adds a locater to the context.\r\n   *\r\n   * If no locaters are defined or a fallback locater is not defined, the new locater is added at the end of the locaters array.\r\n   * If a fallback locater is already defined, the new locater is inserted before the fallback locater.\r\n   *\r\n   * @param locater - The locater to be added.\r\n   */\r\n  public addLocater(locater: ISchemaLocater) {\r\n    const insertIndex = (this._locaters.length === 0 || !this._fallbackLocaterDefined) ? this._locaters.length : this._locaters.length - 1;\r\n    this._locaters.splice(insertIndex, 0, locater);\r\n  }\r\n\r\n  /**\r\n   * Adds a fallback locater to the context.\r\n   *\r\n   * If a fallback locater is already defined, it replaces the existing one.\r\n   * Otherwise, it adds the new locater to the end of the locaters array and marks the fallback locater as defined.\r\n   *\r\n   * @param locater - The locater to be added as a fallback.\r\n   */\r\n  public addFallbackLocater(locater: ISchemaLocater) {\r\n    if (this._fallbackLocaterDefined) {\r\n      this._locaters[this._locaters.length - 1] = locater;\r\n    } else {\r\n      this._locaters.push(locater);\r\n      this._fallbackLocaterDefined = true;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Adds the schema to this context.  Use addSchemaPromise instead when asynchronously loading schemas.\r\n   * @param schema The schema to add to this context\r\n   */\r\n  public async addSchema(schema: Schema) {\r\n    this.addSchemaSync(schema);\r\n  }\r\n\r\n  /**\r\n   * Adds the schema to this context\r\n   * @param schema The schema to add to this context\r\n   */\r\n  public addSchemaSync(schema: Schema) {\r\n    this._knownSchemas.addSchemaSync(schema);\r\n  }\r\n\r\n  /**\r\n   * Adds the given SchemaItem to the the SchemaContext by locating the schema, with the best match of SchemaMatchType.Exact, and\r\n   * @param schemaItem The SchemaItem to add\r\n   * @deprecated in 4.0 use ecschema-editing package\r\n   */\r\n  public async addSchemaItem(schemaItem: SchemaItem) {\r\n    const schema = await this.getSchema(schemaItem.key.schemaKey, SchemaMatchType.Exact);\r\n    if (!schema)\r\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to add the schema item ${schemaItem.name} to the schema ${schemaItem.key.schemaKey.toString()} because the schema could not be located.`);\r\n\r\n    (schema as MutableSchema).addItem(schemaItem);\r\n  }\r\n\r\n  /**\r\n   * Returns true if the schema is already in the context.  SchemaMatchType.Latest is used to find a match.\r\n   * @param schemaKey\r\n   */\r\n  public schemaExists(schemaKey: Readonly<SchemaKey>): boolean {\r\n    return this._knownSchemas.schemaExists(schemaKey);\r\n  }\r\n\r\n  /**\r\n   * Adds a promise to load the schema to the cache. Does not allow for duplicate schemas in the cache of schemas or cache of promises, checks using SchemaMatchType.Latest.\r\n   * When the promise completes the schema will be added to the schema cache and the promise will be removed from the promise cache.\r\n   * Use this method over addSchema when asynchronously loading schemas\r\n   * @param schemaInfo An object with the schema key for the schema being loaded and it's references\r\n   * @param schema The partially loaded schema that the promise will fulfill\r\n   * @param schemaPromise The schema promise to add to the cache.\r\n   */\r\n  public async addSchemaPromise(schemaInfo: SchemaInfo, schema: Schema, schemaPromise: Promise<Schema>) {\r\n    return this._knownSchemas.addSchemaPromise(schemaInfo, schema, schemaPromise);\r\n  }\r\n\r\n  /** Attempts to obtain a schema from this context that matches the specified criteria.\r\n   * @param schemaKey Identifies the schema to obtain.\r\n   * @param matchType Criteria by which to identify potentially matching schemas.\r\n   * @returns the schema matching the input criteria, or `undefined` if no such schema could be located.\r\n   */\r\n  public async getSchema(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<Schema | undefined> {\r\n    // the first locater is _knownSchemas, so we don't have to check the cache explicitly here\r\n    for (const locater of this._locaters) {\r\n      const schema = await locater.getSchema(schemaKey, matchType, this);\r\n      if (undefined !== schema)\r\n        return schema;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.\r\n   * The fully loaded schema can be gotten later from the context using [[getSchema]].\r\n   * @param schemaKey The SchemaKey describing the schema to get from the cache.\r\n   * @param matchType The match type to use when locating the schema\r\n   */\r\n  public async getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType): Promise<SchemaInfo | undefined> {\r\n    for (const locater of this._locaters) {\r\n      const schemaInfo = await locater.getSchemaInfo(schemaKey, matchType, this);\r\n      if (undefined !== schemaInfo)\r\n        return schemaInfo;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /** Attempts to obtain a schema from this context that matches the specified criteria.\r\n   * Will return undefined if the schema is partially loaded.  Use [[getSchema]] to await until the schema is completely loaded.\r\n   * @param schemaKey Identifies the schema to obtain.\r\n   * @param matchType Criteria by which to identify potentially matching schemas.\r\n   * @returns the schema matching the input criteria, or `undefined` if no such schema could be located.\r\n   */\r\n  public getSchemaSync(schemaKey: SchemaKey, matchType: SchemaMatchType = SchemaMatchType.Latest): Schema | undefined {\r\n    // the first locater is _knownSchemas, so we don't have to check the cache explicitly here\r\n    for (const locater of this._locaters) {\r\n      const schema = locater.getSchemaSync(schemaKey, matchType, this);\r\n      if (undefined !== schema)\r\n        return schema;\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  /**\r\n   * Attempts to get a Schema from the context's cache.\r\n   * Will await a partially loaded schema then return when it is completely loaded.\r\n   * @param schemaKey The SchemaKey to identify the Schema.\r\n   * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.\r\n   * @internal\r\n   */\r\n  public async getCachedSchema(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Promise<Schema | undefined> {\r\n    return this._knownSchemas.getSchema(schemaKey, matchType);\r\n  }\r\n\r\n  /**\r\n   * Attempts to get a Schema from the context's cache.\r\n   * Will return undefined if the cached schema is partially loaded.  Use [[getCachedSchema]] to await until the schema is completely loaded.\r\n   * @param schemaKey The SchemaKey to identify the Schema.\r\n   * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.\r\n   * @internal\r\n   */\r\n  public getCachedSchemaSync(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType = SchemaMatchType.Latest): Schema | undefined {\r\n    return this._knownSchemas.getSchemaSync(schemaKey, matchType);\r\n  }\r\n\r\n  /**\r\n   * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].\r\n   * Will await a partially loaded schema then look in it for the requested item\r\n   * @param schemaItemKey The SchemaItemKey identifying the item to return.  SchemaMatchType.Latest is used to match the schema.\r\n   * @param itemConstructor The constructor of the item to return.\r\n   * @returns The requested schema item\r\n   */\r\n  public async getSchemaItem(schemaItemKey: SchemaItemKey): Promise<SchemaItem | undefined>\r\n  public async getSchemaItem<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): Promise<InstanceType<T> | undefined>\r\n  public async getSchemaItem<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor?: T): Promise<SchemaItem | InstanceType<T> | undefined> {\r\n    const schema = await this.getSchema(schemaItemKey.schemaKey, SchemaMatchType.Latest);\r\n    if (undefined === schema)\r\n      return undefined;\r\n\r\n    if(undefined === itemConstructor)\r\n      return schema.getItem(schemaItemKey.name);\r\n\r\n    return schema.getItem(schemaItemKey.name, itemConstructor);\r\n  }\r\n\r\n  /**\r\n   * Gets the schema item from the specified schema if it exists in this [[SchemaContext]].\r\n   * Will return undefined if the cached schema is partially loaded. Use [[getSchemaItem]] to await until the schema is completely loaded.\r\n   * @param schemaItemKey The SchemaItemKey identifying the item to return. SchemaMatchType.Latest is used to match the schema.\r\n   * @param itemConstructor The constructor of the item to return.\r\n   * @returns The requested schema item\r\n   */\r\n  public getSchemaItemSync(schemaItemKey: SchemaItemKey): SchemaItem | undefined\r\n  public getSchemaItemSync<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor: T): InstanceType<T> | undefined\r\n  public getSchemaItemSync<T extends typeof SchemaItem>(schemaItemKey: SchemaItemKey, itemConstructor?: T): SchemaItem | InstanceType<T> | undefined {\r\n    const schema = this.getSchemaSync(schemaItemKey.schemaKey, SchemaMatchType.Latest);\r\n    if (undefined === schema)\r\n      return undefined;\r\n\r\n    if(undefined === itemConstructor)\r\n      return schema.getItemSync(schemaItemKey.name);\r\n\r\n    return schema.getItemSync(schemaItemKey.name, itemConstructor);\r\n  }\r\n\r\n  /**\r\n   * Iterates through the items of each schema known to the context.  This includes schemas added to the\r\n   * context using [[SchemaContext.addSchema]]. This does not include schemas that\r\n   * can be located by an ISchemaLocater instance added to the context.\r\n   * Does not include schema items from schemas that are not completely loaded yet.\r\n   */\r\n  public getSchemaItems(): IterableIterator<SchemaItem> {\r\n    return this._knownSchemas.getSchemaItems();\r\n  }\r\n\r\n  /**\r\n   * Gets all the Schemas known by the context. This includes schemas added to the\r\n   * context using [[SchemaContext.addSchema]]. This does not include schemas that\r\n   * can be located by an ISchemaLocater instance added to the context.  Does not\r\n   * include schemas that are partially loaded.\r\n   * @returns An array of Schema objects.\r\n   */\r\n  public getKnownSchemas(): Schema[] {\r\n    return this._knownSchemas.getAllSchemas();\r\n  }\r\n}\r\n"]}

package/lib/cjs/Deserialization/Helper.d.ts

@@ -31,20 +31,20 @@ export declare class SchemaReadHelper<T = unknown> {
      * @param schema The Schema to populate
      * @param rawSchema The serialized data to use to populate the Schema.
      */
-    readSchemaInfo<U extends Schema>(schema: U, rawSchema: T): Promise<SchemaInfo>;
+    readSchemaInfo(schema: Schema, rawSchema: T): Promise<SchemaInfo>;
     /**
      * Populates the given Schema from a serialized representation.
      * @param schema The Schema to populate
      * @param rawSchema The serialized data to use to populate the Schema.
      */
-    readSchema<U extends Schema>(schema: U, rawSchema: T): Promise<U>;
+    readSchema(schema: Schema, rawSchema: T): Promise<Schema>;
     private loadSchema;
     /**
      * Populates the given Schema from a serialized representation.
      * @param schema The Schema to populate
      * @param rawSchema The serialized data to use to populate the Schema.
      */
-    readSchemaSync<U extends Schema>(schema: U, rawSchema: T): U;
+    readSchemaSync(schema: Schema, rawSchema: T): Schema;
     /**
      * Ensures that the schema references can be located and adds them to the schema.
      * @param ref The object to read the SchemaReference's props from.

package/lib/cjs/Deserialization/Helper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Helper.d.ts","sourceRoot":"","sources":["../../../src/Deserialization/Helper.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,EAA2B,UAAU,EAAE,MAAM,eAAe,CAAC;AAWpE,OAAO,EAAiB,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAI3D,OAAO,EAAE,kBAAkB,EAA6B,MAAM,8BAA8B,CAAC;AAE7F,OAAO,EAAkB,yBAAyB,EAAmB,MAAM,kBAAkB,CAAC;AAO9F;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,gBAAgB,CAAC,CAAC,GAAG,OAAO;IACvC,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,cAAc,CAAC,CAA4B;IACnD,OAAO,CAAC,WAAW,CAAwC;IAC3D,OAAO,CAAC,OAAO,CAA2B;IAI1C,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,WAAW,CAAC,CAAa;gBAErB,UAAU,EAAE,yBAAyB,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,kBAAkB;IAM3G;;;;;;OAMG;IACU,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;IA+B3F;;;;OAIG;IACU,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;YAahE,UAAU;IAgCxB;;;;OAIG;IACI,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,CAAC;IA0CnE;;;OAGG;YACW,mBAAmB;IAkBjC;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAqB/B;;;OAGG;IACH,OAAO,CAAE,wBAAwB;IAkBjC;;;;;;OAMG;YACW,cAAc;IAuE5B;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAsE1B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAcvC;;;;;;;OAOG;YACW,cAAc;IAmC5B;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IA+B1B;;;;OAIG;YACW,QAAQ;IAStB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IASpB;;;;OAIG;YACW,kBAAkB;IAehC;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAc9B;;;;OAIG;YACW,YAAY;IAO1B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;;;OAIG;YACW,gBAAgB;IAS9B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAS5B;;;;OAIG;YACW,UAAU;IAYxB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAatB;;;;;OAKG;YACW,SAAS;IAsBvB;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IAsBrB;;;;OAIG;YACW,eAAe;IAY7B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAY3B;;;;OAIG;YACW,SAAS;IAavB;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAarB;;;;OAIG;YACW,qBAAqB;IAWnC;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;IAWjC;;;;OAIG;YACW,0BAA0B;IAYxC;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAatC;;;;;;OAMG;YACW,iBAAiB;IAmD/B;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IAkD7B;;;;;OAKG;YACW,YAAY;IAa1B;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAaxB;;;;;OAKG;YACW,oBAAoB;IAmBlC;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;WAYlB,oBAAoB,CAAC,aAAa,CAAC,EAAE,aAAa,GAAG,OAAO;CAM3E"}
+{"version":3,"file":"Helper.d.ts","sourceRoot":"","sources":["../../../src/Deserialization/Helper.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3C,OAAO,EAA2B,UAAU,EAAE,MAAM,eAAe,CAAC;AAWpE,OAAO,EAAiB,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAI3D,OAAO,EAAE,kBAAkB,EAA6B,MAAM,8BAA8B,CAAC;AAE7F,OAAO,EAAkB,yBAAyB,EAAmB,MAAM,kBAAkB,CAAC;AAO9F;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,qBAAa,gBAAgB,CAAC,CAAC,GAAG,OAAO;IACvC,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,cAAc,CAAC,CAA4B;IACnD,OAAO,CAAC,WAAW,CAAwC;IAC3D,OAAO,CAAC,OAAO,CAA2B;IAI1C,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,WAAW,CAAC,CAAa;gBAErB,UAAU,EAAE,yBAAyB,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,kBAAkB;IAM3G;;;;;;OAMG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;IA+B9E;;;;OAIG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;YAaxD,UAAU;IAgCxB;;;;OAIG;IACI,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,GAAG,MAAM;IA0C3D;;;OAGG;YACW,mBAAmB;IAkBjC;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAqB/B;;;OAGG;IACH,OAAO,CAAE,wBAAwB;IAkBjC;;;;;;OAMG;YACW,cAAc;IAuE5B;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAsE1B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,wBAAwB;IAcvC;;;;;;;OAOG;YACW,cAAc;IAmC5B;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IA+B1B;;;;OAIG;YACW,QAAQ;IAStB;;;;OAIG;IACH,OAAO,CAAC,YAAY;IASpB;;;;OAIG;YACW,kBAAkB;IAehC;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IAc9B;;;;OAIG;YACW,YAAY;IAO1B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;;;OAIG;YACW,gBAAgB;IAS9B;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAS5B;;;;OAIG;YACW,UAAU;IAYxB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IAatB;;;;;OAKG;YACW,SAAS;IAsBvB;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IAsBrB;;;;OAIG;YACW,eAAe;IAY7B;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAY3B;;;;OAIG;YACW,SAAS;IAavB;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAarB;;;;OAIG;YACW,qBAAqB;IAWnC;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;IAWjC;;;;OAIG;YACW,0BAA0B;IAYxC;;;;OAIG;IACH,OAAO,CAAC,8BAA8B;IAatC;;;;;;OAMG;YACW,iBAAiB;IAmD/B;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IAkD7B;;;;;OAKG;YACW,YAAY;IAa1B;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAaxB;;;;;OAKG;YACW,oBAAoB;IAmBlC;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;WAYlB,oBAAoB,CAAC,aAAa,CAAC,EAAE,aAAa,GAAG,OAAO;CAM3E"}