@itwin/ecschema-metadata 5.0.0-dev.99 → 5.1.0-dev.1

package/lib/esm/DelayedPromise.js

@@ -24,7 +24,7 @@
  * 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
+ * @internal
  */
 export class DelayedPromise {
     /**
@@ -73,7 +73,7 @@ export class DelayedPromise {
 // 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
+ * @internal
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 export const DelayedPromiseWithProps = (class extends DelayedPromise {

package/lib/esm/DelayedPromise.js.map

@@ -1 +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;QACzC,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;IAED,qGAAqG;IACrF,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,SAAkB,CAAC;IAE1D;;OAEG;IACI,KAAK,CAAmB;IAE/B;;;;;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;AAgCD,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":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Utils\n */\n\n/**\n * Similar to a normal Promise, a DelayedPromise represents the eventual completion (or failure)\n * and resulting value of an asynchronous operation ***that has not yet started***.\n *\n * The asynchronous operation behind a DelayedPromise will start when any of the following occurs:\n *  - The DelayedPromise is `await`ed.\n *  - A callback is attached via `.then()` or `.catch(() => { })`.\n *  - The asynchronous operation is explicitly started via `.start()`\n *\n * Just as normal Promises will never return to their pending state once fulfilled or rejected,\n * a DelayedPromise will never re-execute its asynchronous operation more than **once**.\n *\n * Ultimately, a DelayedPromise is nothing more than some syntactic sugar that allows you to\n * represent an (asynchronously) lazily-loaded value as an instance property instead of a method.\n * You could also accomplish something similar by defining an async function as a property getter.\n * However, since a property defined as a DelayedPromise will not start simply by being accessed,\n * additional (non-lazily-loaded) \"nested\" properties can be added.\n *\n * [!alert text=\"*Remember:* Unlike regular Promises in JavaScript, DelayedPromises represent processes that **may not** already be happening.\" kind=\"warning\"]\n * @beta\n */\nexport class DelayedPromise<T> implements Promise<T> {\n\n  /**\n   * Constructs a DelayedPromise object.\n   * @param startCallback The asynchronous callback to execute when this DelayedPromise should be \"started\".\n   */\n  constructor(startCallback: () => Promise<T>) {\n    let pending: Promise<T> | undefined;\n    this.start = async () => {\n      pending = pending || startCallback();\n      return pending;\n    };\n  }\n\n  // We need this in order to fulfill the Promise interface defined in lib.es2015.symbol.wellknown.d.ts\n  public readonly [Symbol.toStringTag] = \"Promise\" as const;\n\n  /**\n   * Explicitly starts the asynchronous operation behind this DelayedPromise (if it hasn't started already).\n   */\n  public start: () => Promise<T>;\n\n  /**\n   * Attaches callbacks for the resolution and/or rejection of the Promise.\n   * @param onfulfilled The callback to execute when the Promise is resolved.\n   * @param onrejected The callback to execute when the Promise is rejected.\n   * @return A Promise for the completion of which ever callback is executed.\n   */\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> {\n    return this.start().then(onfulfilled, onrejected);\n  }\n\n  /**\n   * Attaches a callback for only the rejection of the Promise.\n   * @param onrejected The callback to execute when the Promise is rejected.\n   * @return A Promise for the completion of the callback.\n   */\n  public async catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult> {\n    return this.start().catch(onrejected);\n  }\n\n  /**\n   * Attaches a callback for only the finally clause of the Promise.\n   * @param onrejected The callback to execute when the Promise is finalized.\n   * @return A Promise for the completion of the callback.\n   */\n  public async finally(onFinally?: (() => void) | undefined | null): Promise<T> {\n    return this.start().finally(onFinally);\n  }\n}\n\n// This keeps us from accidentally overriding one of DelayedPromise's methods in the DelayedPromiseWithProps constructor\n/**\n * @beta\n */\nexport interface NoDelayedPromiseMethods {\n  [propName: string]: any;\n  start?: never;\n  then?: never;\n  catch?: never;\n}\n\n// See definition of DelayedPromiseWithProps below\n/**\n * @beta\n */\nexport interface DelayedPromiseWithPropsConstructor {\n\n  /**\n   * Constructs a DelayedPromiseWithProps object, which is at once both:\n   *  - A DelayedPromise object representing the eventual completion (or failure)\n   *    of an asynchronous operation returning a value of type `TPayload`\n   *  - _and_ a readonly \"wrapper\" around an instance of type `TProps`\n   *\n   * @param props An object with properties and methods that will be accessible\n   *              as if they were readonly properties of the DelayedPromiseWithProps object being constructed.\n   * @param startCallback The asynchronous callback to execute when as soon as this DelayedPromise should be \"started\".\n   */\n  new <TProps extends NoDelayedPromiseMethods, TPayload>(props: TProps, startCallback: () => Promise<TPayload>): Readonly<TProps> & DelayedPromise<TPayload>; // eslint-disable-line @typescript-eslint/prefer-function-type\n}\n\n// Because the property getters that wrap `props` are dynamically added, TypeScript isn't aware of them.\n// So by defining this as a class _expression_, we can cast the constructed type to Readonly<TProps> & DelayedPromise<TPayload>\n/**\n * @beta\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DelayedPromiseWithProps = (class <TProps extends NoDelayedPromiseMethods, TPayload> extends DelayedPromise<TPayload> {\n  constructor(props: TProps, cb: () => Promise<TPayload>) {\n    super(cb);\n\n    const handler = {\n      get: (target: TProps, name: string) => {\n        return (name in this) ? this[name as keyof this] : target[name as keyof TProps];\n      },\n    };\n\n    return new Proxy(props, handler) as Readonly<TProps> & DelayedPromise<TPayload>;\n  }\n}) as DelayedPromiseWithPropsConstructor;\n\n/* eslint-disable @typescript-eslint/no-redeclare */\n\n/** Define the type of a DelayedPromiseWithProps instance\n * @beta\n */\nexport type DelayedPromiseWithProps<TProps, TPayload> = Readonly<TProps> & DelayedPromise<TPayload>;\n"]}
+{"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;QACzC,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;IAED,qGAAqG;IACrF,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,SAAkB,CAAC;IAE1D;;OAEG;IACI,KAAK,CAAmB;IAE/B;;;;;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;AAgCD,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,CAAsC,CAAC;IACxE,CAAC;CACF,CAAuC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Utils\n */\n\n/**\n * Similar to a normal Promise, a DelayedPromise represents the eventual completion (or failure)\n * and resulting value of an asynchronous operation ***that has not yet started***.\n *\n * The asynchronous operation behind a DelayedPromise will start when any of the following occurs:\n *  - The DelayedPromise is `await`ed.\n *  - A callback is attached via `.then()` or `.catch(() => { })`.\n *  - The asynchronous operation is explicitly started via `.start()`\n *\n * Just as normal Promises will never return to their pending state once fulfilled or rejected,\n * a DelayedPromise will never re-execute its asynchronous operation more than **once**.\n *\n * Ultimately, a DelayedPromise is nothing more than some syntactic sugar that allows you to\n * represent an (asynchronously) lazily-loaded value as an instance property instead of a method.\n * You could also accomplish something similar by defining an async function as a property getter.\n * However, since a property defined as a DelayedPromise will not start simply by being accessed,\n * additional (non-lazily-loaded) \"nested\" properties can be added.\n *\n * [!alert text=\"*Remember:* Unlike regular Promises in JavaScript, DelayedPromises represent processes that **may not** already be happening.\" kind=\"warning\"]\n * @internal\n */\nexport class DelayedPromise<T> implements Promise<T> {\n\n  /**\n   * Constructs a DelayedPromise object.\n   * @param startCallback The asynchronous callback to execute when this DelayedPromise should be \"started\".\n   */\n  constructor(startCallback: () => Promise<T>) {\n    let pending: Promise<T> | undefined;\n    this.start = async () => {\n      pending = pending || startCallback();\n      return pending;\n    };\n  }\n\n  // We need this in order to fulfill the Promise interface defined in lib.es2015.symbol.wellknown.d.ts\n  public readonly [Symbol.toStringTag] = \"Promise\" as const;\n\n  /**\n   * Explicitly starts the asynchronous operation behind this DelayedPromise (if it hasn't started already).\n   */\n  public start: () => Promise<T>;\n\n  /**\n   * Attaches callbacks for the resolution and/or rejection of the Promise.\n   * @param onfulfilled The callback to execute when the Promise is resolved.\n   * @param onrejected The callback to execute when the Promise is rejected.\n   * @return A Promise for the completion of which ever callback is executed.\n   */\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> {\n    return this.start().then(onfulfilled, onrejected);\n  }\n\n  /**\n   * Attaches a callback for only the rejection of the Promise.\n   * @param onrejected The callback to execute when the Promise is rejected.\n   * @return A Promise for the completion of the callback.\n   */\n  public async catch<TResult = never>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult> {\n    return this.start().catch(onrejected);\n  }\n\n  /**\n   * Attaches a callback for only the finally clause of the Promise.\n   * @param onrejected The callback to execute when the Promise is finalized.\n   * @return A Promise for the completion of the callback.\n   */\n  public async finally(onFinally?: (() => void) | undefined | null): Promise<T> {\n    return this.start().finally(onFinally);\n  }\n}\n\n// This keeps us from accidentally overriding one of DelayedPromise's methods in the DelayedPromiseWithProps constructor\n/**\n * @internal\n */\nexport interface NoDelayedPromiseMethods {\n  [propName: string]: any;\n  start?: never;\n  then?: never;\n  catch?: never;\n}\n\n// See definition of DelayedPromiseWithProps below\n/**\n * @internal\n */\nexport interface DelayedPromiseWithPropsConstructor {\n\n  /**\n   * Constructs a DelayedPromiseWithProps object, which is at once both:\n   *  - A DelayedPromise object representing the eventual completion (or failure)\n   *    of an asynchronous operation returning a value of type `TPayload`\n   *  - _and_ a readonly \"wrapper\" around an instance of type `TProps`\n   *\n   * @param props An object with properties and methods that will be accessible\n   *              as if they were readonly properties of the DelayedPromiseWithProps object being constructed.\n   * @param startCallback The asynchronous callback to execute when as soon as this DelayedPromise should be \"started\".\n   */\n  new <TProps extends NoDelayedPromiseMethods, TPayload>(props: TProps, startCallback: () => Promise<TPayload>): TProps & DelayedPromise<TPayload>; // eslint-disable-line @typescript-eslint/prefer-function-type\n}\n\n// Because the property getters that wrap `props` are dynamically added, TypeScript isn't aware of them.\n// So by defining this as a class _expression_, we can cast the constructed type to Readonly<TProps> & DelayedPromise<TPayload>\n/**\n * @internal\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DelayedPromiseWithProps = (class <TProps extends NoDelayedPromiseMethods, TPayload> extends DelayedPromise<TPayload> {\n  constructor(props: TProps, cb: () => Promise<TPayload>) {\n    super(cb);\n\n    const handler = {\n      get: (target: TProps, name: string) => {\n        return (name in this) ? this[name as keyof this] : target[name as keyof TProps];\n      },\n    };\n\n    return new Proxy(props, handler) as TProps & DelayedPromise<TPayload>;\n  }\n}) as DelayedPromiseWithPropsConstructor;\n\n/* eslint-disable @typescript-eslint/no-redeclare */\n\n/**\n * Define the type of a DelayedPromiseWithProps instance\n * @internal\n */\nexport type DelayedPromiseWithProps<TProps, TPayload> = TProps & DelayedPromise<TPayload>;\n"]}

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

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

package/lib/esm/Deserialization/Helper.js

@@ -4,7 +4,7 @@
 *--------------------------------------------------------------------------------------------*/
 import { SchemaContext } from "../Context";
 import { parsePrimitiveType, parseSchemaItemType, SchemaItemType, SchemaMatchType } from "../ECObjects";
-import { ECObjectsError, ECObjectsStatus } from "../Exception";
+import { ECSchemaError, ECSchemaStatus } from "../Exception";
 import { Schema } from "../Metadata/Schema";
 import { SchemaItem } from "../Metadata/SchemaItem";
 import { ECVersion, SchemaItemKey, SchemaKey } from "../SchemaKey";
@@ -41,7 +41,7 @@ export class SchemaReadHelper {
         // Ensure context matches schema context
         if (schema.context) {
             if (this._context !== schema.context)
-                throw new ECObjectsError(ECObjectsStatus.DifferentSchemaContexts, "The SchemaContext of the schema must be the same SchemaContext held by the SchemaReadHelper.");
+                throw new ECSchemaError(ECSchemaStatus.DifferentSchemaContexts, "The SchemaContext of the schema must be the same SchemaContext held by the SchemaReadHelper.");
         }
         else {
             schema.setContext(this._context);
@@ -50,10 +50,11 @@ export class SchemaReadHelper {
         // Loads all of the properties on the Schema object
         await schema.fromJSON(this._parser.parseSchema());
         this._schema = schema;
-        const schemaInfo = { schemaKey: schema.schemaKey, references: [] };
+        const schemaInfoReferences = [];
+        const schemaInfo = { schemaKey: schema.schemaKey, alias: schema.alias, references: schemaInfoReferences };
         for (const reference of this._parser.getReferences()) {
             const refKey = new SchemaKey(reference.name, ECVersion.fromString(reference.version));
-            schemaInfo.references.push({ schemaKey: refKey });
+            schemaInfoReferences.push({ schemaKey: refKey });
         }
         this._schemaInfo = schemaInfo;
         // Need to add this schema to the context to be able to locate schemaItems within the context.
@@ -73,7 +74,7 @@ export class SchemaReadHelper {
         }
         const cachedSchema = await this._context.getCachedSchema(this._schemaInfo.schemaKey, SchemaMatchType.Latest);
         if (undefined === cachedSchema)
-            throw new ECObjectsError(ECObjectsStatus.UnableToLoadSchema, `Could not load schema ${schema.schemaKey.toString()}`);
+            throw new ECSchemaError(ECSchemaStatus.UnableToLoadSchema, `Could not load schema ${schema.schemaKey.toString()}`);
         return cachedSchema;
     }
     /* Finish loading the rest of the schema */
@@ -144,7 +145,7 @@ export class SchemaReadHelper {
     async loadSchemaReference(schemaInfo, refKey) {
         const refSchema = await this._context.getSchema(refKey, SchemaMatchType.LatestWriteCompatible);
         if (undefined === refSchema)
-            throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Could not locate the referenced schema, ${refKey.name}.${refKey.version.toString()}, of ${schemaInfo.schemaKey.name}`);
+            throw new ECSchemaError(ECSchemaStatus.UnableToLocateSchema, `Could not locate the referenced schema, ${refKey.name}.${refKey.version.toString()}, of ${schemaInfo.schemaKey.name}`);
         await this._schema.addReference(refSchema);
         const results = this.validateSchemaReferences(this._schema);
         let errorMessage = "";
@@ -152,7 +153,7 @@ export class SchemaReadHelper {
             errorMessage += `${result}\r\n`;
         }
         if (errorMessage) {
-            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `${errorMessage}`);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `${errorMessage}`);
         }
     }
     /**
@@ -163,7 +164,7 @@ export class SchemaReadHelper {
         const schemaKey = new SchemaKey(ref.name, ECVersion.fromString(ref.version));
         const refSchema = this._context.getSchemaSync(schemaKey, SchemaMatchType.LatestWriteCompatible);
         if (!refSchema)
-            throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Could not locate the referenced schema, ${ref.name}.${ref.version}, of ${this._schema.schemaKey.name}`);
+            throw new ECSchemaError(ECSchemaStatus.UnableToLocateSchema, `Could not locate the referenced schema, ${ref.name}.${ref.version}, of ${this._schema.schemaKey.name}`);
         this._schema.addReferenceSync(refSchema);
         SchemaGraph.generateGraphSync(this._schema).throwIfCycles();
         const results = this.validateSchemaReferences(this._schema);
@@ -172,7 +173,7 @@ export class SchemaReadHelper {
             errorMessage += `${result}\r\n`;
         }
         if (errorMessage) {
-            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `${errorMessage}`);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `${errorMessage}`);
         }
     }
     /**
@@ -358,7 +359,7 @@ export class SchemaReadHelper {
         if (undefined !== schema && -1 !== fullOrQualifiedName.indexOf(":")) {
             const refName = schema.getReferenceNameByAlias(schemaName);
             if (undefined === refName)
-                throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Could not resolve schema alias '${schemaName}' for schema item '${itemName}.`);
+                throw new ECSchemaError(ECSchemaStatus.UnableToLocateSchema, `Could not resolve schema alias '${schemaName}' for schema item '${itemName}.`);
             return [refName, itemName];
         }
         return [schemaName, itemName];
@@ -377,7 +378,7 @@ export class SchemaReadHelper {
         const [schemaName, itemName] = SchemaReadHelper.resolveSchemaAndItemName(name, this._schema);
         const isInThisSchema = (this._schema && this._schema.name.toLowerCase() === schemaName.toLowerCase());
         if (undefined === schemaName || 0 === schemaName.length)
-            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The SchemaItem ${name} is invalid without a schema name`);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The SchemaItem ${name} is invalid without a schema name`);
         if (isInThisSchema) {
             schemaItem = await this._schema.getItem(itemName);
             if (schemaItem)
@@ -392,11 +393,11 @@ export class SchemaReadHelper {
                     loadCallBack(schemaItem);
                 return schemaItem;
             }
-            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
         }
         schemaItem = await this._context.getSchemaItem(new SchemaItemKey(itemName, new SchemaKey(schemaName)));
         if (undefined === schemaItem)
-            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
         return schemaItem;
     }
     /**
@@ -413,7 +414,7 @@ export class SchemaReadHelper {
         const [schemaName, itemName] = SchemaReadHelper.resolveSchemaAndItemName(name, this._schema);
         const isInThisSchema = (this._schema && this._schema.name.toLowerCase() === schemaName.toLowerCase());
         if (undefined === schemaName || schemaName.length === 0)
-            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The SchemaItem ${name} is invalid without a schema name`);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The SchemaItem ${name} is invalid without a schema name`);
         if (isInThisSchema && undefined === this._schema.getItemSync(itemName)) {
             const foundItem = this._parser.findItem(itemName);
             if (foundItem) {
@@ -425,11 +426,11 @@ export class SchemaReadHelper {
                     loadCallBack(schemaItem);
                 return schemaItem;
             }
-            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
         }
         schemaItem = this._context.getSchemaItemSync(new SchemaItemKey(itemName, new SchemaKey(schemaName)));
         if (undefined === schemaItem)
-            throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
+            throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `Unable to locate SchemaItem ${name}.`);
         return schemaItem;
     }
     /**
@@ -733,16 +734,16 @@ export class SchemaReadHelper {
         const loadTypeName = async (typeName) => {
             if (undefined === parsePrimitiveType(typeName)) {
                 if (SchemaReadHelper.isECSpecVersionNewer(this._parser.getECSpecVersion))
-                    return ECObjectsStatus.NewerECSpecVersion;
+                    return ECSchemaStatus.NewerECSpecVersion;
                 await this.findSchemaItem(typeName);
             }
-            return ECObjectsStatus.Success;
+            return ECSchemaStatus.Success;
         };
         const lowerCasePropType = propType.toLowerCase();
         switch (lowerCasePropType) {
             case "primitiveproperty":
                 const primPropertyProps = this._parser.parsePrimitiveProperty(rawProperty);
-                if (await loadTypeName(primPropertyProps.typeName) === ECObjectsStatus.NewerECSpecVersion)
+                if (await loadTypeName(primPropertyProps.typeName) === ECSchemaStatus.NewerECSpecVersion)
                     primPropertyProps.typeName = "string";
                 const primProp = await classObj.createPrimitiveProperty(propName, primPropertyProps.typeName);
                 return this.loadProperty(primProp, primPropertyProps, rawProperty);
@@ -753,7 +754,7 @@ export class SchemaReadHelper {
                 return this.loadProperty(structProp, structPropertyProps, rawProperty);
             case "primitivearrayproperty":
                 const primArrPropertyProps = this._parser.parsePrimitiveArrayProperty(rawProperty);
-                if (await loadTypeName(primArrPropertyProps.typeName) === ECObjectsStatus.NewerECSpecVersion)
+                if (await loadTypeName(primArrPropertyProps.typeName) === ECSchemaStatus.NewerECSpecVersion)
                     primArrPropertyProps.typeName = "string";
                 const primArrProp = await classObj.createPrimitiveArrayProperty(propName, primArrPropertyProps.typeName);
                 return this.loadProperty(primArrProp, primArrPropertyProps, rawProperty);
@@ -764,7 +765,7 @@ export class SchemaReadHelper {
                 return this.loadProperty(structArrProp, structArrPropertyProps, rawProperty);
             case "navigationproperty":
                 if (classObj.schemaItemType !== SchemaItemType.EntityClass && classObj.schemaItemType !== SchemaItemType.RelationshipClass && classObj.schemaItemType !== SchemaItemType.Mixin)
-                    throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Navigation Property ${classObj.name}.${propName} is invalid, because only EntityClasses, Mixins, and RelationshipClasses can have NavigationProperties.`);
+                    throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Navigation Property ${classObj.name}.${propName} is invalid, because only EntityClasses, Mixins, and RelationshipClasses can have NavigationProperties.`);
                 const navPropertyProps = this._parser.parseNavigationProperty(rawProperty);
                 await this.findSchemaItem(navPropertyProps.relationshipName);
                 const navProp = await classObj.createNavigationProperty(propName, navPropertyProps.relationshipName, navPropertyProps.direction);
@@ -782,16 +783,16 @@ export class SchemaReadHelper {
         const loadTypeName = (typeName) => {
             if (undefined === parsePrimitiveType(typeName)) {
                 if (SchemaReadHelper.isECSpecVersionNewer(this._parser.getECSpecVersion))
-                    return ECObjectsStatus.NewerECSpecVersion;
+                    return ECSchemaStatus.NewerECSpecVersion;
                 this.findSchemaItemSync(typeName);
             }
-            return ECObjectsStatus.Success;
+            return ECSchemaStatus.Success;
         };
         const lowerCasePropType = propType.toLowerCase();
         switch (lowerCasePropType) {
             case "primitiveproperty":
                 const primPropertyProps = this._parser.parsePrimitiveProperty(rawProperty);
-                if (loadTypeName(primPropertyProps.typeName) === ECObjectsStatus.NewerECSpecVersion)
+                if (loadTypeName(primPropertyProps.typeName) === ECSchemaStatus.NewerECSpecVersion)
                     primPropertyProps.typeName = "string";
                 const primProp = classObj.createPrimitivePropertySync(propName, primPropertyProps.typeName);
                 return this.loadPropertySync(primProp, primPropertyProps, rawProperty);
@@ -802,7 +803,7 @@ export class SchemaReadHelper {
                 return this.loadPropertySync(structProp, structPropertyProps, rawProperty);
             case "primitivearrayproperty":
                 const primArrPropertyProps = this._parser.parsePrimitiveArrayProperty(rawProperty);
-                if (loadTypeName(primArrPropertyProps.typeName) === ECObjectsStatus.NewerECSpecVersion)
+                if (loadTypeName(primArrPropertyProps.typeName) === ECSchemaStatus.NewerECSpecVersion)
                     primArrPropertyProps.typeName = "string";
                 const primArrProp = classObj.createPrimitiveArrayPropertySync(propName, primArrPropertyProps.typeName);
                 return this.loadPropertySync(primArrProp, primArrPropertyProps, rawProperty);
@@ -813,7 +814,7 @@ export class SchemaReadHelper {
                 return this.loadPropertySync(structArrProp, structArrPropertyProps, rawProperty);
             case "navigationproperty":
                 if (classObj.schemaItemType !== SchemaItemType.EntityClass && classObj.schemaItemType !== SchemaItemType.RelationshipClass && classObj.schemaItemType !== SchemaItemType.Mixin)
-                    throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `The Navigation Property ${classObj.name}.${propName} is invalid, because only EntityClasses, Mixins, and RelationshipClasses can have NavigationProperties.`);
+                    throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `The Navigation Property ${classObj.name}.${propName} is invalid, because only EntityClasses, Mixins, and RelationshipClasses can have NavigationProperties.`);
                 const navPropertyProps = this._parser.parseNavigationProperty(rawProperty);
                 this.findSchemaItemSync(navPropertyProps.relationshipName);
                 const navProp = classObj.createNavigationPropertySync(propName, navPropertyProps.relationshipName, navPropertyProps.direction);
@@ -865,7 +866,7 @@ export class SchemaReadHelper {
             // If custom attribute exist within the context and is referenced, validate the reference is defined in the container's schema
             if (caClass && caClass.key.schemaName !== container.schema.name &&
                 !container.schema.getReferenceSync(caClass.key.schemaName)) {
-                throw new ECObjectsError(ECObjectsStatus.InvalidECJson, `Unable to load custom attribute ${caClass.fullName} from container ${container.fullName}, ${caClass.key.schemaName} reference not defined`);
+                throw new ECSchemaError(ECSchemaStatus.InvalidECJson, `Unable to load custom attribute ${caClass.fullName} from container ${container.fullName}, ${caClass.key.schemaName} reference not defined`);
             }
             // Second tuple entry ia a function that provides the CA instance.
             const provider = providerTuple[1];