@argos-ci/storybook 0.1.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 Smooth Code
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,20 @@
+<p align="center">
+  <a href="https://argos-ci.com/?utm_source=github&utm_medium=logo" target="_blank">
+    <img src="https://raw.githubusercontent.com/argos-ci/argos/main/resources/logos/logo-github-readme.png" alt="Argos" width="300" height="61">
+  </a>
+</p>
+
+_Argos is a visual testing solution that fits in your workflow to avoid visual regression. Takes screenshots on each commit and be notified if something changes._
+
+# Official Argos Storybook integration
+
+[![npm version](https://img.shields.io/npm/v/@argos-ci/storybook.svg)](https://www.npmjs.com/package/@argos-ci/storybook)
+[![npm dm](https://img.shields.io/npm/dm/@argos-ci/storybook.svg)](https://www.npmjs.com/package/@argos-ci/storybook)
+[![npm dt](https://img.shields.io/npm/dt/@argos-ci/storybook.svg)](https://www.npmjs.com/package/@argos-ci/storybook)
+
+Visit [argos-ci.com/docs/storybook](https://argos-ci.com/docs/storybook) for guides, API and more.
+
+## Links
+
+- [Official SDK Docs](https://argos-ci.com/docs/)
+- [Discord](https://argos-ci.com/discord)

package/dist/index.cjs

@@ -0,0 +1,7 @@
+// @ts-ignore
+const argosScreenshot = async (...args)=>{
+    // @ts-ignore
+    const { argosScreenshot } = await import('./index.mjs');
+    return argosScreenshot(...args);
+};
+exports.argosScreenshot = argosScreenshot;

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+import { TestContext } from "@storybook/test-runner";
+import { ArgosScreenshotOptions as ArgosPlaywrightScreenshotOptions } from "@argos-ci/playwright";
+import { Page } from "playwright";
+type ArgosScreenshotOptions = {
+    /**
+     * Fit the screenshot to the content size.
+     * @default true
+     */
+    fitToContent?: boolean | {
+        /**
+         * Padding around the content in pixels.
+         * @default 16
+         */
+        padding?: number;
+        /**
+         * Zoom level.
+         * @default 2
+         */
+        zoom?: number;
+    };
+} & ArgosPlaywrightScreenshotOptions;
+/**
+ * Stabilize the UI and takes a screenshot of the application under test.
+ *
+ * @example
+ *    argosScreenshot(page, "my-screenshot")
+ * @see https://argos-ci.com/docs/playwright#api-overview
+ */
+declare function argosScreenshot(
+/**
+ * Playwright `page` object.
+ */
+page: Page, 
+/**
+ * Context of the test.
+ */
+context: TestContext, 
+/**
+ * Options for the screenshot.
+ */
+options?: ArgosScreenshotOptions): Promise<void>;
+export { ArgosScreenshotOptions, argosScreenshot };

package/dist/index.mjs

@@ -0,0 +1,57 @@
+import { waitForPageReady } from '@storybook/test-runner';
+import { DO_NOT_USE_setMetadataConfig, argosScreenshot as argosScreenshot$1 } from '@argos-ci/playwright';
+import { join } from 'node:path';
+import { readVersionFromPackage } from '@argos-ci/util';
+import { createRequire } from 'node:module';
+
+const require = createRequire(import.meta.url);
+/**
+ * Get the version of the Argos Playwright SDK.
+ */ async function getArgosStorybookVersion() {
+    const pkgPath = require.resolve("@argos-ci/storybook/package.json");
+    return readVersionFromPackage(pkgPath);
+}
+
+/**
+ * Stabilize the UI and takes a screenshot of the application under test.
+ *
+ * @example
+ *    argosScreenshot(page, "my-screenshot")
+ * @see https://argos-ci.com/docs/playwright#api-overview
+ */ async function argosScreenshot(/**
+   * Playwright `page` object.
+   */ page, /**
+   * Context of the test.
+   */ context, /**
+   * Options for the screenshot.
+   */ options) {
+    const { fitToContent = true, ...screenshotOptions } = options ?? {};
+    await waitForPageReady(page);
+    const fitToContentOptions = (()=>{
+        if (options?.element || !fitToContent) {
+            return {};
+        }
+        const { padding = 16, zoom = 2 } = fitToContent === true ? {} : fitToContent;
+        return {
+            element: "#storybook-root",
+            argosCSS: `#storybook-root { padding: ${padding}px; width: fit-content; height: fit-content; zoom: ${zoom}; }` + (options?.argosCSS ?? "")
+        };
+    })();
+    const version = await getArgosStorybookVersion();
+    await DO_NOT_USE_setMetadataConfig({
+        sdk: {
+            name: "@argos-ci/storybook",
+            version
+        },
+        playwrightLibraries: [
+            "playwright",
+            "playwright-core"
+        ]
+    });
+    await argosScreenshot$1(page, join(context.title, context.name), {
+        ...screenshotOptions,
+        ...fitToContentOptions
+    });
+}
+
+export { argosScreenshot };

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@argos-ci/storybook",
+  "description": "Visual testing for Storybook test runner.",
+  "version": "0.1.0",
+  "author": "Smooth Code",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/argos-ci/argos-javascript.git",
+    "directory": "packages/storybook"
+  },
+  "homepage": "https://argos-ci.com/docs/storybook",
+  "keywords": [
+    "storybook",
+    "storybook-addon",
+    "screenshot",
+    "capture",
+    "testing",
+    "visual testing",
+    "argos",
+    "regression",
+    "visual regression"
+  ],
+  "bin": {
+    "argos-storybook": "./bin/argos-storybook.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=18.16.0"
+  },
+  "dependencies": {
+    "@argos-ci/playwright": "3.8.0",
+    "@argos-ci/util": "2.1.2"
+  },
+  "peerDependencies": {
+    "@storybook/test-runner": "*",
+    "playwright": "*"
+  },
+  "devDependencies": {
+    "@argos-ci/cli": "2.4.7",
+    "@argos-ci/util": "workspace:*",
+    "@storybook/addon-essentials": "^8.3.6",
+    "@storybook/addon-interactions": "^8.3.6",
+    "@storybook/addon-links": "^8.3.6",
+    "@storybook/blocks": "^8.3.6",
+    "@storybook/react": "^8.3.6",
+    "@storybook/react-vite": "^8.3.6",
+    "@storybook/test": "^8.3.6",
+    "@storybook/test-runner": "^0.19.1",
+    "playwright": "^1.48.1",
+    "prop-types": "^15.8.1",
+    "storybook": "^8.3.6"
+  },
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "rollup -c",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build",
+    "test-storybook": "NODE_NO_WARNINGS=1 NODE_OPTIONS=--experimental-vm-modules test-storybook",
+    "argos-upload": "pnpm exec argos upload screenshots --build-name \"argos-storybook-e2e-node-$NODE_VERSION-$OS\"",
+    "e2e": "pnpm run test-storybook && pnpm run argos-upload"
+  },
+  "gitHead": "d0fa8cd790ffd2343d1cd32706bcb757c4f3b26e"
+}