@veolab/discoverylab 0.1.0 → 0.1.1

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 (11) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +65 -179
  3. package/dist/chunk-GOL6FUJL.js +6045 -0
  4. package/dist/chunk-JFTBF4JR.js +6040 -0
  5. package/dist/chunk-X64SFUT5.js +6099 -0
  6. package/dist/cli.js +1 -1
  7. package/dist/index.js +1 -1
  8. package/dist/server-2DXLKLFM.js +13 -0
  9. package/dist/server-G2SY3DOS.js +13 -0
  10. package/dist/server-OESJUEYC.js +13 -0
  11. package/package.json +1 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Anderson Melo
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,59 +1,45 @@
1
- # AppLab Discovery
2
-
3
- > AI-Powered App Testing & Marketing Asset Generator
4
-
5
- A localhost-first tool for developers that combines automated testing, AI analysis, and marketing asset generation. Distributed as a Claude Code Plugin (MCP Server).
6
-
7
- ![AppLab Discovery](assets/applab-discovery.jpeg)
8
-
9
- ## Features
10
-
11
- ### Core Features
12
- - **Video Analysis** - Extract frames, OCR text, detect features using Apple Intelligence
13
- - **3D Mockups** - Professional device mockups (iPhone, Android, Browser)
14
- - **Text Effects** - Behind-object, title, subtitle overlays
15
- - **Screen Capture** - Record emulators, windows, or web apps
16
- - **Maestro Integration** - Automated mobile app testing
17
- - **Playwright Integration** - Automated web app testing with recording (uses user's Chrome)
18
- - **Export** - PNG, MP4, GIF with professional quality
19
-
20
- ### Task Hub
21
- Centralized task management with external tool integration:
22
- - **Multiple Links** - Add multiple Jira, Notion, Figma, and GitHub links per project
23
- - **MCP Metadata Fetch** - Automatically extract ticket keys, page IDs, file info from URLs
24
- - **AI-Generated Requirements** - Auto-generate requirements from linked sources
25
- - **Test Map** - AI-generated test checklist with progress tracking
26
- - **Status Tracking** - Visual indicators for task progress
27
-
28
- ### LLM Provider Configuration
29
- Flexible AI backend with multiple provider support:
30
- - **Anthropic API** - Use your own API key for Claude models
31
- - **OpenAI API** - GPT-4/5 models support
32
- - **Ollama** - Local LLM support (llama3, mistral, etc.)
33
- - **Claude CLI** - Automatic fallback with optimized settings
34
- - **Model Selection** - Configure specific models per provider in Settings UI
35
-
36
- ## Installation
37
-
38
- ### Via Claude Code Plugin Marketplace (Recommended)
39
-
40
- ```bash
41
- # Add the marketplace
42
- /plugin marketplace add veolab/applab-discovery
43
-
44
- # Install the plugin
45
- /plugin install discoverylab@veolab-applab-discovery
1
+ # DiscoveryLab
2
+
3
+ ![Node.js](https://img.shields.io/badge/Node.js-20%2B-brightgreen?style=flat-square)
4
+ [![npm](https://img.shields.io/npm/v/@veolab/discoverylab.svg?style=flat-square)](https://www.npmjs.com/package/@veolab/discoverylab)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](https://opensource.org/licenses/MIT)
6
+
7
+ > AI-powered app testing & marketing asset generator. A Claude Code plugin.
8
+
9
+ ![DiscoveryLab](assets/applab-discovery.jpeg)
10
+
11
+ ## How It Works
12
+
13
+ ```mermaid
14
+ flowchart LR
15
+ subgraph Input
16
+ A[Mobile App] --> R[Record]
17
+ B[Web App] --> R
18
+ C[Video File] --> U[Upload]
19
+ end
20
+
21
+ subgraph DiscoveryLab
22
+ R --> P[Process]
23
+ U --> P
24
+ P --> AI[AI Analysis]
25
+ AI --> O[OCR + Features]
26
+ end
27
+
28
+ subgraph Output
29
+ O --> E1[Screenshots]
30
+ O --> E2[GIF / MP4]
31
+ O --> E3[Test Reports]
32
+ end
46
33
  ```
47
34
 
48
- The MCP server is automatically configured when you install via the marketplace.
49
-
50
- ### Via npm (Manual)
35
+ ## Quick Start
51
36
 
37
+ **Install:**
52
38
  ```bash
53
39
  npm install -g @veolab/discoverylab
54
40
  ```
55
41
 
56
- Then add to your `~/.claude.json`:
42
+ **Configure** `~/.claude.json`:
57
43
  ```json
58
44
  {
59
45
  "mcpServers": {
@@ -65,150 +51,50 @@ Then add to your `~/.claude.json`:
65
51
  }
66
52
  ```
67
53
 
68
- ### Via Bun (Faster)
69
-
54
+ **Run:**
70
55
  ```bash
71
- bun add -g @veolab/discoverylab
72
- ```
73
-
74
- Then add to your `~/.claude.json`:
75
- ```json
76
- {
77
- "mcpServers": {
78
- "discoverylab": {
79
- "command": "bunx",
80
- "args": ["@veolab/discoverylab", "mcp"]
81
- }
82
- }
83
- }
84
- ```
85
-
86
- ## Usage
87
-
88
- ### Skills (Slash Commands)
89
-
90
- After installing the plugin, use these skills in Claude Code:
91
-
92
- | Skill | Description |
93
- |-------|-------------|
94
- | `/discoverylab:open-ui` | Open the DiscoveryLab web interface |
95
- | `/discoverylab:quick-capture` | Quickly capture iOS/Android emulator screen |
96
- | `/discoverylab:mobile-test` | Full mobile testing workflow with Maestro |
97
- | `/discoverylab:web-test` | Web testing workflow with Playwright |
98
- | `/discoverylab:generate-assets` | Generate marketing assets from screenshots |
99
- | `/discoverylab:task-hub` | Manage links, requirements and test maps |
100
-
101
- ### CLI Usage
102
-
103
- ```bash
104
- # Start localhost UI
105
56
  discoverylab serve
106
-
107
- # Analyze a video
108
- discoverylab analyze video.mp4
109
-
110
- # Capture emulator
111
- discoverylab capture --emulator ios
112
57
  ```
113
58
 
114
- ### Natural Language with Claude
115
-
116
- ```
117
- # Basic usage
118
- Use applab to analyze my app recording and generate marketing screenshots
119
-
120
- # Task Hub integration
121
- Add this Jira ticket to my project: https://company.atlassian.net/browse/PROJ-123
122
- Generate requirements and test map from all my project links
123
- Show me my test progress for the current project
124
-
125
- # Recording
126
- Start recording my iOS simulator
127
- Run Maestro tests on my app
128
- ```
129
-
130
- ### Available MCP Tools
131
- - **Projects**: `dlab.project.*` - Create, list, manage projects
132
- - **Task Hub**: `dlab.taskhub.*` - Links, requirements, test maps
133
- - **Recording**: `dlab.capture.*`, `dlab.maestro.*`, `dlab.playwright.*`
134
- - **Export**: `dlab.notion.*`, `dlab.drive.*`, `dlab.jira.*`
135
-
136
- ## Requirements
137
-
138
- - **Node.js 20+**
139
- - **FFmpeg** (for video export)
140
- - **Maestro CLI** (optional, for mobile testing)
141
- - **Playwright** (optional, for web testing)
142
-
143
- ## Platform Compatibility
144
-
145
- | Feature | macOS | Windows | Linux |
146
- |---------|-------|---------|-------|
147
- | Web UI | Full | Full | Full |
148
- | Video Upload & Analysis | Full | Full | Full |
149
- | Grid Composer | Full | Full | Full |
150
- | PNG/Image Export | Full | Full | Full |
151
- | Vision OCR (Apple Intelligence) | Full | Fallback* | Fallback* |
152
- | iOS Simulator Capture | Full | N/A | N/A |
153
- | Android Emulator Capture | Full | Full | Full |
154
- | Playwright Web Testing | Full | Full | Full |
155
- | Maestro Mobile Testing | Full | Full | Full |
156
-
157
- *Fallback: Uses Tesseract.js for OCR when Apple Vision is unavailable.
158
-
159
- ### macOS (Recommended)
160
- Full functionality including iOS Simulator capture and Apple Intelligence Vision OCR.
59
+ ## Features
161
60
 
162
- ### Windows / Linux
163
- Most features work with some limitations:
164
- - iOS Simulator capture requires macOS
165
- - Vision OCR falls back to Tesseract.js
166
- - Android Emulator and Playwright work normally
61
+ | Feature | Description |
62
+ |---------|-------------|
63
+ | **Screen Capture** | Record iOS/Android emulators or web apps |
64
+ | **Maestro Testing** | Automated mobile app testing with screenshots |
65
+ | **Playwright Testing** | Web testing using your installed Chrome |
66
+ | **AI Analysis** | OCR, feature detection, smart summaries |
67
+ | **Export** | PNG, GIF, MP4 with professional quality |
68
+ | **Task Hub** | Jira, Notion, Figma, GitHub integration |
167
69
 
168
- ## API Endpoints
70
+ ## Skills
169
71
 
170
- ### Task Hub Endpoints
72
+ After installing, use these in Claude Code:
171
73
 
172
74
  ```
173
- PUT /api/projects/:id/links - Update project links (legacy + taskHubLinks)
174
- POST /api/mcp/fetch - Fetch metadata from a single URL
175
- POST /api/mcp/fetch-batch - Fetch metadata from multiple URLs
176
- POST /api/ai/generate-task-info - Generate requirements and test map from links
177
- POST /api/projects/sync-orphans - Sync orphan directories from disk to database
75
+ /discoverylab:open-ui → Open web interface
76
+ /discoverylab:quick-capture → Capture emulator screen
77
+ /discoverylab:mobile-test → Mobile testing with Maestro
78
+ /discoverylab:web-test → Web testing with Playwright
178
79
  ```
179
80
 
180
- ### Recording Endpoints
181
-
182
- ```
183
- POST /api/mobile/record/start - Start Maestro mobile recording
184
- POST /api/mobile/record/stop - Stop and process mobile recording
185
- POST /api/web/record/start - Start Playwright web recording (uses user's Chrome)
186
- POST /api/web/record/stop - Stop and process web recording
187
- DELETE /api/recordings/:id - Delete a recording with cascade cleanup
188
- ```
189
-
190
- ### LLM Settings Endpoints
81
+ ## Requirements
191
82
 
192
- ```
193
- GET /api/settings/llm - Get LLM provider settings (API keys masked)
194
- POST /api/settings/llm - Update LLM provider settings
195
- GET /api/ollama/status - Check Ollama server status and available models
196
- GET /api/mobile-chat/providers - Get available chat providers for mobile testing
197
- POST /api/mobile-chat - Send chat message during mobile testing session
198
- ```
83
+ - Node.js 20+
84
+ - FFmpeg (for video/GIF export)
85
+ - Maestro CLI (optional)
86
+ - Playwright (optional)
199
87
 
200
- ## Documentation
88
+ ## Platform Support
201
89
 
202
- See [CLAUDE.md](./CLAUDE.md) for Claude Code specific instructions.
90
+ | | macOS | Windows | Linux |
91
+ |---|:---:|:---:|:---:|
92
+ | Web UI | ✓ | ✓ | ✓ |
93
+ | iOS Capture | ✓ | — | — |
94
+ | Android Capture | ✓ | ✓ | ✓ |
95
+ | Web Recording | ✓ | ✓ | ✓ |
96
+ | Apple Vision OCR | ✓ | — | — |
203
97
 
204
98
  ## License
205
99
 
206
- MIT - See LICENSE file
207
-
208
- ## Credits
209
-
210
- Built with:
211
- - Three.js (3D mockups)
212
- - Remotion (video rendering)
213
- - Apple Vision & NaturalLanguage frameworks
214
- - Claude MCP SDK
100
+ MIT