@vc-shell/framework 1.2.3-beta.0 → 1.2.3

package/core/plugins/ai-agent/types.ts

@@ -1,310 +0,0 @@
-import { ComputedRef, Ref } from "vue";
-
-// ============================================
-// Core Types
-// ============================================
-
-/**
- * Context type for AI agent - determines UI behavior in chatbot
- * - 'list': Multiple selected items from a list blade (shows "X items selected" badge)
- * - 'details': Single item being edited in details blade (shows suggestions UI)
- */
-export type AiAgentContextType = "list" | "details";
-
-/**
- * Suggestion card for AI agent
- */
-export interface ISuggestion {
-  /** Unique identifier */
-  id: string;
-  /** Display title */
-  title: string;
-  /** Icon name */
-  icon: string;
-  /** Icon color (optional) */
-  iconColor?: string;
-  /** Prompt text to send when clicked */
-  prompt: string;
-}
-
-/**
- * Options for useAiAgentContext composable
- */
-export interface UseAiAgentContextOptions<T = Record<string, unknown>> {
-  /**
-   * Ref with data - accepts both formats:
-   * - Ref<T> for DETAILS blade (single object, will be wrapped in array internally)
-   * - Ref<T[]> for LIST blade (array of selected objects)
-   *
-   * When AI agent sends changes back, they will be applied to:
-   * - The object directly (for single-object refs)
-   * - The first item in array (for array refs)
-   */
-  dataRef: Ref<T> | Ref<T[]>;
-
-  /** Custom suggestions for this blade */
-  suggestions?: ISuggestion[];
-}
-
-/**
- * Return type for useAiAgentContext composable
- */
-export interface UseAiAgentContextReturn {
-  /** Preview state (for details blades) */
-  previewState: {
-    isActive: ComputedRef<boolean>;
-    changedFields: ComputedRef<string[]>;
-  };
-}
-
-// ============================================
-// AI Agent Panel Types
-// ============================================
-
-/**
- * State of the AI agent panel
- */
-export type AiAgentPanelState = "closed" | "open" | "expanded";
-
-/**
- * Configuration for the AI agent panel
- */
-export interface IAiAgentConfig {
-  /** URL of the AI agent iframe */
-  url: string;
-  /** Panel title (default: "Virto OZ") */
-  title?: string;
-  /** Panel width in pixels when open (default: 350) */
-  width?: number;
-  /** Panel width in pixels when expanded (default: 500) */
-  expandedWidth?: number;
-  /** Allowed origins for postMessage (default: ["*"]) */
-  allowedOrigins?: string[];
-  /**
-   * Tenant identifier for the platform instance.
-   * This should be a static value identifying the platform installation (e.g., "virto", "acme-corp").
-   * Configured by the host application via VirtoShellFramework options.
-   *
-   */
-  tenantId?: string;
-}
-
-/**
- * Current blade information for AI context
- */
-export interface IAiAgentBladeContext {
-  /** Blade identifier */
-  id: string;
-  /** Blade component name */
-  name: string;
-  /** Blade display title */
-  title?: string;
-  /** Route parameter (e.g., item ID being edited) */
-  param?: string;
-  /** Additional blade options */
-  options?: Record<string, unknown>;
-}
-
-/**
- * User information for AI context
- */
-export interface IAiAgentUserContext {
-  id?: string;
-  userName?: string;
-  isAdministrator?: boolean;
-  permissions?: string[];
-}
-
-/**
- * Full context passed to the AI agent
- */
-export interface IAiAgentContext {
-  /** Current user information */
-  user: IAiAgentUserContext | undefined;
-  /** Current active blade information */
-  currentBlade: IAiAgentBladeContext | null;
-  /** Data items (from useAiAgentContext) */
-  items: Record<string, unknown>[];
-  /** Timestamp of context generation */
-  timestamp: number;
-}
-
-/**
- * Service for managing AI agent state and communication
- */
-export interface IAiAgentService {
-  /** Current panel state */
-  panelState: Ref<AiAgentPanelState>;
-  /** Panel configuration */
-  config: Ref<IAiAgentConfig>;
-  /** Current context (reactive) */
-  context: ComputedRef<IAiAgentContext>;
-  /** Whether panel is open (not closed) */
-  isOpen: ComputedRef<boolean>;
-  /** Whether panel is in expanded state */
-  isExpanded: ComputedRef<boolean>;
-  /** Total count of items in current context */
-  totalItemsCount: ComputedRef<number>;
-
-  /** Open the AI panel */
-  openPanel: () => void;
-  /** Close the AI panel */
-  closePanel: () => void;
-  /** Toggle panel open/close */
-  togglePanel: () => void;
-  /** Expand the panel to larger width */
-  expandPanel: () => void;
-  /** Collapse panel to normal width */
-  collapsePanel: () => void;
-
-  /** Update configuration */
-  setConfig: (config: Partial<IAiAgentConfig>) => void;
-
-  /** Send message to AI agent iframe */
-  sendMessage: (type: AiAgentMessageType, payload: unknown) => void;
-  /** Register message handler, returns unsubscribe function */
-  onMessage: (handler: (event: IAiAgentMessage) => void) => () => void;
-}
-
-// ============================================
-// PostMessage Protocol Types
-// ============================================
-
-/**
- * Message types sent from Shell to Chatbot
- */
-export type ShellToChatMessageType =
-  | "INIT_CONTEXT" // Initial context when chatbot loads
-  | "UPDATE_CONTEXT"; // Context updates (items, blade changes)
-
-/**
- * Message types sent from Chatbot to Shell
- */
-export type ChatToShellMessageType =
-  | "CHAT_READY" // Chatbot is loaded and ready
-  | "NAVIGATE_TO_APP" // Request to navigate to a blade
-  | "EXPAND_IN_CHAT" // Request to expand item in chat
-  | "RELOAD_BLADE" // Request to reload current blade
-  | "PREVIEW_CHANGES" // Request to preview changes in form
-  | "APPLY_CHANGES" // Request to apply data changes
-  | "DOWNLOAD_FILE" // Request to download file
-  | "SHOW_MORE" // Request for more results
-  | "CHAT_ERROR"; // Error notification
-
-/**
- * Combined message types
- */
-export type AiAgentMessageType = ShellToChatMessageType | ChatToShellMessageType;
-
-/**
- * Generic message type (for handlers)
- */
-export interface IAiAgentMessage<T = unknown> {
-  /** Message type identifier */
-  type: AiAgentMessageType;
-  /** Message payload */
-  payload?: T;
-  /** Message timestamp (optional) */
-  timestamp?: number;
-}
-
-// ============================================
-// Specific Message Payloads
-// ============================================
-
-/**
- * Blade context for chatbot (simplified for chat use)
- */
-export interface IChatBladeContext {
-  /** Blade identifier */
-  id: string;
-  /** Blade component name */
-  name: string;
-  /** Blade display title */
-  title: string;
-  /** Route parameter (e.g., item ID being edited) */
-  param?: string;
-}
-
-/** Payload for INIT_CONTEXT message (Shell -> Chat) */
-export interface IInitContextPayload {
-  /** Current user ID */
-  userId: string;
-  /** User locale */
-  locale: string;
-  /** Tenant identifier (from JWT or host app) */
-  tenantId?: string;
-  /** Current blade context */
-  blade: IChatBladeContext;
-  /** Context type - determines chatbot UI behavior */
-  contextType: AiAgentContextType;
-  /** Data items - always array (1 for details, N for list) */
-  items: Record<string, unknown>[];
-  /** Custom suggestions (if any) */
-  suggestions?: ISuggestion[];
-  /** Access token for API calls (automatically refreshed) */
-  accessToken?: string;
-}
-
-/** Payload for UPDATE_CONTEXT message (Shell -> Chat) */
-export interface IUpdateContextPayload {
-  /** Updated blade context (if changed) */
-  blade?: IChatBladeContext;
-  /** Tenant identifier (from JWT or host app) */
-  tenantId?: string;
-  /** Context type - determines chatbot UI behavior */
-  contextType: AiAgentContextType;
-  /** Data items - always array of full objects */
-  items: Record<string, unknown>[];
-  /** Custom suggestions (if changed) */
-  suggestions?: ISuggestion[];
-  /** Updated user locale (if changed) */
-  locale?: string;
-  /** Access token for API calls (automatically refreshed) */
-  accessToken?: string;
-}
-
-/** Payload for NAVIGATE_TO_APP message (Chat -> Shell) */
-export interface INavigateToAppPayload {
-  /** Blade name to open */
-  bladeName: string;
-  /** Entity ID */
-  param?: string;
-  /** Additional options */
-  options?: Record<string, unknown>;
-}
-
-/** Payload for PREVIEW_CHANGES message (Chat -> Shell) */
-export interface IPreviewChangesPayload {
-  /** Updated data to preview */
-  data: Record<string, unknown>;
-  /** List of changed field names */
-  changedFields?: string[];
-}
-
-/** Payload for APPLY_CHANGES message (Chat -> Shell) */
-export interface IApplyChangesPayload {
-  changes: Array<{
-    entityId: string;
-    entityType: string;
-    field: string;
-    oldValue: unknown;
-    newValue: unknown;
-  }>;
-}
-
-/** Payload for DOWNLOAD_FILE message (Chat -> Shell) */
-export interface IDownloadFilePayload {
-  /** Filename for download */
-  filename: string;
-  /** MIME type */
-  contentType: string;
-  /** Base64 encoded content */
-  content: string;
-}
-
-/** Payload for CHAT_ERROR message (Chat -> Shell) */
-export interface IChatErrorPayload {
-  code: string;
-  message: string;
-}

package/core/types/services.ts

@@ -1,194 +0,0 @@
-import type { App, Ref } from "vue";
-
-/**
- * Service lifecycle interface for managing service creation and cleanup
- */
-export interface ServiceLifecycle<T> {
-  /**
-   * Creates a new instance of the service
-   */
-  create(): T;
-
-  /**
-   * Provides the service to the Vue application
-   */
-  provide(app: App): void;
-
-  /**
-   * Cleanup function called when the service is no longer needed
-   */
-  cleanup(): void;
-}
-
-/**
- * Interface for services that support pre-registration of items
- * before the service is fully initialized
- */
-export interface PreregistrationQueue<T> {
-  /**
-   * Items waiting to be registered
-   */
-  readonly items: readonly T[];
-
-  /**
-   * Register an item to be processed when the service initializes
-   */
-  register(item: T): void;
-
-  /**
-   * Flush all pending items and return them for processing
-   */
-  flush(): T[];
-
-  /**
-   * Clear the queue without processing
-   */
-  clear(): void;
-}
-
-/**
- * Base interface for registry-type services
- */
-export interface RegistryService<TKey, TItem> {
-  /**
-   * Register a new item in the registry
-   */
-  register(key: TKey, item: TItem): void;
-
-  /**
-   * Unregister an item from the registry
-   */
-  unregister(key: TKey): boolean;
-
-  /**
-   * Get an item by its key
-   */
-  get(key: TKey): TItem | undefined;
-
-  /**
-   * Check if an item exists in the registry
-   */
-  has(key: TKey): boolean;
-
-  /**
-   * Get all registered items
-   */
-  getAll(): Map<TKey, TItem>;
-
-  /**
-   * Clear all items from the registry
-   */
-  clear(): void;
-}
-
-/**
- * Interface for services that provide reactive lists
- */
-export interface ListService<T> {
-  /**
-   * Reactive reference to the list items
-   */
-  items: Ref<T[]>;
-
-  /**
-   * Add an item to the list
-   */
-  add(item: T): void;
-
-  /**
-   * Remove an item from the list
-   */
-  remove(item: T): boolean;
-
-  /**
-   * Find an item in the list
-   */
-  find(predicate: (item: T) => boolean): T | undefined;
-
-  /**
-   * Filter items in the list
-   */
-  filter(predicate: (item: T) => boolean): T[];
-}
-
-/**
- * Interface for services with ordered items
- */
-export interface OrderedListService<T> extends ListService<T> {
-  /**
-   * Reorder an item to a new position
-   */
-  reorder(fromIndex: number, toIndex: number): void;
-
-  /**
-   * Get items sorted by priority
-   */
-  getSorted(): T[];
-}
-
-/**
- * Result type for async service operations
- */
-export interface ServiceResult<T> {
-  success: boolean;
-  data?: T;
-  error?: {
-    code: string;
-    message: string;
-    details?: Record<string, unknown>;
-  };
-}
-
-/**
- * Interface for services that support subscription to changes
- */
-export interface ObservableService<T> {
-  /**
-   * Subscribe to changes
-   */
-  subscribe(callback: (value: T) => void): () => void;
-
-  /**
-   * Get the current value
-   */
-  getValue(): T;
-}
-
-/**
- * Type for widget registration
- */
-export interface WidgetRegistration<TProps = Record<string, unknown>> {
-  id: string;
-  component: unknown;
-  props?: TProps;
-  order?: number;
-  isVisible?: boolean | (() => boolean);
-}
-
-/**
- * Type for menu item registration
- */
-export interface MenuItemRegistration {
-  id: string;
-  title: string;
-  icon?: string;
-  priority?: number;
-  permissions?: string | string[];
-  routeId?: string;
-  url?: string;
-  group?: string;
-  children?: MenuItemRegistration[];
-}
-
-/**
- * Type for toolbar item registration
- */
-export interface ToolbarItemRegistration {
-  id: string;
-  title: string;
-  icon?: string;
-  order?: number;
-  disabled?: boolean;
-  clickHandler?: () => void;
-  permissions?: string | string[];
-}

package/core/utilities/errorTypes.ts

@@ -1,126 +0,0 @@
-/**
- * Base error class for VC-Shell framework
- * Provides structured error handling with error codes and context
- */
-export class FrameworkError extends Error {
-  constructor(
-    message: string,
-    public readonly code: string,
-    public readonly context?: Record<string, unknown>,
-  ) {
-    super(message);
-    this.name = "FrameworkError";
-
-    // Maintains proper stack trace for where our error was thrown (only available on V8)
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, FrameworkError);
-    }
-  }
-
-  toJSON() {
-    return {
-      name: this.name,
-      code: this.code,
-      message: this.message,
-      context: this.context,
-      stack: this.stack,
-    };
-  }
-}
-
-/**
- * Error thrown when validation fails
- */
-export class ValidationError extends FrameworkError {
-  constructor(message: string, context?: Record<string, unknown>) {
-    super(message, "VALIDATION_ERROR", context);
-    this.name = "ValidationError";
-  }
-}
-
-/**
- * Error thrown when a service operation fails
- */
-export class ServiceError extends FrameworkError {
-  constructor(message: string, context?: Record<string, unknown>) {
-    super(message, "SERVICE_ERROR", context);
-    this.name = "ServiceError";
-  }
-}
-
-/**
- * Error thrown when a required dependency is not provided
- */
-export class InjectionError extends FrameworkError {
-  constructor(serviceName: string, context?: Record<string, unknown>) {
-    super(`${serviceName} not provided. Make sure to call the corresponding 'provide' function.`, "INJECTION_ERROR", {
-      serviceName,
-      ...context,
-    });
-    this.name = "InjectionError";
-  }
-}
-
-/**
- * Error thrown when component registration fails
- */
-export class RegistrationError extends FrameworkError {
-  constructor(componentName: string, reason: string, context?: Record<string, unknown>) {
-    super(`Failed to register '${componentName}': ${reason}`, "REGISTRATION_ERROR", {
-      componentName,
-      ...context,
-    });
-    this.name = "RegistrationError";
-  }
-}
-
-/**
- * Error thrown when a blade operation fails
- */
-export class BladeError extends FrameworkError {
-  constructor(message: string, bladeId?: string, context?: Record<string, unknown>) {
-    super(message, "BLADE_ERROR", {
-      bladeId,
-      ...context,
-    });
-    this.name = "BladeError";
-  }
-}
-
-/**
- * Error thrown when module loading fails
- */
-export class ModuleLoadError extends FrameworkError {
-  constructor(moduleId: string, reason: string, context?: Record<string, unknown>) {
-    super(`Failed to load module '${moduleId}': ${reason}`, "MODULE_LOAD_ERROR", {
-      moduleId,
-      ...context,
-    });
-    this.name = "ModuleLoadError";
-  }
-}
-
-/**
- * Type guard to check if an error is a FrameworkError
- */
-export function isFrameworkError(error: unknown): error is FrameworkError {
-  return error instanceof FrameworkError;
-}
-
-/**
- * Wraps an unknown error into a FrameworkError
- */
-export function wrapError(error: unknown, code = "UNKNOWN_ERROR"): FrameworkError {
-  if (isFrameworkError(error)) {
-    return error;
-  }
-
-  if (error instanceof Error) {
-    return new FrameworkError(error.message, code, {
-      originalError: error.name,
-      stack: error.stack,
-    });
-  }
-
-  return new FrameworkError(String(error), code);
-}