@itwin/ecschema-editing 3.0.0-dev.72

package/lib/Editing/Units.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Units.js","sourceRoot":"","sources":["../../src/Editing/Units.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,gEAAgJ;AAIhJ;;;GAGG;AACH,MAAa,KAAK;IAChB,6CAA6C;IAC7C,YAA6B,aAAkC;QAAlC,kBAAa,GAAb,aAAa,CAAqB;IAAI,CAAC;IAE7D,KAAK,CAAC,MAAM,CAAC,SAAoB,EAAE,IAAY,EAAE,UAAkB,EAAE,UAAyB,EAAE,UAAyB,EAAE,YAAqB;QACrJ,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEjH,MAAM,OAAO,GAAG,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAgB,CAAC;QAC/D,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,OAAO,EAAE,YAAY,EAAE,0BAA0B,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;SAClG;QAED,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,UAAU,CAAe,CAAC;QACzE,IAAI,cAAc,KAAK,SAAS;YAAE,OAAO,EAAE,YAAY,EAAE,+BAA+B,UAAU,CAAC,QAAQ,cAAc,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC;QAC9I,IAAI,cAAc,CAAC,cAAc,KAAK,kCAAc,CAAC,UAAU;YAAE,OAAO,EAAE,YAAY,EAAE,GAAG,UAAU,CAAC,QAAQ,6BAA6B,EAAE,CAAC;QAC9I,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,2CAAuB,CAA4B,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;QAE5H,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,UAAU,CAAe,CAAC;QACzE,IAAI,cAAc,KAAK,SAAS;YAAE,OAAO,EAAE,YAAY,EAAE,gCAAgC,UAAU,CAAC,QAAQ,cAAc,MAAM,CAAC,QAAQ,GAAG,EAAE,CAAC;QAC/I,IAAI,cAAc,CAAC,cAAc,KAAK,kCAAc,CAAC,UAAU;YAAE,OAAO,EAAE,YAAY,EAAE,GAAG,UAAU,CAAC,QAAQ,6BAA6B,EAAE,CAAC;QAC9I,MAAM,OAAO,CAAC,aAAa,CAAC,IAAI,2CAAuB,CAA4B,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;QAE5H,MAAM,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAExC,IAAI,YAAY,EAAE;YAAE,OAAO,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;SAAE;QAE5D,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAoB,EAAE,SAAoB;QACrE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC7D,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,EAAE,YAAY,EAAE,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAEjH,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS;YAAE,OAAO,EAAE,YAAY,EAAE,oCAAoC,EAAE,CAAC;QAChG,MAAM,OAAO,GAAG,CAAC,MAAM,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC1D,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,OAAO,EAAE,YAAY,EAAE,0BAA0B,SAAS,CAAC,IAAI,cAAc,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;SAC5G;QAED,MAAM,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAClC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC;IAClC,CAAC;CACF;AA3CD,sBA2CC","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 Editing\n */\n\nimport { DelayedPromiseWithProps, Phenomenon, SchemaItemKey, SchemaItemType, SchemaKey, UnitProps, UnitSystem } from \"@itwin/ecschema-metadata\";\nimport { SchemaContextEditor, SchemaItemEditResults } from \"./Editor\";\nimport { MutableUnit } from \"./Mutable/MutableUnit\";\n\n/**\n * @alpha\n * A class allowing you to create schema items of type Unit.\n */\nexport class Units {\n  // TODO: Add more setters for all attributes.\n  public constructor(protected _schemaEditor: SchemaContextEditor) { }\n\n  public async create(schemaKey: SchemaKey, name: string, definition: string, phenomenon: SchemaItemKey, unitSystem: SchemaItemKey, displayLabel?: string): Promise<SchemaItemEditResults> {\n    const schema = await this._schemaEditor.getSchema(schemaKey);\n    if (schema === undefined) return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\n\n    const newUnit = (await schema.createUnit(name)) as MutableUnit;\n    if (newUnit === undefined) {\n      return { errorMessage: `Failed to create class ${name} in schema ${schemaKey.toString(true)}.` };\n    }\n\n    const phenomenonItem = await schema.lookupItem(phenomenon) as Phenomenon;\n    if (phenomenonItem === undefined) return { errorMessage: `Unable to locate phenomenon ${phenomenon.fullName} in schema ${schema.fullName}.` };\n    if (phenomenonItem.schemaItemType !== SchemaItemType.Phenomenon) return { errorMessage: `${phenomenon.fullName} is not of type Phenomenon.` };\n    await newUnit.setPhenomenon(new DelayedPromiseWithProps<SchemaItemKey, Phenomenon>(phenomenon, async () => phenomenonItem));\n\n    const unitSystemItem = await schema.lookupItem(unitSystem) as UnitSystem;\n    if (unitSystemItem === undefined) return { errorMessage: `Unable to locate unit system ${unitSystem.fullName} in schema ${schema.fullName}.` };\n    if (unitSystemItem.schemaItemType !== SchemaItemType.UnitSystem) return { errorMessage: `${unitSystem.fullName} is not of type UnitSystem.` };\n    await newUnit.setUnitSystem(new DelayedPromiseWithProps<SchemaItemKey, UnitSystem>(unitSystem, async () => unitSystemItem));\n\n    await newUnit.setDefinition(definition);\n\n    if (displayLabel) { newUnit.setDisplayLabel(displayLabel); }\n\n    return { itemKey: newUnit.key };\n  }\n\n  public async createFromProps(schemaKey: SchemaKey, unitProps: UnitProps): Promise<SchemaItemEditResults> {\n    const schema = await this._schemaEditor.getSchema(schemaKey);\n    if (schema === undefined) return { errorMessage: `Schema Key ${schemaKey.toString(true)} not found in context` };\n\n    if (unitProps.name === undefined) return { errorMessage: `No name was supplied within props.` };\n    const newUnit = (await schema.createUnit(unitProps.name));\n    if (newUnit === undefined) {\n      return { errorMessage: `Failed to create class ${unitProps.name} in schema ${schemaKey.toString(true)}.` };\n    }\n\n    await newUnit.fromJSON(unitProps);\n    return { itemKey: newUnit.key };\n  }\n}\n"]}

package/lib/Validation/Diagnostic.d.ts

@@ -0,0 +1,322 @@
+/** @packageDocumentation
+ * @module Diagnostic
+ */
+import { AnyClass, AnyECType, AnyProperty, CustomAttributeContainerProps, RelationshipConstraint, Schema, SchemaItem } from "@itwin/ecschema-metadata";
+/**
+ * Defines the possible diagnostic types.
+ * @beta
+ */
+export declare enum DiagnosticType {
+    None = 0,
+    Schema = 1,
+    SchemaItem = 2,
+    Property = 3,
+    CustomAttributeContainer = 4,
+    RelationshipConstraint = 5
+}
+/**
+ * Defines the possible diagnostic categories.
+ * @beta
+ */
+export declare enum DiagnosticCategory {
+    Warning = 0,
+    Error = 1,
+    Suggestion = 2,
+    Message = 3
+}
+/**
+ * The interface implemented by all diagnostics used during schema validation.
+ * @beta
+ */
+export interface IDiagnostic<TYPE extends AnyECType, ARGS extends any[]> {
+    /** The diagnostic category (error, warning, etc...). Value is static across all instances. */
+    category: DiagnosticCategory;
+    /** The unique string identifier of the diagnostic in the format '<ruleSetName>:<number>. Value is static across all instances. */
+    code: string;
+    /** The context type of diagnostic (schema, schema item, property, etc...). Value is static across all instances. */
+    diagnosticType: DiagnosticType;
+    /** The unformatted message text associated with the diagnostic. Value is static across all instances. */
+    messageText: string;
+    /** The arguments used when formatted the diagnostic instance's message. */
+    messageArgs?: ARGS;
+    /** The EC object associated with the diagnostic instance. */
+    ecDefinition: TYPE;
+    /** The schema where the diagnostic originated. */
+    schema: Schema;
+}
+/**
+ * Type which encapsulates all possible diagnostics.
+ * @beta
+ */
+export declare type AnyDiagnostic = IDiagnostic<AnyECType, any[]>;
+/**
+ * The abstract base class for all [[IDiagnostic]] implementations.
+ * @beta
+ */
+export declare abstract class BaseDiagnostic<TYPE extends AnyECType, ARGS extends any[]> implements IDiagnostic<TYPE, ARGS> {
+    /**
+     * Initializes a new BaseDiagnostic.
+     * @param ecDefinition The EC object to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(ecDefinition: TYPE, messageArgs?: ARGS, category?: DiagnosticCategory);
+    /** Gets the unique string identifier for the diagnostic in the format '<ruleSetName>:<number>'. */
+    abstract get code(): string;
+    /** Gets the context type of the diagnostic (schema, schema item, property, etc...) */
+    abstract get diagnosticType(): DiagnosticType;
+    /** Gets the message associated with the diagnostic. */
+    abstract get messageText(): string;
+    /** Gets the schema where the diagnostic originated. */
+    abstract get schema(): Schema;
+    /** The EC object to associate with the diagnostic. */
+    ecDefinition: TYPE;
+    /** The arguments used when formatting the diagnostic message.  */
+    messageArgs?: ARGS;
+    /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */
+    category: DiagnosticCategory;
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[Schema]] diagnostics.
+ * @beta
+ */
+export declare abstract class SchemaDiagnostic<ARGS extends any[]> extends BaseDiagnostic<Schema, ARGS> {
+    static diagnosticType: DiagnosticType;
+    /**
+     * Initializes a new SchemaDiagnostic.
+     * @param ecDefinition The EC object to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(schema: Schema, messageArgs: ARGS, category?: DiagnosticCategory);
+    /** Gets the schema where the diagnostic originated. */
+    get schema(): Schema;
+    /** Gets the DiagnosticType. */
+    get diagnosticType(): DiagnosticType;
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[SchemaItem]] diagnostics.
+ * @beta
+ */
+export declare abstract class SchemaItemDiagnostic<TYPE extends SchemaItem, ARGS extends any[]> extends BaseDiagnostic<TYPE, ARGS> {
+    static diagnosticType: DiagnosticType;
+    /**
+     * Initializes a new SchemaItemDiagnostic.
+     * @param ecDefinition The EC object to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(ecDefinition: SchemaItem, messageArgs: ARGS, category?: DiagnosticCategory);
+    /** Gets the schema where the diagnostic originated. */
+    get schema(): Schema;
+    /** Gets the DiagnosticType. */
+    get diagnosticType(): DiagnosticType;
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[ECClass]] diagnostics.
+ * @beta
+ */
+export declare abstract class ClassDiagnostic<ARGS extends any[]> extends SchemaItemDiagnostic<AnyClass, ARGS> {
+    /**
+     * Initializes a new ClassDiagnostic.
+     * @param ecClass The class to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(ecClass: AnyClass, messageArgs: ARGS, category?: DiagnosticCategory);
+    /** Gets the schema where the diagnostic originated. */
+    get schema(): Schema;
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[Property]] diagnostics.
+ * @beta
+ */
+export declare abstract class PropertyDiagnostic<ARGS extends any[]> extends BaseDiagnostic<AnyProperty, ARGS> {
+    /**
+     * Initializes a new PropertyDiagnostic.
+     * @param property The property to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(property: AnyProperty, messageArgs?: ARGS, category?: DiagnosticCategory);
+    /** Gets the schema where the diagnostic originated. */
+    get schema(): Schema;
+    /** Gets the DiagnosticType. */
+    get diagnosticType(): DiagnosticType;
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[RelationshipConstraint]] diagnostics.
+ * @beta
+ */
+export declare abstract class RelationshipConstraintDiagnostic<ARGS extends any[]> extends BaseDiagnostic<RelationshipConstraint, ARGS> {
+    /**
+     * Initializes a new RelationshipConstraintDiagnostic.
+     * @param constraint The Relationship Constraint to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(constraint: RelationshipConstraint, messageArgs: ARGS, category?: DiagnosticCategory);
+    /** Gets the schema where the diagnostic originated. */
+    get schema(): Schema;
+    /** Gets the DiagnosticType. */
+    get diagnosticType(): DiagnosticType;
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[CustomAttributeContainerProps]] diagnostics.
+ * @beta
+ */
+export declare abstract class CustomAttributeContainerDiagnostic<ARGS extends any[]> extends BaseDiagnostic<CustomAttributeContainerProps, ARGS> {
+    /**
+     * Initializes a new CustomAttributeContainerDiagnostic.
+     * @param constraint The Custom Attribute Container to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(container: CustomAttributeContainerProps, messageArgs: ARGS, category?: DiagnosticCategory);
+    /** Gets the schema where the diagnostic originated. */
+    get schema(): Schema;
+    /** Gets the DiagnosticType. */
+    get diagnosticType(): DiagnosticType;
+}
+/**
+ * Helper method for creating [[SchemaDiagnostic]] child classes.
+ * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+export declare function createSchemaDiagnosticClass<ARGS extends any[]>(code: string, messageText: string): {
+    new (schema: Schema, messageArgs: ARGS, category?: DiagnosticCategory): {
+        readonly code: string;
+        readonly messageText: string;
+        /** Gets the schema where the diagnostic originated. */
+        readonly schema: Schema;
+        /** Gets the DiagnosticType. */
+        readonly diagnosticType: DiagnosticType;
+        /** The EC object to associate with the diagnostic. */
+        ecDefinition: Schema;
+        /** The arguments used when formatting the diagnostic message.  */
+        messageArgs?: ARGS | undefined;
+        /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */
+        category: DiagnosticCategory;
+    };
+    code: string;
+    diagnosticType: DiagnosticType;
+};
+/**
+ * Helper method for creating [[SchemaItemDiagnostic]] child classes.
+ * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+export declare function createSchemaItemDiagnosticClass<ITEM extends SchemaItem, ARGS extends any[]>(code: string, messageText: string): {
+    new (ecDefinition: SchemaItem, messageArgs: ARGS, category?: DiagnosticCategory): {
+        readonly code: string;
+        readonly messageText: string;
+        /** Gets the schema where the diagnostic originated. */
+        readonly schema: Schema;
+        /** Gets the DiagnosticType. */
+        readonly diagnosticType: DiagnosticType;
+        /** The EC object to associate with the diagnostic. */
+        ecDefinition: ITEM;
+        /** The arguments used when formatting the diagnostic message.  */
+        messageArgs?: ARGS | undefined;
+        /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */
+        category: DiagnosticCategory;
+    };
+    diagnosticType: DiagnosticType;
+};
+/**
+ * Helper method for creating [[ClassDiagnostic]] child classes.
+ * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+export declare function createClassDiagnosticClass<ARGS extends any[]>(code: string, messageText: string): {
+    new (ecClass: AnyClass, messageArgs: ARGS, category?: DiagnosticCategory): {
+        readonly code: string;
+        readonly messageText: string;
+        /** Gets the schema where the diagnostic originated. */
+        readonly schema: Schema;
+        /** Gets the DiagnosticType. */
+        readonly diagnosticType: DiagnosticType;
+        /** The EC object to associate with the diagnostic. */
+        ecDefinition: AnyClass;
+        /** The arguments used when formatting the diagnostic message.  */
+        messageArgs?: ARGS | undefined;
+        /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */
+        category: DiagnosticCategory;
+    };
+    diagnosticType: DiagnosticType;
+};
+/**
+ * Helper method for creating [[PropertyDiagnostic]] child classes.
+ * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+export declare function createPropertyDiagnosticClass<ARGS extends any[]>(code: string, messageText: string): {
+    new (property: AnyProperty, messageArgs?: ARGS | undefined, category?: DiagnosticCategory): {
+        readonly code: string;
+        readonly messageText: string;
+        /** Gets the schema where the diagnostic originated. */
+        readonly schema: Schema;
+        /** Gets the DiagnosticType. */
+        readonly diagnosticType: DiagnosticType;
+        /** The EC object to associate with the diagnostic. */
+        ecDefinition: AnyProperty;
+        /** The arguments used when formatting the diagnostic message.  */
+        messageArgs?: ARGS | undefined;
+        /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */
+        category: DiagnosticCategory;
+    };
+    code: string;
+};
+/**
+ * Helper method for creating [[RelationshipConstraintDiagnostic]] child classes.
+ * @param code The string that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+export declare function createRelationshipConstraintDiagnosticClass<ARGS extends any[]>(code: string, messageText: string): {
+    new (constraint: RelationshipConstraint, messageArgs: ARGS, category?: DiagnosticCategory): {
+        readonly code: string;
+        readonly messageText: string;
+        /** Gets the schema where the diagnostic originated. */
+        readonly schema: Schema;
+        /** Gets the DiagnosticType. */
+        readonly diagnosticType: DiagnosticType;
+        /** The EC object to associate with the diagnostic. */
+        ecDefinition: RelationshipConstraint;
+        /** The arguments used when formatting the diagnostic message.  */
+        messageArgs?: ARGS | undefined;
+        /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */
+        category: DiagnosticCategory;
+    };
+};
+/**
+ * Helper method for creating [[CustomAttributeContainerDiagnostic]] child classes.
+ * @param code The that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+export declare function createCustomAttributeContainerDiagnosticClass<ARGS extends any[]>(code: string, messageText: string): {
+    new (container: CustomAttributeContainerProps, messageArgs: ARGS, category?: DiagnosticCategory): {
+        readonly code: string;
+        readonly messageText: string;
+        /** Gets the schema where the diagnostic originated. */
+        readonly schema: Schema;
+        /** Gets the DiagnosticType. */
+        readonly diagnosticType: DiagnosticType;
+        /** The EC object to associate with the diagnostic. */
+        ecDefinition: CustomAttributeContainerProps;
+        /** The arguments used when formatting the diagnostic message.  */
+        messageArgs?: ARGS | undefined;
+        /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */
+        category: DiagnosticCategory;
+    };
+};
+/** @beta */
+export declare function diagnosticCategoryToString(category: DiagnosticCategory): "Error" | "Warning" | "Message" | "Suggestion";
+/** @beta */
+export declare function diagnosticTypeToString(type: DiagnosticType): "CustomAttributeContainer" | "None" | "Property" | "RelationshipConstraint" | "Schema" | "SchemaItem";
+//# sourceMappingURL=Diagnostic.d.ts.map

package/lib/Validation/Diagnostic.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Diagnostic.d.ts","sourceRoot":"","sources":["../../src/Validation/Diagnostic.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,6BAA6B,EAAE,sBAAsB,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAYvJ;;;GAGG;AACH,oBAAY,cAAc;IACxB,IAAI,IAAA;IACJ,MAAM,IAAA;IACN,UAAU,IAAA;IACV,QAAQ,IAAA;IACR,wBAAwB,IAAA;IACxB,sBAAsB,IAAA;CACvB;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,OAAO,IAAA;IACP,KAAK,IAAA;IACL,UAAU,IAAA;IACV,OAAO,IAAA;CACR;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,IAAI,SAAS,SAAS,EAAE,IAAI,SAAS,GAAG,EAAE;IACrE,8FAA8F;IAC9F,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,kIAAkI;IAClI,IAAI,EAAE,MAAM,CAAC;IACb,oHAAoH;IACpH,cAAc,EAAE,cAAc,CAAC;IAC/B,yGAAyG;IACzG,WAAW,EAAE,MAAM,CAAC;IACpB,2EAA2E;IAC3E,WAAW,CAAC,EAAE,IAAI,CAAC;IACnB,6DAA6D;IAC7D,YAAY,EAAE,IAAI,CAAC;IACnB,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,oBAAY,aAAa,GAAG,WAAW,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;AAE1D;;;GAGG;AACH,8BAAsB,cAAc,CAAC,IAAI,SAAS,SAAS,EAAE,IAAI,SAAS,GAAG,EAAE,CAAE,YAAW,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC;IACjH;;;;;OAKG;gBACS,YAAY,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE,IAAI,EAAE,QAAQ,GAAE,kBAA6C;IAM3G,mGAAmG;IACnG,aAAoB,IAAI,IAAI,MAAM,CAAC;IACnC,sFAAsF;IACtF,aAAoB,cAAc,IAAI,cAAc,CAAC;IACrD,uDAAuD;IACvD,aAAoB,WAAW,IAAI,MAAM,CAAC;IAC1C,uDAAuD;IACvD,aAAoB,MAAM,IAAI,MAAM,CAAC;IAErC,sDAAsD;IAC/C,YAAY,EAAE,IAAI,CAAC;IAC1B,kEAAkE;IAC3D,WAAW,CAAC,EAAE,IAAI,CAAC;IAC1B,4GAA4G;IACrG,QAAQ,EAAE,kBAAkB,CAAC;CACrC;AAED;;;GAGG;AACH,8BAAsB,gBAAgB,CAAC,IAAI,SAAS,GAAG,EAAE,CAAE,SAAQ,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC;IAC7F,OAAc,cAAc,iBAA6B;IAEzD;;;;;OAKG;gBACS,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,GAAE,kBAA6C;IAItG,uDAAuD;IACvD,IAAW,MAAM,IAAI,MAAM,CAA8B;IAEzD,+BAA+B;IAC/B,IAAW,cAAc,IAAI,cAAc,CAAkC;CAC9E;AAED;;;GAGG;AACH,8BAAsB,oBAAoB,CAAC,IAAI,SAAS,UAAU,EAAE,IAAI,SAAS,GAAG,EAAE,CAAE,SAAQ,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC;IACxH,OAAc,cAAc,iBAA6B;IACzD;;;;;OAKG;gBACS,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,GAAE,kBAA6C;IAIhH,uDAAuD;IACvD,IAAW,MAAM,IAAI,MAAM,CAAqC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,IAAI,cAAc,CAAsC;CAClF;AAED;;;GAGG;AACH,8BAAsB,eAAe,CAAC,IAAI,SAAS,GAAG,EAAE,CAAE,SAAQ,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC;IACpG;;;;;OAKG;gBACS,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,GAAE,kBAA6C;IAIzG,uDAAuD;IACvD,IAAoB,MAAM,IAAI,MAAM,CAAqC;CAC1E;AAED;;;GAGG;AACH,8BAAsB,kBAAkB,CAAC,IAAI,SAAS,GAAG,EAAE,CAAE,SAAQ,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC;IACpG;;;;;OAKG;gBACS,QAAQ,EAAE,WAAW,EAAE,WAAW,CAAC,EAAE,IAAI,EAAE,QAAQ,GAAE,kBAA6C;IAI9G,uDAAuD;IACvD,IAAW,MAAM,IAAI,MAAM,CAAqC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,IAAI,cAAc,CAAoC;CAChF;AAED;;;GAGG;AACH,8BAAsB,gCAAgC,CAAC,IAAI,SAAS,GAAG,EAAE,CAAE,SAAQ,cAAc,CAAC,sBAAsB,EAAE,IAAI,CAAC;IAC7H;;;;;OAKG;gBACS,UAAU,EAAE,sBAAsB,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,GAAE,kBAA6C;IAI1H,uDAAuD;IACvD,IAAW,MAAM,IAAI,MAAM,CAAqC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,IAAI,cAAc,CAAkD;CAC9F;AAED;;;GAGG;AACH,8BAAsB,kCAAkC,CAAC,IAAI,SAAS,GAAG,EAAE,CAAE,SAAQ,cAAc,CAAC,6BAA6B,EAAE,IAAI,CAAC;IACtI;;;;;OAKG;gBACS,SAAS,EAAE,6BAA6B,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,GAAE,kBAA6C;IAIhI,uDAAuD;IACvD,IAAW,MAAM,IAAI,MAAM,CAAqC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,IAAI,cAAc,CAAoD;CAChG;AAED;;;;;GAKG;AACH,wBAAgB,2BAA2B,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;;;;QAzH/F,uDAAuD;;QAGvD,+BAA+B;;QA5B/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;;;;;EAqJ7G;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,IAAI,SAAS,UAAU,EAAE,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;;;;QAjH5H,uDAAuD;;QAGvD,+BAA+B;;QAnD/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;;;;EAmK7G;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;;;;QAzG9F,uDAAuD;;QAnBvD,+BAA+B;;QAnD/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;;;;EAiL7G;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;;;;QApGjG,uDAAuD;;QAGvD,+BAA+B;;QA5F/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;;;;EAgM7G;AAED;;;;;GAKG;AACH,wBAAgB,2CAA2C,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;;;;QA7F/G,uDAAuD;;QAGvD,+BAA+B;;QAlH/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;;;EA8M7G;AAED;;;;;GAKG;AACH,wBAAgB,6CAA6C,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;;;;QArFjH,uDAAuD;;QAGvD,+BAA+B;;QAxI/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;;;EA4N7G;AAED,YAAY;AACZ,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,kBAAkB,kDAWtE;AAED,YAAY;AACZ,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,cAAc,yGAe1D"}

package/lib/Validation/Diagnostic.js

@@ -0,0 +1,311 @@
+"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 Diagnostic
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.diagnosticTypeToString = exports.diagnosticCategoryToString = exports.createCustomAttributeContainerDiagnosticClass = exports.createRelationshipConstraintDiagnosticClass = exports.createPropertyDiagnosticClass = exports.createClassDiagnosticClass = exports.createSchemaItemDiagnosticClass = exports.createSchemaDiagnosticClass = exports.CustomAttributeContainerDiagnostic = exports.RelationshipConstraintDiagnostic = exports.PropertyDiagnostic = exports.ClassDiagnostic = exports.SchemaItemDiagnostic = exports.SchemaDiagnostic = exports.BaseDiagnostic = exports.DiagnosticCategory = exports.DiagnosticType = void 0;
+/* eslint-disable @typescript-eslint/no-shadow */
+const formatString = (format, ...args) => {
+    return format.replace(/{(\d+)}/g, (match, theNumber) => {
+        return typeof args[theNumber] !== "undefined"
+            ? args[theNumber]
+            : match;
+    });
+};
+/**
+ * Defines the possible diagnostic types.
+ * @beta
+ */
+var DiagnosticType;
+(function (DiagnosticType) {
+    DiagnosticType[DiagnosticType["None"] = 0] = "None";
+    DiagnosticType[DiagnosticType["Schema"] = 1] = "Schema";
+    DiagnosticType[DiagnosticType["SchemaItem"] = 2] = "SchemaItem";
+    DiagnosticType[DiagnosticType["Property"] = 3] = "Property";
+    DiagnosticType[DiagnosticType["CustomAttributeContainer"] = 4] = "CustomAttributeContainer";
+    DiagnosticType[DiagnosticType["RelationshipConstraint"] = 5] = "RelationshipConstraint";
+})(DiagnosticType = exports.DiagnosticType || (exports.DiagnosticType = {}));
+/**
+ * Defines the possible diagnostic categories.
+ * @beta
+ */
+var DiagnosticCategory;
+(function (DiagnosticCategory) {
+    DiagnosticCategory[DiagnosticCategory["Warning"] = 0] = "Warning";
+    DiagnosticCategory[DiagnosticCategory["Error"] = 1] = "Error";
+    DiagnosticCategory[DiagnosticCategory["Suggestion"] = 2] = "Suggestion";
+    DiagnosticCategory[DiagnosticCategory["Message"] = 3] = "Message";
+})(DiagnosticCategory = exports.DiagnosticCategory || (exports.DiagnosticCategory = {}));
+/**
+ * The abstract base class for all [[IDiagnostic]] implementations.
+ * @beta
+ */
+class BaseDiagnostic {
+    /**
+     * Initializes a new BaseDiagnostic.
+     * @param ecDefinition The EC object to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(ecDefinition, messageArgs, category = DiagnosticCategory.Error) {
+        this.ecDefinition = ecDefinition;
+        this.messageArgs = messageArgs;
+        this.category = category;
+    }
+}
+exports.BaseDiagnostic = BaseDiagnostic;
+/**
+ * An [[IDiagnostic]] implementation used for [[Schema]] diagnostics.
+ * @beta
+ */
+class SchemaDiagnostic extends BaseDiagnostic {
+    /**
+     * Initializes a new SchemaDiagnostic.
+     * @param ecDefinition The EC object to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(schema, messageArgs, category = DiagnosticCategory.Error) {
+        super(schema, messageArgs, category);
+    }
+    /** Gets the schema where the diagnostic originated. */
+    get schema() { return this.ecDefinition; }
+    /** Gets the DiagnosticType. */
+    get diagnosticType() { return DiagnosticType.Schema; }
+}
+exports.SchemaDiagnostic = SchemaDiagnostic;
+SchemaDiagnostic.diagnosticType = DiagnosticType.SchemaItem;
+/**
+ * An [[IDiagnostic]] implementation used for [[SchemaItem]] diagnostics.
+ * @beta
+ */
+class SchemaItemDiagnostic extends BaseDiagnostic {
+    /**
+     * Initializes a new SchemaItemDiagnostic.
+     * @param ecDefinition The EC object to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(ecDefinition, messageArgs, category = DiagnosticCategory.Error) {
+        super(ecDefinition, messageArgs, category);
+    }
+    /** Gets the schema where the diagnostic originated. */
+    get schema() { return this.ecDefinition.schema; }
+    /** Gets the DiagnosticType. */
+    get diagnosticType() { return DiagnosticType.SchemaItem; }
+}
+exports.SchemaItemDiagnostic = SchemaItemDiagnostic;
+SchemaItemDiagnostic.diagnosticType = DiagnosticType.SchemaItem;
+/**
+ * An [[IDiagnostic]] implementation used for [[ECClass]] diagnostics.
+ * @beta
+ */
+class ClassDiagnostic extends SchemaItemDiagnostic {
+    /**
+     * Initializes a new ClassDiagnostic.
+     * @param ecClass The class to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(ecClass, messageArgs, category = DiagnosticCategory.Error) {
+        super(ecClass, messageArgs, category);
+    }
+    /** Gets the schema where the diagnostic originated. */
+    get schema() { return this.ecDefinition.schema; }
+}
+exports.ClassDiagnostic = ClassDiagnostic;
+/**
+ * An [[IDiagnostic]] implementation used for [[Property]] diagnostics.
+ * @beta
+ */
+class PropertyDiagnostic extends BaseDiagnostic {
+    /**
+     * Initializes a new PropertyDiagnostic.
+     * @param property The property to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(property, messageArgs, category = DiagnosticCategory.Error) {
+        super(property, messageArgs, category);
+    }
+    /** Gets the schema where the diagnostic originated. */
+    get schema() { return this.ecDefinition.schema; }
+    /** Gets the DiagnosticType. */
+    get diagnosticType() { return DiagnosticType.Property; }
+}
+exports.PropertyDiagnostic = PropertyDiagnostic;
+/**
+ * An [[IDiagnostic]] implementation used for [[RelationshipConstraint]] diagnostics.
+ * @beta
+ */
+class RelationshipConstraintDiagnostic extends BaseDiagnostic {
+    /**
+     * Initializes a new RelationshipConstraintDiagnostic.
+     * @param constraint The Relationship Constraint to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(constraint, messageArgs, category = DiagnosticCategory.Error) {
+        super(constraint, messageArgs, category);
+    }
+    /** Gets the schema where the diagnostic originated. */
+    get schema() { return this.ecDefinition.schema; }
+    /** Gets the DiagnosticType. */
+    get diagnosticType() { return DiagnosticType.RelationshipConstraint; }
+}
+exports.RelationshipConstraintDiagnostic = RelationshipConstraintDiagnostic;
+/**
+ * An [[IDiagnostic]] implementation used for [[CustomAttributeContainerProps]] diagnostics.
+ * @beta
+ */
+class CustomAttributeContainerDiagnostic extends BaseDiagnostic {
+    /**
+     * Initializes a new CustomAttributeContainerDiagnostic.
+     * @param constraint The Custom Attribute Container to associate with the diagnostic.
+     * @param messageArgs The arguments used when formatting the diagnostic message.
+     * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.
+     */
+    constructor(container, messageArgs, category = DiagnosticCategory.Error) {
+        super(container, messageArgs, category);
+    }
+    /** Gets the schema where the diagnostic originated. */
+    get schema() { return this.ecDefinition.schema; }
+    /** Gets the DiagnosticType. */
+    get diagnosticType() { return DiagnosticType.CustomAttributeContainer; }
+}
+exports.CustomAttributeContainerDiagnostic = CustomAttributeContainerDiagnostic;
+/**
+ * Helper method for creating [[SchemaDiagnostic]] child classes.
+ * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+function createSchemaDiagnosticClass(code, messageText) {
+    var _a;
+    validateCode(code);
+    return _a = class extends SchemaDiagnostic {
+            get code() { return code; }
+            get messageText() { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }
+        },
+        _a.code = code,
+        _a;
+}
+exports.createSchemaDiagnosticClass = createSchemaDiagnosticClass;
+/**
+ * Helper method for creating [[SchemaItemDiagnostic]] child classes.
+ * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+function createSchemaItemDiagnosticClass(code, messageText) {
+    validateCode(code);
+    return class extends SchemaItemDiagnostic {
+        get code() { return code; }
+        get messageText() { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }
+    };
+}
+exports.createSchemaItemDiagnosticClass = createSchemaItemDiagnosticClass;
+/**
+ * Helper method for creating [[ClassDiagnostic]] child classes.
+ * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+function createClassDiagnosticClass(code, messageText) {
+    validateCode(code);
+    return class extends ClassDiagnostic {
+        get code() { return code; }
+        get messageText() { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }
+    };
+}
+exports.createClassDiagnosticClass = createClassDiagnosticClass;
+/**
+ * Helper method for creating [[PropertyDiagnostic]] child classes.
+ * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+function createPropertyDiagnosticClass(code, messageText) {
+    var _a;
+    validateCode(code);
+    return _a = class extends PropertyDiagnostic {
+            get code() { return code; }
+            get messageText() { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }
+        },
+        _a.code = code,
+        _a;
+}
+exports.createPropertyDiagnosticClass = createPropertyDiagnosticClass;
+/**
+ * Helper method for creating [[RelationshipConstraintDiagnostic]] child classes.
+ * @param code The string that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+function createRelationshipConstraintDiagnosticClass(code, messageText) {
+    validateCode(code);
+    return class extends RelationshipConstraintDiagnostic {
+        get code() { return code; }
+        get messageText() { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }
+    };
+}
+exports.createRelationshipConstraintDiagnosticClass = createRelationshipConstraintDiagnosticClass;
+/**
+ * Helper method for creating [[CustomAttributeContainerDiagnostic]] child classes.
+ * @param code The that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.
+ * @param messageText The message to associate with the diagnostic class.
+ * @beta
+ */
+function createCustomAttributeContainerDiagnosticClass(code, messageText) {
+    validateCode(code);
+    return class extends CustomAttributeContainerDiagnostic {
+        get code() { return code; }
+        get messageText() { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }
+    };
+}
+exports.createCustomAttributeContainerDiagnosticClass = createCustomAttributeContainerDiagnosticClass;
+/** @beta */
+function diagnosticCategoryToString(category) {
+    switch (category) {
+        case DiagnosticCategory.Error:
+            return "Error";
+        case DiagnosticCategory.Warning:
+            return "Warning";
+        case DiagnosticCategory.Message:
+            return "Message";
+        case DiagnosticCategory.Suggestion:
+            return "Suggestion";
+    }
+}
+exports.diagnosticCategoryToString = diagnosticCategoryToString;
+/** @beta */
+function diagnosticTypeToString(type) {
+    switch (type) {
+        case DiagnosticType.CustomAttributeContainer:
+            return "CustomAttributeContainer";
+        case DiagnosticType.None:
+            return "None";
+        case DiagnosticType.Property:
+            return "Property";
+        case DiagnosticType.RelationshipConstraint:
+            return "RelationshipConstraint";
+        case DiagnosticType.Schema:
+            return "Schema";
+        case DiagnosticType.SchemaItem:
+            return "SchemaItem";
+    }
+}
+exports.diagnosticTypeToString = diagnosticTypeToString;
+function validateCode(code) {
+    const msg = `Diagnostic code ${code} is invalid. Expected the format <ruleSetName>-<number>.`;
+    const parts = code.split("-");
+    if (parts.length !== 2)
+        throw new Error(msg);
+    if (isNaN(Number(parts[1])))
+        throw new Error(msg);
+}
+//# sourceMappingURL=Diagnostic.js.map