@vc-shell/framework 1.1.54 → 1.1.55

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.1.55](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.54...v1.1.55) (2025-07-07)
+
+
+### Bug Fixes
+
+* **vc-blade-toolbar:** adjust spacing in 'more' button for improved layout consistency ([2075e5b](https://github.com/VirtoCommerce/vc-shell/commit/2075e5b37b351a89d9aa1a7dde01dd939e76a212))
+
+
+### Features
+
+* **widget-service:** add external widget registration functionality and enhance widget management ([cd35c9b](https://github.com/VirtoCommerce/vc-shell/commit/cd35c9b50bf44af8f466dc6a2d4ce29ad01e9514))
+
+
+
 ## [1.1.54](https://github.com/VirtoCommerce/vc-shell/compare/v1.1.53...v1.1.54) (2025-07-07)
 
 

package/core/composables/useWidgets/index.ts

@@ -1,5 +1,10 @@
 import { getCurrentInstance, inject, provide } from "vue";
-import { createWidgetService, IWidgetService, registerWidget } from "./../../services/widget-service";
+import {
+  createWidgetService,
+  IWidgetService,
+  registerWidget,
+  registerExternalWidget,
+} from "./../../services/widget-service";
 import { WidgetServiceKey } from "./../../../injection-keys";
 
 export function provideWidgetService(): IWidgetService {
@@ -17,4 +22,4 @@ export function useWidgets(): IWidgetService {
   return service;
 }
 
-export { registerWidget };
+export { registerWidget, registerExternalWidget };

package/core/services/widget-service.ts

@@ -11,11 +11,23 @@ export interface IExposedWidget {
   [key: string]: unknown;
 }
 
+export interface IWidgetConfig {
+  // Required data that the widget MUST receive
+  requiredData?: string[];
+  // Optional data that the widget can use if available
+  optionalData?: string[];
+  // Function to transform blade data into widget props
+  propsResolver?: (bladeData: Record<string, unknown>) => Record<string, unknown>;
+  // Field mapping (if names in blade and widget differ)
+  fieldMapping?: Record<string, string>;
+}
+
 export interface IWidget {
   id: string;
   title?: string;
   component: Component;
   props?: Record<string, unknown>;
+  config?: IWidgetConfig;
   events?: Record<string, unknown>;
   isVisible?: boolean | ComputedRef<boolean> | Ref<boolean> | ((blade?: IBladeInstance) => boolean);
   updateFunctionName?: string;
@@ -26,6 +38,17 @@ export interface IWidgetRegistration {
   widget: IWidget;
 }
 
+// Interface for global registration of external widgets
+export interface IExternalWidgetRegistration {
+  id: string;
+  component: Component;
+  config: IWidgetConfig;
+  targetBlades?: string[]; // For which blades is the widget intended
+  isVisible?: boolean | ComputedRef<boolean> | Ref<boolean> | ((blade?: IBladeInstance) => boolean);
+  title?: string;
+  updateFunctionName?: string;
+}
+
 export interface IWidgetService {
   registerWidget: (widget: IWidget, bladeId: string) => void;
   unregisterWidget: (widgetId: string, bladeId: string) => void;
@@ -37,12 +60,17 @@ export interface IWidgetService {
   updateActiveWidget: () => void;
   isWidgetRegistered: (id: string) => boolean;
   updateWidget: ({ id, bladeId, widget }: { id: string; bladeId: string; widget: Partial<IWidget> }) => void;
+  resolveWidgetProps: (widget: IWidget, bladeData: Record<string, unknown>) => Record<string, unknown>;
+  getExternalWidgetsForBlade: (bladeType: string) => IExternalWidgetRegistration[];
 }
 
 // Global state for pre-registering widgets
 const preregisteredWidgets: IWidgetRegistration[] = [];
 const preregisteredIds = new Set<string>();
 
+// Global state for external widgets
+const externalWidgets: IExternalWidgetRegistration[] = [];
+
 /**
  * Registers a widget before the service is initialized
  */
@@ -52,6 +80,20 @@ export function registerWidget(widget: IWidget, bladeId: string): void {
   preregisteredIds.add(widget.id);
 }
 
+/**
+ * Registers an external widget for use across different blades
+ */
+export function registerExternalWidget(widget: IExternalWidgetRegistration): void {
+  externalWidgets.push(widget);
+}
+
+/**
+ * Gets list of external widgets for a specific blade type
+ */
+export function getExternalWidgetsForBlade(bladeType: string): IExternalWidgetRegistration[] {
+  return externalWidgets.filter((widget) => !widget.targetBlades || widget.targetBlades.includes(bladeType));
+}
+
 export function createWidgetService(): IWidgetService {
   const widgetRegistry = reactive<Record<string, IWidget[]>>({});
   const registeredWidgets = reactive<IWidgetRegistration[]>([]);
@@ -73,6 +115,49 @@ export function createWidgetService(): IWidgetService {
     }
   };
 
+  // Add method to resolve props
+  const resolveWidgetProps = (widget: IWidget, bladeData: Record<string, unknown>): Record<string, unknown> => {
+    // If no configuration, return existing props or empty object
+    if (!widget.config) {
+      return widget.props || {};
+    }
+
+    let resolvedProps: Record<string, unknown> = { ...widget.props };
+
+    // If there is a custom resolver
+    if (widget.config.propsResolver) {
+      try {
+        const customProps = widget.config.propsResolver(bladeData);
+        resolvedProps = { ...resolvedProps, ...customProps };
+      } catch (error) {
+        console.error(`Error in propsResolver for widget '${widget.id}':`, error);
+      }
+    } else {
+      // Standard logic for resolving props
+      const { requiredData = [], optionalData = [], fieldMapping = {} } = widget.config;
+
+      // Add required data
+      requiredData.forEach((key) => {
+        const bladeKey = fieldMapping[key] || key;
+        if (bladeData[bladeKey] !== undefined) {
+          resolvedProps[key] = bladeData[bladeKey];
+        } else {
+          console.warn(`Required data '${key}' not found in blade data for widget '${widget.id}'`);
+        }
+      });
+
+      // Add optional data
+      optionalData.forEach((key) => {
+        const bladeKey = fieldMapping[key] || key;
+        if (bladeData[bladeKey] !== undefined) {
+          resolvedProps[key] = bladeData[bladeKey];
+        }
+      });
+    }
+
+    return resolvedProps;
+  };
+
   const updateWidget = ({ id, bladeId, widget }: { id: string; bladeId: string; widget: Partial<IWidget> }): void => {
     const normalizedBladeId = bladeId.toLowerCase();
 
@@ -170,6 +255,10 @@ export function createWidgetService(): IWidgetService {
     return activeWidget.value?.widgetId === id;
   };
 
+  const getExternalWidgetsForBladeLocal = (bladeType: string): IExternalWidgetRegistration[] => {
+    return getExternalWidgetsForBlade(bladeType);
+  };
+
   preregisteredWidgets.forEach((widget) => {
     try {
       registerWidget(widget.widget, widget.bladeId);
@@ -189,5 +278,7 @@ export function createWidgetService(): IWidgetService {
     updateActiveWidget,
     isWidgetRegistered,
     updateWidget,
+    resolveWidgetProps,
+    getExternalWidgetsForBlade: getExternalWidgetsForBladeLocal,
   };
 }

package/dist/core/composables/useWidgets/index.d.ts

@@ -1,5 +1,5 @@
-import { IWidgetService, registerWidget } from "./../../services/widget-service";
+import { IWidgetService, registerWidget, registerExternalWidget } from "./../../services/widget-service";
 export declare function provideWidgetService(): IWidgetService;
 export declare function useWidgets(): IWidgetService;
-export { registerWidget };
+export { registerWidget, registerExternalWidget };
 //# sourceMappingURL=index.d.ts.map

package/dist/core/composables/useWidgets/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/composables/useWidgets/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAuB,cAAc,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAGtG,wBAAgB,oBAAoB,IAAI,cAAc,CAIrD;AAED,wBAAgB,UAAU,IAAI,cAAc,CAO3C;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/composables/useWidgets/index.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,cAAc,EACd,cAAc,EACd,sBAAsB,EACvB,MAAM,iCAAiC,CAAC;AAGzC,wBAAgB,oBAAoB,IAAI,cAAc,CAIrD;AAED,wBAAgB,UAAU,IAAI,cAAc,CAO3C;AAED,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/core/services/widget-service.d.ts

@@ -8,11 +8,18 @@ export interface IExposedWidget {
     id?: string;
     [key: string]: unknown;
 }
+export interface IWidgetConfig {
+    requiredData?: string[];
+    optionalData?: string[];
+    propsResolver?: (bladeData: Record<string, unknown>) => Record<string, unknown>;
+    fieldMapping?: Record<string, string>;
+}
 export interface IWidget {
     id: string;
     title?: string;
     component: Component;
     props?: Record<string, unknown>;
+    config?: IWidgetConfig;
     events?: Record<string, unknown>;
     isVisible?: boolean | ComputedRef<boolean> | Ref<boolean> | ((blade?: IBladeInstance) => boolean);
     updateFunctionName?: string;
@@ -21,6 +28,15 @@ export interface IWidgetRegistration {
     bladeId: string;
     widget: IWidget;
 }
+export interface IExternalWidgetRegistration {
+    id: string;
+    component: Component;
+    config: IWidgetConfig;
+    targetBlades?: string[];
+    isVisible?: boolean | ComputedRef<boolean> | Ref<boolean> | ((blade?: IBladeInstance) => boolean);
+    title?: string;
+    updateFunctionName?: string;
+}
 export interface IWidgetService {
     registerWidget: (widget: IWidget, bladeId: string) => void;
     unregisterWidget: (widgetId: string, bladeId: string) => void;
@@ -39,10 +55,20 @@ export interface IWidgetService {
         bladeId: string;
         widget: Partial<IWidget>;
     }) => void;
+    resolveWidgetProps: (widget: IWidget, bladeData: Record<string, unknown>) => Record<string, unknown>;
+    getExternalWidgetsForBlade: (bladeType: string) => IExternalWidgetRegistration[];
 }
 /**
  * Registers a widget before the service is initialized
  */
 export declare function registerWidget(widget: IWidget, bladeId: string): void;
+/**
+ * Registers an external widget for use across different blades
+ */
+export declare function registerExternalWidget(widget: IExternalWidgetRegistration): void;
+/**
+ * Gets list of external widgets for a specific blade type
+ */
+export declare function getExternalWidgetsForBlade(bladeType: string): IExternalWidgetRegistration[];
 export declare function createWidgetService(): IWidgetService;
 //# sourceMappingURL=widget-service.d.ts.map

package/dist/core/services/widget-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"widget-service.d.ts","sourceRoot":"","sources":["../../../core/services/widget-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAiB,yBAAyB,EAAE,WAAW,EAAE,GAAG,EAAsB,MAAM,KAAK,CAAC;AAChH,OAAO,EAAE,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAEhF,MAAM,MAAM,kBAAkB,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;AAE9D,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC,kBAAkB,CAAC,CAAC;CACxC;AACD,MAAM,WAAW,cAAc;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,SAAS,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC;IAClG,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3D,gBAAgB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9D,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,EAAE,CAAC;IAC3C,iBAAiB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7C,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;IACzC,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;IACxC,eAAe,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;QAAE,OAAO,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IACtH,kBAAkB,EAAE,MAAM,IAAI,CAAC;IAC/B,kBAAkB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;IAC5C,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;KAAE,KAAK,IAAI,CAAC;CAC5G;AAMD;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAIrE;AAED,wBAAgB,mBAAmB,IAAI,cAAc,CA0IpD"}
+{"version":3,"file":"widget-service.d.ts","sourceRoot":"","sources":["../../../core/services/widget-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAiB,yBAAyB,EAAE,WAAW,EAAE,GAAG,EAAsB,MAAM,KAAK,CAAC;AAChH,OAAO,EAAE,cAAc,EAAE,MAAM,gDAAgD,CAAC;AAEhF,MAAM,MAAM,kBAAkB,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;AAE9D,MAAM,WAAW,aAAa;IAC5B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC,kBAAkB,CAAC,CAAC;CACxC;AACD,MAAM,WAAW,cAAc;IAC7B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,aAAa;IAE5B,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB,aAAa,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhF,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,SAAS,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC;IAClG,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC;CACjB;AAGD,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,SAAS,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC;IAClG,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC3D,gBAAgB,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC9D,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,EAAE,CAAC;IAC3C,iBAAiB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7C,iBAAiB,EAAE,mBAAmB,EAAE,CAAC;IACzC,cAAc,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;IACxC,eAAe,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE;QAAE,OAAO,EAAE,yBAAyB,CAAC,SAAS,CAAC,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IACtH,kBAAkB,EAAE,MAAM,IAAI,CAAC;IAC/B,kBAAkB,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC;IAC5C,YAAY,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;KAAE,KAAK,IAAI,CAAC;IAC3G,kBAAkB,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrG,0BAA0B,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,2BAA2B,EAAE,CAAC;CAClF;AASD;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAIrE;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,2BAA2B,GAAG,IAAI,CAEhF;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,2BAA2B,EAAE,CAE3F;AAED,wBAAgB,mBAAmB,IAAI,cAAc,CA2LpD"}