@vc-shell/framework 1.2.4-beta.7 → 2.0.0-alpha.0

package/core/services/widget-service.ts

@@ -1,262 +0,0 @@
-import { Component, ref, ComponentInternalInstance, ComputedRef, Ref } from "vue";
-import type { IBladeInstance } from "@shared/components/blade-navigation/types";
-import { cloneDeep } from "lodash-es";
-import { createBladeScopedRegistry, createPreregistrationBus } from "@core/services/_internal";
-import { createLogger } from "@core/utilities";
-
-const logger = createLogger("widget-service");
-
-export type WidgetEventHandler = (...args: unknown[]) => void;
-
-export interface IWidgetEvents {
-  [key: string]: Set<WidgetEventHandler>;
-}
-
-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 IWidgetTrigger {
-  /** Lucide icon name for dropdown rendering */
-  icon?: string;
-  /** Display title (fallback: IWidget.title) */
-  title?: string;
-  /** Reactive badge value */
-  badge?: Ref<number | string> | ComputedRef<number | string>;
-  /** Handler called when the widget is clicked in dropdown */
-  onClick?: () => void;
-  /** Handler called by updateActiveWidget to refresh data */
-  onRefresh?: () => void | Promise<void>;
-  /** Disabled state — static or reactive */
-  disabled?: Ref<boolean> | ComputedRef<boolean> | boolean;
-}
-
-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;
-  /** Optional trigger contract for lightweight overflow rendering */
-  trigger?: IWidgetTrigger;
-}
-
-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;
-  getWidgets: (bladeId: string) => IWidget[];
-  clearBladeWidgets: (bladeId: string) => void;
-  registeredWidgets: IWidgetRegistration[];
-  isActiveWidget: (id: string) => boolean;
-  setActiveWidget: (args: { widgetId: string; exposed?: ComponentInternalInstance["exposed"] }) => void;
-  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: (bladeId: string) => IExternalWidgetRegistration[];
-  getAllExternalWidgets: () => IExternalWidgetRegistration[];
-  cloneWidget: <T extends IWidget | IExternalWidgetRegistration>(widget: T) => T;
-}
-
-// --- External widgets (module-level, independent of service instances) ---
-
-const externalWidgets = new Map<string, IExternalWidgetRegistration>();
-
-function normalizeTargetBlades(targetBlades?: string[]): string[] | undefined {
-  return targetBlades?.map((bladeId) => bladeId.toLowerCase());
-}
-
-/**
- * Registers an external widget for use across different blades.
- */
-export function registerExternalWidget(widget: IExternalWidgetRegistration): void {
-  externalWidgets.set(widget.id, {
-    ...widget,
-    targetBlades: normalizeTargetBlades(widget.targetBlades),
-  });
-}
-
-/**
- * Gets list of external widgets for a specific blade type.
- */
-export function getExternalWidgetsForBlade(bladeId: string): IExternalWidgetRegistration[] {
-  const normalizedBladeId = bladeId.toLowerCase();
-
-  return Array.from(externalWidgets.values())
-    .filter((widget) => !widget.targetBlades || widget.targetBlades.includes(normalizedBladeId))
-    .map((widget) => ({ ...widget, targetBlades: widget.targetBlades ? [...widget.targetBlades] : undefined }));
-}
-
-/**
- * Gets all external widgets.
- */
-export function getAllExternalWidgets(): IExternalWidgetRegistration[] {
-  return Array.from(externalWidgets.values()).map((widget) => ({
-    ...widget,
-    targetBlades: widget.targetBlades ? [...widget.targetBlades] : undefined,
-  }));
-}
-
-/**
- * Deep clones a widget definition to avoid accidental shared mutations.
- */
-export function cloneWidget<T extends IWidget | IExternalWidgetRegistration>(widget: T): T {
-  return cloneDeep(widget);
-}
-
-// --- Preregistration bus ---
-
-export const widgetBus = createPreregistrationBus<IWidgetRegistration, IWidgetService>({
-  name: "widget-service",
-  getKey: (reg) => `${reg.bladeId.toLowerCase()}::${reg.widget.id}`,
-  registerIntoService: (service, reg) => service.registerWidget(reg.widget, reg.bladeId),
-});
-
-/**
- * Registers a widget before the service is initialized.
- */
-export function registerWidget(widget: IWidget, bladeId: string): void {
-  const normalizedBladeId = bladeId.toLowerCase();
-  widgetBus.preregister({
-    bladeId: normalizedBladeId,
-    widget,
-  });
-}
-
-// --- Service factory ---
-
-export function createWidgetService(): IWidgetService {
-  const bladeRegistry = createBladeScopedRegistry<IWidget, IWidgetRegistration>({
-    createRegistration: (bladeId, item) => ({ bladeId, widget: item }),
-    getRegistrationBladeId: (r) => r.bladeId,
-    getRegistrationItemId: (r) => r.widget.id,
-  });
-
-  const activeWidget = ref<{ exposed?: ComponentInternalInstance["exposed"]; widgetId: string } | undefined>();
-
-  const resolveWidgetProps = (widget: IWidget, bladeData: Record<string, unknown>): Record<string, unknown> => {
-    if (!widget.config) {
-      return widget.props || {};
-    }
-
-    let resolvedProps: Record<string, unknown> = {};
-
-    if (widget.config.propsResolver) {
-      try {
-        const customProps = widget.config.propsResolver(bladeData);
-        resolvedProps = { ...widget.props, ...customProps };
-      } catch (error) {
-        logger.error(`Error in propsResolver for widget '${widget.id}':`, error);
-        resolvedProps = { ...widget.props };
-      }
-    } else {
-      resolvedProps = { ...widget.props };
-
-      const { requiredData = [], optionalData = [], fieldMapping = {} } = widget.config;
-
-      requiredData.forEach((key) => {
-        const bladeKey = fieldMapping[key] || key;
-        if (bladeData[bladeKey] !== undefined) {
-          resolvedProps[key] = bladeData[bladeKey];
-        } else {
-          logger.warn(`Required data '${key}' not found in blade data for widget '${widget.id}'`);
-          logger.warn(`Required data '${key}' not found in blade data for widget '${widget.id}'`);
-        }
-      });
-
-      optionalData.forEach((key) => {
-        const bladeKey = fieldMapping[key] || key;
-        if (bladeData[bladeKey] !== undefined) {
-          resolvedProps[key] = bladeData[bladeKey];
-        }
-      });
-    }
-
-    return resolvedProps;
-  };
-
-  const setActiveWidget = ({
-    exposed,
-    widgetId,
-  }: {
-    widgetId: string;
-    exposed?: ComponentInternalInstance["exposed"];
-  }): void => {
-    activeWidget.value = { exposed, widgetId };
-  };
-
-  const updateActiveWidget = (): void => {
-    const widgetId = activeWidget.value?.widgetId;
-    if (!widgetId) return;
-
-    const registration = bladeRegistry.registrations.find((r) => r.widget.id === widgetId);
-
-    // Priority 1: trigger.onRefresh
-    if (registration?.widget.trigger?.onRefresh) {
-      registration.widget.trigger.onRefresh();
-      return;
-    }
-
-    // Priority 2: legacy exposed[updateFunctionName]
-    const activeExposed = activeWidget.value?.exposed as IExposedWidget | undefined;
-    const functionNameToCall = registration?.widget.updateFunctionName;
-
-    if (activeExposed && functionNameToCall && typeof activeExposed[functionNameToCall] === "function") {
-      activeExposed[functionNameToCall]();
-      return;
-    }
-
-    logger.warn(`Widget '${widgetId}' has no trigger.onRefresh and no exposed function '${functionNameToCall}'.`);
-  };
-
-  const getExternalWidgetsForBladeLocal = (bladeId: string): IExternalWidgetRegistration[] => {
-    return getExternalWidgetsForBlade(bladeId.toLowerCase());
-  };
-
-  const service: IWidgetService = {
-    registerWidget: (widget, bladeId) => bladeRegistry.register(widget, bladeId),
-    unregisterWidget: (widgetId, bladeId) => bladeRegistry.unregister(widgetId, bladeId),
-    getWidgets: (bladeId) => bladeRegistry.get(bladeId),
-    clearBladeWidgets: (bladeId) => bladeRegistry.clear(bladeId),
-    registeredWidgets: bladeRegistry.registrations,
-    isActiveWidget: (id) => activeWidget.value?.widgetId === id,
-    setActiveWidget,
-    updateActiveWidget,
-    isWidgetRegistered: (id) => bladeRegistry.isRegistered(id),
-    updateWidget: ({ id, bladeId, widget }) => bladeRegistry.update(id, bladeId, widget),
-    resolveWidgetProps,
-    getExternalWidgetsForBlade: getExternalWidgetsForBladeLocal,
-    getAllExternalWidgets,
-    cloneWidget,
-  };
-
-  widgetBus.replayInto(service);
-
-  return service;
-}

package/core/types/index.ts

@@ -1,312 +0,0 @@
-import { Component, ComputedRef, Ref } from "vue";
-import type { CoreBladeExposed } from "@shared/components/blade-navigation/types";
-import type { ComponentPublicInstanceConstructor } from "@shared/utilities/vueUtils";
-import type { IBladeInstance } from "@shared/components/blade-navigation/types";
-
-// AI Agent types are now part of the ai-agent plugin
-// export * from "./plugins/ai-agent/types";
-
-// Type instead of interface here is workaround for:
-// https://github.com/microsoft/TypeScript/issues/15300
-// (index signature is missing for interfaces in Typescript,
-// i.e. interface N { key: value } can't be casted to Record<TKey,TValue>
-// while it satisfies requirements
-export type IValidationRules = {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [x: string]: any;
-  required?: boolean;
-  numeric?: boolean;
-  email?: boolean;
-  min?: number;
-  max?: number;
-  regex?: RegExp;
-  min_value?: number;
-  max_value?: number;
-  maxdimensions?: [string | number, string | number];
-  size?: number;
-  alpha?: boolean;
-  alpha_dash?: boolean;
-  alpha_num?: boolean;
-  alpha_spaces?: boolean;
-  between?: [number, number] | { min: number; max: number };
-  confirmed?: `@${string}`;
-  digits?: number;
-  dimensions?: [number, number] | { width: number; height: number };
-  not_one_of?: [number, number];
-  ext?: string[];
-  image?: boolean;
-  integer?: boolean;
-  is?: string;
-  is_not?: string;
-  length?: number;
-  mimes?: string[];
-  one_of?: number[];
-  url?: string;
-  mindimensions?: [number, number] | { width: number; height: number };
-  fileWeight?: number;
-  before?: `@${string}`;
-  after?: `@${string}`;
-  bigint?: boolean;
-};
-
-export interface IBladeDropdownItem {
-  id: string;
-  title: string;
-  icon?: string;
-  clickHandler?(): void;
-}
-
-export interface IMenuItem<T extends Component = Component> {
-  title?: string | Ref<string>;
-  icon?: string | Component;
-  isVisible?: boolean | Ref<boolean>;
-  component?: T;
-  clickHandler?(): void;
-}
-
-export interface IBladeToolbar {
-  id?: string;
-  icon?: string | (() => string);
-  disabled?: boolean | ComputedRef<boolean | undefined>;
-  title?: string | Ref<string> | ComputedRef<string>;
-  isVisible?:
-    | boolean
-    | Ref<boolean | undefined>
-    | ComputedRef<boolean | undefined>
-    | ((blade?: IBladeInstance) => boolean | undefined);
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  clickHandler?(app?: Record<string, any> | CoreBladeExposed | null): void;
-  separator?: "left" | "right" | "both";
-  permissions?: string | string[];
-}
-
-export type ToolbarMenu<T> = T extends {
-  component?: infer C extends ComponentPublicInstanceConstructor;
-}
-  ? {
-      component?: C;
-      options?: InstanceType<C>["$props"];
-    } & IBladeToolbar
-  : T & { component?: ComponentPublicInstanceConstructor };
-
-export type NotificationTemplateConstructor = ComponentPublicInstanceConstructor & {
-  notifyType: string;
-};
-
-// eslint-disable-next-line @typescript-eslint/ban-types
-export interface IActionBuilderResult<T = {}> {
-  icon: string;
-  title: string | Ref<string>;
-  type: "danger" | "success" | "warning" | "info";
-  clickHandler(item?: T, index?: number): void;
-}
-
-export interface AssetsHandler<T extends ICommonAsset> {
-  noRemoveConfirmation?: boolean;
-  loading?: Ref<boolean>;
-  upload?: (files: FileList, startingSortOrder?: number) => Promise<T[]>;
-  edit?: (files: T[]) => T[];
-  remove?: (files: T[]) => T[];
-}
-
-export interface ICommonAsset {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  [x: string]: any;
-  sortOrder?: number;
-  title?: string | undefined;
-  name?: string | undefined;
-  url?: string | undefined;
-  readableSize?: string;
-  relativeUrl?: string | undefined;
-  description?: string | undefined;
-  modifiedDate?: Date;
-  id?: string | undefined;
-  altText?: string | undefined;
-  typeId?: string;
-  size?: number;
-  createdDate?: Date;
-}
-
-export interface RequestPasswordResult {
-  succeeded: boolean;
-  error?: string;
-  errorCode?: string;
-}
-
-/** Option for select filters */
-export interface IFilterOption {
-  value: string;
-  label: string;
-}
-
-/**
- * Column filter configuration.
- * - `true` — text filter, backend field = column.id
- * - `"fieldName"` — text filter, backend field = fieldName
- * - `{ options: [...] }` — select filter (single), backend field = column.id
- * - `{ options: [...], multiple: true }` — select filter (multi), backend field = column.id
- * - `{ field: "x", options: [...] }` — select filter, backend field = x
- * - `{ range: ["startDate", "endDate"] }` — date range filter
- */
-export type IColumnFilterConfig =
-  | true
-  | string
-  | { options: IFilterOption[]; multiple?: boolean }
-  | { field: string; options: IFilterOption[]; multiple?: boolean }
-  | { range: [string, string] };
-
-export type ITableColumnsBase = {
-  id: string;
-  title: string | ComputedRef<string>;
-  width?: number | string;
-  field?: string;
-  alwaysVisible?: boolean;
-  type?:
-    | "money"
-    | "date-ago"
-    | "date"
-    | "time"
-    | "image"
-    | "date-time"
-    | "status"
-    | "status-icon"
-    | "number"
-    | "link"
-    | "html";
-  sortable?: boolean;
-  class?: string;
-  format?: string;
-  align?: "start" | "end" | "center" | "between" | "around" | "evenly";
-  visible?: boolean;
-  editable?: boolean;
-  currencyField?: string;
-  rules?: IValidationRules;
-  /**
-   * Column filter configuration.
-   * @see IColumnFilterConfig for usage examples
-   */
-  filter?: IColumnFilterConfig;
-  // Mobile view specific fields
-  mobilePosition?: "status" | "image" | "top-left" | "top-right" | "bottom-left" | "bottom-right";
-  mobileVisible?: boolean; // Show in mobile view
-};
-
-type IImageColumn = {
-  type: "image";
-  emptyIcon?: string;
-};
-
-type IMoneyColumn = {
-  type: "money";
-  currencyField: string;
-};
-
-export type ITableColumns = ITableColumnsBase | (ITableColumnsBase & IImageColumn) | (ITableColumnsBase & IMoneyColumn);
-
-export interface MenuItem extends Omit<MenuItemConfig, "title" | "id"> {
-  priority: number;
-  routeId?: string;
-  title: string;
-  url?: string;
-  groupIcon?: string | Component;
-  groupId?: string;
-  children?: MenuItem[];
-  permissions?: string | string[];
-  id?: number | string;
-  /**
-   * Badge configuration for displaying counters or indicators on this menu item.
-   */
-  badge?: MenuItemBadgeConfig;
-}
-
-/**
- * Badge configuration for menu items.
- * Used to display counters or indicators on menu items.
- */
-export interface MenuItemBadge {
-  /**
-   * Badge content - can be a static value, ref, computed, or function returning value.
-   */
-  content?:
-    | string
-    | number
-    | Ref<string | number | undefined>
-    | ComputedRef<string | number | undefined>
-    | (() => string | number | undefined);
-  /**
-   * Badge color variant. Defaults to "primary".
-   */
-  variant?: "primary" | "success" | "warning" | "danger" | "info" | "secondary";
-  /**
-   * Show as dot indicator only (ignores content value).
-   */
-  isDot?: boolean;
-}
-
-/**
- * Badge configuration type - supports shorthand (number, ref, function) or full config object.
- */
-export type MenuItemBadgeConfig =
-  | MenuItemBadge
-  | number
-  | string
-  | Ref<number | string | undefined>
-  | ComputedRef<number | string | undefined>
-  | (() => number | string | undefined);
-
-export interface MenuItemConfig {
-  id?: string;
-  /**
-   * Menu item title.
-   */
-  title: string;
-  /**
-   * Menu item icon.
-   */
-  icon: string | Component;
-  /**
-   * Menu group icon.
-   *
-   * @deprecated Use groupConfig.icon instead for better robustness
-   */
-  groupIcon?: string | Component;
-  /**
-   * Menu item group. Is used to group menu items with it's provided name.
-   *
-   * If the path is not specified, the menu item is added to the root of the menu.
-   *
-   * @deprecated Use groupConfig instead for better robustness
-   */
-  group?: string;
-  /**
-   * Group configuration for creating or updating a group when adding this menu item.
-   * This allows creating a group and adding an item to it in one step.
-   * If a group with the specified ID already exists, it will be updated with the provided properties.
-   */
-  groupConfig?: {
-    id: string;
-    title?: string;
-    icon?: string | Component | undefined;
-    priority?: number;
-    permissions?: string | string[];
-    /**
-     * Badge configuration for the group.
-     */
-    badge?: MenuItemBadgeConfig;
-  };
-  /**
-   * Position priority.
-   */
-  priority: number;
-  /**
-   * Position priority in group
-   *
-   * @deprecated Use groupConfig.priority instead for better robustness
-   */
-  inGroupPriority?: number;
-  permissions?: string | string[];
-  /**
-   * Badge configuration for displaying counters or indicators on this menu item.
-   */
-  badge?: MenuItemBadgeConfig;
-}