@itwin/presentation-common 5.0.0-dev.5 → 5.0.0-dev.52

package/lib/cjs/presentation-common/content/Fields.js

@@ -12,6 +12,7 @@ const core_bentley_1 = require("@itwin/core-bentley");
 const EC_1 = require("../EC");
 const Error_1 = require("../Error");
 const RelatedPropertiesSpecification_1 = require("../rules/content/modifiers/RelatedPropertiesSpecification");
+const Utils_1 = require("../Utils");
 const Property_1 = require("./Property");
 function isPropertiesField(field) {
     return !!field.properties;
@@ -32,28 +33,30 @@ function isNestedContentField(field) {
  * @public
  */
 class Field {
-    /**
-     * Creates an instance of Field.
-     * @param category Category information
-     * @param name Unique name
-     * @param label Display label
-     * @param type Description of this field's values data type
-     * @param isReadonly Are values in this field read-only
-     * @param priority Priority of the field
-     * @param editor Property editor used to edit values of this field
-     * @param renderer Property renderer used to render values of this field
-     * @param extendedData Extended data associated with this field
-     */
-    constructor(category, name, label, type, isReadonly, priority, editor, renderer, extendedData) {
-        this.category = category;
-        this.name = name;
-        this.label = label;
-        this.type = type;
-        this.isReadonly = isReadonly;
-        this.priority = priority;
-        this.editor = editor;
-        this.renderer = renderer;
-        this.extendedData = extendedData;
+    constructor(categoryOrProps, name, label, type, isReadonly, priority, editor, renderer, extendedData) {
+        /* istanbul ignore next */
+        const props = "category" in categoryOrProps
+            ? categoryOrProps
+            : {
+                category: categoryOrProps,
+                name: name,
+                label: label,
+                type: type,
+                isReadonly: isReadonly,
+                priority: priority,
+                editor,
+                renderer,
+                extendedData,
+            };
+        this.category = props.category;
+        this.name = props.name;
+        this.label = props.label;
+        this.type = props.type;
+        this.isReadonly = props.isReadonly;
+        this.priority = props.priority;
+        this.editor = props.editor;
+        this.renderer = props.renderer;
+        this.extendedData = props.extendedData;
     }
     /**
      * Is this a [[PropertiesField]]
@@ -74,13 +77,13 @@ class Field {
         return this._parent;
     }
     clone() {
-        const clone = new Field(this.category, this.name, this.label, this.type, this.isReadonly, this.priority, this.editor, this.renderer, this.extendedData);
+        const clone = new Field(this);
         clone.rebuildParentship(this.parent);
         return clone;
     }
     /** Serialize this object to JSON */
     toJSON() {
-        return {
+        return (0, Utils_1.omitUndefined)({
             category: this.category.name,
             name: this.name,
             label: this.label,
@@ -89,8 +92,8 @@ class Field {
             priority: this.priority,
             renderer: this.renderer,
             editor: this.editor,
-            extendedData: this.extendedData
-        };
+            extendedData: this.extendedData,
+        });
     }
     /** Serialize this object to compressed JSON */
     toCompressedJSON(_classesMap) {
@@ -108,8 +111,8 @@ class Field {
             // eslint-disable-next-line @typescript-eslint/no-deprecated
             return NestedContentField.fromJSON(json, categories);
         }
-        const field = Object.create(Field.prototype);
-        return Object.assign(field, json, {
+        return new Field({
+            ...json,
             category: Field.getCategoryFromFieldJson(json, categories),
         });
     }
@@ -124,8 +127,8 @@ class Field {
         if (isNestedContentField(json)) {
             return NestedContentField.fromCompressedJSON(json, classesMap, categories);
         }
-        const field = Object.create(Field.prototype);
-        return Object.assign(field, json, {
+        return new Field({
+            ...json,
             category: Field.getCategoryFromFieldJson(json, categories),
         });
     }
@@ -170,21 +173,23 @@ exports.Field = Field;
  * @public
  */
 class PropertiesField extends Field {
-    /**
-     * Creates an instance of PropertiesField.
-     * @param category Category information
-     * @param name Unique name
-     * @param label Display label
-     * @param type Description of this field's values data type
-     * @param isReadonly Are values in this field read-only
-     * @param priority Priority of the field
-     * @param properties A list of properties this field is created from
-     * @param editor Property editor used to edit values of this field
-     * @param renderer Property renderer used to render values of this field
-     */
-    constructor(category, name, label, description, isReadonly, priority, properties, editor, renderer) {
-        super(category, name, label, description, isReadonly, priority, editor, renderer);
-        this.properties = properties;
+    constructor(categoryOrProps, name, label, type, isReadonly, priority, properties, editor, renderer) {
+        /* istanbul ignore next */
+        const props = "category" in categoryOrProps
+            ? categoryOrProps
+            : {
+                category: categoryOrProps,
+                name: name,
+                label: label,
+                type: type,
+                isReadonly: isReadonly,
+                priority: priority,
+                editor,
+                renderer,
+                properties: properties,
+            };
+        super(props);
+        this.properties = props.properties;
     }
     /** Is this a an array property field */
     isArrayPropertiesField() {
@@ -195,7 +200,7 @@ class PropertiesField extends Field {
         return false;
     }
     clone() {
-        const clone = new PropertiesField(this.category, this.name, this.label, this.type, this.isReadonly, this.priority, this.properties, this.editor, this.renderer);
+        const clone = new PropertiesField(this);
         clone.rebuildParentship(this.parent);
         return clone;
     }
@@ -224,8 +229,8 @@ class PropertiesField extends Field {
         if (isStructPropertiesField(json)) {
             return StructPropertiesField.fromJSON(json, categories);
         }
-        const field = Object.create(PropertiesField.prototype);
-        return Object.assign(field, json, {
+        return new PropertiesField({
+            ...json,
             category: this.getCategoryFromFieldJson(json, categories),
         });
     }
@@ -240,8 +245,8 @@ class PropertiesField extends Field {
         if (isStructPropertiesField(json)) {
             return StructPropertiesField.fromCompressedJSON(json, classesMap, categories);
         }
-        const field = Object.create(PropertiesField.prototype);
-        return Object.assign(field, json, {
+        return new PropertiesField({
+            ...json,
             category: this.getCategoryFromFieldJson(json, categories),
             properties: json.properties.map((propertyJson) => fromCompressedPropertyJSON(propertyJson, classesMap)),
         });
@@ -303,15 +308,30 @@ exports.PropertiesField = PropertiesField;
  * @public
  */
 class ArrayPropertiesField extends PropertiesField {
-    constructor(category, name, label, description, itemsField, isReadonly, priority, properties, editor, renderer) {
-        super(category, name, label, description, isReadonly, priority, properties, editor, renderer);
-        this.itemsField = itemsField;
+    constructor(categoryOrProps, name, label, type, itemsField, isReadonly, priority, properties, editor, renderer) {
+        /* istanbul ignore next */
+        const props = "category" in categoryOrProps
+            ? categoryOrProps
+            : {
+                category: categoryOrProps,
+                name: name,
+                label: label,
+                type: type,
+                isReadonly: isReadonly,
+                priority: priority,
+                editor,
+                renderer,
+                properties: properties,
+                itemsField: itemsField,
+            };
+        super(props);
+        this.itemsField = props.itemsField;
     }
     isArrayPropertiesField() {
         return true;
     }
     clone() {
-        const clone = new ArrayPropertiesField(this.category, this.name, this.label, this.type, this.itemsField.clone(), this.isReadonly, this.priority, this.properties, this.editor, this.renderer);
+        const clone = new ArrayPropertiesField(this);
         clone.rebuildParentship(this.parent);
         return clone;
     }
@@ -331,8 +351,8 @@ class ArrayPropertiesField extends PropertiesField {
     }
     /** Deserialize [[ArrayPropertiesField]] from JSON */
     static fromJSON(json, categories) {
-        const field = Object.create(ArrayPropertiesField.prototype);
-        return Object.assign(field, json, {
+        return new ArrayPropertiesField({
+            ...json,
             category: this.getCategoryFromFieldJson(json, categories),
             itemsField: PropertiesField.fromJSON(json.itemsField, categories),
         });
@@ -342,8 +362,8 @@ class ArrayPropertiesField extends PropertiesField {
      * @public
      */
     static fromCompressedJSON(json, classesMap, categories) {
-        const field = Object.create(ArrayPropertiesField.prototype);
-        return Object.assign(field, json, {
+        return new ArrayPropertiesField({
+            ...json,
             category: this.getCategoryFromFieldJson(json, categories),
             properties: json.properties.map((propertyJson) => fromCompressedPropertyJSON(propertyJson, classesMap)),
             itemsField: PropertiesField.fromCompressedJSON(json.itemsField, classesMap, categories),
@@ -356,15 +376,30 @@ exports.ArrayPropertiesField = ArrayPropertiesField;
  * @public
  */
 class StructPropertiesField extends PropertiesField {
-    constructor(category, name, label, description, memberFields, isReadonly, priority, properties, editor, renderer) {
-        super(category, name, label, description, isReadonly, priority, properties, editor, renderer);
-        this.memberFields = memberFields;
+    constructor(categoryOrProps, name, label, type, memberFields, isReadonly, priority, properties, editor, renderer) {
+        /* istanbul ignore next */
+        const props = "category" in categoryOrProps
+            ? categoryOrProps
+            : {
+                category: categoryOrProps,
+                name: name,
+                label: label,
+                type: type,
+                isReadonly: isReadonly,
+                priority: priority,
+                editor,
+                renderer,
+                properties: properties,
+                memberFields: memberFields,
+            };
+        super(props);
+        this.memberFields = props.memberFields;
     }
     isStructPropertiesField() {
         return true;
     }
     clone() {
-        const clone = new StructPropertiesField(this.category, this.name, this.label, this.type, this.memberFields.map((m) => m.clone()), this.isReadonly, this.priority, this.properties, this.editor, this.renderer);
+        const clone = new StructPropertiesField(this);
         clone.rebuildParentship(this.parent);
         return clone;
     }
@@ -384,8 +419,8 @@ class StructPropertiesField extends PropertiesField {
     }
     /** Deserialize [[StructPropertiesField]] from JSON */
     static fromJSON(json, categories) {
-        const field = Object.create(StructPropertiesField.prototype);
-        return Object.assign(field, json, {
+        return new StructPropertiesField({
+            ...json,
             category: this.getCategoryFromFieldJson(json, categories),
             memberFields: json.memberFields.map((m) => PropertiesField.fromJSON(m, categories)),
         });
@@ -395,8 +430,8 @@ class StructPropertiesField extends PropertiesField {
      * @public
      */
     static fromCompressedJSON(json, classesMap, categories) {
-        const field = Object.create(StructPropertiesField.prototype);
-        return Object.assign(field, json, {
+        return new StructPropertiesField({
+            ...json,
             category: this.getCategoryFromFieldJson(json, categories),
             properties: json.properties.map((propertyJson) => fromCompressedPropertyJSON(propertyJson, classesMap)),
             memberFields: json.memberFields.map((m) => PropertiesField.fromCompressedJSON(m, classesMap, categories)),
@@ -410,35 +445,37 @@ exports.StructPropertiesField = StructPropertiesField;
  * @public
  */
 class NestedContentField extends Field {
-    /**
-     * Creates an instance of NestedContentField.
-     * @param category Category information
-     * @param name Unique name
-     * @param label Display label
-     * @param type Description of this field's values data type
-     * @param isReadonly Are values in this field read-only
-     * @param priority Priority of the field
-     * @param contentClassInfo Information about an ECClass whose properties are nested inside this field
-     * @param pathToPrimaryClass Relationship path to [Primary class]($docs/presentation/content/Terminology#primary-class)
-     * @param nestedFields Contained nested fields
-     * @param editor Property editor used to edit values of this field
-     * @param autoExpand Flag specifying whether field should be expanded
-     * @param relationshipMeaning RelationshipMeaning of the field
-     * @param renderer Property renderer used to render values of this field
-     */
-    constructor(category, name, label, description, isReadonly, priority, contentClassInfo, pathToPrimaryClass, nestedFields, editor, autoExpand, renderer) {
-        super(category, name, label, description, isReadonly, priority, editor, renderer);
-        this.contentClassInfo = contentClassInfo;
-        this.pathToPrimaryClass = pathToPrimaryClass;
-        this.relationshipMeaning = RelatedPropertiesSpecification_1.RelationshipMeaning.RelatedInstance;
-        this.nestedFields = nestedFields;
-        this.autoExpand = autoExpand;
-        this.actualPrimaryClassIds = [];
+    constructor(categoryOrProps, name, label, type, isReadonly, priority, contentClassInfo, pathToPrimaryClass, nestedFields, editor, autoExpand, renderer) {
+        /* istanbul ignore next */
+        const props = "category" in categoryOrProps
+            ? categoryOrProps
+            : {
+                category: categoryOrProps,
+                name: name,
+                label: label,
+                type: type,
+                isReadonly: isReadonly,
+                priority: priority,
+                editor,
+                renderer,
+                contentClassInfo: contentClassInfo,
+                pathToPrimaryClass: pathToPrimaryClass,
+                nestedFields: nestedFields,
+                autoExpand,
+            };
+        super(props);
+        this.contentClassInfo = props.contentClassInfo;
+        this.pathToPrimaryClass = props.pathToPrimaryClass;
+        this.relationshipMeaning = props.relationshipMeaning ?? RelatedPropertiesSpecification_1.RelationshipMeaning.RelatedInstance;
+        this.nestedFields = props.nestedFields;
+        this.autoExpand = props.autoExpand;
+        this.actualPrimaryClassIds = props.actualPrimaryClassIds ?? [];
     }
     clone() {
-        const clone = new NestedContentField(this.category, this.name, this.label, this.type, this.isReadonly, this.priority, this.contentClassInfo, this.pathToPrimaryClass, this.nestedFields.map((n) => n.clone()), this.editor, this.autoExpand, this.renderer);
-        clone.actualPrimaryClassIds = this.actualPrimaryClassIds;
-        clone.relationshipMeaning = this.relationshipMeaning;
+        const clone = new NestedContentField({
+            ...this,
+            nestedFields: this.nestedFields.map((n) => n.clone()),
+        });
         clone.rebuildParentship(this.parent);
         return clone;
     }
@@ -459,7 +496,7 @@ class NestedContentField extends Field {
             relationshipMeaning: this.relationshipMeaning,
             actualPrimaryClassIds: this.actualPrimaryClassIds,
             nestedFields: this.nestedFields.map((field) => field.toJSON()),
-            autoExpand: this.autoExpand,
+            ...(this.autoExpand ? { autoExpand: true } : undefined),
         };
     }
     /** Serialize this object to compressed JSON */
@@ -481,8 +518,9 @@ class NestedContentField extends Field {
         if (!json) {
             return undefined;
         }
-        const field = Object.create(NestedContentField.prototype);
-        return Object.assign(field, json, this.fromCommonJSON(json, categories), {
+        return new NestedContentField({
+            ...json,
+            ...this.fromCommonJSON(json, categories),
             nestedFields: json.nestedFields
                 .map((nestedFieldJson) => Field.fromJSON(nestedFieldJson, categories))
                 .filter((nestedField) => !!nestedField),
@@ -491,8 +529,9 @@ class NestedContentField extends Field {
     /** Deserialize a [[NestedContentField]] from compressed JSON. */
     static fromCompressedJSON(json, classesMap, categories) {
         (0, core_bentley_1.assert)(classesMap.hasOwnProperty(json.contentClassInfo));
-        const field = Object.create(NestedContentField.prototype);
-        return Object.assign(field, json, this.fromCommonJSON(json, categories), {
+        return new NestedContentField({
+            ...json,
+            ...this.fromCommonJSON(json, categories),
             category: this.getCategoryFromFieldJson(json, categories),
             nestedFields: json.nestedFields
                 .map((nestedFieldJson) => Field.fromCompressedJSON(nestedFieldJson, classesMap, categories))