@itwin/ecschema-editing 4.7.0-dev.15 → 4.7.0-dev.16

package/lib/cjs/Editing/Exception.d.ts

@@ -0,0 +1,257 @@
+/** @packageDocumentation
+ * @module Editing
+ */
+import { BentleyError } from "@itwin/core-bentley";
+import { AnyDiagnostic } from "../Validation/Diagnostic";
+import { AnyEnumerator, CustomAttributeContainerProps, Enumeration, Property, RelationshipConstraint, SchemaItemKey, SchemaItemType, SchemaKey } from "@itwin/ecschema-metadata";
+/** @alpha */
+export declare enum ECEditingStatus {
+    EC_EDITING_ERROR_BASE = 196608,
+    Unknown = 0,
+    RuleViolation = 196609,
+    SchemaNotFound = 196610,
+    SchemaItemNotFound = 196611,
+    SchemaItemNotFoundInContext = 196612,
+    PropertyAlreadyExists = 196613,
+    PropertyNotFound = 196614,
+    InvalidPropertyType = 196615,
+    BaseClassIsNotElement = 196616,
+    BaseClassIsNotElementUniqueAspect = 196617,
+    BaseClassIsNotElementMultiAspect = 196618,
+    SchemaItemNameNotSpecified = 196619,
+    InvalidSchemaItemType = 196620,
+    SchemaItemNameAlreadyExists = 196621,
+    InvalidEnumeratorType = 196622,
+    InvalidBaseClass = 196623,
+    EnumeratorDoesNotExist = 196624,
+    InvalidStrengthDirection = 196625,
+    InvalidECName = 196626,
+    InvalidFormatUnitsSpecified = 196627,
+    CreateSchemaItemFailed = 196628,
+    CreateSchemaItemFromProps = 196629,
+    CreateElement = 196630,
+    CreateElementUniqueAspect = 196631,
+    CreateElementMultiAspect = 196632,
+    SetBaseClass = 196633,
+    SetSourceConstraint = 196634,
+    SetTargetConstraint = 196635,
+    AddConstraintClass = 196636,
+    RemoveConstraintClass = 196637,
+    SetAbstractConstraint = 196638,
+    AddCustomAttributeToConstraint = 196639,
+    AddCustomAttributeToProperty = 196640,
+    AddCustomAttributeToClass = 196641,
+    CreateNavigationProperty = 196642,
+    CreateNavigationPropertyFromProps = 196643,
+    SetInvertsUnit = 196644,
+    SetUnitSystem = 196645,
+    SetDescription = 196646,
+    SetLabel = 196647,
+    SetIsReadOnly = 196648,
+    SetPriority = 196649,
+    SetCategory = 196650,
+    SetMinOccurs = 196651,
+    SetMaxOccurs = 196652,
+    SetExtendedTypeName = 196653,
+    SetMinLength = 196654,
+    SetMaxLength = 196655,
+    SetMinValue = 196656,
+    SetMaxValue = 196657,
+    SetPropertyName = 196658,
+    AddMixin = 196659,
+    AddEnumerator = 196660,
+    SetEnumeratorLabel = 196661,
+    SetEnumeratorDescription = 196662,
+    AddPresentationUnit = 196663,
+    AddPresentationOverride = 196664,
+    CreateFormatOverride = 196665,
+    SetPropertyCategoryPriority = 196666,
+    CreatePrimitiveProperty = 196667,
+    CreatePrimitivePropertyFromProps = 196668,
+    CreateEnumerationProperty = 196669,
+    CreateEnumerationPropertyFromProps = 196670,
+    CreatePrimitiveArrayProperty = 196671,
+    CreatePrimitiveArrayPropertyFromProps = 196672,
+    CreateEnumerationArrayProperty = 196673,
+    CreateEnumerationArrayPropertyFromProps = 196674,
+    CreateStructProperty = 196675,
+    CreateStructPropertyFromProps = 196676,
+    CreateStructArrayProperty = 196677,
+    CreateStructArrayPropertyFromProps = 196678,
+    DeleteProperty = 196679,
+    DeleteClass = 196680,
+    SetClassName = 196681,
+    AddSchemaReference = 196682,
+    SetSchemaVersion = 196683,
+    IncrementSchemaMinorVersion = 196684
+}
+export type AnyEditingError = SchemaEditingError | Error;
+export declare enum TaskType {
+    Add = 0,
+    Create = 1,
+    Update = 2,
+    Change = 3,
+    Delete = 4
+}
+export declare enum PropertyTypeName {
+    ArrayProperty = "ArrayProperty",
+    PrimitiveProperty = "PrimitiveProperty",
+    EnumerationProperty = "EnumerationProperty",
+    NavigationProperty = "NavigationProperty",
+    StructProperty = "StructProperty"
+}
+type ECClassSchemaItems = SchemaItemType.EntityClass | SchemaItemType.StructClass | SchemaItemType.RelationshipClass | SchemaItemType.Mixin | SchemaItemType.CustomAttributeClass;
+export interface SchemaTypeIdentifier {
+    name: string;
+}
+export declare class SchemaId implements SchemaTypeIdentifier {
+    readonly name: string;
+    readonly schemaKey: SchemaKey;
+    constructor(schemaKey: SchemaKey);
+}
+export declare class SchemaItemId implements SchemaTypeIdentifier {
+    readonly name: string;
+    readonly type: SchemaItemType;
+    readonly schemaKey: SchemaKey;
+    readonly schemaItemKey: SchemaItemKey;
+    constructor(schemaItemType: SchemaItemType, schemaItemKeyOrName: SchemaItemKey | string, schemaKey?: SchemaKey);
+}
+export declare class ClassId extends SchemaItemId {
+    constructor(schemaItemType: ECClassSchemaItems, schemaItemKeyOrName: SchemaItemKey | string, schemaKey?: SchemaKey);
+}
+export declare class PropertyId implements SchemaTypeIdentifier {
+    readonly name: string;
+    readonly fullName: string;
+    readonly ecClass: ClassId;
+    readonly schemaKey: SchemaKey;
+    readonly typeName?: PropertyTypeName;
+    constructor(schemaItemType: ECClassSchemaItems, classKey: SchemaItemKey, property: Property | string, typeName?: PropertyTypeName);
+}
+export declare class EnumerationId extends SchemaItemId {
+    readonly enumerationType: string;
+    readonly enumeratorName: string;
+    readonly enumeratorType: string;
+    constructor(enumeration: Enumeration, enumerator: AnyEnumerator | string);
+    private getEnumeratorType;
+}
+export declare class CustomAttributeId implements SchemaTypeIdentifier {
+    readonly name: string;
+    readonly schemaKey: SchemaKey;
+    readonly containerFullName: string;
+    constructor(name: string, container: CustomAttributeContainerProps);
+}
+export declare class RelationshipConstraintId implements SchemaTypeIdentifier {
+    readonly name: string;
+    readonly relationshipKey: SchemaItemKey;
+    readonly schemaKey: SchemaKey;
+    constructor(constraint: RelationshipConstraint);
+}
+type AnyIdentifier = SchemaId | PropertyId | CustomAttributeId | RelationshipConstraintId | EnumerationId;
+/**
+ * Indicates if the given identifier is a SchemaId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isSchemaIdentifier(identifier: AnyIdentifier): identifier is SchemaId;
+/**
+ * Indicates if the given identifier is a SchemaId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isSchemaItemIdentifier(identifier: AnyIdentifier): identifier is SchemaItemId;
+/**
+ * Indicates if the given identifier is a ClassId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isClassIdentifier(identifier: AnyIdentifier): identifier is ClassId;
+/**
+ * Indicates if the given identifier is a PropertyId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isPropertyIdentifier(identifier: AnyIdentifier): identifier is PropertyId;
+/**
+ * Indicates if the given identifier is a EnumerationId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isEnumerationIdentifier(identifier: AnyIdentifier): identifier is EnumerationId;
+/**
+ * Indicates if the given identifier is a CustomAttributeId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isCustomAttributeIdentifier(identifier: AnyIdentifier): identifier is CustomAttributeId;
+/**
+ * Indicates if the given identifier is a RelationshipConstraintId instance.
+ * @param identifier The identifier to check.
+ * @returns true if the identifier is the correct type.
+ */
+export declare function isRelationshipConstraintIdentifier(identifier: AnyIdentifier): identifier is RelationshipConstraintId;
+/**
+ * @internal
+ * An exception class for the ecschema-editing API. Contains identifiers for schema types involved in the
+ * exception. An example being SchemaItemId which contains the name of the SchemaItem, SchemaItemKey, SchemaItemType, etc.
+ * Typically will contain an innerError of type SchemaEditingError containing the identifier of the schema item that
+ * caused the exception. The containing error instance will identify the method called (identified by the errorNumber)
+ * and the identifier of the schema item being modified/created.
+ */
+export declare class SchemaEditingError extends BentleyError {
+    readonly errorNumber: number;
+    readonly identifier: AnyIdentifier;
+    readonly innerError?: AnyEditingError | undefined;
+    private _ruleViolations?;
+    private _schemaKey;
+    /**
+     * Constructs a new SchemaEditingError instance.
+     * @param errorNumber The unique ECEditingStatus code identifying the error.
+     * @param identifier The identifier instance containing information about the EC object involved with the exception.
+     * @param innerError The SchemaEditingError containing the identifier of the EC object that caused the initial exception.
+     * @param ruleViolations Will contain EC rule violations of type [[AnyDiagnostic]] for exceptions with the error code ECEditingStatus.RuleViolation.
+     * @param message Optional error message. Most messages on automatically generated by this class based on the ECEditingStatus code.
+     */
+    constructor(errorNumber: number, identifier: AnyIdentifier, innerError?: AnyEditingError | undefined, ruleViolations?: AnyDiagnostic[], message?: string);
+    /**
+     * Gets the SchemaId instance.
+     * @throws Error if the identifier is not an instance of SchemaId.
+     */
+    get schemaId(): SchemaId;
+    /**
+     * Gets the SchemaItemId instance.
+     * @throws Error if the identifier is not an instance of SchemaItemId.
+     */
+    get schemaItemId(): SchemaItemId;
+    /**
+     * Gets the ClassId instance.
+     * @throws Error if the identifier is not an instance of ClassId.
+     */
+    get classId(): ClassId;
+    /**
+     * Gets the PropertyId instance.
+     * @throws Error if the identifier is not an instance of PropertyId.
+     */
+    get propertyId(): PropertyId;
+    /**
+     * Gets the EnumerationId instance.
+     * @throws Error if the identifier is not an instance of EnumerationId.
+     */
+    get enumerationId(): EnumerationId;
+    /**
+     * Gets the CustomAttributeId instance.
+     * @throws Error if the identifier is not an instance of CustomAttributeId.
+     */
+    get customAttributeId(): CustomAttributeId;
+    /**
+     * Gets the RelationshipConstraintId instance.
+     * @throws Error if the identifier is not an instance of RelationshipConstraintId.
+     */
+    get relationshipConstraintId(): RelationshipConstraintId;
+    get ruleViolations(): AnyDiagnostic[] | undefined;
+    toDebugString(): string;
+    private _appendMessage;
+    private generateMessage;
+    private getRuleViolationMessage;
+}
+export {};
+//# sourceMappingURL=Exception.d.ts.map

package/lib/cjs/Editing/Exception.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Exception.d.ts","sourceRoot":"","sources":["../../../src/Editing/Exception.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,6BAA6B,EAAE,WAAW,EAAyB,QAAQ,EAAE,sBAAsB,EAAE,aAAa,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAExM,aAAa;AACb,oBAAY,eAAe;IACzB,qBAAqB,SAAU;IAC/B,OAAO,IAAI;IACX,aAAa,SAA4B;IACzC,cAAc,SAAA;IACd,kBAAkB,SAAA;IAClB,2BAA2B,SAAA;IAC3B,qBAAqB,SAAA;IACrB,gBAAgB,SAAA;IAChB,mBAAmB,SAAA;IACnB,qBAAqB,SAAA;IACrB,iCAAiC,SAAA;IACjC,gCAAgC,SAAA;IAChC,0BAA0B,SAAA;IAC1B,qBAAqB,SAAA;IACrB,2BAA2B,SAAA;IAC3B,qBAAqB,SAAA;IACrB,gBAAgB,SAAA;IAChB,sBAAsB,SAAA;IACtB,wBAAwB,SAAA;IACxB,aAAa,SAAA;IACb,2BAA2B,SAAA;IAE3B,sBAAsB,SAAA;IACtB,yBAAyB,SAAA;IACzB,aAAa,SAAA;IACb,yBAAyB,SAAA;IACzB,wBAAwB,SAAA;IACxB,YAAY,SAAA;IACZ,mBAAmB,SAAA;IACnB,mBAAmB,SAAA;IACnB,kBAAkB,SAAA;IAClB,qBAAqB,SAAA;IACrB,qBAAqB,SAAA;IACrB,8BAA8B,SAAA;IAC9B,4BAA4B,SAAA;IAC5B,yBAAyB,SAAA;IACzB,wBAAwB,SAAA;IACxB,iCAAiC,SAAA;IACjC,cAAc,SAAA;IACd,aAAa,SAAA;IACb,cAAc,SAAA;IACd,QAAQ,SAAA;IACR,aAAa,SAAA;IACb,WAAW,SAAA;IACX,WAAW,SAAA;IACX,YAAY,SAAA;IACZ,YAAY,SAAA;IACZ,mBAAmB,SAAA;IACnB,YAAY,SAAA;IACZ,YAAY,SAAA;IACZ,WAAW,SAAA;IACX,WAAW,SAAA;IACX,eAAe,SAAA;IACf,QAAQ,SAAA;IACR,aAAa,SAAA;IACb,kBAAkB,SAAA;IAClB,wBAAwB,SAAA;IACxB,mBAAmB,SAAA;IACnB,uBAAuB,SAAA;IACvB,oBAAoB,SAAA;IACpB,2BAA2B,SAAA;IAC3B,uBAAuB,SAAA;IACvB,gCAAgC,SAAA;IAChC,yBAAyB,SAAA;IACzB,kCAAkC,SAAA;IAClC,4BAA4B,SAAA;IAC5B,qCAAqC,SAAA;IACrC,8BAA8B,SAAA;IAC9B,uCAAuC,SAAA;IACvC,oBAAoB,SAAA;IACpB,6BAA6B,SAAA;IAC7B,yBAAyB,SAAA;IACzB,kCAAkC,SAAA;IAClC,cAAc,SAAA;IACd,WAAW,SAAA;IACX,YAAY,SAAA;IACZ,kBAAkB,SAAA;IAClB,gBAAgB,SAAA;IAChB,2BAA2B,SAAA;CAC5B;AAED,MAAM,MAAM,eAAe,GAAG,kBAAkB,GAAG,KAAK,CAAC;AAEzD,oBAAY,QAAQ;IAClB,GAAG,IAAA;IACH,MAAM,IAAA;IACN,MAAM,IAAA;IACN,MAAM,IAAA;IACN,MAAM,IAAA;CACP;AAED,oBAAY,gBAAgB;IAC1B,aAAa,kBAAkB;IAC/B,iBAAiB,sBAAsB;IACvC,mBAAmB,wBAAwB;IAC3C,kBAAkB,uBAAuB;IACzC,cAAc,mBAAmB;CAClC;AAED,KAAK,kBAAkB,GAAG,cAAc,CAAC,WAAW,GAAG,cAAc,CAAC,WAAW,GAAG,cAAc,CAAC,iBAAiB,GAAG,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,oBAAoB,CAAC;AAElL,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,qBAAa,QAAS,YAAW,oBAAoB;IACnD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,SAAS,CAAC;gBACzB,SAAS,EAAE,SAAS;CAIjC;AAED,qBAAa,YAAa,YAAW,oBAAoB;IACvD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,IAAI,EAAE,cAAc,CAAC;IACrC,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,aAAa,EAAE,aAAa,CAAC;gBACjC,cAAc,EAAE,cAAc,EAAE,mBAAmB,EAAE,aAAa,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS;CAe/G;AAED,qBAAa,OAAQ,SAAQ,YAAY;gBAC3B,cAAc,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,aAAa,GAAG,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS;CAGnH;AAED,qBAAa,UAAW,YAAW,oBAAoB;IACrD,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,OAAO,EAAE,OAAO,CAAC;IACjC,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,QAAQ,CAAC,EAAE,gBAAgB,CAAC;gBAEhC,cAAc,EAAE,kBAAkB,EAAE,QAAQ,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,gBAAgB;CAOlI;AAED,qBAAa,aAAc,SAAQ,YAAY;IAC7C,SAAgB,eAAe,EAAE,MAAM,CAAC;IACxC,SAAgB,cAAc,EAAE,MAAM,CAAC;IACvC,SAAgB,cAAc,EAAE,MAAM,CAAC;gBAC3B,WAAW,EAAE,WAAW,EAAE,UAAU,EAAE,aAAa,GAAG,MAAM;IAOxE,OAAO,CAAC,iBAAiB;CAM1B;AAED,qBAAa,iBAAkB,YAAW,oBAAoB;IAC5D,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC,SAAgB,iBAAiB,EAAE,MAAM,CAAC;gBAC9B,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,6BAA6B;CAKnE;AAED,qBAAa,wBAAyB,YAAW,oBAAoB;IACnE,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,eAAe,EAAE,aAAa,CAAC;IAC/C,SAAgB,SAAS,EAAE,SAAS,CAAC;gBACzB,UAAU,EAAE,sBAAsB;CAK/C;AAED,KAAK,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,iBAAiB,GAAG,wBAAwB,GAAG,aAAa,CAAC;AAE1G;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,QAAQ,CAEpF;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,YAAY,CAE5F;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,OAAO,CAElF;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,UAAU,CAExF;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,aAAa,CAE9F;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,iBAAiB,CAEtG;AAED;;;;GAIG;AACH,wBAAgB,kCAAkC,CAAC,UAAU,EAAE,aAAa,GAAG,UAAU,IAAI,wBAAwB,CAEpH;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,YAAY;aAYN,WAAW,EAAE,MAAM;aAAkB,UAAU,EAAE,aAAa;aAAkB,UAAU,CAAC;IAXvI,OAAO,CAAC,eAAe,CAAC,CAAkB;IAC1C,OAAO,CAAC,UAAU,CAAY;IAE9B;;;;;;;OAOG;gBACyC,WAAW,EAAE,MAAM,EAAkB,UAAU,EAAE,aAAa,EAAkB,UAAU,CAAC,6BAAiB,EAAE,cAAc,CAAC,EAAE,aAAa,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM;IAO5M;;;OAGG;IACH,IAAW,QAAQ,IAAI,QAAQ,CAI9B;IAED;;;OAGG;IACH,IAAW,YAAY,IAAI,YAAY,CAItC;IAED;;;OAGG;IACH,IAAW,OAAO,IAAI,OAAO,CAI5B;IAED;;;OAGG;IACH,IAAW,UAAU,IAAI,UAAU,CAIlC;IAED;;;OAGG;IACH,IAAW,aAAa,IAAI,aAAa,CAIxC;IAED;;;OAGG;IACH,IAAW,iBAAiB,IAAI,iBAAiB,CAIhD;IAED;;;OAGG;IACH,IAAW,wBAAwB,IAAI,wBAAwB,CAI9D;IAED,IAAW,cAAc,IAAI,aAAa,EAAE,GAAG,SAAS,CAEvD;IAEM,aAAa,IAAI,MAAM;IAW9B,OAAO,CAAC,cAAc;IAItB,OAAO,CAAC,eAAe;IA2DvB,OAAO,CAAC,uBAAuB;CAuBhC"}