@itwin/ecschema-metadata 5.0.0-dev.11 → 5.0.0-dev.110

package/lib/cjs/Metadata/PropertyCategory.d.ts

@@ -6,12 +6,15 @@ import { SchemaItemType } from "../ECObjects";
 import { Schema } from "./Schema";
 import { SchemaItem } from "./SchemaItem";
 /**
- * @beta
+ * @public @preview
  */
 export declare class PropertyCategory extends SchemaItem {
-    readonly schemaItemType: SchemaItemType.PropertyCategory;
-    protected _priority: number;
+    readonly schemaItemType: SchemaItemType;
+    /** @internal */
+    static get schemaItemType(): SchemaItemType;
+    private _priority;
     get priority(): number;
+    /** @internal */
     constructor(schema: Schema, name: string);
     /**
      * Save this PropertyCategory's properties to an object for serializing to JSON.
@@ -24,10 +27,23 @@ export declare class PropertyCategory extends SchemaItem {
     fromJSONSync(propertyCategoryProps: PropertyCategoryProps): void;
     fromJSON(propertyCategoryProps: PropertyCategoryProps): Promise<void>;
     /**
-     * @alpha
      * Used for schema editing.
+     * @internal
      */
     protected setPriority(priority: number): void;
+    /**
+     * Type guard to check if the SchemaItem is of type PropertyCategory.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a PropertyCategory, false otherwise.
+     */
+    static isPropertyCategory(item?: SchemaItem): item is PropertyCategory;
+    /**
+     * Type assertion to check if the SchemaItem is of type PropertyCategory.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to PropertyCategory if it is a PropertyCategory, undefined otherwise.
+     * @internal
+     */
+    static assertIsPropertyCategory(item?: SchemaItem): asserts item is PropertyCategory;
 }
 /**
  * @internal

package/lib/cjs/Metadata/PropertyCategory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyCategory.d.ts","sourceRoot":"","sources":["../../../src/Metadata/PropertyCategory.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,UAAU;IAC9C,SAAyB,cAAc,EAAG,cAAc,CAAC,gBAAgB,CAAC;IAC1E,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC;IAE5B,IAAW,QAAQ,WAA6B;gBAEpC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAMxC;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,qBAAqB;IAMjH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlD,YAAY,CAAC,qBAAqB,EAAE,qBAAqB;IAKnD,QAAQ,CAAC,qBAAqB,EAAE,qBAAqB;IAG3E;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM;CAGvC;AAED;;;GAGG;AACH,8BAAsB,uBAAwB,SAAQ,gBAAgB;aAC3C,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;aACnC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"PropertyCategory.d.ts","sourceRoot":"","sources":["../../../src/Metadata/PropertyCategory.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,UAAU;IAC9C,SAAyB,cAAc,iBAAmC;IAC1E,gBAAgB;IAChB,WAA2B,cAAc,mBAA8C;IACvF,OAAO,CAAC,SAAS,CAAS;IAE1B,IAAW,QAAQ,WAElB;IAED,gBAAgB;gBACJ,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAKxC;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,qBAAqB;IAMjH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAMlD,YAAY,CAAC,qBAAqB,EAAE,qBAAqB;IAKnD,QAAQ,CAAC,qBAAqB,EAAE,qBAAqB;IAG3E;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM;IAItC;;;;OAIG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,gBAAgB;IAO7E;;;;;OAKG;WACW,wBAAwB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,gBAAgB;CAI5F;AAED;;;GAGG;AACH,8BAAsB,uBAAwB,SAAQ,gBAAgB;aAC3C,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;aACnC,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/cjs/Metadata/PropertyCategory.js

@@ -9,15 +9,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MutablePropertyCategory = exports.PropertyCategory = void 0;
 const ECObjects_1 = require("../ECObjects");
+const Exception_1 = require("../Exception");
 const SchemaItem_1 = require("./SchemaItem");
 /**
- * @beta
+ * @public @preview
  */
 class PropertyCategory extends SchemaItem_1.SchemaItem {
-    get priority() { return this._priority; }
+    schemaItemType = PropertyCategory.schemaItemType;
+    /** @internal */
+    static get schemaItemType() { return ECObjects_1.SchemaItemType.PropertyCategory; }
+    _priority;
+    get priority() {
+        return this._priority;
+    }
+    /** @internal */
     constructor(schema, name) {
         super(schema, name);
-        this.schemaItemType = ECObjects_1.SchemaItemType.PropertyCategory;
         this._priority = 0;
     }
     /**
@@ -44,12 +51,32 @@ class PropertyCategory extends SchemaItem_1.SchemaItem {
         this.fromJSONSync(propertyCategoryProps);
     }
     /**
-     * @alpha
      * Used for schema editing.
+     * @internal
      */
     setPriority(priority) {
         this._priority = priority;
     }
+    /**
+     * Type guard to check if the SchemaItem is of type PropertyCategory.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a PropertyCategory, false otherwise.
+     */
+    static isPropertyCategory(item) {
+        if (item && item.schemaItemType === ECObjects_1.SchemaItemType.PropertyCategory)
+            return true;
+        return false;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type PropertyCategory.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to PropertyCategory if it is a PropertyCategory, undefined otherwise.
+     * @internal
+     */
+    static assertIsPropertyCategory(item) {
+        if (!this.isPropertyCategory(item))
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.PropertyCategory}' (PropertyCategory)`);
+    }
 }
 exports.PropertyCategory = PropertyCategory;
 /**

package/lib/cjs/Metadata/PropertyCategory.js.map

@@ -1 +1 @@
-{"version":3,"file":"PropertyCategory.js","sourceRoot":"","sources":["../../../src/Metadata/PropertyCategory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,4CAA8C;AAE9C,6CAA0C;AAE1C;;GAEG;AACH,MAAa,gBAAiB,SAAQ,uBAAU;IAI9C,IAAW,QAAQ,KAAK,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhD,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,cAAc,GAAG,0BAAc,CAAC,gBAAgB,CAAC;QACtD,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC/D,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,qBAA4C;QACvE,KAAK,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,qBAAqB,CAAC,QAAQ,CAAC;IAClD,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,qBAA4C;QACzE,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;IAC3C,CAAC;IACD;;;OAGG;IACO,WAAW,CAAC,QAAgB;QACpC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;CACF;AA7CD,4CA6CC;AAED;;;GAGG;AACH,MAAsB,uBAAwB,SAAQ,gBAAgB;CAGrE;AAHD,0DAGC","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 Metadata\r\n */\r\n\r\nimport { PropertyCategoryProps } from \"../Deserialization/JsonProps\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\n\r\n/**\r\n * @beta\r\n */\r\nexport class PropertyCategory extends SchemaItem {\r\n  public override readonly schemaItemType!: SchemaItemType.PropertyCategory;\r\n  protected _priority: number;\r\n\r\n  public get priority() { return this._priority; }\r\n\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this.schemaItemType = SchemaItemType.PropertyCategory;\r\n    this._priority = 0;\r\n  }\r\n\r\n  /**\r\n   * Save this PropertyCategory's properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): PropertyCategoryProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.priority = this.priority;\r\n    return schemaJson;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n    itemElement.setAttribute(\"priority\", this.priority.toString());\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(propertyCategoryProps: PropertyCategoryProps) {\r\n    super.fromJSONSync(propertyCategoryProps);\r\n    this._priority = propertyCategoryProps.priority;\r\n  }\r\n\r\n  public override async fromJSON(propertyCategoryProps: PropertyCategoryProps) {\r\n    this.fromJSONSync(propertyCategoryProps);\r\n  }\r\n  /**\r\n   * @alpha\r\n   * Used for schema editing.\r\n   */\r\n  protected setPriority(priority: number) {\r\n    this._priority = priority;\r\n  }\r\n}\r\n\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutablePropertyCategory extends PropertyCategory {\r\n  public abstract override setPriority(priority: number): void;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}
+{"version":3,"file":"PropertyCategory.js","sourceRoot":"","sources":["../../../src/Metadata/PropertyCategory.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,4CAA8C;AAC9C,4CAA6D;AAE7D,6CAA0C;AAE1C;;GAEG;AACH,MAAa,gBAAiB,SAAQ,uBAAU;IACrB,cAAc,GAAG,gBAAgB,CAAC,cAAc,CAAC;IAC1E,gBAAgB;IACT,MAAM,KAAc,cAAc,KAAK,OAAO,0BAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC/E,SAAS,CAAS;IAE1B,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,gBAAgB;IAChB,YAAY,MAAc,EAAE,IAAY;QACtC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,aAAsB,KAAK,EAAE,uBAAgC,KAAK;QACvF,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,oBAAoB,CAAQ,CAAC;QACzE,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACpC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,gBAAgB;IACA,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7C,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACjD,WAAW,CAAC,YAAY,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC/D,OAAO,WAAW,CAAC;IACrB,CAAC;IAEe,YAAY,CAAC,qBAA4C;QACvE,KAAK,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,qBAAqB,CAAC,QAAQ,CAAC;IAClD,CAAC;IAEe,KAAK,CAAC,QAAQ,CAAC,qBAA4C;QACzE,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC;IAC3C,CAAC;IACD;;;OAGG;IACO,WAAW,CAAC,QAAgB;QACpC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAiB;QAChD,IAAI,IAAI,IAAI,IAAI,CAAC,cAAc,KAAK,0BAAc,CAAC,gBAAgB;YACjE,OAAO,IAAI,CAAC;QAEd,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,wBAAwB,CAAC,IAAiB;QACtD,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC;YAChC,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,qBAAqB,EAAE,aAAa,0BAAc,CAAC,gBAAgB,sBAAsB,CAAC,CAAC;IACtI,CAAC;CACF;AAxED,4CAwEC;AAED;;;GAGG;AACH,MAAsB,uBAAwB,SAAQ,gBAAgB;CAGrE;AAHD,0DAGC","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 Metadata\r\n */\r\n\r\nimport { PropertyCategoryProps } from \"../Deserialization/JsonProps\";\r\nimport { SchemaItemType } from \"../ECObjects\";\r\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\r\nimport { Schema } from \"./Schema\";\r\nimport { SchemaItem } from \"./SchemaItem\";\r\n\r\n/**\r\n * @public @preview\r\n */\r\nexport class PropertyCategory extends SchemaItem {\r\n  public override readonly schemaItemType = PropertyCategory.schemaItemType;\r\n  /** @internal */\r\n  public static override get schemaItemType() { return SchemaItemType.PropertyCategory; }\r\n  private _priority: number;\r\n\r\n  public get priority() {\r\n    return this._priority;\r\n  }\r\n\r\n  /** @internal */\r\n  constructor(schema: Schema, name: string) {\r\n    super(schema, name);\r\n    this._priority = 0;\r\n  }\r\n\r\n  /**\r\n   * Save this PropertyCategory's properties to an object for serializing to JSON.\r\n   * @param standalone Serialization includes only this object (as opposed to the full schema).\r\n   * @param includeSchemaVersion Include the Schema's version information in the serialized object.\r\n   */\r\n  public override toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): PropertyCategoryProps {\r\n    const schemaJson = super.toJSON(standalone, includeSchemaVersion) as any;\r\n    schemaJson.priority = this.priority;\r\n    return schemaJson;\r\n  }\r\n\r\n  /** @internal */\r\n  public override async toXml(schemaXml: Document): Promise<Element> {\r\n    const itemElement = await super.toXml(schemaXml);\r\n    itemElement.setAttribute(\"priority\", this.priority.toString());\r\n    return itemElement;\r\n  }\r\n\r\n  public override fromJSONSync(propertyCategoryProps: PropertyCategoryProps) {\r\n    super.fromJSONSync(propertyCategoryProps);\r\n    this._priority = propertyCategoryProps.priority;\r\n  }\r\n\r\n  public override async fromJSON(propertyCategoryProps: PropertyCategoryProps) {\r\n    this.fromJSONSync(propertyCategoryProps);\r\n  }\r\n  /**\r\n   * Used for schema editing.\r\n   * @internal\r\n   */\r\n  protected setPriority(priority: number) {\r\n    this._priority = priority;\r\n  }\r\n\r\n  /**\r\n   * Type guard to check if the SchemaItem is of type PropertyCategory.\r\n   * @param item The SchemaItem to check.\r\n   * @returns True if the item is a PropertyCategory, false otherwise.\r\n   */\r\n  public static isPropertyCategory(item?: SchemaItem): item is PropertyCategory {\r\n    if (item && item.schemaItemType === SchemaItemType.PropertyCategory)\r\n      return true;\r\n\r\n    return false;\r\n  }\r\n\r\n  /**\r\n   * Type assertion to check if the SchemaItem is of type PropertyCategory.\r\n   * @param item The SchemaItem to check.\r\n   * @returns The item cast to PropertyCategory if it is a PropertyCategory, undefined otherwise.\r\n   * @internal\r\n   */\r\n  public static assertIsPropertyCategory(item?: SchemaItem): asserts item is PropertyCategory {\r\n    if (!this.isPropertyCategory(item))\r\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaItemType, `Expected '${SchemaItemType.PropertyCategory}' (PropertyCategory)`);\r\n  }\r\n}\r\n\r\n/**\r\n * @internal\r\n * An abstract class used for schema editing.\r\n */\r\nexport abstract class MutablePropertyCategory extends PropertyCategory {\r\n  public abstract override setPriority(priority: number): void;\r\n  public abstract override setDisplayLabel(displayLabel: string): void;\r\n}\r\n"]}

package/lib/cjs/Metadata/RelationshipClass.d.ts

@@ -6,21 +6,26 @@ import { ECClassModifier, RelationshipEnd, SchemaItemType, StrengthDirection, St
 import { LazyLoadedRelationshipConstraintClass } from "../Interfaces";
 import { ECClass } from "./Class";
 import { CustomAttribute, CustomAttributeContainerProps, CustomAttributeSet } from "./CustomAttribute";
-import { EntityClass } from "./EntityClass";
-import { Mixin } from "./Mixin";
 import { NavigationProperty } from "./Property";
 import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
 /**
  * A Typescript class representation of a ECRelationshipClass.
- * @beta
+ * @public @preview
  */
 export declare class RelationshipClass extends ECClass {
-    readonly schema: Schema;
-    readonly schemaItemType: SchemaItemType.RelationshipClass;
+    readonly schemaItemType: SchemaItemType;
+    /** @internal */
+    static get schemaItemType(): SchemaItemType;
+    /** @internal */
     protected _strength: StrengthType;
+    /** @internal */
     protected _strengthDirection: StrengthDirection;
+    /** @internal */
     protected _source: RelationshipConstraint;
+    /** @internal */
     protected _target: RelationshipConstraint;
+    /** @internal */
     constructor(schema: Schema, name: string, modifier?: ECClassModifier);
     get strength(): StrengthType;
     get strengthDirection(): StrengthDirection;
@@ -31,23 +36,25 @@ export declare class RelationshipClass extends ECClass {
      * @param name
      * @param relationship
      * @param direction
+     * @internal
      */
     protected createNavigationProperty(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): Promise<NavigationProperty>;
+    /** @internal */
     protected createNavigationPropertySync(name: string, relationship: string | RelationshipClass, direction: string | StrengthDirection): NavigationProperty;
     /**
-     * @alpha Used for schema editing.
+     * @internal Used for schema editing.
      */
     protected setStrength(strength: StrengthType): void;
     /**
-     * @alpha Used for schema editing.
+     * @internal Used for schema editing.
      */
     protected setStrengthDirection(direction: StrengthDirection): void;
     /**
-     * @alpha Used for schema editing.
+     * @internal Used for schema editing.
      */
     protected setSourceConstraint(source: RelationshipConstraint): void;
     /**
-     * @alpha Used for schema editing.
+     * @internal Used for schema editing.
      */
     protected setTargetConstraint(target: RelationshipConstraint): void;
     /**
@@ -60,38 +67,47 @@ export declare class RelationshipClass extends ECClass {
     toXml(schemaXml: Document): Promise<Element>;
     fromJSONSync(relationshipClassProps: RelationshipClassProps): void;
     fromJSON(relationshipClassProps: RelationshipClassProps): Promise<void>;
+    /**
+     * Type guard to check if the SchemaItem is of type RelationshipClass.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a RelationshipClass, false otherwise.
+     */
+    static isRelationshipClass(item?: SchemaItem): item is RelationshipClass;
+    /**
+     * Type assertion to check if the SchemaItem is of type RelationshipClass.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to RelationshipClass if it is a RelationshipClass, undefined otherwise.
+     * @internal
+     */
+    static assertIsRelationshipClass(item?: SchemaItem): asserts item is RelationshipClass;
 }
 /**
  * A Typescript class representation of a ECRelationshipConstraint.
- * @beta
+ * @public @preview
  */
 export declare class RelationshipConstraint implements CustomAttributeContainerProps {
-    protected _abstractConstraint?: LazyLoadedRelationshipConstraintClass;
-    protected _relationshipClass: RelationshipClass;
-    protected _relationshipEnd: RelationshipEnd;
-    protected _multiplicity?: RelationshipMultiplicity;
-    protected _polymorphic?: boolean;
-    protected _roleLabel?: string;
-    protected _constraintClasses?: LazyLoadedRelationshipConstraintClass[];
+    private _abstractConstraint?;
+    private _relationshipClass;
+    private _relationshipEnd;
+    private _multiplicity?;
+    private _polymorphic?;
+    private _roleLabel?;
+    private _constraintClasses?;
     private _customAttributes?;
+    /** @internal */
     constructor(relClass: RelationshipClass, relEnd: RelationshipEnd, roleLabel?: string, polymorphic?: boolean);
     get multiplicity(): RelationshipMultiplicity;
-    protected set multiplicity(multiplicity: RelationshipMultiplicity);
     get polymorphic(): boolean;
-    protected set polymorphic(polymorphic: boolean);
     get roleLabel(): string | undefined;
-    protected set roleLabel(roleLabel: string | undefined);
-    get constraintClasses(): LazyLoadedRelationshipConstraintClass[] | undefined;
+    get constraintClasses(): ReadonlyArray<LazyLoadedRelationshipConstraintClass> | undefined;
     get relationshipClass(): RelationshipClass;
     get relationshipEnd(): RelationshipEnd;
-    protected set relationshipEnd(relationshipEnd: RelationshipEnd);
     get customAttributes(): CustomAttributeSet | undefined;
     /** Returns the constraint name, ie. 'RelationshipName.Source/Target' */
     get fullName(): string;
     /** Returns the schema of the RelationshipClass. */
     get schema(): Schema;
     get abstractConstraint(): LazyLoadedRelationshipConstraintClass | undefined;
-    set abstractConstraint(abstractConstraint: LazyLoadedRelationshipConstraintClass | undefined);
     /**
      * True if this RelationshipConstraint is the Source relationship end.
      */
@@ -99,13 +115,16 @@ export declare class RelationshipConstraint implements CustomAttributeContainerP
     /**
      * Adds the provided class as a constraint class to this constraint.
      * @param constraint The class to add as a constraint class.
-     */
-    addClass(constraint: EntityClass | Mixin | RelationshipClass): void;
+     * @internal
+    */
+    addClass(constraint: LazyLoadedRelationshipConstraintClass): void;
     /**
      * Removes the provided class as a constraint class from this constraint.
      * @param constraint The class to add as a constraint class.
+     *
+     * @internal
      */
-    protected removeClass(constraint: EntityClass | Mixin | RelationshipClass): void;
+    protected removeClass(constraint: LazyLoadedRelationshipConstraintClass): void;
     /**
      * Save this RelationshipConstraint's properties to an object for serializing to JSON.
      */
@@ -130,7 +149,18 @@ export declare class RelationshipConstraint implements CustomAttributeContainerP
      * @internal
      */
     static isRelationshipConstraint(object: any): object is RelationshipConstraint;
+    /** @internal */
     protected addCustomAttribute(customAttribute: CustomAttribute): void;
+    /** @internal */
+    protected setRoleLabel(roleLabel: string | undefined): void;
+    /** @internal */
+    protected setRelationshipEnd(relationshipEnd: RelationshipEnd): void;
+    /** @internal */
+    protected setPolymorphic(polymorphic: boolean): void;
+    /** @internal */
+    protected setMultiplicity(multiplicity: RelationshipMultiplicity): void;
+    /** @internal */
+    protected setAbstractConstraint(abstractConstraint: LazyLoadedRelationshipConstraintClass | undefined): void;
 }
 /**
  * Hackish approach that works like a "friend class" so we can access protected members without making them public.
@@ -138,9 +168,14 @@ export declare class RelationshipConstraint implements CustomAttributeContainerP
  */
 export declare abstract class MutableRelationshipConstraint extends RelationshipConstraint {
     abstract addCustomAttribute(customAttribute: CustomAttribute): void;
+    abstract setRoleLabel(roleLabel: string | undefined): void;
+    abstract setRelationshipEnd(relationshipEnd: RelationshipEnd): void;
+    abstract setPolymorphic(polymorphic: boolean): void;
+    abstract setMultiplicity(multiplicity: RelationshipMultiplicity): void;
+    abstract setAbstractConstraint(abstractConstraint: LazyLoadedRelationshipConstraintClass | undefined): void;
 }
 /**
- * @beta
+ * @public @preview
  */
 export declare class RelationshipMultiplicity {
     static readonly zeroOne: RelationshipMultiplicity;
@@ -149,6 +184,7 @@ export declare class RelationshipMultiplicity {
     static readonly oneMany: RelationshipMultiplicity;
     readonly lowerLimit: number;
     readonly upperLimit: number;
+    /** @internal */
     constructor(lowerLimit: number, upperLimit: number);
     static fromString(str: string): RelationshipMultiplicity | undefined;
     equals(rhs: RelationshipMultiplicity): boolean;

package/lib/cjs/Metadata/RelationshipClass.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RelationshipClass.d.ts","sourceRoot":"","sources":["../../../src/Metadata/RelationshipClass.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,MAAM,8BAA8B,CAAC;AAEnG,OAAO,EACL,eAAe,EAAyC,eAAe,EAAE,cAAc,EAAE,iBAAiB,EACxF,YAAY,EAC/B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,qCAAqC,EAAE,MAAM,eAAe,CAAC;AAEtE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,6BAA6B,EAAE,kBAAkB,EAA6B,MAAM,mBAAmB,CAAC;AAClI,OAAO,EAA0D,WAAW,EAAE,MAAM,eAAe,CAAC;AACpG,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAKlC;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,OAAO;IAC5C,SAAyB,MAAM,EAAG,MAAM,CAAC;IACzC,SAAyB,cAAc,EAAG,cAAc,CAAC,iBAAiB,CAAC;IAC3E,SAAS,CAAC,SAAS,EAAE,YAAY,CAAC;IAClC,SAAS,CAAC,kBAAkB,EAAE,iBAAiB,CAAC;IAChD,SAAS,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAC1C,SAAS,CAAC,OAAO,EAAE,sBAAsB,CAAC;gBAE9B,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe;IASpE,IAAW,QAAQ,iBAA6B;IAChD,IAAW,iBAAiB,sBAAsC;IAClE,IAAW,MAAM,2BAA2B;IAC5C,IAAW,MAAM,2BAA2B;IAE5C;;;;;OAKG;cACa,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIpK,SAAS,CAAC,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;IAIzJ;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY;IAI5C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,iBAAiB;IAI3D;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,sBAAsB;IAI5D;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,sBAAsB;IAG5D;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,sBAAsB;IASlH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IASlD,YAAY,CAAC,sBAAsB,EAAE,sBAAsB;IAmBrD,QAAQ,CAAC,sBAAsB,EAAE,sBAAsB;CAG9E;AAED;;;GAGG;AACH,qBAAa,sBAAuB,YAAW,6BAA6B;IAC1E,SAAS,CAAC,mBAAmB,CAAC,EAAE,qCAAqC,CAAC;IACtE,SAAS,CAAC,kBAAkB,EAAE,iBAAiB,CAAC;IAChD,SAAS,CAAC,gBAAgB,EAAE,eAAe,CAAC;IAC5C,SAAS,CAAC,aAAa,CAAC,EAAE,wBAAwB,CAAC;IACnD,SAAS,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IACjC,SAAS,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC9B,SAAS,CAAC,kBAAkB,CAAC,EAAE,qCAAqC,EAAE,CAAC;IACvE,OAAO,CAAC,iBAAiB,CAAC,CAA+B;gBAE7C,QAAQ,EAAE,iBAAiB,EAAE,MAAM,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO;IAY3G,IAAW,YAAY,IACkB,wBAAwB,CAD2B;IAC5F,SAAS,KAAK,YAAY,CAAC,YAAY,EAAE,wBAAwB,EAEhE;IAED,IAAW,WAAW,IACiB,OAAO,CADiB;IAC/D,SAAS,KAAK,WAAW,CAAC,WAAW,EAAE,OAAO,EAE7C;IAED,IAAW,SAAS,IACe,MAAM,GAAG,SAAS,CADH;IAClD,SAAS,KAAK,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,EAEpD;IAED,IAAW,iBAAiB,IAAI,qCAAqC,EAAE,GAAG,SAAS,CAAoC;IAEvH,IAAW,iBAAiB,sBAAsC;IAElE,IAAW,eAAe,IACqB,eAAe,CADA;IAC9D,SAAS,KAAK,eAAe,CAAC,eAAe,EAAE,eAAe,EAE7D;IAED,IAAW,gBAAgB,IAAI,kBAAkB,GAAG,SAAS,CAAmC;IAEhG,wEAAwE;IACxE,IAAW,QAAQ,WAAuF;IAE1G,mDAAmD;IACnD,IAAW,MAAM,IAAI,MAAM,CAA2C;IAEtE,IAAW,kBAAkB,IAAI,qCAAqC,GAAG,SAAS,CAQjF;IAED,IAAW,kBAAkB,CAAC,kBAAkB,EAAE,qCAAqC,GAAG,SAAS,EAElG;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,OAAO,CAA4D;IAE1F;;;OAGG;IACI,QAAQ,CAAC,UAAU,EAAE,WAAW,GAAG,KAAK,GAAG,iBAAiB,GAAG,IAAI;IAW1E;;;OAGG;IACH,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,WAAW,GAAG,KAAK,GAAG,iBAAiB,GAAG,IAAI;IAYhF;;OAEG;IACI,MAAM,IAAI,2BAA2B;IAgB5C,gBAAgB;IACH,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAsClD,YAAY,CAAC,2BAA2B,EAAE,2BAA2B;IAuC/D,QAAQ,CAAC,2BAA2B,EAAE,2BAA2B;IAI9E;;;OAGG;IACU,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IA4B9D;;;;;OAKG;WACiB,6BAA6B,CAAC,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBzI;;OAEG;WACW,wBAAwB,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,sBAAsB;IAOrF,SAAS,CAAC,kBAAkB,CAAC,eAAe,EAAE,eAAe;CAO9D;AAED;;;GAGG;AACH,8BAAsB,6BAA8B,SAAQ,sBAAsB;aACvD,kBAAkB,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;CAEpF;AAID;;GAEG;AACH,qBAAa,wBAAwB;IACnC,gBAAuB,OAAO,2BAAsC;IACpE,gBAAuB,QAAQ,2BAA8C;IAC7E,gBAAuB,MAAM,2BAAsC;IACnE,gBAAuB,OAAO,2BAA8C;IAE5E,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,SAAgB,UAAU,EAAE,MAAM,CAAC;gBAEvB,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;WAKpC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,GAAG,SAAS;IAmBpE,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO;IAI9C,QAAQ,IAAI,MAAM;CAG1B;AAED;;;GAGG;AACH,8BAAsB,wBAAyB,SAAQ,iBAAiB;IACtE,IAAoB,MAAM,IAA4B,6BAA6B,CAAG;IACtF,IAAoB,MAAM,IAA4B,6BAA6B,CAAG;aAC7D,WAAW,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;aACzC,oBAAoB,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;aACxD,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;aACpJ,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;aAC/I,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}
+{"version":3,"file":"RelationshipClass.d.ts","sourceRoot":"","sources":["../../../src/Metadata/RelationshipClass.ts"],"names":[],"mappings":"AAIA;;GAEG;AAIH,OAAO,EAAE,sBAAsB,EAAE,2BAA2B,EAAE,MAAM,8BAA8B,CAAC;AAEnG,OAAO,EACL,eAAe,EAAyC,eAAe,EAAE,cAAc,EAAE,iBAAiB,EACxF,YAAY,EAC/B,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,qCAAqC,EAAE,MAAM,eAAe,CAAC;AAEtE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,6BAA6B,EAAE,kBAAkB,EAA6B,MAAM,mBAAmB,CAAC;AAGlI,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAI1C;;;GAGG;AACH,qBAAa,iBAAkB,SAAQ,OAAO;IAC5C,SAAyB,cAAc,iBAAoC;IAC3E,gBAAgB;IAChB,WAA2B,cAAc,mBAA+C;IACxF,gBAAgB;IAChB,SAAS,CAAC,SAAS,EAAE,YAAY,CAAC;IAClC,gBAAgB;IAChB,SAAS,CAAC,kBAAkB,EAAE,iBAAiB,CAAC;IAChD,gBAAgB;IAChB,SAAS,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAC1C,gBAAgB;IAChB,SAAS,CAAC,OAAO,EAAE,sBAAsB,CAAC;IAE1C,gBAAgB;gBACJ,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe;IAQpE,IAAW,QAAQ,iBAA6B;IAChD,IAAW,iBAAiB,sBAAsC;IAClE,IAAW,MAAM,2BAA2B;IAC5C,IAAW,MAAM,2BAA2B;IAE5C;;;;;;OAMG;cACa,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAIpK,gBAAgB;IAChB,SAAS,CAAC,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;IAIzJ;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,YAAY;IAI5C;;OAEG;IACH,SAAS,CAAC,oBAAoB,CAAC,SAAS,EAAE,iBAAiB;IAI3D;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,sBAAsB;IAI5D;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,MAAM,EAAE,sBAAsB;IAG5D;;;;OAIG;IACa,MAAM,CAAC,UAAU,GAAE,OAAe,EAAE,oBAAoB,GAAE,OAAe,GAAG,sBAAsB;IASlH,gBAAgB;IACM,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IASlD,YAAY,CAAC,sBAAsB,EAAE,sBAAsB;IAmBrD,QAAQ,CAAC,sBAAsB,EAAE,sBAAsB;IAI7E;;;;OAIG;WACW,mBAAmB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,IAAI,IAAI,iBAAiB;IAO/E;;;;;OAKG;WACW,yBAAyB,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,IAAI,iBAAiB;CAI9F;AAED;;;GAGG;AACH,qBAAa,sBAAuB,YAAW,6BAA6B;IAC1E,OAAO,CAAC,mBAAmB,CAAC,CAAwC;IACpE,OAAO,CAAC,kBAAkB,CAAoB;IAC9C,OAAO,CAAC,gBAAgB,CAAkB;IAC1C,OAAO,CAAC,aAAa,CAAC,CAA2B;IACjD,OAAO,CAAC,YAAY,CAAC,CAAU;IAC/B,OAAO,CAAC,UAAU,CAAC,CAAS;IAC5B,OAAO,CAAC,kBAAkB,CAAC,CAA0C;IACrE,OAAO,CAAC,iBAAiB,CAAC,CAA+B;IAEzD,gBAAgB;gBACJ,QAAQ,EAAE,iBAAiB,EAAE,MAAM,EAAE,eAAe,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO;IAY3G,IAAW,YAAY,6BAAqE;IAE5F,IAAW,WAAW,YAAyC;IAE/D,IAAW,SAAS,uBAA8B;IAElD,IAAW,iBAAiB,IAAI,aAAa,CAAC,qCAAqC,CAAC,GAAG,SAAS,CAAoC;IAEpI,IAAW,iBAAiB,sBAAsC;IAElE,IAAW,eAAe,oBAAoC;IAE9D,IAAW,gBAAgB,IAAI,kBAAkB,GAAG,SAAS,CAAmC;IAEhG,wEAAwE;IACxE,IAAW,QAAQ,WAAuF;IAE1G,mDAAmD;IACnD,IAAW,MAAM,IAAI,MAAM,CAA2C;IAEtE,IAAW,kBAAkB,IAAI,qCAAqC,GAAG,SAAS,CAQjF;IAED;;OAEG;IACH,IAAW,QAAQ,IAAI,OAAO,CAA4D;IAE1F;;;;MAIE;IACK,QAAQ,CAAC,UAAU,EAAE,qCAAqC,GAAG,IAAI;IAWxE;;;;;OAKG;IACH,SAAS,CAAC,WAAW,CAAC,UAAU,EAAE,qCAAqC,GAAG,IAAI;IAY9E;;OAEG;IACI,MAAM,IAAI,2BAA2B;IAgB5C,gBAAgB;IACH,KAAK,CAAC,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC;IAsClD,YAAY,CAAC,2BAA2B,EAAE,2BAA2B;IAyC/D,QAAQ,CAAC,2BAA2B,EAAE,2BAA2B;IAI9E;;;OAGG;IACU,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IA4B9D;;;;;OAKG;WACiB,6BAA6B,CAAC,eAAe,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAmBzI;;OAEG;WACW,wBAAwB,CAAC,MAAM,EAAE,GAAG,GAAG,MAAM,IAAI,sBAAsB;IAOrF,gBAAgB;IAChB,SAAS,CAAC,kBAAkB,CAAC,eAAe,EAAE,eAAe;IAO7D,gBAAgB;IAChB,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS;IAIpD,gBAAgB;IAChB,SAAS,CAAC,kBAAkB,CAAC,eAAe,EAAE,eAAe;IAI7D,gBAAgB;IAChB,SAAS,CAAC,cAAc,CAAC,WAAW,EAAE,OAAO;IAI7C,gBAAgB;IAChB,SAAS,CAAC,eAAe,CAAC,YAAY,EAAE,wBAAwB;IAIhE,gBAAgB;IAChB,SAAS,CAAC,qBAAqB,CAAC,kBAAkB,EAAE,qCAAqC,GAAG,SAAS;CAGtG;AAED;;;GAGG;AACH,8BAAsB,6BAA8B,SAAQ,sBAAsB;aACvD,kBAAkB,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;aAC1D,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;aACjD,kBAAkB,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;aAC1D,cAAc,CAAC,WAAW,EAAE,OAAO,GAAG,IAAI;aAC1C,eAAe,CAAC,YAAY,EAAE,wBAAwB,GAAG,IAAI;aAC7D,qBAAqB,CAAC,kBAAkB,EAAE,qCAAqC,GAAG,SAAS,GAAG,IAAI;CAC5H;AAID;;GAEG;AACH,qBAAa,wBAAwB;IACnC,gBAAuB,OAAO,2BAAsC;IACpE,gBAAuB,QAAQ,2BAA8C;IAC7E,gBAAuB,MAAM,2BAAsC;IACnE,gBAAuB,OAAO,2BAA8C;IAE5E,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,SAAgB,UAAU,EAAE,MAAM,CAAC;IAEnC,gBAAgB;gBACJ,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;WAKpC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,GAAG,SAAS;IAmBpE,MAAM,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO;IAI9C,QAAQ,IAAI,MAAM;CAG1B;AAED;;;GAGG;AACH,8BAAsB,wBAAyB,SAAQ,iBAAiB;IACtE,IAAoB,MAAM,IAA4B,6BAA6B,CAAG;IACtF,IAAoB,MAAM,IAA4B,6BAA6B,CAAG;aAC7D,WAAW,CAAC,QAAQ,EAAE,YAAY,GAAG,IAAI;aACzC,oBAAoB,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;aACxD,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC;aACpJ,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,iBAAiB,EAAE,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,kBAAkB;aAC/I,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;CACrE"}

package/lib/cjs/Metadata/RelationshipClass.js

@@ -16,15 +16,27 @@ const Exception_1 = require("../Exception");
 const Class_1 = require("./Class");
 const CustomAttribute_1 = require("./CustomAttribute");
 const EntityClass_1 = require("./EntityClass");
+const Mixin_1 = require("./Mixin");
 const SchemaItem_1 = require("./SchemaItem");
 /**
  * A Typescript class representation of a ECRelationshipClass.
- * @beta
+ * @public @preview
  */
 class RelationshipClass extends Class_1.ECClass {
+    schemaItemType = RelationshipClass.schemaItemType;
+    /** @internal */
+    static get schemaItemType() { return ECObjects_1.SchemaItemType.RelationshipClass; }
+    /** @internal */
+    _strength;
+    /** @internal */
+    _strengthDirection;
+    /** @internal */
+    _source;
+    /** @internal */
+    _target;
+    /** @internal */
     constructor(schema, name, modifier) {
         super(schema, name, modifier);
-        this.schemaItemType = ECObjects_1.SchemaItemType.RelationshipClass;
         this._strengthDirection = ECObjects_1.StrengthDirection.Forward;
         this._strength = ECObjects_1.StrengthType.Referencing;
         this._source = new RelationshipConstraint(this, ECObjects_1.RelationshipEnd.Source);
@@ -39,33 +51,35 @@ class RelationshipClass extends Class_1.ECClass {
      * @param name
      * @param relationship
      * @param direction
+     * @internal
      */
     async createNavigationProperty(name, relationship, direction) {
         return this.addProperty(await (0, EntityClass_1.createNavigationProperty)(this, name, relationship, direction));
     }
+    /** @internal */
     createNavigationPropertySync(name, relationship, direction) {
         return this.addProperty((0, EntityClass_1.createNavigationPropertySync)(this, name, relationship, direction));
     }
     /**
-     * @alpha Used for schema editing.
+     * @internal Used for schema editing.
      */
     setStrength(strength) {
         this._strength = strength;
     }
     /**
-     * @alpha Used for schema editing.
+     * @internal Used for schema editing.
      */
     setStrengthDirection(direction) {
         this._strengthDirection = direction;
     }
     /**
-     * @alpha Used for schema editing.
+     * @internal Used for schema editing.
      */
     setSourceConstraint(source) {
         this._source = source;
     }
     /**
-     * @alpha Used for schema editing.
+     * @internal Used for schema editing.
      */
     setTargetConstraint(target) {
         this._target = target;
@@ -99,24 +113,53 @@ class RelationshipClass extends Class_1.ECClass {
             if (Helper_1.SchemaReadHelper.isECSpecVersionNewer({ readVersion: relationshipClassProps.originalECSpecMajorVersion, writeVersion: relationshipClassProps.originalECSpecMinorVersion }))
                 strength = ECObjects_1.StrengthType.Referencing;
             else
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidStrength, `The RelationshipClass ${this.fullName} has an invalid 'strength' attribute. '${relationshipClassProps.strength}' is not a valid StrengthType.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidStrength, `The RelationshipClass ${this.fullName} has an invalid 'strength' attribute. '${relationshipClassProps.strength}' is not a valid StrengthType.`);
         }
         const strengthDirection = (0, ECObjects_1.parseStrengthDirection)(relationshipClassProps.strengthDirection);
         if (undefined === strengthDirection)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidStrength, `The RelationshipClass ${this.fullName} has an invalid 'strengthDirection' attribute. '${relationshipClassProps.strengthDirection}' is not a valid StrengthDirection.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidStrength, `The RelationshipClass ${this.fullName} has an invalid 'strengthDirection' attribute. '${relationshipClassProps.strengthDirection}' is not a valid StrengthDirection.`);
         this._strength = strength;
         this._strengthDirection = strengthDirection;
     }
     async fromJSON(relationshipClassProps) {
         this.fromJSONSync(relationshipClassProps);
     }
+    /**
+     * Type guard to check if the SchemaItem is of type RelationshipClass.
+     * @param item The SchemaItem to check.
+     * @returns True if the item is a RelationshipClass, false otherwise.
+     */
+    static isRelationshipClass(item) {
+        if (item && item.schemaItemType === ECObjects_1.SchemaItemType.RelationshipClass)
+            return true;
+        return false;
+    }
+    /**
+     * Type assertion to check if the SchemaItem is of type RelationshipClass.
+     * @param item The SchemaItem to check.
+     * @returns The item cast to RelationshipClass if it is a RelationshipClass, undefined otherwise.
+     * @internal
+     */
+    static assertIsRelationshipClass(item) {
+        if (!this.isRelationshipClass(item))
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, `Expected '${ECObjects_1.SchemaItemType.RelationshipClass}' (RelationshipClass)`);
+    }
 }
 exports.RelationshipClass = RelationshipClass;
 /**
  * A Typescript class representation of a ECRelationshipConstraint.
- * @beta
+ * @public @preview
  */
 class RelationshipConstraint {
+    _abstractConstraint;
+    _relationshipClass;
+    _relationshipEnd;
+    _multiplicity;
+    _polymorphic;
+    _roleLabel;
+    _constraintClasses;
+    _customAttributes;
+    /** @internal */
     constructor(relClass, relEnd, roleLabel, polymorphic) {
         this._relationshipEnd = relEnd;
         if (polymorphic)
@@ -128,23 +171,11 @@ class RelationshipConstraint {
         this._roleLabel = roleLabel;
     }
     get multiplicity() { return this._multiplicity ?? RelationshipMultiplicity.zeroOne; }
-    set multiplicity(multiplicity) {
-        this._multiplicity = multiplicity;
-    }
     get polymorphic() { return this._polymorphic ?? false; }
-    set polymorphic(polymorphic) {
-        this._polymorphic = polymorphic;
-    }
     get roleLabel() { return this._roleLabel; }
-    set roleLabel(roleLabel) {
-        this._roleLabel = roleLabel;
-    }
     get constraintClasses() { return this._constraintClasses; }
     get relationshipClass() { return this._relationshipClass; }
     get relationshipEnd() { return this._relationshipEnd; }
-    set relationshipEnd(relationshipEnd) {
-        this._relationshipEnd = relationshipEnd;
-    }
     get customAttributes() { return this._customAttributes; }
     /** Returns the constraint name, ie. 'RelationshipName.Source/Target' */
     get fullName() { return `${this._relationshipClass.name}:${this.isSource ? "Source" : "Target"}`; }
@@ -157,9 +188,6 @@ class RelationshipConstraint {
             return this.constraintClasses[0];
         return this._abstractConstraint;
     }
-    set abstractConstraint(abstractConstraint) {
-        this._abstractConstraint = abstractConstraint;
-    }
     /**
      * True if this RelationshipConstraint is the Source relationship end.
      */
@@ -167,18 +195,21 @@ class RelationshipConstraint {
     /**
      * Adds the provided class as a constraint class to this constraint.
      * @param constraint The class to add as a constraint class.
-     */
+     * @internal
+    */
     addClass(constraint) {
         // TODO: Ensure we don't start mixing constraint class types
         // TODO: Check that this class is or subclasses abstract constraint?
         if (!this._constraintClasses)
             this._constraintClasses = [];
         // TODO: Handle relationship constraints
-        this._constraintClasses.push(new DelayedPromise_1.DelayedPromiseWithProps(constraint.key, async () => constraint));
+        this._constraintClasses.push(constraint);
     }
     /**
      * Removes the provided class as a constraint class from this constraint.
      * @param constraint The class to add as a constraint class.
+     *
+     * @internal
      */
     removeClass(constraint) {
         if (undefined === this._constraintClasses)
@@ -246,29 +277,31 @@ class RelationshipConstraint {
         this._polymorphic = relationshipConstraintProps.polymorphic;
         const parsedMultiplicity = RelationshipMultiplicity.fromString(relationshipConstraintProps.multiplicity);
         if (!parsedMultiplicity)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidMultiplicity, ``);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidMultiplicity, ``);
         this._multiplicity = parsedMultiplicity;
         const relClassSchema = this.relationshipClass.schema;
         if (undefined !== relationshipConstraintProps.abstractConstraint) {
             const abstractConstraintSchemaItemKey = relClassSchema.getSchemaItemKey(relationshipConstraintProps.abstractConstraint);
             if (!abstractConstraintSchemaItemKey)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the abstractConstraint ${relationshipConstraintProps.abstractConstraint}.`);
-            this.abstractConstraint = new DelayedPromise_1.DelayedPromiseWithProps(abstractConstraintSchemaItemKey, async () => {
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate the abstractConstraint ${relationshipConstraintProps.abstractConstraint}.`);
+            this.setAbstractConstraint(new DelayedPromise_1.DelayedPromiseWithProps(abstractConstraintSchemaItemKey, async () => {
                 const tempAbstractConstraint = await relClassSchema.lookupItem(relationshipConstraintProps.abstractConstraint);
-                if (undefined === tempAbstractConstraint)
-                    throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, `Unable to locate the abstractConstraint ${relationshipConstraintProps.abstractConstraint}.`);
+                if (undefined === tempAbstractConstraint ||
+                    (!EntityClass_1.EntityClass.isEntityClass(tempAbstractConstraint) && !Mixin_1.Mixin.isMixin(tempAbstractConstraint) && !RelationshipClass.isRelationshipClass(tempAbstractConstraint)))
+                    throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, `Unable to locate the abstractConstraint ${relationshipConstraintProps.abstractConstraint}.`);
                 return tempAbstractConstraint;
-            });
+            }));
         }
         const loadEachConstraint = (constraintClassName) => {
             const tempConstraintClass = relClassSchema.lookupItemSync(constraintClassName);
-            if (!tempConstraintClass)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECJson, ``);
+            if (!tempConstraintClass ||
+                (!EntityClass_1.EntityClass.isEntityClass(tempConstraintClass) && !Mixin_1.Mixin.isMixin(tempConstraintClass) && !RelationshipClass.isRelationshipClass(tempConstraintClass)))
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECJson, ``);
             return tempConstraintClass;
         };
         for (const constraintClassName of relationshipConstraintProps.constraintClasses) {
             const constraintClass = loadEachConstraint(constraintClassName);
-            this.addClass(constraintClass);
+            this.addClass(new DelayedPromise_1.DelayedPromiseWithProps(constraintClass.key, async () => constraintClass));
         }
     }
     async fromJSON(relationshipConstraintProps) {
@@ -326,15 +359,36 @@ class RelationshipConstraint {
      * @internal
      */
     static isRelationshipConstraint(object) {
-        const relationshipConstrait = object;
-        return relationshipConstrait !== undefined && relationshipConstrait.polymorphic !== undefined && relationshipConstrait.multiplicity !== undefined
-            && relationshipConstrait.relationshipEnd !== undefined && relationshipConstrait._relationshipClass !== undefined;
+        const relationshipConstraint = object;
+        return relationshipConstraint !== undefined && relationshipConstraint.polymorphic !== undefined && relationshipConstraint.multiplicity !== undefined
+            && relationshipConstraint.relationshipEnd !== undefined && relationshipConstraint._relationshipClass !== undefined;
     }
+    /** @internal */
     addCustomAttribute(customAttribute) {
         if (!this._customAttributes)
             this._customAttributes = new Map();
         this._customAttributes.set(customAttribute.className, customAttribute);
     }
+    /** @internal */
+    setRoleLabel(roleLabel) {
+        this._roleLabel = roleLabel;
+    }
+    /** @internal */
+    setRelationshipEnd(relationshipEnd) {
+        this._relationshipEnd = relationshipEnd;
+    }
+    /** @internal */
+    setPolymorphic(polymorphic) {
+        this._polymorphic = polymorphic;
+    }
+    /** @internal */
+    setMultiplicity(multiplicity) {
+        this._multiplicity = multiplicity;
+    }
+    /** @internal */
+    setAbstractConstraint(abstractConstraint) {
+        this._abstractConstraint = abstractConstraint;
+    }
 }
 exports.RelationshipConstraint = RelationshipConstraint;
 /**
@@ -346,9 +400,16 @@ class MutableRelationshipConstraint extends RelationshipConstraint {
 exports.MutableRelationshipConstraint = MutableRelationshipConstraint;
 const INT32_MAX = 2147483647;
 /**
- * @beta
+ * @public @preview
  */
 class RelationshipMultiplicity {
+    static zeroOne = new RelationshipMultiplicity(0, 1);
+    static zeroMany = new RelationshipMultiplicity(0, INT32_MAX);
+    static oneOne = new RelationshipMultiplicity(1, 1);
+    static oneMany = new RelationshipMultiplicity(1, INT32_MAX);
+    lowerLimit;
+    upperLimit;
+    /** @internal */
     constructor(lowerLimit, upperLimit) {
         this.lowerLimit = lowerLimit;
         this.upperLimit = upperLimit;
@@ -377,10 +438,6 @@ class RelationshipMultiplicity {
     }
 }
 exports.RelationshipMultiplicity = RelationshipMultiplicity;
-RelationshipMultiplicity.zeroOne = new RelationshipMultiplicity(0, 1);
-RelationshipMultiplicity.zeroMany = new RelationshipMultiplicity(0, INT32_MAX);
-RelationshipMultiplicity.oneOne = new RelationshipMultiplicity(1, 1);
-RelationshipMultiplicity.oneMany = new RelationshipMultiplicity(1, INT32_MAX);
 /**
  * @internal
  * An abstract class used for schema editing.