@itwin/presentation-backend 3.5.0-dev.8 → 3.5.1

package/lib/cjs/presentation-backend/PresentationManager.d.ts

@@ -1,402 +1,437 @@
-/** @packageDocumentation
- * @module Core
- */
-import { IModelDb } from "@itwin/core-backend";
-import { Id64String } from "@itwin/core-bentley";
-import { FormatProps, UnitSystemKey } from "@itwin/core-quantity";
-import { ComputeSelectionRequestOptions, Content, ContentDescriptorRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, Descriptor, DescriptorOverrides, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DisplayValueGroup, DistinctValuesRequestOptions, ElementProperties, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyCompareInfo, HierarchyCompareOptions, HierarchyRequestOptions, InstanceKey, KeySet, LabelDefinition, MultiElementPropertiesRequestOptions, Node, NodeKey, NodePathElement, Paged, PagedResponse, Prioritized, Ruleset, RulesetVariable, SelectClassInfo, SelectionScope, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions, WithCancelEvent } from "@itwin/presentation-common";
-import { NativePlatformDefinition } from "./NativePlatform";
-import { PresentationManagerDetail } from "./PresentationManagerDetail";
-import { RulesetManager } from "./RulesetManager";
-import { RulesetVariablesManager } from "./RulesetVariablesManager";
-import { BackendDiagnosticsAttribute, BackendDiagnosticsOptions } from "./Utils";
-/**
- * Presentation manager working mode.
- * @public
- */
-export declare enum PresentationManagerMode {
-    /**
-     * Presentation manager assumes iModels are opened in read-only mode and avoids doing some work
-     * related to reacting to changes in iModels.
-     */
-    ReadOnly = 0,
-    /**
-     * Presentation manager assumes iModels are opened in read-write mode and it may need to
-     * react to changes. This involves some additional work and gives slightly worse performance.
-     */
-    ReadWrite = 1
-}
-/**
- * Presentation hierarchy cache mode.
- * @beta
- */
-export declare enum HierarchyCacheMode {
-    /**
-     * Hierarchy cache is created in memory.
-     */
-    Memory = "memory",
-    /**
-     * Hierarchy cache is created on disk. In this mode hierarchy cache is persisted between iModel
-     * openings.
-     */
-    Disk = "disk",
-    /**
-     * Hierarchy cache is created on disk. In this mode everything is cached in memory while creating hierarchy level
-     * and persisted in disk cache when whole hierarchy level is created.
-     */
-    Hybrid = "hybrid"
-}
-/**
- * Configuration for hierarchy cache.
- * @beta
- */
-export declare type HierarchyCacheConfig = MemoryHierarchyCacheConfig | DiskHierarchyCacheConfig | HybridCacheConfig;
-/**
- * Base interface for all [[HierarchyCacheConfig]] implementations.
- * @beta
- */
-export interface HierarchyCacheConfigBase {
-    mode: HierarchyCacheMode;
-}
-/**
- * Configuration for in-memory hierarchy cache.
- * @beta
- */
-export interface MemoryHierarchyCacheConfig extends HierarchyCacheConfigBase {
-    mode: HierarchyCacheMode.Memory;
-}
-/**
- * Configuration for persistent disk hierarchy cache.
- * @beta
- */
-export interface DiskHierarchyCacheConfig extends HierarchyCacheConfigBase {
-    mode: HierarchyCacheMode.Disk;
-    /**
-     * A directory for Presentation hierarchy cache. If set, the directory must exist.
-     *
-     * The default directory depends on the iModel and the way it's opened.
-     */
-    directory?: string;
-}
-/**
- * Configuration for the experimental hybrid hierarchy cache.
- *
- * Hybrid cache uses a combination of in-memory and disk caches, which should make it a better
- * alternative for cases when there are lots of simultaneous requests.
- *
- * @beta
- */
-export interface HybridCacheConfig extends HierarchyCacheConfigBase {
-    mode: HierarchyCacheMode.Hybrid;
-    /** Configuration for disk cache used to persist hierarchies. */
-    disk?: DiskHierarchyCacheConfig;
-}
-/**
- * Configuration for content cache.
- * @public
- */
-export interface ContentCacheConfig {
-    /**
-     * Maximum number of content descriptors cached in memory for quicker paged content requests.
-     *
-     * Defaults to `100`.
-     *
-     * @alpha
-     */
-    size?: number;
-}
-/**
- * A data structure that associates unit systems with a format. The associations are used for
- * assigning default unit formats for specific phenomenons (see [[PresentationManagerProps.defaultFormats]]).
- *
- * @public
- */
-export interface UnitSystemFormat {
-    unitSystems: UnitSystemKey[];
-    format: FormatProps;
-}
-/**
- * Data structure for multiple element properties request response.
- * @alpha
- */
-export interface MultiElementPropertiesResponse {
-    total: number;
-    iterator: () => AsyncGenerator<ElementProperties[]>;
-}
-/**
- * Properties that can be used to configure [[PresentationManager]]
- * @public
- */
-export interface PresentationManagerProps {
-    /**
-     * Path overrides for presentation assets. Need to be overriden by application if it puts these assets someplace else than the default.
-     *
-     * By default paths to asset directories are determined during the call of [[Presentation.initialize]] using this algorithm:
-     *
-     * - for `presentation-backend` assets:
-     *
-     *   - if path of `.js` file that contains [[PresentationManager]] definition contains "presentation-backend", assume the package is in `node_modules` and the directory structure is:
-     *     - `assets/*\*\/*`
-     *     - `presentation-backend/{presentation-backend source files}`
-     *
-     *     which means the assets can be found through a relative path `../assets/` from the JS file being executed.
-     *
-     * - for `presentation-common` assets:
-     *
-     *   - if path of `.js` files of `presentation-common` package contain "presentation-common", assume the package is in `node_modules` and the directory structure is:
-     *     - `assets/*\*\/*`
-     *     - `presentation-common/{presentation-common source files}`
-     *
-     *     which means the assets can be found through a relative path `../assets/` from the package's source files.
-     *
-     * - in both cases, if we determine that source files are not in `node_modules`, assume the backend is webpacked into a single file with assets next to it:
-     *   - `assets/*\*\/*`
-     *   - `{source file being executed}.js`
-     *
-     *   which means the assets can be found through a relative path `./assets/` from the `{source file being executed}`.
-     *
-     * The overrides can be specified as a single path (when assets of both `presentation-backend` and `presentation-common` packages are merged into a single directory) or as an object with two separate paths for each package.
-     */
-    presentationAssetsRoot?: string | {
-        /** Path to `presentation-backend` assets */
-        backend: string;
-        /** Path to `presentation-common` assets */
-        common: string;
-    };
-    /**
-     * A list of directories containing application's presentation rulesets.
-     */
-    rulesetDirectories?: string[];
-    /**
-     * A list of directories containing application's supplemental presentation rulesets.
-     */
-    supplementalRulesetDirectories?: string[];
-    /**
-     * A list of directories containing application's locale-specific localized
-     * string files (in simplified i18next v3 format)
-     *
-     * @deprecated Use [[getLocalizedString]] to localize data returned by [[PresentationManager]].
-     */
-    localeDirectories?: string[];
-    /**
-     * Sets the active locale to use when localizing presentation-related
-     * strings. It can later be changed through [[PresentationManager.activeLocale]].
-     *
-     * @deprecated Use [[getLocalizedString]] to localize data returned by [[PresentationManager]].
-     */
-    defaultLocale?: string;
-    /**
-     * Sets the active unit system to use for formatting property values with
-     * units. Default presentation units are used if this is not specified. The active unit
-     * system can later be changed through [[PresentationManager.activeUnitSystem]] or overriden for each request
-     * through request options.
-     */
-    defaultUnitSystem?: UnitSystemKey;
-    /**
-     * A map of default unit formats to use for formatting properties that don't have a presentation format
-     * in requested unit system.
-     */
-    defaultFormats?: {
-        [phenomenon: string]: UnitSystemFormat;
-    };
-    /**
-     * Should schemas preloading be enabled. If true, presentation manager listens
-     * for `BriefcaseDb.onOpened` event and force pre-loads all ECSchemas.
-     *
-     * @deprecated Use [[PresentationPropsBase.enableSchemasPreload]] instead.
-     */
-    enableSchemasPreload?: boolean;
-    /**
-     * A number of worker threads to use for handling presentation requests. Defaults to `2`.
-     */
-    workerThreadsCount?: number;
-    /**
-     * Presentation manager working mode. Backends that use iModels in read-write mode should
-     * use `ReadWrite`, others might want to set to `ReadOnly` for better performance.
-     *
-     * Defaults to [[PresentationManagerMode.ReadWrite]].
-     */
-    mode?: PresentationManagerMode;
-    /**
-     * The interval (in milliseconds) used to poll for presentation data changes. Only has
-     * effect in read-write mode (see [[mode]]).
-     *
-     * @alpha
-     */
-    updatesPollInterval?: number;
-    /** Options for caching. */
-    caching?: {
-        /**
-         * Hierarchies-related caching options.
-         * @beta
-         */
-        hierarchies?: HierarchyCacheConfig;
-        /** Content-related caching options. */
-        content?: ContentCacheConfig;
-    };
-    /**
-     * Use [SQLite's Memory-Mapped I/O](https://sqlite.org/mmap.html) for worker connections. This mode improves performance of handling
-     * requests with high I/O intensity, e.g. filtering large tables on non-indexed columns. No downsides have been noticed.
-     *
-     * Set to a falsy value to turn off. `true` for memory-mapping the whole iModel. Number value for memory-mapping the specified amount of bytes.
-     *
-     * @alpha
-     */
-    useMmap?: boolean | number;
-    /**
-     * An identifier which helps separate multiple presentation managers. It's
-     * mostly useful in tests where multiple presentation managers can co-exist
-     * and try to share the same resources, which we don't want. With this identifier
-     * set, managers put their resources into id-named subdirectories.
-     *
-     * @internal
-     */
-    id?: string;
-    /** @internal */
-    addon?: NativePlatformDefinition;
-    /**
-     * Localization function when only backend is used.
-     * @beta
-    */
-    getLocalizedString?: (key: string) => string;
-    /**
-     * Parameters for gathering diagnostics at the manager level. When supplied, they're used with every request
-     * made through the manager.
-     *
-     * @see [Diagnostics documentation page]($docs/presentation/advanced/Diagnostics.md)
-     * @beta
-     */
-    diagnostics?: BackendDiagnosticsOptions;
-}
-/**
- * Backend Presentation manager which pulls the presentation data from
- * an iModel using native platform.
- *
- * @public
- */
-export declare class PresentationManager {
-    private _props;
-    private _detail;
-    private _localizationHelper;
-    /**
-     * Get / set active locale used for localizing presentation data
-     * @deprecated Use [[getLocalizedString]] to localize data returned by [[PresentationManager]].
-     */
-    activeLocale: string | undefined;
-    /**
-     * Creates an instance of PresentationManager.
-     * @param props Optional configuration properties.
-     */
-    constructor(props?: PresentationManagerProps);
-    /** Get / set active unit system used to format property values with units */
-    get activeUnitSystem(): UnitSystemKey | undefined;
-    set activeUnitSystem(value: UnitSystemKey | undefined);
-    /** Dispose the presentation manager. Must be called to clean up native resources. */
-    dispose(): void;
-    /** @internal */
-    setOnManagerUsedHandler(handler: () => void): void;
-    /** Properties used to initialize the manager */
-    get props(): PresentationManagerProps;
-    /** Get rulesets manager */
-    rulesets(): RulesetManager;
-    /**
-     * Get ruleset variables manager for specific ruleset
-     * @param rulesetId Id of the ruleset to get variables manager for
-     */
-    vars(rulesetId: string): RulesetVariablesManager;
-    /** @internal */
-    getNativePlatform: () => NativePlatformDefinition;
-    /** @internal */
-    getDetail(): PresentationManagerDetail;
-    /** @internal */
-    getRulesetId(rulesetOrId: Ruleset | string): string;
-    /**
-     * Retrieves nodes
-     * @public
-     */
-    getNodes(requestOptions: WithCancelEvent<Prioritized<Paged<HierarchyRequestOptions<IModelDb, NodeKey, RulesetVariable>>>> & BackendDiagnosticsAttribute): Promise<Node[]>;
-    /**
-     * Retrieves nodes count
-     * @public
-     */
-    getNodesCount(requestOptions: WithCancelEvent<Prioritized<HierarchyRequestOptions<IModelDb, NodeKey, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<number>;
-    /**
-     * Retrieves paths from root nodes to children nodes according to specified instance key paths. Intersecting paths will be merged.
-     * TODO: Return results in pages
-     * @public
-     */
-    getNodePaths(requestOptions: WithCancelEvent<Prioritized<FilterByInstancePathsHierarchyRequestOptions<IModelDb, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<NodePathElement[]>;
-    /**
-     * Retrieves paths from root nodes to nodes containing filter text in their label.
-     * TODO: Return results in pages
-     * @public
-     */
-    getFilteredNodePaths(requestOptions: WithCancelEvent<Prioritized<FilterByTextHierarchyRequestOptions<IModelDb, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<NodePathElement[]>;
-    /** @beta */
-    getContentSources(requestOptions: WithCancelEvent<Prioritized<ContentSourcesRequestOptions<IModelDb>>> & BackendDiagnosticsAttribute): Promise<SelectClassInfo[]>;
-    /**
-     * Retrieves the content descriptor which can be used to get content
-     * @public
-     */
-    getContentDescriptor(requestOptions: WithCancelEvent<Prioritized<ContentDescriptorRequestOptions<IModelDb, KeySet, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<Descriptor | undefined>;
-    /**
-     * Retrieves the content set size based on the supplied content descriptor override
-     * @public
-     */
-    getContentSetSize(requestOptions: WithCancelEvent<Prioritized<ContentRequestOptions<IModelDb, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<number>;
-    /**
-     * Retrieves the content based on the supplied content descriptor override.
-     * @public
-     */
-    getContent(requestOptions: WithCancelEvent<Prioritized<Paged<ContentRequestOptions<IModelDb, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>>>> & BackendDiagnosticsAttribute): Promise<Content | undefined>;
-    /**
-     * Retrieves distinct values of specific field from the content based on the supplied content descriptor override.
-     * @param requestOptions      Options for the request
-     * @return A promise object that returns either distinct values on success or an error string on error.
-     * @public
-     */
-    getPagedDistinctValues(requestOptions: WithCancelEvent<Prioritized<DistinctValuesRequestOptions<IModelDb, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroup>>;
-    /**
-     * Retrieves property data in a simplified format for a single element specified by ID.
-     * @beta
-     */
-    getElementProperties(requestOptions: WithCancelEvent<Prioritized<SingleElementPropertiesRequestOptions<IModelDb>>> & BackendDiagnosticsAttribute): Promise<ElementProperties | undefined>;
-    /**
-     * Retrieves property data in simplified format for multiple elements specified by class or all element.
-     * @return An object that contains element count and AsyncGenerator to iterate over properties of those elements in batches of undefined size.
-     * @alpha
-     */
-    getElementProperties(requestOptions: WithCancelEvent<Prioritized<MultiElementPropertiesRequestOptions<IModelDb>>> & BackendDiagnosticsAttribute): Promise<MultiElementPropertiesResponse>;
-    private getMultipleElementProperties;
-    /**
-     * Retrieves display label definition of specific item
-     * @public
-     */
-    getDisplayLabelDefinition(requestOptions: WithCancelEvent<Prioritized<DisplayLabelRequestOptions<IModelDb, InstanceKey>>> & BackendDiagnosticsAttribute): Promise<LabelDefinition>;
-    /**
-     * Retrieves display label definitions of specific items
-     * @public
-     */
-    getDisplayLabelDefinitions(requestOptions: WithCancelEvent<Prioritized<Paged<DisplayLabelsRequestOptions<IModelDb, InstanceKey>>>> & BackendDiagnosticsAttribute): Promise<LabelDefinition[]>;
-    /**
-     * Retrieves available selection scopes.
-     * @public
-     */
-    getSelectionScopes(_requestOptions: SelectionScopeRequestOptions<IModelDb> & BackendDiagnosticsAttribute): Promise<SelectionScope[]>;
-    /**
-     * Computes selection set based on provided selection scope.
-     * @public
-     */
-    computeSelection(requestOptions: SelectionScopeRequestOptions<IModelDb> & {
-        ids: Id64String[];
-        scopeId: string;
-    } & BackendDiagnosticsAttribute): Promise<KeySet>;
-    /** @alpha */
-    computeSelection(requestOptions: ComputeSelectionRequestOptions<IModelDb> & BackendDiagnosticsAttribute): Promise<KeySet>;
-    /**
-     * Compares two hierarchies specified in the request options
-     * @public
-     */
-    compareHierarchies(requestOptions: HierarchyCompareOptions<IModelDb, NodeKey>): Promise<HierarchyCompareInfo>;
-}
+/** @packageDocumentation
+ * @module Core
+ */
+import { IModelDb } from "@itwin/core-backend";
+import { Id64String } from "@itwin/core-bentley";
+import { FormatProps, UnitSystemKey } from "@itwin/core-quantity";
+import { ComputeSelectionRequestOptions, Content, ContentDescriptorRequestOptions, ContentRequestOptions, ContentSourcesRequestOptions, Descriptor, DescriptorOverrides, DisplayLabelRequestOptions, DisplayLabelsRequestOptions, DisplayValueGroup, DistinctValuesRequestOptions, ElementProperties, FilterByInstancePathsHierarchyRequestOptions, FilterByTextHierarchyRequestOptions, HierarchyCompareInfo, HierarchyCompareOptions, HierarchyRequestOptions, InstanceKey, KeySet, LabelDefinition, MultiElementPropertiesRequestOptions, Node, NodeKey, NodePathElement, Paged, PagedResponse, Prioritized, Ruleset, RulesetVariable, SelectClassInfo, SelectionScope, SelectionScopeRequestOptions, SingleElementPropertiesRequestOptions, WithCancelEvent } from "@itwin/presentation-common";
+import { NativePlatformDefinition } from "./NativePlatform";
+import { PresentationManagerDetail } from "./PresentationManagerDetail";
+import { RulesetManager } from "./RulesetManager";
+import { RulesetVariablesManager } from "./RulesetVariablesManager";
+import { BackendDiagnosticsAttribute, BackendDiagnosticsOptions } from "./Utils";
+/**
+ * Presentation manager working mode.
+ * @public
+ * @deprecated The attribute is not used by [[PresentationManager]] anymore
+ */
+export declare enum PresentationManagerMode {
+    /**
+     * Presentation manager assumes iModels are opened in read-only mode and avoids doing some work
+     * related to reacting to changes in iModels.
+     */
+    ReadOnly = 0,
+    /**
+     * Presentation manager assumes iModels are opened in read-write mode and it may need to
+     * react to changes. This involves some additional work and gives slightly worse performance.
+     */
+    ReadWrite = 1
+}
+/**
+ * Presentation hierarchy cache mode.
+ * @beta
+ */
+export declare enum HierarchyCacheMode {
+    /**
+     * Hierarchy cache is created in memory.
+     */
+    Memory = "memory",
+    /**
+     * Hierarchy cache is created on disk. In this mode hierarchy cache is persisted between iModel
+     * openings.
+     */
+    Disk = "disk",
+    /**
+     * Hierarchy cache is created on disk. In this mode everything is cached in memory while creating hierarchy level
+     * and persisted in disk cache when whole hierarchy level is created.
+     */
+    Hybrid = "hybrid"
+}
+/**
+ * Configuration for hierarchy cache.
+ * @beta
+ */
+export declare type HierarchyCacheConfig = MemoryHierarchyCacheConfig | DiskHierarchyCacheConfig | HybridCacheConfig;
+/**
+ * Base interface for all [[HierarchyCacheConfig]] implementations.
+ * @beta
+ */
+export interface HierarchyCacheConfigBase {
+    mode: HierarchyCacheMode;
+}
+/**
+ * Configuration for in-memory hierarchy cache.
+ *
+ * @see [Memory cache documentation page]($docs/presentation/advanced/Caching.md#memory-cache)
+ * @beta
+ */
+export interface MemoryHierarchyCacheConfig extends HierarchyCacheConfigBase {
+    mode: HierarchyCacheMode.Memory;
+}
+/**
+ * Configuration for persistent disk hierarchy cache.
+ *
+ * @see [Disk cache documentation page]($docs/presentation/advanced/Caching.md#disk-cache)
+ * @beta
+ */
+export interface DiskHierarchyCacheConfig extends HierarchyCacheConfigBase {
+    mode: HierarchyCacheMode.Disk;
+    /**
+     * A directory for Presentation hierarchy cache. If set, the directory must exist.
+     *
+     * The default directory depends on the iModel and the way it's opened.
+     */
+    directory?: string;
+    /**
+     * While the cache itself is stored on a disk, there's still a required small in-memory cache.
+     * The parameter allows controlling size of that cache. Defaults to `32768000` bytes (32 MB).
+     *
+     * @beta
+     */
+    memoryCacheSize?: number;
+}
+/**
+ * Configuration for the experimental hybrid hierarchy cache.
+ *
+ * Hybrid cache uses a combination of in-memory and disk caches, which should make it a better
+ * alternative for cases when there are lots of simultaneous requests.
+ *
+ * @see [Hybrid cache documentation page]($docs/presentation/advanced/Caching.md#hybrid-cache)
+ * @beta
+ */
+export interface HybridCacheConfig extends HierarchyCacheConfigBase {
+    mode: HierarchyCacheMode.Hybrid;
+    /** Configuration for disk cache used to persist hierarchies. */
+    disk?: DiskHierarchyCacheConfig;
+}
+/**
+ * Configuration for content cache.
+ *
+ * @see [Content cache documentation page]($docs/presentation/advanced/Caching.md#content-cache)
+ * @public
+ */
+export interface ContentCacheConfig {
+    /**
+     * Maximum number of content descriptors cached in memory for quicker paged content requests.
+     *
+     * Defaults to `100`.
+     *
+     * @beta
+     */
+    size?: number;
+}
+/**
+ * Caching configuration options for [[PresentationManager]].
+ * @public
+ */
+export interface PresentationManagerCachingConfig {
+    /**
+     * Hierarchies-related caching options.
+     *
+     * @see [Hierarchies cache documentation page]($docs/presentation/advanced/Caching.md#hierarchies-cache)
+     * @beta
+     */
+    hierarchies?: HierarchyCacheConfig;
+    /**
+     * Content-related caching options.
+     *
+     * @see [Content cache documentation page]($docs/presentation/advanced/Caching.md#content-cache)
+     */
+    content?: ContentCacheConfig;
+    /**
+     * Each worker thread (see [[workerThreadsCount]]) opens a connection to an iModel used for a request. This
+     * means there could be  `{workerThreadsCount} * {iModels count}` number of connections. Each connection
+     * uses a memory cache to increase iModel read performance. This parameter allows controlling the size of that
+     * cache. Defaults to `32768000` bytes (32 MB).
+     *
+     * @see [Worker connections cache documentation page]($docs/presentation/advanced/Caching.md#worker-connections-cache)
+     * @beta
+     */
+    workerConnectionCacheSize?: number;
+}
+/**
+ * A data structure that associates unit systems with a format. The associations are used for
+ * assigning default unit formats for specific phenomenons (see [[PresentationManagerProps.defaultFormats]]).
+ *
+ * @public
+ */
+export interface UnitSystemFormat {
+    unitSystems: UnitSystemKey[];
+    format: FormatProps;
+}
+/**
+ * Data structure for multiple element properties request response.
+ * @alpha
+ */
+export interface MultiElementPropertiesResponse {
+    total: number;
+    iterator: () => AsyncGenerator<ElementProperties[]>;
+}
+/**
+ * Configuration options for supplying asset directly paths to [[PresentationManager]].
+ * @public
+ */
+export interface PresentationAssetsRootConfig {
+    /** Path to `presentation-backend` assets */
+    backend: string;
+    /**
+     * Path to `presentation-common` assets.
+     *
+     * @deprecated This path is not used anymore
+     */
+    common: string;
+}
+/**
+ * Properties that can be used to configure [[PresentationManager]]
+ * @public
+ */
+export interface PresentationManagerProps {
+    /**
+     * Path overrides for presentation backend assets. Need to be overriden by application if it puts these assets someplace else than the default.
+     *
+     * By default the path to assets directory is determined during the call of [[Presentation.initialize]] using this algorithm:
+     *
+     * - if path of `.js` file that contains [[PresentationManager]] definition contains "presentation-backend", assume the package is in `node_modules` and the directory structure is:
+     *   - `assets/*\*\/*`
+     *   - `presentation-backend/{presentation-backend source files}`
+     *
+     *   which means the assets can be found through a relative path `../assets/` from the JS file being executed.
+     *
+     * - else, assume the backend is webpacked into a single file with assets next to it:
+     *   - `assets/*\*\/*`
+     *   - `{source file being executed}.js`
+     *
+     *   which means the assets can be found through a relative path `./assets/` from the `{source file being executed}`.
+     */
+    presentationAssetsRoot?: string | PresentationAssetsRootConfig;
+    /**
+     * A list of directories containing application's presentation rulesets.
+     */
+    rulesetDirectories?: string[];
+    /**
+     * A list of directories containing application's supplemental presentation rulesets.
+     */
+    supplementalRulesetDirectories?: string[];
+    /**
+     * A list of directories containing application's locale-specific localized
+     * string files (in simplified i18next v3 format)
+     *
+     * @deprecated Use [[getLocalizedString]] to localize data returned by [[PresentationManager]].
+     */
+    localeDirectories?: string[];
+    /**
+     * Sets the active locale to use when localizing presentation-related
+     * strings. It can later be changed through [[PresentationManager.activeLocale]].
+     *
+     * @deprecated Use [[getLocalizedString]] to localize data returned by [[PresentationManager]].
+     */
+    defaultLocale?: string;
+    /**
+     * Sets the active unit system to use for formatting property values with
+     * units. Default presentation units are used if this is not specified. The active unit
+     * system can later be changed through [[PresentationManager.activeUnitSystem]] or overriden for each request
+     * through request options.
+     */
+    defaultUnitSystem?: UnitSystemKey;
+    /**
+     * A map of default unit formats to use for formatting properties that don't have a presentation format
+     * in requested unit system.
+     */
+    defaultFormats?: {
+        [phenomenon: string]: UnitSystemFormat;
+    };
+    /**
+     * Should schemas preloading be enabled. If true, presentation manager listens
+     * for `BriefcaseDb.onOpened` event and force pre-loads all ECSchemas.
+     *
+     * @deprecated Use [[PresentationPropsBase.enableSchemasPreload]] instead.
+     */
+    enableSchemasPreload?: boolean;
+    /**
+     * A number of worker threads to use for handling presentation requests. Defaults to `2`.
+     */
+    workerThreadsCount?: number;
+    /**
+     * Presentation manager working mode. Backends that use iModels in read-write mode should
+     * use `ReadWrite`, others might want to set to `ReadOnly` for better performance.
+     *
+     * Defaults to [[PresentationManagerMode.ReadWrite]].
+     *
+     * @deprecated The attribute is not used by [[PresentationManager]] anymore
+     */
+    mode?: PresentationManagerMode;
+    /**
+     * The interval (in milliseconds) used to poll for presentation data changes. Only has
+     * effect in read-write mode (see [[mode]]).
+     *
+     * @alpha
+     */
+    updatesPollInterval?: number;
+    /** Options for caching. */
+    caching?: PresentationManagerCachingConfig;
+    /**
+     * Use [SQLite's Memory-Mapped I/O](https://sqlite.org/mmap.html) for worker connections. This mode improves performance of handling
+     * requests with high I/O intensity, e.g. filtering large tables on non-indexed columns. No downsides have been noticed.
+     *
+     * Set to a falsy value to turn off. `true` for memory-mapping the whole iModel. Number value for memory-mapping the specified amount of bytes.
+     *
+     * @alpha
+     */
+    useMmap?: boolean | number;
+    /**
+     * An identifier which helps separate multiple presentation managers. It's
+     * mostly useful in tests where multiple presentation managers can co-exist
+     * and try to share the same resources, which we don't want. With this identifier
+     * set, managers put their resources into id-named subdirectories.
+     *
+     * @internal
+     */
+    id?: string;
+    /** @internal */
+    addon?: NativePlatformDefinition;
+    /**
+     * Localization function when only backend is used.
+     * @beta
+    */
+    getLocalizedString?: (key: string) => string;
+    /**
+     * Parameters for gathering diagnostics at the manager level. When supplied, they're used with every request
+     * made through the manager.
+     *
+     * @see [Diagnostics documentation page]($docs/presentation/advanced/Diagnostics.md)
+     * @beta
+     */
+    diagnostics?: BackendDiagnosticsOptions;
+}
+/**
+ * Backend Presentation manager which pulls the presentation data from
+ * an iModel using native platform.
+ *
+ * @public
+ */
+export declare class PresentationManager {
+    private _props;
+    private _detail;
+    private _localizationHelper;
+    /**
+     * Get / set active locale used for localizing presentation data
+     * @deprecated Use [[getLocalizedString]] to localize data returned by [[PresentationManager]].
+     */
+    activeLocale: string | undefined;
+    /**
+     * Creates an instance of PresentationManager.
+     * @param props Optional configuration properties.
+     */
+    constructor(props?: PresentationManagerProps);
+    /** Get / set active unit system used to format property values with units */
+    get activeUnitSystem(): UnitSystemKey | undefined;
+    set activeUnitSystem(value: UnitSystemKey | undefined);
+    /** Dispose the presentation manager. Must be called to clean up native resources. */
+    dispose(): void;
+    /** @internal */
+    setOnManagerUsedHandler(handler: () => void): void;
+    /** Properties used to initialize the manager */
+    get props(): PresentationManagerProps;
+    /** Get rulesets manager */
+    rulesets(): RulesetManager;
+    /**
+     * Get ruleset variables manager for specific ruleset
+     * @param rulesetId Id of the ruleset to get variables manager for
+     */
+    vars(rulesetId: string): RulesetVariablesManager;
+    /** @internal */
+    getNativePlatform: () => NativePlatformDefinition;
+    /** @internal */
+    getDetail(): PresentationManagerDetail;
+    /** @internal */
+    getRulesetId(rulesetOrId: Ruleset | string): string;
+    /**
+     * Retrieves nodes
+     * @public
+     */
+    getNodes(requestOptions: WithCancelEvent<Prioritized<Paged<HierarchyRequestOptions<IModelDb, NodeKey, RulesetVariable>>>> & BackendDiagnosticsAttribute): Promise<Node[]>;
+    /**
+     * Retrieves nodes count
+     * @public
+     */
+    getNodesCount(requestOptions: WithCancelEvent<Prioritized<HierarchyRequestOptions<IModelDb, NodeKey, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<number>;
+    /**
+     * Retrieves paths from root nodes to children nodes according to specified instance key paths. Intersecting paths will be merged.
+     * TODO: Return results in pages
+     * @public
+     */
+    getNodePaths(requestOptions: WithCancelEvent<Prioritized<FilterByInstancePathsHierarchyRequestOptions<IModelDb, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<NodePathElement[]>;
+    /**
+     * Retrieves paths from root nodes to nodes containing filter text in their label.
+     * TODO: Return results in pages
+     * @public
+     */
+    getFilteredNodePaths(requestOptions: WithCancelEvent<Prioritized<FilterByTextHierarchyRequestOptions<IModelDb, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<NodePathElement[]>;
+    /** @beta */
+    getContentSources(requestOptions: WithCancelEvent<Prioritized<ContentSourcesRequestOptions<IModelDb>>> & BackendDiagnosticsAttribute): Promise<SelectClassInfo[]>;
+    /**
+     * Retrieves the content descriptor which can be used to get content
+     * @public
+     */
+    getContentDescriptor(requestOptions: WithCancelEvent<Prioritized<ContentDescriptorRequestOptions<IModelDb, KeySet, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<Descriptor | undefined>;
+    /**
+     * Retrieves the content set size based on the supplied content descriptor override
+     * @public
+     */
+    getContentSetSize(requestOptions: WithCancelEvent<Prioritized<ContentRequestOptions<IModelDb, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<number>;
+    /**
+     * Retrieves the content based on the supplied content descriptor override.
+     * @public
+     */
+    getContent(requestOptions: WithCancelEvent<Prioritized<Paged<ContentRequestOptions<IModelDb, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>>>> & BackendDiagnosticsAttribute): Promise<Content | undefined>;
+    /**
+     * Retrieves distinct values of specific field from the content based on the supplied content descriptor override.
+     * @param requestOptions      Options for the request
+     * @return A promise object that returns either distinct values on success or an error string on error.
+     * @public
+     */
+    getPagedDistinctValues(requestOptions: WithCancelEvent<Prioritized<DistinctValuesRequestOptions<IModelDb, Descriptor | DescriptorOverrides, KeySet, RulesetVariable>>> & BackendDiagnosticsAttribute): Promise<PagedResponse<DisplayValueGroup>>;
+    /**
+     * Retrieves property data in a simplified format for a single element specified by ID.
+     * @beta
+     */
+    getElementProperties(requestOptions: WithCancelEvent<Prioritized<SingleElementPropertiesRequestOptions<IModelDb>>> & BackendDiagnosticsAttribute): Promise<ElementProperties | undefined>;
+    /**
+     * Retrieves property data in simplified format for multiple elements specified by class or all element.
+     * @return An object that contains element count and AsyncGenerator to iterate over properties of those elements in batches of undefined size.
+     * @alpha
+     */
+    getElementProperties(requestOptions: WithCancelEvent<Prioritized<MultiElementPropertiesRequestOptions<IModelDb>>> & BackendDiagnosticsAttribute): Promise<MultiElementPropertiesResponse>;
+    private getMultipleElementProperties;
+    /**
+     * Retrieves display label definition of specific item
+     * @public
+     */
+    getDisplayLabelDefinition(requestOptions: WithCancelEvent<Prioritized<DisplayLabelRequestOptions<IModelDb, InstanceKey>>> & BackendDiagnosticsAttribute): Promise<LabelDefinition>;
+    /**
+     * Retrieves display label definitions of specific items
+     * @public
+     */
+    getDisplayLabelDefinitions(requestOptions: WithCancelEvent<Prioritized<Paged<DisplayLabelsRequestOptions<IModelDb, InstanceKey>>>> & BackendDiagnosticsAttribute): Promise<LabelDefinition[]>;
+    /**
+     * Retrieves available selection scopes.
+     * @public
+     */
+    getSelectionScopes(_requestOptions: SelectionScopeRequestOptions<IModelDb> & BackendDiagnosticsAttribute): Promise<SelectionScope[]>;
+    /**
+     * Computes selection set based on provided selection scope.
+     * @public
+     */
+    computeSelection(requestOptions: SelectionScopeRequestOptions<IModelDb> & {
+        ids: Id64String[];
+        scopeId: string;
+    } & BackendDiagnosticsAttribute): Promise<KeySet>;
+    /** @alpha */
+    computeSelection(requestOptions: ComputeSelectionRequestOptions<IModelDb> & BackendDiagnosticsAttribute): Promise<KeySet>;
+    /**
+     * Compares two hierarchies specified in the request options
+     * @public
+     */
+    compareHierarchies(requestOptions: HierarchyCompareOptions<IModelDb, NodeKey>): Promise<HierarchyCompareInfo>;
+}
 //# sourceMappingURL=PresentationManager.d.ts.map