@itwin/presentation-common 4.0.0-dev.8 → 4.0.0-dev.81

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

@@ -1,391 +1,387 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Content
- */
-import { assert } from "@itwin/core-bentley";
-import { NavigationPropertyInfo, RelatedClassInfo, RelationshipPath, } from "../EC";
-import { PresentationError, PresentationStatus } from "../Error";
-import { RelationshipMeaning } from "../rules/content/modifiers/RelatedPropertiesSpecification";
-import { Property } from "./Property";
-/** Is supplied field a properties field. */
-const isPropertiesField = (field) => {
-    return !!field.properties;
-};
-/** Is supplied field a nested content field. */
-const isNestedContentField = (field) => {
-    return !!field.nestedFields;
-};
-/**
- * Describes a single content field. A field is usually represented as a grid column
- * or a property pane row.
- *
- * @public
- */
-export 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
-     */
-    constructor(category, name, label, type, isReadonly, priority, editor, renderer) {
-        this.category = category;
-        this.name = name;
-        this.label = label;
-        this.type = type;
-        this.isReadonly = isReadonly;
-        this.priority = priority;
-        this.editor = editor;
-        this.renderer = renderer;
-    }
-    /**
-     * Is this a [[PropertiesField]]
-     */
-    isPropertiesField() { return isPropertiesField(this); }
-    /**
-     * Is this a [[NestedContentField]]
-     */
-    isNestedContentField() { return isNestedContentField(this); }
-    /**
-     * Get parent
-     */
-    get parent() { return this._parent; }
-    clone() {
-        const clone = new Field(this.category, this.name, this.label, this.type, this.isReadonly, this.priority, this.editor, this.renderer);
-        clone.rebuildParentship(this.parent);
-        return clone;
-    }
-    /** Serialize this object to JSON */
-    toJSON() {
-        return {
-            category: this.category.name,
-            name: this.name,
-            label: this.label,
-            type: this.type,
-            isReadonly: this.isReadonly,
-            priority: this.priority,
-            renderer: this.renderer,
-            editor: this.editor,
-        };
-    }
-    /** Serialize this object to compressed JSON */
-    toCompressedJSON(classesMap) {
-        if (this.isPropertiesField())
-            return {
-                ...this.toJSON(),
-                properties: this.properties.map((property) => Property.toCompressedJSON(property, classesMap)),
-            };
-        if (this.isNestedContentField()) {
-            const { id, ...leftOverInfo } = this.contentClassInfo;
-            classesMap[id] = leftOverInfo;
-            return {
-                ...this.toJSON(),
-                contentClassInfo: id,
-                pathToPrimaryClass: this.pathToPrimaryClass.map((classInfo) => RelatedClassInfo.toCompressedJSON(classInfo, classesMap)),
-                nestedFields: this.nestedFields.map((field) => field.toCompressedJSON(classesMap)),
-            };
-        }
-        return this.toJSON();
-    }
-    /** Deserialize [[Field]] from JSON */
-    static fromJSON(json, categories) {
-        if (!json)
-            return undefined;
-        if (isPropertiesField(json))
-            return PropertiesField.fromJSON(json, categories);
-        if (isNestedContentField(json))
-            // eslint-disable-next-line deprecation/deprecation
-            return NestedContentField.fromJSON(json, categories);
-        const field = Object.create(Field.prototype);
-        return Object.assign(field, json, {
-            category: Field.getCategoryFromFieldJson(json, categories),
-        });
-    }
-    /**
-     * Deserialize a [[Field]] from compressed JSON.
-     * @public
-     */
-    static fromCompressedJSON(json, classesMap, categories) {
-        if (!json)
-            return undefined;
-        if (isPropertiesField(json))
-            return PropertiesField.fromCompressedJSON(json, classesMap, categories);
-        if (isNestedContentField(json))
-            return NestedContentField.fromCompressedJSON(json, classesMap, categories);
-        const field = Object.create(Field.prototype);
-        return Object.assign(field, json, {
-            category: Field.getCategoryFromFieldJson(json, categories),
-        });
-    }
-    static getCategoryFromFieldJson(fieldJson, categories) {
-        const category = categories.find((c) => c.name === fieldJson.category);
-        if (!category)
-            throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid content field category`);
-        return category;
-    }
-    /** @internal */
-    resetParentship() {
-        this._parent = undefined;
-    }
-    /** @internal */
-    rebuildParentship(parentField) {
-        this._parent = parentField;
-    }
-    /**
-     * Get descriptor for this field.
-     * @public
-     */
-    getFieldDescriptor() {
-        return {
-            type: FieldDescriptorType.Name,
-            fieldName: this.name,
-        };
-    }
-}
-/**
- * Describes a content field that's based on one or more similar
- * EC properties.
- *
- * @public
- */
-export 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;
-    }
-    clone() {
-        const clone = new PropertiesField(this.category, this.name, this.label, this.type, this.isReadonly, this.priority, this.properties, this.editor, this.renderer);
-        clone.rebuildParentship(this.parent);
-        return clone;
-    }
-    /** Serialize this object to JSON */
-    toJSON() {
-        return {
-            ...super.toJSON(),
-            properties: this.properties,
-        };
-    }
-    /** Deserialize [[PropertiesField]] from JSON */
-    static fromJSON(json, categories) {
-        if (!json)
-            return undefined;
-        const field = Object.create(PropertiesField.prototype);
-        return Object.assign(field, json, {
-            category: this.getCategoryFromFieldJson(json, categories),
-        });
-    }
-    /**
-     * Deserialize a [[PropertiesField]] from compressed JSON.
-     * @public
-     */
-    static fromCompressedJSON(json, classesMap, categories) {
-        const field = Object.create(PropertiesField.prototype);
-        return Object.assign(field, json, {
-            category: this.getCategoryFromFieldJson(json, categories),
-            properties: json.properties.map((propertyJson) => fromCompressedPropertyJSON(propertyJson, classesMap)),
-        });
-    }
-    /**
-     * Get descriptor for this field.
-     * @public
-     */
-    getFieldDescriptor() {
-        const pathFromPropertyToSelectClass = new Array();
-        let currAncestor = this.parent;
-        while (currAncestor) {
-            pathFromPropertyToSelectClass.push(...currAncestor.pathToPrimaryClass);
-            currAncestor = currAncestor.parent;
-        }
-        return {
-            type: FieldDescriptorType.Properties,
-            pathFromSelectToPropertyClass: RelationshipPath.strip(RelationshipPath.reverse(pathFromPropertyToSelectClass)),
-            properties: this.properties.map((p) => ({
-                class: p.property.classInfo.name,
-                name: p.property.name,
-            })),
-        };
-    }
-}
-/**
- * Describes a content field that contains [Nested content]($docs/presentation/content/Terminology#nested-content).
- *
- * @public
- */
-export 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 = RelationshipMeaning.RelatedInstance;
-        this.nestedFields = nestedFields;
-        this.autoExpand = autoExpand;
-        this.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;
-        clone.rebuildParentship(this.parent);
-        return clone;
-    }
-    /**
-     * Get field by its name
-     * @param name Name of the field to find
-     * @param recurse Recurse into nested fields
-     */
-    getFieldByName(name, recurse) {
-        return getFieldByName(this.nestedFields, name, recurse);
-    }
-    /** Serialize this object to JSON */
-    toJSON() {
-        return {
-            ...super.toJSON(),
-            contentClassInfo: this.contentClassInfo,
-            pathToPrimaryClass: this.pathToPrimaryClass,
-            relationshipMeaning: this.relationshipMeaning,
-            actualPrimaryClassIds: this.actualPrimaryClassIds,
-            nestedFields: this.nestedFields.map((field) => field.toJSON()),
-            autoExpand: this.autoExpand,
-        };
-    }
-    /**
-     * Deserialize [[NestedContentField]] from JSON
-     * @deprecated in 3.x. Use [[NestedContentField.fromCompressedJSON]]
-     */
-    static fromJSON(json, categories) {
-        if (!json)
-            return undefined;
-        const field = Object.create(NestedContentField.prototype);
-        return Object.assign(field, json, this.fromCommonJSON(json, categories), {
-            nestedFields: json.nestedFields
-                .map((nestedFieldJson) => Field.fromJSON(nestedFieldJson, categories))
-                .filter((nestedField) => !!nestedField),
-        });
-    }
-    /**
-     * Deserialize a [[NestedContentField]] from compressed JSON.
-     * @public
-     */
-    static fromCompressedJSON(json, classesMap, categories) {
-        assert(classesMap.hasOwnProperty(json.contentClassInfo));
-        const field = Object.create(NestedContentField.prototype);
-        return Object.assign(field, json, this.fromCommonJSON(json, categories), {
-            category: this.getCategoryFromFieldJson(json, categories),
-            nestedFields: json.nestedFields.map((nestedFieldJson) => Field.fromCompressedJSON(nestedFieldJson, classesMap, categories))
-                .filter((nestedField) => !!nestedField),
-            contentClassInfo: { id: json.contentClassInfo, ...classesMap[json.contentClassInfo] },
-            pathToPrimaryClass: json.pathToPrimaryClass.map((stepJson) => RelatedClassInfo.fromCompressedJSON(stepJson, classesMap)),
-        });
-    }
-    // eslint-disable-next-line deprecation/deprecation
-    static fromCommonJSON(json, categories) {
-        var _a, _b;
-        return {
-            category: this.getCategoryFromFieldJson(json, categories),
-            relationshipMeaning: (_a = json.relationshipMeaning) !== null && _a !== void 0 ? _a : RelationshipMeaning.RelatedInstance,
-            actualPrimaryClassIds: (_b = json.actualPrimaryClassIds) !== null && _b !== void 0 ? _b : [],
-            autoExpand: json.autoExpand,
-        };
-    }
-    /** @internal */
-    resetParentship() {
-        super.resetParentship();
-        for (const nestedField of this.nestedFields)
-            nestedField.resetParentship();
-    }
-    /** @internal */
-    rebuildParentship(parentField) {
-        super.rebuildParentship(parentField);
-        for (const nestedField of this.nestedFields)
-            nestedField.rebuildParentship(this);
-    }
-}
-/** @internal */
-export const getFieldByName = (fields, name, recurse) => {
-    if (name) {
-        for (const field of fields) {
-            if (field.name === name)
-                return field;
-            if (recurse && field.isNestedContentField()) {
-                const nested = getFieldByName(field.nestedFields, name, recurse);
-                if (nested)
-                    return nested;
-            }
-        }
-    }
-    return undefined;
-};
-/**
- * Types of different field descriptors.
- * @public
- */
-export var FieldDescriptorType;
-(function (FieldDescriptorType) {
-    FieldDescriptorType["Name"] = "name";
-    FieldDescriptorType["Properties"] = "properties";
-})(FieldDescriptorType || (FieldDescriptorType = {}));
-/** @public */
-export var FieldDescriptor;
-(function (FieldDescriptor) {
-    /** Is this a named field descriptor */
-    function isNamed(d) {
-        return d.type === FieldDescriptorType.Name;
-    }
-    FieldDescriptor.isNamed = isNamed;
-    /** Is this a properties field descriptor */
-    function isProperties(d) {
-        return d.type === FieldDescriptorType.Properties;
-    }
-    FieldDescriptor.isProperties = isProperties;
-})(FieldDescriptor || (FieldDescriptor = {}));
-function fromCompressedPropertyJSON(compressedPropertyJSON, classesMap) {
-    return {
-        property: fromCompressedPropertyInfoJSON(compressedPropertyJSON.property, classesMap),
-    };
-}
-function fromCompressedPropertyInfoJSON(compressedPropertyJSON, classesMap) {
-    assert(classesMap.hasOwnProperty(compressedPropertyJSON.classInfo));
-    const { navigationPropertyInfo, ...leftOverPropertyJSON } = compressedPropertyJSON;
-    return {
-        ...leftOverPropertyJSON,
-        classInfo: { id: compressedPropertyJSON.classInfo, ...classesMap[compressedPropertyJSON.classInfo] },
-        ...(navigationPropertyInfo ? { navigationPropertyInfo: NavigationPropertyInfo.fromCompressedJSON(navigationPropertyInfo, classesMap) } : undefined),
-    };
-}
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Content
+ */
+import { assert } from "@itwin/core-bentley";
+import { NavigationPropertyInfo, RelatedClassInfo, RelationshipPath, } from "../EC";
+import { PresentationError, PresentationStatus } from "../Error";
+import { RelationshipMeaning } from "../rules/content/modifiers/RelatedPropertiesSpecification";
+import { Property } from "./Property";
+/** Is supplied field a properties field. */
+const isPropertiesField = (field) => {
+    return !!field.properties;
+};
+/** Is supplied field a nested content field. */
+const isNestedContentField = (field) => {
+    return !!field.nestedFields;
+};
+/**
+ * Describes a single content field. A field is usually represented as a grid column
+ * or a property pane row.
+ *
+ * @public
+ */
+export 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
+     */
+    constructor(category, name, label, type, isReadonly, priority, editor, renderer) {
+        this.category = category;
+        this.name = name;
+        this.label = label;
+        this.type = type;
+        this.isReadonly = isReadonly;
+        this.priority = priority;
+        this.editor = editor;
+        this.renderer = renderer;
+    }
+    /**
+     * Is this a [[PropertiesField]]
+     */
+    isPropertiesField() { return isPropertiesField(this); }
+    /**
+     * Is this a [[NestedContentField]]
+     */
+    isNestedContentField() { return isNestedContentField(this); }
+    /**
+     * Get parent
+     */
+    get parent() { return this._parent; }
+    clone() {
+        const clone = new Field(this.category, this.name, this.label, this.type, this.isReadonly, this.priority, this.editor, this.renderer);
+        clone.rebuildParentship(this.parent);
+        return clone;
+    }
+    /** Serialize this object to JSON */
+    toJSON() {
+        return {
+            category: this.category.name,
+            name: this.name,
+            label: this.label,
+            type: this.type,
+            isReadonly: this.isReadonly,
+            priority: this.priority,
+            renderer: this.renderer,
+            editor: this.editor,
+        };
+    }
+    /** Serialize this object to compressed JSON */
+    toCompressedJSON(classesMap) {
+        if (this.isPropertiesField())
+            return {
+                ...this.toJSON(),
+                properties: this.properties.map((property) => Property.toCompressedJSON(property, classesMap)),
+            };
+        if (this.isNestedContentField()) {
+            const { id, ...leftOverInfo } = this.contentClassInfo;
+            classesMap[id] = leftOverInfo;
+            return {
+                ...this.toJSON(),
+                contentClassInfo: id,
+                pathToPrimaryClass: this.pathToPrimaryClass.map((classInfo) => RelatedClassInfo.toCompressedJSON(classInfo, classesMap)),
+                nestedFields: this.nestedFields.map((field) => field.toCompressedJSON(classesMap)),
+            };
+        }
+        return this.toJSON();
+    }
+    /** Deserialize [[Field]] from JSON */
+    static fromJSON(json, categories) {
+        if (!json)
+            return undefined;
+        if (isPropertiesField(json))
+            return PropertiesField.fromJSON(json, categories);
+        if (isNestedContentField(json))
+            // eslint-disable-next-line deprecation/deprecation
+            return NestedContentField.fromJSON(json, categories);
+        const field = Object.create(Field.prototype);
+        return Object.assign(field, json, {
+            category: Field.getCategoryFromFieldJson(json, categories),
+        });
+    }
+    /** Deserialize a [[Field]] from compressed JSON. */
+    static fromCompressedJSON(json, classesMap, categories) {
+        if (!json)
+            return undefined;
+        if (isPropertiesField(json))
+            return PropertiesField.fromCompressedJSON(json, classesMap, categories);
+        if (isNestedContentField(json))
+            return NestedContentField.fromCompressedJSON(json, classesMap, categories);
+        const field = Object.create(Field.prototype);
+        return Object.assign(field, json, {
+            category: Field.getCategoryFromFieldJson(json, categories),
+        });
+    }
+    static getCategoryFromFieldJson(fieldJson, categories) {
+        const category = categories.find((c) => c.name === fieldJson.category);
+        if (!category)
+            throw new PresentationError(PresentationStatus.InvalidArgument, `Invalid content field category`);
+        return category;
+    }
+    /** Resets field's parent. */
+    resetParentship() {
+        this._parent = undefined;
+    }
+    /** Sets provided [[NestedContentField]] as parent of this field. */
+    rebuildParentship(parentField) {
+        this._parent = parentField;
+    }
+    /**
+     * Get descriptor for this field.
+     * @public
+     */
+    getFieldDescriptor() {
+        return {
+            type: FieldDescriptorType.Name,
+            fieldName: this.name,
+        };
+    }
+}
+/**
+ * Describes a content field that's based on one or more similar
+ * EC properties.
+ *
+ * @public
+ */
+export 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;
+    }
+    clone() {
+        const clone = new PropertiesField(this.category, this.name, this.label, this.type, this.isReadonly, this.priority, this.properties, this.editor, this.renderer);
+        clone.rebuildParentship(this.parent);
+        return clone;
+    }
+    /** Serialize this object to JSON */
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            properties: this.properties,
+        };
+    }
+    /** Deserialize [[PropertiesField]] from JSON */
+    static fromJSON(json, categories) {
+        if (!json)
+            return undefined;
+        const field = Object.create(PropertiesField.prototype);
+        return Object.assign(field, json, {
+            category: this.getCategoryFromFieldJson(json, categories),
+        });
+    }
+    /**
+     * Deserialize a [[PropertiesField]] from compressed JSON.
+     * @public
+     */
+    static fromCompressedJSON(json, classesMap, categories) {
+        const field = Object.create(PropertiesField.prototype);
+        return Object.assign(field, json, {
+            category: this.getCategoryFromFieldJson(json, categories),
+            properties: json.properties.map((propertyJson) => fromCompressedPropertyJSON(propertyJson, classesMap)),
+        });
+    }
+    /**
+     * Get descriptor for this field.
+     * @public
+     */
+    getFieldDescriptor() {
+        const pathFromPropertyToSelectClass = new Array();
+        let currAncestor = this.parent;
+        while (currAncestor) {
+            pathFromPropertyToSelectClass.push(...currAncestor.pathToPrimaryClass);
+            currAncestor = currAncestor.parent;
+        }
+        return {
+            type: FieldDescriptorType.Properties,
+            pathFromSelectToPropertyClass: RelationshipPath.strip(RelationshipPath.reverse(pathFromPropertyToSelectClass)),
+            properties: this.properties.map((p) => ({
+                class: p.property.classInfo.name,
+                name: p.property.name,
+            })),
+        };
+    }
+}
+/**
+ * Describes a content field that contains [Nested content]($docs/presentation/content/Terminology#nested-content).
+ *
+ * @public
+ */
+export 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 = RelationshipMeaning.RelatedInstance;
+        this.nestedFields = nestedFields;
+        this.autoExpand = autoExpand;
+        this.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;
+        clone.rebuildParentship(this.parent);
+        return clone;
+    }
+    /**
+     * Get field by its name
+     * @param name Name of the field to find
+     * @param recurse Recurse into nested fields
+     */
+    getFieldByName(name, recurse) {
+        return getFieldByName(this.nestedFields, name, recurse);
+    }
+    /** Serialize this object to JSON */
+    toJSON() {
+        return {
+            ...super.toJSON(),
+            contentClassInfo: this.contentClassInfo,
+            pathToPrimaryClass: this.pathToPrimaryClass,
+            relationshipMeaning: this.relationshipMeaning,
+            actualPrimaryClassIds: this.actualPrimaryClassIds,
+            nestedFields: this.nestedFields.map((field) => field.toJSON()),
+            autoExpand: this.autoExpand,
+        };
+    }
+    /**
+     * Deserialize [[NestedContentField]] from JSON
+     * @deprecated in 3.x. Use [[NestedContentField.fromCompressedJSON]]
+     */
+    static fromJSON(json, categories) {
+        if (!json)
+            return undefined;
+        const field = Object.create(NestedContentField.prototype);
+        return Object.assign(field, json, this.fromCommonJSON(json, categories), {
+            nestedFields: json.nestedFields
+                .map((nestedFieldJson) => Field.fromJSON(nestedFieldJson, categories))
+                .filter((nestedField) => !!nestedField),
+        });
+    }
+    /** Deserialize a [[NestedContentField]] from compressed JSON. */
+    static fromCompressedJSON(json, classesMap, categories) {
+        assert(classesMap.hasOwnProperty(json.contentClassInfo));
+        const field = Object.create(NestedContentField.prototype);
+        return Object.assign(field, json, this.fromCommonJSON(json, categories), {
+            category: this.getCategoryFromFieldJson(json, categories),
+            nestedFields: json.nestedFields.map((nestedFieldJson) => Field.fromCompressedJSON(nestedFieldJson, classesMap, categories))
+                .filter((nestedField) => !!nestedField),
+            contentClassInfo: { id: json.contentClassInfo, ...classesMap[json.contentClassInfo] },
+            pathToPrimaryClass: json.pathToPrimaryClass.map((stepJson) => RelatedClassInfo.fromCompressedJSON(stepJson, classesMap)),
+        });
+    }
+    // eslint-disable-next-line deprecation/deprecation
+    static fromCommonJSON(json, categories) {
+        return {
+            category: this.getCategoryFromFieldJson(json, categories),
+            relationshipMeaning: json.relationshipMeaning ?? RelationshipMeaning.RelatedInstance,
+            actualPrimaryClassIds: json.actualPrimaryClassIds ?? [],
+            autoExpand: json.autoExpand,
+        };
+    }
+    /** Resets parent of this field and all nested fields. */
+    resetParentship() {
+        super.resetParentship();
+        for (const nestedField of this.nestedFields)
+            nestedField.resetParentship();
+    }
+    /**
+     * Sets provided [[NestedContentField]] as parent of this fields and recursively updates
+     * all nested fields parents.
+     */
+    rebuildParentship(parentField) {
+        super.rebuildParentship(parentField);
+        for (const nestedField of this.nestedFields)
+            nestedField.rebuildParentship(this);
+    }
+}
+/** @internal */
+export const getFieldByName = (fields, name, recurse) => {
+    if (name) {
+        for (const field of fields) {
+            if (field.name === name)
+                return field;
+            if (recurse && field.isNestedContentField()) {
+                const nested = getFieldByName(field.nestedFields, name, recurse);
+                if (nested)
+                    return nested;
+            }
+        }
+    }
+    return undefined;
+};
+/**
+ * Types of different field descriptors.
+ * @public
+ */
+export var FieldDescriptorType;
+(function (FieldDescriptorType) {
+    FieldDescriptorType["Name"] = "name";
+    FieldDescriptorType["Properties"] = "properties";
+})(FieldDescriptorType || (FieldDescriptorType = {}));
+/** @public */
+export var FieldDescriptor;
+(function (FieldDescriptor) {
+    /** Is this a named field descriptor */
+    function isNamed(d) {
+        return d.type === FieldDescriptorType.Name;
+    }
+    FieldDescriptor.isNamed = isNamed;
+    /** Is this a properties field descriptor */
+    function isProperties(d) {
+        return d.type === FieldDescriptorType.Properties;
+    }
+    FieldDescriptor.isProperties = isProperties;
+})(FieldDescriptor || (FieldDescriptor = {}));
+function fromCompressedPropertyJSON(compressedPropertyJSON, classesMap) {
+    return {
+        property: fromCompressedPropertyInfoJSON(compressedPropertyJSON.property, classesMap),
+    };
+}
+function fromCompressedPropertyInfoJSON(compressedPropertyJSON, classesMap) {
+    assert(classesMap.hasOwnProperty(compressedPropertyJSON.classInfo));
+    const { navigationPropertyInfo, ...leftOverPropertyJSON } = compressedPropertyJSON;
+    return {
+        ...leftOverPropertyJSON,
+        classInfo: { id: compressedPropertyJSON.classInfo, ...classesMap[compressedPropertyJSON.classInfo] },
+        ...(navigationPropertyInfo ? { navigationPropertyInfo: NavigationPropertyInfo.fromCompressedJSON(navigationPropertyInfo, classesMap) } : undefined),
+    };
+}
 //# sourceMappingURL=Fields.js.map