@wasao/kagemusha 0.1.0

package/dist/lib/upload.js

@@ -0,0 +1,43 @@
+import fs from "node:fs";
+import { PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
+export async function uploadToS3(config, results, _projectRoot) {
+    if (!config.publish) {
+        throw new Error("publish config is required for S3 upload");
+    }
+    const client = new S3Client({});
+    const uploadResults = [];
+    for (const result of results) {
+        const imagePath = result.annotatedPath;
+        if (!fs.existsSync(imagePath)) {
+            console.warn(`Image not found, skipping: ${imagePath}`);
+            continue;
+        }
+        const body = fs.readFileSync(imagePath);
+        const key = `${result.id}/latest.png`;
+        await client.send(new PutObjectCommand({
+            Bucket: config.publish.cdnBucket,
+            Key: key,
+            Body: body,
+            ContentType: "image/png",
+            CacheControl: "no-cache",
+        }));
+        // Also upload with timestamp for history
+        const historyKey = `${result.id}/${result.timestamp}.png`;
+        await client.send(new PutObjectCommand({
+            Bucket: config.publish.cdnBucket,
+            Key: historyKey,
+            Body: body,
+            ContentType: "image/png",
+        }));
+        const url = `${config.publish.cdnBaseUrl}/${key}`;
+        uploadResults.push({
+            id: result.id,
+            url,
+            bucket: config.publish.cdnBucket ?? "",
+            key,
+        });
+        console.log(`  Uploaded: ${result.id} → ${url}`);
+    }
+    return uploadResults;
+}
+//# sourceMappingURL=upload.js.map

package/dist/lib/upload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upload.js","sourceRoot":"","sources":["../../src/lib/upload.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAUhE,MAAM,CAAC,KAAK,UAAU,UAAU,CAC/B,MAAuB,EACvB,OAAwB,EACxB,YAAoB;IAEpB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC,EAAE,CAAC,CAAC;IAChC,MAAM,aAAa,GAAmB,EAAE,CAAC;IAEzC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,MAAM,CAAC,aAAa,CAAC;QACvC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC/B,OAAO,CAAC,IAAI,CAAC,8BAA8B,SAAS,EAAE,CAAC,CAAC;YACxD,SAAS;QACV,CAAC;QAED,MAAM,IAAI,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACxC,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,EAAE,aAAa,CAAC;QAEtC,MAAM,MAAM,CAAC,IAAI,CAChB,IAAI,gBAAgB,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS;YAChC,GAAG,EAAE,GAAG;YACR,IAAI,EAAE,IAAI;YACV,WAAW,EAAE,WAAW;YACxB,YAAY,EAAE,UAAU;SACxB,CAAC,CACF,CAAC;QAEF,yCAAyC;QACzC,MAAM,UAAU,GAAG,GAAG,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,SAAS,MAAM,CAAC;QAC1D,MAAM,MAAM,CAAC,IAAI,CAChB,IAAI,gBAAgB,CAAC;YACpB,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS;YAChC,GAAG,EAAE,UAAU;YACf,IAAI,EAAE,IAAI;YACV,WAAW,EAAE,WAAW;SACxB,CAAC,CACF,CAAC;QAEF,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,UAAU,IAAI,GAAG,EAAE,CAAC;QAClD,aAAa,CAAC,IAAI,CAAC;YAClB,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,GAAG;YACH,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE;YACtC,GAAG;SACH,CAAC,CAAC;QAEH,OAAO,CAAC,GAAG,CAAC,eAAe,MAAM,CAAC,EAAE,MAAM,GAAG,EAAE,CAAC,CAAC;IAClD,CAAC;IAED,OAAO,aAAa,CAAC;AACtB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,168 @@
+export interface KagemushaConfig {
+    app: {
+        baseUrl: string;
+    };
+    auth?: {
+        loginUrl: string;
+        steps: CaptureAction[];
+    };
+    screenshot: {
+        defaultViewport: Viewport;
+        defaultDiffThreshold: number;
+    };
+    publish?: {
+        destination: "local" | "s3" | "intercom";
+        outputDir?: string;
+        cdnBucket?: string;
+        cdnBaseUrl?: string;
+    };
+    routing?: Route[];
+    notification?: {
+        slack?: {
+            webhookUrl: string;
+        };
+    };
+}
+export interface Route {
+    pattern: string;
+    screenshots: string[];
+}
+export interface Viewport {
+    width: number;
+    height: number;
+    deviceScaleFactor?: number;
+}
+export interface ScreenshotDefinition {
+    id: string;
+    name: string;
+    url: string;
+    urlParams?: Record<string, string>;
+    viewport?: Viewport;
+    beforeCapture?: CaptureAction[];
+    capture: CaptureConfig;
+    decorations?: Decoration[];
+    hideElements?: string[];
+    intercom?: {
+        articleId: string;
+        imageSelector?: string;
+    };
+}
+export type CaptureAction = {
+    action: "click";
+    selector: string;
+} | {
+    action: "type";
+    selector: string;
+    text: string;
+} | {
+    action: "select";
+    selector: string;
+    value: string;
+} | {
+    action: "hover";
+    selector: string;
+} | {
+    action: "scroll";
+    selector?: string;
+    y: number;
+} | {
+    action: "wait";
+    ms: number;
+} | {
+    action: "waitForSelector";
+    selector: string;
+    timeout?: number;
+} | {
+    action: "waitForNavigation";
+    timeout?: number;
+} | {
+    action: "evaluate";
+    script: string;
+};
+export type CaptureConfig = {
+    mode: "fullPage";
+} | {
+    mode: "selector";
+    selector: string;
+} | {
+    mode: "crop";
+    crop: {
+        start: {
+            x: number;
+            y: number;
+        };
+        end: {
+            x: number;
+            y: number;
+        };
+    };
+};
+export type Decoration = RectDecoration | ArrowDecoration | LabelDecoration;
+export interface RectDecoration {
+    type: "rect";
+    target: {
+        selector: string;
+    } | {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    style?: {
+        color?: string;
+        strokeWidth?: number;
+        borderRadius?: number;
+    };
+}
+export interface ArrowDecoration {
+    type: "arrow";
+    from: {
+        x: number;
+        y: number;
+    } | {
+        selector: string;
+        anchor?: string;
+    };
+    to: {
+        x: number;
+        y: number;
+    } | {
+        selector: string;
+        anchor?: string;
+    };
+    style?: {
+        color?: string;
+        strokeWidth?: number;
+    };
+}
+export interface LabelDecoration {
+    type: "label";
+    text: string;
+    position: {
+        x: number;
+        y: number;
+    } | {
+        selector: string;
+        anchor?: string;
+    };
+    style?: {
+        fontSize?: number;
+        color?: string;
+        background?: string;
+    };
+}
+export interface CaptureResult {
+    id: string;
+    rawPath: string;
+    annotatedPath: string;
+    timestamp: string;
+}
+export interface CompareResult {
+    id: string;
+    status: "unchanged" | "minor" | "changed";
+    diffRate: number;
+    beforePath?: string;
+    afterPath?: string;
+    diffPath?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC/B,GAAG,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,CAAC,EAAE;QACN,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,aAAa,EAAE,CAAC;KACvB,CAAC;IACF,UAAU,EAAE;QACX,eAAe,EAAE,QAAQ,CAAC;QAC1B,oBAAoB,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,OAAO,CAAC,EAAE;QACT,WAAW,EAAE,OAAO,GAAG,IAAI,GAAG,UAAU,CAAC;QACzC,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC;IAClB,YAAY,CAAC,EAAE;QACd,KAAK,CAAC,EAAE;YACP,UAAU,EAAE,MAAM,CAAC;SACnB,CAAC;KACF,CAAC;CACF;AAED,MAAM,WAAW,KAAK;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,aAAa,CAAC,EAAE,aAAa,EAAE,CAAC;IAChC,OAAO,EAAE,aAAa,CAAC;IACvB,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,QAAQ,CAAC,EAAE;QACV,SAAS,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;CACF;AAED,MAAM,MAAM,aAAa,GACtB;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACrC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACrD;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACrC;IAAE,MAAM,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,GAClD;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,EAAE,EAAE,MAAM,CAAA;CAAE,GAC9B;IAAE,MAAM,EAAE,iBAAiB,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GACjE;IAAE,MAAM,EAAE,mBAAmB,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GACjD;IAAE,MAAM,EAAE,UAAU,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1C,MAAM,MAAM,aAAa,GACtB;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GACpB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GACtC;IACA,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE;QAAE,KAAK,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,GAAG,EAAE;YAAE,CAAC,EAAE,MAAM,CAAC;YAAC,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;CACxE,CAAC;AAEL,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,eAAe,GAAG,eAAe,CAAC;AAE5E,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EACH;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,GACpB;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3D,KAAK,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACF;AAED,MAAM,WAAW,eAAe;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACvE,EAAE,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACrE,KAAK,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACF;AAED,MAAM,WAAW,eAAe;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3E,KAAK,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;CACF;AAED,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,WAAW,GAAG,OAAO,GAAG,SAAS,CAAC;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@wasao/kagemusha",
+  "version": "0.1.0",
+  "description": "Auto-update help center screenshots when your code changes. The shadow warrior for your documentation.",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "bin": {
+    "kagemusha": "dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "bun --watch src/index.ts",
+    "typecheck": "tsc --noEmit",
+    "lint": "bunx biome check .",
+    "format": "bunx biome format --write .",
+    "test": "bun test",
+    "prepare": "husky",
+    "prepublishOnly": "bun run build"
+  },
+  "keywords": [
+    "screenshot",
+    "documentation",
+    "help-center",
+    "intercom",
+    "playwright",
+    "vrt",
+    "visual-regression",
+    "automation"
+  ],
+  "author": "iwasawahideto",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iwasawahideto/kagemusha.git"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.700.0",
+    "chalk": "^5.4.0",
+    "commander": "^13.0.0",
+    "glob": "^11.0.0",
+    "inquirer": "^12.0.0",
+    "playwright-chromium": "^1.50.0",
+    "sharp": "^0.34.5",
+    "yaml": "^2.7.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^2.4.12",
+    "@types/bun": "latest",
+    "@types/inquirer": "^9.0.0",
+    "@types/node": "^22.0.0",
+    "@types/sharp": "^0.32.0",
+    "husky": "^9.1.7",
+    "typescript": "^5.7.0"
+  }
+}