document360-capture 0.2.9 → 0.2.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document360-capture",
-  "version": "0.2.9",
+  "version": "0.2.10",
   "description": "CLI that captures product screenshots from Playwright specs. Login once, capture many. Companion to document360-writer.",
   "type": "module",
   "bin": {
@@ -12,7 +12,7 @@
     "./helpers": "./dist/helpers/index.js"
   },
   "files": [
-    "dist",
+    "dist/**/*.js",
     "README.md",
     "LICENSE"
   ],

package/dist/annotate/compose.d.ts

@@ -1,7 +0,0 @@
-export type AnnotateResult = {
-    id: string;
-    ok: boolean;
-    reason?: string;
-    finalPath?: string;
-};
-export declare function composeAnnotations(outputDir: string, enabled: boolean): Promise<AnnotateResult[]>;

package/dist/annotate/svg.d.ts

@@ -1,32 +0,0 @@
-import type { Bbox } from '../helpers/types.js';
-export declare function escapeXml(s: string): string;
-export declare function highlightSvg(bbox: Bbox): string;
-export declare function redactSvg(bbox: Bbox): string;
-/**
- * Just the numbered pin, placed on the target's top-left corner (clamped into the image). Pins
- * only MARK targets — the explanation lives in the legend band — so they stay small and never
- * cover the surrounding UI, which is what doomed inline captions on busy screens.
- */
-export declare function pinSvg(label: string, bbox: Bbox, canvasW: number, canvasH: number): string;
-export type LegendItem = {
-    label: string;
-    text: string;
-};
-export type LegendLayout = {
-    /** Y where the band starts (== original image height). */
-    top: number;
-    width: number;
-    /** Vertical padding above the first / below the last entry. */
-    pad: number;
-    /** Per-entry row height. */
-    lineHeight: number;
-};
-/** Height a legend band needs for `n` entries — the canvas is extended by exactly this much. */
-export declare function legendBandHeight(n: number, layout: Pick<LegendLayout, 'pad' | 'lineHeight'>): number;
-/**
- * The legend band: a numbered list in the appended strip below the screenshot. Deterministic,
- * always-safe placement (the band is added space, so nothing on the page is ever covered) — no
- * collision detection or whitespace-hunting required. Each row reuses the pin's numbered chip so
- * the legend entry and its on-image pin read as the same marker.
- */
-export declare function legendSvg(items: LegendItem[], layout: LegendLayout): string;

package/dist/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/commands/auth.d.ts

@@ -1,4 +0,0 @@
-export type AuthOptions = {
-    profile?: string;
-};
-export declare function authCommand(opts: AuthOptions): Promise<void>;

package/dist/commands/capture.d.ts

@@ -1,5 +0,0 @@
-export type CaptureOptions = {
-    profile?: string;
-    noAnnotate?: boolean;
-};
-export declare function captureCommand(specId: string | undefined, opts: CaptureOptions): Promise<number>;

package/dist/commands/doctor.d.ts

@@ -1,4 +0,0 @@
-export type DoctorOptions = {
-    profile?: string;
-};
-export declare function doctorCommand(opts: DoctorOptions): Promise<number>;

package/dist/commands/init.d.ts

@@ -1,5 +0,0 @@
-export type InitOptions = {
-    /** Non-interactive: scaffold with all defaults + a placeholder URL, asking nothing. */
-    yes?: boolean;
-};
-export declare function initCommand(opts?: InitOptions): Promise<void>;

package/dist/commands/list.d.ts

@@ -1 +0,0 @@
-export declare function listCommand(): Promise<void>;

package/dist/commands/profile.d.ts

@@ -1,3 +0,0 @@
-export declare function profileList(): void;
-export declare function profileUse(name: string): number;
-export declare function profileShow(name?: string): number;

package/dist/commands/status.d.ts

@@ -1 +0,0 @@
-export declare function statusCommand(): Promise<void>;

package/dist/config/authState.d.ts

@@ -1,10 +0,0 @@
-export declare function authStateDir(): string;
-export declare function authStatePath(projectId: string, profileName: string): string;
-export declare function ensureAuthStateDir(projectId: string): void;
-export type AuthStateInfo = {
-    path: string;
-    exists: boolean;
-    ageMs?: number;
-};
-export declare function getAuthStateInfo(projectId: string, profileName: string): AuthStateInfo;
-export declare function ensureParentDir(path: string): void;

package/dist/config/projectConfig.d.ts

@@ -1,117 +0,0 @@
-/** How to reach a target deployment for capture. On disk, only `startUrl` is required —
-    `authBoundaryUrlPattern` is filled by resolveProfile (host heuristic) when omitted. */
-export type ProfileConnection = {
-    startUrl: string;
-    authBoundaryUrlPattern?: string;
-};
-/** A named capture profile. `connection` is one aspect; a profile may also override
-    the directories/viewport so one repo can target multiple doc-sets/environments. */
-export type Profile = {
-    connection: ProfileConnection;
-    captureDir?: string;
-    outputDir?: string;
-    viewport?: {
-        width: number;
-        height: number;
-    };
-    /** Visible warning only — capture is read-only (screenshots), so no hard guard. */
-    production?: boolean;
-    /** The prepared "demo" context a capture run targets, as generic key→value pairs the writer
-        recommends per product (NOT hardcoded to one product's notions). FlowForge → {project:"…"};
-        Document360 → {project,workspace,language}; others → {org}/{site}/… Injected to specs as
-        CAPTURE_SCOPE; specs read it via the captureScope() helper to navigate deterministically. */
-    scope?: Record<string, string>;
-};
-/**
- * The on-disk shape: a minimal `.d360-capture.json` need only carry a `profiles` map
- * whose profiles each have a `connection.startUrl`. Everything else is filled at load
- * time (see `DEFAULTS` + `normalizeProjectConfig`), so a 3-line config is valid.
- */
-export type RawProjectConfig = {
-    projectId?: string;
-    captureDir?: string;
-    outputDir?: string;
-    viewport?: {
-        width: number;
-        height: number;
-    };
-    loginTimeoutMs?: number;
-    annotation?: {
-        enabled: boolean;
-    };
-    profiles: Record<string, Profile>;
-    defaultProfile?: string;
-};
-/** A fully-resolved config: every default materialized. What every command sees. */
-export type ProjectConfig = {
-    projectId: string;
-    /** Defaults inherited by any profile that doesn't override them. */
-    captureDir: string;
-    outputDir: string;
-    viewport: {
-        width: number;
-        height: number;
-    };
-    loginTimeoutMs: number;
-    annotation: {
-        enabled: boolean;
-    };
-    profiles: Record<string, Profile>;
-    defaultProfile: string;
-};
-/** A profile connection with the auth boundary resolved (always a string). */
-export type ResolvedConnection = {
-    startUrl: string;
-    authBoundaryUrlPattern: string;
-};
-/** A profile with directory/viewport defaults and the auth boundary already merged in. */
-export type ResolvedProfile = {
-    name: string;
-    connection: ResolvedConnection;
-    captureDir: string;
-    outputDir: string;
-    viewport: {
-        width: number;
-        height: number;
-    };
-    production: boolean;
-    /** The capture scope (key→value) for this profile; {} when unset. */
-    scope: Record<string, string>;
-    /** True when the auth boundary was derived (host heuristic) rather than configured —
-        doctor surfaces this so a too-loose/tight pattern is refinable before it bites. */
-    authBoundaryDefaulted: boolean;
-};
-export declare const PROJECT_CONFIG_FILENAME: string;
-/** Filled in for any field a minimal config omits. Default location lives under .d360-writer/ to
-    match the writer's single-footprint layout (the capture dirs derive from the writer's docsDir
-    when present; these are the bare fallback). */
-export declare const DEFAULTS: {
-    readonly captureDir: ".d360-writer/user-docs/_capture";
-    readonly outputDir: ".d360-writer/user-docs/_screenshots";
-    readonly viewport: {
-        readonly width: 1440;
-        readonly height: 900;
-    };
-    readonly loginTimeoutMs: 0;
-    readonly annotation: {
-        readonly enabled: true;
-    };
-};
-export declare class ProfileConfigError extends Error {
-}
-export declare function findProjectConfigPath(cwd?: string): string;
-export declare function readProjectConfig(path: string): ProjectConfig;
-export declare function writeProjectConfig(path: string, cfg: RawProjectConfig): void;
-/**
- * Derive a permissive post-login auth boundary from the profile's start URL: any URL on the
- * same origin. The login/IdP flow legitimately leaves that origin (SSO redirects) and returns
- * to it once authenticated, so "back on the app origin" is a reasonable logged-in signal —
- * good enough as a default, refinable when it isn't. Falls back to match-anything if the URL
- * can't be parsed.
- */
-export declare function deriveAuthBoundary(startUrl: string): string;
-/** Fill every optional field from DEFAULTS / the cwd, then validate what can't be defaulted. */
-export declare function normalizeProjectConfig(raw: RawProjectConfig & {
-    environments?: unknown;
-}, path: string, cwd?: string): ProjectConfig;
-export declare function resolveProfile(cfg: ProjectConfig, name?: string): ResolvedProfile;

package/dist/config/userConfig.d.ts

@@ -1,6 +0,0 @@
-export type UserConfig = {
-    autoUpdate?: boolean;
-};
-export declare function userConfigPath(): string;
-export declare function readUserConfig(): UserConfig;
-export declare function writeUserConfig(cfg: UserConfig): void;

package/dist/config/writerConfigDefaults.d.ts

@@ -1,18 +0,0 @@
-/**
- * d360-capture rides on d360-writer's setup: when a repo already has `.d360-writer.json`,
- * `init` inherits its project label + doc directories so the only thing left to ask is the
- * live app URL. This reads that file as PLAIN JSON — never an engine import (the packages are
- * deliberately decoupled; this is file I/O, not a code dependency). Tolerant by design:
- * any parse/shape problem yields {} and init falls back to its own defaults.
- *
- * Field overlap is intentional — `.d360-writer.json` already carries `projectId`
- * (its doc comment: "scopes sessions/screenshots"), `captureDir`, `outputDir`, and `docsDir`.
- */
-export type WriterConfigDefaults = {
-    projectId?: string;
-    captureDir?: string;
-    outputDir?: string;
-};
-export declare function writerConfigPath(cwd?: string): string;
-export declare function hasWriterConfig(cwd?: string): boolean;
-export declare function readWriterConfigDefaults(cwd?: string): WriterConfigDefaults;

package/dist/helpers/dumpAnnotations.d.ts

@@ -1,3 +0,0 @@
-import type { Page } from '@playwright/test';
-import type { Placeholder } from './types.js';
-export declare function dumpAnnotations(page: Page, ph: Placeholder): Promise<void>;

package/dist/helpers/index.d.ts

@@ -1,4 +0,0 @@
-export { waitPastLogin } from './waitPastLogin.js';
-export { dumpAnnotations } from './dumpAnnotations.js';
-export { captureScope, scopeValue } from './scope.js';
-export type { Bbox, Annotation, Placeholder, ResolvedAnnotations } from './types.js';

package/dist/helpers/scope.d.ts

@@ -1,10 +0,0 @@
-/**
- * The prepared capture scope — generic key→value pairs (e.g. {project: "Docs Demo"}, or
- * {project, workspace, language} for products that scope that way) that the writer recommends
- * per product and the user fills in. document360-capture injects it to specs as CAPTURE_SCOPE
- * (JSON). Specs read it to navigate into a KNOWN context deterministically instead of grabbing
- * "the first one". Returns {} when unset, so single-context setups keep working.
- */
-export declare function captureScope(): Record<string, string>;
-/** One scope value, e.g. `scopeValue('project')`. Undefined when not configured. */
-export declare function scopeValue(key: string): string | undefined;

package/dist/helpers/types.d.ts

@@ -1,37 +0,0 @@
-export type Bbox = {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-};
-export type Annotation = {
-    target: string;
-    label: string;
-    text: string;
-};
-export type Placeholder = {
-    id: string;
-    saveTo: string;
-    highlight?: string[];
-    annotations?: Annotation[];
-    redact?: string[];
-};
-export type ResolvedAnnotations = {
-    id: string;
-    rawPath: string;
-    finalPath: string;
-    highlight: {
-        selector: string;
-        bbox: Bbox;
-    }[];
-    annotations: {
-        label: string;
-        text: string;
-        selector: string;
-        bbox: Bbox;
-    }[];
-    redact: {
-        selector: string;
-        bbox: Bbox;
-    }[];
-};

package/dist/helpers/waitPastLogin.d.ts

@@ -1,2 +0,0 @@
-import type { Page } from '@playwright/test';
-export declare function waitPastLogin(page: Page, pattern: RegExp, timeoutMs?: number): Promise<void>;

package/dist/lib/updateNudge.d.ts

@@ -1,3 +0,0 @@
-/** Print a one-line update hint (from the cached answer) when a newer d360-capture is published, then
-    kick off a background cache refresh for next time. Best-effort; never blocks or throws. */
-export declare function maybeNudgeCaptureUpdate(currentVersion: string): void;

package/dist/runner/expiryDetect.d.ts

@@ -1 +0,0 @@
-export declare function looksLikeSessionExpiry(output: string): boolean;

package/dist/runner/playwrightConfig.d.ts

@@ -1,15 +0,0 @@
-export type RuntimeConfigArgs = {
-    cwd: string;
-    profileName: string;
-    captureDir: string;
-    viewport: {
-        width: number;
-        height: number;
-    };
-    storageStatePath: string;
-};
-export type RuntimeConfigPaths = {
-    configPath: string;
-    tsconfigPath: string;
-};
-export declare function writeRuntimePlaywrightConfig(args: RuntimeConfigArgs): RuntimeConfigPaths;

package/dist/runner/runSpecs.d.ts

@@ -1,26 +0,0 @@
-export type RunSpecsArgs = {
-    cwd: string;
-    configPath: string;
-    tsconfigPath: string;
-    startUrl: string;
-    authBoundaryUrlPattern: string;
-    specId?: string;
-    captureDirAbs: string;
-    /** Abort the in-flight Playwright run (hard interrupt) — kills the child process. */
-    signal?: AbortSignal;
-    /** Prepared capture scope (key→value), passed to specs as CAPTURE_SCOPE (JSON). */
-    scope?: Record<string, string>;
-};
-export type RunOutcome = 'passed' | 'failed' | 'skipped';
-export type RunSpecsResult = {
-    exitCode: number;
-    stdout: string;
-    stderr: string;
-    /** Distinguishes a skipped spec (exit 0 + "skipped") from a real pass — so a prerequisite
-        skip isn't miscounted as a capture. */
-    outcome: RunOutcome;
-};
-/** Classify a single-spec run: nonzero → failed; else "skipped" only if Playwright reported a
-    skip and no pass; otherwise passed. (Per-spec mode runs exactly one test, so it's unambiguous.) */
-export declare function classifyOutcome(exitCode: number, stdout: string): RunOutcome;
-export declare function runSpecs(args: RunSpecsArgs): Promise<RunSpecsResult>;

package/dist/scripts/postinstall.d.ts

@@ -1 +0,0 @@
-export {};