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

package/lib/esm/Validation/Diagnostic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Diagnostic.js","sourceRoot":"","sources":["../../../src/Validation/Diagnostic.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH,iDAAiD;AAEjD,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,GAAG,IAAc,EAAE,EAAE;IACzD,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACrD,OAAO,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,WAAW;YAC3C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;YACjB,CAAC,CAAC,KAAK,CAAC;IACZ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAN,IAAY,cAOX;AAPD,WAAY,cAAc;IACxB,mDAAI,CAAA;IACJ,uDAAM,CAAA;IACN,+DAAU,CAAA;IACV,2DAAQ,CAAA;IACR,2FAAwB,CAAA;IACxB,uFAAsB,CAAA;AACxB,CAAC,EAPW,cAAc,KAAd,cAAc,QAOzB;AAED;;;GAGG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,iEAAO,CAAA;IACP,6DAAK,CAAA;IACL,uEAAU,CAAA;IACV,iEAAO,CAAA;AACT,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AA6BD;;;GAGG;AACH,MAAM,OAAgB,cAAc;IAClC;;;;;OAKG;IACH,YAAY,YAAkB,EAAE,WAAkB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACzG,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAWD,sDAAsD;IAC/C,YAAY,CAAO;IAC1B,kEAAkE;IAC3D,WAAW,CAAQ;IAC1B,4GAA4G;IACrG,QAAQ,CAAqB;CACrC;AAED;;;GAGG;AACH,MAAM,OAAgB,gBAAqC,SAAQ,cAA4B;IACtF,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC;IAEzD;;;;;OAKG;IACH,YAAY,MAAc,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACpG,KAAK,CAAC,MAAM,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAEzD,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;;AAG/E;;;GAGG;AACH,MAAM,OAAgB,oBAAkE,SAAQ,cAA0B;IACjH,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,UAAU,CAAC;IACzD;;;;;OAKG;IACH,YAAY,YAAwB,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QAC9G,KAAK,CAAC,YAAoB,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACrD,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC;;AAGnF;;;GAGG;AACH,MAAM,OAAgB,eAAoC,SAAQ,oBAAoC;IACpG;;;;;OAKG;IACH,YAAY,OAAiB,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACvG,KAAK,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,uDAAuD;IACvD,IAAoB,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;CAC1E;AAED;;;GAGG;AACH,MAAM,OAAgB,kBAAuC,SAAQ,cAAiC;IACpG;;;;;OAKG;IACH,YAAY,QAAqB,EAAE,WAAkB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QAC5G,KAAK,CAAC,QAAQ,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;CAChF;AAED;;;GAGG;AACH,MAAM,OAAgB,gCAAqD,SAAQ,cAA4C;IAC7H;;;;;OAKG;IACH,YAAY,UAAkC,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QACxH,KAAK,CAAC,UAAU,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,sBAAsB,CAAC,CAAC,CAAC;CAC9F;AAED;;;GAGG;AACH,MAAM,OAAgB,kCAAuD,SAAQ,cAAmD;IACtI;;;;;OAKG;IACH,YAAY,SAAwC,EAAE,WAAiB,EAAE,WAA+B,kBAAkB,CAAC,KAAK;QAC9H,KAAK,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IAED,uDAAuD;IACvD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IAEhE,+BAA+B;IAC/B,IAAW,cAAc,KAAqB,OAAO,cAAc,CAAC,wBAAwB,CAAC,CAAC,CAAC;CAChG;AAED;;;;;GAKG;AACH,MAAM,UAAU,2BAA2B,CAAqB,IAAY,EAAE,WAAmB;IAC/F,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,gBAAsB;QAClC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QAC1B,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,+BAA+B,CAA8C,IAAY,EAAE,WAAmB;IAC5H,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,oBAAgC;QACnD,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAqB,IAAY,EAAE,WAAmB;IAC9F,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,eAAqB;QACxC,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,6BAA6B,CAAqB,IAAY,EAAE,WAAmB;IACjG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,kBAAwB;QACpC,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QAC1B,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,2CAA2C,CAAqB,IAAY,EAAE,WAAmB;IAC/G,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,gCAAsC;QACzD,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,6CAA6C,CAAqB,IAAY,EAAE,WAAmB;IACjH,YAAY,CAAC,IAAI,CAAC,CAAC;IACnB,OAAO,KAAM,SAAQ,kCAAwC;QAC3D,IAAW,IAAI,KAAa,OAAO,IAAI,CAAC,CAAC,CAAC;QAC1C,IAAW,WAAW,KAAa,OAAO,SAAS,KAAK,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;KAC3I,CAAC;AACJ,CAAC;AAED,YAAY;AACZ,MAAM,UAAU,0BAA0B,CAAC,QAA4B;IACrE,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,kBAAkB,CAAC,KAAK;YAC3B,OAAO,OAAO,CAAC;QACjB,KAAK,kBAAkB,CAAC,OAAO;YAC7B,OAAO,SAAS,CAAC;QACnB,KAAK,kBAAkB,CAAC,OAAO;YAC7B,OAAO,SAAS,CAAC;QACnB,KAAK,kBAAkB,CAAC,UAAU;YAChC,OAAO,YAAY,CAAC;IACxB,CAAC;AACH,CAAC;AAED,YAAY;AACZ,MAAM,UAAU,sBAAsB,CAAC,IAAoB;IACzD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,cAAc,CAAC,wBAAwB;YAC1C,OAAO,0BAA0B,CAAC;QACpC,KAAK,cAAc,CAAC,IAAI;YACtB,OAAO,MAAM,CAAC;QAChB,KAAK,cAAc,CAAC,QAAQ;YAC1B,OAAO,UAAU,CAAC;QACpB,KAAK,cAAc,CAAC,sBAAsB;YACxC,OAAO,wBAAwB,CAAC;QAClC,KAAK,cAAc,CAAC,MAAM;YACxB,OAAO,QAAQ,CAAC;QAClB,KAAK,cAAc,CAAC,UAAU;YAC5B,OAAO,YAAY,CAAC;IACxB,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,GAAG,GAAG,mBAAmB,IAAI,0DAA0D,CAAC;IAC9F,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;IAEvB,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC","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 Diagnostic\n */\n\nimport { AnyClass, AnyECType, AnyProperty, CustomAttributeContainerProps, RelationshipConstraint, Schema, SchemaItem } from \"@itwin/ecschema-metadata\";\n\n/* eslint-disable @typescript-eslint/no-shadow */\n\nconst formatString = (format: string, ...args: string[]) => {\n  return format.replace(/{(\\d+)}/g, (match, theNumber) => {\n    return typeof args[theNumber] !== \"undefined\"\n      ? args[theNumber]\n      : match;\n  });\n};\n\n/**\n * Defines the possible diagnostic types.\n * @beta\n */\nexport enum DiagnosticType {\n  None,\n  Schema,\n  SchemaItem,\n  Property,\n  CustomAttributeContainer,\n  RelationshipConstraint,\n}\n\n/**\n * Defines the possible diagnostic categories.\n * @beta\n */\nexport enum DiagnosticCategory {\n  Warning,\n  Error,\n  Suggestion,\n  Message,\n}\n\n/**\n * The interface implemented by all diagnostics used during schema validation.\n * @beta\n */\nexport interface IDiagnostic<TYPE extends AnyECType, ARGS extends any[]> {\n  /** The diagnostic category (error, warning, etc...). Value is static across all instances. */\n  category: DiagnosticCategory;\n  /** The unique string identifier of the diagnostic in the format '<ruleSetName>:<number>. Value is static across all instances. */\n  code: string;\n  /** The context type of diagnostic (schema, schema item, property, etc...). Value is static across all instances. */\n  diagnosticType: DiagnosticType;\n  /** The unformatted message text associated with the diagnostic. Value is static across all instances. */\n  messageText: string;\n  /** The arguments used when formatted the diagnostic instance's message. */\n  messageArgs?: ARGS;\n  /** The EC object associated with the diagnostic instance. */\n  ecDefinition: TYPE;\n  /** The schema where the diagnostic originated. */\n  schema: Schema;\n}\n\n/**\n * Type which encapsulates all possible diagnostics.\n * @beta\n */\nexport type AnyDiagnostic = IDiagnostic<AnyECType, any[]>;\n\n/**\n * The abstract base class for all [[IDiagnostic]] implementations.\n * @beta\n */\nexport abstract class BaseDiagnostic<TYPE extends AnyECType, ARGS extends any[]> implements IDiagnostic<TYPE, ARGS> {\n  /**\n   * Initializes a new BaseDiagnostic.\n   * @param ecDefinition The EC object to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(ecDefinition: TYPE, messageArgs?: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    this.ecDefinition = ecDefinition;\n    this.messageArgs = messageArgs;\n    this.category = category;\n  }\n\n  /** Gets the unique string identifier for the diagnostic in the format '<ruleSetName>:<number>'. */\n  public abstract get code(): string;\n  /** Gets the context type of the diagnostic (schema, schema item, property, etc...) */\n  public abstract get diagnosticType(): DiagnosticType;\n  /** Gets the message associated with the diagnostic. */\n  public abstract get messageText(): string;\n  /** Gets the schema where the diagnostic originated. */\n  public abstract get schema(): Schema;\n\n  /** The EC object to associate with the diagnostic. */\n  public ecDefinition: TYPE;\n  /** The arguments used when formatting the diagnostic message.  */\n  public messageArgs?: ARGS;\n  /** The diagnostic category is of the type DiagnosticCategory; which is defined as an enumeration above.  */\n  public category: DiagnosticCategory;\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[Schema]] diagnostics.\n * @beta\n */\nexport abstract class SchemaDiagnostic<ARGS extends any[]> extends BaseDiagnostic<Schema, ARGS> {\n  public static diagnosticType = DiagnosticType.SchemaItem;\n\n  /**\n   * Initializes a new SchemaDiagnostic.\n   * @param ecDefinition The EC object to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(schema: Schema, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(schema, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.Schema; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[SchemaItem]] diagnostics.\n * @beta\n */\nexport abstract class SchemaItemDiagnostic<TYPE extends SchemaItem, ARGS extends any[]> extends BaseDiagnostic<TYPE, ARGS> {\n  public static diagnosticType = DiagnosticType.SchemaItem;\n  /**\n   * Initializes a new SchemaItemDiagnostic.\n   * @param ecDefinition The EC object to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(ecDefinition: SchemaItem, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(ecDefinition as TYPE, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.SchemaItem; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[ECClass]] diagnostics.\n * @beta\n */\nexport abstract class ClassDiagnostic<ARGS extends any[]> extends SchemaItemDiagnostic<AnyClass, ARGS> {\n  /**\n   * Initializes a new ClassDiagnostic.\n   * @param ecClass The class to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(ecClass: AnyClass, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(ecClass, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public override get schema(): Schema { return this.ecDefinition.schema; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[Property]] diagnostics.\n * @beta\n */\nexport abstract class PropertyDiagnostic<ARGS extends any[]> extends BaseDiagnostic<AnyProperty, ARGS> {\n  /**\n   * Initializes a new PropertyDiagnostic.\n   * @param property The property to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(property: AnyProperty, messageArgs?: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(property, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.Property; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[RelationshipConstraint]] diagnostics.\n * @beta\n */\nexport abstract class RelationshipConstraintDiagnostic<ARGS extends any[]> extends BaseDiagnostic<RelationshipConstraint, ARGS> {\n  /**\n   * Initializes a new RelationshipConstraintDiagnostic.\n   * @param constraint The Relationship Constraint to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(constraint: RelationshipConstraint, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(constraint, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.RelationshipConstraint; }\n}\n\n/**\n * An [[IDiagnostic]] implementation used for [[CustomAttributeContainerProps]] diagnostics.\n * @beta\n */\nexport abstract class CustomAttributeContainerDiagnostic<ARGS extends any[]> extends BaseDiagnostic<CustomAttributeContainerProps, ARGS> {\n  /**\n   * Initializes a new CustomAttributeContainerDiagnostic.\n   * @param constraint The Custom Attribute Container to associate with the diagnostic.\n   * @param messageArgs The arguments used when formatting the diagnostic message.\n   * @param category The [[DiagnosticCategory]] to associate with the diagnostic, Error by default.\n   */\n  constructor(container: CustomAttributeContainerProps, messageArgs: ARGS, category: DiagnosticCategory = DiagnosticCategory.Error) {\n    super(container, messageArgs, category);\n  }\n\n  /** Gets the schema where the diagnostic originated. */\n  public get schema(): Schema { return this.ecDefinition.schema; }\n\n  /** Gets the DiagnosticType. */\n  public get diagnosticType(): DiagnosticType { return DiagnosticType.CustomAttributeContainer; }\n}\n\n/**\n * Helper method for creating [[SchemaDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createSchemaDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends SchemaDiagnostic<ARGS> {\n    public static code = code;\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[SchemaItemDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createSchemaItemDiagnosticClass<ITEM extends SchemaItem, ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends SchemaItemDiagnostic<ITEM, ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[ClassDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createClassDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends ClassDiagnostic<ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[PropertyDiagnostic]] child classes.\n * @param code The string that uniquely identifies the diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createPropertyDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends PropertyDiagnostic<ARGS> {\n    public static code = code;\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[RelationshipConstraintDiagnostic]] child classes.\n * @param code The string that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createRelationshipConstraintDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends RelationshipConstraintDiagnostic<ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/**\n * Helper method for creating [[CustomAttributeContainerDiagnostic]] child classes.\n * @param code The that uniquely identifies the type of diagnostic in the format '<ruleSetName>:<number>'.\n * @param messageText The message to associate with the diagnostic class.\n * @beta\n */\nexport function createCustomAttributeContainerDiagnosticClass<ARGS extends any[]>(code: string, messageText: string) {\n  validateCode(code);\n  return class extends CustomAttributeContainerDiagnostic<ARGS> {\n    public get code(): string { return code; }\n    public get messageText(): string { return undefined === this.messageArgs ? messageText : formatString(messageText, ...this.messageArgs); }\n  };\n}\n\n/** @beta */\nexport function diagnosticCategoryToString(category: DiagnosticCategory) {\n  switch (category) {\n    case DiagnosticCategory.Error:\n      return \"Error\";\n    case DiagnosticCategory.Warning:\n      return \"Warning\";\n    case DiagnosticCategory.Message:\n      return \"Message\";\n    case DiagnosticCategory.Suggestion:\n      return \"Suggestion\";\n  }\n}\n\n/** @beta */\nexport function diagnosticTypeToString(type: DiagnosticType) {\n  switch (type) {\n    case DiagnosticType.CustomAttributeContainer:\n      return \"CustomAttributeContainer\";\n    case DiagnosticType.None:\n      return \"None\";\n    case DiagnosticType.Property:\n      return \"Property\";\n    case DiagnosticType.RelationshipConstraint:\n      return \"RelationshipConstraint\";\n    case DiagnosticType.Schema:\n      return \"Schema\";\n    case DiagnosticType.SchemaItem:\n      return \"SchemaItem\";\n  }\n}\n\nfunction validateCode(code: string) {\n  const msg = `Diagnostic code ${code} is invalid. Expected the format <ruleSetName>-<number>.`;\n  const parts = code.split(\"-\");\n  if (parts.length !== 2)\n    throw new Error(msg);\n\n  if (isNaN(Number(parts[1])))\n    throw new Error(msg);\n}\n"]}

package/lib/esm/Validation/DiagnosticReporter.d.ts

@@ -0,0 +1,97 @@
+/** @packageDocumentation
+ * @module Diagnostic
+ */
+import { Localization } from "@itwin/core-common";
+import { AnyDiagnostic } from "./Diagnostic";
+/**
+ * Interface used to report [[IDiagnostic]] objects created during schema validation.
+ * @beta
+ */
+export interface IDiagnosticReporter {
+    /**
+     * A map where the key is a schema full name and the value is a collection
+     * of diagnostics codes identifying which rules violations to ignore during validation.
+     */
+    suppressions?: Map<string, string[]>;
+    /** The localization object to use for message translation. */
+    localization?: Localization;
+    /**
+     * Handles the given [[IDiagnostic]] based on the implementation requirements for a
+     * given reporter.
+     * @param diagnostic The diagnostic to report.
+     */
+    report(diagnostic: AnyDiagnostic): void;
+}
+/**
+ * An abstract base class for [[IDiagnosticReporter]] implementation that used the
+ * provided Map to suppress certain rule violations from being reported. The Map's key
+ * a schema full name, and the Map's value is a collection of rule codes to suppress.
+ * @beta
+ */
+export declare abstract class SuppressionDiagnosticReporter implements IDiagnosticReporter {
+    private _suppressions?;
+    /**
+     * Initializes a new SuppressionDiagnosticReporter
+     * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.
+     */
+    constructor(suppressions?: Map<string, string[]>);
+    /**
+     * Gets the collection of ISchemaDiagnosticSuppression objects that identify
+     * rules violations to ignore during validation.
+     */
+    get suppressions(): Map<string, string[]> | undefined;
+    /**
+     * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)
+     * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.
+     * @param diagnostic The diagnostic to report.
+     */
+    report(diagnostic: AnyDiagnostic): void;
+    /**
+     * Handles the given [[IDiagnostic]] based on the implementation requirements for a
+     * given reporter.
+     * @param diagnostic The diagnostic to report.
+     */
+    protected abstract reportInternal(diagnostic: AnyDiagnostic): void;
+}
+/**
+ * An abstract [[SuppressionDiagnosticReporter]] implementation that formats the
+ * diagnostic message with the message args. If a Localization implementation is specified,
+ * the message will also be translated.
+ * @beta
+ */
+export declare abstract class FormatDiagnosticReporter extends SuppressionDiagnosticReporter {
+    /**
+     * Initializes a new FormatDiagnosticReporter
+     * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.
+     * @param localization The Localization instance to use to translate validation messages.
+     */
+    constructor(suppressions?: Map<string, string[]>, localization?: Localization);
+    /** The Localization object to use for message translation. If undefined, no translation will occur. */
+    localization?: Localization;
+    /**
+     * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)
+     * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.
+     * @param diagnostic The diagnostic to report.
+     */
+    reportInternal(diagnostic: AnyDiagnostic): void;
+    /**
+     * Handles the given [[IDiagnostic]] based on the implementation requirements for a
+     * given reporter.
+     * @param diagnostic The diagnostic to report.
+     * @param messageText The formatted message.
+     */
+    protected abstract reportDiagnostic(diagnostic: AnyDiagnostic, messageText: string): void;
+    /**
+     * Helper method that formats string with provided arguments where the place holders
+     * are in the the format '{0}', '{1}', etc.
+     * @param text The text to format.
+     * @param args The arguments to place in the text.
+     * @param baseIndex The base index for the args, used for validation (typically 0, which is the default).
+     */
+    protected formatStringFromArgs(text: string, args: ArrayLike<string>, baseIndex?: number): string;
+    private formatMessage;
+    private translateMessage;
+    private getTranslationKey;
+    private assertDefined;
+}
+//# sourceMappingURL=DiagnosticReporter.d.ts.map

package/lib/esm/Validation/DiagnosticReporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DiagnosticReporter.d.ts","sourceRoot":"","sources":["../../../src/Validation/DiagnosticReporter.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAQ7C;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAErC,8DAA8D;IAC9D,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B;;;;OAIG;IACH,MAAM,CAAC,UAAU,EAAE,aAAa,GAAG,IAAI,CAAC;CACzC;AAED;;;;;GAKG;AACH,8BAAsB,6BAA8B,YAAW,mBAAmB;IAChF,OAAO,CAAC,aAAa,CAAC,CAAwB;IAE9C;;;OAGG;gBACS,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC;IAIhD;;;OAGG;IACH,IAAW,YAAY,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,SAAS,CAE3D;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,EAAE,aAAa;IAUvC;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,UAAU,EAAE,aAAa,GAAG,IAAI;CACnE;AAED;;;;;GAKG;AACH,8BAAsB,wBAAyB,SAAQ,6BAA6B;IAClF;;;;OAIG;gBACS,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,YAAY,CAAC,EAAE,YAAY;IAK7E,uGAAuG;IAChG,YAAY,CAAC,EAAE,YAAY,CAAC;IAEnC;;;;OAIG;IACI,cAAc,CAAC,UAAU,EAAE,aAAa;IAK/C;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,UAAU,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAEzF;;;;;;OAMG;IACH,SAAS,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,SAAS,SAAI,GAAG,MAAM;IAI5F,OAAO,CAAC,aAAa;IAQrB,OAAO,CAAC,gBAAgB;IAOxB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,aAAa;CAMtB"}

package/lib/esm/Validation/DiagnosticReporter.js

@@ -0,0 +1,105 @@
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+import * as assert from "assert";
+const translationNamespace = "ECSchemaMetaData";
+const subTranslationNamespace = "Diagnostics";
+const baseTranslationKey = `${translationNamespace}:${subTranslationNamespace}`;
+/**
+ * An abstract base class for [[IDiagnosticReporter]] implementation that used the
+ * provided Map to suppress certain rule violations from being reported. The Map's key
+ * a schema full name, and the Map's value is a collection of rule codes to suppress.
+ * @beta
+ */
+export class SuppressionDiagnosticReporter {
+    _suppressions;
+    /**
+     * Initializes a new SuppressionDiagnosticReporter
+     * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.
+     */
+    constructor(suppressions) {
+        this._suppressions = suppressions;
+    }
+    /**
+     * Gets the collection of ISchemaDiagnosticSuppression objects that identify
+     * rules violations to ignore during validation.
+     */
+    get suppressions() {
+        return this._suppressions;
+    }
+    /**
+     * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)
+     * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.
+     * @param diagnostic The diagnostic to report.
+     */
+    report(diagnostic) {
+        if (this._suppressions && this._suppressions.has(diagnostic.schema.fullName)) {
+            const suppressedCodes = this._suppressions.get(diagnostic.schema.fullName);
+            if (suppressedCodes.includes(diagnostic.code))
+                return;
+        }
+        this.reportInternal(diagnostic);
+    }
+}
+/**
+ * An abstract [[SuppressionDiagnosticReporter]] implementation that formats the
+ * diagnostic message with the message args. If a Localization implementation is specified,
+ * the message will also be translated.
+ * @beta
+ */
+export class FormatDiagnosticReporter extends SuppressionDiagnosticReporter {
+    /**
+     * Initializes a new FormatDiagnosticReporter
+     * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.
+     * @param localization The Localization instance to use to translate validation messages.
+     */
+    constructor(suppressions, localization) {
+        super(suppressions);
+        this.localization = localization;
+    }
+    /** The Localization object to use for message translation. If undefined, no translation will occur. */
+    localization;
+    /**
+     * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)
+     * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.
+     * @param diagnostic The diagnostic to report.
+     */
+    reportInternal(diagnostic) {
+        const message = this.formatMessage(diagnostic);
+        this.reportDiagnostic(diagnostic, message);
+    }
+    /**
+     * Helper method that formats string with provided arguments where the place holders
+     * are in the the format '{0}', '{1}', etc.
+     * @param text The text to format.
+     * @param args The arguments to place in the text.
+     * @param baseIndex The base index for the args, used for validation (typically 0, which is the default).
+     */
+    formatStringFromArgs(text, args, baseIndex = 0) {
+        return text.replace(/{(\d+)}/g, (_match, index) => this.assertDefined(args[+index + baseIndex]));
+    }
+    formatMessage(diagnostic) {
+        let translatedMessage = this.translateMessage(diagnostic);
+        if (diagnostic.messageArgs && diagnostic.messageArgs.length > 0)
+            translatedMessage = this.formatStringFromArgs(translatedMessage, diagnostic.messageArgs);
+        return translatedMessage;
+    }
+    translateMessage(diagnostic) {
+        if (!this.localization)
+            return diagnostic.messageText;
+        return this.localization.getLocalizedString(this.getTranslationKey(diagnostic));
+    }
+    getTranslationKey(diagnostic) {
+        return `${baseTranslationKey}.${diagnostic.code}`;
+    }
+    assertDefined(value, message) {
+        if (value === undefined || value === null)
+            return assert(false, message);
+        return value;
+    }
+}
+//# sourceMappingURL=DiagnosticReporter.js.map

package/lib/esm/Validation/DiagnosticReporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DiagnosticReporter.js","sourceRoot":"","sources":["../../../src/Validation/DiagnosticReporter.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAC;AAEjC,MAAM,oBAAoB,GAAG,kBAAkB,CAAC;AAChD,MAAM,uBAAuB,GAAG,aAAa,CAAC;AAC9C,MAAM,kBAAkB,GAAG,GAAG,oBAAoB,IAAI,uBAAuB,EAAE,CAAC;AAwBhF;;;;;GAKG;AACH,MAAM,OAAgB,6BAA6B;IACzC,aAAa,CAAyB;IAE9C;;;OAGG;IACH,YAAY,YAAoC;QAC9C,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED;;;OAGG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAyB;QACrC,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7E,MAAM,eAAe,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAC3E,IAAI,eAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;gBAC5C,OAAO;QACX,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IAClC,CAAC;CAQF;AAED;;;;;GAKG;AACH,MAAM,OAAgB,wBAAyB,SAAQ,6BAA6B;IAClF;;;;OAIG;IACH,YAAY,YAAoC,EAAE,YAA2B;QAC3E,KAAK,CAAC,YAAY,CAAC,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAED,uGAAuG;IAChG,YAAY,CAAgB;IAEnC;;;;OAIG;IACI,cAAc,CAAC,UAAyB;QAC7C,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAUD;;;;;;OAMG;IACO,oBAAoB,CAAC,IAAY,EAAE,IAAuB,EAAE,SAAS,GAAG,CAAC;QACjF,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,MAAM,EAAE,KAAa,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEO,aAAa,CAAC,UAAyB;QAC7C,IAAI,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QAE1D,IAAI,UAAU,CAAC,WAAW,IAAI,UAAU,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC;YAC7D,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,CAAC,iBAAiB,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3F,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAEO,gBAAgB,CAAC,UAAyB;QAChD,IAAI,CAAC,IAAI,CAAC,YAAY;YACpB,OAAO,UAAU,CAAC,WAAW,CAAC;QAEhC,OAAO,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC;IAClF,CAAC;IAEO,iBAAiB,CAAC,UAAyB;QACjD,OAAO,GAAG,kBAAkB,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC;IACpD,CAAC;IAEO,aAAa,CAAI,KAA2B,EAAE,OAAgB;QACpE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;YACvC,OAAO,MAAM,CAAC,KAAK,EAAE,OAAO,CAAU,CAAC;QAEzC,OAAO,KAAK,CAAC;IACf,CAAC;CACF","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 Diagnostic\n */\n\nimport { Localization } from \"@itwin/core-common\";\nimport { AnyDiagnostic } from \"./Diagnostic\";\n\nimport * as assert from \"assert\";\n\nconst translationNamespace = \"ECSchemaMetaData\";\nconst subTranslationNamespace = \"Diagnostics\";\nconst baseTranslationKey = `${translationNamespace}:${subTranslationNamespace}`;\n\n/**\n * Interface used to report [[IDiagnostic]] objects created during schema validation.\n * @beta\n */\nexport interface IDiagnosticReporter {\n  /**\n   * A map where the key is a schema full name and the value is a collection\n   * of diagnostics codes identifying which rules violations to ignore during validation.\n   */\n  suppressions?: Map<string, string[]>;\n\n  /** The localization object to use for message translation. */\n  localization?: Localization;\n\n  /**\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\n   * given reporter.\n   * @param diagnostic The diagnostic to report.\n   */\n  report(diagnostic: AnyDiagnostic): void;\n}\n\n/**\n * An abstract base class for [[IDiagnosticReporter]] implementation that used the\n * provided Map to suppress certain rule violations from being reported. The Map's key\n * a schema full name, and the Map's value is a collection of rule codes to suppress.\n * @beta\n */\nexport abstract class SuppressionDiagnosticReporter implements IDiagnosticReporter {\n  private _suppressions?: Map<string, string[]>;\n\n  /**\n   * Initializes a new SuppressionDiagnosticReporter\n   * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.\n   */\n  constructor(suppressions?: Map<string, string[]>) {\n    this._suppressions = suppressions;\n  }\n\n  /**\n   * Gets the collection of ISchemaDiagnosticSuppression objects that identify\n   * rules violations to ignore during validation.\n   */\n  public get suppressions(): Map<string, string[]> | undefined {\n    return this._suppressions;\n  }\n\n  /**\n   * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)\n   * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.\n   * @param diagnostic The diagnostic to report.\n   */\n  public report(diagnostic: AnyDiagnostic) {\n    if (this._suppressions && this._suppressions.has(diagnostic.schema.fullName)) {\n      const suppressedCodes = this._suppressions.get(diagnostic.schema.fullName);\n      if (suppressedCodes!.includes(diagnostic.code))\n        return;\n    }\n\n    this.reportInternal(diagnostic);\n  }\n\n  /**\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\n   * given reporter.\n   * @param diagnostic The diagnostic to report.\n   */\n  protected abstract reportInternal(diagnostic: AnyDiagnostic): void;\n}\n\n/**\n * An abstract [[SuppressionDiagnosticReporter]] implementation that formats the\n * diagnostic message with the message args. If a Localization implementation is specified,\n * the message will also be translated.\n * @beta\n */\nexport abstract class FormatDiagnosticReporter extends SuppressionDiagnosticReporter {\n  /**\n   * Initializes a new FormatDiagnosticReporter\n   * @param suppressions A Map where the key is a schema full name and the value is collection of diagnostic codes to suppress.\n   * @param localization The Localization instance to use to translate validation messages.\n   */\n  constructor(suppressions?: Map<string, string[]>, localization?: Localization) {\n    super(suppressions);\n    this.localization = localization;\n  }\n\n  /** The Localization object to use for message translation. If undefined, no translation will occur. */\n  public localization?: Localization;\n\n  /**\n   * Prior to reporting the [[IDiagnostic]], the diagnostic message is formatted (with translations)\n   * base on arguments contained in the diagnostic. Calls reportDiagnostic after the message is formatted.\n   * @param diagnostic The diagnostic to report.\n   */\n  public reportInternal(diagnostic: AnyDiagnostic) {\n    const message = this.formatMessage(diagnostic);\n    this.reportDiagnostic(diagnostic, message);\n  }\n\n  /**\n   * Handles the given [[IDiagnostic]] based on the implementation requirements for a\n   * given reporter.\n   * @param diagnostic The diagnostic to report.\n   * @param messageText The formatted message.\n   */\n  protected abstract reportDiagnostic(diagnostic: AnyDiagnostic, messageText: string): void;\n\n  /**\n   * Helper method that formats string with provided arguments where the place holders\n   * are in the the format '{0}', '{1}', etc.\n   * @param text The text to format.\n   * @param args The arguments to place in the text.\n   * @param baseIndex The base index for the args, used for validation (typically 0, which is the default).\n   */\n  protected formatStringFromArgs(text: string, args: ArrayLike<string>, baseIndex = 0): string {\n    return text.replace(/{(\\d+)}/g, (_match, index: string) => this.assertDefined(args[+index + baseIndex]));\n  }\n\n  private formatMessage(diagnostic: AnyDiagnostic): string {\n    let translatedMessage = this.translateMessage(diagnostic);\n\n    if (diagnostic.messageArgs && diagnostic.messageArgs.length > 0)\n      translatedMessage = this.formatStringFromArgs(translatedMessage, diagnostic.messageArgs);\n    return translatedMessage;\n  }\n\n  private translateMessage(diagnostic: AnyDiagnostic): string {\n    if (!this.localization)\n      return diagnostic.messageText;\n\n    return this.localization.getLocalizedString(this.getTranslationKey(diagnostic));\n  }\n\n  private getTranslationKey(diagnostic: AnyDiagnostic): string {\n    return `${baseTranslationKey}.${diagnostic.code}`;\n  }\n\n  private assertDefined<T>(value: T | null | undefined, message?: string): T {\n    if (value === undefined || value === null)\n      return assert(false, message) as never;\n\n    return value;\n  }\n}\n"]}