@itwin/presentation-common 3.2.0-dev.9 → 3.2.0

package/lib/esm/presentation-common/hierarchy/Node.js.map

@@ -1 +1 @@
-{"version":3,"file":"Node.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Node.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAuB,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAe,MAAM,OAAO,CAAC;AA2G7C,cAAc;AACd,MAAM,KAAW,IAAI,CAmFpB;AAnFD,WAAiB,IAAI;IACnB,uCAAuC;IACvC,SAAgB,MAAM,CAAC,IAAU;QAC/B,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACzC,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;YACxB,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC;SAC/C,CAAC;IACJ,CAAC;IAPe,WAAM,SAOrB,CAAA;IAED,gBAAgB;IAChB,SAAgB,aAAa,CAAC,IAAiB;QAC7C,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACzC,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;YACxB,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC;SAC/C,CAAC;IACJ,CAAC;IAXe,kBAAa,gBAW5B,CAAA;IAED,qCAAqC;IACrC,SAAgB,QAAQ,CAAC,IAAuB;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC9C,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;YAC/B,KAAK,EAAE,eAAe,CAAC,QAAQ,CAAC,eAAe,CAAC;SACjD,CAAC;IACJ,CAAC;IATe,aAAQ,WASvB,CAAA;IAED,gBAAgB;IAChB,SAAgB,eAAe,CAAC,IAAqB;QACnD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACnD,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YAC1B,KAAK,EAAE,eAAe,CAAC,QAAQ,CAAC,eAAe,CAAC;SACjD,CAAC;IACJ,CAAC;IAXe,oBAAe,kBAW9B,CAAA;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAW,EAAE,KAAU;QAC7C,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9C,CAAC;IAFe,YAAO,UAEtB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,YAAY,CAAC,IAAyB;QACpD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IAJe,iBAAY,eAI3B,CAAA;IAED;;;;;OAKG;IACH,SAAgB,WAAW,CAAC,GAAW,EAAE,KAAU;QACjD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAClD,CAAC;IAFe,gBAAW,cAE1B,CAAA;AACH,CAAC,EAnFgB,IAAI,KAAJ,IAAI,QAmFpB","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 Hierarchies\r\n */\r\n\r\nimport { LabelDefinition, LabelDefinitionJSON } from \"../LabelDefinition\";\r\nimport { NodeKey, NodeKeyJSON } from \"./Key\";\r\n\r\n/**\r\n * Data structure that describes a tree node.\r\n * @public\r\n */\r\nexport interface Node {\r\n  /** A key that uniquely identifies a node. */\r\n  key: NodeKey;\r\n  /** Definition of node display label */\r\n  label: LabelDefinition;\r\n  /** Extensive description */\r\n  description?: string;\r\n  /**\r\n   * Image ID\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  imageId?: string;\r\n  /**\r\n   * Foreground color\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  foreColor?: string;\r\n  /**\r\n   * Background color\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  backColor?: string;\r\n  /**\r\n   * Font style\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  fontStyle?: string;\r\n  /** Does this node have child nodes */\r\n  hasChildren?: boolean;\r\n  /** Is this node selectable */\r\n  isSelectionDisabled?: boolean;\r\n  /** Is this node editable */\r\n  isEditable?: boolean;\r\n  /** Is this node expanded */\r\n  isExpanded?: boolean;\r\n  /**\r\n   * Is checkbox visible for this node\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isCheckboxVisible?: boolean;\r\n  /**\r\n   * Is this node's checkbox checked\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isChecked?: boolean;\r\n  /**\r\n   * Is this node's checkbox enabled\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/Customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isCheckboxEnabled?: boolean;\r\n  /** Extended data injected into this node */\r\n  extendedData?: {\r\n    [key: string]: any;\r\n  };\r\n}\r\n\r\n/**\r\n * Serialized [[Node]] JSON representation.\r\n * @public\r\n */\r\nexport interface NodeJSON {\r\n  key: NodeKeyJSON;\r\n  labelDefinition: LabelDefinitionJSON;\r\n  description?: string;\r\n  /** @deprecated */\r\n  imageId?: string;\r\n  /** @deprecated */\r\n  foreColor?: string;\r\n  /** @deprecated */\r\n  backColor?: string;\r\n  /** @deprecated */\r\n  fontStyle?: string;\r\n  hasChildren?: boolean;\r\n  isSelectionDisabled?: boolean;\r\n  isEditable?: boolean;\r\n  isExpanded?: boolean;\r\n  /** @deprecated */\r\n  isCheckboxVisible?: boolean;\r\n  /** @deprecated */\r\n  isChecked?: boolean;\r\n  /** @deprecated */\r\n  isCheckboxEnabled?: boolean;\r\n  extendedData?: {\r\n    [key: string]: any;\r\n  };\r\n}\r\n\r\n/**\r\n * Partial node definition.\r\n * @public\r\n */\r\nexport type PartialNode = AllOrNone<Partial<Node>, \"key\" | \"label\">;\r\n\r\n/**\r\n * Serialized [[PartialNode]] JSON representation.\r\n * @public\r\n */\r\nexport type PartialNodeJSON = AllOrNone<Partial<NodeJSON>, \"key\" | \"labelDefinition\">;\r\n\r\ntype AllOrNone<T, P extends keyof T> = Omit<T, P> & ({ [K in P]?: never } | Required<Pick<T, P>>);\r\n\r\n/** @public */\r\nexport namespace Node {\r\n  /** Serialize given [[Node]] to JSON */\r\n  export function toJSON(node: Node): NodeJSON {\r\n    const { key, label, ...baseNode } = node;\r\n    return {\r\n      ...baseNode,\r\n      key: NodeKey.toJSON(key),\r\n      labelDefinition: LabelDefinition.toJSON(label),\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  export function toPartialJSON(node: PartialNode): PartialNodeJSON {\r\n    if (node.key === undefined) {\r\n      return node;\r\n    }\r\n\r\n    const { key, label, ...baseNode } = node;\r\n    return {\r\n      ...baseNode,\r\n      key: NodeKey.toJSON(key),\r\n      labelDefinition: LabelDefinition.toJSON(label),\r\n    };\r\n  }\r\n\r\n  /** Deserialize [[Node]] from JSON */\r\n  export function fromJSON(json: NodeJSON | string): Node {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, reviver);\r\n    const { labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      key: NodeKey.fromJSON(json.key),\r\n      label: LabelDefinition.fromJSON(labelDefinition),\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  export function fromPartialJSON(json: PartialNodeJSON): PartialNode {\r\n    if (json.key === undefined) {\r\n      return json;\r\n    }\r\n\r\n    const { key, labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      key: NodeKey.fromJSON(key),\r\n      label: LabelDefinition.fromJSON(labelDefinition),\r\n    };\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 [[Node]] objects.\r\n   *\r\n   * @internal\r\n   */\r\n  export function reviver(key: string, value: any): any {\r\n    return key === \"\" ? fromJSON(value) : value;\r\n  }\r\n\r\n  /**\r\n   * Deserialize nodes list from JSON\r\n   * @param json JSON or JSON serialized to string to deserialize from\r\n   * @returns Deserialized nodes list\r\n   *\r\n   * @internal\r\n   */\r\n  export function listFromJSON(json: NodeJSON[] | string): Node[] {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, listReviver);\r\n    return json.map((m) => fromJSON(m));\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 [[Node]][] objects.\r\n   *\r\n   * @internal\r\n   */\r\n  export function listReviver(key: string, value: any): any {\r\n    return key === \"\" ? listFromJSON(value) : value;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"Node.js","sourceRoot":"","sources":["../../../../src/presentation-common/hierarchy/Node.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAuB,MAAM,oBAAoB,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAe,MAAM,OAAO,CAAC;AA2G7C,cAAc;AACd,MAAM,KAAW,IAAI,CAmFpB;AAnFD,WAAiB,IAAI;IACnB,uCAAuC;IACvC,SAAgB,MAAM,CAAC,IAAU;QAC/B,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACzC,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;YACxB,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC;SAC/C,CAAC;IACJ,CAAC;IAPe,WAAM,SAOrB,CAAA;IAED,gBAAgB;IAChB,SAAgB,aAAa,CAAC,IAAiB;QAC7C,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACzC,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC;YACxB,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC;SAC/C,CAAC;IACJ,CAAC;IAXe,kBAAa,gBAW5B,CAAA;IAED,qCAAqC;IACrC,SAAgB,QAAQ,CAAC,IAAuB;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QAC9C,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;YAC/B,KAAK,EAAE,eAAe,CAAC,QAAQ,CAAC,eAAe,CAAC;SACjD,CAAC;IACJ,CAAC;IATe,aAAQ,WASvB,CAAA;IAED,gBAAgB;IAChB,SAAgB,eAAe,CAAC,IAAqB;QACnD,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,MAAM,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;QACnD,OAAO;YACL,GAAG,QAAQ;YACX,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC;YAC1B,KAAK,EAAE,eAAe,CAAC,QAAQ,CAAC,eAAe,CAAC;SACjD,CAAC;IACJ,CAAC;IAXe,oBAAe,kBAW9B,CAAA;IAED;;;;;OAKG;IACH,SAAgB,OAAO,CAAC,GAAW,EAAE,KAAU;QAC7C,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAC9C,CAAC;IAFe,YAAO,UAEtB,CAAA;IAED;;;;;;OAMG;IACH,SAAgB,YAAY,CAAC,IAAyB;QACpD,IAAI,OAAO,IAAI,KAAK,QAAQ;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IAJe,iBAAY,eAI3B,CAAA;IAED;;;;;OAKG;IACH,SAAgB,WAAW,CAAC,GAAW,EAAE,KAAU;QACjD,OAAO,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAClD,CAAC;IAFe,gBAAW,cAE1B,CAAA;AACH,CAAC,EAnFgB,IAAI,KAAJ,IAAI,QAmFpB","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 Hierarchies\r\n */\r\n\r\nimport { LabelDefinition, LabelDefinitionJSON } from \"../LabelDefinition\";\r\nimport { NodeKey, NodeKeyJSON } from \"./Key\";\r\n\r\n/**\r\n * Data structure that describes a tree node.\r\n * @public\r\n */\r\nexport interface Node {\r\n  /** A key that uniquely identifies a node. */\r\n  key: NodeKey;\r\n  /** Definition of node display label */\r\n  label: LabelDefinition;\r\n  /** Extensive description */\r\n  description?: string;\r\n  /**\r\n   * Image ID\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  imageId?: string;\r\n  /**\r\n   * Foreground color\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  foreColor?: string;\r\n  /**\r\n   * Background color\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  backColor?: string;\r\n  /**\r\n   * Font style\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  fontStyle?: string;\r\n  /** Does this node have child nodes */\r\n  hasChildren?: boolean;\r\n  /** Is this node selectable */\r\n  isSelectionDisabled?: boolean;\r\n  /** Is this node editable */\r\n  isEditable?: boolean;\r\n  /** Is this node expanded */\r\n  isExpanded?: boolean;\r\n  /**\r\n   * Is checkbox visible for this node\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isCheckboxVisible?: boolean;\r\n  /**\r\n   * Is this node's checkbox checked\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isChecked?: boolean;\r\n  /**\r\n   * Is this node's checkbox enabled\r\n   * @deprecated Use [[extendedData]] instead. See [extended data usage page]($docs/presentation/customization/ExtendedDataUsage.md) for more details.\r\n   */\r\n  isCheckboxEnabled?: boolean;\r\n  /** Extended data injected into this node */\r\n  extendedData?: {\r\n    [key: string]: any;\r\n  };\r\n}\r\n\r\n/**\r\n * Serialized [[Node]] JSON representation.\r\n * @public\r\n */\r\nexport interface NodeJSON {\r\n  key: NodeKeyJSON;\r\n  labelDefinition: LabelDefinitionJSON;\r\n  description?: string;\r\n  /** @deprecated */\r\n  imageId?: string;\r\n  /** @deprecated */\r\n  foreColor?: string;\r\n  /** @deprecated */\r\n  backColor?: string;\r\n  /** @deprecated */\r\n  fontStyle?: string;\r\n  hasChildren?: boolean;\r\n  isSelectionDisabled?: boolean;\r\n  isEditable?: boolean;\r\n  isExpanded?: boolean;\r\n  /** @deprecated */\r\n  isCheckboxVisible?: boolean;\r\n  /** @deprecated */\r\n  isChecked?: boolean;\r\n  /** @deprecated */\r\n  isCheckboxEnabled?: boolean;\r\n  extendedData?: {\r\n    [key: string]: any;\r\n  };\r\n}\r\n\r\n/**\r\n * Partial node definition.\r\n * @public\r\n */\r\nexport type PartialNode = AllOrNone<Partial<Node>, \"key\" | \"label\">;\r\n\r\n/**\r\n * Serialized [[PartialNode]] JSON representation.\r\n * @public\r\n */\r\nexport type PartialNodeJSON = AllOrNone<Partial<NodeJSON>, \"key\" | \"labelDefinition\">;\r\n\r\ntype AllOrNone<T, P extends keyof T> = Omit<T, P> & ({ [K in P]?: never } | Required<Pick<T, P>>);\r\n\r\n/** @public */\r\nexport namespace Node {\r\n  /** Serialize given [[Node]] to JSON */\r\n  export function toJSON(node: Node): NodeJSON {\r\n    const { key, label, ...baseNode } = node;\r\n    return {\r\n      ...baseNode,\r\n      key: NodeKey.toJSON(key),\r\n      labelDefinition: LabelDefinition.toJSON(label),\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  export function toPartialJSON(node: PartialNode): PartialNodeJSON {\r\n    if (node.key === undefined) {\r\n      return node;\r\n    }\r\n\r\n    const { key, label, ...baseNode } = node;\r\n    return {\r\n      ...baseNode,\r\n      key: NodeKey.toJSON(key),\r\n      labelDefinition: LabelDefinition.toJSON(label),\r\n    };\r\n  }\r\n\r\n  /** Deserialize [[Node]] from JSON */\r\n  export function fromJSON(json: NodeJSON | string): Node {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, reviver);\r\n    const { labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      key: NodeKey.fromJSON(json.key),\r\n      label: LabelDefinition.fromJSON(labelDefinition),\r\n    };\r\n  }\r\n\r\n  /** @internal */\r\n  export function fromPartialJSON(json: PartialNodeJSON): PartialNode {\r\n    if (json.key === undefined) {\r\n      return json;\r\n    }\r\n\r\n    const { key, labelDefinition, ...baseJson } = json;\r\n    return {\r\n      ...baseJson,\r\n      key: NodeKey.fromJSON(key),\r\n      label: LabelDefinition.fromJSON(labelDefinition),\r\n    };\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 [[Node]] objects.\r\n   *\r\n   * @internal\r\n   */\r\n  export function reviver(key: string, value: any): any {\r\n    return key === \"\" ? fromJSON(value) : value;\r\n  }\r\n\r\n  /**\r\n   * Deserialize nodes list from JSON\r\n   * @param json JSON or JSON serialized to string to deserialize from\r\n   * @returns Deserialized nodes list\r\n   *\r\n   * @internal\r\n   */\r\n  export function listFromJSON(json: NodeJSON[] | string): Node[] {\r\n    if (typeof json === \"string\")\r\n      return JSON.parse(json, listReviver);\r\n    return json.map((m) => fromJSON(m));\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 [[Node]][] objects.\r\n   *\r\n   * @internal\r\n   */\r\n  export function listReviver(key: string, value: any): any {\r\n    return key === \"\" ? listFromJSON(value) : value;\r\n  }\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts

@@ -2,42 +2,44 @@
  * @module PresentationRules
  */
 /**
- * Specification for a single ECClass
+ * This specification is used to point to specific ECClass.
+ *
+ * @see [Single schema class specification reference documentation page]($docs/presentation/SingleSchemaClassSpecification.md)
  * @public
  */
 export interface SingleSchemaClassSpecification {
     /**
-     * Name of ECSchema
+     * Specifies name of the schema which contains the target class.
      *
      * @pattern ^[\w\d]+$
      */
     schemaName: string;
     /**
-     * Name of ECClass
+     * Specifies name of the target class.
      *
      * @pattern ^[\w\d]+$
      */
     className: string;
 }
 /**
- * Specification for multiple ECClasses that belong to
- * the same ECSchema.
+ * This specification lists ECClasses which should be targeted when creating content or hierarchy nodes.
  *
+ * @see [Multi schema classes specification reference documentation page]($docs/presentation/MultiSchemaClassesSpecification.md)
  * @public
  */
 export interface MultiSchemaClassesSpecification {
     /**
-     * Name of ECSchema
+     * Specifies the schema which contains the target classes.
      *
      * @pattern ^[\w\d]+$
      */
     schemaName: string;
     /**
-     * List of ECClass names.
+     * An array of target ECClass names.
      */
     classNames: string[];
     /**
-     * Should all classes specified in [[classNames]] array be handled polymorphically.
+     * Defines whether the derived ECClasses should be included in the result.
      */
     arePolymorphic?: boolean;
 }

package/lib/esm/presentation-common/rules/ClassSpecifications.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ClassSpecifications.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/ClassSpecifications.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B"}
+{"version":3,"file":"ClassSpecifications.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/ClassSpecifications.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;GAKG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;;;;GAKG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B"}

package/lib/esm/presentation-common/rules/ClassSpecifications.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClassSpecifications.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/ClassSpecifications.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\n/**\r\n * Specification for a single ECClass\r\n * @public\r\n */\r\nexport interface SingleSchemaClassSpecification {\r\n  /**\r\n   * Name of ECSchema\r\n   *\r\n   * @pattern ^[\\w\\d]+$\r\n   */\r\n  schemaName: string;\r\n\r\n  /**\r\n   * Name of ECClass\r\n   *\r\n   * @pattern ^[\\w\\d]+$\r\n   */\r\n  className: string;\r\n}\r\n\r\n/**\r\n * Specification for multiple ECClasses that belong to\r\n * the same ECSchema.\r\n *\r\n * @public\r\n */\r\nexport interface MultiSchemaClassesSpecification {\r\n  /**\r\n   * Name of ECSchema\r\n   *\r\n   * @pattern ^[\\w\\d]+$\r\n   */\r\n  schemaName: string;\r\n\r\n  /**\r\n   * List of ECClass names.\r\n   */\r\n  classNames: string[];\r\n\r\n  /**\r\n   * Should all classes specified in [[classNames]] array be handled polymorphically.\r\n   */\r\n  arePolymorphic?: boolean;\r\n}\r\n"]}
+{"version":3,"file":"ClassSpecifications.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/ClassSpecifications.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\n/**\r\n * This specification is used to point to specific ECClass.\r\n *\r\n * @see [Single schema class specification reference documentation page]($docs/presentation/SingleSchemaClassSpecification.md)\r\n * @public\r\n */\r\nexport interface SingleSchemaClassSpecification {\r\n  /**\r\n   * Specifies name of the schema which contains the target class.\r\n   *\r\n   * @pattern ^[\\w\\d]+$\r\n   */\r\n  schemaName: string;\r\n\r\n  /**\r\n   * Specifies name of the target class.\r\n   *\r\n   * @pattern ^[\\w\\d]+$\r\n   */\r\n  className: string;\r\n}\r\n\r\n/**\r\n * This specification lists ECClasses which should be targeted when creating content or hierarchy nodes.\r\n *\r\n * @see [Multi schema classes specification reference documentation page]($docs/presentation/MultiSchemaClassesSpecification.md)\r\n * @public\r\n */\r\nexport interface MultiSchemaClassesSpecification {\r\n  /**\r\n   * Specifies the schema which contains the target classes.\r\n   *\r\n   * @pattern ^[\\w\\d]+$\r\n   */\r\n  schemaName: string;\r\n\r\n  /**\r\n   * An array of target ECClass names.\r\n   */\r\n  classNames: string[];\r\n\r\n  /**\r\n   * Defines whether the derived ECClasses should be included in the result.\r\n   */\r\n  arePolymorphic?: boolean;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts

@@ -3,81 +3,29 @@
  */
 import { RelationshipPathSpecification } from "./RelationshipPathSpecification";
 /**
- * This sub-specification allows joining the primary node instance with any number of related instances and creating
- * hierarchies based on a mix of those related instances.
+ * Related instance specification is used in [content]($docs/presentation/content/ContentRule.md#attribute-specifications)
+ * and [hierarchy]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications) specifications to "join" the
+ * primary instance with its related instance and allow using the related instance for filtering, customization and grouping.
  *
- * The related instance property values can be accessed from multiple different places:
- * - Instance filter
- * - Customization rule value
- * - Grouping rule
- *
- * **Example:**
- * ```JSON
- * {
- *   "id": "related_instance_example",
- *   "rules": [{
- *     "ruleType": "LabelOverride",
- *     "condition": "ThisNode.IsInstanceNode ANDALSO this.IsOfClass(\"Model\", \"BisCore\")",
- *     "label": "modeledElement.UserLabel"
- *   }, {
- *     "ruleType": "Grouping",
- *     "condition": "ParentNode.IsNull",
- *     "class": {
- *       "schemaName": "BisCore",
- *       "className": "Element"
- *     },
- *     "groups": [{
- *       "specType": "Property",
- *       "propertyName": "CodeValue",
- *       "createGroupForSingleItem": true
- *     }]
- *   }, {
- *     "ruleType": "RootNodes",
- *     "specifications": [{
- *       "specType": "InstanceNodesOfSpecificClasses",
- *       "classes": { "schemaName": "BisCore", "classNames": ["GeometricModel"] },
- *       "arePolymorphic": true,
- *       "instanceFilter": "modeledElement.CodeNamespace = 1",
- *       "relatedInstances": [{
- *         "relationshipPath": [{
- *           "relationship": { "schemaName": "BisCore", "className": "ModelModelsElement" },
- *           "direction": "Forward",
- *         }],
- *         "class": { "schemaName": "BisCore", "className": "Element" },
- *         "alias": "modeledElement"
- *       }]
- *     }]
- *   }]
- * }
- * ```
- * Here `BisCore:GeometricModel` instances are joined with `BisCore:Element` instances to create the hierarchy. This allows:
- * - Related `BisCore:Element` properties to be accessed in `InstanceFilter` using `modeledElement` alias.
- * - The `LabelOverride` rule to use `modeledElement` alias to access properties of the joined related instance.
- * - The `GroupingRule` to be applied because it's grouping `BisCore:Element` which is now part of the generated nodes.
- *
- * @see [More details]($docs/presentation/RelatedInstanceSpecification.md)
+ * @see [Related instance specification reference documentation page]($docs/presentation/RelatedInstanceSpecification.md)
  * @public
  */
 export interface RelatedInstanceSpecification {
     /**
-     * Relationship path to find the related instance.
+     * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md)
+     * that forms a path from the primary instance to the related instances.
      */
     relationshipPath: RelationshipPathSpecification;
     /**
-     * The alias to give for the joined related instance. Used to reference the related instance in
-     * instance filter and customization rules.
-     *
-     * **The value must be unique per-specification!**
+     * Specifies an an alias that given to the related instance. The alias can be used to reference the
+     * instance in instance filter and customization rules.
      *
      * @pattern ^\w[\w\d]*$
      */
     alias: string;
     /**
-     * Is the related instance required to exist. If yes, primary instance won't be returned
-     * if the related instance doesn't exist. If not, primary instance will be returned, but related
-     * instance will be null.
-     *
-     * In SQL terms in can be compared to INNER JOIN vs OUTER JOIN.
+     * Specifies whether to omit the primary instance from the result if the other end of [[relationshipPath]]
+     * does not yield any related instances.
      */
     isRequired?: boolean;
 }

package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RelatedInstanceSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,gBAAgB,EAAE,6BAA6B,CAAC;IAEhD;;;;;;;OAOG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}
+{"version":3,"file":"RelatedInstanceSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAEhF;;;;;;;GAOG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,gBAAgB,EAAE,6BAA6B,CAAC;IAEhD;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}

package/lib/esm/presentation-common/rules/RelatedInstanceSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelatedInstanceSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { RelationshipPathSpecification } from \"./RelationshipPathSpecification\";\r\n\r\n/**\r\n * This sub-specification allows joining the primary node instance with any number of related instances and creating\r\n * hierarchies based on a mix of those related instances.\r\n *\r\n * The related instance property values can be accessed from multiple different places:\r\n * - Instance filter\r\n * - Customization rule value\r\n * - Grouping rule\r\n *\r\n * **Example:**\r\n * ```JSON\r\n * {\r\n *   \"id\": \"related_instance_example\",\r\n *   \"rules\": [{\r\n *     \"ruleType\": \"LabelOverride\",\r\n *     \"condition\": \"ThisNode.IsInstanceNode ANDALSO this.IsOfClass(\\\"Model\\\", \\\"BisCore\\\")\",\r\n *     \"label\": \"modeledElement.UserLabel\"\r\n *   }, {\r\n *     \"ruleType\": \"Grouping\",\r\n *     \"condition\": \"ParentNode.IsNull\",\r\n *     \"class\": {\r\n *       \"schemaName\": \"BisCore\",\r\n *       \"className\": \"Element\"\r\n *     },\r\n *     \"groups\": [{\r\n *       \"specType\": \"Property\",\r\n *       \"propertyName\": \"CodeValue\",\r\n *       \"createGroupForSingleItem\": true\r\n *     }]\r\n *   }, {\r\n *     \"ruleType\": \"RootNodes\",\r\n *     \"specifications\": [{\r\n *       \"specType\": \"InstanceNodesOfSpecificClasses\",\r\n *       \"classes\": { \"schemaName\": \"BisCore\", \"classNames\": [\"GeometricModel\"] },\r\n *       \"arePolymorphic\": true,\r\n *       \"instanceFilter\": \"modeledElement.CodeNamespace = 1\",\r\n *       \"relatedInstances\": [{\r\n *         \"relationshipPath\": [{\r\n *           \"relationship\": { \"schemaName\": \"BisCore\", \"className\": \"ModelModelsElement\" },\r\n *           \"direction\": \"Forward\",\r\n *         }],\r\n *         \"class\": { \"schemaName\": \"BisCore\", \"className\": \"Element\" },\r\n *         \"alias\": \"modeledElement\"\r\n *       }]\r\n *     }]\r\n *   }]\r\n * }\r\n * ```\r\n * Here `BisCore:GeometricModel` instances are joined with `BisCore:Element` instances to create the hierarchy. This allows:\r\n * - Related `BisCore:Element` properties to be accessed in `InstanceFilter` using `modeledElement` alias.\r\n * - The `LabelOverride` rule to use `modeledElement` alias to access properties of the joined related instance.\r\n * - The `GroupingRule` to be applied because it's grouping `BisCore:Element` which is now part of the generated nodes.\r\n *\r\n * @see [More details]($docs/presentation/RelatedInstanceSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedInstanceSpecification {\r\n  /**\r\n   * Relationship path to find the related instance.\r\n   */\r\n  relationshipPath: RelationshipPathSpecification;\r\n\r\n  /**\r\n   * The alias to give for the joined related instance. Used to reference the related instance in\r\n   * instance filter and customization rules.\r\n   *\r\n   * **The value must be unique per-specification!**\r\n   *\r\n   * @pattern ^\\w[\\w\\d]*$\r\n   */\r\n  alias: string;\r\n\r\n  /**\r\n   * Is the related instance required to exist. If yes, primary instance won't be returned\r\n   * if the related instance doesn't exist. If not, primary instance will be returned, but related\r\n   * instance will be null.\r\n   *\r\n   * In SQL terms in can be compared to INNER JOIN vs OUTER JOIN.\r\n   */\r\n  isRequired?: boolean;\r\n}\r\n"]}
+{"version":3,"file":"RelatedInstanceSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelatedInstanceSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { RelationshipPathSpecification } from \"./RelationshipPathSpecification\";\r\n\r\n/**\r\n * Related instance specification is used in [content]($docs/presentation/content/ContentRule.md#attribute-specifications)\r\n * and [hierarchy]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-specifications) specifications to \"join\" the\r\n * primary instance with its related instance and allow using the related instance for filtering, customization and grouping.\r\n *\r\n * @see [Related instance specification reference documentation page]($docs/presentation/RelatedInstanceSpecification.md)\r\n * @public\r\n */\r\nexport interface RelatedInstanceSpecification {\r\n  /**\r\n   * Specifies a chain of [relationship path specifications]($docs/presentation/RelationshipPathSpecification.md)\r\n   * that forms a path from the primary instance to the related instances.\r\n   */\r\n  relationshipPath: RelationshipPathSpecification;\r\n\r\n  /**\r\n   * Specifies an an alias that given to the related instance. The alias can be used to reference the\r\n   * instance in instance filter and customization rules.\r\n   *\r\n   * @pattern ^\\w[\\w\\d]*$\r\n   */\r\n  alias: string;\r\n\r\n  /**\r\n   * Specifies whether to omit the primary instance from the result if the other end of [[relationshipPath]]\r\n   * does not yield any related instances.\r\n   */\r\n  isRequired?: boolean;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts

@@ -4,43 +4,50 @@
 import { SingleSchemaClassSpecification } from "./ClassSpecifications";
 import { RelationshipDirection } from "./RelationshipDirection";
 /**
- * Specification of a single relationship path step.
+ * Specification of a single step in [[RelationshipPathSpecification]].
+ *
+ * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)
  * @public
  */
 export interface RelationshipStepSpecification {
-    /** Specification of the relationship to use for joining the related instance. */
+    /** This attribute specifies the ECRelationship that should be used to traverse to target class. */
     relationship: SingleSchemaClassSpecification;
-    /** Relationship direction that should be followed to find the target class. */
+    /** This attribute specifies the direction in which the [[relationship]] should be followed. */
     direction: RelationshipDirection.Forward | RelationshipDirection.Backward;
     /**
-     * Specification of the target class. Either relationship's source or target class is used (based
-     * on specified direction) if more specific target class is not specified by this attribute.
+     * This attribute may be used to specialize the target of the relationship.
      */
     targetClass?: SingleSchemaClassSpecification;
 }
 /**
- * Specification of a single relationship path step.
+ * Specification of a single step in [[RepeatableRelationshipPathSpecification]].
+ *
+ * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)
  * @public
  */
 export interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {
     /**
-     * Number of relationship steps that should be taken. Special `*` value means that
-     * relationship is traversed recursively and all matching instances are accumulated.
-     * Defaults to `1`.
+     * When a number is specified, the relationship is traversed recursively the specified number of times.
+     *
+     * When it is set to a special value `"*"`, the same relationship is traversed recursively unbounded number
+     * of times, starting from zero (the relationship is not followed). On each traversal iteration, Presentation
+     * rules engine accumulates all indirectly related ECInstances as defined by the remaining relationship path.
      */
     count?: number | "*";
 }
 /**
- * Specification of a relationship path.
+ * Relationship path specification is used to define a relationship path to an ECClass.
  *
- * @see [More details]($docs/presentation/RelationshipPathSpecification.md)
+ * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)
  * @public
  */
 export declare type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];
 /**
- * Specification of a repeatable relationship path.
+ * This specification declares a step in a relationship path between a source and target ECInstances. A step
+ * can optionally be repeated a number of times to traverse the same relationship recursively. Multiple
+ * specifications of this type can be chained together to express complex indirect relationships.
  *
- * @see [More details]($docs/presentation/RepeatableRelationshipPathSpecification.md)
+ * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)
  * @public
  */
 export declare type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];

package/lib/esm/presentation-common/rules/RelationshipPathSpecification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RelationshipPathSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;GAGG;AACH,MAAM,WAAW,6BAA6B;IAC5C,iFAAiF;IACjF,YAAY,EAAE,8BAA8B,CAAC;IAE7C,+EAA+E;IAC/E,SAAS,EAAE,qBAAqB,CAAC,OAAO,GAAG,qBAAqB,CAAC,QAAQ,CAAC;IAE1E;;;OAGG;IACH,WAAW,CAAC,EAAE,8BAA8B,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,uCAAwC,SAAQ,6BAA6B;IAC5F;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;;;;GAKG;AACH,oBAAY,6BAA6B,GAAG,6BAA6B,GAAG,6BAA6B,EAAE,CAAC;AAE5G;;;;;GAKG;AACH,oBAAY,uCAAuC,GAAG,uCAAuC,GAAG,uCAAuC,EAAE,CAAC"}
+{"version":3,"file":"RelationshipPathSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,8BAA8B,EAAE,MAAM,uBAAuB,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B;IAC5C,mGAAmG;IACnG,YAAY,EAAE,8BAA8B,CAAC;IAE7C,+FAA+F;IAC/F,SAAS,EAAE,qBAAqB,CAAC,OAAO,GAAG,qBAAqB,CAAC,QAAQ,CAAC;IAE1E;;OAEG;IACH,WAAW,CAAC,EAAE,8BAA8B,CAAC;CAC9C;AAED;;;;;GAKG;AACH,MAAM,WAAW,uCAAwC,SAAQ,6BAA6B;IAC5F;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB;AAED;;;;;GAKG;AACH,oBAAY,6BAA6B,GAAG,6BAA6B,GAAG,6BAA6B,EAAE,CAAC;AAE5G;;;;;;;GAOG;AACH,oBAAY,uCAAuC,GAAG,uCAAuC,GAAG,uCAAuC,EAAE,CAAC"}

package/lib/esm/presentation-common/rules/RelationshipPathSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n  /** Specification of the relationship to use for joining the related instance. */\r\n  relationship: SingleSchemaClassSpecification;\r\n\r\n  /** Relationship direction that should be followed to find the target class. */\r\n  direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n  /**\r\n   * Specification of the target class. Either relationship's source or target class is used (based\r\n   * on specified direction) if more specific target class is not specified by this attribute.\r\n   */\r\n  targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single relationship path step.\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n  /**\r\n   * Number of relationship steps that should be taken. Special `*` value means that\r\n   * relationship is traversed recursively and all matching instances are accumulated.\r\n   * Defaults to `1`.\r\n   */\r\n  count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Specification of a relationship path.\r\n *\r\n * @see [More details]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];\r\n\r\n/**\r\n * Specification of a repeatable relationship path.\r\n *\r\n * @see [More details]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];\r\n"]}
+{"version":3,"file":"RelationshipPathSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/RelationshipPathSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { SingleSchemaClassSpecification } from \"./ClassSpecifications\";\r\nimport { RelationshipDirection } from \"./RelationshipDirection\";\r\n\r\n/**\r\n * Specification of a single step in [[RelationshipPathSpecification]].\r\n *\r\n * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport interface RelationshipStepSpecification {\r\n  /** This attribute specifies the ECRelationship that should be used to traverse to target class. */\r\n  relationship: SingleSchemaClassSpecification;\r\n\r\n  /** This attribute specifies the direction in which the [[relationship]] should be followed. */\r\n  direction: RelationshipDirection.Forward | RelationshipDirection.Backward;\r\n\r\n  /**\r\n   * This attribute may be used to specialize the target of the relationship.\r\n   */\r\n  targetClass?: SingleSchemaClassSpecification;\r\n}\r\n\r\n/**\r\n * Specification of a single step in [[RepeatableRelationshipPathSpecification]].\r\n *\r\n * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport interface RepeatableRelationshipStepSpecification extends RelationshipStepSpecification {\r\n  /**\r\n   * When a number is specified, the relationship is traversed recursively the specified number of times.\r\n   *\r\n   * When it is set to a special value `\"*\"`, the same relationship is traversed recursively unbounded number\r\n   * of times, starting from zero (the relationship is not followed). On each traversal iteration, Presentation\r\n   * rules engine accumulates all indirectly related ECInstances as defined by the remaining relationship path.\r\n   */\r\n  count?: number | \"*\";\r\n}\r\n\r\n/**\r\n * Relationship path specification is used to define a relationship path to an ECClass.\r\n *\r\n * @see [Relationship path specification reference documentation page]($docs/presentation/RelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RelationshipPathSpecification = RelationshipStepSpecification | RelationshipStepSpecification[];\r\n\r\n/**\r\n * This specification declares a step in a relationship path between a source and target ECInstances. A step\r\n * can optionally be repeated a number of times to traverse the same relationship recursively. Multiple\r\n * specifications of this type can be chained together to express complex indirect relationships.\r\n *\r\n * @see [Repeatable relationship path specification reference documentation page]($docs/presentation/RepeatableRelationshipPathSpecification.md)\r\n * @public\r\n */\r\nexport type RepeatableRelationshipPathSpecification = RepeatableRelationshipStepSpecification | RepeatableRelationshipStepSpecification[];\r\n"]}

package/lib/esm/presentation-common/rules/Rule.d.ts

@@ -8,47 +8,46 @@ import { CustomizationRule } from "./customization/CustomizationRule";
 import { NavigationRule } from "./hierarchy/NavigationRule";
 import { RequiredSchemaSpecification } from "./SchemasSpecification";
 /**
- * Base interface for all [[Rule]] implementations. Not meant
- * to be used directly, see `Rule`.
- *
+ * Base interface for all [[Rule]] implementations.
  * @public
  */
 export interface RuleBase {
     /** Used for serializing to JSON. */
     ruleType: RuleTypes;
     /**
-     * Defines the order in which presentation rules will be evaluated and executed. Defaults to `1000`.
+     * Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are
+     * equal, the rules are handled in the order they're defined.
      *
      * @type integer
      */
     priority?: number;
     /**
-     * Should this rule should be ignored if there is already an existing
-     * rule with a higher priority.
+     * Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule
+     * priorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.
      */
     onlyIfNotHandled?: boolean;
     /**
-     * Schema requirements for this rule. The rule is not used if the requirements are not met.
+     * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.
      * @beta
      */
     requiredSchemas?: RequiredSchemaSpecification[];
 }
 /**
- * Presentation rules allow configuring the hierarchy and content.
+ * A union of all presentation rule types.
  * @public
  */
 export declare type Rule = CustomizationRule | NavigationRule | ContentRule | ContentModifier | DefaultPropertyCategoryOverride;
 /**
  * Container of a [[condition]] property. Used for rules that support conditions. Not
- * meant to be used directly, see `Rule`.
+ * meant to be used directly, see [[Rule]].
  *
+ * @deprecated This interface is not used anymore. All interfaces that used to extend it, have the [[condition]]
+ * attribute of their own.
  * @public
  */
 export interface ConditionContainer {
     /**
-     * Defines a condition for the rule, which needs to be met in order to execute it. Condition
-     * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use
-     * a limited set of symbols (depends on specific `ConditionContainer`).
+     * Defines a condition for the rule, which needs to be met in order to execute it.
      */
     condition?: string;
 }

package/lib/esm/presentation-common/rules/Rule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Rule.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Rule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,+BAA+B,EAAE,MAAM,2CAA2C,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAErE;;;;;GAKG;AACH,MAAM,WAAW,QAAQ;IACvB,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC;IAEpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,2BAA2B,EAAE,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,IAAI,GAAG,iBAAiB,GAAG,cAAc,GAAG,WAAW,GAAG,eAAe,GAAG,+BAA+B,CAAC;AAEhI;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,SAAS;IAEnB,SAAS,cAAc;IACvB,UAAU,eAAe;IAGzB,OAAO,YAAY;IACnB,eAAe,oBAAoB;IACnC,+BAA+B,oCAAoC;IAGnE,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,qBAAqB,0BAA0B;IAC/C,aAAa,kBAAkB;IAC/B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,YAAY,iBAAiB;CAC9B"}
+{"version":3,"file":"Rule.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Rule.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,+BAA+B,EAAE,MAAM,2CAA2C,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAErE;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,oCAAoC;IACpC,QAAQ,EAAE,SAAS,CAAC;IAEpB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,eAAe,CAAC,EAAE,2BAA2B,EAAE,CAAC;CACjD;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,MAAM,IAAI,GAAG,iBAAiB,GAAG,cAAc,GAAG,WAAW,GAAG,eAAe,GAAG,+BAA+B,CAAC;AAEhI;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,oBAAY,SAAS;IAEnB,SAAS,cAAc;IACvB,UAAU,eAAe;IAGzB,OAAO,YAAY;IACnB,eAAe,oBAAoB;IACnC,+BAA+B,oCAAoC;IAGnE,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,qBAAqB,0BAA0B;IAC/C,aAAa,kBAAkB;IAC/B,QAAQ,aAAa;IACrB,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B,YAAY,iBAAiB;CAC9B"}

package/lib/esm/presentation-common/rules/Rule.js.map

@@ -1 +1 @@
-{"version":3,"file":"Rule.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Rule.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA4DH;;;GAGG;AACH,MAAM,CAAN,IAAY,SAqBX;AArBD,WAAY,SAAS;IACnB,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,sCAAyB,CAAA;IAEzB,gBAAgB;IAChB,gCAAmB,CAAA;IACnB,gDAAmC,CAAA;IACnC,gFAAmE,CAAA;IAEnE,sBAAsB;IACtB,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,gDAAmC,CAAA;IACnC,4CAA+B,CAAA;IAC/B,4DAA+C,CAAA;IAC/C,4CAA+B,CAAA;IAC/B,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,4CAA+B,CAAA;IAC/B,0CAA6B,CAAA;AAC/B,CAAC,EArBW,SAAS,KAAT,SAAS,QAqBpB","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 PresentationRules\r\n */\r\n\r\nimport { ContentRule } from \"./content/ContentRule\";\r\nimport { DefaultPropertyCategoryOverride } from \"./content/DefaultPropertyCategoryOverride\";\r\nimport { ContentModifier } from \"./content/modifiers/ContentModifier\";\r\nimport { CustomizationRule } from \"./customization/CustomizationRule\";\r\nimport { NavigationRule } from \"./hierarchy/NavigationRule\";\r\nimport { RequiredSchemaSpecification } from \"./SchemasSpecification\";\r\n\r\n/**\r\n * Base interface for all [[Rule]] implementations. Not meant\r\n * to be used directly, see `Rule`.\r\n *\r\n * @public\r\n */\r\nexport interface RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes;\r\n\r\n  /**\r\n   * Defines the order in which presentation rules will be evaluated and executed. Defaults to `1000`.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Should this rule should be ignored if there is already an existing\r\n   * rule with a higher priority.\r\n   */\r\n  onlyIfNotHandled?: boolean;\r\n\r\n  /**\r\n   * Schema requirements for this rule. The rule is not used if the requirements are not met.\r\n   * @beta\r\n   */\r\n  requiredSchemas?: RequiredSchemaSpecification[];\r\n}\r\n\r\n/**\r\n * Presentation rules allow configuring the hierarchy and content.\r\n * @public\r\n */\r\nexport declare type Rule = CustomizationRule | NavigationRule | ContentRule | ContentModifier | DefaultPropertyCategoryOverride;\r\n\r\n/**\r\n * Container of a [[condition]] property. Used for rules that support conditions. Not\r\n * meant to be used directly, see `Rule`.\r\n *\r\n * @public\r\n */\r\nexport interface ConditionContainer {\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order to execute it. Condition\r\n   * is an [ECExpression]($docs/presentation/Advanced/ECExpressions.md), which can use\r\n   * a limited set of symbols (depends on specific `ConditionContainer`).\r\n   */\r\n  condition?: string;\r\n}\r\n\r\n/**\r\n * Used for serializing [[Rule]] objects to JSON.\r\n * @public\r\n */\r\nexport enum RuleTypes {\r\n  // hierarchy rules\r\n  RootNodes = \"RootNodes\",\r\n  ChildNodes = \"ChildNodes\",\r\n\r\n  // content rules\r\n  Content = \"Content\",\r\n  ContentModifier = \"ContentModifier\", // eslint-disable-line @typescript-eslint/no-shadow\r\n  DefaultPropertyCategoryOverride = \"DefaultPropertyCategoryOverride\", // eslint-disable-line @typescript-eslint/no-shadow\r\n\r\n  // customization rules\r\n  Grouping = \"Grouping\",\r\n  PropertySorting = \"PropertySorting\",\r\n  DisabledSorting = \"DisabledSorting\",\r\n  NodeArtifacts = \"NodeArtifacts\",\r\n  InstanceLabelOverride = \"InstanceLabelOverride\",\r\n  LabelOverride = \"LabelOverride\",\r\n  CheckBox = \"CheckBox\",\r\n  ImageIdOverride = \"ImageIdOverride\",\r\n  StyleOverride = \"StyleOverride\",\r\n  ExtendedData = \"ExtendedData\",\r\n}\r\n"]}
+{"version":3,"file":"Rule.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Rule.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA2DH;;;GAGG;AACH,MAAM,CAAN,IAAY,SAqBX;AArBD,WAAY,SAAS;IACnB,kBAAkB;IAClB,oCAAuB,CAAA;IACvB,sCAAyB,CAAA;IAEzB,gBAAgB;IAChB,gCAAmB,CAAA;IACnB,gDAAmC,CAAA;IACnC,gFAAmE,CAAA;IAEnE,sBAAsB;IACtB,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,gDAAmC,CAAA;IACnC,4CAA+B,CAAA;IAC/B,4DAA+C,CAAA;IAC/C,4CAA+B,CAAA;IAC/B,kCAAqB,CAAA;IACrB,gDAAmC,CAAA;IACnC,4CAA+B,CAAA;IAC/B,0CAA6B,CAAA;AAC/B,CAAC,EArBW,SAAS,KAAT,SAAS,QAqBpB","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 PresentationRules\r\n */\r\n\r\nimport { ContentRule } from \"./content/ContentRule\";\r\nimport { DefaultPropertyCategoryOverride } from \"./content/DefaultPropertyCategoryOverride\";\r\nimport { ContentModifier } from \"./content/modifiers/ContentModifier\";\r\nimport { CustomizationRule } from \"./customization/CustomizationRule\";\r\nimport { NavigationRule } from \"./hierarchy/NavigationRule\";\r\nimport { RequiredSchemaSpecification } from \"./SchemasSpecification\";\r\n\r\n/**\r\n * Base interface for all [[Rule]] implementations.\r\n * @public\r\n */\r\nexport interface RuleBase {\r\n  /** Used for serializing to JSON. */\r\n  ruleType: RuleTypes;\r\n\r\n  /**\r\n   * Defines the order in which rules are handled, higher number means the rule is handled first. If priorities are\r\n   * equal, the rules are handled in the order they're defined.\r\n   *\r\n   * @type integer\r\n   */\r\n  priority?: number;\r\n\r\n  /**\r\n   * Tells the library that the rule should only be handled if no other rule of the same type was handled previously (based on rule\r\n   * priorities and definition order). This allows adding fallback rules which can be overriden by higher-priority rules.\r\n   */\r\n  onlyIfNotHandled?: boolean;\r\n\r\n  /**\r\n   * A list of [ECSchema requirements]($docs/presentation/RequiredSchemaSpecification.md) that need to be met for the rule to be used.\r\n   * @beta\r\n   */\r\n  requiredSchemas?: RequiredSchemaSpecification[];\r\n}\r\n\r\n/**\r\n * A union of all presentation rule types.\r\n * @public\r\n */\r\nexport declare type Rule = CustomizationRule | NavigationRule | ContentRule | ContentModifier | DefaultPropertyCategoryOverride;\r\n\r\n/**\r\n * Container of a [[condition]] property. Used for rules that support conditions. Not\r\n * meant to be used directly, see [[Rule]].\r\n *\r\n * @deprecated This interface is not used anymore. All interfaces that used to extend it, have the [[condition]]\r\n * attribute of their own.\r\n * @public\r\n */\r\nexport interface ConditionContainer {\r\n  /**\r\n   * Defines a condition for the rule, which needs to be met in order to execute it.\r\n   */\r\n  condition?: string;\r\n}\r\n\r\n/**\r\n * Used for serializing [[Rule]] objects to JSON.\r\n * @public\r\n */\r\nexport enum RuleTypes {\r\n  // hierarchy rules\r\n  RootNodes = \"RootNodes\",\r\n  ChildNodes = \"ChildNodes\",\r\n\r\n  // content rules\r\n  Content = \"Content\",\r\n  ContentModifier = \"ContentModifier\", // eslint-disable-line @typescript-eslint/no-shadow\r\n  DefaultPropertyCategoryOverride = \"DefaultPropertyCategoryOverride\", // eslint-disable-line @typescript-eslint/no-shadow\r\n\r\n  // customization rules\r\n  Grouping = \"Grouping\",\r\n  PropertySorting = \"PropertySorting\",\r\n  DisabledSorting = \"DisabledSorting\",\r\n  NodeArtifacts = \"NodeArtifacts\",\r\n  InstanceLabelOverride = \"InstanceLabelOverride\",\r\n  LabelOverride = \"LabelOverride\",\r\n  CheckBox = \"CheckBox\",\r\n  ImageIdOverride = \"ImageIdOverride\",\r\n  StyleOverride = \"StyleOverride\",\r\n  ExtendedData = \"ExtendedData\",\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/Ruleset.d.ts

@@ -6,15 +6,16 @@ import { RequiredSchemaSpecification } from "./SchemasSpecification";
 import { VariablesGroup } from "./Variables";
 /**
  * Presentation ruleset is a list of rules that define tree hierarchy and content provided by
- * the presentation manager. The ruleset consists of:
+ * the presentation library. The ruleset consists of:
  * - Ruleset options
- * - Navigation rules:
+ * - Hierarchy rules:
  *   - Root node rules
  *   - Child node rules
- * - Content rules for content you see in content controls
+ * - Content rules for content you see in content controls like property grid and table.
  * - Customization rules used for additional customizations such as styling, labeling, checkboxes, etc.
  * - User-controllable variables.
  *
+ * @see [Presentation library documentation page]($docs/presentation/index.md)
  * @public
  */
 export interface Ruleset {
@@ -30,7 +31,7 @@ export interface Ruleset {
      * Setting the version is optional, but might be useful when ruleset is persisted
      * somewhere and evolves over time. Having a version helps choose persisting
      * strategy (keep all versions or only latest) and find the latest ruleset from a list
-     * of ruleset with the same id.
+     * of rulesets with the same id.
      *
      * Defaults to `0.0.0`.
      *
@@ -52,7 +53,7 @@ export interface Ruleset {
 }
 /**
  * Contains supplementation-related information for
- * [supplemental rulesets]($docs/presentation/Advanced/RulesetSupplementation.md).
+ * [supplemental rulesets]($docs/presentation/advanced/RulesetSupplementation.md).
  *
  * @public
  */

package/lib/esm/presentation-common/rules/Ruleset.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Ruleset.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Ruleset.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,OAAO;IACtB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,eAAe,CAAC,EAAE,2BAA2B,EAAE,CAAC;IAEhD,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C,6CAA6C;IAC7C,IAAI,CAAC,EAAE,cAAc,EAAE,CAAC;IAExB,gEAAgE;IAChE,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC"}
+{"version":3,"file":"Ruleset.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Ruleset.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,OAAO;IACtB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,eAAe,CAAC,EAAE,2BAA2B,EAAE,CAAC;IAEhD,2DAA2D;IAC3D,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAE1C,6CAA6C;IAC7C,IAAI,CAAC,EAAE,cAAc,EAAE,CAAC;IAExB,gEAAgE;IAChE,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,sBAAsB,EAAE,MAAM,CAAC;CAChC"}

package/lib/esm/presentation-common/rules/Ruleset.js.map

@@ -1 +1 @@
-{"version":3,"file":"Ruleset.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Ruleset.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { Rule } from \"./Rule\";\r\nimport { RequiredSchemaSpecification } from \"./SchemasSpecification\";\r\nimport { VariablesGroup } from \"./Variables\";\r\n\r\n/**\r\n * Presentation ruleset is a list of rules that define tree hierarchy and content provided by\r\n * the presentation manager. The ruleset consists of:\r\n * - Ruleset options\r\n * - Navigation rules:\r\n *   - Root node rules\r\n *   - Child node rules\r\n * - Content rules for content you see in content controls\r\n * - Customization rules used for additional customizations such as styling, labeling, checkboxes, etc.\r\n * - User-controllable variables.\r\n *\r\n * @public\r\n */\r\nexport interface Ruleset {\r\n  /**\r\n   * Ruleset identifier. This ID is used to bind UI components with the specific rule set.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  id: string;\r\n\r\n  /**\r\n   * Version of the presentation ruleset in SemVer format: `{major}.{minor}.{patch}`.\r\n   *\r\n   * Setting the version is optional, but might be useful when ruleset is persisted\r\n   * somewhere and evolves over time. Having a version helps choose persisting\r\n   * strategy (keep all versions or only latest) and find the latest ruleset from a list\r\n   * of ruleset with the same id.\r\n   *\r\n   * Defaults to `0.0.0`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   * @beta\r\n   */\r\n  version?: string;\r\n\r\n  /**\r\n   * Schema requirements for this ruleset. The ruleset is not used if the requirements are not met.\r\n   * @beta\r\n   */\r\n  requiredSchemas?: RequiredSchemaSpecification[];\r\n\r\n  /** Supplementation-related information for this ruleset */\r\n  supplementationInfo?: SupplementationInfo;\r\n\r\n  /** User-controllable variable definitions */\r\n  vars?: VariablesGroup[];\r\n\r\n  /** Presentation rules used to create hierarchies and content */\r\n  rules: Rule[];\r\n}\r\n\r\n/**\r\n * Contains supplementation-related information for\r\n * [supplemental rulesets]($docs/presentation/Advanced/RulesetSupplementation.md).\r\n *\r\n * @public\r\n */\r\nexport interface SupplementationInfo {\r\n  /**\r\n   * Identifies why supplementation is done and uniquely identifies particular supplemental ruleset.\r\n   * There can be only one supplemental rule set with the same [[Ruleset.id]] and [[supplementationPurpose]].\r\n   */\r\n  supplementationPurpose: string;\r\n}\r\n"]}
+{"version":3,"file":"Ruleset.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Ruleset.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\nimport { Rule } from \"./Rule\";\r\nimport { RequiredSchemaSpecification } from \"./SchemasSpecification\";\r\nimport { VariablesGroup } from \"./Variables\";\r\n\r\n/**\r\n * Presentation ruleset is a list of rules that define tree hierarchy and content provided by\r\n * the presentation library. The ruleset consists of:\r\n * - Ruleset options\r\n * - Hierarchy rules:\r\n *   - Root node rules\r\n *   - Child node rules\r\n * - Content rules for content you see in content controls like property grid and table.\r\n * - Customization rules used for additional customizations such as styling, labeling, checkboxes, etc.\r\n * - User-controllable variables.\r\n *\r\n * @see [Presentation library documentation page]($docs/presentation/index.md)\r\n * @public\r\n */\r\nexport interface Ruleset {\r\n  /**\r\n   * Ruleset identifier. This ID is used to bind UI components with the specific rule set.\r\n   *\r\n   * @minLength 1\r\n   */\r\n  id: string;\r\n\r\n  /**\r\n   * Version of the presentation ruleset in SemVer format: `{major}.{minor}.{patch}`.\r\n   *\r\n   * Setting the version is optional, but might be useful when ruleset is persisted\r\n   * somewhere and evolves over time. Having a version helps choose persisting\r\n   * strategy (keep all versions or only latest) and find the latest ruleset from a list\r\n   * of rulesets with the same id.\r\n   *\r\n   * Defaults to `0.0.0`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   * @beta\r\n   */\r\n  version?: string;\r\n\r\n  /**\r\n   * Schema requirements for this ruleset. The ruleset is not used if the requirements are not met.\r\n   * @beta\r\n   */\r\n  requiredSchemas?: RequiredSchemaSpecification[];\r\n\r\n  /** Supplementation-related information for this ruleset */\r\n  supplementationInfo?: SupplementationInfo;\r\n\r\n  /** User-controllable variable definitions */\r\n  vars?: VariablesGroup[];\r\n\r\n  /** Presentation rules used to create hierarchies and content */\r\n  rules: Rule[];\r\n}\r\n\r\n/**\r\n * Contains supplementation-related information for\r\n * [supplemental rulesets]($docs/presentation/advanced/RulesetSupplementation.md).\r\n *\r\n * @public\r\n */\r\nexport interface SupplementationInfo {\r\n  /**\r\n   * Identifies why supplementation is done and uniquely identifies particular supplemental ruleset.\r\n   * There can be only one supplemental rule set with the same [[Ruleset.id]] and [[supplementationPurpose]].\r\n   */\r\n  supplementationPurpose: string;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts

@@ -15,11 +15,14 @@ export interface SchemasSpecification {
     isExclude?: boolean;
 }
 /**
- * A specification for a schema requirement.
+ * This specification is designed for specifying schema requirements for the [[Ruleset]] or specific
+ * presentation rules.
+ *
+ * @see [Required schema specification reference documentation page]($docs/presentation/RequiredSchemaSpecification.md)
  * @beta
  */
 export interface RequiredSchemaSpecification {
-    /** ECSchema name */
+    /** Specifies the schema to whom the requirement is being set. */
     name: string;
     /**
      * Minimum required schema version (inclusive).

package/lib/esm/presentation-common/rules/SchemasSpecification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SchemasSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/SchemasSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,qBAAqB;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC1C,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}
+{"version":3,"file":"SchemasSpecification.d.ts","sourceRoot":"","sources":["../../../../src/presentation-common/rules/SchemasSpecification.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,qBAAqB;IACrB,WAAW,EAAE,MAAM,EAAE,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,2BAA2B;IAC1C,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAC;IAEb;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB"}

package/lib/esm/presentation-common/rules/SchemasSpecification.js.map

@@ -1 +1 @@
-{"version":3,"file":"SchemasSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/SchemasSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\n/**\r\n * Specification for a list of ECSchemas\r\n * @public\r\n */\r\nexport interface SchemasSpecification {\r\n  /** ECSchema names */\r\n  schemaNames: string[];\r\n\r\n  /**\r\n   * Should schemas specified in [[schemaNames]] be excluded rather than included.\r\n   * Exclusion works by including everything except what's specified in [[schemaNames]].\r\n   */\r\n  isExclude?: boolean;\r\n}\r\n\r\n/**\r\n * A specification for a schema requirement.\r\n * @beta\r\n */\r\nexport interface RequiredSchemaSpecification {\r\n  /** ECSchema name */\r\n  name: string;\r\n\r\n  /**\r\n   * Minimum required schema version (inclusive).\r\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   */\r\n  minVersion?: string;\r\n\r\n  /**\r\n   * Maximum allowed schema version (exclusive).\r\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   */\r\n  maxVersion?: string;\r\n}\r\n"]}
+{"version":3,"file":"SchemasSpecification.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/SchemasSpecification.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 PresentationRules\r\n */\r\n\r\n/**\r\n * Specification for a list of ECSchemas\r\n * @public\r\n */\r\nexport interface SchemasSpecification {\r\n  /** ECSchema names */\r\n  schemaNames: string[];\r\n\r\n  /**\r\n   * Should schemas specified in [[schemaNames]] be excluded rather than included.\r\n   * Exclusion works by including everything except what's specified in [[schemaNames]].\r\n   */\r\n  isExclude?: boolean;\r\n}\r\n\r\n/**\r\n * This specification is designed for specifying schema requirements for the [[Ruleset]] or specific\r\n * presentation rules.\r\n *\r\n * @see [Required schema specification reference documentation page]($docs/presentation/RequiredSchemaSpecification.md)\r\n * @beta\r\n */\r\nexport interface RequiredSchemaSpecification {\r\n  /** Specifies the schema to whom the requirement is being set. */\r\n  name: string;\r\n\r\n  /**\r\n   * Minimum required schema version (inclusive).\r\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   */\r\n  minVersion?: string;\r\n\r\n  /**\r\n   * Maximum allowed schema version (exclusive).\r\n   * Format: `{read version}.{write version}.{minor version}`, e.g. `2.1.15`.\r\n   *\r\n   * @pattern ^[\\d]+\\.[\\d]+\\.[\\d]+$\r\n   */\r\n  maxVersion?: string;\r\n}\r\n"]}

package/lib/esm/presentation-common/rules/Variables.d.ts

@@ -5,7 +5,7 @@
  * Presentation rules support variables that allow having additional customization of the hierarchy
  * and content based on variables whose values can change during application session.
  *
- * There are [special ECExpression symbols]($docs/presentation/Advanced/ECExpressions.md#ruleset-variables-user-settings)
+ * There are [special ECExpression symbols]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings)
  * that can be used to access variables by their ID, so rule conditions can check for a value and change
  * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.
  *
@@ -14,7 +14,7 @@
 export interface VariablesGroup {
     /**
      * Group label to display in the UI.
-     * May be [localized]($docs/presentation/Advanced/Localization.md).
+     * May be [localized]($docs/presentation/advanced/Localization.md).
      */
     label: string;
     /** Grouped variables */
@@ -45,7 +45,7 @@ export interface Variable {
     id: string;
     /**
      * Label of the variable that is shown in the UI.
-     * May be [localized]($docs/presentation/Advanced/Localization.md).
+     * May be [localized]($docs/presentation/advanced/Localization.md).
      */
     label: string;
     /** Defines value type. Defaults to [[VariableValueType.YesNo]]. */

package/lib/esm/presentation-common/rules/Variables.js.map

@@ -1 +1 @@
-{"version":3,"file":"Variables.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Variables.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA0BH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,uDAAuD;IACvD,oCAAe,CAAA;IAEf,0DAA0D;IAC1D,0CAAqB,CAAA;IAErB,uBAAuB;IACvB,2CAAsB,CAAA;IAEtB,wBAAwB;IACxB,qCAAgB,CAAA;AAClB,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B","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 PresentationRules\r\n */\r\n\r\n/**\r\n * Presentation rules support variables that allow having additional customization of the hierarchy\r\n * and content based on variables whose values can change during application session.\r\n *\r\n * There are [special ECExpression symbols]($docs/presentation/Advanced/ECExpressions.md#ruleset-variables-user-settings)\r\n * that can be used to access variables by their ID, so rule conditions can check for a value and change\r\n * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.\r\n *\r\n * @public\r\n */\r\nexport interface VariablesGroup {\r\n  /**\r\n   * Group label to display in the UI.\r\n   * May be [localized]($docs/presentation/Advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /** Grouped variables */\r\n  vars: Variable[];\r\n\r\n  /** Nested variable groups. */\r\n  nestedGroups?: VariablesGroup[];\r\n}\r\n\r\n/**\r\n * Available value types of user-controllable variables\r\n * @public\r\n */\r\nexport enum VariableValueType {\r\n  /** Bool value, that uses Yes / No strings in the UI */\r\n  YesNo = \"YesNo\",\r\n\r\n  /** Bool value, that uses Show / Hide strings in the UI */\r\n  ShowHide = \"ShowHide\",\r\n\r\n  /** Any string value */\r\n  String = \"StringValue\",\r\n\r\n  /** Any integer value */\r\n  Int = \"IntValue\",\r\n}\r\n\r\n/**\r\n * Definition for single user-controllable variable\r\n * @public\r\n */\r\nexport interface Variable {\r\n  /** Id of the variable */\r\n  id: string;\r\n\r\n  /**\r\n   * Label of the variable that is shown in the UI.\r\n   * May be [localized]($docs/presentation/Advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /** Defines value type. Defaults to [[VariableValueType.YesNo]]. */\r\n  type?: VariableValueType;\r\n\r\n  /** Default value. */\r\n  defaultValue?: string;\r\n}\r\n"]}
+{"version":3,"file":"Variables.js","sourceRoot":"","sources":["../../../../src/presentation-common/rules/Variables.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AA0BH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAYX;AAZD,WAAY,iBAAiB;IAC3B,uDAAuD;IACvD,oCAAe,CAAA;IAEf,0DAA0D;IAC1D,0CAAqB,CAAA;IAErB,uBAAuB;IACvB,2CAAsB,CAAA;IAEtB,wBAAwB;IACxB,qCAAgB,CAAA;AAClB,CAAC,EAZW,iBAAiB,KAAjB,iBAAiB,QAY5B","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 PresentationRules\r\n */\r\n\r\n/**\r\n * Presentation rules support variables that allow having additional customization of the hierarchy\r\n * and content based on variables whose values can change during application session.\r\n *\r\n * There are [special ECExpression symbols]($docs/presentation/advanced/ECExpressions.md#ruleset-variables-user-settings)\r\n * that can be used to access variables by their ID, so rule conditions can check for a value and change\r\n * the behavior. It allows showing / hiding some nodes in the hierarchy, change the grouping, etc.\r\n *\r\n * @public\r\n */\r\nexport interface VariablesGroup {\r\n  /**\r\n   * Group label to display in the UI.\r\n   * May be [localized]($docs/presentation/advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /** Grouped variables */\r\n  vars: Variable[];\r\n\r\n  /** Nested variable groups. */\r\n  nestedGroups?: VariablesGroup[];\r\n}\r\n\r\n/**\r\n * Available value types of user-controllable variables\r\n * @public\r\n */\r\nexport enum VariableValueType {\r\n  /** Bool value, that uses Yes / No strings in the UI */\r\n  YesNo = \"YesNo\",\r\n\r\n  /** Bool value, that uses Show / Hide strings in the UI */\r\n  ShowHide = \"ShowHide\",\r\n\r\n  /** Any string value */\r\n  String = \"StringValue\",\r\n\r\n  /** Any integer value */\r\n  Int = \"IntValue\",\r\n}\r\n\r\n/**\r\n * Definition for single user-controllable variable\r\n * @public\r\n */\r\nexport interface Variable {\r\n  /** Id of the variable */\r\n  id: string;\r\n\r\n  /**\r\n   * Label of the variable that is shown in the UI.\r\n   * May be [localized]($docs/presentation/advanced/Localization.md).\r\n   */\r\n  label: string;\r\n\r\n  /** Defines value type. Defaults to [[VariableValueType.YesNo]]. */\r\n  type?: VariableValueType;\r\n\r\n  /** Default value. */\r\n  defaultValue?: string;\r\n}\r\n"]}