btcp-browser-agent 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (117) hide show
  1. package/CLAUDE.md +230 -0
  2. package/LICENSE +21 -0
  3. package/README.md +309 -0
  4. package/SKILL.md +143 -0
  5. package/SNAPSHOT_IMPROVEMENTS.md +302 -0
  6. package/USAGE.md +146 -0
  7. package/dist/index.d.ts +34 -0
  8. package/dist/index.d.ts.map +1 -0
  9. package/dist/index.js +35 -0
  10. package/dist/index.js.map +1 -0
  11. package/docs/browser-cli-design.md +500 -0
  12. package/examples/chrome-extension/CHANGELOG.md +210 -0
  13. package/examples/chrome-extension/DEBUG.md +231 -0
  14. package/examples/chrome-extension/ERROR_FIXED.md +147 -0
  15. package/examples/chrome-extension/QUICK_TEST.md +189 -0
  16. package/examples/chrome-extension/README.md +149 -0
  17. package/examples/chrome-extension/SESSION_ONLY_MODE.md +305 -0
  18. package/examples/chrome-extension/TEST_WITH_YOUR_TABS.md +97 -0
  19. package/examples/chrome-extension/build.js +43 -0
  20. package/examples/chrome-extension/manifest.json +37 -0
  21. package/examples/chrome-extension/package-lock.json +1063 -0
  22. package/examples/chrome-extension/package.json +21 -0
  23. package/examples/chrome-extension/popup.html +195 -0
  24. package/examples/chrome-extension/src/background.ts +12 -0
  25. package/examples/chrome-extension/src/content.ts +7 -0
  26. package/examples/chrome-extension/src/popup.ts +303 -0
  27. package/examples/chrome-extension/src/scenario-google-github.ts +389 -0
  28. package/examples/chrome-extension/test-page.html +127 -0
  29. package/examples/chrome-extension/tests/README.md +206 -0
  30. package/examples/chrome-extension/tests/scenario-google-to-github-star.ts +380 -0
  31. package/examples/chrome-extension/tsconfig.json +14 -0
  32. package/examples/snapshots/README.md +207 -0
  33. package/examples/snapshots/amazon-com-detail.html +9528 -0
  34. package/examples/snapshots/amazon-com-detail.snapshot.txt +997 -0
  35. package/examples/snapshots/convert-snapshots.ts +97 -0
  36. package/examples/snapshots/edition-cnn-com.html +13292 -0
  37. package/examples/snapshots/edition-cnn-com.snapshot.txt +562 -0
  38. package/examples/snapshots/github-com-microsoft-vscode.html +2916 -0
  39. package/examples/snapshots/github-com-microsoft-vscode.snapshot.txt +455 -0
  40. package/examples/snapshots/google-search.html +20012 -0
  41. package/examples/snapshots/google-search.snapshot.txt +195 -0
  42. package/examples/snapshots/metadata.json +86 -0
  43. package/examples/snapshots/npr-org-templates.html +2031 -0
  44. package/examples/snapshots/npr-org-templates.snapshot.txt +224 -0
  45. package/examples/snapshots/stackoverflow-com.html +5216 -0
  46. package/examples/snapshots/stackoverflow-com.snapshot.txt +2404 -0
  47. package/examples/snapshots/test-all-mode.html +46 -0
  48. package/examples/snapshots/test-all-mode.snapshot.txt +5 -0
  49. package/examples/snapshots/validate.test.ts +296 -0
  50. package/package.json +65 -0
  51. package/packages/cli/package.json +42 -0
  52. package/packages/cli/src/__tests__/cli.test.ts +434 -0
  53. package/packages/cli/src/__tests__/errors.test.ts +226 -0
  54. package/packages/cli/src/__tests__/executor.test.ts +275 -0
  55. package/packages/cli/src/__tests__/formatter.test.ts +260 -0
  56. package/packages/cli/src/__tests__/parser.test.ts +288 -0
  57. package/packages/cli/src/__tests__/suggestions.test.ts +255 -0
  58. package/packages/cli/src/commands/back.ts +22 -0
  59. package/packages/cli/src/commands/check.ts +33 -0
  60. package/packages/cli/src/commands/clear.ts +33 -0
  61. package/packages/cli/src/commands/click.ts +32 -0
  62. package/packages/cli/src/commands/closetab.ts +31 -0
  63. package/packages/cli/src/commands/eval.ts +41 -0
  64. package/packages/cli/src/commands/fill.ts +30 -0
  65. package/packages/cli/src/commands/focus.ts +33 -0
  66. package/packages/cli/src/commands/forward.ts +22 -0
  67. package/packages/cli/src/commands/goto.ts +34 -0
  68. package/packages/cli/src/commands/help.ts +162 -0
  69. package/packages/cli/src/commands/hover.ts +34 -0
  70. package/packages/cli/src/commands/index.ts +129 -0
  71. package/packages/cli/src/commands/newtab.ts +35 -0
  72. package/packages/cli/src/commands/press.ts +40 -0
  73. package/packages/cli/src/commands/reload.ts +25 -0
  74. package/packages/cli/src/commands/screenshot.ts +27 -0
  75. package/packages/cli/src/commands/scroll.ts +64 -0
  76. package/packages/cli/src/commands/select.ts +35 -0
  77. package/packages/cli/src/commands/snapshot.ts +21 -0
  78. package/packages/cli/src/commands/tab.ts +32 -0
  79. package/packages/cli/src/commands/tabs.ts +26 -0
  80. package/packages/cli/src/commands/text.ts +27 -0
  81. package/packages/cli/src/commands/title.ts +17 -0
  82. package/packages/cli/src/commands/type.ts +38 -0
  83. package/packages/cli/src/commands/uncheck.ts +33 -0
  84. package/packages/cli/src/commands/url.ts +17 -0
  85. package/packages/cli/src/commands/wait.ts +54 -0
  86. package/packages/cli/src/errors.ts +164 -0
  87. package/packages/cli/src/executor.ts +68 -0
  88. package/packages/cli/src/formatter.ts +215 -0
  89. package/packages/cli/src/index.ts +257 -0
  90. package/packages/cli/src/parser.ts +195 -0
  91. package/packages/cli/src/suggestions.ts +207 -0
  92. package/packages/cli/src/terminal/Terminal.ts +365 -0
  93. package/packages/cli/src/terminal/index.ts +5 -0
  94. package/packages/cli/src/types.ts +155 -0
  95. package/packages/cli/tsconfig.json +20 -0
  96. package/packages/core/package.json +35 -0
  97. package/packages/core/src/actions.ts +1210 -0
  98. package/packages/core/src/errors.ts +296 -0
  99. package/packages/core/src/index.test.ts +638 -0
  100. package/packages/core/src/index.ts +220 -0
  101. package/packages/core/src/ref-map.ts +107 -0
  102. package/packages/core/src/snapshot.ts +873 -0
  103. package/packages/core/src/types.ts +536 -0
  104. package/packages/core/tsconfig.json +23 -0
  105. package/packages/extension/README.md +129 -0
  106. package/packages/extension/package.json +43 -0
  107. package/packages/extension/src/background.ts +888 -0
  108. package/packages/extension/src/content.ts +172 -0
  109. package/packages/extension/src/index.ts +579 -0
  110. package/packages/extension/src/session-manager.ts +385 -0
  111. package/packages/extension/src/session-types.ts +144 -0
  112. package/packages/extension/src/types.ts +162 -0
  113. package/packages/extension/tsconfig.json +28 -0
  114. package/src/index.ts +64 -0
  115. package/tsconfig.build.json +12 -0
  116. package/tsconfig.json +26 -0
  117. package/vitest.config.ts +13 -0
@@ -0,0 +1,155 @@
1
+ /**
2
+ * @btcp/cli - Type definitions
3
+ *
4
+ * Types for CLI commands, parsing, and execution.
5
+ */
6
+
7
+ import type { Response } from '@btcp/extension';
8
+
9
+ /**
10
+ * Parsed CLI command structure
11
+ */
12
+ export interface ParsedCommand {
13
+ /** Command name (e.g., 'goto', 'click', 'snapshot') */
14
+ name: string;
15
+ /** Positional arguments */
16
+ args: string[];
17
+ /** Flag arguments (--flag or --flag=value) */
18
+ flags: Record<string, string | boolean>;
19
+ /** Original raw input */
20
+ raw: string;
21
+ }
22
+
23
+ /**
24
+ * Command execution result
25
+ */
26
+ export interface CommandResult {
27
+ /** Whether the command succeeded */
28
+ success: boolean;
29
+ /** Human-readable message */
30
+ message?: string;
31
+ /** Result data (varies by command) */
32
+ data?: unknown;
33
+ /** Error message if failed */
34
+ error?: string;
35
+ }
36
+
37
+ /**
38
+ * Result of executing multiple commands
39
+ */
40
+ export interface BatchResult {
41
+ /** Results for each command in order */
42
+ results: CommandResult[];
43
+ /** Whether all commands succeeded */
44
+ allSucceeded: boolean;
45
+ /** Index of first failed command (-1 if all succeeded) */
46
+ firstFailedIndex: number;
47
+ /** Total number of commands executed */
48
+ executed: number;
49
+ }
50
+
51
+ /**
52
+ * Command handler definition
53
+ */
54
+ export interface CommandHandler {
55
+ /** Command name */
56
+ name: string;
57
+ /** Brief description */
58
+ description: string;
59
+ /** Usage pattern (e.g., 'goto <url>') */
60
+ usage: string;
61
+ /** Example usages */
62
+ examples?: string[];
63
+ /** Execute the command */
64
+ execute: CommandExecuteFn;
65
+ }
66
+
67
+ /**
68
+ * Command execute function signature
69
+ */
70
+ export type CommandExecuteFn = (
71
+ client: CommandClient,
72
+ args: string[],
73
+ flags: Record<string, string | boolean>
74
+ ) => Promise<CommandResult>;
75
+
76
+ /**
77
+ * Client interface for command execution
78
+ * This is a subset of the @btcp/extension Client
79
+ */
80
+ export interface CommandClient {
81
+ execute(command: import('@btcp/extension').Command): Promise<Response>;
82
+ navigate(url: string, options?: { waitUntil?: 'load' | 'domcontentloaded' }): Promise<Response>;
83
+ back(): Promise<Response>;
84
+ forward(): Promise<Response>;
85
+ reload(options?: { bypassCache?: boolean }): Promise<Response>;
86
+ getUrl(): Promise<string>;
87
+ getTitle(): Promise<string>;
88
+ snapshot(options?: { selector?: string; maxDepth?: number }): Promise<{
89
+ tree: string;
90
+ refs: Record<string, { selector: string; role: string; name?: string }>;
91
+ }>;
92
+ click(selector: string, options?: { button?: 'left' | 'right' | 'middle' }): Promise<Response>;
93
+ type(selector: string, text: string, options?: { delay?: number; clear?: boolean }): Promise<Response>;
94
+ fill(selector: string, value: string): Promise<Response>;
95
+ getText(selector: string): Promise<string | null>;
96
+ isVisible(selector: string): Promise<boolean>;
97
+ screenshot(options?: { format?: 'png' | 'jpeg'; quality?: number }): Promise<string>;
98
+ tabNew(options?: { url?: string; active?: boolean }): Promise<{ tabId: number; url?: string }>;
99
+ tabClose(tabId?: number): Promise<Response>;
100
+ tabSwitch(tabId: number): Promise<Response>;
101
+ tabList(): Promise<import('@btcp/extension').TabInfo[]>;
102
+ }
103
+
104
+ /**
105
+ * Formatted output for terminal display
106
+ */
107
+ export interface FormattedOutput {
108
+ /** Output type for styling */
109
+ type: 'success' | 'error' | 'info' | 'data';
110
+ /** Text content */
111
+ content: string;
112
+ }
113
+
114
+ /**
115
+ * Terminal history entry
116
+ */
117
+ export interface HistoryEntry {
118
+ /** Entry type */
119
+ type: 'input' | 'output' | 'error' | 'info';
120
+ /** Text content */
121
+ content: string;
122
+ /** Timestamp */
123
+ timestamp: number;
124
+ }
125
+
126
+ /**
127
+ * Terminal configuration
128
+ */
129
+ export interface TerminalConfig {
130
+ /** Color theme */
131
+ theme: 'dark' | 'light';
132
+ /** Font size in pixels */
133
+ fontSize: number;
134
+ /** Max history entries */
135
+ historySize: number;
136
+ /** Command prompt string */
137
+ prompt: string;
138
+ }
139
+
140
+ /**
141
+ * CLI instance interface
142
+ */
143
+ export interface CLI {
144
+ /** Execute a single command or multiple commands (split by \n) */
145
+ execute(input: string): Promise<CommandResult>;
146
+ /**
147
+ * Execute multiple commands (split by \n)
148
+ * Stops on first error unless continueOnError is true
149
+ */
150
+ executeAll(input: string, options?: { continueOnError?: boolean }): Promise<BatchResult>;
151
+ /** Get available commands */
152
+ getCommands(): CommandHandler[];
153
+ /** Get help for a specific command */
154
+ getHelp(commandName?: string): string;
155
+ }
@@ -0,0 +1,20 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2020",
4
+ "module": "ESNext",
5
+ "moduleResolution": "bundler",
6
+ "declaration": true,
7
+ "declarationMap": true,
8
+ "sourceMap": true,
9
+ "outDir": "./dist",
10
+ "rootDir": "./src",
11
+ "strict": true,
12
+ "esModuleInterop": true,
13
+ "skipLibCheck": true,
14
+ "forceConsistentCasingInFileNames": true,
15
+ "resolveJsonModule": true,
16
+ "isolatedModules": true
17
+ },
18
+ "include": ["src/**/*"],
19
+ "exclude": ["node_modules", "dist"]
20
+ }
@@ -0,0 +1,35 @@
1
+ {
2
+ "name": "@btcp/core",
3
+ "version": "0.1.0",
4
+ "description": "Core DOM actions for browser automation - runs in any browser context",
5
+ "type": "module",
6
+ "main": "dist/index.js",
7
+ "types": "dist/index.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/index.d.ts",
11
+ "import": "./dist/index.js"
12
+ }
13
+ },
14
+ "scripts": {
15
+ "build": "tsc",
16
+ "test": "vitest",
17
+ "clean": "rm -rf dist"
18
+ },
19
+ "files": [
20
+ "dist",
21
+ "src"
22
+ ],
23
+ "keywords": [
24
+ "browser",
25
+ "automation",
26
+ "dom",
27
+ "accessibility"
28
+ ],
29
+ "license": "Apache-2.0",
30
+ "devDependencies": {
31
+ "typescript": "^5.3.0",
32
+ "vitest": "^1.0.0",
33
+ "jsdom": "^24.0.0"
34
+ }
35
+ }