@itwin/ecschema-metadata 4.0.0-dev.8 → 4.0.0-dev.80

package/lib/cjs/ECName.js

@@ -1,86 +1,86 @@
-"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 Metadata
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ECName = void 0;
-const core_bentley_1 = require("@itwin/core-bentley");
-const Exception_1 = require("./Exception");
-const validECNameRegex = /^([a-zA-Z_]+[a-zA-Z0-9_]*)$/i;
-const ecNameReplacerRegex = /__x([0-9a-fA-F]{4})__/g;
-const leadingDigits = ["0000", "000", "00", "0", ""];
-function isDigit(character) {
-    (0, core_bentley_1.assert)(1 === character.length);
-    return character >= "0" && character <= "9";
-}
-function isValidAlphaNumericCharacter(c) {
-    (0, core_bentley_1.assert)(1 === c.length);
-    return (((c >= "0" && c <= "9") || (c >= "A" && c <= "Z") || (c >= "a" && c <= "z") || c === "_"));
-}
-/** The name of an item in a [[Schema]], encoded to meet restrictions on the characters usable in such names.
- * An ECName meets the following criteria:
- *  - Contains at least one character.
- *  - Does not begin with a digit.
- *  - Consists entirely of characters in the ASCII ranges A-Z, a-z, and 0-9; and the underscore ("_") character.
- *
- * All characters not meeting the above criteria are encoded as "__x####__" where "####" is the UTF-16 character code.
- * Such names are often automatically generated from the item's display label, which is unrestricted in the characters it may contain.
- * @public
- */
-class ECName {
-    /** Construct a new ECName from a valid EC name.
-     * throws ECObjectsError if `name` does not meet the criteria for a valid EC name.
-     */
-    constructor(name) {
-        if (!ECName.validate(name))
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECName);
-        this._name = name;
-    }
-    /** Returns true if a string meets the criteria of a valid EC name. */
-    static validate(name) {
-        return validECNameRegex.test(name);
-    }
-    /** The underlying name as a string. */
-    get name() {
-        return this._name;
-    }
-    /** Create an ECName from an arbitrary string, encoding any special characters as "__x####__" where "####" is the UTF-16 character code.
-     * @throws ECObjectsError if `input` is an empty string.
-     */
-    static encode(input) {
-        if (0 === input.length)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECName);
-        if (ECName.validate(input)) {
-            // It's already a valid EC name.
-            return new ECName(input);
-        }
-        let output = "";
-        function appendEncodedCharacter(index) {
-            const hex = input.charCodeAt(index).toString(16).toUpperCase();
-            (0, core_bentley_1.assert)(hex.length > 0 && hex.length < 5);
-            output += `__x${leadingDigits[hex.length]}${hex}__`;
-        }
-        // First character cannot be a digit.
-        const firstCharIsDigit = isDigit(input[0]);
-        if (firstCharIsDigit)
-            appendEncodedCharacter(0);
-        for (let i = firstCharIsDigit ? 1 : 0; i < input.length; i++) {
-            const char = input[i];
-            if (!isValidAlphaNumericCharacter(char))
-                appendEncodedCharacter(i);
-            else
-                output += char;
-        }
-        return new ECName(output);
-    }
-    /** Decode this ECName, replacing encoded special characters with the characters they encode. */
-    decode() {
-        return this.name.replace(ecNameReplacerRegex, (_match, hex) => String.fromCharCode(Number.parseInt(hex, 16)));
-    }
-}
-exports.ECName = ECName;
+"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 Metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ECName = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const Exception_1 = require("./Exception");
+const validECNameRegex = /^([a-zA-Z_]+[a-zA-Z0-9_]*)$/i;
+const ecNameReplacerRegex = /__x([0-9a-fA-F]{4})__/g;
+const leadingDigits = ["0000", "000", "00", "0", ""];
+function isDigit(character) {
+    (0, core_bentley_1.assert)(1 === character.length);
+    return character >= "0" && character <= "9";
+}
+function isValidAlphaNumericCharacter(c) {
+    (0, core_bentley_1.assert)(1 === c.length);
+    return (((c >= "0" && c <= "9") || (c >= "A" && c <= "Z") || (c >= "a" && c <= "z") || c === "_"));
+}
+/** The name of an item in a [[Schema]], encoded to meet restrictions on the characters usable in such names.
+ * An ECName meets the following criteria:
+ *  - Contains at least one character.
+ *  - Does not begin with a digit.
+ *  - Consists entirely of characters in the ASCII ranges A-Z, a-z, and 0-9; and the underscore ("_") character.
+ *
+ * All characters not meeting the above criteria are encoded as "__x####__" where "####" is the UTF-16 character code.
+ * Such names are often automatically generated from the item's display label, which is unrestricted in the characters it may contain.
+ * @public
+ */
+class ECName {
+    /** Construct a new ECName from a valid EC name.
+     * throws ECObjectsError if `name` does not meet the criteria for a valid EC name.
+     */
+    constructor(name) {
+        if (!ECName.validate(name))
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECName);
+        this._name = name;
+    }
+    /** Returns true if a string meets the criteria of a valid EC name. */
+    static validate(name) {
+        return validECNameRegex.test(name);
+    }
+    /** The underlying name as a string. */
+    get name() {
+        return this._name;
+    }
+    /** Create an ECName from an arbitrary string, encoding any special characters as "__x####__" where "####" is the UTF-16 character code.
+     * @throws ECObjectsError if `input` is an empty string.
+     */
+    static encode(input) {
+        if (0 === input.length)
+            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECName);
+        if (ECName.validate(input)) {
+            // It's already a valid EC name.
+            return new ECName(input);
+        }
+        let output = "";
+        function appendEncodedCharacter(index) {
+            const hex = input.charCodeAt(index).toString(16).toUpperCase();
+            (0, core_bentley_1.assert)(hex.length > 0 && hex.length < 5);
+            output += `__x${leadingDigits[hex.length]}${hex}__`;
+        }
+        // First character cannot be a digit.
+        const firstCharIsDigit = isDigit(input[0]);
+        if (firstCharIsDigit)
+            appendEncodedCharacter(0);
+        for (let i = firstCharIsDigit ? 1 : 0; i < input.length; i++) {
+            const char = input[i];
+            if (!isValidAlphaNumericCharacter(char))
+                appendEncodedCharacter(i);
+            else
+                output += char;
+        }
+        return new ECName(output);
+    }
+    /** Decode this ECName, replacing encoded special characters with the characters they encode. */
+    decode() {
+        return this.name.replace(ecNameReplacerRegex, (_match, hex) => String.fromCharCode(Number.parseInt(hex, 16)));
+    }
+}
+exports.ECName = ECName;
 //# sourceMappingURL=ECName.js.map

package/lib/cjs/ECObjects.d.ts

@@ -1,163 +1,163 @@
-/** @packageDocumentation
- * @module Metadata
- */
-export { PropertyType } from "./PropertyTypes";
-/** @beta */
-export declare enum ECClassModifier {
-    None = 0,
-    Abstract = 1,
-    Sealed = 2
-}
-/** @beta */
-export declare enum SchemaItemType {
-    EntityClass = 0,
-    Mixin = 1,
-    StructClass = 2,
-    CustomAttributeClass = 3,
-    RelationshipClass = 4,
-    Enumeration = 5,
-    KindOfQuantity = 6,
-    PropertyCategory = 7,
-    Unit = 8,
-    InvertedUnit = 9,
-    Constant = 10,
-    Phenomenon = 11,
-    UnitSystem = 12,
-    Format = 13
-}
-/**
- * Primitive data types for ECProperties.
- * @beta
- */
-export declare enum PrimitiveType {
-    Uninitialized = 0,
-    Binary = 257,
-    Boolean = 513,
-    DateTime = 769,
-    Double = 1025,
-    Integer = 1281,
-    Long = 1537,
-    Point2d = 1793,
-    Point3d = 2049,
-    String = 2305,
-    IGeometry = 2561
-}
-/**
- * Defines the valid CustomAttribute container types.
- * @beta
- */
-export declare enum CustomAttributeContainerType {
-    Schema = 1,
-    EntityClass = 2,
-    CustomAttributeClass = 4,
-    StructClass = 8,
-    RelationshipClass = 16,
-    AnyClass = 30,
-    PrimitiveProperty = 32,
-    StructProperty = 64,
-    PrimitiveArrayProperty = 128,
-    StructArrayProperty = 256,
-    NavigationProperty = 512,
-    AnyProperty = 992,
-    SourceRelationshipConstraint = 1024,
-    TargetRelationshipConstraint = 2048,
-    AnyRelationshipConstraint = 3072,
-    Any = 4095
-}
-/**
- * Defines what sort of match should be used when locating a schema.
- * @beta
- */
-export declare enum SchemaMatchType {
-    Identical = 0,
-    Exact = 1,
-    LatestWriteCompatible = 2,
-    Latest = 3,
-    LatestReadCompatible = 4
-}
-/**
- * Identifer for an ECRelationshipConstraint. Used to determine the side of the relationship the constraint is representing.
- * @beta
- */
-export declare enum RelationshipEnd {
-    Source = 0,
-    Target = 1
-}
-/** @beta */
-export declare enum StrengthType {
-    Referencing = 0,
-    Holding = 1,
-    Embedding = 2
-}
-/** @beta */
-export declare enum StrengthDirection {
-    Forward = 1,
-    Backward = 2
-}
-/**
- * Parses the provided string into an ECClassModifier if the string is a valid modifier.
- * @param modifier The modifier string to parse.
- * @beta
- */
-export declare function parseClassModifier(modifier: string): ECClassModifier | undefined;
-/**
- * @return A string representing the provided ECClassModifier. If the modifier is not valid, an empty string is returned.
- * @beta
- */
-export declare function classModifierToString(modifier: ECClassModifier): string;
-/**
- * Tries to parse the given string as one of the 8 schema item types.
- * @param type The schema item type string to parse.
- * @returns A valid SchemaItemType if successfully parsed. Otherwise, undefined if the provided string is not a valid SchemaItemType.
- * @beta
- */
-export declare function parseSchemaItemType(type: string): SchemaItemType | undefined;
-/**
- * Converts a valid SchemaItemType to a display string.
- * @param value The SchemaItemType to stringify.
- * @return A string representing the provided SchemaItemType. If the type is not valid, an empty string is returned.
- * @beta
- */
-export declare function schemaItemTypeToString(value: SchemaItemType): string;
-/** @internal */
-export declare function schemaItemTypeToXmlString(value: SchemaItemType): string;
-/**
- * Tries to parse the given string as one of the 10 primitive types.
- * @param type The primitive type string to parse.
- * @returns A valid PrimitiveType if successfully parsed, or undefined if the provided string is not a valid PrimitiveType.
- * @beta
- */
-export declare function parsePrimitiveType(type: string): PrimitiveType | undefined;
-/** @beta */
-export declare function primitiveTypeToString(type: PrimitiveType): string;
-/**
- * Parses the given string into the appropriate CustomAttributeContainerType if the string is valid.
- * @param type The container type string to parse.
- * @beta
- */
-export declare function parseCustomAttributeContainerType(type: string): CustomAttributeContainerType | undefined;
-/**
- * Creates a string representing a valid CustomAttributeContainerType.
- * @param value The CustomAttributeContainerType to stringify.
- * @return A string representing the provided CustomAttributeContainerType. If the type is not valid, an empty string is returned.
- * @beta
- */
-export declare function containerTypeToString(type: CustomAttributeContainerType): string;
-/** @beta */
-export declare function parseRelationshipEnd(end: string): RelationshipEnd | undefined;
-/** @beta */
-export declare function relationshipEndToString(end: RelationshipEnd): string;
-/**
- * Takes a string representing a StrengthType, will parse it and return the corresponding StrengthType.
- * @throws ECObjectsStatus.InvalidStrength if the provided string that is not valid
- * @param strength
- * @beta
- */
-export declare function parseStrength(strength: string): StrengthType | undefined;
-/** @beta */
-export declare function strengthToString(strength: StrengthType): string;
-/** @beta */
-export declare function parseStrengthDirection(direction: string): StrengthDirection | undefined;
-/** @beta */
-export declare function strengthDirectionToString(direction: StrengthDirection): string;
+/** @packageDocumentation
+ * @module Metadata
+ */
+export { PropertyType } from "./PropertyTypes";
+/** @beta */
+export declare enum ECClassModifier {
+    None = 0,
+    Abstract = 1,
+    Sealed = 2
+}
+/** @beta */
+export declare enum SchemaItemType {
+    EntityClass = 0,
+    Mixin = 1,
+    StructClass = 2,
+    CustomAttributeClass = 3,
+    RelationshipClass = 4,
+    Enumeration = 5,
+    KindOfQuantity = 6,
+    PropertyCategory = 7,
+    Unit = 8,
+    InvertedUnit = 9,
+    Constant = 10,
+    Phenomenon = 11,
+    UnitSystem = 12,
+    Format = 13
+}
+/**
+ * Primitive data types for ECProperties.
+ * @beta
+ */
+export declare enum PrimitiveType {
+    Uninitialized = 0,
+    Binary = 257,
+    Boolean = 513,
+    DateTime = 769,
+    Double = 1025,
+    Integer = 1281,
+    Long = 1537,
+    Point2d = 1793,
+    Point3d = 2049,
+    String = 2305,
+    IGeometry = 2561
+}
+/**
+ * Defines the valid CustomAttribute container types.
+ * @beta
+ */
+export declare enum CustomAttributeContainerType {
+    Schema = 1,
+    EntityClass = 2,
+    CustomAttributeClass = 4,
+    StructClass = 8,
+    RelationshipClass = 16,
+    AnyClass = 30,
+    PrimitiveProperty = 32,
+    StructProperty = 64,
+    PrimitiveArrayProperty = 128,
+    StructArrayProperty = 256,
+    NavigationProperty = 512,
+    AnyProperty = 992,
+    SourceRelationshipConstraint = 1024,
+    TargetRelationshipConstraint = 2048,
+    AnyRelationshipConstraint = 3072,
+    Any = 4095
+}
+/**
+ * Defines what sort of match should be used when locating a schema.
+ * @beta
+ */
+export declare enum SchemaMatchType {
+    Identical = 0,
+    Exact = 1,
+    LatestWriteCompatible = 2,
+    Latest = 3,
+    LatestReadCompatible = 4
+}
+/**
+ * Identifer for an ECRelationshipConstraint. Used to determine the side of the relationship the constraint is representing.
+ * @beta
+ */
+export declare enum RelationshipEnd {
+    Source = 0,
+    Target = 1
+}
+/** @beta */
+export declare enum StrengthType {
+    Referencing = 0,
+    Holding = 1,
+    Embedding = 2
+}
+/** @beta */
+export declare enum StrengthDirection {
+    Forward = 1,
+    Backward = 2
+}
+/**
+ * Parses the provided string into an ECClassModifier if the string is a valid modifier.
+ * @param modifier The modifier string to parse.
+ * @beta
+ */
+export declare function parseClassModifier(modifier: string): ECClassModifier | undefined;
+/**
+ * @return A string representing the provided ECClassModifier. If the modifier is not valid, an empty string is returned.
+ * @beta
+ */
+export declare function classModifierToString(modifier: ECClassModifier): string;
+/**
+ * Tries to parse the given string as one of the 8 schema item types.
+ * @param type The schema item type string to parse.
+ * @returns A valid SchemaItemType if successfully parsed. Otherwise, undefined if the provided string is not a valid SchemaItemType.
+ * @beta
+ */
+export declare function parseSchemaItemType(type: string): SchemaItemType | undefined;
+/**
+ * Converts a valid SchemaItemType to a display string.
+ * @param value The SchemaItemType to stringify.
+ * @return A string representing the provided SchemaItemType. If the type is not valid, an empty string is returned.
+ * @beta
+ */
+export declare function schemaItemTypeToString(value: SchemaItemType): string;
+/** @internal */
+export declare function schemaItemTypeToXmlString(value: SchemaItemType): string;
+/**
+ * Tries to parse the given string as one of the 10 primitive types.
+ * @param type The primitive type string to parse.
+ * @returns A valid PrimitiveType if successfully parsed, or undefined if the provided string is not a valid PrimitiveType.
+ * @beta
+ */
+export declare function parsePrimitiveType(type: string): PrimitiveType | undefined;
+/** @beta */
+export declare function primitiveTypeToString(type: PrimitiveType): string;
+/**
+ * Parses the given string into the appropriate CustomAttributeContainerType if the string is valid.
+ * @param type The container type string to parse.
+ * @beta
+ */
+export declare function parseCustomAttributeContainerType(type: string): CustomAttributeContainerType | undefined;
+/**
+ * Creates a string representing a valid CustomAttributeContainerType.
+ * @param value The CustomAttributeContainerType to stringify.
+ * @return A string representing the provided CustomAttributeContainerType. If the type is not valid, an empty string is returned.
+ * @beta
+ */
+export declare function containerTypeToString(type: CustomAttributeContainerType): string;
+/** @beta */
+export declare function parseRelationshipEnd(end: string): RelationshipEnd | undefined;
+/** @beta */
+export declare function relationshipEndToString(end: RelationshipEnd): string;
+/**
+ * Takes a string representing a StrengthType, will parse it and return the corresponding StrengthType.
+ * @throws ECObjectsStatus.InvalidStrength if the provided string that is not valid
+ * @param strength
+ * @beta
+ */
+export declare function parseStrength(strength: string): StrengthType | undefined;
+/** @beta */
+export declare function strengthToString(strength: StrengthType): string;
+/** @beta */
+export declare function parseStrengthDirection(direction: string): StrengthDirection | undefined;
+/** @beta */
+export declare function strengthDirectionToString(direction: StrengthDirection): string;
 //# sourceMappingURL=ECObjects.d.ts.map