orquesta-cli 0.1.12

package/src/tools/llm/simple/user-interaction-tools.ts

@@ -0,0 +1,277 @@
+/**
+ * User Interaction Tools (LLM Simple)
+ *
+ * Tools for LLM to interact with users
+ * - tell_to_user: Send message to user
+ * - ask_to_user: Ask user a question and receive response
+ */
+
+import { LLMSimpleTool, ToolResult, ToolCategory } from '../../types.js';
+import { ToolDefinition } from '../../../types/index.js';
+import { logger } from '../../../utils/logger.js';
+
+// ============================================
+// tell_to_user Tool
+// ============================================
+
+/**
+ * Callback for tell_to_user messages
+ */
+type TellToUserCallback = (message: string) => void;
+let tellToUserCallback: TellToUserCallback | null = null;
+
+/**
+ * Set callback for tell_to_user messages
+ */
+export function setTellToUserCallback(callback: TellToUserCallback | null): void {
+  tellToUserCallback = callback;
+}
+
+/**
+ * tell_to_user Tool Definition
+ */
+const TELL_TO_USER_DEFINITION: ToolDefinition = {
+  type: 'function',
+  function: {
+    name: 'tell_to_user',
+    description: `Send a message directly to the user to explain what you're doing or provide status updates.
+Use this tool to communicate with the user during task execution.
+The message will be displayed immediately in the UI.`,
+    parameters: {
+      type: 'object',
+      properties: {
+        message: {
+          type: 'string',
+          description: `A natural, conversational message for the user (in user's language).
+Examples:
+- "Analyzing the files, please wait a moment"
+- "Found the config file! Let me modify it now"
+- "Ran the tests and 2 failed. Let me find the cause"
+- "Almost done, wrapping up the work"`,
+        },
+      },
+      required: ['message'],
+    },
+  },
+};
+
+/**
+ * Execute tell_to_user
+ */
+async function executeTellToUser(args: Record<string, unknown>): Promise<ToolResult> {
+  const message = args['message'] as string;
+
+  if (tellToUserCallback) {
+    tellToUserCallback(message);
+  }
+
+  return {
+    success: true,
+    result: `Message sent to user: ${message}`,
+  };
+}
+
+/**
+ * tell_to_user LLM Simple Tool
+ */
+export const tellToUserTool: LLMSimpleTool = {
+  definition: TELL_TO_USER_DEFINITION,
+  execute: executeTellToUser,
+  categories: ['llm-simple'] as ToolCategory[],
+  description: 'Send message to user',
+};
+
+// ============================================
+// ask_to_user Tool
+// ============================================
+
+/**
+ * User question request
+ */
+export interface AskUserRequest {
+  question: string;
+  options: string[];
+}
+
+/**
+ * User response
+ */
+export interface AskUserResponse {
+  selectedOption: string;
+  isOther: boolean;
+  customText?: string;
+}
+
+/**
+ * User question callback type
+ */
+export type AskUserCallback = (request: AskUserRequest) => Promise<AskUserResponse>;
+
+let askUserCallback: AskUserCallback | null = null;
+
+/**
+ * Set the ask-user callback
+ */
+export function setAskUserCallback(callback: AskUserCallback): void {
+  logger.flow('Setting ask-user callback');
+  askUserCallback = callback;
+}
+
+/**
+ * Clear ask-user callback
+ */
+export function clearAskUserCallback(): void {
+  logger.flow('Clearing ask-user callback');
+  askUserCallback = null;
+}
+
+/**
+ * Check if ask-user callback is available
+ */
+export function hasAskUserCallback(): boolean {
+  return askUserCallback !== null;
+}
+
+/**
+ * ask_to_user Tool Definition
+ */
+const ASK_TO_USER_DEFINITION: ToolDefinition = {
+  type: 'function',
+  function: {
+    name: 'ask_to_user',
+    description: `Ask the user a question with multiple choice options.
+
+Use this tool when you need to:
+- Clarify ambiguous requirements
+- Get user preferences or decisions
+- Confirm important actions before proceeding
+- Offer multiple implementation approaches
+
+The user will always have an "Other (custom input)" option to provide custom input,
+so you only need to provide the main choices.
+
+RULES:
+- Provide 2-4 clear, distinct options
+- Each option should be a viable choice
+- Keep the question concise and specific
+- "Other" option is automatically added for custom input`,
+    parameters: {
+      type: 'object',
+      properties: {
+        question: {
+          type: 'string',
+          description: 'The question to ask the user. Should be clear and specific.',
+        },
+        options: {
+          type: 'array',
+          items: { type: 'string' },
+          description: 'List of main options for the user to choose from. Provide 2-4 options. An "Other" option for custom input is automatically added.',
+          minItems: 2,
+          maxItems: 4,
+        },
+      },
+      required: ['question', 'options'],
+    },
+  },
+};
+
+/**
+ * Execute ask_to_user
+ */
+async function executeAskToUser(args: Record<string, unknown>): Promise<ToolResult> {
+  logger.enter('executeAskToUser', args);
+
+  const question = args['question'] as string;
+  const options = args['options'] as string[];
+
+  // Validate inputs
+  if (!question || typeof question !== 'string') {
+    logger.warn('Invalid question parameter');
+    return {
+      success: false,
+      error: 'Invalid question: must be a non-empty string',
+    };
+  }
+
+  if (!Array.isArray(options) || options.length < 2) {
+    logger.warn('Invalid options parameter', { optionsLength: options?.length });
+    return {
+      success: false,
+      error: 'Invalid options: must be an array with at least 2 items',
+    };
+  }
+
+  if (options.length > 4) {
+    logger.warn('Too many options', { optionsLength: options.length });
+    return {
+      success: false,
+      error: 'Too many options: maximum 4 options allowed',
+    };
+  }
+
+  if (!askUserCallback) {
+    logger.warn('Ask-user callback not set');
+    return {
+      success: false,
+      error: 'User interaction is not available in current context',
+    };
+  }
+
+  try {
+    logger.flow('Asking user question');
+    const response = await askUserCallback({ question, options });
+
+    logger.debug('User responded', { selectedOption: response.selectedOption, isOther: response.isOther });
+
+    const resultText = response.isOther && response.customText
+      ? `User provided custom response: "${response.customText}"`
+      : `User selected: "${response.selectedOption}"`;
+
+    logger.exit('executeAskToUser', { success: true });
+    return {
+      success: true,
+      result: resultText,
+      metadata: {
+        question,
+        selectedOption: response.selectedOption,
+        isOther: response.isOther,
+        customText: response.customText,
+      },
+    };
+  } catch (error) {
+    logger.error('Error asking user', error as Error);
+    return {
+      success: false,
+      error: `Error asking user: ${error instanceof Error ? error.message : 'Unknown error'}`,
+    };
+  }
+}
+
+/**
+ * ask_to_user LLM Simple Tool
+ */
+export const askToUserTool: LLMSimpleTool = {
+  definition: ASK_TO_USER_DEFINITION,
+  execute: executeAskToUser,
+  categories: ['llm-simple'] as ToolCategory[],
+  description: 'Ask user a question with options',
+};
+
+// ============================================
+// Exports
+// ============================================
+
+/**
+ * All user interaction tools
+ */
+export const USER_INTERACTION_TOOLS: LLMSimpleTool[] = [
+  tellToUserTool,
+  askToUserTool,
+];
+
+/**
+ * USER_TOOLS alias for backward compatibility (Electron parity)
+ */
+export const USER_TOOLS: LLMSimpleTool[] = USER_INTERACTION_TOOLS;
+
+export default USER_INTERACTION_TOOLS;

package/src/tools/office/common/constants.ts

@@ -0,0 +1,335 @@
+/**
+ * Office Common Constants
+ *
+ * Shared constants for Office tools (Word, Excel, PowerPoint)
+ */
+
+import * as path from 'path';
+import { LOCAL_HOME_DIR } from '../../../constants.js';
+import { ToolCategory } from '../../types.js';
+
+// =============================================================================
+// Directory Constants
+// =============================================================================
+
+/**
+ * Directory for storing Office screenshots
+ */
+export const OFFICE_SCREENSHOT_DIR = path.join(LOCAL_HOME_DIR, 'screenshots', 'office');
+
+/**
+ * User-friendly path description for screenshots
+ */
+export const OFFICE_SCREENSHOT_PATH_DESC = '~/.local-cli/screenshots/office/';
+
+// =============================================================================
+// Tool Category Constants
+// =============================================================================
+
+/**
+ * Default categories for Office tools
+ */
+export const OFFICE_CATEGORIES: ToolCategory[] = ['llm-simple'];
+
+// =============================================================================
+// Word Alignment Constants
+// =============================================================================
+
+/**
+ * Word paragraph alignment values (wdParagraphAlignment)
+ */
+export const WORD_PARAGRAPH_ALIGNMENT = {
+  left: 0,      // wdAlignParagraphLeft
+  center: 1,    // wdAlignParagraphCenter
+  right: 2,     // wdAlignParagraphRight
+  justify: 3,   // wdAlignParagraphJustify
+} as const;
+
+/**
+ * Word page number alignment values (wdPageNumberAlignment)
+ */
+export const WORD_PAGE_NUMBER_ALIGNMENT = {
+  left: 0,      // wdAlignPageNumberLeft
+  center: 1,    // wdAlignPageNumberCenter
+  right: 2,     // wdAlignPageNumberRight
+} as const;
+
+// =============================================================================
+// Excel Alignment Constants
+// =============================================================================
+
+/**
+ * Excel horizontal alignment values (xlHAlign)
+ */
+export const EXCEL_HORIZONTAL_ALIGNMENT = {
+  left: -4131,    // xlLeft
+  center: -4108,  // xlCenter
+  right: -4152,   // xlRight
+} as const;
+
+/**
+ * Excel vertical alignment values (xlVAlign)
+ */
+export const EXCEL_VERTICAL_ALIGNMENT = {
+  top: -4160,     // xlTop
+  center: -4108,  // xlCenter
+  bottom: -4107,  // xlBottom
+} as const;
+
+// =============================================================================
+// PowerPoint Alignment Constants
+// =============================================================================
+
+/**
+ * PowerPoint text horizontal alignment values (ppParagraphAlignment)
+ */
+export const POWERPOINT_HORIZONTAL_ALIGNMENT = {
+  left: 1,      // ppAlignLeft
+  center: 2,    // ppAlignCenter
+  right: 3,     // ppAlignRight
+  justify: 4,   // ppAlignJustify
+} as const;
+
+/**
+ * PowerPoint text vertical alignment values (msoVerticalAnchor)
+ */
+export const POWERPOINT_VERTICAL_ALIGNMENT = {
+  top: 1,       // msoAnchorTop
+  middle: 3,    // msoAnchorMiddle
+  bottom: 4,    // msoAnchorBottom
+} as const;
+
+/**
+ * PowerPoint shape alignment values (msoAlignCmd)
+ */
+export const POWERPOINT_SHAPE_ALIGNMENT = {
+  left: 0,      // msoAlignLefts
+  center: 1,    // msoAlignCenters
+  right: 2,     // msoAlignRights
+  top: 3,       // msoAlignTops
+  middle: 4,    // msoAlignMiddles
+  bottom: 5,    // msoAlignBottoms
+} as const;
+
+/**
+ * PowerPoint shape distribution values (msoDistributeCmd)
+ */
+export const POWERPOINT_DISTRIBUTE = {
+  horizontal: 0,  // msoDistributeHorizontally
+  vertical: 1,    // msoDistributeVertically
+} as const;
+
+// =============================================================================
+// Excel Chart Type Constants
+// =============================================================================
+
+/**
+ * Excel chart types (xlChartType)
+ */
+export const EXCEL_CHART_TYPES = {
+  column: 51,      // xlColumnClustered
+  bar: 57,         // xlBarClustered
+  line: 4,         // xlLine
+  pie: 5,          // xlPie
+  area: 1,         // xlArea
+  scatter: -4169,  // xlXYScatter
+  doughnut: -4120, // xlDoughnut
+} as const;
+
+// =============================================================================
+// Excel Border Constants
+// =============================================================================
+
+/**
+ * Excel border line styles (xlLineStyle)
+ */
+export const EXCEL_BORDER_STYLES = {
+  thin: 1,        // xlContinuous
+  medium: 1,      // xlContinuous (weight differs)
+  thick: 1,       // xlContinuous (weight differs)
+  double: -4119,  // xlDouble
+  dotted: -4118,  // xlDot
+  dashed: -4115,  // xlDash
+} as const;
+
+/**
+ * Excel border weights (xlBorderWeight)
+ */
+export const EXCEL_BORDER_WEIGHTS = {
+  thin: 2,        // xlThin
+  medium: -4138,  // xlMedium
+  thick: 4,       // xlThick
+  double: 2,      // xlThin
+  dotted: 2,      // xlThin
+  dashed: 2,      // xlThin
+} as const;
+
+/**
+ * Excel border edge indices (xlBordersIndex)
+ */
+export const EXCEL_BORDER_EDGES = {
+  left: 7,        // xlEdgeLeft
+  right: 10,      // xlEdgeRight
+  top: 8,         // xlEdgeTop
+  bottom: 9,      // xlEdgeBottom
+  all: -1,        // Special value for all borders
+} as const;
+
+// =============================================================================
+// Excel Conditional Format Constants
+// =============================================================================
+
+/**
+ * Excel conditional format types (xlFormatConditionType)
+ */
+export const EXCEL_CONDITION_TYPES = {
+  cellValue: 1,   // xlCellValue
+  colorScale: 3,  // xlColorScale
+  dataBar: 4,     // xlDataBar
+  iconSet: 6,     // xlIconSet
+  duplicates: 8,  // xlUniqueValues
+  top10: 5,       // xlTop10
+} as const;
+
+/**
+ * Excel comparison operators (xlFormatConditionOperator)
+ */
+export const EXCEL_COMPARISON_OPERATORS = {
+  greater: 5,     // xlGreater
+  less: 6,        // xlLess
+  equal: 3,       // xlEqual
+  between: 1,     // xlBetween
+  notBetween: 2,  // xlNotBetween
+} as const;
+
+// =============================================================================
+// Excel Data Validation Constants
+// =============================================================================
+
+/**
+ * Excel data validation types (xlDVType)
+ */
+export const EXCEL_VALIDATION_TYPES = {
+  list: 3,        // xlValidateList
+  whole: 1,       // xlValidateWholeNumber
+  decimal: 2,     // xlValidateDecimal
+  date: 4,        // xlValidateDate
+  textLength: 6,  // xlValidateTextLength
+  custom: 7,      // xlValidateCustom
+} as const;
+
+/**
+ * Excel data validation operators (xlFormatConditionOperator)
+ */
+export const EXCEL_VALIDATION_OPERATORS = {
+  between: 1,
+  notBetween: 2,
+  equal: 3,
+  notEqual: 4,
+  greater: 5,
+  less: 6,
+  greaterEqual: 7,
+  lessEqual: 8,
+} as const;
+
+// =============================================================================
+// PowerPoint Animation Constants
+// =============================================================================
+
+/**
+ * PowerPoint animation effect types (msoAnimEffect)
+ */
+export const POWERPOINT_ANIMATION_EFFECTS = {
+  appear: 1,            // msoAnimEffectAppear
+  fade: 10,             // msoAnimEffectFade
+  fly_in: 2,            // msoAnimEffectFly
+  float_in: 42,         // msoAnimEffectFloat
+  split: 21,            // msoAnimEffectSplit
+  wipe: 22,             // msoAnimEffectWipe
+  shape: 31,            // msoAnimEffectShape (Circle)
+  wheel: 36,            // msoAnimEffectWheel
+  random_bars: 15,      // msoAnimEffectRandomBars
+  grow_and_turn: 26,    // msoAnimEffectGrowAndTurn
+  zoom: 39,             // msoAnimEffectZoom
+  swivel: 20,           // msoAnimEffectSwivel
+  bounce: 25,           // msoAnimEffectBounce
+} as const;
+
+// =============================================================================
+// PowerPoint Transition Constants
+// =============================================================================
+
+/**
+ * PowerPoint slide transition types (ppEntryEffect)
+ */
+export const POWERPOINT_TRANSITION_TYPES = {
+  none: 0,
+  fade: 1197,           // ppEffectFade
+  push: 1228,           // ppEffectPush
+  wipe: 1212,           // ppEffectWipe
+  split: 1217,          // ppEffectSplit
+  reveal: 1204,         // ppEffectReveal
+  random_bars: 1243,    // ppEffectRandomBars
+  shape: 1221,          // ppEffectShape (circle)
+  uncover: 1227,        // ppEffectUncover
+  cover: 1218,          // ppEffectCover
+  flash: 1248,          // ppEffectFlash
+} as const;
+
+// =============================================================================
+// PowerPoint Shape Types
+// =============================================================================
+
+/**
+ * PowerPoint AutoShape types (msoAutoShapeType)
+ */
+export const POWERPOINT_SHAPE_TYPES = {
+  rectangle: 1,         // msoShapeRectangle
+  rounded_rectangle: 5, // msoShapeRoundedRectangle
+  oval: 9,              // msoShapeOval
+  diamond: 4,           // msoShapeDiamond
+  triangle: 7,          // msoShapeIsoscelesTriangle
+  right_triangle: 6,    // msoShapeRightTriangle
+  pentagon: 51,         // msoShapePentagon
+  hexagon: 52,          // msoShapeHexagon
+  arrow_right: 33,      // msoShapeRightArrow
+  arrow_left: 34,       // msoShapeLeftArrow
+  arrow_up: 35,         // msoShapeUpArrow
+  arrow_down: 36,       // msoShapeDownArrow
+  star_5: 12,           // msoShape5pointStar
+  star_6: 58,           // msoShape6pointStar
+  heart: 21,            // msoShapeHeart
+  lightning: 22,        // msoShapeLightningBolt
+  callout: 41,          // msoShapeRectangularCallout
+} as const;
+
+// =============================================================================
+// PowerPoint Chart Type Constants
+// =============================================================================
+
+/**
+ * PowerPoint chart types (xlChartType - same as Excel)
+ */
+export const POWERPOINT_CHART_TYPES = EXCEL_CHART_TYPES;
+
+// =============================================================================
+// Word Break Types
+// =============================================================================
+
+/**
+ * Word break types (wdBreakType)
+ */
+export const WORD_BREAK_TYPES = {
+  page: 7,        // wdPageBreak
+  line: 6,        // wdLineBreak
+  section: 2,     // wdSectionBreakNextPage
+} as const;
+
+// =============================================================================
+// Word Shape Types
+// =============================================================================
+
+/**
+ * Word AutoShape types (msoAutoShapeType) - same as PowerPoint
+ */
+export const WORD_SHAPE_TYPES = POWERPOINT_SHAPE_TYPES;