@itwin/ecschema-metadata 4.8.0-dev.8 → 4.8.0

package/lib/esm/Context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Context.js","sourceRoot":"","sources":["../../src/Context.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAM9D;;GAEG;AACH,MAAM,SAAU,SAAQ,KAAkB;CAAI;AAuD9C;;GAEG;AACH,MAAM,OAAO,WAAW;IAGtB;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,eAAe,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,eAAe,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,eAAe,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,cAAc,CAAC,eAAe,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,cAAc,CAAC,eAAe,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,cAAc,CAAC,eAAe,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,eAAe,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,eAAe,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,eAAe,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,cAAc,CAAC,eAAe,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;AAED;;;;;;;GAOG;AACH,MAAM,OAAO,aAAa;IAKxB;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;IAC1C,CAAC;IAEM,UAAU,CAAC,OAAuB;QACvC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,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,eAAe,CAAC,KAAK,CAAC,CAAC;QACrF,IAAI,CAAC,MAAM;YACT,MAAM,IAAI,cAAc,CAAC,eAAe,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,eAAe,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,eAAe,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,eAAe,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,eAAe,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,eAAe,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,eAAe,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","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\r\n  constructor() {\r\n    this._locaters = [];\r\n\r\n    this._knownSchemas = new SchemaCache();\r\n    this._locaters.push(this._knownSchemas);\r\n  }\r\n\r\n  public addLocater(locater: ISchemaLocater) {\r\n    this._locaters.push(locater);\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"]}

package/lib/esm/DelayedPromise.d.ts

@@ -0,0 +1,89 @@
+/** @packageDocumentation
+ * @module Utils
+ */
+/**
+ * Similar to a normal Promise, a DelayedPromise represents the eventual completion (or failure)
+ * and resulting value of an asynchronous operation ***that has not yet started***.
+ *
+ * The asynchronous operation behind a DelayedPromise will start when any of the following occurs:
+ *  - The DelayedPromise is `await`ed.
+ *  - A callback is attached via `.then()` or `.catch(() => { })`.
+ *  - The asynchronous operation is explicitly started via `.start()`
+ *
+ * Just as normal Promises will never return to their pending state once fulfilled or rejected,
+ * a DelayedPromise will never re-execute its asynchronous operation more than **once**.
+ *
+ * Ultimately, a DelayedPromise is nothing more than some syntactic sugar that allows you to
+ * represent an (asynchronously) lazily-loaded value as an instance property instead of a method.
+ * You could also accomplish something similar by defining an async function as a property getter.
+ * However, since a property defined as a DelayedPromise will not start simply by being accessed,
+ * additional (non-lazily-loaded) "nested" properties can be added.
+ *
+ * [!alert text="*Remember:* Unlike regular Promises in JavaScript, DelayedPromises represent processes that **may not** already be happening." kind="warning"]
+ * @beta
+ */
+export declare class DelayedPromise<T> implements Promise<T> {
+    /**
+     * Constructs a DelayedPromise object.
+     * @param startCallback The asynchronous callback to execute when this DelayedPromise should be "started".
+     */
+    constructor(startCallback: () => Promise<T>);
+    readonly [Symbol.toStringTag]: "Promise";
+    /**
+     * Explicitly starts the asynchronous operation behind this DelayedPromise (if it hasn't started already).
+     */
+    start: () => Promise<T>;
+    /**
+     * Attaches callbacks for the resolution and/or rejection of the Promise.
+     * @param onfulfilled The callback to execute when the Promise is resolved.
+     * @param onrejected The callback to execute when the Promise is rejected.
+     * @return A Promise for the completion of which ever callback is executed.
+     */
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+    /**
+     * Attaches a callback for only the rejection of the Promise.
+     * @param onrejected The callback to execute when the Promise is rejected.
+     * @return A Promise for the completion of the callback.
+     */
+    catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>;
+    /**
+     * Attaches a callback for only the finally clause of the Promise.
+     * @param onrejected The callback to execute when the Promise is finalized.
+     * @return A Promise for the completion of the callback.
+     */
+    finally(onFinally?: (() => void) | undefined | null): Promise<T>;
+}
+/**
+ * @beta
+ */
+export interface NoDelayedPromiseMethods {
+    [propName: string]: any;
+    start?: never;
+    then?: never;
+    catch?: never;
+}
+/**
+ * @beta
+ */
+export interface DelayedPromiseWithPropsConstructor {
+    /**
+     * Constructs a DelayedPromiseWithProps object, which is at once both:
+     *  - A DelayedPromise object representing the eventual completion (or failure)
+     *    of an asynchronous operation returning a value of type `TPayload`
+     *  - _and_ a readonly "wrapper" around an instance of type `TProps`
+     *
+     * @param props An object with properties and methods that will be accessible
+     *              as if they were readonly properties of the DelayedPromiseWithProps object being constructed.
+     * @param startCallback The asynchronous callback to execute when as soon as this DelayedPromise should be "started".
+     */
+    new <TProps extends NoDelayedPromiseMethods, TPayload>(props: TProps, startCallback: () => Promise<TPayload>): Readonly<TProps> & DelayedPromise<TPayload>;
+}
+/**
+ * @beta
+ */
+export declare const DelayedPromiseWithProps: DelayedPromiseWithPropsConstructor;
+/** Define the type of a DelayedPromiseWithProps instance
+ * @beta
+ */
+export type DelayedPromiseWithProps<TProps, TPayload> = Readonly<TProps> & DelayedPromise<TPayload>;
+//# sourceMappingURL=DelayedPromise.d.ts.map

package/lib/esm/DelayedPromise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelayedPromise.d.ts","sourceRoot":"","sources":["../../src/DelayedPromise.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,cAAc,CAAC,CAAC,CAAE,YAAW,OAAO,CAAC,CAAC,CAAC;IAElD;;;OAGG;gBACS,aAAa,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAS3C,SAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,YAAsB;IAE1D;;OAEG;IACI,KAAK,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC;IAE/B;;;;;OAKG;IACU,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAIvP;;;;OAIG;IACU,KAAK,CAAC,OAAO,GAAG,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC;IAI5I;;;;OAIG;IACU,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC;CAG9E;AAGD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;IACxB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAGD;;GAEG;AACH,MAAM,WAAW,kCAAkC;IAEjD;;;;;;;;;OASG;IACH,KAAK,MAAM,SAAS,uBAAuB,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;CAC5J;AAID;;GAEG;AAEH,eAAO,MAAM,uBAAuB,oCAYI,CAAC;AAIzC;;GAEG;AACH,MAAM,MAAM,uBAAuB,CAAC,MAAM,EAAE,QAAQ,IAAI,QAAQ,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC"}

package/lib/esm/DelayedPromise.js

@@ -0,0 +1,88 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Utils
+ */
+var _a;
+/**
+ * Similar to a normal Promise, a DelayedPromise represents the eventual completion (or failure)
+ * and resulting value of an asynchronous operation ***that has not yet started***.
+ *
+ * The asynchronous operation behind a DelayedPromise will start when any of the following occurs:
+ *  - The DelayedPromise is `await`ed.
+ *  - A callback is attached via `.then()` or `.catch(() => { })`.
+ *  - The asynchronous operation is explicitly started via `.start()`
+ *
+ * Just as normal Promises will never return to their pending state once fulfilled or rejected,
+ * a DelayedPromise will never re-execute its asynchronous operation more than **once**.
+ *
+ * Ultimately, a DelayedPromise is nothing more than some syntactic sugar that allows you to
+ * represent an (asynchronously) lazily-loaded value as an instance property instead of a method.
+ * You could also accomplish something similar by defining an async function as a property getter.
+ * However, since a property defined as a DelayedPromise will not start simply by being accessed,
+ * additional (non-lazily-loaded) "nested" properties can be added.
+ *
+ * [!alert text="*Remember:* Unlike regular Promises in JavaScript, DelayedPromises represent processes that **may not** already be happening." kind="warning"]
+ * @beta
+ */
+export class DelayedPromise {
+    /**
+     * Constructs a DelayedPromise object.
+     * @param startCallback The asynchronous callback to execute when this DelayedPromise should be "started".
+     */
+    constructor(startCallback) {
+        // We need this in order to fulfill the Promise interface defined in lib.es2015.symbol.wellknown.d.ts
+        this[_a] = "Promise";
+        let pending;
+        this.start = async () => {
+            pending = pending || startCallback();
+            return pending;
+        };
+    }
+    /**
+     * Attaches callbacks for the resolution and/or rejection of the Promise.
+     * @param onfulfilled The callback to execute when the Promise is resolved.
+     * @param onrejected The callback to execute when the Promise is rejected.
+     * @return A Promise for the completion of which ever callback is executed.
+     */
+    async then(onfulfilled, onrejected) {
+        return this.start().then(onfulfilled, onrejected);
+    }
+    /**
+     * Attaches a callback for only the rejection of the Promise.
+     * @param onrejected The callback to execute when the Promise is rejected.
+     * @return A Promise for the completion of the callback.
+     */
+    async catch(onrejected) {
+        return this.start().catch(onrejected);
+    }
+    /**
+     * Attaches a callback for only the finally clause of the Promise.
+     * @param onrejected The callback to execute when the Promise is finalized.
+     * @return A Promise for the completion of the callback.
+     */
+    async finally(onFinally) {
+        return this.start().finally(onFinally);
+    }
+}
+_a = Symbol.toStringTag;
+// Because the property getters that wrap `props` are dynamically added, TypeScript isn't aware of them.
+// So by defining this as a class _expression_, we can cast the constructed type to Readonly<TProps> & DelayedPromise<TPayload>
+/**
+ * @beta
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DelayedPromiseWithProps = (class extends DelayedPromise {
+    constructor(props, cb) {
+        super(cb);
+        const handler = {
+            get: (target, name) => {
+                return (name in this) ? this[name] : target[name];
+            },
+        };
+        return new Proxy(props, handler);
+    }
+});
+//# sourceMappingURL=DelayedPromise.js.map

package/lib/esm/DelayedPromise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelayedPromise.js","sourceRoot":"","sources":["../../src/DelayedPromise.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,cAAc;IAEzB;;;OAGG;IACH,YAAY,aAA+B;QAQ3C,qGAAqG;QACrF,QAAoB,GAAG,SAAkB,CAAC;QARxD,IAAI,OAA+B,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,EAAE;YACtB,OAAO,GAAG,OAAO,IAAI,aAAa,EAAE,CAAC;YACrC,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC;IACJ,CAAC;IAUD;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CAAiC,WAAiF,EAAE,UAAmF;QACtN,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,KAAK,CAAkB,UAAiF;QACnH,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAAC,SAA2C;QAC9D,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;CACF;KAlCkB,MAAM,CAAC,WAAW;AAkErC,wGAAwG;AACxG,+HAA+H;AAC/H;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,KAAyD,SAAQ,cAAwB;IAC/H,YAAY,KAAa,EAAE,EAA2B;QACpD,KAAK,CAAC,EAAE,CAAC,CAAC;QAEV,MAAM,OAAO,GAAG;YACd,GAAG,EAAE,CAAC,MAAc,EAAE,IAAY,EAAE,EAAE;gBACpC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAkB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAoB,CAAC,CAAC;YAClF,CAAC;SACF,CAAC;QAEF,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,CAAgD,CAAC;IAClF,CAAC;CACF,CAAuC,CAAC","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/** @packageDocumentation\r\n * @module Utils\r\n */\r\n\r\n/**\r\n * Similar to a normal Promise, a DelayedPromise represents the eventual completion (or failure)\r\n * and resulting value of an asynchronous operation ***that has not yet started***.\r\n *\r\n * The asynchronous operation behind a DelayedPromise will start when any of the following occurs:\r\n *  - The DelayedPromise is `await`ed.\r\n *  - A callback is attached via `.then()` or `.catch(() => { })`.\r\n *  - The asynchronous operation is explicitly started via `.start()`\r\n *\r\n * Just as normal Promises will never return to their pending state once fulfilled or rejected,\r\n * a DelayedPromise will never re-execute its asynchronous operation more than **once**.\r\n *\r\n * Ultimately, a DelayedPromise is nothing more than some syntactic sugar that allows you to\r\n * represent an (asynchronously) lazily-loaded value as an instance property instead of a method.\r\n * You could also accomplish something similar by defining an async function as a property getter.\r\n * However, since a property defined as a DelayedPromise will not start simply by being accessed,\r\n * additional (non-lazily-loaded) \"nested\" properties can be added.\r\n *\r\n * [!alert text=\"*Remember:* Unlike regular Promises in JavaScript, DelayedPromises represent processes that **may not** already be happening.\" kind=\"warning\"]\r\n * @beta\r\n */\r\nexport class DelayedPromise<T> implements Promise<T> {\r\n\r\n  /**\r\n   * Constructs a DelayedPromise object.\r\n   * @param startCallback The asynchronous callback to execute when this DelayedPromise should be \"started\".\r\n   */\r\n  constructor(startCallback: () => Promise<T>) {\r\n    let pending: Promise<T> | undefined;\r\n    this.start = async () => {\r\n      pending = pending || startCallback();\r\n      return pending;\r\n    };\r\n  }\r\n\r\n  // We need this in order to fulfill the Promise interface defined in lib.es2015.symbol.wellknown.d.ts\r\n  public readonly [Symbol.toStringTag] = \"Promise\" as const;\r\n\r\n  /**\r\n   * Explicitly starts the asynchronous operation behind this DelayedPromise (if it hasn't started already).\r\n   */\r\n  public start: () => Promise<T>;\r\n\r\n  /**\r\n   * Attaches callbacks for the resolution and/or rejection of the Promise.\r\n   * @param onfulfilled The callback to execute when the Promise is resolved.\r\n   * @param onrejected The callback to execute when the Promise is rejected.\r\n   * @return A Promise for the completion of which ever callback is executed.\r\n   */\r\n  public async then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2> {\r\n    return this.start().then(onfulfilled, onrejected);\r\n  }\r\n\r\n  /**\r\n   * Attaches a callback for only the rejection of the Promise.\r\n   * @param onrejected The callback to execute when the Promise is rejected.\r\n   * @return A Promise for the completion of the callback.\r\n   */\r\n  public async catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult> {\r\n    return this.start().catch(onrejected);\r\n  }\r\n\r\n  /**\r\n   * Attaches a callback for only the finally clause of the Promise.\r\n   * @param onrejected The callback to execute when the Promise is finalized.\r\n   * @return A Promise for the completion of the callback.\r\n   */\r\n  public async finally(onFinally?: (() => void) | undefined | null): Promise<T> {\r\n    return this.start().finally(onFinally);\r\n  }\r\n}\r\n\r\n// This keeps us from accidentally overriding one of DelayedPromise's methods in the DelayedPromiseWithProps constructor\r\n/**\r\n * @beta\r\n */\r\nexport interface NoDelayedPromiseMethods {\r\n  [propName: string]: any;\r\n  start?: never;\r\n  then?: never;\r\n  catch?: never;\r\n}\r\n\r\n// See definition of DelayedPromiseWithProps below\r\n/**\r\n * @beta\r\n */\r\nexport interface DelayedPromiseWithPropsConstructor {\r\n\r\n  /**\r\n   * Constructs a DelayedPromiseWithProps object, which is at once both:\r\n   *  - A DelayedPromise object representing the eventual completion (or failure)\r\n   *    of an asynchronous operation returning a value of type `TPayload`\r\n   *  - _and_ a readonly \"wrapper\" around an instance of type `TProps`\r\n   *\r\n   * @param props An object with properties and methods that will be accessible\r\n   *              as if they were readonly properties of the DelayedPromiseWithProps object being constructed.\r\n   * @param startCallback The asynchronous callback to execute when as soon as this DelayedPromise should be \"started\".\r\n   */\r\n  new <TProps extends NoDelayedPromiseMethods, TPayload>(props: TProps, startCallback: () => Promise<TPayload>): Readonly<TProps> & DelayedPromise<TPayload>; // eslint-disable-line @typescript-eslint/prefer-function-type\r\n}\r\n\r\n// Because the property getters that wrap `props` are dynamically added, TypeScript isn't aware of them.\r\n// So by defining this as a class _expression_, we can cast the constructed type to Readonly<TProps> & DelayedPromise<TPayload>\r\n/**\r\n * @beta\r\n */\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nexport const DelayedPromiseWithProps = (class <TProps extends NoDelayedPromiseMethods, TPayload> extends DelayedPromise<TPayload> {\r\n  constructor(props: TProps, cb: () => Promise<TPayload>) {\r\n    super(cb);\r\n\r\n    const handler = {\r\n      get: (target: TProps, name: string) => {\r\n        return (name in this) ? this[name as keyof this] : target[name as keyof TProps];\r\n      },\r\n    };\r\n\r\n    return new Proxy(props, handler) as Readonly<TProps> & DelayedPromise<TPayload>;\r\n  }\r\n}) as DelayedPromiseWithPropsConstructor;\r\n\r\n/* eslint-disable @typescript-eslint/no-redeclare */\r\n\r\n/** Define the type of a DelayedPromiseWithProps instance\r\n * @beta\r\n */\r\nexport type DelayedPromiseWithProps<TProps, TPayload> = Readonly<TProps> & DelayedPromise<TPayload>;\r\n"]}

package/lib/esm/Deserialization/AbstractParser.d.ts

@@ -0,0 +1,46 @@
+import { ConstantProps, CustomAttributeClassProps, EntityClassProps, EnumerationProps, InvertedUnitProps, KindOfQuantityProps, MixinProps, NavigationPropertyProps, PhenomenonProps, PrimitiveArrayPropertyProps, PrimitivePropertyProps, PropertyCategoryProps, RelationshipClassProps, SchemaItemFormatProps, SchemaItemUnitProps, SchemaProps, SchemaReferenceProps, StructArrayPropertyProps, StructClassProps, StructPropertyProps, UnitSystemProps } from "../Deserialization/JsonProps";
+import { CustomAttribute } from "../Metadata/CustomAttribute";
+import { CustomAttributeClass } from "../Metadata/CustomAttributeClass";
+type SchemaItemTuple<T> = Readonly<[string /** Name */, string /** SchemaItemType */, Readonly<T>]>;
+type PropertyTuple<T> = Readonly<[string /** Name */, string /** Property */, Readonly<T>]>;
+/** @internal */
+export type CustomAttributeProvider = (caClass: CustomAttributeClass) => CustomAttribute;
+/** @internal */
+export type CAProviderTuple = Readonly<[string /** Full Name */, CustomAttributeProvider]>;
+/** @internal */
+export declare abstract class AbstractParser<TItem = any, TProperty = TItem> {
+    abstract parseSchema(): SchemaProps;
+    abstract getReferences(): Iterable<SchemaReferenceProps>;
+    abstract getItems(): Iterable<SchemaItemTuple<TItem>>;
+    abstract findItem(itemName: string): SchemaItemTuple<TItem> | undefined;
+    abstract parseEntityClass(data: Readonly<TItem>): EntityClassProps;
+    abstract parseMixin(data: Readonly<TItem>): MixinProps;
+    abstract parseStructClass(data: Readonly<TItem>): StructClassProps;
+    abstract parseCustomAttributeClass(data: Readonly<TItem>): CustomAttributeClassProps;
+    abstract parseRelationshipClass(data: Readonly<TItem>): RelationshipClassProps;
+    abstract parseEnumeration(data: Readonly<TItem>): EnumerationProps;
+    abstract parseKindOfQuantity(data: Readonly<TItem>): KindOfQuantityProps;
+    abstract parsePropertyCategory(data: Readonly<TItem>): PropertyCategoryProps;
+    abstract parseUnit(data: Readonly<TItem>): SchemaItemUnitProps;
+    abstract parseInvertedUnit(data: Readonly<TItem>): InvertedUnitProps;
+    abstract parseConstant(data: Readonly<TItem>): ConstantProps;
+    abstract parsePhenomenon(data: Readonly<TItem>): PhenomenonProps;
+    abstract parseFormat(data: Readonly<TItem>): SchemaItemFormatProps;
+    abstract parseUnitSystem(data: Readonly<TItem>): UnitSystemProps;
+    abstract getProperties(data: Readonly<TItem>, itemName: string): Iterable<PropertyTuple<TProperty>>;
+    abstract parsePrimitiveProperty(data: Readonly<TProperty>): PrimitivePropertyProps;
+    abstract parseStructProperty(data: Readonly<TProperty>): StructPropertyProps;
+    abstract parsePrimitiveArrayProperty(data: Readonly<TProperty>): PrimitiveArrayPropertyProps;
+    abstract parseStructArrayProperty(data: Readonly<TProperty>): StructArrayPropertyProps;
+    abstract parseNavigationProperty(data: Readonly<TProperty>): NavigationPropertyProps;
+    abstract getSchemaCustomAttributeProviders(): Iterable<CAProviderTuple>;
+    abstract getClassCustomAttributeProviders(data: Readonly<TItem>): Iterable<CAProviderTuple>;
+    abstract getPropertyCustomAttributeProviders(data: Readonly<TProperty>): Iterable<CAProviderTuple>;
+    abstract getRelationshipConstraintCustomAttributeProviders(data: Readonly<TItem>): [Iterable<CAProviderTuple>, Iterable<CAProviderTuple>];
+}
+/** @internal */
+export interface AbstractParserConstructor<TSchema, TItem = any, TProperty = TItem> {
+    new (obj: Readonly<TSchema>): AbstractParser<TItem, TProperty>;
+}
+export {};
+//# sourceMappingURL=AbstractParser.d.ts.map

package/lib/esm/Deserialization/AbstractParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractParser.d.ts","sourceRoot":"","sources":["../../../src/Deserialization/AbstractParser.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,aAAa,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,UAAU,EAChI,uBAAuB,EAAE,eAAe,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,sBAAsB,EAC5I,qBAAqB,EAAE,mBAAmB,EAAE,WAAW,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,eAAe,EAChK,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAExE,KAAK,eAAe,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,qBAAqB,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpG,KAAK,aAAa,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,eAAe,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE5F,gBAAgB;AAChB,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,EAAE,oBAAoB,KAAK,eAAe,CAAC;AAEzF,gBAAgB;AAChB,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,CAAC,MAAM,CAAC,gBAAgB,EAAE,uBAAuB,CAAC,CAAC,CAAC;AAE3F,gBAAgB;AAChB,8BAAsB,cAAc,CAAC,KAAK,GAAG,GAAG,EAAE,SAAS,GAAG,KAAK;aACjD,WAAW,IAAI,WAAW;aAC1B,aAAa,IAAI,QAAQ,CAAC,oBAAoB,CAAC;aAE/C,QAAQ,IAAI,QAAQ,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;aAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,SAAS;aAE9D,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,gBAAgB;aACzD,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,UAAU;aAC7C,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,gBAAgB;aACzD,yBAAyB,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,yBAAyB;aAC3E,sBAAsB,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,sBAAsB;aACrE,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,gBAAgB;aACzD,mBAAmB,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,mBAAmB;aAC/D,qBAAqB,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,qBAAqB;aACnE,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,mBAAmB;aACrD,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,iBAAiB;aAC3D,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,aAAa;aACnD,eAAe,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,eAAe;aACvD,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,qBAAqB;aACzD,eAAe,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,eAAe;aAEvD,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;aAC1F,sBAAsB,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,sBAAsB;aACzE,mBAAmB,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,mBAAmB;aACnE,2BAA2B,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,2BAA2B;aACnF,wBAAwB,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,wBAAwB;aAC7E,uBAAuB,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,uBAAuB;aAE3E,iCAAiC,IAAI,QAAQ,CAAC,eAAe,CAAC;aAC9D,gCAAgC,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,eAAe,CAAC;aAClF,mCAAmC,CAAC,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAC,eAAe,CAAC;aACzF,iDAAiD,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAe,QAAQ,CAAC,eAAe,CAAC,CAAc;CAC3K;AAED,gBAAgB;AAEhB,MAAM,WAAW,yBAAyB,CAAC,OAAO,EAAE,KAAK,GAAG,GAAG,EAAE,SAAS,GAAG,KAAK;IAAI,KAAI,GAAG,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;CAAE"}

package/lib/esm/Deserialization/AbstractParser.js

@@ -0,0 +1,8 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @internal */
+export class AbstractParser {
+}
+//# sourceMappingURL=AbstractParser.js.map

package/lib/esm/Deserialization/AbstractParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractParser.js","sourceRoot":"","sources":["../../../src/Deserialization/AbstractParser.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAmB/F,gBAAgB;AAChB,MAAM,OAAgB,cAAc;CAiCnC","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 {\r\n  ConstantProps, CustomAttributeClassProps, EntityClassProps, EnumerationProps, InvertedUnitProps, KindOfQuantityProps, MixinProps,\r\n  NavigationPropertyProps, PhenomenonProps, PrimitiveArrayPropertyProps, PrimitivePropertyProps, PropertyCategoryProps, RelationshipClassProps,\r\n  SchemaItemFormatProps, SchemaItemUnitProps, SchemaProps, SchemaReferenceProps, StructArrayPropertyProps, StructClassProps, StructPropertyProps, UnitSystemProps,\r\n} from \"../Deserialization/JsonProps\";\r\nimport { CustomAttribute } from \"../Metadata/CustomAttribute\";\r\nimport { CustomAttributeClass } from \"../Metadata/CustomAttributeClass\";\r\n\r\ntype SchemaItemTuple<T> = Readonly<[string /** Name */, string /** SchemaItemType */, Readonly<T>]>;\r\ntype PropertyTuple<T> = Readonly<[string /** Name */, string /** Property */, Readonly<T>]>;\r\n\r\n/** @internal */\r\nexport type CustomAttributeProvider = (caClass: CustomAttributeClass) => CustomAttribute;\r\n\r\n/** @internal */\r\nexport type CAProviderTuple = Readonly<[string /** Full Name */, CustomAttributeProvider]>;\r\n\r\n/** @internal */\r\nexport abstract class AbstractParser<TItem = any, TProperty = TItem> {\r\n  public abstract parseSchema(): SchemaProps;\r\n  public abstract getReferences(): Iterable<SchemaReferenceProps>;\r\n\r\n  public abstract getItems(): Iterable<SchemaItemTuple<TItem>>;\r\n  public abstract findItem(itemName: string): SchemaItemTuple<TItem> | undefined;\r\n\r\n  public abstract parseEntityClass(data: Readonly<TItem>): EntityClassProps;\r\n  public abstract parseMixin(data: Readonly<TItem>): MixinProps;\r\n  public abstract parseStructClass(data: Readonly<TItem>): StructClassProps;\r\n  public abstract parseCustomAttributeClass(data: Readonly<TItem>): CustomAttributeClassProps;\r\n  public abstract parseRelationshipClass(data: Readonly<TItem>): RelationshipClassProps;\r\n  public abstract parseEnumeration(data: Readonly<TItem>): EnumerationProps;\r\n  public abstract parseKindOfQuantity(data: Readonly<TItem>): KindOfQuantityProps;\r\n  public abstract parsePropertyCategory(data: Readonly<TItem>): PropertyCategoryProps;\r\n  public abstract parseUnit(data: Readonly<TItem>): SchemaItemUnitProps;\r\n  public abstract parseInvertedUnit(data: Readonly<TItem>): InvertedUnitProps;\r\n  public abstract parseConstant(data: Readonly<TItem>): ConstantProps;\r\n  public abstract parsePhenomenon(data: Readonly<TItem>): PhenomenonProps;\r\n  public abstract parseFormat(data: Readonly<TItem>): SchemaItemFormatProps;\r\n  public abstract parseUnitSystem(data: Readonly<TItem>): UnitSystemProps;\r\n\r\n  public abstract getProperties(data: Readonly<TItem>, itemName: string): Iterable<PropertyTuple<TProperty>>;\r\n  public abstract parsePrimitiveProperty(data: Readonly<TProperty>): PrimitivePropertyProps;\r\n  public abstract parseStructProperty(data: Readonly<TProperty>): StructPropertyProps;\r\n  public abstract parsePrimitiveArrayProperty(data: Readonly<TProperty>): PrimitiveArrayPropertyProps;\r\n  public abstract parseStructArrayProperty(data: Readonly<TProperty>): StructArrayPropertyProps;\r\n  public abstract parseNavigationProperty(data: Readonly<TProperty>): NavigationPropertyProps;\r\n\r\n  public abstract getSchemaCustomAttributeProviders(): Iterable<CAProviderTuple>;\r\n  public abstract getClassCustomAttributeProviders(data: Readonly<TItem>): Iterable<CAProviderTuple>;\r\n  public abstract getPropertyCustomAttributeProviders(data: Readonly<TProperty>): Iterable<CAProviderTuple>;\r\n  public abstract getRelationshipConstraintCustomAttributeProviders(data: Readonly<TItem>): [Iterable<CAProviderTuple> /* source */, Iterable<CAProviderTuple> /* target */];\r\n}\r\n\r\n/** @internal */\r\n// eslint-disable-next-line @typescript-eslint/prefer-function-type\r\nexport interface AbstractParserConstructor<TSchema, TItem = any, TProperty = TItem> { new(obj: Readonly<TSchema>): AbstractParser<TItem, TProperty> }\r\n"]}

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

@@ -0,0 +1,263 @@
+import { SchemaContext } from "../Context";
+import { SchemaInfo } from "../Interfaces";
+import { Schema } from "../Metadata/Schema";
+import { ISchemaPartVisitor } from "../SchemaPartVisitorDelegate";
+import { AbstractParserConstructor } from "./AbstractParser";
+/**
+ * This class properly handles the order the deserialization of ECSchemas and SchemaItems from serialized formats.
+ * For example, when deserializing an ECClass most times all base class should be de-serialized before the given class.
+ * @internal
+ */
+export declare class SchemaReadHelper<T = unknown> {
+    private _context;
+    private _visitorHelper?;
+    private _parserType;
+    private _parser;
+    private _schema?;
+    private _schemaInfo?;
+    constructor(parserType: AbstractParserConstructor<T>, context?: SchemaContext, visitor?: ISchemaPartVisitor);
+    /**
+     * Creates a complete SchemaInfo and starts parsing the schema from a serialized representation.
+     * The info and schema promise will be registered with the SchemaContext.  The complete schema can be retrieved by
+     * calling getCachedSchema on the context.
+     * @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>;
+    /**
+     * 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>;
+    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;
+    /**
+     * 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.
+     */
+    private loadSchemaReference;
+    /**
+     * 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.
+     */
+    private loadSchemaReferenceSync;
+    /**
+     * Validates schema references against multiple EC rules.
+     * @param schema The schema to validate.
+     */
+    private validateSchemaReferences;
+    /**
+     * Given the schema item object, the anticipated type and the name a schema item is created and loaded into the schema provided.
+     * @param schema The Schema the SchemaItem to.
+     * @param name The name of the schema item to be loaded.
+     * @param itemType The SchemaItemType of the item to load.
+     * @param schemaItemObject The Object to populate the SchemaItem with.
+     */
+    private loadSchemaItem;
+    /**
+     * Given the schema item object, the anticipated type and the name a schema item is created and loaded into the schema provided.
+     * @param schema The Schema the SchemaItem to.
+     * @param name The name of the schema item to be loaded.
+     * @param itemType The SchemaItemType of the item to load.
+     * @param schemaItemObject The Object to populate the SchemaItem with.
+     */
+    private loadSchemaItemSync;
+    /**
+     * Given the full (Schema.ItemName) or qualified (alias:ItemName) item name, returns
+     * a tuple of strings in the format ["SchemaName", "ItemName"]. The schema name may be
+     * empty if the item comes from the schema being parsed.
+     * @param fullOrQualifiedName The full or qualified name of the schema item.
+     * @param schema The schema that will be used to lookup the schema name by alias, if necessary.
+     */
+    private static resolveSchemaAndItemName;
+    /**
+     * Finds the a SchemaItem matching the name first by checking the schema that is being deserialized. If it does
+     * not exist within the schema, the SchemaContext will be searched.
+     * @param name The full (Schema.ItemName) or qualified (alias:ItemName) name of the SchemaItem to search for.
+     * @param skipVisitor Used to break Mixin -appliesTo-> Entity -extends-> Mixin cycle.
+     * @param loadCallBack Only called if the SchemaItem had to be loaded.
+     * @return The SchemaItem if it had to be loaded, otherwise undefined.
+     */
+    private findSchemaItem;
+    /**
+     * Finds the a SchemaItem matching the name first by checking the schema that is being deserialized. If it does
+     * not exist within the schema, the SchemaContext will be searched.
+     * @param name The full (Schema.ItemName) or qualified (alias:ItemName) name of the SchemaItem to search for.
+     * @param skipVisitor Used to break Mixin -appliesTo-> Entity -extends-> Mixin cycle.
+     * @param loadCallBack Only called if the SchemaItem had to be loaded.
+     * @return The SchemaItem if it had to be loaded, otherwise undefined.
+     */
+    private findSchemaItemSync;
+    /**
+     * Load dependencies on phenomenon and unitSystem for a Unit object and load the Unit from its serialized format.
+     * @param unit The Unit object that we are loading dependencies for and "deserializing into".
+     * @param rawUnit The serialized unit data
+     */
+    private loadUnit;
+    /**
+     * Load dependencies on phenomenon and unitSystem for a Unit object and load the Unit from its serialized format.
+     * @param unit The Unit object that we are loading dependencies for and "deserializing into".
+     * @param rawUnit The serialized unit data
+     */
+    private loadUnitSync;
+    /**
+     * Load the persistence unit and presentation unit dependencies for a KindOfQuantity object and load the KoQ from its serialized format.
+     * @param koq The KindOfQuantity object that we are loading dependencies for and "deserializing into".
+     * @param rawKoQ The serialized kind of quantity data
+     */
+    private loadKindOfQuantity;
+    /**
+     * Load the persistence unit and presentation unit dependencies for a KindOfQuantity object and load the KoQ from its serialized format.
+     * @param koq The KindOfQuantity object that we are loading dependencies for and "deserializing into".
+     * @param rawKoQ The serialized kind of quantity data
+     */
+    private loadKindOfQuantitySync;
+    /**
+     * Load the phenomenon dependency for a Constant object and load the Constant from its serialized format.
+     * @param constant The Constant object that we are loading the phenomenon dependency for
+     * @param rawConstant The serialized constant data
+     */
+    private loadConstant;
+    /**
+     * Load the phenomenon dependency for a Constant object and load the Constant from its serialized format.
+     * @param constant The Constant object that we are loading dependencies for and "deserializing into".
+     * @param rawConstant The serialized constant data
+     */
+    private loadConstantSync;
+    /**
+     * Load the unit system and invertsUnit dependencies for an Inverted Unit object and load the Inverted Unit from its serialized format.
+     * @param invertedUnit The InvertedUnit object that we are loading dependencies for and "deserializing into".
+     * @param rawInvertedUnit The serialized inverted unit data.
+     */
+    private loadInvertedUnit;
+    /**
+     * Load the unit system and invertsUnit dependencies for an Inverted Unit object and load the Inverted Unit from its serialized format.
+     * @param invertedUnit The InvertedUnit object that we are loading dependencies for and "deserializing into".
+     * @param rawInvertedUnit The serialized inverted unit data.
+     */
+    private loadInvertedUnitSync;
+    /**
+     * Load the unit dependencies for a Format object and load the Format from its serialized format.
+     * @param format The Format object that we are loading dependencies for and "deserializing into".
+     * @param rawFormat The serialized format data.
+     */
+    private loadFormat;
+    /**
+     * Load the unit dependencies for a Format object and load the Format from its serialized format.
+     * @param format The Format object that we are loading dependencies for and "deserializing into".
+     * @param rawFormat The serialized format data.
+     */
+    private loadFormatSync;
+    /**
+     * Load the base class and property type dependencies for an ECClass object and load the ECClass (and its properties) from its serialized format.
+     * @param classObj The ECClass object that we are loading dependencies for and "deserializing into".
+     * @param classProps The parsed class props object.
+     * @param rawClass The serialized class data.
+     */
+    private loadClass;
+    /**
+     * Load the base class and property type dependencies for an ECClass object and load the ECClass (and its properties) from its serialized format.
+     * @param classObj The ECClass object that we are loading dependencies for and "deserializing into".
+     * @param classProps The parsed class props object.
+     * @param rawClass The serialized class data.
+     */
+    private loadClassSync;
+    /**
+     * Load the mixin, base class, and property type dependencies for an EntityClass object and load the EntityClass (and properties) from its serialized format.
+     * @param entity The EntityClass that we are loading dependencies for and "deserializing into".
+     * @param rawEntity The serialized entity class data.
+     */
+    private loadEntityClass;
+    /**
+     * Load the mixin, base class, and property type dependencies for an EntityClass object and load the EntityClass (and properties) from its serialized format.
+     * @param entity The EntityClass that we are loading dependencies for and "deserializing into".
+     * @param rawEntity The serialized entity class data.
+     */
+    private loadEntityClassSync;
+    /**
+     * Load the appliesTo class, base class, and property type dependencies for a Mixin object and load the Mixin (and properties) from its serialized format.
+     * @param mixin The Mixin that we are loading dependencies for and "deserializing into".
+     * @param rawMixin The serialized mixin data.
+     */
+    private loadMixin;
+    /**
+     * Load the appliesTo class, base class, and property type dependencies for a Mixin object and load the Mixin (and properties) from its serialized format.
+     * @param mixin The Mixin that we are loading dependencies for and "deserializing into".
+     * @param rawMixin The serialized mixin data.
+     */
+    private loadMixinSync;
+    /**
+     * Load the relationship constraint, base class, and property type dependencies for a RelationshipClass object and load the RelationshipClass (and properties) from its serialized format.
+     * @param rel The RelationshipClass that we are loading dependencies for and "deserializing into".
+     * @param rawRel The serialized relationship class data.
+     */
+    private loadRelationshipClass;
+    /**
+     * Load the relationship constraint, base class, and property type dependencies for a RelationshipClass object and load the RelationshipClass (and properties) from its serialized format.
+     * @param rel The RelationshipClass that we are loading dependencies for and "deserializing into".
+     * @param rawRel The serialized relationship class data.
+     */
+    private loadRelationshipClassSync;
+    /**
+     * Load the abstract constraint and constraint class dependencies for a RelationshipConstraint object and load the RelationshipConstraint from its parsed props.
+     * @param relConstraint The RelationshipConstraint that we are loading dependencies for and "deserializing into".
+     * @param props The parsed relationship constraint props.
+     */
+    private loadRelationshipConstraint;
+    /**
+     * Load the abstract constraint and constraint class dependencies for a RelationshipConstraint object and load the RelationshipConstraint from its parsed props.
+     * @param relConstraint The RelationshipConstraint that we are loading dependencies for and "deserializing into".
+     * @param props The parsed relationship constraint props.
+     */
+    private loadRelationshipConstraintSync;
+    /**
+     * Load the type dependencies for a serialized property, then creates and deserialized the Property object in the given ECClass.
+     * @param classObj The ECClass that the Property should be created in.
+     * @param propName The name of the Property.
+     * @param propType The (serialized string) kind of property to create.
+     * @param rawProperty The serialized property data.
+     */
+    private loadPropertyTypes;
+    /**
+     * Load the type dependencies for a serialized property, then creates and deserialized the Property object in the given ECClass.
+     * @param classObj The ECClass that the Property should be created in.
+     * @param propName The name of the Property.
+     * @param propType The (serialized string) kind of property to create.
+     * @param rawProperty The serialized property data.
+     */
+    private loadPropertyTypesSync;
+    /**
+     * Load the propertyCategory, kindOfQuantity, and customAttribute dependencies for a Property object and load the Property from its parsed props.
+     * @param propertyObj The Property that we are loading dependencies for and "deserializing into".
+     * @param props The parsed property props.
+     * @param rawProperty The serialized property data.
+     */
+    private loadProperty;
+    /**
+     * Load the propertyCategory, kindOfQuantity, and customAttribute dependencies for a Property object and load the Property from its parsed props.
+     * @param propertyObj The Property that we are loading dependencies for and "deserializing into".
+     * @param props The parsed property props.
+     * @param rawProperty The serialized property data.
+     */
+    private loadPropertySync;
+    /**
+     * Load the customAttribute class dependencies for a set of CustomAttribute objects and add
+     * them to a given custom attribute container.
+     * @param container The CustomAttributeContainer that each CustomAttribute will be added to.
+     * @param customAttributes An iterable set of parsed CustomAttribute objects.
+     */
+    private loadCustomAttributes;
+    /**
+     * Load the customAttribute class dependencies for a set of CustomAttribute objects and add them to a given custom attribute container.
+     * @param container The CustomAttributeContainer that each CustomAttribute will be added to.
+     * @param customAttributes An iterable set of parsed CustomAttribute objects.
+     */
+    private loadCustomAttributesSync;
+}
+//# sourceMappingURL=Helper.d.ts.map

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

@@ -0,0 +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;;;;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;IA6C/B;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IA4C7B;;;;;OAKG;YACW,YAAY;IAa1B;;;;;OAKG;IACH,OAAO,CAAC,gBAAgB;IAaxB;;;;;OAKG;YACW,oBAAoB;IAmBlC;;;;OAIG;IACH,OAAO,CAAC,wBAAwB;CAWjC"}