@reshotdev/screenshot 0.0.1-beta.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to the Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 Mindy, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,388 @@
+# @reshotdev/screenshot
+
+Product screenshots in documentation go stale within days of a deploy. Manually recapturing them across themes, viewports, and locales is tedious and error-prone. This CLI automates screenshot and video capture in CI/CD, comparing against baselines to detect visual drift before it reaches production docs.
+
+[![npm](https://img.shields.io/npm/v/@reshotdev/screenshot)](https://www.npmjs.com/package/@reshotdev/screenshot)
+[![CI](https://github.com/reshotdev/screenshot/actions/workflows/ci.yml/badge.svg)](https://github.com/reshotdev/screenshot/actions/workflows/ci.yml)
+
+**Status: Beta** (0.x). The API may change between minor versions.
+
+## Install
+
+```bash
+npm install -g @reshotdev/screenshot
+```
+
+Requires Node.js >= 18. Playwright browsers are installed automatically on first run.
+
+## Quick Start
+
+```bash
+# 1. Interactive setup wizard
+reshot setup
+
+# 2. Capture screenshots from your config
+reshot run
+
+# 3. Review captures in the web UI
+reshot studio
+```
+
+## Configuration
+
+Create `docsync.config.json` in your project root:
+
+```json
+{
+  "baseUrl": "http://localhost:3000",
+  "assetDir": ".reshot/output",
+  "concurrency": 2,
+  "viewport": { "width": 1280, "height": 720 },
+  "timeout": 30000,
+  "headless": true,
+  "scenarios": [
+    {
+      "key": "homepage",
+      "name": "Homepage",
+      "url": "/",
+      "steps": [
+        { "action": "wait", "ms": 1000 },
+        { "action": "screenshot", "key": "hero", "description": "Hero section" }
+      ]
+    },
+    {
+      "key": "dashboard",
+      "name": "Dashboard",
+      "url": "/dashboard",
+      "requiresAuth": true,
+      "readySelector": "[data-loaded='true']",
+      "steps": [
+        { "action": "screenshot", "key": "overview", "description": "Dashboard overview" },
+        { "action": "click", "selector": "button[data-tab='analytics']" },
+        { "action": "wait", "ms": 500 },
+        { "action": "screenshot", "key": "analytics", "description": "Analytics tab" }
+      ]
+    }
+  ]
+}
+```
+
+## Commands
+
+| Command | Description | Key Flags |
+| --- | --- | --- |
+| `reshot setup` | Interactive config wizard | `--offline`, `--force` |
+| `reshot run` | Execute capture scenarios | `--scenarios`, `--diff`, `--all-variants`, `--concurrency`, `--no-headless` |
+| `reshot record [title]` | Interactive recording via Chrome DevTools | `--browser`, `--url`, `--port` |
+| `reshot sync` | Upload traces/docs to Reshot platform | `--trace-dir`, `--dry-run` |
+| `reshot studio` | Launch web management UI | `--port`, `--no-open` |
+| `reshot validate` | Check config and bindings | `--strict`, `--fix` |
+| `reshot status` | View project status and sync history | `--jobs`, `--drifts`, `--json` |
+| `reshot publish` | Upload assets with versioning | `--tag`, `--message`, `--dry-run` |
+| `reshot pull` | Generate asset map for builds | `--format json\|ts\|csv`, `--output`, `--status` |
+| `reshot drifts` | Manage visual drift notifications | `approve`, `reject`, `ignore`, `approve-all` |
+| `reshot import-tests` | Import Playwright tests as scenarios | `--dry-run`, `--no-interactive` |
+| `reshot ci setup` | Generate CI/CD workflow files | — |
+| `reshot ci run` | Capture + publish in one step (CI) | `--tag`, `--no-publish`, `--dry-run` |
+
+## Step Types
+
+Steps define a sequence of browser actions within a scenario:
+
+| Step | Description | Key Properties |
+| --- | --- | --- |
+| `wait` | Pause execution | `ms` |
+| `screenshot` | Capture current viewport | `key`, `description` |
+| `click` | Click a DOM element | `selector`, `optional` |
+| `type` | Type text into an input | `selector`, `text` |
+| `keyboard` | Send keyboard input | `key` (e.g., `"Meta+k"`, `"Enter"`) |
+| `waitForSelector` | Wait for element to appear | `selector`, `timeout` |
+| `navigate` | Go to a URL | `url` |
+| `fillForm` | Fill multiple form fields | `fields` (selector-to-value map) |
+
+## Variant System
+
+Capture the same scenario across multiple dimensions (themes, locales, roles) without duplicating config:
+
+```json
+{
+  "variants": {
+    "dimensions": {
+      "theme": {
+        "label": "Color Theme",
+        "options": {
+          "light": {
+            "name": "Light Mode",
+            "inject": [
+              { "method": "localStorage", "key": "theme", "value": "light" },
+              { "method": "browser", "colorScheme": "light" }
+            ]
+          },
+          "dark": {
+            "name": "Dark Mode",
+            "inject": [
+              { "method": "localStorage", "key": "theme", "value": "dark" },
+              { "method": "browser", "colorScheme": "dark" }
+            ]
+          }
+        }
+      },
+      "locale": {
+        "label": "Language",
+        "options": {
+          "en": {
+            "name": "English",
+            "inject": [
+              { "method": "browser", "locale": "en-US" }
+            ]
+          },
+          "de": {
+            "name": "German",
+            "inject": [
+              { "method": "browser", "locale": "de-DE", "timezone": "Europe/Berlin" }
+            ]
+          }
+        }
+      }
+    },
+    "presets": {
+      "all-themes": { "name": "All Themes", "dimensions": ["theme"] },
+      "matrix": { "name": "Full Matrix", "dimensions": ["theme", "locale"] }
+    }
+  }
+}
+```
+
+Run all variants:
+
+```bash
+reshot run --all-variants
+# Captures: homepage/light/en, homepage/light/de, homepage/dark/en, homepage/dark/de
+```
+
+**Injection methods:** `localStorage`, `sessionStorage`, `browser` (colorScheme, locale, timezone), `cookie`, `queryParam`.
+
+## Viewport Presets
+
+Use preset names in your config or with the `--viewport` flag:
+
+| Category | Preset | Resolution | Scale |
+| --- | --- | --- | --- |
+| Desktop | `desktop-hd` | 1920x1080 | 1x |
+| Desktop | `desktop` | 1280x720 | 1x |
+| Desktop | `desktop-retina` | 1280x720 | 2x |
+| Tablet | `tablet-landscape` | 1024x768 | 2x |
+| Tablet | `tablet-portrait` | 768x1024 | 2x |
+| Mobile | `mobile` | 375x667 | 2x |
+| Mobile | `mobile-large` | 414x896 | 3x |
+| Docs | `docs-wide` | 1200x800 | 2x |
+| Docs | `docs-standard` | 960x640 | 2x |
+| Social | `social-og` | 1200x630 | 2x |
+| Social | `social-twitter` | 1200x600 | 2x |
+
+## Visual Diffing
+
+Compare captures against baselines to detect changes:
+
+```json
+{
+  "diffing": {
+    "enabled": true,
+    "threshold": 0.1,
+    "antialiasing": true,
+    "ignoreRegions": [
+      { "x": 0, "y": 0, "width": 1280, "height": 50 }
+    ]
+  }
+}
+```
+
+```bash
+# Run with diffing enabled
+reshot run --diff
+
+# Compare against cloud baselines
+reshot run --diff --cloud
+```
+
+Pixel-level comparison using pixelmatch. The `threshold` (0-1) controls sensitivity — 0.1 means 10% pixel difference tolerance. `antialiasing: true` compensates for font rendering differences across platforms. `ignoreRegions` excludes dynamic areas like timestamps or ads.
+
+## Interactive Recording
+
+Record scenarios by interacting with your app in a real browser:
+
+```bash
+# Launch Chrome and start recording
+reshot record "Checkout Flow" --browser --url http://localhost:3000
+```
+
+During recording:
+- Press **S** to capture a screenshot step
+- Press **C** to start/stop a video clip
+- Press **Q** to quit and save
+
+The recorded scenario is appended to `docsync.config.json` automatically.
+
+## Authentication
+
+### Storage State (from Playwright)
+
+```bash
+npx playwright codegen http://localhost:3000 --save-storage=.reshot/auth-state.json
+```
+
+```json
+{
+  "storageStatePath": ".reshot/auth-state.json"
+}
+```
+
+### Login Steps
+
+```json
+{
+  "auth": {
+    "loginUrl": "http://localhost:3000/login",
+    "loginSteps": [
+      { "action": "type", "selector": "input[name='email']", "text": "${EMAIL}" },
+      { "action": "type", "selector": "input[name='password']", "text": "${PASSWORD}" },
+      { "action": "click", "selector": "button[type='submit']" },
+      { "action": "waitForSelector", "selector": "[data-authenticated='true']" }
+    ]
+  }
+}
+```
+
+Environment variables (`${EMAIL}`, `${PASSWORD}`) are interpolated at runtime.
+
+## Output Formats
+
+### Step-by-Step Images (default)
+
+```
+.reshot/output/dashboard/20260315-120000/theme-light/
+  ├── step-0-overview.png
+  └── step-1-analytics.png
+```
+
+### Video Recording
+
+Set `"format": "summary-video"` in scenario output config to record the full browser session as MP4.
+
+### Selective Capture (Crop)
+
+```json
+{
+  "output": {
+    "crop": {
+      "enabled": true,
+      "selector": ".modal-dialog",
+      "padding": 16
+    }
+  }
+}
+```
+
+Crops the screenshot to the bounding box of the selected element.
+
+## CI/CD Integration
+
+### GitHub Actions
+
+```yaml
+name: Visual Capture
+on:
+  push:
+    branches: [main]
+
+jobs:
+  capture:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with: { node-version: 20 }
+      - run: npm ci
+      - run: npm start &  # start your app
+      - run: npx @reshotdev/screenshot ci run --tag ${{ github.sha }} --message "Deploy ${{ github.sha }}"
+        env:
+          RESHOT_TOKEN: ${{ secrets.RESHOT_TOKEN }}
+```
+
+Or use the setup wizard:
+
+```bash
+reshot ci setup
+```
+
+This generates a `.github/workflows/reshot.yml` tailored to your project.
+
+## Asset Map for Builds
+
+Generate a manifest of captured assets for use in documentation sites or marketing pages:
+
+```bash
+reshot pull --format json --output assets.json --status approved
+```
+
+```json
+{
+  "assets": [
+    {
+      "key": "dashboard-overview",
+      "variant": "theme-light",
+      "url": "https://cdn.reshot.dev/abc123/dashboard-overview.png",
+      "format": "png",
+      "width": 1280,
+      "height": 720,
+      "version": "v1.2.0"
+    }
+  ]
+}
+```
+
+Also supports `--format ts` (TypeScript with full metadata) and `--format csv`.
+
+## Drift Management
+
+Visual drifts are flagged when captures differ from baselines:
+
+```bash
+# List pending drifts
+reshot drifts
+
+# Approve a specific drift (updates baseline)
+reshot drifts approve drift-abc123
+
+# Approve all pending drifts
+reshot drifts approve-all
+
+# Reject a drift (keeps old baseline)
+reshot drifts reject drift-abc123
+```
+
+## Standalone Mode
+
+Run without any cloud connection:
+
+```bash
+reshot setup --offline
+```
+
+All capture, recording, diffing, and studio features work locally. Cloud features (publish, sync, drifts, pull) are disabled.
+
+## Limitations
+
+- Beta release. The CLI interface and config format may change between minor versions.
+- Playwright browsers are downloaded on first run (~200MB for Chromium).
+- Video recording requires Chromium (Firefox and WebKit support screenshots only).
+- Cloud features (publish, sync, drifts) require a Reshot account at [reshot.dev](https://reshot.dev).
+- Privacy masking (automatic PII redaction) is best-effort and should not be relied on for compliance.
+
+## Documentation
+
+[reshot.dev/docs](https://reshot.dev/docs)
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@reshotdev/screenshot",
+  "version": "0.0.1-beta.0",
+  "description": "CI/CD screenshot and video capture CLI",
+  "author": "Reshot <hello@reshot.dev>",
+  "license": "MIT",
+  "homepage": "https://reshot.dev",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/reshotdev/screenshot"
+  },
+  "bugs": "https://github.com/reshotdev/screenshot/issues",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": ["screenshots", "ci-cd", "documentation", "visual-testing", "automation", "playwright"],
+  "bin": {
+    "reshot": "./src/index.js"
+  },
+  "files": [
+    "src/",
+    "web/manager/dist/",
+    "web/cropper/",
+    "web/subtitle-editor/",
+    "LICENSE",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "scripts": {
+    "test": "node scripts/test.js",
+    "test:unit": "node --test tests/unit/*.test.js",
+    "test:integration": "node --test tests/integration/*.test.js",
+    "test:all": "node --test tests/unit/*.test.js tests/integration/*.test.js",
+    "test:dry-run": "node src/index.js --help && node src/index.js --version",
+    "prepublishOnly": "cd web/manager && npm install && npm run build",
+    "ui:build": "cd web/manager && npm install && npm run build",
+    "ui:dev": "cd web/manager && npm install && npm run dev",
+    "lint": "echo 'No linting configured yet'",
+    "pack:check": "npm pack --dry-run"
+  },
+  "dependencies": {
+    "axios": "^1.6.2",
+    "chalk": "^4.1.2",
+    "commander": "^11.1.0",
+    "cors": "^2.8.5",
+    "dotenv": "^16.3.1",
+    "express": "^4.18.2",
+    "form-data": "^4.0.0",
+    "fs-extra": "^11.2.0",
+    "get-port": "^7.0.0",
+    "inquirer": "^8.2.5",
+    "open": "^9.1.0",
+    "ora": "^7.0.1",
+    "pixelmatch": "^5.3.0",
+    "playwright": "^1.40.0",
+    "pngjs": "^7.0.0",
+    "sharp": "^0.33.2",
+    "socket.io": "^4.7.2",
+    "uuid": "^9.0.1",
+    "@aws-sdk/client-s3": "^3.650.0"
+  }
+}