@scrymore/scry-deployer 0.6.1 → 0.7.0-next.20260926151750

package/README.md

@@ -2,31 +2,7 @@
 
 Deploy your Storybook to the cloud with one command. ⚡
 
-## Set up with your AI assistant
-
-From your application's repository, install the Scry setup skill:
-
-```bash
-npx skills add epinnock/scry-node --skill scry-setup
-```
-
-The current installer requires Node.js 22.20 or newer. Choose your assistant
-(Claude Code, Codex, Cursor, or another compatible agent), then ask:
-**“Set up Scry for this project and connect my assistant to its components.”**
-
-The skill handles deployment configuration, GitHub Actions, component indexing,
-MCP connections, and optional Figma linking. You can also ask for MCP alone.
-Complete account sign-in in your browser and keep API keys in your environment
-or CI secret store.
-
-See the [setup guide](https://docs.scrymore.com/guide/skill) for installation
-options, or inspect the [skill instructions](skills/scry-setup/SKILL.md).
-
-## Set up directly with the CLI
-
-`init` writes configuration and workflows, configures GitHub secrets, then
-commits and pushes. For local preparation before publishing, use the skill or
-the manual deployment path below. `--skip-gh-setup` still commits and pushes.
+## 🎯 Quick Start (5 seconds)
 
 ### 1. Get your credentials
 Visit the [Scry Dashboard](https://dashboard.scrymore.com) and:
@@ -102,7 +78,7 @@ This deploys your Storybook immediately without setting up GitHub Actions.
 npx @scrymore/scry-deployer init --projectId xxx --apiKey yyy
 
 # From GitHub (latest from main branch)
-npx github:epinnock/scry-node init --projectId xxx --apiKey yyy
+npx github:scryorg/scry-node init --projectId xxx --apiKey yyy
 ```
 
 ### Installing as a Dependency
@@ -114,18 +90,18 @@ If you prefer to install it as a development dependency:
 npm install @scrymore/scry-deployer --save-dev
 
 # From GitHub
-npm install github:epinnock/scry-node --save-dev
+npm install github:scryorg/scry-node --save-dev
 # or
-pnpm add github:epinnock/scry-node -D
+pnpm add github:scryorg/scry-node -D
 # or
-yarn add github:epinnock/scry-node --dev
+yarn add github:scryorg/scry-node --dev
 ```
 
 After installation, you can run commands using:
 
 ```bash
-# Using the scry-deployer binary
-npm exec -- scry-deployer init --projectId xxx --apiKey yyy
+# Using the storybook-deployer binary
+npx storybook-deployer init --projectId xxx --apiKey yyy
 
 # Using the scry alias
 npx scry init --projectId xxx --apiKey yyy
@@ -205,13 +181,16 @@ The CLI is configured through a combination of command-line options and environm
 |----------------|---------------------------------------|--------------------------------------------------------------|----------|--------------------------------------|
 | `--dir`        | `STORYBOOK_DEPLOYER_DIR`              | Path to the built Storybook directory (e.g., `storybook-static`). | Yes      | -                                    |
 | `--api-key`    | `STORYBOOK_DEPLOYER_API_KEY`          | The API key for the deployment service.                        | No       | -                                    |
-| `--api-url`    | `STORYBOOK_DEPLOYER_API_URL`          | Base URL for the deployment service API.                       | No       | `https://api.default-service.com/v1`  |
+| `--api-url`    | `STORYBOOK_DEPLOYER_API_URL`          | Base URL for the deployment service API.                       | No       | `https://storybook-deployment-service.epinnock.workers.dev` |
 | `--project`    | `STORYBOOK_DEPLOYER_PROJECT`          | The project name/identifier.                                   | No       | `main`                               |
 | `--version`    | `STORYBOOK_DEPLOYER_VERSION`          | The version identifier for the deployment.                     | No       | `latest`                             |
 | `--with-analysis` | `STORYBOOK_DEPLOYER_WITH_ANALYSIS` | Enable Storybook analysis (story crawling + screenshots). Enabled by default in generated workflows. | No       | `false`                              |
 | `--stories-dir` | `STORYBOOK_DEPLOYER_STORIES_DIR`     | Path to stories directory (optional, auto-detects .stories.* files). | No | Auto-detect                          |
 | `--screenshots-dir` | `STORYBOOK_DEPLOYER_SCREENSHOTS_DIR` | Directory for captured screenshots.                        | No       | `./screenshots`                      |
 | `--storybook-url` | `STORYBOOK_DEPLOYER_STORYBOOK_URL` | URL of running Storybook server for screenshot capture.        | No       | `http://localhost:6006`              |
+| `--capture-mode` | `SCRY_CAPTURE_MODE`                 | Screenshot framing forwarded to scry-sbcov: `root` (crop to the component) or `viewport`. | No | unset: sbcov decides (`root` from sbcov 0.6) |
+| `--capture-scale` | `SCRY_CAPTURE_SCALE`               | Screenshot device scale factor forwarded to scry-sbcov, `0 < n <= 4`. | No | unset: sbcov decides (`2` from sbcov 0.6) |
+| `--capture-viewport` | `SCRY_CAPTURE_VIEWPORT`         | Browser viewport `WIDTHxHEIGHT` forwarded to scry-sbcov.       | No | unset: sbcov decides (`1280x720`) |
 | `--verbose`    | `STORYBOOK_DEPLOYER_VERBOSE`          | Enable verbose logging for debugging purposes.                 | No       | `false`                              |
 | `--help`, `-h` | -                                     | Show the help message.                                       | -        | -                                    |
 | `--version`, `-v`| -                                     | Show the version number.                                     | -        | -                                    |
@@ -284,6 +263,15 @@ The configuration file (`.storybook-deployer.json`) is automatically created in
 - `project` → `--project` CLI option
 - `version` → `--version` CLI option
 - `verbose` → `--verbose` CLI option
+- `captureMode` → `--capture-mode` CLI option
+- `captureScale` → `--capture-scale` CLI option
+- `captureViewport` → `--capture-viewport` CLI option (`"390x844"` or `{ "width": 390, "height": 844 }`)
+
+**Screenshot capture settings.** `captureMode`, `captureScale` and `captureViewport` are validated and passed to
+scry-sbcov as `--capture-mode`, `--capture-scale` and `--capture-viewport`. Only the ones you set are passed, so
+leaving them out keeps sbcov's defaults and any `scry-sbcov.config.*` in your project in charge. An invalid value
+fails the run. To keep whole-window 1x screenshots, set `"captureMode": "viewport", "captureScale": 1`. For
+`root` mode, mark the component with `data-scry-root` (see the scry-sbcov README, "Capture settings").
 
 **See [`.storybook-deployer.example.json`](.storybook-deployer.example.json) for a complete configuration file with all available options and their default values.**
 
@@ -450,7 +438,7 @@ If you're installing from GitHub, the workflow file is already included.
 | Variable Name | Value | Example |
 |--------------|-------|---------|
 | `SCRY_PROJECT_ID` | Your project identifier | `my-storybook` or `company-design-system` |
-| `SCRY_API_URL` | Backend API endpoint for uploads | `https://api.scrymore.com` |
+| `SCRY_API_URL` | Backend API endpoint for uploads (the upload service) | `https://storybook-deployment-service.epinnock.workers.dev` |
 | `SCRY_VIEW_URL` | Base URL where users view deployed Storybooks | `https://view.scrymore.com` |
 
 **Note:** The `SCRY_VIEW_URL` is where users will access your deployed Storybook (e.g., `https://view.scrymore.com/{project}/pr-{number}/`). This is separate from `SCRY_API_URL`, which is the backend API endpoint used for uploads.
@@ -1040,6 +1028,6 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed contribution guidelines.
 ## 🆘 Support
 
 Need help?
-- 📖 [Documentation](https://github.com/epinnock/scry-node)
-- 🐛 [Report an issue](https://github.com/epinnock/scry-node/issues)
-- 💬 [Discussions](https://github.com/epinnock/scry-node/discussions)
+- 📖 [Documentation](https://github.com/scryorg/scry-node)
+- 🐛 [Report an issue](https://github.com/scryorg/scry-node/issues)
+- 💬 [Discussions](https://github.com/scryorg/scry-node/discussions)

package/bin/cli.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-const { initTelemetry, captureCliError, flushTelemetry, redactArgv } = require('../lib/telemetry.js');
+const { initTelemetry, captureCliError, flushTelemetry } = require('../lib/telemetry.js');
 const yargs = require('yargs/yargs');
 const { hideBin } = require('yargs/helpers');
 const fs = require('fs');
@@ -25,8 +25,7 @@ const { resolveBuildGitContext } = require('../lib/gitContext.js');
 async function runAnalysis(argv) {
     const logger = createLogger(argv);
     logger.info('📊 Starting Storybook analysis...');
-    // Credentials masked: this line is also a Sentry breadcrumb.
-    logger.debug(`Received arguments: ${JSON.stringify(redactArgv(argv))}`);
+    logger.debug(`Received arguments: ${JSON.stringify(argv)}`);
 
     const outPath = path.join(os.tmpdir(), `storybook-analysis-${Date.now()}.zip`);
 
@@ -86,8 +85,7 @@ async function runAnalysis(argv) {
 async function runDeployment(argv) {
     const logger = createLogger(argv);
     logger.info('🚀 Starting deployment...');
-    // Credentials masked: this line is also a Sentry breadcrumb.
-    logger.debug(`Received arguments: ${JSON.stringify(redactArgv(argv))}`);
+    logger.debug(`Received arguments: ${JSON.stringify(argv)}`);
 
     const outPath = path.join(os.tmpdir(), `storybook-deployment-${Date.now()}.zip`);
     let metadataZipPath = null;
@@ -281,6 +279,19 @@ async function main() {
                         type: 'boolean',
                         default: false,
                     })
+                    .option('capture-mode', {
+                        describe: 'Screenshot framing forwarded to scry-sbcov: root or viewport (unset: sbcov default)',
+                        type: 'string',
+                        choices: ['root', 'viewport'],
+                    })
+                    .option('capture-scale', {
+                        describe: 'Screenshot device scale factor forwarded to scry-sbcov, 0 < n <= 4 (unset: sbcov default)',
+                        type: 'string',
+                    })
+                    .option('capture-viewport', {
+                        describe: 'Browser viewport WIDTHxHEIGHT forwarded to scry-sbcov (unset: sbcov default)',
+                        type: 'string',
+                    })
                     .option('with-analysis', {
                         describe: 'Include Storybook analysis (screenshots, metadata)',
                         type: 'boolean',
@@ -389,6 +400,19 @@ async function main() {
                         default: false,
                         alias: 'coverageExecute'
                     })
+                    .option('capture-mode', {
+                        describe: 'Screenshot framing forwarded to scry-sbcov: root or viewport (unset: sbcov default)',
+                        type: 'string',
+                        choices: ['root', 'viewport'],
+                    })
+                    .option('capture-scale', {
+                        describe: 'Screenshot device scale factor forwarded to scry-sbcov, 0 < n <= 4 (unset: sbcov default)',
+                        type: 'string',
+                    })
+                    .option('capture-viewport', {
+                        describe: 'Browser viewport WIDTHxHEIGHT forwarded to scry-sbcov (unset: sbcov default)',
+                        type: 'string',
+                    })
                     .option('output', {
                         describe: 'Where to write the JSON coverage report',
                         type: 'string',
@@ -402,6 +426,8 @@ async function main() {
             }, async (argv) => {
                 const logger = createLogger(argv);
 
+                // Capture settings: CLI flag > env > .storybook-deployer.json; unset = sbcov decides.
+                const { captureMode, captureScale, captureViewport } = loadConfig(argv);
                 const result = await runCoverageAnalysis({
                     storybookDir: argv.dir,
                     baseBranch: argv.coverageBase || 'main',
@@ -409,6 +435,9 @@ async function main() {
                     execute: Boolean(argv.coverageExecute),
                     outputPath: argv.output,
                     keepReport: true,
+                    captureMode,
+                    captureScale,
+                    captureViewport,
                 });
                 const report = result.report;
 
@@ -612,6 +641,9 @@ async function resolveCoverage(argv, logger) {
                 execute: Boolean(argv.coverageExecute) || needsScreenshots,
                 screenshots: needsScreenshots,
                 outputZipPath,
+                captureMode: argv.captureMode,
+                captureScale: argv.captureScale,
+                captureViewport: argv.captureViewport,
             });
             report = result.report;
             metadataZipPath = result.metadataZipPath;

package/lib/config.js

@@ -119,7 +119,11 @@ function loadEnvConfig() {
     'WITH_ANALYSIS': 'withAnalysis',
     'STORIES_DIR': 'storiesDir',
     'SCREENSHOTS_DIR': 'screenshotsDir',
-    'STORYBOOK_URL': 'storybookUrl'
+    'STORYBOOK_URL': 'storybookUrl',
+    // Screenshot capture settings forwarded to scry-sbcov (unset = sbcov decides)
+    'CAPTURE_MODE': 'captureMode',
+    'CAPTURE_SCALE': 'captureScale',
+    'CAPTURE_VIEWPORT': 'captureViewport'
   };
 
   Object.keys(envMapping).forEach(envKey => {

package/lib/coverage.js

@@ -12,8 +12,68 @@ const chalk = require('chalk');
  * @property {boolean} [keepReport=false] If true, do not delete the output file after reading
  * @property {boolean} [screenshots=false] Enable passing-story screenshots in scry-sbcov
  * @property {string|null} [outputZipPath=null] Where to write metadata+screenshots ZIP
+ * @property {'root'|'viewport'} [captureMode] Screenshot framing forwarded as --capture-mode
+ * @property {number|string} [captureScale] Device scale factor (0 < n <= 4) forwarded as --capture-scale
+ * @property {string|{width:number,height:number}} [captureViewport] "WxH" or {width,height}, forwarded as --capture-viewport
  */
 
+const CAPTURE_MODES = ['root', 'viewport'];
+
+/**
+ * Turn a project's capture settings into scry-sbcov flags.
+ *
+ * Only settings the project actually set are forwarded: an unset value is left
+ * to scry-sbcov, so its own defaults and any scry-sbcov.config.* in the project
+ * still apply. Every value is validated to a fixed shape (enum, bounded number,
+ * WxH integers) before it gets near a shell command; anything else throws.
+ *
+ * @param {{captureMode?:any, captureScale?:any, captureViewport?:any}} [settings]
+ * @returns {string[]}
+ */
+function buildCaptureArgs(settings = {}) {
+  const { captureMode, captureScale, captureViewport } = settings || {};
+  const args = [];
+  const isSet = (v) => v !== undefined && v !== null && v !== '';
+
+  if (isSet(captureMode)) {
+    if (typeof captureMode !== 'string' || !CAPTURE_MODES.includes(captureMode)) {
+      throw new Error(`Invalid captureMode ${JSON.stringify(captureMode)}: expected "root" or "viewport"`);
+    }
+    args.push('--capture-mode', captureMode);
+  }
+
+  if (isSet(captureScale)) {
+    const text = String(captureScale).trim();
+    const n = Number(text);
+    if (!/^\d+(\.\d+)?$/.test(text) || !(n > 0) || n > 4) {
+      throw new Error(`Invalid captureScale ${JSON.stringify(captureScale)}: expected a number in (0, 4]`);
+    }
+    args.push('--capture-scale', String(n));
+  }
+
+  if (isSet(captureViewport)) {
+    let width;
+    let height;
+    if (typeof captureViewport === 'string') {
+      const m = /^\s*(\d{1,5})\s*[xX]\s*(\d{1,5})\s*$/.exec(captureViewport);
+      if (m) {
+        width = Number(m[1]);
+        height = Number(m[2]);
+      }
+    } else if (typeof captureViewport === 'object') {
+      width = captureViewport.width;
+      height = captureViewport.height;
+    }
+    const ok = (v) => Number.isInteger(v) && v >= 1 && v <= 10000;
+    if (!ok(width) || !ok(height)) {
+      throw new Error(`Invalid captureViewport ${JSON.stringify(captureViewport)}: expected "WIDTHxHEIGHT" or { width, height } in whole CSS px`);
+    }
+    args.push('--capture-viewport', `${width}x${height}`);
+  }
+
+  return args;
+}
+
 /**
  * Run Storybook coverage analysis via `@scrymore/scry-sbcov`.
  *
@@ -39,12 +99,19 @@ async function runCoverageAnalysis(options) {
     keepReport = false,
     screenshots = false,
     outputZipPath = null,
+    captureMode,
+    captureScale,
+    captureViewport,
   } = options || {};
 
   if (!storybookDir || typeof storybookDir !== 'string') {
     throw new Error('runCoverageAnalysis: options.storybookDir is required');
   }
 
+  // Validate before doing anything: a bad explicit setting should fail loudly,
+  // not be swallowed by the failOnThreshold=false path below.
+  const captureArgs = buildCaptureArgs({ captureMode, captureScale, captureViewport });
+
   console.log(chalk.blue('Running Storybook coverage analysis...'));
 
   const outputPath = providedOutputPath
@@ -77,6 +144,7 @@ async function runCoverageAnalysis(options) {
       cliArgs.push('--output-zip', outputZipPath);
     }
   }
+  cliArgs.push(...captureArgs);
 
   // Allow local override for E2E testing before package publication.
   // Example:
@@ -305,6 +373,7 @@ function readGithubPullRequestBaseSha(eventPath) {
 
 module.exports = {
   runCoverageAnalysis,
+  buildCaptureArgs,
   loadCoverageReport,
   extractCoverageSummary,
   normalizeGitBaseRef,

package/lib/telemetry.js

@@ -21,8 +21,6 @@ const Sentry = require('@sentry/node');
  * None of that is needed to know that an upload failed with EAI_AGAIN.
  */
 
-const { version: PACKAGE_VERSION } = require('../package.json');
-
 const DSN =
   'https://c66ce229a1db2289f145eebd02436d9c@o4507889391828992.ingest.us.sentry.io/4510699330732032';
 
@@ -43,58 +41,8 @@ const SECRET_PATTERNS = [
   [/scry_proj_[A-Za-z0-9_\-]+/g, 'scry_proj_<redacted>'],
   [/(X-Amz-Signature=)[^&\s]+/gi, '$1<redacted>'],
   [/(Bearer\s+)[A-Za-z0-9._\-]+/gi, '$1<redacted>'],
-  // A credential flag echoed on a command line: --api-key X, --api-key=X,
-  // -k X, --token X, --openai-api-key X, ...
-  [/(--[\w-]*(?:api-key|apikey|token|secret|password)[\w-]*[=\s]+|(?:^|\s)-k[=\s]+)(?!<redacted>)[^\s"',]+/gi, '$1<redacted>'],
-  // A credential field inside serialized JSON: "apiKey":"X", "token": "X".
-  [/("[\w-]*(?:api[-_]?key|token|secret|password)[\w-]*"\s*:\s*)"[^"]*"/gi, '$1"<redacted>"'],
-  // An env echo: SCRY_API_KEY=X, STORYBOOK_DEPLOYER_API_KEY=X, JINA_API_KEY=X.
-  [/(\b[A-Z][A-Z0-9_]*(?:KEY|TOKEN|SECRET|PASSWORD)[A-Z0-9_]*=)(?!<redacted>)[^\s"',]+/g, '$1<redacted>'],
 ];
 
-/** Field names whose values are credentials, in any spelling yargs produces. */
-const SECRET_FIELD = /(^k$|api[-_]?key|token|secret|password)/i;
-
-/**
- * A copy of argv with every credential-named field masked, at any depth.
- *
- * For logging argv whole (the --verbose "Received arguments" line), which is
- * also a Sentry breadcrumb. Unlike sanitizeArgv this keeps every field, so it
- * must only be used for local diagnostics, never as event context.
- */
-function redactArgv(value, depth = 0) {
-  if (depth > 5 || value === null || typeof value !== 'object') return value;
-  if (Array.isArray(value)) return value.map((v) => redactArgv(v, depth + 1));
-  const out = {};
-  for (const [k, v] of Object.entries(value)) {
-    out[k] = SECRET_FIELD.test(k) && v !== undefined && v !== null && v !== '' ? '<redacted>' : redactArgv(v, depth + 1);
-  }
-  return out;
-}
-
-/** Scrub every string in a JSON-like value (breadcrumb data), in place-safe copy. */
-function scrubDeep(value, depth = 0) {
-  if (typeof value === 'string') return scrub(value);
-  if (depth > 5 || value === null || typeof value !== 'object') return value;
-  if (Array.isArray(value)) return value.map((v) => scrubDeep(v, depth + 1));
-  const out = {};
-  for (const [k, v] of Object.entries(value)) {
-    out[k] = SECRET_FIELD.test(k) && typeof v === 'string' && v ? '<redacted>' : scrubDeep(v, depth + 1);
-  }
-  return out;
-}
-
-/**
- * Breadcrumbs are sent with every event and beforeSend does not see them as
- * separate items, so they get the same scrubbing on the way in.
- */
-function scrubBreadcrumb(breadcrumb) {
-  if (!breadcrumb) return breadcrumb;
-  if (breadcrumb.message) breadcrumb.message = scrub(breadcrumb.message);
-  if (breadcrumb.data) breadcrumb.data = scrubDeep(breadcrumb.data);
-  return breadcrumb;
-}
-
 function scrub(value) {
   if (typeof value !== 'string') return value;
   return SECRET_PATTERNS.reduce((acc, [pattern, replacement]) => acc.replace(pattern, replacement), value);
@@ -129,9 +77,6 @@ function initTelemetry() {
   Sentry.init({
     dsn: DSN,
     environment: process.env.NODE_ENV || 'production',
-    // Which published deployer produced the event, so a fix can be matched to
-    // the versions still in the wild.
-    release: `@scrymore/scry-deployer@${PACKAGE_VERSION}`,
 
     // Errors only. Traces from a CLI describe the customer's build pipeline,
     // which is more than is needed to fix a crash.
@@ -141,18 +86,8 @@ function initTelemetry() {
     sendDefaultPii: false,
     serverName: false,
 
-    // The logger turns every line (including debug) into a breadcrumb, and
-    // Sentry's console integration does the same for console.*. None of that
-    // passed through beforeSend's scrubbing before.
-    beforeBreadcrumb(breadcrumb) {
-      return scrubBreadcrumb(breadcrumb);
-    },
-
     beforeSend(event) {
       if (event.message) event.message = scrub(event.message);
-      // Belt and braces for breadcrumbs added before init or by integrations
-      // that bypass beforeBreadcrumb.
-      if (Array.isArray(event.breadcrumbs)) event.breadcrumbs = event.breadcrumbs.map(scrubBreadcrumb);
 
       for (const entry of event.exception?.values ?? []) {
         if (entry.value) entry.value = scrub(entry.value);
@@ -200,8 +135,6 @@ module.exports = {
   flushTelemetry,
   telemetryDisabled,
   sanitizeArgv,
-  redactArgv,
   scrub,
-  scrubBreadcrumb,
   SAFE_ARGV_FIELDS,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scrymore/scry-deployer",
-  "version": "0.6.1",
+  "version": "0.7.0-next.20260926151750",
   "description": "A CLI to automate the deployment of Storybook static builds.",
   "main": "index.js",
   "bin": {