@c8y/ngx-components 1024.18.1 → 1024.18.9

package/fesm2022/c8y-ngx-components-context-dashboard.mjs

@@ -12,7 +12,7 @@ import { NgTemplateOutlet, CommonModule, NgClass, AsyncPipe, NgIf, NgForOf, NgFo
 import { takeUntilDestroyed, toSignal } from '@angular/core/rxjs-interop';
 import * as i6 from '@c8y/ngx-components/context-dashboard-state';
 import * as i2$1 from '@ngx-translate/core';
-import { assign, pick, isEmpty, cloneDeep, some, keys, keyBy, has, set, reduce, forEach, get, isEqual, clone, merge as merge$1, omit, sortBy, isNull, escapeRegExp, findIndex, kebabCase, every, words, camelCase } from 'lodash-es';
+import { assign, pick, isEmpty, cloneDeep, some, keys, keyBy, has, set, forEach, get, isEqual, clone, merge as merge$1, omit, sortBy, isNull, escapeRegExp, findIndex, kebabCase, every, words, camelCase } from 'lodash-es';
 import * as i2$2 from 'ngx-bootstrap/popover';
 import { PopoverModule, PopoverDirective } from 'ngx-bootstrap/popover';
 import * as i1$1 from '@c8y/client';
@@ -647,7 +647,7 @@ class ContextDashboardService {
     async pasteDashboard(newContext) {
         if (this.copyClipboard) {
             try {
-                const dashboardToPaste = this.createContextDashboardCopy(this.copyClipboard.dashboard, newContext.contextData, this.copyClipboard.context.contextData);
+                const dashboardToPaste = await this.createContextDashboardCopy(this.copyClipboard.dashboard, newContext.contextData, this.copyClipboard.context.contextData);
                 const dashboard = await this.create(this.clean(dashboardToPaste), newContext);
                 // linking childAdditions for e.g. to grant access to the images uploaded by the image widget for users with only inventory roles.
                 const { data: childAdditions } = await this.inventory.childAdditionsList(this.copyClipboard.dashboardId, { pageSize: 2000 });
@@ -935,28 +935,44 @@ class ContextDashboardService {
         });
         dashboard.c8y_Dashboard.children = children;
     }
-    createContextDashboardCopy(dash, newContext, oldContext) {
-        const children = reduce(dash.children, (_children, child) => {
+    async createContextDashboardCopy(dash, newContext, oldContext) {
+        const _children = {};
+        const propertiesToCopy = {
+            device: device => this.replaceContextInObj(device, newContext, oldContext),
+            deviceIds: deviceIds => this.replaceContextInIdsObj(deviceIds, newContext, oldContext),
+            datapoints: dataPoints => this.replaceContextInDataPoints(dataPoints, newContext, oldContext),
+            dataPoints: dataPoints => this.replaceContextInDataPoints(dataPoints, newContext, oldContext),
+            datapointsGauge: dataPoints => this.replaceContextInDataPoints(dataPoints, newContext, oldContext),
+            datapointsLabels: dataPoints => this.replaceContextInDataPoints(dataPoints, newContext, oldContext)
+        };
+        for (const child of Object.values(dash.children || {})) {
             const { id } = child;
             const cfg = child.config;
-            const propertiesToCopy = {
-                device: device => this.replaceContextInObj(device, newContext, oldContext),
-                deviceIds: deviceIds => this.replaceContextInIdsObj(deviceIds, newContext, oldContext),
-                datapoints: dataPoints => this.replaceContextInDataPoints(dataPoints, newContext, oldContext),
-                dataPoints: dataPoints => this.replaceContextInDataPoints(dataPoints, newContext, oldContext),
-                datapointsGauge: dataPoints => this.replaceContextInDataPoints(dataPoints, newContext, oldContext),
-                datapointsLabels: dataPoints => this.replaceContextInDataPoints(dataPoints, newContext, oldContext)
-            };
             if (cfg) {
-                this.copyProperties(cfg, propertiesToCopy);
-                if (cfg.options) {
-                    this.copyProperties(cfg.options, propertiesToCopy);
+                const definition = await this.dynamicComponent.getById(child.componentId);
+                const pasteHook = definition?.data?.paste;
+                let pasteHookApplied = false;
+                if (typeof pasteHook === 'function') {
+                    try {
+                        // A hook that returns nothing is treated as "config left as is", so that a missing
+                        // return value cannot wipe the widget's configuration.
+                        child.config = (await pasteHook(cfg, newContext, oldContext)) ?? cfg;
+                        pasteHookApplied = true;
+                    }
+                    catch (error) {
+                        console.error(`The paste hook of widget "${child.componentId}" failed. Falling back to the default context replacement.`, error);
+                    }
+                }
+                if (!pasteHookApplied) {
+                    this.copyProperties(cfg, propertiesToCopy);
+                    if (cfg.options) {
+                        this.copyProperties(cfg.options, propertiesToCopy);
+                    }
                 }
             }
             _children[id] = cloneDeep(child);
-            return _children;
-        }, {});
-        dash.children = children;
+        }
+        dash.children = _children;
         const isTypeDashboard = dash.deviceType && !!dash.deviceTypeValue;
         if (isTypeDashboard) {
             dash.deviceTypeValue = newContext.type;
@@ -4922,7 +4938,70 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.19", ngImpo
             args: [{ providedIn: 'root' }]
         }] });
 
+/**
+ * Checks whether the given managed object ID refers to the old context.
+ *
+ * IDs are compared as strings, because a configuration can hold them either as a string or as a
+ * number depending on how it was created (e.g. seeded through the API), while the context always
+ * carries the platform's string ID.
+ *
+ * @param id - The ID stored in the widget configuration
+ * @param oldContext - The old context managed object containing the ID to compare against
+ */
+function referencesOldContext(id, oldContext) {
+    return id !== undefined && id !== null && String(id) === String(oldContext.id);
+}
+/**
+ * Rebinds a single asset reference of a widget configuration to the new context.
+ *
+ * Use this from a widget's `paste` hook for every asset, device or group reference the widget
+ * stores, so that a widget pasted onto a different context object stops reading from the object
+ * it was originally bound to. References pointing at anything other than the old context are
+ * left untouched, as they were deliberately bound to a different asset.
+ *
+ * @param reference - The asset reference to rebind, modified in place
+ * @param newContext - The new context managed object to bind to
+ * @param oldContext - The old context managed object to replace
+ * @returns The same reference, rebound when it matched the old context
+ */
+function replaceContextInAssetReference(reference, newContext, oldContext) {
+    if (reference && referencesOldContext(reference.id, oldContext)) {
+        Object.assign(reference, pick(newContext, ['id', 'name']));
+    }
+    return reference;
+}
+
 const IDENTIFIER_REGEX = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/;
+/**
+ * Replaces context IDs in per-placeholder asset property mappings (see `AssetPropertyMappings`).
+ *
+ * Each mapping's `assetProperty.asset` identifies the asset/device/group that placeholder is
+ * bound to, which can differ from the widget's primary `device`. Computed properties
+ * additionally carry a `contextAssetId` that mirrors `asset.id`, and reference the source of
+ * their measurements through `config.dp[].__target`. All of them need to be replaced when a
+ * widget's config is reused in a new context, otherwise the pasted placeholder keeps reading
+ * from the asset it was originally bound to. Mappings with a `null` `assetProperty` (unmapped
+ * placeholders) are left untouched.
+ *
+ * @param mappings - Map of placeholder name to asset property mapping
+ * @param newContext - The new context managed object containing the ID to replace with
+ * @param oldContext - The old context managed object containing the ID to replace
+ * @returns The same mappings object, with matching asset references replaced in place
+ */
+function replaceContextInAssetPropertyMappings(mappings, newContext, oldContext) {
+    forEach(mappings, mapping => {
+        const assetProperty = mapping?.assetProperty;
+        if (!assetProperty) {
+            return;
+        }
+        replaceContextInAssetReference(assetProperty.asset, newContext, oldContext);
+        if (referencesOldContext(assetProperty.contextAssetId, oldContext)) {
+            assetProperty.contextAssetId = newContext.id;
+        }
+        forEach(assetProperty.config?.dp, dataPoint => replaceContextInAssetReference(dataPoint?.__target, newContext, oldContext));
+    });
+    return mappings;
+}
 function stripC8yPrefix(s) {
     return s.startsWith('c8y_') ? s.slice(4) : s;
 }
@@ -5317,5 +5396,5 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.19", ngImpo
  * Generated bundle index. Do not edit.
  */
 
-export { ALL_GLOBAL_ROLES_SELECTED, APPLIED_TO_APPLICATIONS_FRAGMENT, AddDashboardComponent, AddDashboardFactory, AppearanceSettingsComponent, AssetPropertyMappingsComponent, AssetPropertyMappingsService, CONTEXT_DASHBOARD_CONFIG, ContextDashboardComponent, ContextDashboardModule, ContextDashboardService, ContextDashboardType, DASHBOARD_CHILDREN_STATE_NAME, DASHBOARD_DETAILS_OUTLET, DASHBOARD_DETAILS_TABS_OUTLET_NAME, DASHBOARD_FOUNDATION_MAP, DASHBOARD_SETTINGS_CHANGES, DASHBOARD_THEME_CLASSES, DashboardActionBarFactory, DashboardDetailComponent, DashboardDetailService, DashboardDetailsTabId, DeviceInfoDashboardComponent, DeviceInfoDashboardModule, DeviceManagementHomeDashboardComponent, DeviceManagementHomeDashboardModule, FOUNDATION_CLASSES, GlobalContextSectionComponent, HOOK_WIDGET_CONFIG, NewDashboardGuard, PRODUCT_EXPERIENCE, PasteDashboardActionComponent, REPORT_DEFAULT_NAVIGATION_NODE_PRIORITY, STYLING_CLASS_PREFIXES, THEME_FOUNDATION_MAP, TypeDashboardInfoComponent, WIDGET_CONTENT_CLASSES, WIDGET_FOUNDATION_MAP, WIDGET_HEADER_CLASSES, WidgetAssetSelectorComponent, WidgetConfigAppearanceComponent, WidgetConfigChangeMode, WidgetConfigComponent, WidgetConfigFeedbackComponent, WidgetConfigGeneralComponent, WidgetConfigSectionComponent, WidgetConfigSectionService, WidgetConfigService, WidgetPreviewComponent, WidgetPreviewWrapperComponent, WidgetService, applyEntitySharing, escapeForRegExp, getPropertyBaseKey, getSharedApplicationKeys, hookWidgetConfig, newDashboardTab, quoteAndEscape, renamePropertyKeyInCode };
+export { ALL_GLOBAL_ROLES_SELECTED, APPLIED_TO_APPLICATIONS_FRAGMENT, AddDashboardComponent, AddDashboardFactory, AppearanceSettingsComponent, AssetPropertyMappingsComponent, AssetPropertyMappingsService, CONTEXT_DASHBOARD_CONFIG, ContextDashboardComponent, ContextDashboardModule, ContextDashboardService, ContextDashboardType, DASHBOARD_CHILDREN_STATE_NAME, DASHBOARD_DETAILS_OUTLET, DASHBOARD_DETAILS_TABS_OUTLET_NAME, DASHBOARD_FOUNDATION_MAP, DASHBOARD_SETTINGS_CHANGES, DASHBOARD_THEME_CLASSES, DashboardActionBarFactory, DashboardDetailComponent, DashboardDetailService, DashboardDetailsTabId, DeviceInfoDashboardComponent, DeviceInfoDashboardModule, DeviceManagementHomeDashboardComponent, DeviceManagementHomeDashboardModule, FOUNDATION_CLASSES, GlobalContextSectionComponent, HOOK_WIDGET_CONFIG, NewDashboardGuard, PRODUCT_EXPERIENCE, PasteDashboardActionComponent, REPORT_DEFAULT_NAVIGATION_NODE_PRIORITY, STYLING_CLASS_PREFIXES, THEME_FOUNDATION_MAP, TypeDashboardInfoComponent, WIDGET_CONTENT_CLASSES, WIDGET_FOUNDATION_MAP, WIDGET_HEADER_CLASSES, WidgetAssetSelectorComponent, WidgetConfigAppearanceComponent, WidgetConfigChangeMode, WidgetConfigComponent, WidgetConfigFeedbackComponent, WidgetConfigGeneralComponent, WidgetConfigSectionComponent, WidgetConfigSectionService, WidgetConfigService, WidgetPreviewComponent, WidgetPreviewWrapperComponent, WidgetService, applyEntitySharing, escapeForRegExp, getPropertyBaseKey, getSharedApplicationKeys, hookWidgetConfig, newDashboardTab, quoteAndEscape, referencesOldContext, renamePropertyKeyInCode, replaceContextInAssetPropertyMappings, replaceContextInAssetReference };
 //# sourceMappingURL=c8y-ngx-components-context-dashboard.mjs.map