@itwin/ecschema-metadata 4.0.0-dev.103 → 4.0.0-dev.104

package/lib/cjs/Constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"Constants.js","sourceRoot":"","sources":["../../src/Constants.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AACH,MAAa,iBAAiB;;AAC5B,mBAAmB;AACI,yCAAuB,GAAW,QAAQ,CAAC;AAC3C,yCAAuB,GAAW,QAAQ,CAAC;AAElE,iBAAiB;AACM,sCAAoB,GAAW,QAAQ,CAAC;AACxC,2CAAyB,GAAW,aAAa,CAAC;AAClD,oDAAkC,GAAW,sBAAsB,CAAC;AACpE,2CAAyB,GAAW,aAAa,CAAC;AAClD,iDAA+B,GAAW,mBAAmB,CAAC;AAC9D,wCAAsB,GAAW,UAAU,CAAC;AAE5C,iDAA+B,GAAW,mBAAmB,CAAC;AAC9D,8CAA4B,GAAW,gBAAgB,CAAC;AACxD,sDAAoC,GAAW,eAAe,CAAC;AAC/D,mDAAiC,GAAW,qBAAqB,CAAC;AAClE,kDAAgC,GAAW,oBAAoB,CAAC;AAChE,2CAAyB,GAAW,aAAa,CAAC;AAElD,4DAA0C,GAAW,8BAA8B,CAAC;AACpF,4DAA0C,GAAW,8BAA8B,CAAC;AACpF,yDAAuC,GAAW,2BAA2B,CAAC;AAE9E,mCAAiB,GAAW,KAAK,CAAC;AAxB9C,8CAAiB","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\n/**\r\n * @internal\r\n */\r\nexport class ECStringConstants {\r\n  // Relationship End\r\n  public static readonly RELATIONSHIP_END_SOURCE: string = \"Source\";\r\n  public static readonly RELATIONSHIP_END_TARGET: string = \"Target\";\r\n\r\n  // Container Type\r\n  public static readonly CONTAINERTYPE_SCHEMA: string = \"Schema\";\r\n  public static readonly CONTAINERTYPE_ENTITYCLASS: string = \"EntityClass\";\r\n  public static readonly CONTAINERTYPE_CUSTOMATTRIBUTECLASS: string = \"CustomAttributeClass\";\r\n  public static readonly CONTAINERTYPE_STRUCTCLASS: string = \"StructClass\";\r\n  public static readonly CONTAINERTYPE_RELATIONSHIPCLASS: string = \"RelationshipClass\";\r\n  public static readonly CONTAINERTYPE_ANYCLASS: string = \"AnyClass\";\r\n\r\n  public static readonly CONTAINERTYPE_PRIMITIVEPROPERTY: string = \"PrimitiveProperty\";\r\n  public static readonly CONTAINERTYPE_STRUCTPROPERTY: string = \"StructProperty\";\r\n  public static readonly CONTAINERTYPE_PRIMITIVEARRAYPROPERTY: string = \"ArrayProperty\";\r\n  public static readonly CONTAINERTYPE_STRUCTARRAYPROPERTY: string = \"StructArrayProperty\";\r\n  public static readonly CONTAINERTYPE_NAVIGATIONPROPERTY: string = \"NavigationProperty\";\r\n  public static readonly CONTAINERTYPE_ANYPROPERTY: string = \"AnyProperty\";\r\n\r\n  public static readonly CONTAINERTYPE_SOURCERELATIONSHIPCONSTRAINT: string = \"SourceRelationshipConstraint\";\r\n  public static readonly CONTAINERTYPE_TARGETRELATIONSHIPCONSTRAINT: string = \"TargetRelationshipConstraint\";\r\n  public static readonly CONTAINERTYPE_ANYRELATIONSHIPCONSTRAINT: string = \"AnyRelationshipConstraint\";\r\n\r\n  public static readonly CONTAINERTYPE_ANY: string = \"Any\";\r\n}\r\n"]}
+{"version":3,"file":"Constants.js","sourceRoot":"","sources":["../../src/Constants.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AACH,MAAa,iBAAiB;;AAC5B,mBAAmB;AACI,yCAAuB,GAAW,QAAQ,CAAC;AAC3C,yCAAuB,GAAW,QAAQ,CAAC;AAElE,iBAAiB;AACM,sCAAoB,GAAW,QAAQ,CAAC;AACxC,2CAAyB,GAAW,aAAa,CAAC;AAClD,oDAAkC,GAAW,sBAAsB,CAAC;AACpE,2CAAyB,GAAW,aAAa,CAAC;AAClD,iDAA+B,GAAW,mBAAmB,CAAC;AAC9D,wCAAsB,GAAW,UAAU,CAAC;AAE5C,iDAA+B,GAAW,mBAAmB,CAAC;AAC9D,8CAA4B,GAAW,gBAAgB,CAAC;AACxD,sDAAoC,GAAW,eAAe,CAAC;AAC/D,mDAAiC,GAAW,qBAAqB,CAAC;AAClE,kDAAgC,GAAW,oBAAoB,CAAC;AAChE,2CAAyB,GAAW,aAAa,CAAC;AAElD,4DAA0C,GAAW,8BAA8B,CAAC;AACpF,4DAA0C,GAAW,8BAA8B,CAAC;AACpF,yDAAuC,GAAW,2BAA2B,CAAC;AAE9E,mCAAiB,GAAW,KAAK,CAAC;AAxB9C,8CAAiB","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\n/**\n * @internal\n */\nexport class ECStringConstants {\n  // Relationship End\n  public static readonly RELATIONSHIP_END_SOURCE: string = \"Source\";\n  public static readonly RELATIONSHIP_END_TARGET: string = \"Target\";\n\n  // Container Type\n  public static readonly CONTAINERTYPE_SCHEMA: string = \"Schema\";\n  public static readonly CONTAINERTYPE_ENTITYCLASS: string = \"EntityClass\";\n  public static readonly CONTAINERTYPE_CUSTOMATTRIBUTECLASS: string = \"CustomAttributeClass\";\n  public static readonly CONTAINERTYPE_STRUCTCLASS: string = \"StructClass\";\n  public static readonly CONTAINERTYPE_RELATIONSHIPCLASS: string = \"RelationshipClass\";\n  public static readonly CONTAINERTYPE_ANYCLASS: string = \"AnyClass\";\n\n  public static readonly CONTAINERTYPE_PRIMITIVEPROPERTY: string = \"PrimitiveProperty\";\n  public static readonly CONTAINERTYPE_STRUCTPROPERTY: string = \"StructProperty\";\n  public static readonly CONTAINERTYPE_PRIMITIVEARRAYPROPERTY: string = \"ArrayProperty\";\n  public static readonly CONTAINERTYPE_STRUCTARRAYPROPERTY: string = \"StructArrayProperty\";\n  public static readonly CONTAINERTYPE_NAVIGATIONPROPERTY: string = \"NavigationProperty\";\n  public static readonly CONTAINERTYPE_ANYPROPERTY: string = \"AnyProperty\";\n\n  public static readonly CONTAINERTYPE_SOURCERELATIONSHIPCONSTRAINT: string = \"SourceRelationshipConstraint\";\n  public static readonly CONTAINERTYPE_TARGETRELATIONSHIPCONSTRAINT: string = \"TargetRelationshipConstraint\";\n  public static readonly CONTAINERTYPE_ANYRELATIONSHIPCONSTRAINT: string = \"AnyRelationshipConstraint\";\n\n  public static readonly CONTAINERTYPE_ANY: string = \"Any\";\n}\n"]}

package/lib/cjs/Context.d.ts

@@ -1,14 +1,14 @@
 import { SchemaMatchType } from "./ECObjects";
+import { SchemaInfo } from "./Interfaces";
 import { Schema } from "./Metadata/Schema";
 import { SchemaItem } from "./Metadata/SchemaItem";
 import { SchemaItemKey, SchemaKey } from "./SchemaKey";
 /**
- * @beta
- */
-export declare class SchemaMap extends Array<Schema> {
-}
-/**
- * The interface defines what is needed to be a ISchemaLocater, which are used in a SchemaContext.
+ * The interface defines what is needed to be an `ISchemaLocater`.
+ * A Schema Locater loads the requested schema if it can or returns undefined.
+ * Schema Locaters should always load the schema on each request and should not hold a cache of schemas.
+ * Schema locaters should never be used directly to load a schema, they should be added to a `SchemaContext`
+ * and the context should be used to load schemas.  The `SchemaContext` caches schemas and manages schema life time.
  * @beta
  */
 export interface ISchemaLocater {
@@ -17,17 +17,24 @@ export interface ISchemaLocater {
      * For schemas that may have references, construct and call through a SchemaContext instead.
      * @param schemaKey key to look up
      * @param matchType how to match key against candidate schemas
-     * @param context optional context for loading schema references
+     * @param context context for loading schema references
      */
-    getSchema<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context?: SchemaContext): Promise<T | undefined>;
+    getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<T | 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.
+    * @param schemaKey The SchemaKey describing the schema to get from the cache.
+    * @param matchType The match type to use when locating the schema
+    */
+    getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): Promise<SchemaInfo | undefined>;
     /**
      * Attempts to get a schema from the locater. Yields undefined if no matching schema is found.
      * For schemas that may have references, construct and call through a SchemaContext instead.
      * @param schemaKey key to look up
      * @param matchType how to match key against candidate schemas
-     * @param context optional context for loading schema references
+     * @param context context for loading schema references
      */
-    getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType: SchemaMatchType, context?: SchemaContext): T | undefined;
+    getSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType, context: SchemaContext): T | undefined;
 }
 /**
  * @beta
@@ -36,12 +43,30 @@ export interface ISchemaItemLocater {
     getSchemaItem<T extends SchemaItem>(schemaItemKey: SchemaItemKey): Promise<T | undefined>;
 }
 /**
- * @beta
+ * @internal
  */
 export declare class SchemaCache implements ISchemaLocater {
     private _schema;
     constructor();
     get count(): number;
+    private loadedSchemaExists;
+    private schemaPromiseExists;
+    private findEntry;
+    private removeSchemaPromise;
+    private removeEntry;
+    /**
+     * Returns true if the schema exists in either the schema cache or the promise cache.  SchemaMatchType.Latest used.
+     * @param schemaKey The key to search for.
+     */
+    schemaExists(schemaKey: Readonly<SchemaKey>): boolean;
+    /**
+     * 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.
+     * When the promise completes the schema will be added to the schema cache and the promise will be removed from the promise cache
+     * @param schemaInfo An object with the schema key for the schema being loaded and it's references
+     * @param schema The partially loaded schema that the promise will fulfill
+     * @param schemaPromise The schema promise to add to the cache.
+     */
+    addSchemaPromise(schemaInfo: SchemaInfo, schema: Schema, schemaPromise: Promise<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.
@@ -57,19 +82,27 @@ 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
      */
-    getSchema<T extends Schema>(schemaKey: SchemaKey, matchType?: SchemaMatchType): Promise<T | undefined>;
+    getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined>;
     /**
-     *
-     * @param schemaKey
-     * @param matchType
+      * 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.
+      * @param matchType The match type to use when locating the schema
+      */
+    getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<SchemaInfo | undefined>;
+    /**
+     * Gets the schema which matches the provided SchemaKey.  If the schema is partially loaded an exception will be thrown.
+     * @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: SchemaKey, matchType?: SchemaMatchType): T | undefined;
+    getSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): T | undefined;
     /**
-     * Generator function that can iterate through each schema in _schema SchemaMap and items for each Schema
+     * 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.
      */
     getSchemaItems(): IterableIterator<SchemaItem>;
     /**
      * Gets all the schemas from the schema cache.
+     * Does not include schemas from schemas that are not completely loaded yet.
      * @returns An array of Schema objects.
      */
     getAllSchemas(): Schema[];
@@ -82,13 +115,13 @@ export declare class SchemaCache implements ISchemaLocater {
  * The context is made up of a group of Schema Locators.
  * @beta
  */
-export declare class SchemaContext implements ISchemaLocater, ISchemaItemLocater {
+export declare class SchemaContext implements ISchemaItemLocater {
     private _locaters;
     private _knownSchemas;
     constructor();
     addLocater(locater: ISchemaLocater): void;
     /**
-     * Adds the schema to this context
+     * Adds the schema to this context.  Use addSchemaPromise instead when asynchronously loading schemas.
      * @param schema The schema to add to this context
      */
     addSchema(schema: Schema): Promise<void>;
@@ -100,13 +133,35 @@ export declare class SchemaContext implements ISchemaLocater, ISchemaItemLocater
     /**
      * Adds the given SchemaItem to the the SchemaContext by locating the schema, with the best match of SchemaMatchType.Exact, and
      * @param schemaItem The SchemaItem to add
+     * @deprecated in 4.0 use ecschema-editing package
      */
     addSchemaItem(schemaItem: SchemaItem): Promise<void>;
+    /**
+     * Returns true if the schema is already in the context.  SchemaMatchType.Latest is used to find a match.
+     * @param schemaKey
+     */
+    schemaExists(schemaKey: Readonly<SchemaKey>): boolean;
+    /**
+     * 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.
+     * When the promise completes the schema will be added to the schema cache and the promise will be removed from the promise cache.
+     * Use this method over addSchema when asynchronously loading schemas
+     * @param schemaInfo An object with the schema key for the schema being loaded and it's references
+     * @param schema The partially loaded schema that the promise will fulfill
+     * @param schemaPromise The schema promise to add to the cache.
+     */
+    addSchemaPromise(schemaInfo: SchemaInfo, schema: Schema, schemaPromise: Promise<Schema>): Promise<void>;
     /**
      *
      * @param schemaKey
      */
-    getSchema<T extends Schema>(schemaKey: SchemaKey, matchType?: SchemaMatchType): Promise<T | undefined>;
+    getSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined>;
+    /**
+     * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+     * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+     * @param schemaKey The SchemaKey describing the schema to get from the cache.
+     * @param matchType The match type to use when locating the schema
+     */
+    getSchemaInfo(schemaKey: Readonly<SchemaKey>, matchType: SchemaMatchType): Promise<SchemaInfo | undefined>;
     /**
      *
      * @param schemaKey
@@ -114,25 +169,46 @@ export declare class SchemaContext implements ISchemaLocater, ISchemaItemLocater
     getSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType?: SchemaMatchType): T | undefined;
     /**
      * Attempts to get a Schema from the context's cache.
+     * Will await a partially loaded schema then return when it is completely loaded.
      * @param schemaKey The SchemaKey to identify the Schema.
      * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.
      * @internal
      */
-    getCachedSchema<T extends Schema>(schemaKey: SchemaKey, matchType?: SchemaMatchType): Promise<T | undefined>;
+    getCachedSchema<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): Promise<T | undefined>;
     /**
      * Attempts to get a Schema from the context's cache.
+     * Will return undefined if the cached schema is partially loaded.  Use the async method to await partially loaded schemas.
      * @param schemaKey The SchemaKey to identify the Schema.
      * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.
      * @internal
      */
-    getCachedSchemaSync<T extends Schema>(schemaKey: SchemaKey, matchType?: SchemaMatchType): Schema | undefined;
+    getCachedSchemaSync<T extends Schema>(schemaKey: Readonly<SchemaKey>, matchType?: SchemaMatchType): 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<T extends SchemaItem>(schemaItemKey: SchemaItemKey): Promise<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.
+     * @returns The requested schema item
+     */
     getSchemaItemSync<T extends SchemaItem>(schemaItemKey: SchemaItemKey): 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
+     * can be located by an ISchemaLocater instance added to the context.
+     * Does not include schema items from schemas that are not completely loaded yet.
+     */
     getSchemaItems(): IterableIterator<SchemaItem>;
     /**
      * Gets all the Schemas known by the context. This includes schemas added to the
      * context using [[SchemaContext.addSchema]]. This does not include schemas that
-     * can be located by an ISchemaLocater instance added to the context.
+     * can be located by an ISchemaLocater instance added to the context.  Does not
+     * include schemas that are partially loaded.
      * @returns An array of Schema objects.
      */
     getKnownSchemas(): Schema[];

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,EAAiB,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAEvD;;GAEG;AACH,qBAAa,SAAU,SAAQ,KAAK,CAAC,MAAM,CAAC;CAAI;AAEhD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC;IAE/H;;;;;;OAMG;IACH,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS,CAAC;CAC3H;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;;;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,SAAS,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAgB3I;;;;OAIG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAE,eAAwC,GAAG,CAAC,GAAG,SAAS;IAgBhI;;OAEG;IACK,cAAc,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAQtD;;;OAGG;IACI,aAAa,IAAI,MAAM,EAAG;CAGlC;AAED;;;;;;;GAOG;AACH,qBAAa,aAAc,YAAW,cAAc,EAAE,kBAAkB;IACtE,OAAO,CAAC,SAAS,CAAmB;IAEpC,OAAO,CAAC,aAAa,CAAc;;IAS5B,UAAU,CAAC,OAAO,EAAE,cAAc;IAIzC;;;OAGG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM;IAIrC;;;OAGG;IACI,aAAa,CAAC,MAAM,EAAE,MAAM;IAInC;;;OAGG;IACU,aAAa,CAAC,UAAU,EAAE,UAAU;IAQjD;;;OAGG;IACU,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAW3I;;;OAGG;IACI,aAAa,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAE,eAAwC,GAAG,CAAC,GAAG,SAAS;IAWhI;;;;;OAKG;IACU,eAAe,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAE,eAAwC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAIjJ;;;;;OAKG;IACI,mBAAmB,CAAC,CAAC,SAAS,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAE,eAAwC,GAAG,MAAM,GAAG,SAAS;IAK9H,aAAa,CAAC,CAAC,SAAS,UAAU,EAAE,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAO/F,iBAAiB,CAAC,CAAC,SAAS,UAAU,EAAE,aAAa,EAAE,aAAa,GAAG,CAAC,GAAG,SAAS;IAOpF,cAAc,IAAI,gBAAgB,CAAC,UAAU,CAAC;IAIrD;;;;;OAKG;IACI,eAAe,IAAI,MAAM,EAAG;CAGpC"}
+{"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;;IAS5B,UAAU,CAAC,OAAO,EAAE,cAAc;IAIzC;;;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;;;OAGG;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;;;OAGG;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"}

package/lib/cjs/Context.js

@@ -4,40 +4,82 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SchemaContext = exports.SchemaCache = exports.SchemaMap = void 0;
+exports.SchemaContext = exports.SchemaCache = void 0;
 const ECObjects_1 = require("./ECObjects");
 const Exception_1 = require("./Exception");
 /**
- * @beta
+ * @internal
  */
 class SchemaMap extends Array {
 }
-exports.SchemaMap = SchemaMap;
 /**
- * @beta
+ * @internal
  */
 class SchemaCache {
     constructor() {
         this._schema = new SchemaMap();
     }
     get count() { return this._schema.length; }
+    loadedSchemaExists(schemaKey) {
+        return undefined !== this._schema.find((entry) => entry.schemaInfo.schemaKey.matches(schemaKey, ECObjects_1.SchemaMatchType.Latest) && !entry.schemaPromise);
+    }
+    schemaPromiseExists(schemaKey) {
+        return undefined !== this._schema.find((entry) => entry.schemaInfo.schemaKey.matches(schemaKey, ECObjects_1.SchemaMatchType.Latest) && undefined !== entry.schemaPromise);
+    }
+    findEntry(schemaKey, matchType) {
+        return this._schema.find((entry) => entry.schemaInfo.schemaKey.matches(schemaKey, matchType));
+    }
+    removeSchemaPromise(schemaKey) {
+        const entry = this.findEntry(schemaKey, ECObjects_1.SchemaMatchType.Latest);
+        if (entry)
+            entry.schemaPromise = undefined;
+    }
+    removeEntry(schemaKey) {
+        this._schema = this._schema.filter((entry) => !entry.schemaInfo.schemaKey.matches(schemaKey));
+    }
+    /**
+     * Returns true if the schema exists in either the schema cache or the promise cache.  SchemaMatchType.Latest used.
+     * @param schemaKey The key to search for.
+     */
+    schemaExists(schemaKey) {
+        return this.loadedSchemaExists(schemaKey) || this.schemaPromiseExists(schemaKey);
+    }
+    /**
+     * 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.
+     * When the promise completes the schema will be added to the schema cache and the promise will be removed from the promise cache
+     * @param schemaInfo An object with the schema key for the schema being loaded and it's references
+     * @param schema The partially loaded schema that the promise will fulfill
+     * @param schemaPromise The schema promise to add to the cache.
+     */
+    async addSchemaPromise(schemaInfo, schema, schemaPromise) {
+        if (this.schemaExists(schemaInfo.schemaKey))
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.DuplicateSchema, `The schema, ${schemaPromise.toString()}, already exists within this cache.`);
+        this._schema.push({ schemaInfo, schema, schemaPromise });
+        // This promise is cached and will be awaited when the user requests the full schema.
+        // If the promise competes successfully before the user requests the schema it will be removed from the cache
+        // If it fails it will remain in the cache until the user awaits it and handles the error
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        schemaPromise.then(() => {
+            this.removeSchemaPromise(schemaInfo.schemaKey);
+        });
+    }
     /**
      * 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.
      */
     async addSchema(schema) {
-        if (await this.getSchema(schema.schemaKey))
+        if (this.schemaExists(schema.schemaKey))
             throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.DuplicateSchema, `The schema, ${schema.schemaKey.toString()}, already exists within this cache.`);
-        this._schema.push(schema);
+        this._schema.push({ schemaInfo: schema, schema });
     }
     /**
      * 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(schema) {
-        if (this.getSchemaSync(schema.schemaKey))
+        if (this.schemaExists(schema.schemaKey))
             throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.DuplicateSchema, `The schema, ${schema.schemaKey.toString()}, already exists within this cache.`);
-        this._schema.push(schema);
+        this._schema.push({ schemaInfo: schema, schema });
     }
     /**
      * Gets the schema which matches the provided SchemaKey.
@@ -47,46 +89,69 @@ class SchemaCache {
     async getSchema(schemaKey, matchType = ECObjects_1.SchemaMatchType.Latest) {
         if (this.count === 0)
             return undefined;
-        const findFunc = (schema) => {
-            return schema.schemaKey.matches(schemaKey, matchType);
-        };
-        const foundSchema = this._schema.find(findFunc);
-        if (!foundSchema)
+        const entry = this.findEntry(schemaKey, matchType);
+        if (!entry)
             return undefined;
-        return foundSchema;
+        if (entry.schemaPromise) {
+            try {
+                const schema = await entry.schemaPromise;
+                return schema;
+            }
+            catch (e) {
+                this.removeEntry(schemaKey);
+                throw e;
+            }
+        }
+        return entry.schema;
     }
     /**
-     *
-     * @param schemaKey
-     * @param matchType
+      * 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.
+      * @param matchType The match type to use when locating the schema
+      */
+    async getSchemaInfo(schemaKey, matchType = ECObjects_1.SchemaMatchType.Latest) {
+        if (this.count === 0)
+            return undefined;
+        const entry = this.findEntry(schemaKey, matchType);
+        if (entry)
+            return entry.schemaInfo;
+        return undefined;
+    }
+    /**
+     * Gets the schema which matches the provided SchemaKey.  If the schema is partially loaded an exception will be thrown.
+     * @param schemaKey The SchemaKey describing the schema to get from the cache.
+     * @param matchType The match type to use when locating the schema
      */
     getSchemaSync(schemaKey, matchType = ECObjects_1.SchemaMatchType.Latest) {
         if (this.count === 0)
             return undefined;
-        const findFunc = (schema) => {
-            return schema.schemaKey.matches(schemaKey, matchType);
-        };
-        const foundSchema = this._schema.find(findFunc);
-        if (!foundSchema)
-            return foundSchema;
-        return foundSchema;
+        const entry = this.findEntry(schemaKey, matchType);
+        if (entry) {
+            if (entry.schemaPromise) {
+                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLoadSchema, `The Schema ${schemaKey.toString()} is partially loaded so cannot be loaded synchronously.`);
+            }
+            return entry.schema;
+        }
+        return undefined;
     }
     /**
-     * Generator function that can iterate through each schema in _schema SchemaMap and items for each Schema
+     * 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.
      */
     *getSchemaItems() {
-        for (const schema of this._schema) {
-            for (const schemaItem of schema.getItems()) {
+        for (const entry of this._schema) {
+            for (const schemaItem of entry.schema.getItems()) {
                 yield schemaItem;
             }
         }
     }
     /**
      * Gets all the schemas from the schema cache.
+     * Does not include schemas from schemas that are not completely loaded yet.
      * @returns An array of Schema objects.
      */
     getAllSchemas() {
-        return this._schema;
+        return this._schema.map((entry) => entry.schema);
     }
 }
 exports.SchemaCache = SchemaCache;
@@ -108,7 +173,7 @@ class SchemaContext {
         this._locaters.push(locater);
     }
     /**
-     * Adds the schema to this context
+     * Adds the schema to this context.  Use addSchemaPromise instead when asynchronously loading schemas.
      * @param schema The schema to add to this context
      */
     async addSchema(schema) {
@@ -124,6 +189,7 @@ class SchemaContext {
     /**
      * Adds the given SchemaItem to the the SchemaContext by locating the schema, with the best match of SchemaMatchType.Exact, and
      * @param schemaItem The SchemaItem to add
+     * @deprecated in 4.0 use ecschema-editing package
      */
     async addSchemaItem(schemaItem) {
         const schema = await this.getSchema(schemaItem.key.schemaKey, ECObjects_1.SchemaMatchType.Exact);
@@ -131,6 +197,24 @@ class SchemaContext {
             throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLocateSchema, `Unable to add the schema item ${schemaItem.name} to the schema ${schemaItem.key.schemaKey.toString()} because the schema could not be located.`);
         schema.addItem(schemaItem);
     }
+    /**
+     * Returns true if the schema is already in the context.  SchemaMatchType.Latest is used to find a match.
+     * @param schemaKey
+     */
+    schemaExists(schemaKey) {
+        return this._knownSchemas.schemaExists(schemaKey);
+    }
+    /**
+     * 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.
+     * When the promise completes the schema will be added to the schema cache and the promise will be removed from the promise cache.
+     * Use this method over addSchema when asynchronously loading schemas
+     * @param schemaInfo An object with the schema key for the schema being loaded and it's references
+     * @param schema The partially loaded schema that the promise will fulfill
+     * @param schemaPromise The schema promise to add to the cache.
+     */
+    async addSchemaPromise(schemaInfo, schema, schemaPromise) {
+        return this._knownSchemas.addSchemaPromise(schemaInfo, schema, schemaPromise);
+    }
     /**
      *
      * @param schemaKey
@@ -144,6 +228,20 @@ class SchemaContext {
         }
         return undefined;
     }
+    /**
+     * Gets the schema info which matches the provided SchemaKey.  The schema info may be returned before the schema is fully loaded.
+     * The fully loaded schema can be gotten later from the context using the getCachedSchema method.
+     * @param schemaKey The SchemaKey describing the schema to get from the cache.
+     * @param matchType The match type to use when locating the schema
+     */
+    async getSchemaInfo(schemaKey, matchType) {
+        for (const locater of this._locaters) {
+            const schemaInfo = await locater.getSchemaInfo(schemaKey, matchType, this);
+            if (undefined !== schemaInfo)
+                return schemaInfo;
+        }
+        return undefined;
+    }
     /**
      *
      * @param schemaKey
@@ -159,42 +257,62 @@ class SchemaContext {
     }
     /**
      * Attempts to get a Schema from the context's cache.
+     * Will await a partially loaded schema then return when it is completely loaded.
      * @param schemaKey The SchemaKey to identify the Schema.
      * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.
      * @internal
      */
     async getCachedSchema(schemaKey, matchType = ECObjects_1.SchemaMatchType.Latest) {
-        return this.getCachedSchemaSync(schemaKey, matchType);
+        return this._knownSchemas.getSchema(schemaKey, matchType);
     }
     /**
      * Attempts to get a Schema from the context's cache.
+     * Will return undefined if the cached schema is partially loaded.  Use the async method to await partially loaded schemas.
      * @param schemaKey The SchemaKey to identify the Schema.
      * @param matchType The SchemaMatch type to use. Default is SchemaMatchType.Latest.
      * @internal
      */
     getCachedSchemaSync(schemaKey, matchType = ECObjects_1.SchemaMatchType.Latest) {
-        const schema = this._knownSchemas.getSchemaSync(schemaKey, matchType);
-        return schema;
+        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) {
         const schema = await this.getSchema(schemaItemKey.schemaKey, ECObjects_1.SchemaMatchType.Latest);
         if (undefined === schema)
             return undefined;
         return schema.getItem(schemaItemKey.name);
     }
+    /**
+     * 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) {
         const schema = this.getSchemaSync(schemaItemKey.schemaKey, ECObjects_1.SchemaMatchType.Latest);
         if (undefined === schema)
             return undefined;
         return schema.getItemSync(schemaItemKey.name);
     }
+    /**
+     * 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
+     * can be located by an ISchemaLocater instance added to the context.
+     * Does not include schema items from schemas that are not completely loaded yet.
+     */
     getSchemaItems() {
         return this._knownSchemas.getSchemaItems();
     }
     /**
      * Gets all the Schemas known by the context. This includes schemas added to the
      * context using [[SchemaContext.addSchema]]. This does not include schemas that
-     * can be located by an ISchemaLocater instance added to the context.
+     * can be located by an ISchemaLocater instance added to the context.  Does not
+     * include schemas that are partially loaded.
      * @returns An array of Schema objects.
      */
     getKnownSchemas() {