@itwin/ecschema-editing 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/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 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/esm/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,MAAM,MAAM,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;iBA7H3E,MAAM,gCAA+B,kBAAkB;;;QAI3E,uDAAuD;;QAGvD,+BAA+B;;QA5B/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;kBAC3F,kBAAkB;;;;EAoJpC;AAED;;;;;GAKG;AACH,wBAAgB,+BAA+B,CAAC,IAAI,SAAS,UAAU,EAAE,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;uBArHlG,UAAU,gCAA+B,kBAAkB;;;QAIrF,uDAAuD;;QAGvD,+BAA+B;;QAnD/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;kBAC3F,kBAAkB;;;EAkKpC;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;kBA7GzE,QAAQ,gCAA+B,kBAAkB;;;QAI9E,uDAAuD;;QAnBvD,+BAA+B;;QAnD/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;kBAC3F,kBAAkB;;;EAgLpC;AAED;;;;;GAKG;AACH,wBAAgB,6BAA6B,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;mBAxG3E,WAAW,6CAAgC,kBAAkB;;;QAInF,uDAAuD;;QAGvD,+BAA+B;;QA5F/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;kBAC3F,kBAAkB;;;EA+LpC;AAED;;;;;GAKG;AACH,wBAAgB,2CAA2C,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;qBAjGvF,sBAAsB,gCAA+B,kBAAkB;;;QAI/F,uDAAuD;;QAGvD,+BAA+B;;QAlH/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;kBAC3F,kBAAkB;;EA6MpC;AAED;;;;;GAKG;AACH,wBAAgB,6CAA6C,CAAC,IAAI,SAAS,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;oBAzF1F,6BAA6B,gCAA+B,kBAAkB;;;QAIrG,uDAAuD;;QAGvD,+BAA+B;;QAxI/B,sDAAsD;;QAEtD,kEAAkE;;QAElE,4GAA4G;kBAC3F,kBAAkB;;EA2NpC;AAED,YAAY;AACZ,wBAAgB,0BAA0B,CAAC,QAAQ,EAAE,kBAAkB,kDAWtE;AAED,YAAY;AACZ,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,cAAc,yGAe1D"}

package/lib/esm/Validation/Diagnostic.js

@@ -0,0 +1,295 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/* 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
+ */
+export 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 || (DiagnosticType = {}));
+/**
+ * Defines the possible diagnostic categories.
+ * @beta
+ */
+export 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 || (DiagnosticCategory = {}));
+/**
+ * The abstract base class for all [[IDiagnostic]] implementations.
+ * @beta
+ */
+export 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;
+    }
+    /** The EC object to associate with the diagnostic. */
+    ecDefinition;
+    /** The arguments used when formatting the diagnostic message.  */
+    messageArgs;
+    /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */
+    category;
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[Schema]] diagnostics.
+ * @beta
+ */
+export class SchemaDiagnostic extends BaseDiagnostic {
+    static diagnosticType = DiagnosticType.SchemaItem;
+    /**
+     * 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; }
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[SchemaItem]] diagnostics.
+ * @beta
+ */
+export class SchemaItemDiagnostic extends BaseDiagnostic {
+    static diagnosticType = DiagnosticType.SchemaItem;
+    /**
+     * 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; }
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[ECClass]] diagnostics.
+ * @beta
+ */
+export 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; }
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[Property]] diagnostics.
+ * @beta
+ */
+export 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; }
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[RelationshipConstraint]] diagnostics.
+ * @beta
+ */
+export 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; }
+}
+/**
+ * An [[IDiagnostic]] implementation used for [[CustomAttributeContainerProps]] diagnostics.
+ * @beta
+ */
+export 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; }
+}
+/**
+ * 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 function createSchemaDiagnosticClass(code, messageText) {
+    validateCode(code);
+    return class extends SchemaDiagnostic {
+        static code = code;
+        get code() { return code; }
+        get messageText() { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }
+    };
+}
+/**
+ * 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 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); }
+    };
+}
+/**
+ * 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 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); }
+    };
+}
+/**
+ * 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 function createPropertyDiagnosticClass(code, messageText) {
+    validateCode(code);
+    return class extends PropertyDiagnostic {
+        static code = code;
+        get code() { return code; }
+        get messageText() { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }
+    };
+}
+/**
+ * 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 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); }
+    };
+}
+/**
+ * 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 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); }
+    };
+}
+/** @beta */
+export 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";
+    }
+}
+/** @beta */
+export 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";
+    }
+}
+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