@histoire/plugin-percy 0.17.16 → 1.0.0-alpha.1

package/README.md

@@ -2,7 +2,6 @@
 
 You need the [Percy CLI](https://docs.percy.io/docs/cli-overview) installed to be able to send snapshots to Percy.
 
-
 ```bash
 pnpm add -D @histoire/plugin-percy
 ```
@@ -10,8 +9,8 @@ pnpm add -D @histoire/plugin-percy
 Add the plugin in histoire config:
 
 ```js
-import { defineConfig } from 'histoire'
 import { HstPercy } from '@histoire/plugin-percy'
+import { defineConfig } from 'histoire'
 
 export default defineConfig({
   plugins: [

package/dist/index.d.ts

@@ -22,7 +22,7 @@ export interface PercySnapshotOptions {
         userAgent: string;
     }>;
 }
-export type PagePayload = {
+export interface PagePayload {
     file: string;
     story: {
         title: string;
@@ -31,7 +31,7 @@ export type PagePayload = {
         id: string;
         title: string;
     };
-};
+}
 type ContructorOption<T extends object | number> = T | ((payload: PagePayload) => T);
 export interface PercyPluginOptions {
     /**

package/dist/index.js

@@ -1,8 +1,8 @@
+import { createRequire } from 'node:module';
+import { fileURLToPath } from 'node:url';
+import { fetchPercyDOM, isPercyEnabled, postSnapshot } from '@percy/sdk-utils';
 import { defu } from 'defu';
 import path from 'pathe';
-import { fileURLToPath } from 'node:url';
-import { createRequire } from 'node:module';
-import { isPercyEnabled, fetchPercyDOM, postSnapshot } from '@percy/sdk-utils';
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const require = createRequire(import.meta.url);
 const defaultOptions = {
@@ -47,7 +47,7 @@ export function HstPercy(options = {}) {
                 const percyOptions = resolveOptions(finalOptions.percyOptions, payload);
                 const page = await browser.newPage();
                 await page.goto(url, pptrOptions);
-                await new Promise((resolve) => setTimeout(resolve, pptrWait));
+                await new Promise(resolve => setTimeout(resolve, pptrWait));
                 if (finalOptions.beforeSnapshot) {
                     const result = await finalOptions.beforeSnapshot(page, payload);
                     if (result === false) {

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@histoire/plugin-percy",
-  "version": "0.17.16",
+  "type": "module",
+  "version": "1.0.0-alpha.1",
   "description": "Histoire plugin to take screenshots with Percy for visual regression testing",
-  "license": "MIT",
   "author": {
     "name": "Guillaume Chau"
   },
+  "license": "MIT",
   "repository": {
     "url": "https://github.com/Akryum/histoire.git",
     "type": "git",
@@ -14,7 +15,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "type": "module",
   "exports": {
     ".": "./dist/index.js",
     "./*": "./*"
@@ -22,20 +22,20 @@
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "peerDependencies": {
+    "histoire": "^1.0.0-alpha.1"
+  },
   "dependencies": {
-    "@percy/sdk-utils": "^1.27.4",
-    "defu": "^6.1.3",
-    "fs-extra": "^10.1.0",
-    "pathe": "^1.1.1",
-    "puppeteer": "^13.7.0"
+    "@percy/sdk-utils": "^1.30.4",
+    "defu": "^6.1.4",
+    "fs-extra": "^11.2.0",
+    "pathe": "^1.1.2",
+    "puppeteer": "^23.10.1"
   },
   "devDependencies": {
-    "@types/node": "^18.11.9",
-    "typescript": "^4.9.5",
-    "histoire": "0.17.16"
-  },
-  "peerDependencies": {
-    "histoire": "^0.17.16"
+    "@types/node": "^22.10.1",
+    "typescript": "5.6.3",
+    "histoire": "1.0.0-alpha.1"
   },
   "scripts": {
     "build": "rimraf dist && tsc -d",

package/src/index.ts

@@ -1,10 +1,10 @@
 import type { Plugin } from 'histoire'
+import type { Page, WaitForOptions } from 'puppeteer'
+import { createRequire } from 'node:module'
+import { fileURLToPath } from 'node:url'
+import { fetchPercyDOM, isPercyEnabled, postSnapshot } from '@percy/sdk-utils'
 import { defu } from 'defu'
 import path from 'pathe'
-import { fileURLToPath } from 'node:url'
-import { createRequire } from 'node:module'
-import { isPercyEnabled, fetchPercyDOM, postSnapshot } from '@percy/sdk-utils'
-import type { JSONObject, Page, WaitForOptions } from 'puppeteer'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 const require = createRequire(import.meta.url)
@@ -32,15 +32,15 @@ export interface PercySnapshotOptions {
   }>
 }
 
-export type PagePayload = {
+export interface PagePayload {
   file: string
   story: { title: string }
   variant: { id: string, title: string }
-};
+}
 
 type ContructorOption<T extends object | number> =
   | T
-  | ((payload: PagePayload) => T);
+  | ((payload: PagePayload) => T)
 
 export interface PercyPluginOptions {
   /**
@@ -61,9 +61,9 @@ export interface PercyPluginOptions {
    * Navigation Parameter
    */
   pptrOptions?: ContructorOption<
-  WaitForOptions & {
-    referer?: string
-  }
+    WaitForOptions & {
+      referer?: string
+    }
   >
 
   /**
@@ -85,14 +85,14 @@ const defaultOptions: PercyPluginOptions = {
   pptrOptions: {},
 }
 
-function resolveOptions<T extends object | number> (
+function resolveOptions<T extends object | number>(
   option: ContructorOption<T>,
   payload: PagePayload,
 ): T {
   return typeof option === 'function' ? option(payload) : option
 }
 
-export function HstPercy (options: PercyPluginOptions = {}): Plugin {
+export function HstPercy(options: PercyPluginOptions = {}): Plugin {
   const finalOptions: PercyPluginOptions = defu(options, defaultOptions)
   return {
     name: '@histoire/plugin-percy',
@@ -134,7 +134,7 @@ export function HstPercy (options: PercyPluginOptions = {}): Plugin {
         const page = await browser.newPage()
         await page.goto(url, pptrOptions)
 
-        await new Promise((resolve) => setTimeout(resolve, pptrWait))
+        await new Promise(resolve => setTimeout(resolve, pptrWait))
 
         if (finalOptions.beforeSnapshot) {
           const result = await finalOptions.beforeSnapshot(page, payload)
@@ -148,7 +148,7 @@ export function HstPercy (options: PercyPluginOptions = {}): Plugin {
         const domSnapshot = await page.evaluate((opts) => {
           // @ts-expect-error window global var
           return window.PercyDOM.serialize(opts)
-        }, percyOptions as JSONObject)
+        }, percyOptions)
         await postSnapshot({
           ...percyOptions,
           environmentInfo: ENV_INFO,

package/tsconfig.json

@@ -1,32 +1,32 @@
 {
   "compilerOptions": {
     "target": "ESNext",
+    // Volar
+    "jsx": "preserve",
+    "lib": [
+      "ESNext",
+      "DOM"
+    ],
+    "rootDir": "src",
     "module": "ESNext",
     "moduleResolution": "node",
-    "outDir": "dist",
-    "rootDir": "src",
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
-    "removeComments": false,
     "resolveJsonModule": true,
-    "skipLibCheck": true,
     "types": [
       "node"
     ],
-    "lib": [
-      "ESNext",
-      "DOM"
-    ],
-    "sourceMap": false,
-    "preserveWatchOutput": true,
+    "strictBindCallApply": true,
+    "strictFunctionTypes": true,
+    "alwaysStrict": true,
     // Strict
     "noImplicitAny": false,
     "noImplicitThis": true,
-    "alwaysStrict": true,
-    "strictBindCallApply": true,
-    "strictFunctionTypes": true,
-    // Volar
-    "jsx": "preserve",
+    "outDir": "dist",
+    "removeComments": false,
+    "sourceMap": false,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "preserveWatchOutput": true
   },
   "include": [
     "src"