@itwin/presentation-common 4.0.0-dev.23 → 4.0.0-dev.24

package/lib/esm/presentation-common/Utils.d.ts

@@ -1,63 +1,63 @@
-/** @packageDocumentation
- * @module Core
- */
-import { KeySet } from "./KeySet";
-/**
- * Create a type with `T` properties excluding properties listed in `K`.
- *
- * Usage example: `Omit<SomeType, "exclude_prop1" | "exclude_prop2">`
- *
- * @public
- */
-export declare type Omit<T, K> = Pick<T, Exclude<keyof T, K>>;
-/**
- * Create a type with `T` properties excluding all properties in type `K`.
- *
- * Usage example: `Subtract<SomeType, ExcludePropertiesInThisType>`
- *
- * @public
- */
-export declare type Subtract<T, K> = Omit<T, keyof K>;
-/**
- * Create a type from given type `T` and make specified properties optional.
- * @public
- */
-export declare type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-/**
- * A dictionary data structure.
- * @public
- */
-export interface ValuesDictionary<T> {
-    [key: string]: T;
-}
-/**
- * A structure for paged responses
- * @public
- */
-export interface PagedResponse<T> {
-    /** Total number of items */
-    total: number;
-    /** Items for the requested page  */
-    items: T[];
-}
-/**
- * Get total number of instances included in the supplied key set. The
- * count is calculated by adding all of the following:
- * - `keys.instanceKeysCount`
- * - number of `keys.nodeKeys` which are *ECInstance* keys
- * - for every grouping node key in `keys.nodeKeys`, number of grouped instances
- *
- * E.g. if `keys` contains one instance key, one *ECInstance* node key
- * and one grouping node key which groups 3 instances, the result is 5.
- *
- * @public
- */
-export declare const getInstancesCount: (keys: Readonly<KeySet>) => number;
-/**
- * Default (recommended) keyset batch size for cases when it needs to be sent
- * over HTTP. Sending keys in batches helps avoid HTTP413 error.
- *
- * @public
- */
-export declare const DEFAULT_KEYS_BATCH_SIZE = 5000;
+/** @packageDocumentation
+ * @module Core
+ */
+import { KeySet } from "./KeySet";
+/**
+ * Create a type with `T` properties excluding properties listed in `K`.
+ *
+ * Usage example: `Omit<SomeType, "exclude_prop1" | "exclude_prop2">`
+ *
+ * @public
+ */
+export declare type Omit<T, K> = Pick<T, Exclude<keyof T, K>>;
+/**
+ * Create a type with `T` properties excluding all properties in type `K`.
+ *
+ * Usage example: `Subtract<SomeType, ExcludePropertiesInThisType>`
+ *
+ * @public
+ */
+export declare type Subtract<T, K> = Omit<T, keyof K>;
+/**
+ * Create a type from given type `T` and make specified properties optional.
+ * @public
+ */
+export declare type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+/**
+ * A dictionary data structure.
+ * @public
+ */
+export interface ValuesDictionary<T> {
+    [key: string]: T;
+}
+/**
+ * A structure for paged responses
+ * @public
+ */
+export interface PagedResponse<T> {
+    /** Total number of items */
+    total: number;
+    /** Items for the requested page  */
+    items: T[];
+}
+/**
+ * Get total number of instances included in the supplied key set. The
+ * count is calculated by adding all of the following:
+ * - `keys.instanceKeysCount`
+ * - number of `keys.nodeKeys` which are *ECInstance* keys
+ * - for every grouping node key in `keys.nodeKeys`, number of grouped instances
+ *
+ * E.g. if `keys` contains one instance key, one *ECInstance* node key
+ * and one grouping node key which groups 3 instances, the result is 5.
+ *
+ * @public
+ */
+export declare const getInstancesCount: (keys: Readonly<KeySet>) => number;
+/**
+ * Default (recommended) keyset batch size for cases when it needs to be sent
+ * over HTTP. Sending keys in batches helps avoid HTTP413 error.
+ *
+ * @public
+ */
+export declare const DEFAULT_KEYS_BATCH_SIZE = 5000;
 //# sourceMappingURL=Utils.d.ts.map

package/lib/esm/presentation-common/Utils.js

@@ -1,40 +1,40 @@
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module Core
- */
-import { NodeKey } from "./hierarchy/Key";
-/**
- * Get total number of instances included in the supplied key set. The
- * count is calculated by adding all of the following:
- * - `keys.instanceKeysCount`
- * - number of `keys.nodeKeys` which are *ECInstance* keys
- * - for every grouping node key in `keys.nodeKeys`, number of grouped instances
- *
- * E.g. if `keys` contains one instance key, one *ECInstance* node key
- * and one grouping node key which groups 3 instances, the result is 5.
- *
- * @public
- */
-export const getInstancesCount = (keys) => {
-    let count = keys.instanceKeysCount;
-    keys.nodeKeys.forEach((key) => {
-        if (NodeKey.isInstancesNodeKey(key)) {
-            count += key.instanceKeys.length;
-        }
-        else if (NodeKey.isGroupingNodeKey(key)) {
-            count += key.groupedInstancesCount;
-        }
-    });
-    return count;
-};
-/**
- * Default (recommended) keyset batch size for cases when it needs to be sent
- * over HTTP. Sending keys in batches helps avoid HTTP413 error.
- *
- * @public
- */
-export const DEFAULT_KEYS_BATCH_SIZE = 5000;
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Core
+ */
+import { NodeKey } from "./hierarchy/Key";
+/**
+ * Get total number of instances included in the supplied key set. The
+ * count is calculated by adding all of the following:
+ * - `keys.instanceKeysCount`
+ * - number of `keys.nodeKeys` which are *ECInstance* keys
+ * - for every grouping node key in `keys.nodeKeys`, number of grouped instances
+ *
+ * E.g. if `keys` contains one instance key, one *ECInstance* node key
+ * and one grouping node key which groups 3 instances, the result is 5.
+ *
+ * @public
+ */
+export const getInstancesCount = (keys) => {
+    let count = keys.instanceKeysCount;
+    keys.nodeKeys.forEach((key) => {
+        if (NodeKey.isInstancesNodeKey(key)) {
+            count += key.instanceKeys.length;
+        }
+        else if (NodeKey.isGroupingNodeKey(key)) {
+            count += key.groupedInstancesCount;
+        }
+    });
+    return count;
+};
+/**
+ * Default (recommended) keyset batch size for cases when it needs to be sent
+ * over HTTP. Sending keys in batches helps avoid HTTP413 error.
+ *
+ * @public
+ */
+export const DEFAULT_KEYS_BATCH_SIZE = 5000;
 //# sourceMappingURL=Utils.js.map

package/lib/esm/presentation-common/Utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/presentation-common/Utils.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AA8C1C;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAsB,EAAU,EAAE;IAClE,IAAI,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC;IACnC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAY,EAAE,EAAE;QACrC,IAAI,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE;YACnC,KAAK,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC;SAClC;aAAM,IAAI,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE;YACzC,KAAK,IAAI,GAAG,CAAC,qBAAqB,CAAC;SACpC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAC","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 Core\n */\n\nimport { NodeKey } from \"./hierarchy/Key\";\nimport { KeySet } from \"./KeySet\";\n\n/**\n * Create a type with `T` properties excluding properties listed in `K`.\n *\n * Usage example: `Omit<SomeType, \"exclude_prop1\" | \"exclude_prop2\">`\n *\n * @public\n */\nexport type Omit<T, K> = Pick<T, Exclude<keyof T, K>>;\n\n/**\n * Create a type with `T` properties excluding all properties in type `K`.\n *\n * Usage example: `Subtract<SomeType, ExcludePropertiesInThisType>`\n *\n * @public\n */\nexport type Subtract<T, K> = Omit<T, keyof K>;\n\n/**\n * Create a type from given type `T` and make specified properties optional.\n * @public\n */\nexport type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;\n\n/**\n * A dictionary data structure.\n * @public\n */\nexport interface ValuesDictionary<T> {\n  [key: string]: T;\n}\n\n/**\n * A structure for paged responses\n * @public\n */\nexport interface PagedResponse<T> {\n  /** Total number of items */\n  total: number;\n  /** Items for the requested page  */\n  items: T[];\n}\n\n/**\n * Get total number of instances included in the supplied key set. The\n * count is calculated by adding all of the following:\n * - `keys.instanceKeysCount`\n * - number of `keys.nodeKeys` which are *ECInstance* keys\n * - for every grouping node key in `keys.nodeKeys`, number of grouped instances\n *\n * E.g. if `keys` contains one instance key, one *ECInstance* node key\n * and one grouping node key which groups 3 instances, the result is 5.\n *\n * @public\n */\nexport const getInstancesCount = (keys: Readonly<KeySet>): number => {\n  let count = keys.instanceKeysCount;\n  keys.nodeKeys.forEach((key: NodeKey) => {\n    if (NodeKey.isInstancesNodeKey(key)) {\n      count += key.instanceKeys.length;\n    } else if (NodeKey.isGroupingNodeKey(key)) {\n      count += key.groupedInstancesCount;\n    }\n  });\n  return count;\n};\n\n/**\n * Default (recommended) keyset batch size for cases when it needs to be sent\n * over HTTP. Sending keys in batches helps avoid HTTP413 error.\n *\n * @public\n */\nexport const DEFAULT_KEYS_BATCH_SIZE = 5000;\n"]}
+{"version":3,"file":"Utils.js","sourceRoot":"","sources":["../../../src/presentation-common/Utils.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AA8C1C;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAsB,EAAU,EAAE;IAClE,IAAI,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC;IACnC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAY,EAAE,EAAE;QACrC,IAAI,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE;YACnC,KAAK,IAAI,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC;SAClC;aAAM,IAAI,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE;YACzC,KAAK,IAAI,GAAG,CAAC,qBAAqB,CAAC;SACpC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAC","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 Core\r\n */\r\n\r\nimport { NodeKey } from \"./hierarchy/Key\";\r\nimport { KeySet } from \"./KeySet\";\r\n\r\n/**\r\n * Create a type with `T` properties excluding properties listed in `K`.\r\n *\r\n * Usage example: `Omit<SomeType, \"exclude_prop1\" | \"exclude_prop2\">`\r\n *\r\n * @public\r\n */\r\nexport type Omit<T, K> = Pick<T, Exclude<keyof T, K>>;\r\n\r\n/**\r\n * Create a type with `T` properties excluding all properties in type `K`.\r\n *\r\n * Usage example: `Subtract<SomeType, ExcludePropertiesInThisType>`\r\n *\r\n * @public\r\n */\r\nexport type Subtract<T, K> = Omit<T, keyof K>;\r\n\r\n/**\r\n * Create a type from given type `T` and make specified properties optional.\r\n * @public\r\n */\r\nexport type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;\r\n\r\n/**\r\n * A dictionary data structure.\r\n * @public\r\n */\r\nexport interface ValuesDictionary<T> {\r\n  [key: string]: T;\r\n}\r\n\r\n/**\r\n * A structure for paged responses\r\n * @public\r\n */\r\nexport interface PagedResponse<T> {\r\n  /** Total number of items */\r\n  total: number;\r\n  /** Items for the requested page  */\r\n  items: T[];\r\n}\r\n\r\n/**\r\n * Get total number of instances included in the supplied key set. The\r\n * count is calculated by adding all of the following:\r\n * - `keys.instanceKeysCount`\r\n * - number of `keys.nodeKeys` which are *ECInstance* keys\r\n * - for every grouping node key in `keys.nodeKeys`, number of grouped instances\r\n *\r\n * E.g. if `keys` contains one instance key, one *ECInstance* node key\r\n * and one grouping node key which groups 3 instances, the result is 5.\r\n *\r\n * @public\r\n */\r\nexport const getInstancesCount = (keys: Readonly<KeySet>): number => {\r\n  let count = keys.instanceKeysCount;\r\n  keys.nodeKeys.forEach((key: NodeKey) => {\r\n    if (NodeKey.isInstancesNodeKey(key)) {\r\n      count += key.instanceKeys.length;\r\n    } else if (NodeKey.isGroupingNodeKey(key)) {\r\n      count += key.groupedInstancesCount;\r\n    }\r\n  });\r\n  return count;\r\n};\r\n\r\n/**\r\n * Default (recommended) keyset batch size for cases when it needs to be sent\r\n * over HTTP. Sending keys in batches helps avoid HTTP413 error.\r\n *\r\n * @public\r\n */\r\nexport const DEFAULT_KEYS_BATCH_SIZE = 5000;\r\n"]}

package/lib/esm/presentation-common/content/Category.d.ts

@@ -1,50 +1,50 @@
-/** @packageDocumentation
- * @module Content
- */
-import { RendererDescription } from "./Renderer";
-/**
- * A data structure that describes a [[Field]] category.
- * @public
- */
-export interface CategoryDescription {
-    /** Unique name */
-    name: string;
-    /** Display label */
-    label: string;
-    /** Extensive description */
-    description: string;
-    /** Priority. Categories with higher priority should appear higher in the UI */
-    priority: number;
-    /** Should this category be auto-expanded when it's displayed in the UI */
-    expand: boolean;
-    /** Parent category description */
-    parent?: CategoryDescription;
-    /** Custom renderer description */
-    renderer?: RendererDescription;
-}
-/** @public */
-export declare namespace CategoryDescription {
-    /** Serialize given category to JSON */
-    function toJSON(category: CategoryDescription): CategoryDescriptionJSON;
-    /**
-     * Deserialize [[CategoryDescription]] from JSON. The `parent` is not assigned - use [[CategoryDescription.listFromJSON]]
-     * to deserialize the whole categories list and set parents.
-     */
-    function fromJSON(json: CategoryDescriptionJSON): CategoryDescription;
-    /** Deserialize a list of [[CategoryDescription]] from JSON. */
-    function listFromJSON(json: CategoryDescriptionJSON[]): CategoryDescription[];
-}
-/**
- * Serialized [[CategoryDescription]] JSON representation.
- * @public
- */
-export interface CategoryDescriptionJSON {
-    name: string;
-    label: string;
-    description: string;
-    priority: number;
-    expand: boolean;
-    parent?: string;
-    renderer?: RendererDescription;
-}
+/** @packageDocumentation
+ * @module Content
+ */
+import { RendererDescription } from "./Renderer";
+/**
+ * A data structure that describes a [[Field]] category.
+ * @public
+ */
+export interface CategoryDescription {
+    /** Unique name */
+    name: string;
+    /** Display label */
+    label: string;
+    /** Extensive description */
+    description: string;
+    /** Priority. Categories with higher priority should appear higher in the UI */
+    priority: number;
+    /** Should this category be auto-expanded when it's displayed in the UI */
+    expand: boolean;
+    /** Parent category description */
+    parent?: CategoryDescription;
+    /** Custom renderer description */
+    renderer?: RendererDescription;
+}
+/** @public */
+export declare namespace CategoryDescription {
+    /** Serialize given category to JSON */
+    function toJSON(category: CategoryDescription): CategoryDescriptionJSON;
+    /**
+     * Deserialize [[CategoryDescription]] from JSON. The `parent` is not assigned - use [[CategoryDescription.listFromJSON]]
+     * to deserialize the whole categories list and set parents.
+     */
+    function fromJSON(json: CategoryDescriptionJSON): CategoryDescription;
+    /** Deserialize a list of [[CategoryDescription]] from JSON. */
+    function listFromJSON(json: CategoryDescriptionJSON[]): CategoryDescription[];
+}
+/**
+ * Serialized [[CategoryDescription]] JSON representation.
+ * @public
+ */
+export interface CategoryDescriptionJSON {
+    name: string;
+    label: string;
+    description: string;
+    priority: number;
+    expand: boolean;
+    parent?: string;
+    renderer?: RendererDescription;
+}
 //# sourceMappingURL=Category.d.ts.map

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

@@ -1,46 +1,46 @@
-/*---------------------------------------------------------------------------------------------
-* 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
- */
-/** @public */
-export var CategoryDescription;
-(function (CategoryDescription) {
-    /** Serialize given category to JSON */
-    function toJSON(category) {
-        const { parent, ...rest } = category;
-        return {
-            ...rest,
-            ...(parent ? { parent: parent.name } : undefined),
-        };
-    }
-    CategoryDescription.toJSON = toJSON;
-    /**
-     * Deserialize [[CategoryDescription]] from JSON. The `parent` is not assigned - use [[CategoryDescription.listFromJSON]]
-     * to deserialize the whole categories list and set parents.
-     */
-    function fromJSON(json) {
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
-        const { parent, ...rest } = json;
-        return rest;
-    }
-    CategoryDescription.fromJSON = fromJSON;
-    function createCategoriesHierarchy(json, categoriesMap) {
-        const category = categoriesMap.get(json.name);
-        if (json.parent) {
-            // note: mutating categories in the `categoriesMap`
-            category.parent = categoriesMap.get(json.parent);
-        }
-        return category;
-    }
-    /** Deserialize a list of [[CategoryDescription]] from JSON. */
-    function listFromJSON(json) {
-        const categoriesMap = new Map();
-        json.forEach((categoryJson) => categoriesMap.set(categoryJson.name, CategoryDescription.fromJSON(categoryJson)));
-        return json.map((categoryJson) => createCategoriesHierarchy(categoryJson, categoriesMap));
-    }
-    CategoryDescription.listFromJSON = listFromJSON;
-})(CategoryDescription || (CategoryDescription = {}));
+/*---------------------------------------------------------------------------------------------
+* 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
+ */
+/** @public */
+export var CategoryDescription;
+(function (CategoryDescription) {
+    /** Serialize given category to JSON */
+    function toJSON(category) {
+        const { parent, ...rest } = category;
+        return {
+            ...rest,
+            ...(parent ? { parent: parent.name } : undefined),
+        };
+    }
+    CategoryDescription.toJSON = toJSON;
+    /**
+     * Deserialize [[CategoryDescription]] from JSON. The `parent` is not assigned - use [[CategoryDescription.listFromJSON]]
+     * to deserialize the whole categories list and set parents.
+     */
+    function fromJSON(json) {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { parent, ...rest } = json;
+        return rest;
+    }
+    CategoryDescription.fromJSON = fromJSON;
+    function createCategoriesHierarchy(json, categoriesMap) {
+        const category = categoriesMap.get(json.name);
+        if (json.parent) {
+            // note: mutating categories in the `categoriesMap`
+            category.parent = categoriesMap.get(json.parent);
+        }
+        return category;
+    }
+    /** Deserialize a list of [[CategoryDescription]] from JSON. */
+    function listFromJSON(json) {
+        const categoriesMap = new Map();
+        json.forEach((categoryJson) => categoriesMap.set(categoryJson.name, CategoryDescription.fromJSON(categoryJson)));
+        return json.map((categoryJson) => createCategoriesHierarchy(categoryJson, categoriesMap));
+    }
+    CategoryDescription.listFromJSON = listFromJSON;
+})(CategoryDescription || (CategoryDescription = {}));
 //# sourceMappingURL=Category.js.map

package/lib/esm/presentation-common/content/Category.js.map

@@ -1 +1 @@
-{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Category.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAwBH,cAAc;AACd,MAAM,KAAW,mBAAmB,CAmCnC;AAnCD,WAAiB,mBAAmB;IAClC,uCAAuC;IACvC,SAAgB,MAAM,CAAC,QAA6B;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC;QACrC,OAAO;YACL,GAAG,IAAI;YACP,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAClD,CAAC;IACJ,CAAC;IANe,0BAAM,SAMrB,CAAA;IAED;;;OAGG;IACH,SAAgB,QAAQ,CAAC,IAA6B;QACpD,6DAA6D;QAC7D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAJe,4BAAQ,WAIvB,CAAA;IAED,SAAS,yBAAyB,CAAC,IAA6B,EAAE,aAA+C;QAC/G,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAE,CAAC;QAC/C,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,mDAAmD;YACnD,QAAQ,CAAC,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAClD;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,+DAA+D;IAC/D,SAAgB,YAAY,CAAC,IAA+B;QAC1D,MAAM,aAAa,GAAG,IAAI,GAAG,EAA+B,CAAC;QAC7D,IAAI,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,mBAAmB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACjH,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,yBAAyB,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;IAC5F,CAAC;IAJe,gCAAY,eAI3B,CAAA;AACH,CAAC,EAnCgB,mBAAmB,KAAnB,mBAAmB,QAmCnC","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 Content\n */\n\nimport { RendererDescription } from \"./Renderer\";\n\n/**\n * A data structure that describes a [[Field]] category.\n * @public\n */\nexport interface CategoryDescription {\n  /** Unique name */\n  name: string;\n  /** Display label */\n  label: string;\n  /** Extensive description */\n  description: string;\n  /** Priority. Categories with higher priority should appear higher in the UI */\n  priority: number;\n  /** Should this category be auto-expanded when it's displayed in the UI */\n  expand: boolean;\n  /** Parent category description */\n  parent?: CategoryDescription;\n  /** Custom renderer description */\n  renderer?: RendererDescription;\n}\n/** @public */\nexport namespace CategoryDescription {\n  /** Serialize given category to JSON */\n  export function toJSON(category: CategoryDescription): CategoryDescriptionJSON {\n    const { parent, ...rest } = category;\n    return {\n      ...rest,\n      ...(parent ? { parent: parent.name } : undefined),\n    };\n  }\n\n  /**\n   * Deserialize [[CategoryDescription]] from JSON. The `parent` is not assigned - use [[CategoryDescription.listFromJSON]]\n   * to deserialize the whole categories list and set parents.\n   */\n  export function fromJSON(json: CategoryDescriptionJSON): CategoryDescription {\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n    const { parent, ...rest } = json;\n    return rest;\n  }\n\n  function createCategoriesHierarchy(json: CategoryDescriptionJSON, categoriesMap: Map<string, CategoryDescription>): CategoryDescription {\n    const category = categoriesMap.get(json.name)!;\n    if (json.parent) {\n      // note: mutating categories in the `categoriesMap`\n      category.parent = categoriesMap.get(json.parent);\n    }\n    return category;\n  }\n\n  /** Deserialize a list of [[CategoryDescription]] from JSON. */\n  export function listFromJSON(json: CategoryDescriptionJSON[]): CategoryDescription[] {\n    const categoriesMap = new Map<string, CategoryDescription>();\n    json.forEach((categoryJson) => categoriesMap.set(categoryJson.name, CategoryDescription.fromJSON(categoryJson)));\n    return json.map((categoryJson) => createCategoriesHierarchy(categoryJson, categoriesMap));\n  }\n}\n\n/**\n * Serialized [[CategoryDescription]] JSON representation.\n * @public\n */\nexport interface CategoryDescriptionJSON {\n  name: string;\n  label: string;\n  description: string;\n  priority: number;\n  expand: boolean;\n  parent?: string;\n  renderer?: RendererDescription;\n}\n"]}
+{"version":3,"file":"Category.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Category.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAwBH,cAAc;AACd,MAAM,KAAW,mBAAmB,CAmCnC;AAnCD,WAAiB,mBAAmB;IAClC,uCAAuC;IACvC,SAAgB,MAAM,CAAC,QAA6B;QAClD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC;QACrC,OAAO;YACL,GAAG,IAAI;YACP,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAClD,CAAC;IACJ,CAAC;IANe,0BAAM,SAMrB,CAAA;IAED;;;OAGG;IACH,SAAgB,QAAQ,CAAC,IAA6B;QACpD,6DAA6D;QAC7D,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IAJe,4BAAQ,WAIvB,CAAA;IAED,SAAS,yBAAyB,CAAC,IAA6B,EAAE,aAA+C;QAC/G,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAE,CAAC;QAC/C,IAAI,IAAI,CAAC,MAAM,EAAE;YACf,mDAAmD;YACnD,QAAQ,CAAC,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAClD;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,+DAA+D;IAC/D,SAAgB,YAAY,CAAC,IAA+B;QAC1D,MAAM,aAAa,GAAG,IAAI,GAAG,EAA+B,CAAC;QAC7D,IAAI,CAAC,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,mBAAmB,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACjH,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,yBAAyB,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC,CAAC;IAC5F,CAAC;IAJe,gCAAY,eAI3B,CAAA;AACH,CAAC,EAnCgB,mBAAmB,KAAnB,mBAAmB,QAmCnC","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 Content\r\n */\r\n\r\nimport { RendererDescription } from \"./Renderer\";\r\n\r\n/**\r\n * A data structure that describes a [[Field]] category.\r\n * @public\r\n */\r\nexport interface CategoryDescription {\r\n  /** Unique name */\r\n  name: string;\r\n  /** Display label */\r\n  label: string;\r\n  /** Extensive description */\r\n  description: string;\r\n  /** Priority. Categories with higher priority should appear higher in the UI */\r\n  priority: number;\r\n  /** Should this category be auto-expanded when it's displayed in the UI */\r\n  expand: boolean;\r\n  /** Parent category description */\r\n  parent?: CategoryDescription;\r\n  /** Custom renderer description */\r\n  renderer?: RendererDescription;\r\n}\r\n/** @public */\r\nexport namespace CategoryDescription {\r\n  /** Serialize given category to JSON */\r\n  export function toJSON(category: CategoryDescription): CategoryDescriptionJSON {\r\n    const { parent, ...rest } = category;\r\n    return {\r\n      ...rest,\r\n      ...(parent ? { parent: parent.name } : undefined),\r\n    };\r\n  }\r\n\r\n  /**\r\n   * Deserialize [[CategoryDescription]] from JSON. The `parent` is not assigned - use [[CategoryDescription.listFromJSON]]\r\n   * to deserialize the whole categories list and set parents.\r\n   */\r\n  export function fromJSON(json: CategoryDescriptionJSON): CategoryDescription {\r\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\r\n    const { parent, ...rest } = json;\r\n    return rest;\r\n  }\r\n\r\n  function createCategoriesHierarchy(json: CategoryDescriptionJSON, categoriesMap: Map<string, CategoryDescription>): CategoryDescription {\r\n    const category = categoriesMap.get(json.name)!;\r\n    if (json.parent) {\r\n      // note: mutating categories in the `categoriesMap`\r\n      category.parent = categoriesMap.get(json.parent);\r\n    }\r\n    return category;\r\n  }\r\n\r\n  /** Deserialize a list of [[CategoryDescription]] from JSON. */\r\n  export function listFromJSON(json: CategoryDescriptionJSON[]): CategoryDescription[] {\r\n    const categoriesMap = new Map<string, CategoryDescription>();\r\n    json.forEach((categoryJson) => categoriesMap.set(categoryJson.name, CategoryDescription.fromJSON(categoryJson)));\r\n    return json.map((categoryJson) => createCategoriesHierarchy(categoryJson, categoriesMap));\r\n  }\r\n}\r\n\r\n/**\r\n * Serialized [[CategoryDescription]] JSON representation.\r\n * @public\r\n */\r\nexport interface CategoryDescriptionJSON {\r\n  name: string;\r\n  label: string;\r\n  description: string;\r\n  priority: number;\r\n  expand: boolean;\r\n  parent?: string;\r\n  renderer?: RendererDescription;\r\n}\r\n"]}

package/lib/esm/presentation-common/content/Content.d.ts

@@ -1,39 +1,39 @@
-/** @packageDocumentation
- * @module Content
- */
-import { Descriptor, DescriptorJSON } from "./Descriptor";
-import { Item, ItemJSON } from "./Item";
-/**
- * Serialized [[Content]] JSON representation.
- * @public
- */
-export interface ContentJSON {
-    descriptor: DescriptorJSON;
-    contentSet: ItemJSON[];
-}
-/**
- * A data structure that contains the [[Descriptor]] and a list of [[Item]]
- * objects which are based on that descriptor.
- *
- * @public
- */
-export declare class Content {
-    /** Descriptor used to create the content */
-    readonly descriptor: Descriptor;
-    /** Content items */
-    readonly contentSet: Item[];
-    /** Create a new [[Content]] instance */
-    constructor(descriptor: Descriptor, items: Item[]);
-    /** Serialize this object to JSON */
-    toJSON(): ContentJSON;
-    /** Deserialize [[Content]] from JSON */
-    static fromJSON(json: ContentJSON | string | undefined): Content | undefined;
-    /**
-     * Reviver function that can be used as a second argument for
-     * `JSON.parse` method when parsing Content objects.
-     *
-     * @internal
-     */
-    static reviver(key: string, value: any): any;
-}
+/** @packageDocumentation
+ * @module Content
+ */
+import { Descriptor, DescriptorJSON } from "./Descriptor";
+import { Item, ItemJSON } from "./Item";
+/**
+ * Serialized [[Content]] JSON representation.
+ * @public
+ */
+export interface ContentJSON {
+    descriptor: DescriptorJSON;
+    contentSet: ItemJSON[];
+}
+/**
+ * A data structure that contains the [[Descriptor]] and a list of [[Item]]
+ * objects which are based on that descriptor.
+ *
+ * @public
+ */
+export declare class Content {
+    /** Descriptor used to create the content */
+    readonly descriptor: Descriptor;
+    /** Content items */
+    readonly contentSet: Item[];
+    /** Create a new [[Content]] instance */
+    constructor(descriptor: Descriptor, items: Item[]);
+    /** Serialize this object to JSON */
+    toJSON(): ContentJSON;
+    /** Deserialize [[Content]] from JSON */
+    static fromJSON(json: ContentJSON | string | undefined): Content | undefined;
+    /**
+     * Reviver function that can be used as a second argument for
+     * `JSON.parse` method when parsing Content objects.
+     *
+     * @internal
+     */
+    static reviver(key: string, value: any): any;
+}
 //# sourceMappingURL=Content.d.ts.map

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

@@ -1,53 +1,53 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { Descriptor } from "./Descriptor";
-import { Item } from "./Item";
-/**
- * A data structure that contains the [[Descriptor]] and a list of [[Item]]
- * objects which are based on that descriptor.
- *
- * @public
- */
-export class Content {
-    /** Create a new [[Content]] instance */
-    constructor(descriptor, items) {
-        this.descriptor = descriptor;
-        this.contentSet = items;
-    }
-    /** Serialize this object to JSON */
-    toJSON() {
-        return {
-            descriptor: this.descriptor.toJSON(),
-            contentSet: this.contentSet.map((item) => item.toJSON()),
-        };
-    }
-    /** Deserialize [[Content]] from JSON */
-    static fromJSON(json) {
-        if (!json)
-            return undefined;
-        if (typeof json === "string")
-            return JSON.parse(json, Content.reviver);
-        const descriptor = Descriptor.fromJSON(json.descriptor);
-        if (!descriptor)
-            return undefined;
-        const contentSet = json.contentSet
-            .map((itemJson) => Item.fromJSON(itemJson))
-            .filter((item) => (item !== undefined));
-        return new Content(descriptor, contentSet);
-    }
-    /**
-     * Reviver function that can be used as a second argument for
-     * `JSON.parse` method when parsing Content objects.
-     *
-     * @internal
-     */
-    static reviver(key, value) {
-        return key === "" ? Content.fromJSON(value) : value;
-    }
-}
+/*---------------------------------------------------------------------------------------------
+* 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 { Descriptor } from "./Descriptor";
+import { Item } from "./Item";
+/**
+ * A data structure that contains the [[Descriptor]] and a list of [[Item]]
+ * objects which are based on that descriptor.
+ *
+ * @public
+ */
+export class Content {
+    /** Create a new [[Content]] instance */
+    constructor(descriptor, items) {
+        this.descriptor = descriptor;
+        this.contentSet = items;
+    }
+    /** Serialize this object to JSON */
+    toJSON() {
+        return {
+            descriptor: this.descriptor.toJSON(),
+            contentSet: this.contentSet.map((item) => item.toJSON()),
+        };
+    }
+    /** Deserialize [[Content]] from JSON */
+    static fromJSON(json) {
+        if (!json)
+            return undefined;
+        if (typeof json === "string")
+            return JSON.parse(json, Content.reviver);
+        const descriptor = Descriptor.fromJSON(json.descriptor);
+        if (!descriptor)
+            return undefined;
+        const contentSet = json.contentSet
+            .map((itemJson) => Item.fromJSON(itemJson))
+            .filter((item) => (item !== undefined));
+        return new Content(descriptor, contentSet);
+    }
+    /**
+     * Reviver function that can be used as a second argument for
+     * `JSON.parse` method when parsing Content objects.
+     *
+     * @internal
+     */
+    static reviver(key, value) {
+        return key === "" ? Content.fromJSON(value) : value;
+    }
+}
 //# sourceMappingURL=Content.js.map

package/lib/esm/presentation-common/content/Content.js.map

@@ -1 +1 @@
-{"version":3,"file":"Content.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Content.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAkB,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAY,MAAM,QAAQ,CAAC;AAWxC;;;;;GAKG;AACH,MAAM,OAAO,OAAO;IAMlB,wCAAwC;IACxC,YAAmB,UAAsB,EAAE,KAAa;QACtD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAED,oCAAoC;IAC7B,MAAM;QACX,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACpC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAU,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;SAC/D,CAAC;IACJ,CAAC;IAED,wCAAwC;IACjC,MAAM,CAAC,QAAQ,CAAC,IAAsC;QAC3D,IAAI,CAAC,IAAI;YACP,OAAO,SAAS,CAAC;QAEnB,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAE3C,MAAM,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,UAAU;YACb,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU;aAC/B,GAAG,CAAC,CAAC,QAAkB,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;aACpD,MAAM,CAAO,CAAC,IAAI,EAAgB,EAAE,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC;QAC9D,OAAO,IAAI,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,KAAU;QAC3C,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACtD,CAAC;CACF","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 Content\n */\n\nimport { Descriptor, DescriptorJSON } from \"./Descriptor\";\nimport { Item, ItemJSON } from \"./Item\";\n\n/**\n * Serialized [[Content]] JSON representation.\n * @public\n */\nexport interface ContentJSON {\n  descriptor: DescriptorJSON;\n  contentSet: ItemJSON[];\n}\n\n/**\n * A data structure that contains the [[Descriptor]] and a list of [[Item]]\n * objects which are based on that descriptor.\n *\n * @public\n */\nexport class Content {\n  /** Descriptor used to create the content */\n  public readonly descriptor: Descriptor;\n  /** Content items */\n  public readonly contentSet: Item[];\n\n  /** Create a new [[Content]] instance */\n  public constructor(descriptor: Descriptor, items: Item[]) {\n    this.descriptor = descriptor;\n    this.contentSet = items;\n  }\n\n  /** Serialize this object to JSON */\n  public toJSON(): ContentJSON {\n    return {\n      descriptor: this.descriptor.toJSON(),\n      contentSet: this.contentSet.map((item: Item) => item.toJSON()),\n    };\n  }\n\n  /** Deserialize [[Content]] from JSON */\n  public static fromJSON(json: ContentJSON | string | undefined): Content | undefined {\n    if (!json)\n      return undefined;\n\n    if (typeof json === \"string\")\n      return JSON.parse(json, Content.reviver);\n\n    const descriptor = Descriptor.fromJSON(json.descriptor);\n    if (!descriptor)\n      return undefined;\n\n    const contentSet = json.contentSet\n      .map((itemJson: ItemJSON) => Item.fromJSON(itemJson))\n      .filter<Item>((item): item is Item => (item !== undefined));\n    return new Content(descriptor, contentSet);\n  }\n\n  /**\n   * Reviver function that can be used as a second argument for\n   * `JSON.parse` method when parsing Content objects.\n   *\n   * @internal\n   */\n  public static reviver(key: string, value: any): any {\n    return key === \"\" ? Content.fromJSON(value) : value;\n  }\n}\n"]}
+{"version":3,"file":"Content.js","sourceRoot":"","sources":["../../../../src/presentation-common/content/Content.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAkB,MAAM,cAAc,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAY,MAAM,QAAQ,CAAC;AAWxC;;;;;GAKG;AACH,MAAM,OAAO,OAAO;IAMlB,wCAAwC;IACxC,YAAmB,UAAsB,EAAE,KAAa;QACtD,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;IAC1B,CAAC;IAED,oCAAoC;IAC7B,MAAM;QACX,OAAO;YACL,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;YACpC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,IAAU,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;SAC/D,CAAC;IACJ,CAAC;IAED,wCAAwC;IACjC,MAAM,CAAC,QAAQ,CAAC,IAAsC;QAC3D,IAAI,CAAC,IAAI;YACP,OAAO,SAAS,CAAC;QAEnB,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAE3C,MAAM,UAAU,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,UAAU;YACb,OAAO,SAAS,CAAC;QAEnB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU;aAC/B,GAAG,CAAC,CAAC,QAAkB,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;aACpD,MAAM,CAAO,CAAC,IAAI,EAAgB,EAAE,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC;QAC9D,OAAO,IAAI,OAAO,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,KAAU;QAC3C,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IACtD,CAAC;CACF","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 Content\r\n */\r\n\r\nimport { Descriptor, DescriptorJSON } from \"./Descriptor\";\r\nimport { Item, ItemJSON } from \"./Item\";\r\n\r\n/**\r\n * Serialized [[Content]] JSON representation.\r\n * @public\r\n */\r\nexport interface ContentJSON {\r\n  descriptor: DescriptorJSON;\r\n  contentSet: ItemJSON[];\r\n}\r\n\r\n/**\r\n * A data structure that contains the [[Descriptor]] and a list of [[Item]]\r\n * objects which are based on that descriptor.\r\n *\r\n * @public\r\n */\r\nexport class Content {\r\n  /** Descriptor used to create the content */\r\n  public readonly descriptor: Descriptor;\r\n  /** Content items */\r\n  public readonly contentSet: Item[];\r\n\r\n  /** Create a new [[Content]] instance */\r\n  public constructor(descriptor: Descriptor, items: Item[]) {\r\n    this.descriptor = descriptor;\r\n    this.contentSet = items;\r\n  }\r\n\r\n  /** Serialize this object to JSON */\r\n  public toJSON(): ContentJSON {\r\n    return {\r\n      descriptor: this.descriptor.toJSON(),\r\n      contentSet: this.contentSet.map((item: Item) => item.toJSON()),\r\n    };\r\n  }\r\n\r\n  /** Deserialize [[Content]] from JSON */\r\n  public static fromJSON(json: ContentJSON | string | undefined): Content | undefined {\r\n    if (!json)\r\n      return undefined;\r\n\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, Content.reviver);\r\n\r\n    const descriptor = Descriptor.fromJSON(json.descriptor);\r\n    if (!descriptor)\r\n      return undefined;\r\n\r\n    const contentSet = json.contentSet\r\n      .map((itemJson: ItemJSON) => Item.fromJSON(itemJson))\r\n      .filter<Item>((item): item is Item => (item !== undefined));\r\n    return new Content(descriptor, contentSet);\r\n  }\r\n\r\n  /**\r\n   * Reviver function that can be used as a second argument for\r\n   * `JSON.parse` method when parsing Content objects.\r\n   *\r\n   * @internal\r\n   */\r\n  public static reviver(key: string, value: any): any {\r\n    return key === \"\" ? Content.fromJSON(value) : value;\r\n  }\r\n}\r\n"]}