@jshookmcp/jshook 0.2.2 → 0.2.5

package/dist/src/server/domains/browser/definitions.tools.behavior.js

@@ -1,229 +1,122 @@
+import { tool } from '../../registry/tool-builder.js';
 export const behaviorTools = [
-    {
-        name: 'human_mouse',
-        description: 'Move the mouse along a natural Bezier curve path with random jitter.\n\n' +
-            'Simulates human-like mouse movement using cubic Bezier curves with:\n' +
-            '- Non-linear speed (ease-in-out)\n' +
-            '- Configurable jitter/noise\n' +
-            '- Viewport-clamped trajectory\n\n' +
-            'Use this before page_click for anti-bot bypass on browser-check or widget challenges.\n\n' +
-            'Example:\n' +
-            '  human_mouse({ toX: 500, toY: 300, durationMs: 800 })',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                fromX: {
-                    type: 'number',
-                    description: 'Start X coordinate (default: current mouse position or 0)',
-                },
-                fromY: {
-                    type: 'number',
-                    description: 'Start Y coordinate (default: current mouse position or 0)',
-                },
-                toX: { type: 'number', description: 'Target X coordinate' },
-                toY: { type: 'number', description: 'Target Y coordinate' },
-                selector: {
-                    type: 'string',
-                    description: 'CSS selector to move to (alternative to toX/toY — auto-resolves element center)',
-                },
-                durationMs: {
-                    type: 'number',
-                    description: 'Movement duration in ms (default: 600)',
-                    default: 600,
-                },
-                steps: {
-                    type: 'integer',
-                    description: 'Number of intermediate points (default: 24)',
-                    default: 24,
-                },
-                jitterPx: {
-                    type: 'number',
-                    description: 'Max random offset per step in pixels (default: 1.5)',
-                    default: 1.5,
-                },
-                curve: {
-                    type: 'string',
-                    enum: ['ease', 'linear', 'ease-in', 'ease-out'],
-                    description: 'Speed curve (default: ease)',
-                    default: 'ease',
-                },
-                click: {
-                    type: 'boolean',
-                    description: 'Click at destination after movement (default: false)',
-                    default: false,
-                },
-            },
-        },
-    },
-    {
-        name: 'human_scroll',
-        description: 'Scroll the page with human-like behavior: variable speed, micro-pauses, and deceleration.\n\n' +
-            'Simulates natural scrolling patterns:\n' +
-            '- Segmented scroll with random segment sizes\n' +
-            '- Brief pauses between segments\n' +
-            '- Velocity deceleration near the end\n\n' +
-            'Example:\n' +
-            '  human_scroll({ distance: 1000, direction: "down", durationMs: 2000 })',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                distance: {
-                    type: 'number',
-                    description: 'Total scroll distance in pixels (default: 500)',
-                    default: 500,
-                },
-                direction: {
-                    type: 'string',
-                    enum: ['up', 'down', 'left', 'right'],
-                    description: 'Scroll direction (default: down)',
-                    default: 'down',
-                },
-                durationMs: {
-                    type: 'number',
-                    description: 'Total scroll duration in ms (default: 1500)',
-                    default: 1500,
-                },
-                segments: {
-                    type: 'integer',
-                    description: 'Number of scroll segments (default: 8)',
-                    default: 8,
-                },
-                pauseMs: {
-                    type: 'number',
-                    description: 'Average pause between segments in ms (default: 80)',
-                    default: 80,
-                },
-                jitter: {
-                    type: 'number',
-                    description: 'Random variation factor 0-1 (default: 0.3)',
-                    default: 0.3,
-                },
-                selector: {
-                    type: 'string',
-                    description: 'CSS selector of scrollable container (default: window)',
-                },
-            },
-        },
-    },
-    {
-        name: 'human_typing',
-        description: 'Type text with human-like patterns: variable speed, occasional typos, and natural corrections.\n\n' +
-            'Features:\n' +
-            '- Per-character random delay based on WPM\n' +
-            '- Configurable typo rate with auto-correction (backspace + retype)\n' +
-            '- Word boundary pauses\n' +
-            '- Shift key simulation for uppercase\n\n' +
-            'Use this instead of page_type for anti-bot bypass.\n\n' +
-            'Example:\n' +
-            '  human_typing({ selector: "#email", text: "user@example.com", wpm: 80 })',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                selector: { type: 'string', description: 'CSS selector of the input field' },
-                text: { type: 'string', description: 'Text to type' },
-                wpm: { type: 'integer', description: 'Words per minute (default: 90)', default: 90 },
-                errorRate: {
-                    type: 'number',
-                    description: 'Probability of typo per character 0-0.2 (default: 0.02)',
-                    default: 0.02,
-                },
-                correctDelayMs: {
-                    type: 'number',
-                    description: 'Delay before correcting a typo in ms (default: 200)',
-                    default: 200,
-                },
-                clearFirst: {
-                    type: 'boolean',
-                    description: 'Clear existing value before typing (default: false)',
-                    default: false,
-                },
-            },
-            required: ['selector', 'text'],
-        },
-    },
-    {
-        name: 'captcha_vision_solve',
-        description: 'Attempt to solve a CAPTCHA using an external solving service or AI vision.\n\n' +
-            'Public contract:\n' +
-            '- `mode: "external_service"` routes to the configured solver backend\n' +
-            '- `mode: "manual"` waits for the user to solve manually\n\n' +
-            'Automatically detects the challenge class (`image` or `widget`) if `challengeType` is omitted.\n\n' +
-            'Example:\n' +
-            '  captcha_vision_solve({ mode: "external_service", apiKey: "..." })',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                mode: {
-                    type: 'string',
-                    enum: ['external_service', 'manual'],
-                    description: 'Solver mode (default: from config or "manual")',
-                },
-                provider: {
-                    type: 'string',
-                    description: 'Deprecated legacy external-service override; avoid in new callers',
-                },
-                apiKey: {
-                    type: 'string',
-                    description: 'External solver API key (default: from CAPTCHA_API_KEY env)',
-                },
-                challengeType: {
-                    type: 'string',
-                    enum: ['image', 'widget', 'browser_check', 'auto'],
-                    description: 'Generic challenge type hint (default: auto-detect)',
-                    default: 'auto',
-                },
-                typeHint: {
-                    type: 'string',
-                    description: 'Deprecated legacy alias for challengeType; avoid in new callers',
-                },
-                siteKey: { type: 'string', description: 'Widget site key (auto-extracted if omitted)' },
-                pageUrl: { type: 'string', description: 'Page URL for context (auto-detected if omitted)' },
-                timeoutMs: {
-                    type: 'number',
-                    description: 'Max solve time in ms (default: 180000)',
-                    default: 180000,
-                },
-                maxRetries: { type: 'integer', description: 'Max retry attempts (default: 2)', default: 2 },
-            },
-        },
-    },
-    {
-        name: 'widget_challenge_solve',
-        description: 'Solve an embedded widget challenge.\n\n' +
-            'Strategy:\n' +
-            '1. Detect the widget and extract siteKey\n' +
-            '2. Send to the configured external solver service (or hook the page callback to extract token)\n' +
-            '3. Inject the solved token back into the page\n' +
-            '4. Trigger callback to proceed\n\n' +
-            'Requires either external solver credentials or uses the built-in hook approach.\n\n' +
-            'Example:\n' +
-            '  widget_challenge_solve({ mode: "external_service" })',
-        inputSchema: {
-            type: 'object',
-            properties: {
-                siteKey: { type: 'string', description: 'Widget site key (auto-detected if omitted)' },
-                pageUrl: { type: 'string', description: 'Page URL (auto-detected if omitted)' },
-                mode: {
-                    type: 'string',
-                    enum: ['external_service', 'hook', 'manual'],
-                    description: 'Solving mode (default: from config or "manual")',
-                },
-                provider: {
-                    type: 'string',
-                    description: 'Deprecated legacy external-service override; avoid in new callers',
-                },
-                apiKey: { type: 'string', description: 'External solver API key' },
-                timeoutMs: {
-                    type: 'number',
-                    description: 'Max solve time in ms (default: 120000)',
-                    default: 120000,
-                },
-                injectToken: {
-                    type: 'boolean',
-                    description: 'Auto-inject solved token into page (default: true)',
-                    default: true,
-                },
-            },
-        },
-    },
+    tool('human_mouse')
+        .desc(`Move the mouse along a natural Bezier curve path with random jitter.
+
+Simulates human-like mouse movement using cubic Bezier curves with:
+- Non-linear speed (ease-in-out)
+- Configurable jitter/noise
+- Viewport-clamped trajectory
+
+Use this before page_click for anti-bot bypass on browser-check or widget challenges.
+
+Example:
+  human_mouse({ toX: 500, toY: 300, durationMs: 800 })`)
+        .number('fromX', 'Start X coordinate (default: current mouse position or 0)')
+        .number('fromY', 'Start Y coordinate (default: current mouse position or 0)')
+        .number('toX', 'Target X coordinate')
+        .number('toY', 'Target Y coordinate')
+        .string('selector', 'CSS selector to move to (alternative to toX/toY — auto-resolves element center)')
+        .number('durationMs', 'Movement duration in ms (default: 600)', { default: 600 })
+        .number('steps', 'Number of intermediate points (default: 24)', { default: 24 })
+        .number('jitterPx', 'Max random offset per step in pixels (default: 1.5)', { default: 1.5 })
+        .enum('curve', ['ease', 'linear', 'ease-in', 'ease-out'], 'Speed curve (default: ease)', {
+        default: 'ease',
+    })
+        .boolean('click', 'Click at destination after movement (default: false)', { default: false })
+        .openWorld()
+        .build(),
+    tool('human_scroll')
+        .desc(`Scroll the page with human-like behavior: variable speed, micro-pauses, and deceleration.
+
+Simulates natural scrolling patterns:
+- Segmented scroll with random segment sizes
+- Brief pauses between segments
+- Velocity deceleration near the end
+
+Example:
+  human_scroll({ distance: 1000, direction: "down", durationMs: 2000 })`)
+        .number('distance', 'Total scroll distance in pixels (default: 500)', { default: 500 })
+        .enum('direction', ['up', 'down', 'left', 'right'], 'Scroll direction (default: down)', {
+        default: 'down',
+    })
+        .number('durationMs', 'Total scroll duration in ms (default: 1500)', { default: 1500 })
+        .number('segments', 'Number of scroll segments (default: 8)', { default: 8 })
+        .number('pauseMs', 'Average pause between segments in ms (default: 80)', { default: 80 })
+        .number('jitter', 'Random variation factor 0-1 (default: 0.3)', { default: 0.3 })
+        .string('selector', 'CSS selector of scrollable container (default: window)')
+        .openWorld()
+        .build(),
+    tool('human_typing')
+        .desc(`Type text with human-like patterns: variable speed, occasional typos, and natural corrections.
+
+Features:
+- Per-character random delay based on WPM
+- Configurable typo rate with auto-correction (backspace + retype)
+- Word boundary pauses
+- Shift key simulation for uppercase
+
+Use this instead of page_type for anti-bot bypass.
+
+Example:
+  human_typing({ selector: "#email", text: "user@example.com", wpm: 80 })`)
+        .string('selector', 'CSS selector of the input field')
+        .string('text', 'Text to type')
+        .number('wpm', 'Words per minute (default: 90)', { default: 90 })
+        .number('errorRate', 'Probability of typo per character 0-0.2 (default: 0.02)', {
+        default: 0.02,
+    })
+        .number('correctDelayMs', 'Delay before correcting a typo in ms (default: 200)', {
+        default: 200,
+    })
+        .boolean('clearFirst', 'Clear existing value before typing (default: false)', {
+        default: false,
+    })
+        .required('selector', 'text')
+        .openWorld()
+        .build(),
+    tool('captcha_vision_solve')
+        .desc(`Attempt to solve a CAPTCHA using an external solving service or AI vision.
+
+Public contract:
+- \`mode: "external_service"\` routes to the configured solver backend
+- \`mode: "manual"\` waits for the user to solve manually
+
+Automatically detects the challenge class (\`image\` or \`widget\`) if \`challengeType\` is omitted.
+
+Example:
+  captcha_vision_solve({ mode: "external_service", apiKey: "..." })`)
+        .enum('mode', ['external_service', 'manual'], 'Solver mode (default: from config or "manual")')
+        .string('provider', 'Deprecated legacy external-service override; avoid in new callers')
+        .string('apiKey', 'External solver API key (default: from CAPTCHA_API_KEY env)')
+        .enum('challengeType', ['image', 'widget', 'browser_check', 'auto'], 'Generic challenge type hint (default: auto-detect)', { default: 'auto' })
+        .string('typeHint', 'Deprecated legacy alias for challengeType; avoid in new callers')
+        .string('siteKey', 'Widget site key (auto-extracted if omitted)')
+        .string('pageUrl', 'Page URL for context (auto-detected if omitted)')
+        .number('timeoutMs', 'Max solve time in ms (default: 180000)', { default: 180000 })
+        .number('maxRetries', 'Max retry attempts (default: 2)', { default: 2 })
+        .openWorld()
+        .build(),
+    tool('widget_challenge_solve')
+        .desc(`Solve an embedded widget challenge.
+
+Strategy:
+1. Detect the widget and extract siteKey
+2. Send to the configured external solver service (or hook the page callback to extract token)
+3. Inject the solved token back into the page
+4. Trigger callback to proceed
+
+Requires either external solver credentials or uses the built-in hook approach.
+
+Example:
+  widget_challenge_solve({ mode: "external_service" })`)
+        .string('siteKey', 'Widget site key (auto-detected if omitted)')
+        .string('pageUrl', 'Page URL (auto-detected if omitted)')
+        .enum('mode', ['external_service', 'hook', 'manual'], 'Solving mode (default: from config or "manual")')
+        .string('provider', 'Deprecated legacy external-service override; avoid in new callers')
+        .string('apiKey', 'External solver API key')
+        .number('timeoutMs', 'Max solve time in ms (default: 120000)', { default: 120000 })
+        .boolean('injectToken', 'Auto-inject solved token into page (default: true)', { default: true })
+        .openWorld()
+        .build(),
 ];