@itwin/ecschema-editing 4.0.0-dev.1 → 4.0.0-dev.100

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 type IRule<T extends AnyECType, U = {}> = (ecDefinition: T, ...args: U[]) => AsyncIterable<BaseDiagnostic<T, any[]>>;
+/** @beta */
+export 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.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Rules.d.ts","sourceRoot":"","sources":["../../../src/Validation/Rules.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,oBAAoB,EACxF,6BAA6B,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAChH,gBAAgB,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,EAClG,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C;;;GAGG;AACH,oBAAY,KAAK,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,EAAE,KAAK,aAAa,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AAE5H,YAAY;AACZ,oBAAY,QAAQ,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb,gHAAgH;IAChH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE9B,oEAAoE;IACpE,WAAW,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACnC,wEAAwE;IACxE,eAAe,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3C,qEAAqE;IACrE,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpC,sEAAsE;IACtE,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAC1C,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7C,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7C,mEAAmE;IACnE,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IACjC,+EAA+E;IAC/E,iBAAiB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACpD,oFAAoF;IACpF,2BAA2B,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;IACnE,kFAAkF;IAClF,yBAAyB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC/D,2FAA2F;IAC3F,6BAA6B,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAC5E,6EAA6E;IAC7E,4BAA4B,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,6BAA6B,EAAE,eAAe,CAAC,CAAC,CAAC;IAC/F,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7C,4EAA4E;IAC5E,mBAAmB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IACnD,8EAA8E;IAC9E,qBAAqB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACvD,oEAAoE;IACpE,WAAW,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACnC,kEAAkE;IAClE,SAAS,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/B,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/C,wEAAwE;IACxE,eAAe,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3C,wEAAwE;IACxE,eAAe,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3C,sEAAsE;IACtE,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;CACxC"}
+{"version":3,"file":"Rules.d.ts","sourceRoot":"","sources":["../../../src/Validation/Rules.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,eAAe,EAAE,oBAAoB,EACxF,6BAA6B,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAChH,gBAAgB,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,IAAI,EAClG,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,GAAG,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,EAAE,KAAK,aAAa,CAAC,cAAc,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;AAE5H,YAAY;AACZ,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,SAAS,IAAI,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;AAE7E;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IAEb,gHAAgH;IAChH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE9B,oEAAoE;IACpE,WAAW,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACnC,wEAAwE;IACxE,eAAe,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3C,qEAAqE;IACrE,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpC,sEAAsE;IACtE,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAC1C,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7C,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7C,mEAAmE;IACnE,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IACjC,+EAA+E;IAC/E,iBAAiB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAC;IACpD,oFAAoF;IACpF,2BAA2B,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;IACnE,kFAAkF;IAClF,yBAAyB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC/D,2FAA2F;IAC3F,6BAA6B,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAC5E,6EAA6E;IAC7E,4BAA4B,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,6BAA6B,EAAE,eAAe,CAAC,CAAC,CAAC;IAC/F,yEAAyE;IACzE,gBAAgB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;IAC7C,4EAA4E;IAC5E,mBAAmB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC;IACnD,8EAA8E;IAC9E,qBAAqB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACvD,oEAAoE;IACpE,WAAW,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACnC,kEAAkE;IAClE,SAAS,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/B,0EAA0E;IAC1E,iBAAiB,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;IAC/C,wEAAwE;IACxE,eAAe,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3C,wEAAwE;IACxE,eAAe,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3C,sEAAsE;IACtE,aAAa,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC;CACxC"}

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