@itwin/presentation-frontend 5.0.0-dev.1 → 5.0.0-dev.100

package/lib/cjs/presentation-frontend/PresentationManager.js

@@ -11,12 +11,15 @@ exports.PresentationManager = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_frontend_1 = require("@itwin/core-frontend");
 const presentation_common_1 = require("@itwin/presentation-common");
-const IpcRequestsHandler_1 = require("./IpcRequestsHandler");
-const LocalizationHelper_1 = require("./LocalizationHelper");
-const RulesetManager_1 = require("./RulesetManager");
-const RulesetVariablesManager_1 = require("./RulesetVariablesManager");
-const SelectionManager_1 = require("./selection/SelectionManager");
-const StreamedResponseGenerator_1 = require("./StreamedResponseGenerator");
+const internal_1 = require("@itwin/presentation-common/internal");
+const unified_selection_1 = require("@itwin/unified-selection");
+const IpcRequestsHandler_js_1 = require("./IpcRequestsHandler.js");
+const LocalizationHelper_js_1 = require("./LocalizationHelper.js");
+const RulesetManager_js_1 = require("./RulesetManager.js");
+const RulesetVariablesManager_js_1 = require("./RulesetVariablesManager.js");
+const StreamedResponseGenerator_js_1 = require("./StreamedResponseGenerator.js");
+const IModelConnectionInitialization_js_1 = require("./IModelConnectionInitialization.js");
+const InternalSymbols_js_1 = require("./InternalSymbols.js");
 /**
  * Frontend Presentation manager which basically just forwards all calls to
  * the backend implementation.
@@ -24,6 +27,23 @@ const StreamedResponseGenerator_1 = require("./StreamedResponseGenerator");
  * @public
  */
 class PresentationManager {
+    _requestsHandler;
+    _rulesets;
+    _localizationHelper;
+    _explicitActiveUnitSystem;
+    _rulesetVars;
+    _clearEventListener;
+    _schemaContextProvider;
+    _defaultFormats;
+    _ipcRequestsHandler;
+    /**
+     * An event raised when hierarchies created using specific ruleset change
+     */
+    onIModelHierarchyChanged = new core_bentley_1.BeEvent();
+    /**
+     * An event raised when content created using specific ruleset changes
+     */
+    onIModelContentChanged = new core_bentley_1.BeEvent();
     /**
      * Get / set active unit system used to format property values with units.
      *
@@ -38,33 +58,22 @@ class PresentationManager {
         this._explicitActiveUnitSystem = value;
     }
     constructor(props) {
-        /**
-         * An event raised when hierarchies created using specific ruleset change
-         */
-        this.onIModelHierarchyChanged = new core_bentley_1.BeEvent();
-        /**
-         * An event raised when content created using specific ruleset changes
-         */
-        this.onIModelContentChanged = new core_bentley_1.BeEvent();
-        this.onUpdate = (_evt, report) => {
-            // eslint-disable-next-line @typescript-eslint/no-floating-promises
-            this.handleUpdateAsync(report);
-        };
         if (props) {
             // eslint-disable-next-line @typescript-eslint/no-deprecated
             this._explicitActiveUnitSystem = props.activeUnitSystem;
         }
         this._requestsHandler =
-            props?.rpcRequestsHandler ?? new presentation_common_1.RpcRequestsHandler(props ? { clientId: props.clientId, timeout: props.requestTimeout } : undefined);
+            props?.rpcRequestsHandler ??
+                new internal_1.RpcRequestsHandler(props ? { clientId: props.clientId, timeout: props.requestTimeout } : undefined);
         this._rulesetVars = new Map();
-        this._rulesets = RulesetManager_1.RulesetManagerImpl.create();
-        this._localizationHelper = new LocalizationHelper_1.FrontendLocalizationHelper(props?.activeLocale);
+        this._rulesets = RulesetManager_js_1.RulesetManagerImpl.create();
+        this._localizationHelper = new LocalizationHelper_js_1.FrontendLocalizationHelper(props?.activeLocale);
         this._schemaContextProvider = props?.schemaContextProvider;
         this._defaultFormats = props?.defaultFormats;
         if (core_frontend_1.IpcApp.isValid) {
             // Ipc only works in ipc apps, so the `onUpdate` callback will only be called there.
-            this._clearEventListener = core_frontend_1.IpcApp.addListener(presentation_common_1.PresentationIpcEvents.Update, this.onUpdate);
-            this._ipcRequestsHandler = props?.ipcRequestsHandler ?? new IpcRequestsHandler_1.IpcRequestsHandler(this._requestsHandler.clientId);
+            this._clearEventListener = core_frontend_1.IpcApp.addListener(internal_1.PresentationIpcEvents.Update, this.onUpdate);
+            this._ipcRequestsHandler = props?.ipcRequestsHandler ?? new IpcRequestsHandler_js_1.IpcRequestsHandler(this._requestsHandler.clientId);
         }
     }
     /** Get / set active locale used for localizing presentation data */
@@ -74,22 +83,31 @@ class PresentationManager {
     set activeLocale(locale) {
         this._localizationHelper.locale = locale;
     }
-    dispose() {
+    [Symbol.dispose]() {
         if (this._clearEventListener) {
             this._clearEventListener();
             this._clearEventListener = undefined;
         }
     }
+    /** @deprecated in 5.0 Use [Symbol.dispose] instead. */
+    /* c8 ignore next 3 */
+    dispose() {
+        this[Symbol.dispose]();
+    }
+    onUpdate = (_evt, report) => {
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        this.handleUpdateAsync(report);
+    };
     /** @note This is only called in native apps after changes in iModels */
     async handleUpdateAsync(report) {
         for (const imodelKey in report) {
-            // istanbul ignore if
+            /* c8 ignore next 3 */
             if (!report.hasOwnProperty(imodelKey)) {
                 continue;
             }
             const imodelReport = report[imodelKey];
             for (const rulesetId in imodelReport) {
-                // istanbul ignore if
+                /* c8 ignore next 3 */
                 if (!imodelReport.hasOwnProperty(rulesetId)) {
                     continue;
                 }
@@ -103,17 +121,6 @@ class PresentationManager {
             }
         }
     }
-    /**
-     * Function that is called when a new IModelConnection is used to retrieve data.
-     * @internal
-     */
-    startIModelInitialization(_) { }
-    /**
-     * Function that should be called to finish initialization that was started at [[PresentationManager.startIModelInitialization]].
-     * Can be removed when [[FavoritePropertiesManager.has]] and [[FavoritePropertiesManager.sortFields]] are removed.
-     * @internal
-     */
-    async ensureIModelInitialized(_) { }
     /**
      * Create a new PresentationManager instance
      * @param props Optional properties used to configure the manager
@@ -122,11 +129,11 @@ class PresentationManager {
         return new PresentationManager(props);
     }
     /** @internal */
-    get rpcRequestsHandler() {
+    get [InternalSymbols_js_1._presentation_manager_rpcRequestsHandler]() {
         return this._requestsHandler;
     }
     /** @internal */
-    get ipcRequestsHandler() {
+    get [InternalSymbols_js_1._presentation_manager_ipcRequestsHandler]() {
         return this._ipcRequestsHandler;
     }
     /**
@@ -141,7 +148,7 @@ class PresentationManager {
      */
     vars(rulesetId) {
         if (!this._rulesetVars.has(rulesetId)) {
-            const varsManager = new RulesetVariablesManager_1.RulesetVariablesManagerImpl(rulesetId, this._ipcRequestsHandler);
+            const varsManager = new RulesetVariablesManager_js_1.RulesetVariablesManagerImpl(rulesetId, this._ipcRequestsHandler);
             this._rulesetVars.set(rulesetId, varsManager);
         }
         return this._rulesetVars.get(rulesetId);
@@ -192,17 +199,16 @@ class PresentationManager {
     }
     /** Returns an iterator that polls nodes asynchronously. */
     async getNodesIterator(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = this.toRpcTokenOptions({ ...options });
-        const generator = new StreamedResponseGenerator_1.StreamedResponseGenerator({
+        const generator = new StreamedResponseGenerator_js_1.StreamedResponseGenerator({
             ...requestOptions,
             getBatch: async (paging) => {
                 const result = await this._requestsHandler.getPagedNodes({ ...rpcOptions, paging });
                 return {
                     total: result.total,
-                    // eslint-disable-next-line @typescript-eslint/no-deprecated
-                    items: this._localizationHelper.getLocalizedNodes(result.items.map(presentation_common_1.Node.fromJSON)),
+                    items: this._localizationHelper.getLocalizedNodes(result.items),
                 };
             },
         });
@@ -218,7 +224,7 @@ class PresentationManager {
     }
     /** Retrieves nodes count. */
     async getNodesCount(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = this.toRpcTokenOptions({ ...options });
         return this._requestsHandler.getNodesCount(rpcOptions);
@@ -239,7 +245,7 @@ class PresentationManager {
      * @public
      */
     async getNodesDescriptor(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         try {
             const options = await this.addRulesetAndVariablesToOptions(requestOptions);
             const rpcOptions = this.toRpcTokenOptions({ ...options });
@@ -248,25 +254,23 @@ class PresentationManager {
             return descriptor ? this._localizationHelper.getLocalizedContentDescriptor(descriptor) : undefined;
         }
         finally {
-            await this.ensureIModelInitialized(requestOptions.imodel);
+            await (0, IModelConnectionInitialization_js_1.ensureIModelInitialized)(requestOptions.imodel);
         }
     }
     /** Retrieves paths from root nodes to children nodes according to specified keys. Intersecting paths will be merged. */
     async getNodePaths(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = this.toRpcTokenOptions({ ...options });
         const result = await this._requestsHandler.getNodePaths(rpcOptions);
-        // eslint-disable-next-line @typescript-eslint/no-deprecated
-        return result.map(presentation_common_1.NodePathElement.fromJSON).map((npe) => this._localizationHelper.getLocalizedNodePathElement(npe));
+        return result.map((npe) => this._localizationHelper.getLocalizedNodePathElement(npe));
     }
     /** Retrieves paths from root nodes to nodes containing filter text in their label. */
     async getFilteredNodePaths(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const result = await this._requestsHandler.getFilteredNodePaths(this.toRpcTokenOptions(options));
-        // eslint-disable-next-line @typescript-eslint/no-deprecated
-        return result.map(presentation_common_1.NodePathElement.fromJSON).map((npe) => this._localizationHelper.getLocalizedNodePathElement(npe));
+        return result.map((npe) => this._localizationHelper.getLocalizedNodePathElement(npe));
     }
     /**
      * Get information about the sources of content when building it for specific ECClasses. Sources involve classes of the primary select instance,
@@ -274,14 +278,14 @@ class PresentationManager {
      * @public
      */
     async getContentSources(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const rpcOptions = this.toRpcTokenOptions(requestOptions);
         const result = await this._requestsHandler.getContentSources(rpcOptions);
-        return presentation_common_1.SelectClassInfo.listFromCompressedJSON(result.sources, result.classesMap);
+        return result.sources.map((sourceJson) => presentation_common_1.SelectClassInfo.fromCompressedJSON(sourceJson, result.classesMap));
     }
     /** Retrieves the content descriptor which describes the content and can be used to customize it. */
     async getContentDescriptor(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         try {
             const options = await this.addRulesetAndVariablesToOptions(requestOptions);
             const rpcOptions = this.toRpcTokenOptions({
@@ -293,12 +297,12 @@ class PresentationManager {
             return descriptor ? this._localizationHelper.getLocalizedContentDescriptor(descriptor) : undefined;
         }
         finally {
-            await this.ensureIModelInitialized(requestOptions.imodel);
+            await (0, IModelConnectionInitialization_js_1.ensureIModelInitialized)(requestOptions.imodel);
         }
     }
     /** Retrieves overall content set size. */
     async getContentSetSize(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = this.toRpcTokenOptions({
             ...options,
@@ -320,7 +324,7 @@ class PresentationManager {
         let contentFormatter;
         if (!requestOptions.omitFormattedValues && this._schemaContextProvider) {
             const koqPropertyFormatter = new presentation_common_1.KoqPropertyValueFormatter(this._schemaContextProvider(requestOptions.imodel), this._defaultFormats);
-            contentFormatter = new presentation_common_1.ContentFormatter(new presentation_common_1.ContentPropertyValueFormatter(koqPropertyFormatter), requestOptions.unitSystem ?? this._explicitActiveUnitSystem ?? core_frontend_1.IModelApp.quantityFormatter.activeUnitSystem);
+            contentFormatter = new internal_1.ContentFormatter(new internal_1.ContentPropertyValueFormatter(koqPropertyFormatter), requestOptions.unitSystem ?? this._explicitActiveUnitSystem ?? core_frontend_1.IModelApp.quantityFormatter.activeUnitSystem);
         }
         let descriptor = requestOptions.descriptor instanceof presentation_common_1.Descriptor ? requestOptions.descriptor : undefined;
         let firstPage;
@@ -332,7 +336,7 @@ class PresentationManager {
             descriptor = presentation_common_1.Descriptor.fromJSON(firstPageResponse?.descriptor);
             firstPage = firstPageResponse?.contentSet;
         }
-        // istanbul ignore if
+        /* c8 ignore next 3 */
         if (!descriptor) {
             return undefined;
         }
@@ -350,7 +354,7 @@ class PresentationManager {
                 items,
             };
         };
-        const generator = new StreamedResponseGenerator_1.StreamedResponseGenerator({
+        const generator = new StreamedResponseGenerator_js_1.StreamedResponseGenerator({
             ...requestOptions,
             getBatch: getPage,
         });
@@ -361,12 +365,12 @@ class PresentationManager {
     }
     /** Retrieves a content descriptor, item count and async generator for the items themselves. */
     async getContentIterator(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const response = await this.getContentIteratorInternal(requestOptions);
         if (!response) {
             return undefined;
         }
-        await this.ensureIModelInitialized(requestOptions.imodel);
+        await (0, IModelConnectionInitialization_js_1.ensureIModelInitialized)(requestOptions.imodel);
         return response;
     }
     /**
@@ -395,21 +399,20 @@ class PresentationManager {
     }
     /** Returns an iterator that asynchronously polls distinct values of specific field from the content. */
     async getDistinctValuesIterator(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = {
             ...this.toRpcTokenOptions(options),
             descriptor: getDescriptorOverrides(options.descriptor),
             keys: stripTransientElementKeys(options.keys).toJSON(),
         };
-        const generator = new StreamedResponseGenerator_1.StreamedResponseGenerator({
+        const generator = new StreamedResponseGenerator_js_1.StreamedResponseGenerator({
             ...requestOptions,
             getBatch: async (paging) => {
                 const response = await this._requestsHandler.getPagedDistinctValues({ ...rpcOptions, paging });
                 return {
                     total: response.total,
-                    // eslint-disable-next-line @typescript-eslint/no-deprecated
-                    items: response.items.map((x) => this._localizationHelper.getLocalizedDisplayValueGroup(presentation_common_1.DisplayValueGroup.fromJSON(x))),
+                    items: response.items.map((x) => this._localizationHelper.getLocalizedDisplayValueGroup(x)),
                 };
             },
         });
@@ -431,9 +434,9 @@ class PresentationManager {
      * @public
      */
     async getElementProperties(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const { elementId, contentParser, ...optionsNoElementId } = requestOptions;
-        const parser = contentParser ?? presentation_common_1.buildElementProperties;
+        const parser = contentParser ?? internal_1.buildElementProperties;
         const iter = await this.getContentIterator({
             ...optionsNoElementId,
             descriptor: {
@@ -453,13 +456,13 @@ class PresentationManager {
      * @public
      */
     async getContentInstanceKeys(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const options = await this.addRulesetAndVariablesToOptions(requestOptions);
         const rpcOptions = {
             ...this.toRpcTokenOptions(options),
             keys: stripTransientElementKeys(options.keys).toJSON(),
         };
-        const generator = new StreamedResponseGenerator_1.StreamedResponseGenerator({
+        const generator = new StreamedResponseGenerator_js_1.StreamedResponseGenerator({
             ...requestOptions,
             getBatch: async (page) => {
                 const keys = await this._requestsHandler.getContentInstanceKeys({ ...rpcOptions, paging: page });
@@ -484,16 +487,16 @@ class PresentationManager {
     }
     /** Retrieves display label definition of specific item. */
     async getDisplayLabelDefinition(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const rpcOptions = this.toRpcTokenOptions({ ...requestOptions });
         const result = await this._requestsHandler.getDisplayLabelDefinition(rpcOptions);
         return this._localizationHelper.getLocalizedLabelDefinition(result);
     }
     /** Retrieves display label definition of specific items. */
     async getDisplayLabelDefinitionsIterator(requestOptions) {
-        this.startIModelInitialization(requestOptions.imodel);
+        (0, IModelConnectionInitialization_js_1.startIModelInitialization)(requestOptions.imodel);
         const rpcOptions = this.toRpcTokenOptions({ ...requestOptions });
-        const generator = new StreamedResponseGenerator_1.StreamedResponseGenerator({
+        const generator = new StreamedResponseGenerator_js_1.StreamedResponseGenerator({
             ...requestOptions,
             getBatch: async (page) => {
                 const partialKeys = !page.start ? rpcOptions.keys : rpcOptions.keys.slice(page.start);
@@ -521,16 +524,16 @@ const getDescriptorOverrides = (descriptorOrOverrides) => {
     return descriptorOrOverrides;
 };
 const stripTransientElementKeys = (keys) => {
-    if (!keys.some((key) => presentation_common_1.Key.isInstanceKey(key) && key.className === SelectionManager_1.TRANSIENT_ELEMENT_CLASSNAME)) {
+    if (!keys.some((key) => presentation_common_1.Key.isInstanceKey(key) && key.className === unified_selection_1.TRANSIENT_ELEMENT_CLASSNAME)) {
         return keys;
     }
     const copy = new presentation_common_1.KeySet();
     copy.add(keys, (key) => {
         // the callback is not going to be called with EntityProps as KeySet converts them
         // to InstanceKeys, but we want to keep the EntityProps case for correctness
-        // istanbul ignore next
-        const isTransient = (presentation_common_1.Key.isInstanceKey(key) && key.className === SelectionManager_1.TRANSIENT_ELEMENT_CLASSNAME) ||
-            (presentation_common_1.Key.isEntityProps(key) && key.classFullName === SelectionManager_1.TRANSIENT_ELEMENT_CLASSNAME);
+        /* c8 ignore next 3 */
+        const isTransient = (presentation_common_1.Key.isInstanceKey(key) && key.className === unified_selection_1.TRANSIENT_ELEMENT_CLASSNAME) ||
+            (presentation_common_1.Key.isEntityProps(key) && key.classFullName === unified_selection_1.TRANSIENT_ELEMENT_CLASSNAME);
         return !isTransient;
     });
     return copy;