@itwin/ecschema-metadata 3.5.0-dev.14 → 3.5.0-dev.16

package/lib/cjs/Interfaces.js

@@ -1,10 +1,10 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Metadata
- */
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=Interfaces.js.map

package/lib/cjs/Interfaces.js.map

@@ -1 +1 @@
-{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../src/Interfaces.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Metadata\n */\n\nimport { DelayedPromise } from \"./DelayedPromise\";\nimport { ECClass, StructClass } from \"./Metadata/Class\";\nimport { Constant } from \"./Metadata/Constant\";\nimport { CustomAttribute, CustomAttributeContainerProps } from \"./Metadata/CustomAttribute\";\nimport { CustomAttributeClass } from \"./Metadata/CustomAttributeClass\";\nimport { EntityClass } from \"./Metadata/EntityClass\";\nimport { AnyEnumerator, Enumeration } from \"./Metadata/Enumeration\";\nimport { Format } from \"./Metadata/Format\";\nimport { InvertedUnit } from \"./Metadata/InvertedUnit\";\nimport { KindOfQuantity } from \"./Metadata/KindOfQuantity\";\nimport { Mixin } from \"./Metadata/Mixin\";\nimport { OverrideFormat } from \"./Metadata/OverrideFormat\";\nimport { Phenomenon } from \"./Metadata/Phenomenon\";\nimport { AnyProperty } from \"./Metadata/Property\";\nimport { PropertyCategory } from \"./Metadata/PropertyCategory\";\nimport { RelationshipClass, RelationshipConstraint } from \"./Metadata/RelationshipClass\";\nimport { Schema } from \"./Metadata/Schema\";\nimport { SchemaItem } from \"./Metadata/SchemaItem\";\nimport { Unit } from \"./Metadata/Unit\";\nimport { UnitSystem } from \"./Metadata/UnitSystem\";\nimport { SchemaItemKey, SchemaKey } from \"./SchemaKey\";\n\n/** @beta */\nexport type LazyLoadedSchema = Readonly<SchemaKey> & DelayedPromise<Schema> & Promise<Schema>;\n\n/** @beta */\nexport type LazyLoadedSchemaItem<T extends SchemaItem> = Readonly<SchemaItemKey> & DelayedPromise<T> & Promise<T>;\n/** @beta */\nexport type LazyLoadedECClass = LazyLoadedSchemaItem<ECClass>;\n/** @beta */\nexport type LazyLoadedEntityClass = LazyLoadedSchemaItem<EntityClass>;\n/** @beta */\nexport type LazyLoadedMixin = LazyLoadedSchemaItem<Mixin>;\n/** @beta */\nexport type LazyLoadedStructClass = LazyLoadedSchemaItem<StructClass>;\n/** @beta */\nexport type LazyLoadedCustomAttributeClass = LazyLoadedSchemaItem<CustomAttributeClass>;\n/** @beta */\nexport type LazyLoadedRelationshipClass = LazyLoadedSchemaItem<RelationshipClass>;\n/** @beta */\nexport type LazyLoadedEnumeration = LazyLoadedSchemaItem<Enumeration>;\n/** @beta */\nexport type LazyLoadedKindOfQuantity = LazyLoadedSchemaItem<KindOfQuantity>;\n/** @beta */\nexport type LazyLoadedPropertyCategory = LazyLoadedSchemaItem<PropertyCategory>;\n/** @beta */\nexport type LazyLoadedRelationshipConstraintClass = LazyLoadedSchemaItem<EntityClass | Mixin | RelationshipClass>;\n/** @beta */\nexport type LazyLoadedUnit = LazyLoadedSchemaItem<Unit>;\n/** @beta */\nexport type LazyLoadedInvertedUnit = LazyLoadedSchemaItem<InvertedUnit>;\n/** @beta */\nexport type LazyLoadedConstant = LazyLoadedSchemaItem<Constant>;\n/** @beta */\nexport type LazyLoadedPhenomenon = LazyLoadedSchemaItem<Phenomenon>;\n/** @beta */\nexport type LazyLoadedUnitSystem = LazyLoadedSchemaItem<UnitSystem>;\n/** @beta */\nexport type LazyLoadedFormat = LazyLoadedSchemaItem<Format>;\n\n/** @beta */\nexport type AnyClass = EntityClass | Mixin | StructClass | CustomAttributeClass | RelationshipClass;\n/** @beta */\nexport type AnySchemaItem = AnyClass | Enumeration | KindOfQuantity | PropertyCategory | Unit | InvertedUnit | Constant | Phenomenon | UnitSystem | Format;\n/** @beta */\nexport type AnyECType = Schema | SchemaItem | AnyProperty | RelationshipConstraint | CustomAttributeContainerProps | CustomAttribute | OverrideFormat | AnyEnumerator;\n"]}
+{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../src/Interfaces.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 { DelayedPromise } from \"./DelayedPromise\";\r\nimport { ECClass, StructClass } from \"./Metadata/Class\";\r\nimport { Constant } from \"./Metadata/Constant\";\r\nimport { CustomAttribute, CustomAttributeContainerProps } from \"./Metadata/CustomAttribute\";\r\nimport { CustomAttributeClass } from \"./Metadata/CustomAttributeClass\";\r\nimport { EntityClass } from \"./Metadata/EntityClass\";\r\nimport { AnyEnumerator, Enumeration } from \"./Metadata/Enumeration\";\r\nimport { Format } from \"./Metadata/Format\";\r\nimport { InvertedUnit } from \"./Metadata/InvertedUnit\";\r\nimport { KindOfQuantity } from \"./Metadata/KindOfQuantity\";\r\nimport { Mixin } from \"./Metadata/Mixin\";\r\nimport { OverrideFormat } from \"./Metadata/OverrideFormat\";\r\nimport { Phenomenon } from \"./Metadata/Phenomenon\";\r\nimport { AnyProperty } from \"./Metadata/Property\";\r\nimport { PropertyCategory } from \"./Metadata/PropertyCategory\";\r\nimport { RelationshipClass, RelationshipConstraint } from \"./Metadata/RelationshipClass\";\r\nimport { Schema } from \"./Metadata/Schema\";\r\nimport { SchemaItem } from \"./Metadata/SchemaItem\";\r\nimport { Unit } from \"./Metadata/Unit\";\r\nimport { UnitSystem } from \"./Metadata/UnitSystem\";\r\nimport { SchemaItemKey, SchemaKey } from \"./SchemaKey\";\r\n\r\n/** @beta */\r\nexport type LazyLoadedSchema = Readonly<SchemaKey> & DelayedPromise<Schema> & Promise<Schema>;\r\n\r\n/** @beta */\r\nexport type LazyLoadedSchemaItem<T extends SchemaItem> = Readonly<SchemaItemKey> & DelayedPromise<T> & Promise<T>;\r\n/** @beta */\r\nexport type LazyLoadedECClass = LazyLoadedSchemaItem<ECClass>;\r\n/** @beta */\r\nexport type LazyLoadedEntityClass = LazyLoadedSchemaItem<EntityClass>;\r\n/** @beta */\r\nexport type LazyLoadedMixin = LazyLoadedSchemaItem<Mixin>;\r\n/** @beta */\r\nexport type LazyLoadedStructClass = LazyLoadedSchemaItem<StructClass>;\r\n/** @beta */\r\nexport type LazyLoadedCustomAttributeClass = LazyLoadedSchemaItem<CustomAttributeClass>;\r\n/** @beta */\r\nexport type LazyLoadedRelationshipClass = LazyLoadedSchemaItem<RelationshipClass>;\r\n/** @beta */\r\nexport type LazyLoadedEnumeration = LazyLoadedSchemaItem<Enumeration>;\r\n/** @beta */\r\nexport type LazyLoadedKindOfQuantity = LazyLoadedSchemaItem<KindOfQuantity>;\r\n/** @beta */\r\nexport type LazyLoadedPropertyCategory = LazyLoadedSchemaItem<PropertyCategory>;\r\n/** @beta */\r\nexport type LazyLoadedRelationshipConstraintClass = LazyLoadedSchemaItem<EntityClass | Mixin | RelationshipClass>;\r\n/** @beta */\r\nexport type LazyLoadedUnit = LazyLoadedSchemaItem<Unit>;\r\n/** @beta */\r\nexport type LazyLoadedInvertedUnit = LazyLoadedSchemaItem<InvertedUnit>;\r\n/** @beta */\r\nexport type LazyLoadedConstant = LazyLoadedSchemaItem<Constant>;\r\n/** @beta */\r\nexport type LazyLoadedPhenomenon = LazyLoadedSchemaItem<Phenomenon>;\r\n/** @beta */\r\nexport type LazyLoadedUnitSystem = LazyLoadedSchemaItem<UnitSystem>;\r\n/** @beta */\r\nexport type LazyLoadedFormat = LazyLoadedSchemaItem<Format>;\r\n\r\n/** @beta */\r\nexport type AnyClass = EntityClass | Mixin | StructClass | CustomAttributeClass | RelationshipClass;\r\n/** @beta */\r\nexport type AnySchemaItem = AnyClass | Enumeration | KindOfQuantity | PropertyCategory | Unit | InvertedUnit | Constant | Phenomenon | UnitSystem | Format;\r\n/** @beta */\r\nexport type AnyECType = Schema | SchemaItem | AnyProperty | RelationshipConstraint | CustomAttributeContainerProps | CustomAttribute | OverrideFormat | AnyEnumerator;\r\n"]}

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

@@ -1,244 +1,244 @@
-/** @packageDocumentation
- * @module Metadata
- */
-import { ClassProps } from "../Deserialization/JsonProps";
-import { ECClassModifier, PrimitiveType, SchemaItemType } from "../ECObjects";
-import { AnyClass, LazyLoadedECClass } from "../Interfaces";
-import { CustomAttribute, CustomAttributeContainerProps, CustomAttributeSet } from "./CustomAttribute";
-import { Enumeration } from "./Enumeration";
-import { EnumerationArrayProperty, EnumerationProperty, PrimitiveArrayProperty, PrimitiveProperty, Property, StructArrayProperty, StructProperty } from "./Property";
-import { Schema } from "./Schema";
-import { SchemaItem } from "./SchemaItem";
-/**
- * A common abstract class for all of the ECClass types.
- * @beta
- */
-export declare abstract class ECClass extends SchemaItem implements CustomAttributeContainerProps {
-    protected _modifier: ECClassModifier;
-    protected _baseClass?: LazyLoadedECClass;
-    protected _properties?: Map<string, Property>;
-    private _customAttributes?;
-    private _mergedPropertyCache?;
-    get modifier(): ECClassModifier;
-    get baseClass(): LazyLoadedECClass | undefined;
-    set baseClass(baseClass: LazyLoadedECClass | undefined);
-    get properties(): IterableIterator<Property> | undefined;
-    get customAttributes(): CustomAttributeSet | undefined;
-    constructor(schema: Schema, name: string, modifier?: ECClassModifier);
-    /**
-     * Convenience method for adding an already loaded ECProperty used by create*Property methods.
-     * @param prop The property to add.
-     * @return The property that was added.
-     */
-    protected addProperty<T extends Property>(prop: T): T;
-    /**
-     * Deletes a property from within this class.
-     * @param name The property name to delete, lookup is case-insensitive
-     * @alpha
-     */
-    protected deleteProperty(name: string): Promise<void>;
-    /**
-     * Deletes a property from within this class.
-     * @param name The property name to delete, lookup is case-insensitive
-     * @alpha
-     */
-    protected deletePropertySync(name: string): void;
-    getBaseClassSync(): ECClass | undefined;
-    /**
-     * Searches, case-insensitive, for a local ECProperty with the name provided.
-     * @param name
-     */
-    getProperty(name: string, includeInherited?: boolean): Promise<Property | undefined>;
-    /**
-     * Searches, case-insensitive, for a local ECProperty with the name provided.
-     * @param name
-     */
-    getPropertySync(name: string, includeInherited?: boolean): Property | undefined;
-    /**
-     * Searches the base class, if one exists, for the property with the name provided.
-     * @param name The name of the inherited property to find.
-     */
-    getInheritedProperty(name: string): Promise<Property | undefined>;
-    /**
-     * Searches the base class, if one exists, for the property with the name provided.
-     * @param name The name of the inherited property to find.
-     */
-    getInheritedPropertySync(name: string): Property | undefined;
-    /**
-     * Creates a PrimitiveECProperty.
-     * @param name The name of property to create.
-     * @param primitiveType The primitive type of property to create. If not provided the default is PrimitiveType.Integer
-     * @throws ECObjectsStatus DuplicateProperty: thrown if a property with the same name already exists in the class.
-     */
-    protected createPrimitiveProperty(name: string, primitiveType: PrimitiveType): Promise<PrimitiveProperty>;
-    protected createPrimitiveProperty(name: string, primitiveType: Enumeration): Promise<EnumerationProperty>;
-    /**
-     * Creates a PrimitiveECProperty.
-     * @param name The name of property to create.
-     * @param primitiveType The primitive type of property to create. If not provided the default is PrimitiveType.Integer
-     * @throws ECObjectsStatus DuplicateProperty: thrown if a property with the same name already exists in the class.
-     */
-    protected createPrimitivePropertySync(name: string, primitiveType: PrimitiveType): PrimitiveProperty;
-    protected createPrimitivePropertySync(name: string, primitiveType: Enumeration): EnumerationProperty;
-    /**
-     * Creates a PrimitiveArrayECProperty.
-     * @param name The name of property to create.
-     * @param primitiveType The primitive type of property to create. If not provided the default is PrimitiveType.Integer
-     */
-    protected createPrimitiveArrayProperty(name: string, primitiveType: PrimitiveType): Promise<PrimitiveArrayProperty>;
-    protected createPrimitiveArrayProperty(name: string, primitiveType: Enumeration): Promise<EnumerationArrayProperty>;
-    /**
-     * Creates a PrimitiveArrayECProperty.
-     * @param name The name of property to create.
-     * @param primitiveType The primitive type of property to create. If not provided the default is PrimitiveType.Integer
-     */
-    protected createPrimitiveArrayPropertySync(name: string, primitiveType: PrimitiveType): PrimitiveArrayProperty;
-    protected createPrimitiveArrayPropertySync(name: string, primitiveType: Enumeration): EnumerationArrayProperty;
-    /**
-     *
-     * @param name The name of property to create.
-     * @param structType The struct type of property to create.
-     */
-    protected createStructProperty(name: string, structType: string | StructClass): Promise<StructProperty>;
-    /**
-     *
-     * @param name The name of property to create.
-     * @param structType The struct type of property to create.
-     */
-    protected createStructPropertySync(name: string, structType: string | StructClass): StructProperty;
-    /**
-     *
-     * @param name
-     * @param type
-     */
-    protected createStructArrayProperty(name: string, structType: string | StructClass): Promise<StructArrayProperty>;
-    /**
-     *
-     * @param name
-     * @param type
-     */
-    protected createStructArrayPropertySync(name: string, structType: string | StructClass): StructArrayProperty;
-    protected loadStructType(structType: string | StructClass | undefined, schema: Schema): Promise<StructClass>;
-    protected loadStructTypeSync(structType: string | StructClass | undefined, schema: Schema): StructClass;
-    protected loadPrimitiveType(primitiveType: string | PrimitiveType | Enumeration | undefined, schema: Schema): Promise<PrimitiveType | Enumeration>;
-    protected loadPrimitiveTypeSync(primitiveType: string | PrimitiveType | Enumeration | undefined, schema: Schema): PrimitiveType | Enumeration;
-    /**
-     * Save this Classes properties to an object for serializing to JSON.
-     * @param standalone Serialization includes only this object (as opposed to the full schema).
-     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
-     */
-    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): ClassProps;
-    /** @internal */
-    toXml(schemaXml: Document): Promise<Element>;
-    fromJSONSync(classProps: ClassProps): void;
-    fromJSON(classProps: ClassProps): Promise<void>;
-    protected addCustomAttribute(customAttribute: CustomAttribute): void;
-    /**
-     * Iterates (recursively) over all base classes and mixins, in "property override" order.
-     * This is essentially a depth-first traversal through the inheritance tree.
-     */
-    getAllBaseClasses(): AsyncIterableIterator<ECClass>;
-    getAllBaseClassesSync(): Iterable<AnyClass>;
-    protected static mergeProperties(target: Property[], existingValues: Map<string, number>, propertiesToMerge: Property[], overwriteExisting: boolean): void;
-    protected buildPropertyCache(result: Property[], existingValues?: Map<string, number>, resetBaseCaches?: boolean): Promise<void>;
-    protected buildPropertyCacheSync(result: Property[], existingValues?: Map<string, number>, resetBaseCaches?: boolean): void;
-    /**
-     * Iterates all properties, including the ones merged from base classes and mixins. To obtain only local properties, use the 'properties' field.
-     * Since this is an expensive operation, results will be cached after first call.
-     * @param resetCache if true, any previously cached results will be dropped and cache will be rebuilt
-     */
-    getPropertiesSync(resetCache?: boolean): Property[];
-    /**
-     * Iterates all properties, including the ones merged from base classes and mixins. To obtain only local properties, use the 'properties' field.
-     * Since this is an expensive operation, results will be cached after first call.
-     * @param resetCache if true, any previously cached results will be dropped and cache will be rebuilt
-     */
-    getProperties(resetCache?: boolean): Promise<Property[]>;
-    /**
-     * Retrieve all custom attributes in the current class and its bases
-     * This is the async version of getCustomAttributesSync()
-     */
-    getCustomAttributes(): Promise<CustomAttributeSet>;
-    /**
-     * Retrieve all custom attributes in the current class and its bases.
-     */
-    getCustomAttributesSync(): CustomAttributeSet;
-    /**
-     * Asynchronously traverses through the inheritance tree, using depth-first traversal, calling the given callback
-     * function for each base class encountered.
-     * @param callback The function to call for each base class in the hierarchy.
-     * @param arg An argument that will be passed as the second parameter to the callback function.
-     */
-    traverseBaseClasses(callback: (ecClass: ECClass, arg?: any) => boolean, arg?: any): Promise<boolean>;
-    /**
-     * Synchronously traverses through the inheritance tree, using depth-first traversal, calling the given callback
-     * function for each base class encountered.
-     * @param callback The function to call for each base class in the hierarchy.
-     * @param arg An argument that will be passed as the second parameter to the callback function.
-     */
-    traverseBaseClassesSync(callback: (ecClass: ECClass, arg?: any) => boolean, arg?: any): boolean;
-    /**
-     * Indicates if the targetClass is of this type.
-     * @param targetClass The ECClass or ECClass name to check.
-     * @param schemaName The schema name. Required if targetClass is the ECClass name.
-     */
-    is(targetClass: string, schemaName: string): Promise<boolean>;
-    is(targetClass: ECClass): Promise<boolean>;
-    /**
-     * A synchronous version of the [[ECClass.is]], indicating if the targetClass is of this type.
-     * @param targetClass The class to check.
-     */
-    isSync(targetClass: ECClass): boolean;
-    /**
-     * @internal
-     */
-    static isECClass(object: any): object is ECClass;
-    /**
-     * @alpha
-     * A setter method used specifically for schema editing.
-     * @param modifier
-     */
-    protected setModifier(modifier: ECClassModifier): void;
-}
-/**
- * A Typescript class representation of an ECStructClass.
- * @beta
- */
-export declare class StructClass extends ECClass {
-    readonly schemaItemType: SchemaItemType.StructClass;
-    constructor(schema: Schema, name: string, modifier?: ECClassModifier);
-}
-/**
- * @internal
- * An abstract class used for schema editing.
- */
-export declare abstract class MutableStructClass extends StructClass {
-    abstract setDisplayLabel(displayLabel: string): void;
-}
-/**
- * Hackish approach that works like a "friend class" so we can access protected members without making them public.
- * @internal
- */
-export declare abstract class MutableClass extends ECClass {
-    abstract addCustomAttribute(customAttribute: CustomAttribute): void;
-    abstract setModifier(modifier: ECClassModifier): void;
-    abstract createPrimitiveProperty(name: string, primitiveType: PrimitiveType): Promise<PrimitiveProperty>;
-    abstract createPrimitiveProperty(name: string, primitiveType: Enumeration): Promise<EnumerationProperty>;
-    abstract createPrimitiveProperty(name: string, primitiveType?: string | PrimitiveType | Enumeration): Promise<Property>;
-    abstract createPrimitivePropertySync(name: string, primitiveType: PrimitiveType): PrimitiveProperty;
-    abstract createPrimitivePropertySync(name: string, primitiveType: Enumeration): EnumerationProperty;
-    abstract createPrimitivePropertySync(name: string, primitiveType?: string | PrimitiveType | Enumeration): Property;
-    abstract createPrimitiveArrayProperty(name: string, primitiveType: PrimitiveType): Promise<PrimitiveArrayProperty>;
-    abstract createPrimitiveArrayProperty(name: string, primitiveType: Enumeration): Promise<EnumerationArrayProperty>;
-    abstract createPrimitiveArrayProperty(name: string, primitiveType?: string | PrimitiveType | Enumeration): Promise<Property>;
-    abstract createPrimitiveArrayPropertySync(name: string, primitiveType: PrimitiveType): PrimitiveArrayProperty;
-    abstract createPrimitiveArrayPropertySync(name: string, primitiveType: Enumeration): EnumerationArrayProperty;
-    abstract createPrimitiveArrayPropertySync(name: string, primitiveType?: string | PrimitiveType | Enumeration): Property;
-    abstract createStructProperty(name: string, structType: string | StructClass): Promise<StructProperty>;
-    abstract createStructPropertySync(name: string, structType: string | StructClass): StructProperty;
-    abstract createStructArrayProperty(name: string, structType: string | StructClass): Promise<StructArrayProperty>;
-    abstract createStructArrayPropertySync(name: string, structType: string | StructClass): StructArrayProperty;
-    abstract deleteProperty(name: string): Promise<void>;
-    abstract deletePropertySync(name: string): void;
-}
+/** @packageDocumentation
+ * @module Metadata
+ */
+import { ClassProps } from "../Deserialization/JsonProps";
+import { ECClassModifier, PrimitiveType, SchemaItemType } from "../ECObjects";
+import { AnyClass, LazyLoadedECClass } from "../Interfaces";
+import { CustomAttribute, CustomAttributeContainerProps, CustomAttributeSet } from "./CustomAttribute";
+import { Enumeration } from "./Enumeration";
+import { EnumerationArrayProperty, EnumerationProperty, PrimitiveArrayProperty, PrimitiveProperty, Property, StructArrayProperty, StructProperty } from "./Property";
+import { Schema } from "./Schema";
+import { SchemaItem } from "./SchemaItem";
+/**
+ * A common abstract class for all of the ECClass types.
+ * @beta
+ */
+export declare abstract class ECClass extends SchemaItem implements CustomAttributeContainerProps {
+    protected _modifier: ECClassModifier;
+    protected _baseClass?: LazyLoadedECClass;
+    protected _properties?: Map<string, Property>;
+    private _customAttributes?;
+    private _mergedPropertyCache?;
+    get modifier(): ECClassModifier;
+    get baseClass(): LazyLoadedECClass | undefined;
+    set baseClass(baseClass: LazyLoadedECClass | undefined);
+    get properties(): IterableIterator<Property> | undefined;
+    get customAttributes(): CustomAttributeSet | undefined;
+    constructor(schema: Schema, name: string, modifier?: ECClassModifier);
+    /**
+     * Convenience method for adding an already loaded ECProperty used by create*Property methods.
+     * @param prop The property to add.
+     * @return The property that was added.
+     */
+    protected addProperty<T extends Property>(prop: T): T;
+    /**
+     * Deletes a property from within this class.
+     * @param name The property name to delete, lookup is case-insensitive
+     * @alpha
+     */
+    protected deleteProperty(name: string): Promise<void>;
+    /**
+     * Deletes a property from within this class.
+     * @param name The property name to delete, lookup is case-insensitive
+     * @alpha
+     */
+    protected deletePropertySync(name: string): void;
+    getBaseClassSync(): ECClass | undefined;
+    /**
+     * Searches, case-insensitive, for a local ECProperty with the name provided.
+     * @param name
+     */
+    getProperty(name: string, includeInherited?: boolean): Promise<Property | undefined>;
+    /**
+     * Searches, case-insensitive, for a local ECProperty with the name provided.
+     * @param name
+     */
+    getPropertySync(name: string, includeInherited?: boolean): Property | undefined;
+    /**
+     * Searches the base class, if one exists, for the property with the name provided.
+     * @param name The name of the inherited property to find.
+     */
+    getInheritedProperty(name: string): Promise<Property | undefined>;
+    /**
+     * Searches the base class, if one exists, for the property with the name provided.
+     * @param name The name of the inherited property to find.
+     */
+    getInheritedPropertySync(name: string): Property | undefined;
+    /**
+     * Creates a PrimitiveECProperty.
+     * @param name The name of property to create.
+     * @param primitiveType The primitive type of property to create. If not provided the default is PrimitiveType.Integer
+     * @throws ECObjectsStatus DuplicateProperty: thrown if a property with the same name already exists in the class.
+     */
+    protected createPrimitiveProperty(name: string, primitiveType: PrimitiveType): Promise<PrimitiveProperty>;
+    protected createPrimitiveProperty(name: string, primitiveType: Enumeration): Promise<EnumerationProperty>;
+    /**
+     * Creates a PrimitiveECProperty.
+     * @param name The name of property to create.
+     * @param primitiveType The primitive type of property to create. If not provided the default is PrimitiveType.Integer
+     * @throws ECObjectsStatus DuplicateProperty: thrown if a property with the same name already exists in the class.
+     */
+    protected createPrimitivePropertySync(name: string, primitiveType: PrimitiveType): PrimitiveProperty;
+    protected createPrimitivePropertySync(name: string, primitiveType: Enumeration): EnumerationProperty;
+    /**
+     * Creates a PrimitiveArrayECProperty.
+     * @param name The name of property to create.
+     * @param primitiveType The primitive type of property to create. If not provided the default is PrimitiveType.Integer
+     */
+    protected createPrimitiveArrayProperty(name: string, primitiveType: PrimitiveType): Promise<PrimitiveArrayProperty>;
+    protected createPrimitiveArrayProperty(name: string, primitiveType: Enumeration): Promise<EnumerationArrayProperty>;
+    /**
+     * Creates a PrimitiveArrayECProperty.
+     * @param name The name of property to create.
+     * @param primitiveType The primitive type of property to create. If not provided the default is PrimitiveType.Integer
+     */
+    protected createPrimitiveArrayPropertySync(name: string, primitiveType: PrimitiveType): PrimitiveArrayProperty;
+    protected createPrimitiveArrayPropertySync(name: string, primitiveType: Enumeration): EnumerationArrayProperty;
+    /**
+     *
+     * @param name The name of property to create.
+     * @param structType The struct type of property to create.
+     */
+    protected createStructProperty(name: string, structType: string | StructClass): Promise<StructProperty>;
+    /**
+     *
+     * @param name The name of property to create.
+     * @param structType The struct type of property to create.
+     */
+    protected createStructPropertySync(name: string, structType: string | StructClass): StructProperty;
+    /**
+     *
+     * @param name
+     * @param type
+     */
+    protected createStructArrayProperty(name: string, structType: string | StructClass): Promise<StructArrayProperty>;
+    /**
+     *
+     * @param name
+     * @param type
+     */
+    protected createStructArrayPropertySync(name: string, structType: string | StructClass): StructArrayProperty;
+    protected loadStructType(structType: string | StructClass | undefined, schema: Schema): Promise<StructClass>;
+    protected loadStructTypeSync(structType: string | StructClass | undefined, schema: Schema): StructClass;
+    protected loadPrimitiveType(primitiveType: string | PrimitiveType | Enumeration | undefined, schema: Schema): Promise<PrimitiveType | Enumeration>;
+    protected loadPrimitiveTypeSync(primitiveType: string | PrimitiveType | Enumeration | undefined, schema: Schema): PrimitiveType | Enumeration;
+    /**
+     * Save this Classes properties to an object for serializing to JSON.
+     * @param standalone Serialization includes only this object (as opposed to the full schema).
+     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
+     */
+    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): ClassProps;
+    /** @internal */
+    toXml(schemaXml: Document): Promise<Element>;
+    fromJSONSync(classProps: ClassProps): void;
+    fromJSON(classProps: ClassProps): Promise<void>;
+    protected addCustomAttribute(customAttribute: CustomAttribute): void;
+    /**
+     * Iterates (recursively) over all base classes and mixins, in "property override" order.
+     * This is essentially a depth-first traversal through the inheritance tree.
+     */
+    getAllBaseClasses(): AsyncIterableIterator<ECClass>;
+    getAllBaseClassesSync(): Iterable<AnyClass>;
+    protected static mergeProperties(target: Property[], existingValues: Map<string, number>, propertiesToMerge: Property[], overwriteExisting: boolean): void;
+    protected buildPropertyCache(result: Property[], existingValues?: Map<string, number>, resetBaseCaches?: boolean): Promise<void>;
+    protected buildPropertyCacheSync(result: Property[], existingValues?: Map<string, number>, resetBaseCaches?: boolean): void;
+    /**
+     * Iterates all properties, including the ones merged from base classes and mixins. To obtain only local properties, use the 'properties' field.
+     * Since this is an expensive operation, results will be cached after first call.
+     * @param resetCache if true, any previously cached results will be dropped and cache will be rebuilt
+     */
+    getPropertiesSync(resetCache?: boolean): Property[];
+    /**
+     * Iterates all properties, including the ones merged from base classes and mixins. To obtain only local properties, use the 'properties' field.
+     * Since this is an expensive operation, results will be cached after first call.
+     * @param resetCache if true, any previously cached results will be dropped and cache will be rebuilt
+     */
+    getProperties(resetCache?: boolean): Promise<Property[]>;
+    /**
+     * Retrieve all custom attributes in the current class and its bases
+     * This is the async version of getCustomAttributesSync()
+     */
+    getCustomAttributes(): Promise<CustomAttributeSet>;
+    /**
+     * Retrieve all custom attributes in the current class and its bases.
+     */
+    getCustomAttributesSync(): CustomAttributeSet;
+    /**
+     * Asynchronously traverses through the inheritance tree, using depth-first traversal, calling the given callback
+     * function for each base class encountered.
+     * @param callback The function to call for each base class in the hierarchy.
+     * @param arg An argument that will be passed as the second parameter to the callback function.
+     */
+    traverseBaseClasses(callback: (ecClass: ECClass, arg?: any) => boolean, arg?: any): Promise<boolean>;
+    /**
+     * Synchronously traverses through the inheritance tree, using depth-first traversal, calling the given callback
+     * function for each base class encountered.
+     * @param callback The function to call for each base class in the hierarchy.
+     * @param arg An argument that will be passed as the second parameter to the callback function.
+     */
+    traverseBaseClassesSync(callback: (ecClass: ECClass, arg?: any) => boolean, arg?: any): boolean;
+    /**
+     * Indicates if the targetClass is of this type.
+     * @param targetClass The ECClass or ECClass name to check.
+     * @param schemaName The schema name. Required if targetClass is the ECClass name.
+     */
+    is(targetClass: string, schemaName: string): Promise<boolean>;
+    is(targetClass: ECClass): Promise<boolean>;
+    /**
+     * A synchronous version of the [[ECClass.is]], indicating if the targetClass is of this type.
+     * @param targetClass The class to check.
+     */
+    isSync(targetClass: ECClass): boolean;
+    /**
+     * @internal
+     */
+    static isECClass(object: any): object is ECClass;
+    /**
+     * @alpha
+     * A setter method used specifically for schema editing.
+     * @param modifier
+     */
+    protected setModifier(modifier: ECClassModifier): void;
+}
+/**
+ * A Typescript class representation of an ECStructClass.
+ * @beta
+ */
+export declare class StructClass extends ECClass {
+    readonly schemaItemType: SchemaItemType.StructClass;
+    constructor(schema: Schema, name: string, modifier?: ECClassModifier);
+}
+/**
+ * @internal
+ * An abstract class used for schema editing.
+ */
+export declare abstract class MutableStructClass extends StructClass {
+    abstract setDisplayLabel(displayLabel: string): void;
+}
+/**
+ * Hackish approach that works like a "friend class" so we can access protected members without making them public.
+ * @internal
+ */
+export declare abstract class MutableClass extends ECClass {
+    abstract addCustomAttribute(customAttribute: CustomAttribute): void;
+    abstract setModifier(modifier: ECClassModifier): void;
+    abstract createPrimitiveProperty(name: string, primitiveType: PrimitiveType): Promise<PrimitiveProperty>;
+    abstract createPrimitiveProperty(name: string, primitiveType: Enumeration): Promise<EnumerationProperty>;
+    abstract createPrimitiveProperty(name: string, primitiveType?: string | PrimitiveType | Enumeration): Promise<Property>;
+    abstract createPrimitivePropertySync(name: string, primitiveType: PrimitiveType): PrimitiveProperty;
+    abstract createPrimitivePropertySync(name: string, primitiveType: Enumeration): EnumerationProperty;
+    abstract createPrimitivePropertySync(name: string, primitiveType?: string | PrimitiveType | Enumeration): Property;
+    abstract createPrimitiveArrayProperty(name: string, primitiveType: PrimitiveType): Promise<PrimitiveArrayProperty>;
+    abstract createPrimitiveArrayProperty(name: string, primitiveType: Enumeration): Promise<EnumerationArrayProperty>;
+    abstract createPrimitiveArrayProperty(name: string, primitiveType?: string | PrimitiveType | Enumeration): Promise<Property>;
+    abstract createPrimitiveArrayPropertySync(name: string, primitiveType: PrimitiveType): PrimitiveArrayProperty;
+    abstract createPrimitiveArrayPropertySync(name: string, primitiveType: Enumeration): EnumerationArrayProperty;
+    abstract createPrimitiveArrayPropertySync(name: string, primitiveType?: string | PrimitiveType | Enumeration): Property;
+    abstract createStructProperty(name: string, structType: string | StructClass): Promise<StructProperty>;
+    abstract createStructPropertySync(name: string, structType: string | StructClass): StructProperty;
+    abstract createStructArrayProperty(name: string, structType: string | StructClass): Promise<StructArrayProperty>;
+    abstract createStructArrayPropertySync(name: string, structType: string | StructClass): StructArrayProperty;
+    abstract deleteProperty(name: string): Promise<void>;
+    abstract deletePropertySync(name: string): void;
+}
 //# sourceMappingURL=Class.d.ts.map