@itwin/ecschema-metadata 5.0.0-dev.11 → 5.0.0-dev.111

package/lib/cjs/Deserialization/XmlSerializationUtils.js

@@ -19,19 +19,16 @@ var XmlSerializationUtils;
      * @param customAttribute The CustomAttribute instance to serialize.
      * @param schemaDoc The Xml Document object holding the serialized EC Schema.
      * @param schema The Schema object being serialized.
-     * @beta
      */
     async function writeCustomAttribute(fullName, customAttribute, schemaDoc, schema) {
         const caClass = await schema.lookupItem(fullName);
         if (!caClass)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.ClassNotFound, `The class '${fullName}' could not be found in the current schema context.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.ClassNotFound, `The class '${fullName}' could not be found in the current schema context.`);
         const nameAndNamespace = await resolveCustomAttributeNamespace(fullName, schema);
         const caElement = schemaDoc.createElement(nameAndNamespace[0]);
         if (nameAndNamespace[1])
             caElement.setAttribute("xmlns", nameAndNamespace[1]);
-        if (!caClass.properties)
-            return caElement;
-        for (const property of caClass.properties)
+        for (const property of await caClass.getProperties())
             await writeInstanceProperty(property, customAttribute, caElement, schemaDoc);
         return caElement;
     }
@@ -42,7 +39,6 @@ var XmlSerializationUtils;
      * @param instance The Property instance.
      * @param instanceElement The XML Element that will contain the serialized property instance.
      * @param schemaDoc The Xml Document object holding the serialized EC Schema.
-     * @beta
      */
     async function writeInstanceProperty(propertyClass, instance, instanceElement, schemaDoc) {
         const propertyValue = instance[propertyClass.name];
@@ -67,7 +63,6 @@ var XmlSerializationUtils;
      * @param propertyValue An array holding the property values.
      * @param arrayElement The XML Element that will contain the serialized property instance.
      * @param schemaDoc The Xml Document object holding the serialized EC Schema.
-     * @beta
      */
     async function writeArrayProperty(propertyClass, propertyValue, arrayElement, schemaDoc) {
         if (propertyClass.isPrimitive()) {
@@ -93,13 +88,10 @@ var XmlSerializationUtils;
      * @param propertyValue The struct object holding the property values.
      * @param structElement The XML Element that will contain the serialized property instance.
      * @param schemaDoc The Xml Document object holding the serialized EC Schema.
-     * @beta
      */
     async function writeStructProperty(propertyClass, propertyValue, structElement, schemaDoc) {
         const structClass = propertyClass.structClass;
-        if (!structClass.properties)
-            return;
-        for (const propertyMetadata of structClass.properties)
+        for (const propertyMetadata of structClass.getPropertiesSync(true))
             await writeInstanceProperty(propertyMetadata, propertyValue, structElement, schemaDoc);
     }
     XmlSerializationUtils.writeStructProperty = writeStructProperty;
@@ -108,16 +100,15 @@ var XmlSerializationUtils;
      * @param propertyClass The Property metadata object.
      * @param propertyValue The struct object holding the property values.
      * @param propertyElement The XML Element that will contain the serialized property instance.
-     * @beta
      */
     async function writePrimitiveProperty(propertyClass, propertyValue, propertyElement) {
         let primitiveType;
         if (propertyClass.isEnumeration()) {
             const enumeration = await propertyClass.enumeration;
             if (!enumeration)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.ClassNotFound, `The enumeration on property class '${propertyClass.fullName}' could not be found in the current schema context.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.ClassNotFound, `The enumeration on property class '${propertyClass.fullName}' could not be found in the current schema context.`);
             if (enumeration.type === undefined)
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidType, `The enumeration on property class '${propertyClass.fullName}' has an invalid primitive type.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidType, `The enumeration on property class '${propertyClass.fullName}' has an invalid primitive type.`);
             primitiveType = enumeration.type;
         }
         else
@@ -148,7 +139,7 @@ var XmlSerializationUtils;
                 propertyElement.textContent = propertyValue;
                 return;
             default:
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidPrimitiveType, `The property '${propertyClass.fullName}' has an invalid primitive type.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidPrimitiveType, `The property '${propertyClass.fullName}' has an invalid primitive type.`);
         }
     }
     XmlSerializationUtils.writePrimitiveProperty = writePrimitiveProperty;
@@ -158,7 +149,7 @@ var XmlSerializationUtils;
         // Alias is required in Spec. It could be undefined (technically), so
         // throw until fixed.
         if (typeSchema.alias === undefined)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaAlias, `The schema '${typeSchema.name}' has an invalid alias.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaAlias, `The schema '${typeSchema.name}' has an invalid alias.`);
         return `${typeSchema.alias}:${typeName}`;
     }
     XmlSerializationUtils.createXmlTypedName = createXmlTypedName;
@@ -168,7 +159,7 @@ var XmlSerializationUtils;
             return [caName, undefined];
         const attributeSchema = nameParts[0].toUpperCase() === schema.name.toUpperCase() ? schema : await schema.getReference(nameParts[0]);
         if (!attributeSchema)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.UnableToLocateSchema, `Unable to resolve the namespace for CustomAttribute '${caName}' because the referenced schema '${nameParts[0]}' could not be located.`);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.UnableToLocateSchema, `Unable to resolve the namespace for CustomAttribute '${caName}' because the referenced schema '${nameParts[0]}' could not be located.`);
         return [nameParts[1], `${nameParts[0]}.${attributeSchema.schemaKey.version.toString()}`];
     }
 })(XmlSerializationUtils || (exports.XmlSerializationUtils = XmlSerializationUtils = {}));

package/lib/cjs/Deserialization/XmlSerializationUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"XmlSerializationUtils.js","sourceRoot":"","sources":["../../../src/Deserialization/XmlSerializationUtils.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,4CAAoE;AACpE,4CAA+D;AAM/D;;;GAGG;AACH,IAAiB,qBAAqB,CA4KrC;AA5KD,WAAiB,qBAAqB;IACpC;;;;;;;OAOG;IACI,KAAK,UAAU,oBAAoB,CAAC,QAAgB,EAAE,eAAgC,EAAE,SAAmB,EAAE,MAAc;QAChI,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAyB,CAAC;QAC1E,IAAI,CAAC,OAAO;YACV,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,cAAc,QAAQ,qDAAqD,CAAC,CAAC;QAEvI,MAAM,gBAAgB,GAAG,MAAM,+BAA+B,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACjF,MAAM,SAAS,GAAG,SAAS,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/D,IAAI,gBAAgB,CAAC,CAAC,CAAC;YACrB,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;QAEvD,IAAI,CAAC,OAAO,CAAC,UAAU;YACrB,OAAO,SAAS,CAAC;QAEnB,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU;YACvC,MAAM,qBAAqB,CAAC,QAAQ,EAAE,eAAe,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAE/E,OAAO,SAAS,CAAC;IACnB,CAAC;IAlBqB,0CAAoB,uBAkBzC,CAAA;IAED;;;;;;;OAOG;IACI,KAAK,UAAU,qBAAqB,CAAC,aAAuB,EAAE,QAAa,EAAE,eAAwB,EAAE,SAAmB;QAC/H,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,aAAa,KAAK,SAAS;YAC7B,OAAO;QAET,MAAM,eAAe,GAAG,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACpE,eAAe,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAE7C,IAAI,aAAa,CAAC,OAAO,EAAE,EAAE,CAAC;YAC5B,MAAM,kBAAkB,CAAC,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACrF,CAAC;aAAM,IAAI,aAAa,CAAC,WAAW,EAAE,EAAE,CAAC;YACvC,MAAM,sBAAsB,CAAC,aAAa,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;QAC9E,CAAC;aAAM,IAAI,aAAa,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpC,MAAM,mBAAmB,CAAC,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAfqB,2CAAqB,wBAe1C,CAAA;IAED;;;;;;;OAOG;IACI,KAAK,UAAU,kBAAkB,CAAC,aAA4B,EAAE,aAAoB,EAAE,YAAqB,EAAE,SAAmB;QACrI,IAAI,aAAa,CAAC,WAAW,EAAE,EAAE,CAAC;YAChC,MAAM,UAAU,GAAG,IAAA,iCAAqB,EAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YACtE,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;gBAClC,MAAM,YAAY,GAAG,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;gBACzD,MAAM,sBAAsB,CAAC,aAAa,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;gBACjE,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QAED,IAAI,aAAa,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC7B,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;gBAClC,MAAM,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC9E,YAAY,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;gBACxC,MAAM,mBAAmB,CAAC,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;IACH,CAAC;IAjBqB,wCAAkB,qBAiBvC,CAAA;IAED;;;;;;;OAOG;IACI,KAAK,UAAU,mBAAmB,CAAC,aAA6B,EAAE,aAAkB,EAAE,aAAsB,EAAE,SAAmB;QACtI,MAAM,WAAW,GAAG,aAAa,CAAC,WAAW,CAAC;QAC9C,IAAI,CAAC,WAAW,CAAC,UAAU;YACzB,OAAO;QAET,KAAK,MAAM,gBAAgB,IAAI,WAAW,CAAC,UAAU;YACnD,MAAM,qBAAqB,CAAC,gBAAgB,EAAE,aAAa,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;IAC3F,CAAC;IAPqB,yCAAmB,sBAOxC,CAAA;IAED;;;;;;OAMG;IACI,KAAK,UAAU,sBAAsB,CAAC,aAA0C,EAAE,aAAkB,EAAE,eAAwB;QACnI,IAAI,aAA4B,CAAC;QACjC,IAAI,aAAa,CAAC,aAAa,EAAE,EAAE,CAAC;YAClC,MAAM,WAAW,GAAG,MAAO,aAAqC,CAAC,WAAW,CAAC;YAC7E,IAAI,CAAC,WAAW;gBACd,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,EAAE,sCAAsC,aAAa,CAAC,QAAQ,qDAAqD,CAAC,CAAC;YAE7K,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS;gBAChC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,WAAW,EAAE,sCAAsC,aAAa,CAAC,QAAQ,kCAAkC,CAAC,CAAC;YAExJ,aAAa,GAAG,WAAW,CAAC,IAAI,CAAC;QACnC,CAAC;;YACC,aAAa,GAAI,aAAmC,CAAC,aAAa,CAAC;QAErE,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,yBAAa,CAAC,MAAM;gBACvB,eAAe,CAAC,WAAW,GAAG,aAAa,CAAC;gBAC5C,OAAO;YACT,KAAK,yBAAa,CAAC,OAAO;gBACxB,eAAe,CAAC,WAAW,GAAI,aAAyB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;gBAC5E,OAAO;YACT,KAAK,yBAAa,CAAC,OAAO,CAAC;YAC3B,KAAK,yBAAa,CAAC,MAAM,CAAC;YAC1B,KAAK,yBAAa,CAAC,IAAI;gBACrB,eAAe,CAAC,WAAW,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC;gBACvD,OAAO;YACT,KAAK,yBAAa,CAAC,QAAQ;gBACzB,eAAe,CAAC,WAAW,GAAG,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;gBAC3E,OAAO;YACT,KAAK,yBAAa,CAAC,OAAO;gBACxB,eAAe,CAAC,WAAW,GAAG,GAAG,aAAa,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC;gBACtE,OAAO;YACT,KAAK,yBAAa,CAAC,OAAO;gBACxB,eAAe,CAAC,WAAW,GAAG,GAAG,aAAa,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC;gBACzF,OAAO;YACT,KAAK,yBAAa,CAAC,SAAS,CAAC;YAC7B,KAAK,yBAAa,CAAC,MAAM;gBACvB,eAAe,CAAC,WAAW,GAAG,aAAa,CAAC;gBAC5C,OAAO;YACT;gBACE,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,oBAAoB,EAAE,iBAAiB,aAAa,CAAC,QAAQ,kCAAkC,CAAC,CAAC;QAC9I,CAAC;IACH,CAAC;IA1CqB,4CAAsB,yBA0C3C,CAAA;IAED,SAAgB,kBAAkB,CAAC,aAAqB,EAAE,UAAkB,EAAE,QAAgB;QAC5F,IAAI,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC;YACvD,OAAO,QAAQ,CAAC;QAElB,qEAAqE;QACrE,qBAAqB;QACrB,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS;YAChC,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,kBAAkB,EAAE,eAAe,UAAU,CAAC,IAAI,yBAAyB,CAAC,CAAC;QAExH,OAAO,GAAG,UAAU,CAAC,KAAK,IAAI,QAAQ,EAAE,CAAC;IAC3C,CAAC;IAVe,wCAAkB,qBAUjC,CAAA;IAED,KAAK,UAAU,+BAA+B,CAAC,MAAc,EAAE,MAAc;QAC3E,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;YACxB,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAE7B,MAAM,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACpI,IAAI,CAAC,eAAe;YAClB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,oBAAoB,EAAE,wDAAwD,MAAM,oCAAoC,SAAS,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC;QAE1M,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC3F,CAAC;AACH,CAAC,EA5KgB,qBAAqB,qCAArB,qBAAqB,QA4KrC","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\r\nimport { PrimitiveType, primitiveTypeToString } from \"../ECObjects\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"../Exception\";\r\nimport { CustomAttribute } from \"../Metadata/CustomAttribute\";\r\nimport { CustomAttributeClass } from \"../Metadata/CustomAttributeClass\";\r\nimport { ArrayProperty, EnumerationProperty, PrimitiveOrEnumPropertyBase, PrimitiveProperty, Property, StructProperty } from \"../Metadata/Property\";\r\nimport { Schema } from \"../Metadata/Schema\";\r\n\r\n/**\r\n * Namespace holding utility functions for serializing EC types to the EC XML format.\r\n * @internal\r\n */\r\nexport namespace XmlSerializationUtils {\r\n  /**\r\n   * Serializes a CustomAttribute instance to the EC XML format.\r\n   * @param fullName The full name of the CustomAttribute (qualified by schema name).\r\n   * @param customAttribute The CustomAttribute instance to serialize.\r\n   * @param schemaDoc The Xml Document object holding the serialized EC Schema.\r\n   * @param schema The Schema object being serialized.\r\n   * @beta\r\n   */\r\n  export async function writeCustomAttribute(fullName: string, customAttribute: CustomAttribute, schemaDoc: Document, schema: Schema): Promise<Element> {\r\n    const caClass = await schema.lookupItem(fullName) as CustomAttributeClass;\r\n    if (!caClass)\r\n      throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `The class '${fullName}' could not be found in the current schema context.`);\r\n\r\n    const nameAndNamespace = await resolveCustomAttributeNamespace(fullName, schema);\r\n    const caElement = schemaDoc.createElement(nameAndNamespace[0]);\r\n\r\n    if (nameAndNamespace[1])\r\n      caElement.setAttribute(\"xmlns\", nameAndNamespace[1]);\r\n\r\n    if (!caClass.properties)\r\n      return caElement;\r\n\r\n    for (const property of caClass.properties)\r\n      await writeInstanceProperty(property, customAttribute, caElement, schemaDoc);\r\n\r\n    return caElement;\r\n  }\r\n\r\n  /**\r\n   * Serializes an EC Property instance to the EC XML format.\r\n   * @param propertyClass The Property metadata object.\r\n   * @param instance The Property instance.\r\n   * @param instanceElement The XML Element that will contain the serialized property instance.\r\n   * @param schemaDoc The Xml Document object holding the serialized EC Schema.\r\n   * @beta\r\n   */\r\n  export async function writeInstanceProperty(propertyClass: Property, instance: any, instanceElement: Element, schemaDoc: Document): Promise<void> {\r\n    const propertyValue = instance[propertyClass.name];\r\n    if (propertyValue === undefined)\r\n      return;\r\n\r\n    const propertyElement = schemaDoc.createElement(propertyClass.name);\r\n    instanceElement.appendChild(propertyElement);\r\n\r\n    if (propertyClass.isArray()) {\r\n      await writeArrayProperty(propertyClass, propertyValue, propertyElement, schemaDoc);\r\n    } else if (propertyClass.isPrimitive()) {\r\n      await writePrimitiveProperty(propertyClass, propertyValue, propertyElement);\r\n    } else if (propertyClass.isStruct()) {\r\n      await writeStructProperty(propertyClass, propertyValue, propertyElement, schemaDoc);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Serializes an EC ArrayProperty instance to the EC XML format.\r\n   * @param propertyClass The Property metadata object.\r\n   * @param propertyValue An array holding the property values.\r\n   * @param arrayElement The XML Element that will contain the serialized property instance.\r\n   * @param schemaDoc The Xml Document object holding the serialized EC Schema.\r\n   * @beta\r\n   */\r\n  export async function writeArrayProperty(propertyClass: ArrayProperty, propertyValue: any[], arrayElement: Element, schemaDoc: Document): Promise<void> {\r\n    if (propertyClass.isPrimitive()) {\r\n      const typeString = primitiveTypeToString(propertyClass.primitiveType);\r\n      for (const value of propertyValue) {\r\n        const entryElement = schemaDoc.createElement(typeString);\r\n        await writePrimitiveProperty(propertyClass, value, entryElement);\r\n        arrayElement.appendChild(entryElement);\r\n      }\r\n    }\r\n\r\n    if (propertyClass.isStruct()) {\r\n      for (const value of propertyValue) {\r\n        const structElement = schemaDoc.createElement(propertyClass.structClass.name);\r\n        arrayElement.appendChild(structElement);\r\n        await writeStructProperty(propertyClass, value, structElement, schemaDoc);\r\n      }\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Serializes an EC StructProperty instance to the EC XML format.\r\n   * @param propertyClass The Property metadata object.\r\n   * @param propertyValue The struct object holding the property values.\r\n   * @param structElement The XML Element that will contain the serialized property instance.\r\n   * @param schemaDoc The Xml Document object holding the serialized EC Schema.\r\n   * @beta\r\n   */\r\n  export async function writeStructProperty(propertyClass: StructProperty, propertyValue: any, structElement: Element, schemaDoc: Document): Promise<void> {\r\n    const structClass = propertyClass.structClass;\r\n    if (!structClass.properties)\r\n      return;\r\n\r\n    for (const propertyMetadata of structClass.properties)\r\n      await writeInstanceProperty(propertyMetadata, propertyValue, structElement, schemaDoc);\r\n  }\r\n\r\n  /**\r\n   * Serializes an EC PrimitiveProperty instance to the EC XML format.\r\n   * @param propertyClass The Property metadata object.\r\n   * @param propertyValue The struct object holding the property values.\r\n   * @param propertyElement The XML Element that will contain the serialized property instance.\r\n   * @beta\r\n   */\r\n  export async function writePrimitiveProperty(propertyClass: PrimitiveOrEnumPropertyBase, propertyValue: any, propertyElement: Element): Promise<void> {\r\n    let primitiveType: PrimitiveType;\r\n    if (propertyClass.isEnumeration()) {\r\n      const enumeration = await (propertyClass as EnumerationProperty).enumeration;\r\n      if (!enumeration)\r\n        throw new ECObjectsError(ECObjectsStatus.ClassNotFound, `The enumeration on property class '${propertyClass.fullName}' could not be found in the current schema context.`);\r\n\r\n      if (enumeration.type === undefined)\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidType, `The enumeration on property class '${propertyClass.fullName}' has an invalid primitive type.`);\r\n\r\n      primitiveType = enumeration.type;\r\n    } else\r\n      primitiveType = (propertyClass as PrimitiveProperty).primitiveType;\r\n\r\n    switch (primitiveType) {\r\n      case PrimitiveType.String:\r\n        propertyElement.textContent = propertyValue;\r\n        return;\r\n      case PrimitiveType.Boolean:\r\n        propertyElement.textContent = (propertyValue as boolean) ? \"True\" : \"False\";\r\n        return;\r\n      case PrimitiveType.Integer:\r\n      case PrimitiveType.Double:\r\n      case PrimitiveType.Long:\r\n        propertyElement.textContent = propertyValue.toString();\r\n        return;\r\n      case PrimitiveType.DateTime:\r\n        propertyElement.textContent = new Date(propertyValue).getTime().toString();\r\n        return;\r\n      case PrimitiveType.Point2d:\r\n        propertyElement.textContent = `${propertyValue.x},${propertyValue.y}`;\r\n        return;\r\n      case PrimitiveType.Point3d:\r\n        propertyElement.textContent = `${propertyValue.x},${propertyValue.y},${propertyValue.z}`;\r\n        return;\r\n      case PrimitiveType.IGeometry:\r\n      case PrimitiveType.Binary:\r\n        propertyElement.textContent = propertyValue;\r\n        return;\r\n      default:\r\n        throw new ECObjectsError(ECObjectsStatus.InvalidPrimitiveType, `The property '${propertyClass.fullName}' has an invalid primitive type.`);\r\n    }\r\n  }\r\n\r\n  export function createXmlTypedName(currentSchema: Schema, typeSchema: Schema, typeName: string) {\r\n    if (currentSchema.schemaKey.matches(typeSchema.schemaKey))\r\n      return typeName;\r\n\r\n    // Alias is required in Spec. It could be undefined (technically), so\r\n    // throw until fixed.\r\n    if (typeSchema.alias === undefined)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidSchemaAlias, `The schema '${typeSchema.name}' has an invalid alias.`);\r\n\r\n    return `${typeSchema.alias}:${typeName}`;\r\n  }\r\n\r\n  async function resolveCustomAttributeNamespace(caName: string, schema: Schema): Promise<[string, string | undefined]> {\r\n    const nameParts = caName.split(\".\");\r\n    if (nameParts.length === 1)\r\n      return [caName, undefined];\r\n\r\n    const attributeSchema = nameParts[0].toUpperCase() === schema.name.toUpperCase() ? schema : await schema.getReference(nameParts[0]);\r\n    if (!attributeSchema)\r\n      throw new ECObjectsError(ECObjectsStatus.UnableToLocateSchema, `Unable to resolve the namespace for CustomAttribute '${caName}' because the referenced schema '${nameParts[0]}' could not be located.`);\r\n\r\n    return [nameParts[1], `${nameParts[0]}.${attributeSchema.schemaKey.version.toString()}`];\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"XmlSerializationUtils.js","sourceRoot":"","sources":["../../../src/Deserialization/XmlSerializationUtils.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,4CAAoE;AACpE,4CAA6D;AAM7D;;;GAGG;AACH,IAAiB,qBAAqB,CAiKrC;AAjKD,WAAiB,qBAAqB;IACpC;;;;;;OAMG;IACI,KAAK,UAAU,oBAAoB,CAAC,QAAgB,EAAE,eAAgC,EAAE,SAAmB,EAAE,MAAc;QAChI,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAyB,CAAC;QAC1E,IAAI,CAAC,OAAO;YACV,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,cAAc,QAAQ,qDAAqD,CAAC,CAAC;QAErI,MAAM,gBAAgB,GAAG,MAAM,+BAA+B,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACjF,MAAM,SAAS,GAAG,SAAS,CAAC,aAAa,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;QAE/D,IAAI,gBAAgB,CAAC,CAAC,CAAC;YACrB,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;QAEvD,KAAK,MAAM,QAAQ,IAAI,MAAM,OAAO,CAAC,aAAa,EAAE;YAClD,MAAM,qBAAqB,CAAC,QAAQ,EAAE,eAAe,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAE/E,OAAO,SAAS,CAAC;IACnB,CAAC;IAfqB,0CAAoB,uBAezC,CAAA;IAED;;;;;;OAMG;IACI,KAAK,UAAU,qBAAqB,CAAC,aAAuB,EAAE,QAAa,EAAE,eAAwB,EAAE,SAAmB;QAC/H,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,aAAa,KAAK,SAAS;YAC7B,OAAO;QAET,MAAM,eAAe,GAAG,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QACpE,eAAe,CAAC,WAAW,CAAC,eAAe,CAAC,CAAC;QAE7C,IAAI,aAAa,CAAC,OAAO,EAAE,EAAE,CAAC;YAC5B,MAAM,kBAAkB,CAAC,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACrF,CAAC;aAAM,IAAI,aAAa,CAAC,WAAW,EAAE,EAAE,CAAC;YACvC,MAAM,sBAAsB,CAAC,aAAa,EAAE,aAAa,EAAE,eAAe,CAAC,CAAC;QAC9E,CAAC;aAAM,IAAI,aAAa,CAAC,QAAQ,EAAE,EAAE,CAAC;YACpC,MAAM,mBAAmB,CAAC,aAAa,EAAE,aAAa,EAAE,eAAe,EAAE,SAAS,CAAC,CAAC;QACtF,CAAC;IACH,CAAC;IAfqB,2CAAqB,wBAe1C,CAAA;IAED;;;;;;OAMG;IACI,KAAK,UAAU,kBAAkB,CAAC,aAA4B,EAAE,aAAoB,EAAE,YAAqB,EAAE,SAAmB;QACrI,IAAI,aAAa,CAAC,WAAW,EAAE,EAAE,CAAC;YAChC,MAAM,UAAU,GAAG,IAAA,iCAAqB,EAAC,aAAa,CAAC,aAAa,CAAC,CAAC;YACtE,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;gBAClC,MAAM,YAAY,GAAG,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;gBACzD,MAAM,sBAAsB,CAAC,aAAa,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;gBACjE,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;QAED,IAAI,aAAa,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC7B,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;gBAClC,MAAM,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBAC9E,YAAY,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;gBACxC,MAAM,mBAAmB,CAAC,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;YAC5E,CAAC;QACH,CAAC;IACH,CAAC;IAjBqB,wCAAkB,qBAiBvC,CAAA;IAED;;;;;;OAMG;IACI,KAAK,UAAU,mBAAmB,CAAC,aAA6B,EAAE,aAAkB,EAAE,aAAsB,EAAE,SAAmB;QACtI,MAAM,WAAW,GAAG,aAAa,CAAC,WAAW,CAAC;QAC9C,KAAK,MAAM,gBAAgB,IAAI,WAAW,CAAC,iBAAiB,CAAC,IAAI,CAAC;YAChE,MAAM,qBAAqB,CAAC,gBAAgB,EAAE,aAAa,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;IAC3F,CAAC;IAJqB,yCAAmB,sBAIxC,CAAA;IAED;;;;;OAKG;IACI,KAAK,UAAU,sBAAsB,CAAC,aAA0C,EAAE,aAAkB,EAAE,eAAwB;QACnI,IAAI,aAA4B,CAAC;QACjC,IAAI,aAAa,CAAC,aAAa,EAAE,EAAE,CAAC;YAClC,MAAM,WAAW,GAAG,MAAO,aAAqC,CAAC,WAAW,CAAC;YAC7E,IAAI,CAAC,WAAW;gBACd,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,EAAE,sCAAsC,aAAa,CAAC,QAAQ,qDAAqD,CAAC,CAAC;YAE3K,IAAI,WAAW,CAAC,IAAI,KAAK,SAAS;gBAChC,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,WAAW,EAAE,sCAAsC,aAAa,CAAC,QAAQ,kCAAkC,CAAC,CAAC;YAEtJ,aAAa,GAAG,WAAW,CAAC,IAAI,CAAC;QACnC,CAAC;;YACC,aAAa,GAAI,aAAmC,CAAC,aAAa,CAAC;QAErE,QAAQ,aAAa,EAAE,CAAC;YACtB,KAAK,yBAAa,CAAC,MAAM;gBACvB,eAAe,CAAC,WAAW,GAAG,aAAa,CAAC;gBAC5C,OAAO;YACT,KAAK,yBAAa,CAAC,OAAO;gBACxB,eAAe,CAAC,WAAW,GAAI,aAAyB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;gBAC5E,OAAO;YACT,KAAK,yBAAa,CAAC,OAAO,CAAC;YAC3B,KAAK,yBAAa,CAAC,MAAM,CAAC;YAC1B,KAAK,yBAAa,CAAC,IAAI;gBACrB,eAAe,CAAC,WAAW,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC;gBACvD,OAAO;YACT,KAAK,yBAAa,CAAC,QAAQ;gBACzB,eAAe,CAAC,WAAW,GAAG,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC;gBAC3E,OAAO;YACT,KAAK,yBAAa,CAAC,OAAO;gBACxB,eAAe,CAAC,WAAW,GAAG,GAAG,aAAa,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC;gBACtE,OAAO;YACT,KAAK,yBAAa,CAAC,OAAO;gBACxB,eAAe,CAAC,WAAW,GAAG,GAAG,aAAa,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,IAAI,aAAa,CAAC,CAAC,EAAE,CAAC;gBACzF,OAAO;YACT,KAAK,yBAAa,CAAC,SAAS,CAAC;YAC7B,KAAK,yBAAa,CAAC,MAAM;gBACvB,eAAe,CAAC,WAAW,GAAG,aAAa,CAAC;gBAC5C,OAAO;YACT;gBACE,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,oBAAoB,EAAE,iBAAiB,aAAa,CAAC,QAAQ,kCAAkC,CAAC,CAAC;QAC5I,CAAC;IACH,CAAC;IA1CqB,4CAAsB,yBA0C3C,CAAA;IAED,SAAgB,kBAAkB,CAAC,aAAqB,EAAE,UAAkB,EAAE,QAAgB;QAC5F,IAAI,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC;YACvD,OAAO,QAAQ,CAAC;QAElB,qEAAqE;QACrE,qBAAqB;QACrB,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS;YAChC,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,kBAAkB,EAAE,eAAe,UAAU,CAAC,IAAI,yBAAyB,CAAC,CAAC;QAEtH,OAAO,GAAG,UAAU,CAAC,KAAK,IAAI,QAAQ,EAAE,CAAC;IAC3C,CAAC;IAVe,wCAAkB,qBAUjC,CAAA;IAED,KAAK,UAAU,+BAA+B,CAAC,MAAc,EAAE,MAAc;QAC3E,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;YACxB,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAE7B,MAAM,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QACpI,IAAI,CAAC,eAAe;YAClB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,oBAAoB,EAAE,wDAAwD,MAAM,oCAAoC,SAAS,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC;QAExM,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,eAAe,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC3F,CAAC;AACH,CAAC,EAjKgB,qBAAqB,qCAArB,qBAAqB,QAiKrC","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\nimport { PrimitiveType, primitiveTypeToString } from \"../ECObjects\";\nimport { ECSchemaError, ECSchemaStatus } from \"../Exception\";\nimport { CustomAttribute } from \"../Metadata/CustomAttribute\";\nimport { CustomAttributeClass } from \"../Metadata/CustomAttributeClass\";\nimport { ArrayProperty, EnumerationProperty, PrimitiveOrEnumPropertyBase, PrimitiveProperty, Property, StructProperty } from \"../Metadata/Property\";\nimport { Schema } from \"../Metadata/Schema\";\n\n/**\n * Namespace holding utility functions for serializing EC types to the EC XML format.\n * @internal\n */\nexport namespace XmlSerializationUtils {\n  /**\n   * Serializes a CustomAttribute instance to the EC XML format.\n   * @param fullName The full name of the CustomAttribute (qualified by schema name).\n   * @param customAttribute The CustomAttribute instance to serialize.\n   * @param schemaDoc The Xml Document object holding the serialized EC Schema.\n   * @param schema The Schema object being serialized.\n   */\n  export async function writeCustomAttribute(fullName: string, customAttribute: CustomAttribute, schemaDoc: Document, schema: Schema): Promise<Element> {\n    const caClass = await schema.lookupItem(fullName) as CustomAttributeClass;\n    if (!caClass)\n      throw new ECSchemaError(ECSchemaStatus.ClassNotFound, `The class '${fullName}' could not be found in the current schema context.`);\n\n    const nameAndNamespace = await resolveCustomAttributeNamespace(fullName, schema);\n    const caElement = schemaDoc.createElement(nameAndNamespace[0]);\n\n    if (nameAndNamespace[1])\n      caElement.setAttribute(\"xmlns\", nameAndNamespace[1]);\n\n    for (const property of await caClass.getProperties())\n      await writeInstanceProperty(property, customAttribute, caElement, schemaDoc);\n\n    return caElement;\n  }\n\n  /**\n   * Serializes an EC Property instance to the EC XML format.\n   * @param propertyClass The Property metadata object.\n   * @param instance The Property instance.\n   * @param instanceElement The XML Element that will contain the serialized property instance.\n   * @param schemaDoc The Xml Document object holding the serialized EC Schema.\n   */\n  export async function writeInstanceProperty(propertyClass: Property, instance: any, instanceElement: Element, schemaDoc: Document): Promise<void> {\n    const propertyValue = instance[propertyClass.name];\n    if (propertyValue === undefined)\n      return;\n\n    const propertyElement = schemaDoc.createElement(propertyClass.name);\n    instanceElement.appendChild(propertyElement);\n\n    if (propertyClass.isArray()) {\n      await writeArrayProperty(propertyClass, propertyValue, propertyElement, schemaDoc);\n    } else if (propertyClass.isPrimitive()) {\n      await writePrimitiveProperty(propertyClass, propertyValue, propertyElement);\n    } else if (propertyClass.isStruct()) {\n      await writeStructProperty(propertyClass, propertyValue, propertyElement, schemaDoc);\n    }\n  }\n\n  /**\n   * Serializes an EC ArrayProperty instance to the EC XML format.\n   * @param propertyClass The Property metadata object.\n   * @param propertyValue An array holding the property values.\n   * @param arrayElement The XML Element that will contain the serialized property instance.\n   * @param schemaDoc The Xml Document object holding the serialized EC Schema.\n   */\n  export async function writeArrayProperty(propertyClass: ArrayProperty, propertyValue: any[], arrayElement: Element, schemaDoc: Document): Promise<void> {\n    if (propertyClass.isPrimitive()) {\n      const typeString = primitiveTypeToString(propertyClass.primitiveType);\n      for (const value of propertyValue) {\n        const entryElement = schemaDoc.createElement(typeString);\n        await writePrimitiveProperty(propertyClass, value, entryElement);\n        arrayElement.appendChild(entryElement);\n      }\n    }\n\n    if (propertyClass.isStruct()) {\n      for (const value of propertyValue) {\n        const structElement = schemaDoc.createElement(propertyClass.structClass.name);\n        arrayElement.appendChild(structElement);\n        await writeStructProperty(propertyClass, value, structElement, schemaDoc);\n      }\n    }\n  }\n\n  /**\n   * Serializes an EC StructProperty instance to the EC XML format.\n   * @param propertyClass The Property metadata object.\n   * @param propertyValue The struct object holding the property values.\n   * @param structElement The XML Element that will contain the serialized property instance.\n   * @param schemaDoc The Xml Document object holding the serialized EC Schema.\n   */\n  export async function writeStructProperty(propertyClass: StructProperty, propertyValue: any, structElement: Element, schemaDoc: Document): Promise<void> {\n    const structClass = propertyClass.structClass;\n    for (const propertyMetadata of structClass.getPropertiesSync(true))\n      await writeInstanceProperty(propertyMetadata, propertyValue, structElement, schemaDoc);\n  }\n\n  /**\n   * Serializes an EC PrimitiveProperty instance to the EC XML format.\n   * @param propertyClass The Property metadata object.\n   * @param propertyValue The struct object holding the property values.\n   * @param propertyElement The XML Element that will contain the serialized property instance.\n   */\n  export async function writePrimitiveProperty(propertyClass: PrimitiveOrEnumPropertyBase, propertyValue: any, propertyElement: Element): Promise<void> {\n    let primitiveType: PrimitiveType;\n    if (propertyClass.isEnumeration()) {\n      const enumeration = await (propertyClass as EnumerationProperty).enumeration;\n      if (!enumeration)\n        throw new ECSchemaError(ECSchemaStatus.ClassNotFound, `The enumeration on property class '${propertyClass.fullName}' could not be found in the current schema context.`);\n\n      if (enumeration.type === undefined)\n        throw new ECSchemaError(ECSchemaStatus.InvalidType, `The enumeration on property class '${propertyClass.fullName}' has an invalid primitive type.`);\n\n      primitiveType = enumeration.type;\n    } else\n      primitiveType = (propertyClass as PrimitiveProperty).primitiveType;\n\n    switch (primitiveType) {\n      case PrimitiveType.String:\n        propertyElement.textContent = propertyValue;\n        return;\n      case PrimitiveType.Boolean:\n        propertyElement.textContent = (propertyValue as boolean) ? \"True\" : \"False\";\n        return;\n      case PrimitiveType.Integer:\n      case PrimitiveType.Double:\n      case PrimitiveType.Long:\n        propertyElement.textContent = propertyValue.toString();\n        return;\n      case PrimitiveType.DateTime:\n        propertyElement.textContent = new Date(propertyValue).getTime().toString();\n        return;\n      case PrimitiveType.Point2d:\n        propertyElement.textContent = `${propertyValue.x},${propertyValue.y}`;\n        return;\n      case PrimitiveType.Point3d:\n        propertyElement.textContent = `${propertyValue.x},${propertyValue.y},${propertyValue.z}`;\n        return;\n      case PrimitiveType.IGeometry:\n      case PrimitiveType.Binary:\n        propertyElement.textContent = propertyValue;\n        return;\n      default:\n        throw new ECSchemaError(ECSchemaStatus.InvalidPrimitiveType, `The property '${propertyClass.fullName}' has an invalid primitive type.`);\n    }\n  }\n\n  export function createXmlTypedName(currentSchema: Schema, typeSchema: Schema, typeName: string) {\n    if (currentSchema.schemaKey.matches(typeSchema.schemaKey))\n      return typeName;\n\n    // Alias is required in Spec. It could be undefined (technically), so\n    // throw until fixed.\n    if (typeSchema.alias === undefined)\n      throw new ECSchemaError(ECSchemaStatus.InvalidSchemaAlias, `The schema '${typeSchema.name}' has an invalid alias.`);\n\n    return `${typeSchema.alias}:${typeName}`;\n  }\n\n  async function resolveCustomAttributeNamespace(caName: string, schema: Schema): Promise<[string, string | undefined]> {\n    const nameParts = caName.split(\".\");\n    if (nameParts.length === 1)\n      return [caName, undefined];\n\n    const attributeSchema = nameParts[0].toUpperCase() === schema.name.toUpperCase() ? schema : await schema.getReference(nameParts[0]);\n    if (!attributeSchema)\n      throw new ECSchemaError(ECSchemaStatus.UnableToLocateSchema, `Unable to resolve the namespace for CustomAttribute '${caName}' because the referenced schema '${nameParts[0]}' could not be located.`);\n\n    return [nameParts[1], `${nameParts[0]}.${attributeSchema.schemaKey.version.toString()}`];\n  }\n}\n"]}

package/lib/cjs/ECName.d.ts

@@ -14,7 +14,7 @@
 export declare class ECName {
     private _name;
     /** Construct a new ECName from a valid EC name.
-     * throws ECObjectsError if `name` does not meet the criteria for a valid EC name.
+     * throws ECSchemaError if `name` does not meet the criteria for a valid EC name.
      */
     constructor(name: string);
     /** Returns true if a string meets the criteria of a valid EC name. */
@@ -22,7 +22,7 @@ export declare class ECName {
     /** The underlying name as a string. */
     get name(): string;
     /** 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.
+     * @throws ECSchemaError if `input` is an empty string.
      */
     static encode(input: string): ECName;
     /** Decode this ECName, replacing encoded special characters with the characters they encode. */

package/lib/cjs/ECName.js

@@ -32,12 +32,13 @@ function isValidAlphaNumericCharacter(c) {
  * @public
  */
 class ECName {
+    _name;
     /** Construct a new ECName from a valid EC name.
-     * throws ECObjectsError if `name` does not meet the criteria for a valid EC name.
+     * throws ECSchemaError 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);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECName);
         this._name = name;
     }
     /** Returns true if a string meets the criteria of a valid EC name. */
@@ -49,11 +50,11 @@ class ECName {
         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.
+     * @throws ECSchemaError if `input` is an empty string.
      */
     static encode(input) {
         if (0 === input.length)
-            throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidECName);
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidECName);
         if (ECName.validate(input)) {
             // It's already a valid EC name.
             return new ECName(input);

package/lib/cjs/ECName.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECName.js","sourceRoot":"","sources":["../../src/ECName.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,2CAA8D;AAE9D,MAAM,gBAAgB,GAAG,8BAA8B,CAAC;AACxD,MAAM,mBAAmB,GAAG,wBAAwB,CAAC;AACrD,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;AAErD,SAAS,OAAO,CAAC,SAAiB;IAChC,IAAA,qBAAM,EAAC,CAAC,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC;IAC/B,OAAO,SAAS,IAAI,GAAG,IAAI,SAAS,IAAI,GAAG,CAAC;AAC9C,CAAC;AAED,SAAS,4BAA4B,CAAC,CAAS;IAC7C,IAAA,qBAAM,EAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;IACvB,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;AACrG,CAAC;AAED;;;;;;;;;GASG;AACH,MAAa,MAAM;IAGjB;;OAEG;IACH,YAAY,IAAY;QACtB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,CAAC,CAAC;QAE1D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,sEAAsE;IAC/D,MAAM,CAAC,QAAQ,CAAC,IAAY;QACjC,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,uCAAuC;IACvC,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,KAAa;QAChC,IAAI,CAAC,KAAK,KAAK,CAAC,MAAM;YACpB,MAAM,IAAI,0BAAc,CAAC,2BAAe,CAAC,aAAa,CAAC,CAAC;QAE1D,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,gCAAgC;YAChC,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,SAAS,sBAAsB,CAAC,KAAa;YAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;YAC/D,IAAA,qBAAM,EAAC,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACzC,MAAM,IAAI,MAAM,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC;QACtD,CAAC;QAED,qCAAqC;QACrC,MAAM,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,gBAAgB;YAClB,sBAAsB,CAAC,CAAC,CAAC,CAAC;QAE5B,KAAK,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7D,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC;gBACrC,sBAAsB,CAAC,CAAC,CAAC,CAAC;;gBAE1B,MAAM,IAAI,IAAI,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED,gGAAgG;IACzF,MAAM;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAChH,CAAC;CACF;AA/DD,wBA+DC","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 Metadata\r\n */\r\n\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { ECObjectsError, ECObjectsStatus } from \"./Exception\";\r\n\r\nconst validECNameRegex = /^([a-zA-Z_]+[a-zA-Z0-9_]*)$/i;\r\nconst ecNameReplacerRegex = /__x([0-9a-fA-F]{4})__/g;\r\nconst leadingDigits = [\"0000\", \"000\", \"00\", \"0\", \"\"];\r\n\r\nfunction isDigit(character: string): boolean {\r\n  assert(1 === character.length);\r\n  return character >= \"0\" && character <= \"9\";\r\n}\r\n\r\nfunction isValidAlphaNumericCharacter(c: string): boolean {\r\n  assert(1 === c.length);\r\n  return (((c >= \"0\" && c <= \"9\") || (c >= \"A\" && c <= \"Z\") || (c >= \"a\" && c <= \"z\") || c === \"_\"));\r\n}\r\n\r\n/** The name of an item in a [[Schema]], encoded to meet restrictions on the characters usable in such names.\r\n * An ECName meets the following criteria:\r\n *  - Contains at least one character.\r\n *  - Does not begin with a digit.\r\n *  - Consists entirely of characters in the ASCII ranges A-Z, a-z, and 0-9; and the underscore (\"_\") character.\r\n *\r\n * All characters not meeting the above criteria are encoded as \"__x####__\" where \"####\" is the UTF-16 character code.\r\n * Such names are often automatically generated from the item's display label, which is unrestricted in the characters it may contain.\r\n * @public\r\n */\r\nexport class ECName {\r\n  private _name: string;\r\n\r\n  /** Construct a new ECName from a valid EC name.\r\n   * throws ECObjectsError if `name` does not meet the criteria for a valid EC name.\r\n   */\r\n  constructor(name: string) {\r\n    if (!ECName.validate(name))\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECName);\r\n\r\n    this._name = name;\r\n  }\r\n\r\n  /** Returns true if a string meets the criteria of a valid EC name. */\r\n  public static validate(name: string): boolean {\r\n    return validECNameRegex.test(name);\r\n  }\r\n\r\n  /** The underlying name as a string. */\r\n  public get name(): string {\r\n    return this._name;\r\n  }\r\n\r\n  /** Create an ECName from an arbitrary string, encoding any special characters as \"__x####__\" where \"####\" is the UTF-16 character code.\r\n   * @throws ECObjectsError if `input` is an empty string.\r\n   */\r\n  public static encode(input: string): ECName {\r\n    if (0 === input.length)\r\n      throw new ECObjectsError(ECObjectsStatus.InvalidECName);\r\n\r\n    if (ECName.validate(input)) {\r\n      // It's already a valid EC name.\r\n      return new ECName(input);\r\n    }\r\n\r\n    let output = \"\";\r\n\r\n    function appendEncodedCharacter(index: number): void {\r\n      const hex = input.charCodeAt(index).toString(16).toUpperCase();\r\n      assert(hex.length > 0 && hex.length < 5);\r\n      output += `__x${leadingDigits[hex.length]}${hex}__`;\r\n    }\r\n\r\n    // First character cannot be a digit.\r\n    const firstCharIsDigit = isDigit(input[0]);\r\n    if (firstCharIsDigit)\r\n      appendEncodedCharacter(0);\r\n\r\n    for (let i = firstCharIsDigit ? 1 : 0; i < input.length; i++) {\r\n      const char = input[i];\r\n      if (!isValidAlphaNumericCharacter(char))\r\n        appendEncodedCharacter(i);\r\n      else\r\n        output += char;\r\n    }\r\n\r\n    return new ECName(output);\r\n  }\r\n\r\n  /** Decode this ECName, replacing encoded special characters with the characters they encode. */\r\n  public decode(): string {\r\n    return this.name.replace(ecNameReplacerRegex, (_match, hex) => String.fromCharCode(Number.parseInt(hex, 16)));\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ECName.js","sourceRoot":"","sources":["../../src/ECName.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,2CAA4D;AAE5D,MAAM,gBAAgB,GAAG,8BAA8B,CAAC;AACxD,MAAM,mBAAmB,GAAG,wBAAwB,CAAC;AACrD,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;AAErD,SAAS,OAAO,CAAC,SAAiB;IAChC,IAAA,qBAAM,EAAC,CAAC,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC;IAC/B,OAAO,SAAS,IAAI,GAAG,IAAI,SAAS,IAAI,GAAG,CAAC;AAC9C,CAAC;AAED,SAAS,4BAA4B,CAAC,CAAS;IAC7C,IAAA,qBAAM,EAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;IACvB,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;AACrG,CAAC;AAED;;;;;;;;;GASG;AACH,MAAa,MAAM;IACT,KAAK,CAAS;IAEtB;;OAEG;IACH,YAAY,IAAY;QACtB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC;YACxB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,CAAC,CAAC;QAExD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,sEAAsE;IAC/D,MAAM,CAAC,QAAQ,CAAC,IAAY;QACjC,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC;IAED,uCAAuC;IACvC,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,MAAM,CAAC,KAAa;QAChC,IAAI,CAAC,KAAK,KAAK,CAAC,MAAM;YACpB,MAAM,IAAI,yBAAa,CAAC,0BAAc,CAAC,aAAa,CAAC,CAAC;QAExD,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,gCAAgC;YAChC,OAAO,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;QAED,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,SAAS,sBAAsB,CAAC,KAAa;YAC3C,MAAM,GAAG,GAAG,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;YAC/D,IAAA,qBAAM,EAAC,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YACzC,MAAM,IAAI,MAAM,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC;QACtD,CAAC;QAED,qCAAqC;QACrC,MAAM,gBAAgB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,IAAI,gBAAgB;YAClB,sBAAsB,CAAC,CAAC,CAAC,CAAC;QAE5B,KAAK,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7D,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC;gBACrC,sBAAsB,CAAC,CAAC,CAAC,CAAC;;gBAE1B,MAAM,IAAI,IAAI,CAAC;QACnB,CAAC;QAED,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC;IAED,gGAAgG;IACzF,MAAM;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;IAChH,CAAC;CACF;AA/DD,wBA+DC","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 Metadata\n */\n\nimport { assert } from \"@itwin/core-bentley\";\nimport { ECSchemaError, ECSchemaStatus } from \"./Exception\";\n\nconst validECNameRegex = /^([a-zA-Z_]+[a-zA-Z0-9_]*)$/i;\nconst ecNameReplacerRegex = /__x([0-9a-fA-F]{4})__/g;\nconst leadingDigits = [\"0000\", \"000\", \"00\", \"0\", \"\"];\n\nfunction isDigit(character: string): boolean {\n  assert(1 === character.length);\n  return character >= \"0\" && character <= \"9\";\n}\n\nfunction isValidAlphaNumericCharacter(c: string): boolean {\n  assert(1 === c.length);\n  return (((c >= \"0\" && c <= \"9\") || (c >= \"A\" && c <= \"Z\") || (c >= \"a\" && c <= \"z\") || c === \"_\"));\n}\n\n/** The name of an item in a [[Schema]], encoded to meet restrictions on the characters usable in such names.\n * An ECName meets the following criteria:\n *  - Contains at least one character.\n *  - Does not begin with a digit.\n *  - Consists entirely of characters in the ASCII ranges A-Z, a-z, and 0-9; and the underscore (\"_\") character.\n *\n * All characters not meeting the above criteria are encoded as \"__x####__\" where \"####\" is the UTF-16 character code.\n * Such names are often automatically generated from the item's display label, which is unrestricted in the characters it may contain.\n * @public\n */\nexport class ECName {\n  private _name: string;\n\n  /** Construct a new ECName from a valid EC name.\n   * throws ECSchemaError if `name` does not meet the criteria for a valid EC name.\n   */\n  constructor(name: string) {\n    if (!ECName.validate(name))\n      throw new ECSchemaError(ECSchemaStatus.InvalidECName);\n\n    this._name = name;\n  }\n\n  /** Returns true if a string meets the criteria of a valid EC name. */\n  public static validate(name: string): boolean {\n    return validECNameRegex.test(name);\n  }\n\n  /** The underlying name as a string. */\n  public get name(): string {\n    return this._name;\n  }\n\n  /** Create an ECName from an arbitrary string, encoding any special characters as \"__x####__\" where \"####\" is the UTF-16 character code.\n   * @throws ECSchemaError if `input` is an empty string.\n   */\n  public static encode(input: string): ECName {\n    if (0 === input.length)\n      throw new ECSchemaError(ECSchemaStatus.InvalidECName);\n\n    if (ECName.validate(input)) {\n      // It's already a valid EC name.\n      return new ECName(input);\n    }\n\n    let output = \"\";\n\n    function appendEncodedCharacter(index: number): void {\n      const hex = input.charCodeAt(index).toString(16).toUpperCase();\n      assert(hex.length > 0 && hex.length < 5);\n      output += `__x${leadingDigits[hex.length]}${hex}__`;\n    }\n\n    // First character cannot be a digit.\n    const firstCharIsDigit = isDigit(input[0]);\n    if (firstCharIsDigit)\n      appendEncodedCharacter(0);\n\n    for (let i = firstCharIsDigit ? 1 : 0; i < input.length; i++) {\n      const char = input[i];\n      if (!isValidAlphaNumericCharacter(char))\n        appendEncodedCharacter(i);\n      else\n        output += char;\n    }\n\n    return new ECName(output);\n  }\n\n  /** Decode this ECName, replacing encoded special characters with the characters they encode. */\n  public decode(): string {\n    return this.name.replace(ecNameReplacerRegex, (_match, hex) => String.fromCharCode(Number.parseInt(hex, 16)));\n  }\n}\n"]}

package/lib/cjs/ECObjects.d.ts

@@ -2,7 +2,11 @@
  * @module Metadata
  */
 export { PropertyType } from "./PropertyTypes";
-/** @beta */
+/**
+ * Identifies a class as abstract or sealed
+ *
+ * @public @preview
+ */
 export declare enum ECClassModifier {
     None = 0,
     Abstract = 1,
@@ -10,7 +14,10 @@ export declare enum ECClassModifier {
 }
 /**
  * An enumeration that has all the schema item type names as values
- * @beta */
+ *
+ * @enum {string}
+ * @public @preview
+ */
 export declare enum SchemaItemType {
     EntityClass = "EntityClass",
     Mixin = "Mixin",
@@ -27,9 +34,22 @@ export declare enum SchemaItemType {
     UnitSystem = "UnitSystem",
     Format = "Format"
 }
+/**
+ * Additional Schema Item Types which define classes of item types
+ * @public @preview
+ */
+export declare enum AbstractSchemaItemType {
+    Class = "Class",
+    SchemaItem = "SchemaItem"
+}
+/**
+ * Defines types of items that may be provided to identify supported items
+ * @public @preview
+ */
+export type SupportedSchemaItemType = SchemaItemType | AbstractSchemaItemType;
 /**
  * Primitive data types for ECProperties.
- * @beta
+ * @public @preview
  */
 export declare enum PrimitiveType {
     Uninitialized = 0,
@@ -46,7 +66,7 @@ export declare enum PrimitiveType {
 }
 /**
  * Defines the valid CustomAttribute container types.
- * @beta
+ * @public @preview
  */
 export declare enum CustomAttributeContainerType {
     Schema = 1,
@@ -68,7 +88,7 @@ export declare enum CustomAttributeContainerType {
 }
 /**
  * Defines what sort of match should be used when locating a schema.
- * @beta
+ * @public @preview
  */
 export declare enum SchemaMatchType {
     Identical = 0,
@@ -79,21 +99,29 @@ export declare enum SchemaMatchType {
 }
 /**
  * Identifer for an ECRelationshipConstraint. Used to determine the side of the relationship the constraint is representing.
- * @beta
+ * @public @preview
  */
 export declare enum RelationshipEnd {
     Source = 0,
     Target = 1
 }
-/** @beta */
+/**
+ * Defines the how the lifetime of the source and target are related.
+ *
+ * @public @preview */
 export declare enum StrengthType {
     Referencing = 0,
     Holding = 1,
     Embedding = 2
 }
-/** @beta */
+/**
+ * Defines the which side of the relationship is the starting point of the relationship.  This impacts how relationship strength is applied.
+ *
+ * @public @preview */
 export declare enum StrengthDirection {
+    /** The source is the starting point of the relationship. */
     Forward = 1,
+    /** The target is the starting point of the relationship. */
     Backward = 2
 }
 /**
@@ -152,7 +180,7 @@ export declare function parseRelationshipEnd(end: string): RelationshipEnd | und
 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
+ * @throws ECSchemaStatus.InvalidStrength if the provided string that is not valid
  * @param strength
  * @beta
  */
@@ -163,4 +191,8 @@ export declare function strengthToString(strength: StrengthType): string;
 export declare function parseStrengthDirection(direction: string): StrengthDirection | undefined;
 /** @beta */
 export declare function strengthDirectionToString(direction: StrengthDirection): string;
+/** Compares a SchemaItemType against supported type.
+ * @beta
+ */
+export declare function isSupportedSchemaItemType(value: SchemaItemType, supported: SupportedSchemaItemType): boolean;
 //# sourceMappingURL=ECObjects.d.ts.map

package/lib/cjs/ECObjects.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ECObjects.d.ts","sourceRoot":"","sources":["../../src/ECObjects.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAO/C,YAAY;AACZ,oBAAY,eAAe;IACzB,IAAI,IAAA;IACJ,QAAQ,IAAA;IACR,MAAM,IAAA;CACP;AAED;;WAEW;AACX,oBAAY,cAAc;IACxB,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,oBAAoB,yBAAyB;IAC7C,iBAAiB,sBAAsB;IACvC,WAAW,gBAAgB;IAC3B,cAAc,mBAAmB;IACjC,gBAAgB,qBAAqB;IACrC,IAAI,SAAS;IACb,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,MAAM,WAAW;CAClB;AAED;;;GAGG;AACH,oBAAY,aAAa;IACvB,aAAa,IAAO;IACpB,MAAM,MAAQ;IACd,OAAO,MAAQ;IACf,QAAQ,MAAQ;IAChB,MAAM,OAAQ;IACd,OAAO,OAAQ;IACf,IAAI,OAAQ;IACZ,OAAO,OAAQ;IACf,OAAO,OAAQ;IACf,MAAM,OAAQ;IACd,SAAS,OAAQ;CAClB;AAED;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,MAAM,IAAgB;IACtB,WAAW,IAAgB;IAC3B,oBAAoB,IAAgB;IACpC,WAAW,IAAgB;IAC3B,iBAAiB,KAAgB;IACjC,QAAQ,KAAuE;IAC/E,iBAAiB,KAAgB;IACjC,cAAc,KAAgB;IAC9B,sBAAsB,MAAgB;IACtC,mBAAmB,MAAgB;IACnC,kBAAkB,MAAgB;IAClC,WAAW,MAAyG;IACpH,4BAA4B,OAAiB;IAC7C,4BAA4B,OAAiB;IAC7C,yBAAyB,OAA8D;IACvF,GAAG,OAA8D;CAClE;AAED;;;GAGG;AACH,oBAAY,eAAe;IAKzB,SAAS,IAAA;IAET,KAAK,IAAA;IAEL,qBAAqB,IAAA;IAErB,MAAM,IAAA;IAEN,oBAAoB,IAAA;CACrB;AAED;;;GAGG;AACH,oBAAY,eAAe;IACzB,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED,YAAY;AACZ,oBAAY,YAAY;IACtB,WAAW,IAAA;IACX,OAAO,IAAA;IACP,SAAS,IAAA;CACV;AAED,YAAY;AACZ,oBAAY,iBAAiB;IAC3B,OAAO,IAAI;IACX,QAAQ,IAAI;CACb;AAID;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAQhF;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,CAOvE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAkB5E;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAEpE;AAED,gBAAgB;AAChB,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAkBvE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAe1E;AAED,YAAY;AACZ,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAcjE;AAED;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,IAAI,EAAE,MAAM,GAAG,4BAA4B,GAAG,SAAS,CAkExG;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,4BAA4B,GAAG,MAAM,CA0DhF;AAED,YAAY;AACZ,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAM7E;AAED,YAAY;AACZ,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,eAAe,GAAG,MAAM,CAMpE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAOxE;AAED,YAAY;AACZ,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,YAAY,GAAG,MAAM,CAO/D;AAED,YAAY;AACZ,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAMvF;AAED,YAAY;AACZ,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,iBAAiB,GAAG,MAAM,CAM9E"}
+{"version":3,"file":"ECObjects.d.ts","sourceRoot":"","sources":["../../src/ECObjects.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAO/C;;;;GAIG;AACH,oBAAY,eAAe;IAEzB,IAAI,IAAA;IAEJ,QAAQ,IAAA;IAER,MAAM,IAAA;CACP;AAED;;;;;GAKG;AACH,oBAAY,cAAc;IACxB,WAAW,gBAAgB;IAC3B,KAAK,UAAU;IACf,WAAW,gBAAgB;IAC3B,oBAAoB,yBAAyB;IAC7C,iBAAiB,sBAAsB;IACvC,WAAW,gBAAgB;IAC3B,cAAc,mBAAmB;IACjC,gBAAgB,qBAAqB;IACrC,IAAI,SAAS;IACb,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,UAAU,eAAe;IACzB,MAAM,WAAW;CAClB;AAED;;;GAGG;AACH,oBAAY,sBAAsB;IAEhC,KAAK,UAAU;IAEf,UAAU,eAAe;CAC1B;AAED;;;GAGG;AACH,MAAM,MAAM,uBAAuB,GAAG,cAAc,GAAG,sBAAsB,CAAC;AAE9E;;;GAGG;AACH,oBAAY,aAAa;IACvB,aAAa,IAAO;IACpB,MAAM,MAAQ;IACd,OAAO,MAAQ;IACf,QAAQ,MAAQ;IAChB,MAAM,OAAQ;IACd,OAAO,OAAQ;IACf,IAAI,OAAQ;IACZ,OAAO,OAAQ;IACf,OAAO,OAAQ;IACf,MAAM,OAAQ;IACd,SAAS,OAAQ;CAClB;AAED;;;GAGG;AACH,oBAAY,4BAA4B;IACtC,MAAM,IAAc;IACpB,WAAW,IAAc;IACzB,oBAAoB,IAAc;IAClC,WAAW,IAAc;IACzB,iBAAiB,KAAc;IAC/B,QAAQ,KAAuE;IAC/E,iBAAiB,KAAc;IAC/B,cAAc,KAAc;IAC5B,sBAAsB,MAAc;IACpC,mBAAmB,MAAc;IACjC,kBAAkB,MAAc;IAChC,WAAW,MAAyG;IACpH,4BAA4B,OAAe;IAC3C,4BAA4B,OAAe;IAC3C,yBAAyB,OAA8D;IACvF,GAAG,OAA8D;CAClE;AAED;;;GAGG;AACH,oBAAY,eAAe;IAKzB,SAAS,IAAA;IAET,KAAK,IAAA;IAEL,qBAAqB,IAAA;IAErB,MAAM,IAAA;IAEN,oBAAoB,IAAA;CACrB;AAED;;;GAGG;AACH,oBAAY,eAAe;IACzB,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED;;;sBAGsB;AACtB,oBAAY,YAAY;IACtB,WAAW,IAAA;IACX,OAAO,IAAA;IACP,SAAS,IAAA;CACV;AAED;;;sBAGsB;AACtB,oBAAY,iBAAiB;IAC3B,4DAA4D;IAC5D,OAAO,IAAI;IACX,4DAA4D;IAC5D,QAAQ,IAAI;CACb;AAID;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAQhF;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,eAAe,GAAG,MAAM,CAQvE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAkB5E;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAEpE;AAED,gBAAgB;AAChB,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM,CAmBvE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAe1E;AAED,YAAY;AACZ,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAejE;AAED;;;;GAIG;AACH,wBAAgB,iCAAiC,CAAC,IAAI,EAAE,MAAM,GAAG,4BAA4B,GAAG,SAAS,CAiExG;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,4BAA4B,GAAG,MAAM,CAuDhF;AAED,YAAY;AACZ,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,GAAG,SAAS,CAM7E;AAED,YAAY;AACZ,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,eAAe,GAAG,MAAM,CAOpE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAOxE;AAED,YAAY;AACZ,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,YAAY,GAAG,MAAM,CAQ/D;AAED,YAAY;AACZ,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAMvF;AAED,YAAY;AACZ,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,iBAAiB,GAAG,MAAM,CAO9E;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,uBAAuB,GAAG,OAAO,CAiB5G"}

package/lib/cjs/ECObjects.js

@@ -1,13 +1,13 @@
 "use strict";
 /*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
+ * 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.StrengthDirection = exports.StrengthType = exports.RelationshipEnd = exports.SchemaMatchType = exports.CustomAttributeContainerType = exports.PrimitiveType = exports.SchemaItemType = exports.ECClassModifier = exports.PropertyType = void 0;
+exports.StrengthDirection = exports.StrengthType = exports.RelationshipEnd = exports.SchemaMatchType = exports.CustomAttributeContainerType = exports.PrimitiveType = exports.AbstractSchemaItemType = exports.SchemaItemType = exports.ECClassModifier = exports.PropertyType = void 0;
 exports.parseClassModifier = parseClassModifier;
 exports.classModifierToString = classModifierToString;
 exports.parseSchemaItemType = parseSchemaItemType;
@@ -23,6 +23,7 @@ exports.parseStrength = parseStrength;
 exports.strengthToString = strengthToString;
 exports.parseStrengthDirection = parseStrengthDirection;
 exports.strengthDirectionToString = strengthDirectionToString;
+exports.isSupportedSchemaItemType = isSupportedSchemaItemType;
 const Constants_1 = require("./Constants");
 const Exception_1 = require("./Exception");
 var PropertyTypes_1 = require("./PropertyTypes");
@@ -31,16 +32,26 @@ Object.defineProperty(exports, "PropertyType", { enumerable: true, get: function
 if (!Symbol.asyncIterator) {
     Symbol.asyncIterator = Symbol.for("Symbol.asyncIterator");
 }
-/** @beta */
+/**
+ * Identifies a class as abstract or sealed
+ *
+ * @public @preview
+ */
 var ECClassModifier;
 (function (ECClassModifier) {
+    /* normal, instantiable class, can be subclassed */
     ECClassModifier[ECClassModifier["None"] = 0] = "None";
+    /* abstract class, cannot be instantiated, can be subclassed */
     ECClassModifier[ECClassModifier["Abstract"] = 1] = "Abstract";
+    /* sealed class, instantiable class, cannot be subclassed */
     ECClassModifier[ECClassModifier["Sealed"] = 2] = "Sealed";
 })(ECClassModifier || (exports.ECClassModifier = ECClassModifier = {}));
 /**
  * An enumeration that has all the schema item type names as values
- * @beta */
+ *
+ * @enum {string}
+ * @public @preview
+ */
 var SchemaItemType;
 (function (SchemaItemType) {
     SchemaItemType["EntityClass"] = "EntityClass";
@@ -58,9 +69,20 @@ var SchemaItemType;
     SchemaItemType["UnitSystem"] = "UnitSystem";
     SchemaItemType["Format"] = "Format";
 })(SchemaItemType || (exports.SchemaItemType = SchemaItemType = {}));
+/**
+ * Additional Schema Item Types which define classes of item types
+ * @public @preview
+ */
+var AbstractSchemaItemType;
+(function (AbstractSchemaItemType) {
+    /* Item is EntityClass, Mixin, StructClass, CustomAttributeClass, or RelationshipClass */
+    AbstractSchemaItemType["Class"] = "Class";
+    /* Any item type including the Class types */
+    AbstractSchemaItemType["SchemaItem"] = "SchemaItem";
+})(AbstractSchemaItemType || (exports.AbstractSchemaItemType = AbstractSchemaItemType = {}));
 /**
  * Primitive data types for ECProperties.
- * @beta
+ * @public @preview
  */
 var PrimitiveType;
 (function (PrimitiveType) {
@@ -78,7 +100,7 @@ var PrimitiveType;
 })(PrimitiveType || (exports.PrimitiveType = PrimitiveType = {}));
 /**
  * Defines the valid CustomAttribute container types.
- * @beta
+ * @public @preview
  */
 var CustomAttributeContainerType;
 (function (CustomAttributeContainerType) {
@@ -101,14 +123,14 @@ var CustomAttributeContainerType;
 })(CustomAttributeContainerType || (exports.CustomAttributeContainerType = CustomAttributeContainerType = {}));
 /**
  * Defines what sort of match should be used when locating a schema.
- * @beta
+ * @public @preview
  */
 var SchemaMatchType;
 (function (SchemaMatchType) {
     /*
-    * Find exact VersionRead, VersionWrite, VersionMinor match as well as Data. NOTE data is not yet matched
-    * @deprecated in 4.10 Use Exact instead.
-    */
+     * Find exact VersionRead, VersionWrite, VersionMinor match as well as Data. NOTE data is not yet matched
+     * @deprecated in 4.10 Use Exact instead.
+     */
     SchemaMatchType[SchemaMatchType["Identical"] = 0] = "Identical";
     /* Find exact VersionRead, VersionWrite, VersionMinor match. */
     SchemaMatchType[SchemaMatchType["Exact"] = 1] = "Exact";
@@ -121,24 +143,32 @@ var SchemaMatchType;
 })(SchemaMatchType || (exports.SchemaMatchType = SchemaMatchType = {}));
 /**
  * Identifer for an ECRelationshipConstraint. Used to determine the side of the relationship the constraint is representing.
- * @beta
+ * @public @preview
  */
 var RelationshipEnd;
 (function (RelationshipEnd) {
     RelationshipEnd[RelationshipEnd["Source"] = 0] = "Source";
     RelationshipEnd[RelationshipEnd["Target"] = 1] = "Target";
 })(RelationshipEnd || (exports.RelationshipEnd = RelationshipEnd = {}));
-/** @beta */
+/**
+ * Defines the how the lifetime of the source and target are related.
+ *
+ * @public @preview */
 var StrengthType;
 (function (StrengthType) {
     StrengthType[StrengthType["Referencing"] = 0] = "Referencing";
     StrengthType[StrengthType["Holding"] = 1] = "Holding";
     StrengthType[StrengthType["Embedding"] = 2] = "Embedding";
 })(StrengthType || (exports.StrengthType = StrengthType = {}));
-/** @beta */
+/**
+ * Defines the which side of the relationship is the starting point of the relationship.  This impacts how relationship strength is applied.
+ *
+ * @public @preview */
 var StrengthDirection;
 (function (StrengthDirection) {
+    /** The source is the starting point of the relationship. */
     StrengthDirection[StrengthDirection["Forward"] = 1] = "Forward";
+    /** The target is the starting point of the relationship. */
     StrengthDirection[StrengthDirection["Backward"] = 2] = "Backward";
 })(StrengthDirection || (exports.StrengthDirection = StrengthDirection = {}));
 // Helper methods for going to/from string for the above Enumerations.
@@ -165,7 +195,8 @@ function classModifierToString(modifier) {
         case ECClassModifier.Abstract: return "Abstract";
         case ECClassModifier.None: return "None";
         case ECClassModifier.Sealed: return "Sealed";
-        default: throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidModifier, "An invalid ECClassModifier has been provided.");
+        default:
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidModifier, "An invalid ECClassModifier has been provided.");
     }
 }
 /**
@@ -220,7 +251,8 @@ function schemaItemTypeToXmlString(value) {
         case SchemaItemType.Phenomenon: return "Phenomenon";
         case SchemaItemType.UnitSystem: return "UnitSystem";
         case SchemaItemType.Format: return "Format";
-        default: throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidSchemaItemType, "An invalid SchemaItemType has been provided.");
+        default:
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidSchemaItemType, "An invalid SchemaItemType has been provided.");
     }
 }
 /**
@@ -258,7 +290,8 @@ function primitiveTypeToString(type) {
         case PrimitiveType.Point2d: return "point2d";
         case PrimitiveType.Point3d: return "point3d";
         case PrimitiveType.String: return "string";
-        default: throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidPrimitiveType, "An invalid PrimitiveType has been provided.");
+        default:
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidPrimitiveType, "An invalid PrimitiveType has been provided.");
     }
 }
 /**
@@ -324,7 +357,7 @@ function parseCustomAttributeContainerType(type) {
                 containerType = containerType | CustomAttributeContainerType.Any;
                 break;
             default:
-                throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidContainerType, `${typeToken} is not a valid CustomAttributeContainerType value.`);
+                throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidContainerType, `${typeToken} is not a valid CustomAttributeContainerType value.`);
         }
     });
     return containerType;
@@ -337,7 +370,7 @@ function parseCustomAttributeContainerType(type) {
  */
 function containerTypeToString(type) {
     const testContainerTypeValue = (compareType, otherType) => {
-        return (compareType === (compareType & otherType));
+        return compareType === (compareType & otherType);
     };
     if (testContainerTypeValue(CustomAttributeContainerType.Any, type))
         return Constants_1.ECStringConstants.CONTAINERTYPE_ANY;
@@ -399,12 +432,13 @@ function relationshipEndToString(end) {
     switch (end) {
         case RelationshipEnd.Source: return Constants_1.ECStringConstants.RELATIONSHIP_END_SOURCE;
         case RelationshipEnd.Target: return Constants_1.ECStringConstants.RELATIONSHIP_END_TARGET;
-        default: throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidRelationshipEnd, `An invalid RelationshipEnd has been provided.`);
+        default:
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidRelationshipEnd, `An invalid RelationshipEnd has been provided.`);
     }
 }
 /**
  * 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
+ * @throws ECSchemaStatus.InvalidStrength if the provided string that is not valid
  * @param strength
  * @beta
  */
@@ -422,7 +456,8 @@ function strengthToString(strength) {
         case StrengthType.Embedding: return "Embedding";
         case StrengthType.Holding: return "Holding";
         case StrengthType.Referencing: return "Referencing";
-        default: throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidStrength, `An invalid Strength has been provided.`);
+        default:
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidStrength, `An invalid Strength has been provided.`);
     }
 }
 /** @beta */
@@ -438,7 +473,26 @@ function strengthDirectionToString(direction) {
     switch (direction) {
         case StrengthDirection.Forward: return "Forward";
         case StrengthDirection.Backward: return "Backward";
-        default: throw new Exception_1.ECObjectsError(Exception_1.ECObjectsStatus.InvalidStrengthDirection, `An invalid StrengthDirection has been provided.`);
+        default:
+            throw new Exception_1.ECSchemaError(Exception_1.ECSchemaStatus.InvalidStrengthDirection, `An invalid StrengthDirection has been provided.`);
+    }
+}
+/** Compares a SchemaItemType against supported type.
+ * @beta
+ */
+function isSupportedSchemaItemType(value, supported) {
+    if (value === supported)
+        return true;
+    if (supported === AbstractSchemaItemType.Class && (value === SchemaItemType.EntityClass ||
+        value === SchemaItemType.Mixin ||
+        value === SchemaItemType.StructClass ||
+        value === SchemaItemType.CustomAttributeClass ||
+        value === SchemaItemType.RelationshipClass)) {
+        return true;
+    }
+    if (supported === AbstractSchemaItemType.SchemaItem) {
+        return true;
     }
+    return false;
 }
 //# sourceMappingURL=ECObjects.js.map