storybook-addon-vis 0.10.1 → 0.10.2

package/dist/vitest-setup.js

@@ -1,6 +1,6 @@
 import { toMatchImageSnapshot, state, page } from './chunk-B2M7JPBQ.js';
 export { cdp, commands, page, server, toMatchImageSnapshot } from './chunk-B2M7JPBQ.js';
-import { expect } from 'vitest';
+import { expect, beforeAll, afterEach } from 'vitest';
 
 // src/should_take_snapshot.ts
 function shouldTakeSnapshot() {

package/dist/vitest-setup.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/should_take_snapshot.ts","../src/vis.ts"],"names":[],"mappings":";;;;;AASO,SAAS,kBAAqB,GAAA;AACpC,EAAA,OAAO,MAAM,kBAAmB,EAAA;AACjC;;;ACHA,MAAO,CAAA,MAAA,CAAO,EAAE,oBAAA,EAAsB,CAAA;AAE/B,SAAS,gBAAgB,OAAsB,EAAA;AACrD,EAAA,MAAM,CAAI,GAAA;AAAA,IACT,OAAS,EAAA;AAAA,MACR,KAAQ,GAAA;AACP,QAAA,SAAA,CAAU,EAAE,SAAS,CAAA;AACrB,QAAU,SAAA,CAAA,CAAA,CAAE,UAAU,kBAAkB,CAAA;AAAA,OACzC;AAAA,MACA,MAAM,MAAoD,EAAA;AACzD,QAAA,SAAA,CAAU,EAAE,SAAS,CAAA;AACrB,QAAA,SAAA,CAAU,CAAE,CAAA,SAAA,CAAU,aAAc,CAAA,MAAM,CAAC,CAAA;AAAA;AAC5C,KACD;AAAA,IACA,MAAM,UAAU,KAAqD,EAAA;AACpE,MAAO,OAAA,KAAA,CAAM,UAAW,CAAA,KAAA,EAAO,OAAO,CAAA;AAAA,KACvC;AAAA,IACA,SAAW,EAAA;AAAA,MACV,MAAM,kBAAqB,GAAA;AAC1B,QAAI,IAAA,CAAC,oBAAsB,EAAA;AAC3B,QAAM,MAAA,CAAA,GAAI,MAAM,IAAA,CAAK,aAAc,EAAA;AACnC,QAAO,MAAA,CAAA,CAAC,EAAE,oBAAqB,EAAA;AAAA,OAChC;AAAA,MACA,cAAc,MAAoD,EAAA;AACjE,QAAA,OAAO,eAAe,kBAAqB,GAAA;AAC1C,UAAI,IAAA,CAAC,oBAAsB,EAAA;AAC3B,UAAA,KAAA,MAAW,WAAW,MAAQ,EAAA;AAC7B,YAAM,MAAA,MAAA,CAAO,OAAO,CAAE,EAAA;AACtB,YAAM,MAAA,CAAA,GAAI,MAAM,IAAA,CAAK,aAAc,CAAA;AAAA,cAClC,qBAAqB,CAAC,EAAA,KAAO,CAAG,EAAA,EAAE,IAAI,OAAO,CAAA;AAAA,aAC7C,CAAA;AACD,YAAM,MAAA,MAAA,CAAO,CAAC,CAAA,CAAE,oBAAqB,EAAA;AAAA;AACtC,SACD;AAAA;AACD;AACD,GACD;AACA,EAAO,OAAA,CAAA;AACR","file":"vitest-setup.js","sourcesContent":["import { state } from './state'\n\n/**\n * Determine should snapshot be taken.\n *\n * not story: false\n * no `snapshot` tag: false\n * disabled by `!snapshot` tag: false\n */\nexport function shouldTakeSnapshot() {\n\treturn state.shouldTakeSnapshot()\n}\n","import { expect } from 'vitest'\nimport { page } from './@vitest/browser/context.js'\nimport './augment.js'\nimport { toMatchImageSnapshot } from './expect.to_match_image_snapshot.js'\nimport { shouldTakeSnapshot } from './should_take_snapshot.js'\nimport { state } from './state.js'\nimport type { VisOptions } from './types.js'\n\nexpect.extend({ toMatchImageSnapshot })\n\nexport function createVisConfig(options?: VisOptions) {\n\tconst h = {\n\t\tpresets: {\n\t\t\tbasic() {\n\t\t\t\tbeforeAll(h.beforeAll)\n\t\t\t\tafterEach(h.afterEach.matchImageSnapshot)\n\t\t\t},\n\t\t\ttheme(themes: Record<string, () => void | Promise<void>>) {\n\t\t\t\tbeforeAll(h.beforeAll)\n\t\t\t\tafterEach(h.afterEach.matchPerTheme(themes))\n\t\t\t},\n\t\t},\n\t\tasync beforeAll(suite: { file: { filepath: string }; name: string }) {\n\t\t\treturn state.setupSuite(suite, options)\n\t\t},\n\t\tafterEach: {\n\t\t\tasync matchImageSnapshot() {\n\t\t\t\tif (!shouldTakeSnapshot()) return\n\t\t\t\tconst r = await page.imageSnapshot()\n\t\t\t\texpect(r).toMatchImageSnapshot()\n\t\t\t},\n\t\t\tmatchPerTheme(themes: Record<string, () => Promise<void> | void>) {\n\t\t\t\treturn async function matchImageSnapshot() {\n\t\t\t\t\tif (!shouldTakeSnapshot()) return\n\t\t\t\t\tfor (const themeId in themes) {\n\t\t\t\t\t\tawait themes[themeId]()\n\t\t\t\t\t\tconst r = await page.imageSnapshot({\n\t\t\t\t\t\t\tcustomizeSnapshotId: (id) => `${id}-${themeId}`,\n\t\t\t\t\t\t})\n\t\t\t\t\t\tawait expect(r).toMatchImageSnapshot()\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t},\n\t}\n\treturn h\n}\n"]}
+{"version":3,"sources":["../src/should_take_snapshot.ts","../src/vis.ts"],"names":[],"mappings":";;;;;AASO,SAAS,kBAAqB,GAAA;AACpC,EAAA,OAAO,MAAM,kBAAmB,EAAA;AACjC;;;ACHA,MAAO,CAAA,MAAA,CAAO,EAAE,oBAAA,EAAsB,CAAA;AAE/B,SAAS,gBAAgB,OAAsB,EAAA;AACrD,EAAA,MAAM,CAAI,GAAA;AAAA,IACT,OAAS,EAAA;AAAA,MACR,KAAQ,GAAA;AACP,QAAA,SAAA,CAAU,EAAE,SAAS,CAAA;AACrB,QAAU,SAAA,CAAA,CAAA,CAAE,UAAU,kBAAkB,CAAA;AAAA,OACzC;AAAA,MACA,MAAM,MAAoD,EAAA;AACzD,QAAA,SAAA,CAAU,EAAE,SAAS,CAAA;AACrB,QAAA,SAAA,CAAU,CAAE,CAAA,SAAA,CAAU,aAAc,CAAA,MAAM,CAAC,CAAA;AAAA;AAC5C,KACD;AAAA,IACA,MAAM,UAAU,KAAqD,EAAA;AACpE,MAAO,OAAA,KAAA,CAAM,UAAW,CAAA,KAAA,EAAO,OAAO,CAAA;AAAA,KACvC;AAAA,IACA,SAAW,EAAA;AAAA,MACV,MAAM,kBAAqB,GAAA;AAC1B,QAAI,IAAA,CAAC,oBAAsB,EAAA;AAC3B,QAAM,MAAA,CAAA,GAAI,MAAM,IAAA,CAAK,aAAc,EAAA;AACnC,QAAO,MAAA,CAAA,CAAC,EAAE,oBAAqB,EAAA;AAAA,OAChC;AAAA,MACA,cAAc,MAAoD,EAAA;AACjE,QAAA,OAAO,eAAe,kBAAqB,GAAA;AAC1C,UAAI,IAAA,CAAC,oBAAsB,EAAA;AAC3B,UAAA,KAAA,MAAW,WAAW,MAAQ,EAAA;AAC7B,YAAM,MAAA,MAAA,CAAO,OAAO,CAAE,EAAA;AACtB,YAAM,MAAA,CAAA,GAAI,MAAM,IAAA,CAAK,aAAc,CAAA;AAAA,cAClC,qBAAqB,CAAC,EAAA,KAAO,CAAG,EAAA,EAAE,IAAI,OAAO,CAAA;AAAA,aAC7C,CAAA;AACD,YAAM,MAAA,MAAA,CAAO,CAAC,CAAA,CAAE,oBAAqB,EAAA;AAAA;AACtC,SACD;AAAA;AACD;AACD,GACD;AACA,EAAO,OAAA,CAAA;AACR","file":"vitest-setup.js","sourcesContent":["import { state } from './state'\n\n/**\n * Determine should snapshot be taken.\n *\n * not story: false\n * no `snapshot` tag: false\n * disabled by `!snapshot` tag: false\n */\nexport function shouldTakeSnapshot() {\n\treturn state.shouldTakeSnapshot()\n}\n","import { afterEach, beforeAll, expect } from 'vitest'\nimport { page } from './@vitest/browser/context.js'\nimport './augment.js'\nimport { toMatchImageSnapshot } from './expect.to_match_image_snapshot.js'\nimport { shouldTakeSnapshot } from './should_take_snapshot.js'\nimport { state } from './state.js'\nimport type { VisOptions } from './types.js'\n\nexpect.extend({ toMatchImageSnapshot })\n\nexport function createVisConfig(options?: VisOptions) {\n\tconst h = {\n\t\tpresets: {\n\t\t\tbasic() {\n\t\t\t\tbeforeAll(h.beforeAll)\n\t\t\t\tafterEach(h.afterEach.matchImageSnapshot)\n\t\t\t},\n\t\t\ttheme(themes: Record<string, () => void | Promise<void>>) {\n\t\t\t\tbeforeAll(h.beforeAll)\n\t\t\t\tafterEach(h.afterEach.matchPerTheme(themes))\n\t\t\t},\n\t\t},\n\t\tasync beforeAll(suite: { file: { filepath: string }; name: string }) {\n\t\t\treturn state.setupSuite(suite, options)\n\t\t},\n\t\tafterEach: {\n\t\t\tasync matchImageSnapshot() {\n\t\t\t\tif (!shouldTakeSnapshot()) return\n\t\t\t\tconst r = await page.imageSnapshot()\n\t\t\t\texpect(r).toMatchImageSnapshot()\n\t\t\t},\n\t\t\tmatchPerTheme(themes: Record<string, () => Promise<void> | void>) {\n\t\t\t\treturn async function matchImageSnapshot() {\n\t\t\t\t\tif (!shouldTakeSnapshot()) return\n\t\t\t\t\tfor (const themeId in themes) {\n\t\t\t\t\t\tawait themes[themeId]()\n\t\t\t\t\t\tconst r = await page.imageSnapshot({\n\t\t\t\t\t\t\tcustomizeSnapshotId: (id) => `${id}-${themeId}`,\n\t\t\t\t\t\t})\n\t\t\t\t\t\tawait expect(r).toMatchImageSnapshot()\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t},\n\t}\n\treturn h\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storybook-addon-vis",
-  "version": "0.10.1",
+  "version": "0.10.2",
   "description": "Storybook Vitest Image Snapshot addon",
   "keywords": [
     "image-snapshot",

package/src/expect.to_match_image_snapshot.global.spec.ts

@@ -1,3 +1,5 @@
+import { expect, it } from 'vitest'
+
 it('should be available in global expect', () => {
 	expect(typeof expect('something').toMatchImageSnapshot).toBe('function')
 })

package/src/expect.to_match_image_snapshot.spec.ts

@@ -1,7 +1,7 @@
 import { composeStories } from '@storybook/react'
 import { screen } from '@testing-library/react'
 import { assertType } from 'type-plus'
-import { expect, it } from 'vitest'
+import { expect, it, test } from 'vitest'
 import { page } from './@vitest/browser/context.js'
 import { toSnapshotId } from './@vitest/browser/image_snapshot.logic.js'
 import * as ToMatchStories from './expect.to_match_image_snapshot.stories.js'

package/src/vis.spec.ts

@@ -1,3 +1,4 @@
+import { expect, it } from 'vitest'
 import { state } from './state.js'
 import { createVisConfig } from './vis.js'
 

package/src/vis.ts

@@ -1,4 +1,4 @@
-import { expect } from 'vitest'
+import { afterEach, beforeAll, expect } from 'vitest'
 import { page } from './@vitest/browser/context.js'
 import './augment.js'
 import { toMatchImageSnapshot } from './expect.to_match_image_snapshot.js'

package/dist/vitest-plugin.d.ts

@@ -1,126 +0,0 @@
-import * as vitest_node from 'vitest/node';
-import { BrowserPage } from '@vitest/browser/context';
-import { PixelmatchOptions } from 'pixelmatch';
-
-interface ImageSnapshotOptions extends CustomizeSnapshotIdOptions {
-    element?: Element;
-    /**
-     * Timeout for taking the snapshot.
-     *
-     * Default: 30000
-     */
-    timeout?: number | undefined;
-}
-type CustomizeSnapshotIdOptions = {
-    /**
-     * Customize the snapshot id. This is used as the filename of the snapshot:
-     *
-     * `${snapshotId}.png`
-     *
-     * @param id The id of the snapshot.
-     * @param index The index of the snapshot.
-     */
-    customizeSnapshotId?: (id: string, index: number) => string;
-};
-type ImageSnapshot = {
-    type: symbol;
-    snapshotFilename: string;
-    baselinePath: string;
-    resultPath: string;
-    diffPath: string;
-    base64: string;
-    image: ImageData;
-};
-
-interface HasImageSnapshotAction {
-    hasImageSnapshot(this: BrowserPage, options?: CustomizeSnapshotIdOptions | undefined): Promise<boolean>;
-}
-
-interface ImageSnapshotAction {
-    imageSnapshot(this: BrowserPage, options?: ImageSnapshotOptions | undefined): Promise<ImageSnapshot>;
-}
-
-interface ImageSnapshotMatcher {
-    toMatchImageSnapshot(options?: MatchImageSnapshotOptions): Promise<void>;
-}
-type MatchImageSnapshotOptions = {
-    /**
-     * Custom options passed to 'pixelmatch'
-     */
-    diffOptions?: PixelmatchOptions | undefined;
-    /**
-     * Failure threshold should measure in `pixel` or `percent`.
-     *
-     * Default is `pixel`.
-     */
-    failureThresholdType?: 'pixel' | 'percent' | undefined;
-    /**
-     * Failure tolerance threshold.
-     *
-     * Default is `0`.
-     */
-    failureThreshold?: number | undefined;
-};
-
-interface CopyFileCommand {
-    copyFile(src: string, dest: string): Promise<void>;
-}
-
-interface ExistDirCommand {
-    existDir: (path: string) => Promise<boolean>;
-}
-
-interface ExistFileCommand {
-    existFile: (path: string) => Promise<boolean>;
-}
-
-interface GetSnapshotPlatformCommand {
-    /**
-     * Get the platform id of the snapshot `{platform}[-ci]`.
-     *
-     * This is useful to control where the snapshot is stored.
-     */
-    getSnapshotPlatform: () => Promise<string>;
-}
-
-interface IsCICommand {
-    isCI: () => Promise<boolean>;
-}
-
-interface RmDirCommand {
-    rmDir: (path: string) => Promise<void>;
-}
-
-declare module '@vitest/browser/context' {
-    interface BrowserPage extends ImageSnapshotAction, HasImageSnapshotAction {
-    }
-    interface BrowserCommands extends CopyFileCommand, ExistDirCommand, GetSnapshotPlatformCommand, RmDirCommand, IsCICommand, ExistFileCommand {
-    }
-}
-declare global {
-    namespace jest {
-        interface Matchers<R, T> extends ImageSnapshotMatcher {
-        }
-    }
-}
-
-declare function storybookVis(): {
-    name: string;
-    config(this: void): {
-        test: {
-            browser: {
-                name: string;
-                commands: {
-                    existDir: vitest_node.BrowserCommand<[path: string]>;
-                    existFile: vitest_node.BrowserCommand<[path: string]>;
-                    copyFile: vitest_node.BrowserCommand<[src: string, dest: string]>;
-                    rmDir: vitest_node.BrowserCommand<[path: string]>;
-                    isCI: () => Promise<boolean>;
-                    getSnapshotPlatform: () => Promise<NodeJS.Platform | "local">;
-                };
-            };
-        };
-    };
-};
-
-export { storybookVis };