@itwin/ecschema-editing 3.4.0-dev.9 → 3.4.1

package/lib/cjs/Validation/Rules.d.ts

@@ -1,65 +1,65 @@
-/** @packageDocumentation
- * @module Validation
- */
-import { AnyClass, AnyECType, AnyProperty, Constant, CustomAttribute, CustomAttributeClass, CustomAttributeContainerProps, EntityClass, Enumeration, Format, InvertedUnit, KindOfQuantity, Mixin, Phenomenon, PropertyCategory, RelationshipClass, RelationshipConstraint, Schema, SchemaItem, StructClass, Unit, UnitSystem } from "@itwin/ecschema-metadata";
-import { BaseDiagnostic } from "./Diagnostic";
-/**
- * Interface used for all rule implementations used during schema validation.
- * @beta
- */
-export declare type IRule<T extends AnyECType, U = {}> = (ecDefinition: T, ...args: U[]) => AsyncIterable<BaseDiagnostic<T, any[]>>;
-/** @beta */
-export declare type BaseRule<T extends AnyECType, U extends AnyECType> = IRule<T, U>;
-/**
- * Interface used to represent logical collection of [IRule]($ecschema-editing) instances.
- * @beta
- */
-export interface IRuleSet {
-    /** The name of the rule set. */
-    name: string;
-    /** A collection of schema names that should be excluded from adhering to the rules defined in this rule set. */
-    schemaExclusionSet?: string[];
-    /** The rules that apply to [Schema]($ecschema-metadata) objects. */
-    schemaRules?: Array<IRule<Schema>>;
-    /** The rules that apply to [SchemaItem]($ecschema-metadata) objects. */
-    schemaItemRules?: Array<IRule<SchemaItem>>;
-    /** The rules that apply to [ECClass]($ecschema-metadata) objects. */
-    classRules?: Array<IRule<AnyClass>>;
-    /** The rules that apply to [Property]($ecschema-metadata) objects. */
-    propertyRules?: Array<IRule<AnyProperty>>;
-    /** The rules that apply to [EntityClass]($ecschema-metadata) objects. */
-    entityClassRules?: Array<IRule<EntityClass>>;
-    /** The rules that apply to [StructClass]($ecschema-metadata) objects. */
-    structClassRules?: Array<IRule<StructClass>>;
-    /** The rules that apply to [Mixin]($ecschema-metadata) objects. */
-    mixinRules?: Array<IRule<Mixin>>;
-    /** The rules that apply to [RelationshipClass]($ecschema-metadata) objects. */
-    relationshipRules?: Array<IRule<RelationshipClass>>;
-    /** The rules that apply to [RelationshipConstraint]($ecschema-metadata) objects. */
-    relationshipConstraintRules?: Array<IRule<RelationshipConstraint>>;
-    /** The rules that apply to [CustomAttributeClass]($ecschema-metadata) objects. */
-    customAttributeClassRules?: Array<IRule<CustomAttributeClass>>;
-    /** The rules that apply to [CustomAttributeContainerProps]($ecschema-metadata) objects. */
-    customAttributeContainerRules?: Array<IRule<CustomAttributeContainerProps>>;
-    /** The rules that apply to [CustomAttribute]($ecschema-metadata) objects. */
-    customAttributeInstanceRules?: Array<BaseRule<CustomAttributeContainerProps, CustomAttribute>>;
-    /** The rules that apply to [Enumeration]($ecschema-metadata) objects. */
-    enumerationRules?: Array<IRule<Enumeration>>;
-    /** The rules that apply to [KindOfQuantity]($ecschema-metadata) objects. */
-    kindOfQuantityRules?: Array<IRule<KindOfQuantity>>;
-    /** The rules that apply to [PropertyCategory]($ecschema-metadata) objects. */
-    propertyCategoryRules?: Array<IRule<PropertyCategory>>;
-    /** The rules that apply to [Format]($ecschema-metadata) objects. */
-    formatRules?: Array<IRule<Format>>;
-    /** The rules that apply to [Unit]($ecschema-metadata) objects. */
-    unitRules?: Array<IRule<Unit>>;
-    /** The rules that apply to [InvertedUnit]($ecschema-metadata) objects. */
-    invertedUnitRules?: Array<IRule<InvertedUnit>>;
-    /** The rules that apply to [UnitSystem]($ecschema-metadata) objects. */
-    unitSystemRules?: Array<IRule<UnitSystem>>;
-    /** The rules that apply to [Phenomenon]($ecschema-metadata) objects. */
-    phenomenonRules?: Array<IRule<Phenomenon>>;
-    /** The rules that apply to [Constant]($ecschema-metadata) objects. */
-    constantRules?: Array<IRule<Constant>>;
-}
+/** @packageDocumentation
+ * @module Validation
+ */
+import { AnyClass, AnyECType, AnyProperty, Constant, CustomAttribute, CustomAttributeClass, CustomAttributeContainerProps, EntityClass, Enumeration, Format, InvertedUnit, KindOfQuantity, Mixin, Phenomenon, PropertyCategory, RelationshipClass, RelationshipConstraint, Schema, SchemaItem, StructClass, Unit, UnitSystem } from "@itwin/ecschema-metadata";
+import { BaseDiagnostic } from "./Diagnostic";
+/**
+ * Interface used for all rule implementations used during schema validation.
+ * @beta
+ */
+export declare type IRule<T extends AnyECType, U = {}> = (ecDefinition: T, ...args: U[]) => AsyncIterable<BaseDiagnostic<T, any[]>>;
+/** @beta */
+export declare type BaseRule<T extends AnyECType, U extends AnyECType> = IRule<T, U>;
+/**
+ * Interface used to represent logical collection of [IRule]($ecschema-editing) instances.
+ * @beta
+ */
+export interface IRuleSet {
+    /** The name of the rule set. */
+    name: string;
+    /** A collection of schema names that should be excluded from adhering to the rules defined in this rule set. */
+    schemaExclusionSet?: string[];
+    /** The rules that apply to [Schema]($ecschema-metadata) objects. */
+    schemaRules?: Array<IRule<Schema>>;
+    /** The rules that apply to [SchemaItem]($ecschema-metadata) objects. */
+    schemaItemRules?: Array<IRule<SchemaItem>>;
+    /** The rules that apply to [ECClass]($ecschema-metadata) objects. */
+    classRules?: Array<IRule<AnyClass>>;
+    /** The rules that apply to [Property]($ecschema-metadata) objects. */
+    propertyRules?: Array<IRule<AnyProperty>>;
+    /** The rules that apply to [EntityClass]($ecschema-metadata) objects. */
+    entityClassRules?: Array<IRule<EntityClass>>;
+    /** The rules that apply to [StructClass]($ecschema-metadata) objects. */
+    structClassRules?: Array<IRule<StructClass>>;
+    /** The rules that apply to [Mixin]($ecschema-metadata) objects. */
+    mixinRules?: Array<IRule<Mixin>>;
+    /** The rules that apply to [RelationshipClass]($ecschema-metadata) objects. */
+    relationshipRules?: Array<IRule<RelationshipClass>>;
+    /** The rules that apply to [RelationshipConstraint]($ecschema-metadata) objects. */
+    relationshipConstraintRules?: Array<IRule<RelationshipConstraint>>;
+    /** The rules that apply to [CustomAttributeClass]($ecschema-metadata) objects. */
+    customAttributeClassRules?: Array<IRule<CustomAttributeClass>>;
+    /** The rules that apply to [CustomAttributeContainerProps]($ecschema-metadata) objects. */
+    customAttributeContainerRules?: Array<IRule<CustomAttributeContainerProps>>;
+    /** The rules that apply to [CustomAttribute]($ecschema-metadata) objects. */
+    customAttributeInstanceRules?: Array<BaseRule<CustomAttributeContainerProps, CustomAttribute>>;
+    /** The rules that apply to [Enumeration]($ecschema-metadata) objects. */
+    enumerationRules?: Array<IRule<Enumeration>>;
+    /** The rules that apply to [KindOfQuantity]($ecschema-metadata) objects. */
+    kindOfQuantityRules?: Array<IRule<KindOfQuantity>>;
+    /** The rules that apply to [PropertyCategory]($ecschema-metadata) objects. */
+    propertyCategoryRules?: Array<IRule<PropertyCategory>>;
+    /** The rules that apply to [Format]($ecschema-metadata) objects. */
+    formatRules?: Array<IRule<Format>>;
+    /** The rules that apply to [Unit]($ecschema-metadata) objects. */
+    unitRules?: Array<IRule<Unit>>;
+    /** The rules that apply to [InvertedUnit]($ecschema-metadata) objects. */
+    invertedUnitRules?: Array<IRule<InvertedUnit>>;
+    /** The rules that apply to [UnitSystem]($ecschema-metadata) objects. */
+    unitSystemRules?: Array<IRule<UnitSystem>>;
+    /** The rules that apply to [Phenomenon]($ecschema-metadata) objects. */
+    phenomenonRules?: Array<IRule<Phenomenon>>;
+    /** The rules that apply to [Constant]($ecschema-metadata) objects. */
+    constantRules?: Array<IRule<Constant>>;
+}
 //# sourceMappingURL=Rules.d.ts.map

package/lib/cjs/Validation/Rules.js

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

package/lib/cjs/Validation/Rules.js.map

@@ -1 +1 @@
-{"version":3,"file":"Rules.js","sourceRoot":"","sources":["../../../src/Validation/Rules.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Validation\r\n */\r\n\r\nimport { AnyClass, AnyECType, AnyProperty, Constant, CustomAttribute, CustomAttributeClass,\r\n  CustomAttributeContainerProps, EntityClass, Enumeration, Format, InvertedUnit, KindOfQuantity, Mixin, Phenomenon,\r\n  PropertyCategory, RelationshipClass, RelationshipConstraint, Schema, SchemaItem, StructClass, Unit,\r\n  UnitSystem } from \"@itwin/ecschema-metadata\";\r\nimport { BaseDiagnostic } from \"./Diagnostic\";\r\n\r\n/**\r\n * Interface used for all rule implementations used during schema validation.\r\n * @beta\r\n */\r\nexport type IRule<T extends AnyECType, U = {}> = (ecDefinition: T, ...args: U[]) => AsyncIterable<BaseDiagnostic<T, any[]>>;\r\n\r\n/** @beta */\r\nexport type BaseRule<T extends AnyECType, U extends AnyECType> = IRule<T, U>;\r\n\r\n/**\r\n * Interface used to represent logical collection of [IRule]($ecschema-editing) instances.\r\n * @beta\r\n */\r\nexport interface IRuleSet {\r\n  /** The name of the rule set. */\r\n  name: string;\r\n\r\n  /** A collection of schema names that should be excluded from adhering to the rules defined in this rule set. */\r\n  schemaExclusionSet?: string[];\r\n\r\n  /** The rules that apply to [Schema]($ecschema-metadata) objects. */\r\n  schemaRules?: Array<IRule<Schema>>;\r\n  /** The rules that apply to [SchemaItem]($ecschema-metadata) objects. */\r\n  schemaItemRules?: Array<IRule<SchemaItem>>;\r\n  /** The rules that apply to [ECClass]($ecschema-metadata) objects. */\r\n  classRules?: Array<IRule<AnyClass>>;\r\n  /** The rules that apply to [Property]($ecschema-metadata) objects. */\r\n  propertyRules?: Array<IRule<AnyProperty>>;\r\n  /** The rules that apply to [EntityClass]($ecschema-metadata) objects. */\r\n  entityClassRules?: Array<IRule<EntityClass>>;\r\n  /** The rules that apply to [StructClass]($ecschema-metadata) objects. */\r\n  structClassRules?: Array<IRule<StructClass>>;\r\n  /** The rules that apply to [Mixin]($ecschema-metadata) objects. */\r\n  mixinRules?: Array<IRule<Mixin>>;\r\n  /** The rules that apply to [RelationshipClass]($ecschema-metadata) objects. */\r\n  relationshipRules?: Array<IRule<RelationshipClass>>;\r\n  /** The rules that apply to [RelationshipConstraint]($ecschema-metadata) objects. */\r\n  relationshipConstraintRules?: Array<IRule<RelationshipConstraint>>;\r\n  /** The rules that apply to [CustomAttributeClass]($ecschema-metadata) objects. */\r\n  customAttributeClassRules?: Array<IRule<CustomAttributeClass>>;\r\n  /** The rules that apply to [CustomAttributeContainerProps]($ecschema-metadata) objects. */\r\n  customAttributeContainerRules?: Array<IRule<CustomAttributeContainerProps>>;\r\n  /** The rules that apply to [CustomAttribute]($ecschema-metadata) objects. */\r\n  customAttributeInstanceRules?: Array<BaseRule<CustomAttributeContainerProps, CustomAttribute>>;\r\n  /** The rules that apply to [Enumeration]($ecschema-metadata) objects. */\r\n  enumerationRules?: Array<IRule<Enumeration>>;\r\n  /** The rules that apply to [KindOfQuantity]($ecschema-metadata) objects. */\r\n  kindOfQuantityRules?: Array<IRule<KindOfQuantity>>;\r\n  /** The rules that apply to [PropertyCategory]($ecschema-metadata) objects. */\r\n  propertyCategoryRules?: Array<IRule<PropertyCategory>>;\r\n  /** The rules that apply to [Format]($ecschema-metadata) objects. */\r\n  formatRules?: Array<IRule<Format>>;\r\n  /** The rules that apply to [Unit]($ecschema-metadata) objects. */\r\n  unitRules?: Array<IRule<Unit>>;\r\n  /** The rules that apply to [InvertedUnit]($ecschema-metadata) objects. */\r\n  invertedUnitRules?: Array<IRule<InvertedUnit>>;\r\n  /** The rules that apply to [UnitSystem]($ecschema-metadata) objects. */\r\n  unitSystemRules?: Array<IRule<UnitSystem>>;\r\n  /** The rules that apply to [Phenomenon]($ecschema-metadata) objects. */\r\n  phenomenonRules?: Array<IRule<Phenomenon>>;\r\n  /** The rules that apply to [Constant]($ecschema-metadata) objects. */\r\n  constantRules?: Array<IRule<Constant>>;\r\n}\r\n"]}
+{"version":3,"file":"Rules.js","sourceRoot":"","sources":["../../../src/Validation/Rules.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Validation\n */\n\nimport { AnyClass, AnyECType, AnyProperty, Constant, CustomAttribute, CustomAttributeClass,\n  CustomAttributeContainerProps, EntityClass, Enumeration, Format, InvertedUnit, KindOfQuantity, Mixin, Phenomenon,\n  PropertyCategory, RelationshipClass, RelationshipConstraint, Schema, SchemaItem, StructClass, Unit,\n  UnitSystem } from \"@itwin/ecschema-metadata\";\nimport { BaseDiagnostic } from \"./Diagnostic\";\n\n/**\n * Interface used for all rule implementations used during schema validation.\n * @beta\n */\nexport type IRule<T extends AnyECType, U = {}> = (ecDefinition: T, ...args: U[]) => AsyncIterable<BaseDiagnostic<T, any[]>>;\n\n/** @beta */\nexport type BaseRule<T extends AnyECType, U extends AnyECType> = IRule<T, U>;\n\n/**\n * Interface used to represent logical collection of [IRule]($ecschema-editing) instances.\n * @beta\n */\nexport interface IRuleSet {\n  /** The name of the rule set. */\n  name: string;\n\n  /** A collection of schema names that should be excluded from adhering to the rules defined in this rule set. */\n  schemaExclusionSet?: string[];\n\n  /** The rules that apply to [Schema]($ecschema-metadata) objects. */\n  schemaRules?: Array<IRule<Schema>>;\n  /** The rules that apply to [SchemaItem]($ecschema-metadata) objects. */\n  schemaItemRules?: Array<IRule<SchemaItem>>;\n  /** The rules that apply to [ECClass]($ecschema-metadata) objects. */\n  classRules?: Array<IRule<AnyClass>>;\n  /** The rules that apply to [Property]($ecschema-metadata) objects. */\n  propertyRules?: Array<IRule<AnyProperty>>;\n  /** The rules that apply to [EntityClass]($ecschema-metadata) objects. */\n  entityClassRules?: Array<IRule<EntityClass>>;\n  /** The rules that apply to [StructClass]($ecschema-metadata) objects. */\n  structClassRules?: Array<IRule<StructClass>>;\n  /** The rules that apply to [Mixin]($ecschema-metadata) objects. */\n  mixinRules?: Array<IRule<Mixin>>;\n  /** The rules that apply to [RelationshipClass]($ecschema-metadata) objects. */\n  relationshipRules?: Array<IRule<RelationshipClass>>;\n  /** The rules that apply to [RelationshipConstraint]($ecschema-metadata) objects. */\n  relationshipConstraintRules?: Array<IRule<RelationshipConstraint>>;\n  /** The rules that apply to [CustomAttributeClass]($ecschema-metadata) objects. */\n  customAttributeClassRules?: Array<IRule<CustomAttributeClass>>;\n  /** The rules that apply to [CustomAttributeContainerProps]($ecschema-metadata) objects. */\n  customAttributeContainerRules?: Array<IRule<CustomAttributeContainerProps>>;\n  /** The rules that apply to [CustomAttribute]($ecschema-metadata) objects. */\n  customAttributeInstanceRules?: Array<BaseRule<CustomAttributeContainerProps, CustomAttribute>>;\n  /** The rules that apply to [Enumeration]($ecschema-metadata) objects. */\n  enumerationRules?: Array<IRule<Enumeration>>;\n  /** The rules that apply to [KindOfQuantity]($ecschema-metadata) objects. */\n  kindOfQuantityRules?: Array<IRule<KindOfQuantity>>;\n  /** The rules that apply to [PropertyCategory]($ecschema-metadata) objects. */\n  propertyCategoryRules?: Array<IRule<PropertyCategory>>;\n  /** The rules that apply to [Format]($ecschema-metadata) objects. */\n  formatRules?: Array<IRule<Format>>;\n  /** The rules that apply to [Unit]($ecschema-metadata) objects. */\n  unitRules?: Array<IRule<Unit>>;\n  /** The rules that apply to [InvertedUnit]($ecschema-metadata) objects. */\n  invertedUnitRules?: Array<IRule<InvertedUnit>>;\n  /** The rules that apply to [UnitSystem]($ecschema-metadata) objects. */\n  unitSystemRules?: Array<IRule<UnitSystem>>;\n  /** The rules that apply to [Phenomenon]($ecschema-metadata) objects. */\n  phenomenonRules?: Array<IRule<Phenomenon>>;\n  /** The rules that apply to [Constant]($ecschema-metadata) objects. */\n  constantRules?: Array<IRule<Constant>>;\n}\n"]}