storybook-addon-vis 0.15.7 → 0.16.0

package/dist/index.d.ts

@@ -12,6 +12,6 @@ declare function defineAutoSnapshotParam(snapshot: ToMatchImageSnapshotOptions):
 /**
  * Check if the snapshot image exists.
  */
-declare function hasImageSnapshot(options?: ImageSnapshotIdOptions | undefined): Promise<boolean>;
+declare function hasImageSnapshot(options?: ImageSnapshotIdOptions | undefined): false | Promise<boolean>;
 
 export { defineAutoSnapshotParam, hasImageSnapshot };

package/dist/index.js

@@ -6,11 +6,9 @@ import { toTaskId } from 'vitest-plugin-vis/client';
 function defineAutoSnapshotParam(snapshot) {
   return { snapshot };
 }
-async function hasImageSnapshot(options) {
+function hasImageSnapshot(options) {
   const test = getCurrentTest();
-  if (!test) {
-    return false;
-  }
+  if (!test) return false;
   const taskId = toTaskId(test);
   if (options?.customizeSnapshotId) {
     return commands.imageSnapshotNextIndex(taskId).then((index) => commands.hasImageSnapshot(taskId, options.customizeSnapshotId(taskId, index)));

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/client/storybook/param.ts","../src/client/has_image_snapshot.ts"],"names":[],"mappings":";;;;;AAKO,SAAS,wBAAwB,QAAuC,EAAA;AAC9E,EAAA,OAAO,EAAE,QAAS,EAAA;AACnB;ACDA,eAAsB,iBAAiB,OAA8C,EAAA;AACpF,EAAA,MAAM,OAAO,cAAe,EAAA;AAC5B,EAAA,IAAI,CAAC,IAAM,EAAA;AACV,IAAO,OAAA,KAAA;AAAA;AAGR,EAAM,MAAA,MAAA,GAAS,SAAS,IAAI,CAAA;AAC5B,EAAA,IAAI,SAAS,mBAAqB,EAAA;AACjC,IAAA,OAAO,QACL,CAAA,sBAAA,CAAuB,MAAM,CAAA,CAC7B,KAAK,CAAC,KAAA,KAAU,QAAS,CAAA,gBAAA,CAAiB,QAAQ,OAAQ,CAAA,mBAAA,CAAqB,MAAQ,EAAA,KAAK,CAAC,CAAC,CAAA;AAAA;AAGjG,EAAO,OAAA,QAAA,CAAS,iBAAiB,MAAM,CAAA;AACxC","file":"index.js","sourcesContent":["import type { ToMatchImageSnapshotOptions } from 'vitest-plugin-vis/client'\n\n/**\n * Define snapshot parameter for auto snapshot.\n */\nexport function defineAutoSnapshotParam(snapshot: ToMatchImageSnapshotOptions) {\n\treturn { snapshot }\n}\n\nexport type { ToMatchImageSnapshotOptions }\n","import { type ImageSnapshotIdOptions, toTaskId } from 'vitest-plugin-vis/client'\nimport { commands, getCurrentTest } from './vitest_proxy.ts'\n\n/**\n * Check if the snapshot image exists.\n */\nexport async function hasImageSnapshot(options?: ImageSnapshotIdOptions | undefined) {\n\tconst test = getCurrentTest()\n\tif (!test) {\n\t\treturn false\n\t}\n\n\tconst taskId = toTaskId(test)\n\tif (options?.customizeSnapshotId) {\n\t\treturn commands\n\t\t\t.imageSnapshotNextIndex(taskId)\n\t\t\t.then((index) => commands.hasImageSnapshot(taskId, options.customizeSnapshotId!(taskId, index)))\n\t}\n\n\treturn commands.hasImageSnapshot(taskId)\n}\n"]}
+{"version":3,"sources":["../src/client/storybook/param.ts","../src/client/has_image_snapshot.ts"],"names":[],"mappings":";;;;;AAKO,SAAS,wBAAwB,QAAuC,EAAA;AAC9E,EAAA,OAAO,EAAE,QAAS,EAAA;AACnB;ACDO,SAAS,iBAAiB,OAA8C,EAAA;AAC9E,EAAA,MAAM,OAAO,cAAe,EAAA;AAC5B,EAAI,IAAA,CAAC,MAAa,OAAA,KAAA;AAElB,EAAM,MAAA,MAAA,GAAS,SAAS,IAAI,CAAA;AAC5B,EAAA,IAAI,SAAS,mBAAqB,EAAA;AACjC,IAAA,OAAO,QACL,CAAA,sBAAA,CAAuB,MAAM,CAAA,CAC7B,KAAK,CAAC,KAAA,KAAU,QAAS,CAAA,gBAAA,CAAiB,QAAQ,OAAQ,CAAA,mBAAA,CAAqB,MAAQ,EAAA,KAAK,CAAC,CAAC,CAAA;AAAA;AAGjG,EAAO,OAAA,QAAA,CAAS,iBAAiB,MAAM,CAAA;AACxC","file":"index.js","sourcesContent":["import type { ToMatchImageSnapshotOptions } from 'vitest-plugin-vis/client'\n\n/**\n * Define snapshot parameter for auto snapshot.\n */\nexport function defineAutoSnapshotParam(snapshot: ToMatchImageSnapshotOptions) {\n\treturn { snapshot }\n}\n\n// This fix the inferred type cannot be named error\nexport type { ToMatchImageSnapshotOptions }\n","import { type ImageSnapshotIdOptions, toTaskId } from 'vitest-plugin-vis/client'\nimport { commands, getCurrentTest } from './vitest_proxy.ts'\n\n/**\n * Check if the snapshot image exists.\n */\nexport function hasImageSnapshot(options?: ImageSnapshotIdOptions | undefined) {\n\tconst test = getCurrentTest()\n\tif (!test) return false\n\n\tconst taskId = toTaskId(test)\n\tif (options?.customizeSnapshotId) {\n\t\treturn commands\n\t\t\t.imageSnapshotNextIndex(taskId)\n\t\t\t.then((index) => commands.hasImageSnapshot(taskId, options.customizeSnapshotId!(taskId, index)))\n\t}\n\n\treturn commands.hasImageSnapshot(taskId)\n}\n"]}

package/dist/preview.js

@@ -1,2 +1,2 @@
-import {expect}from'@storybook/test';import {success,parseImageSnapshotSubject,toTaskId}from'vitest-plugin-vis/client';import {setAutoSnapshotOptions}from'vitest-plugin-vis';var m,i;globalThis.__vitest_browser__&&(import('@vitest/browser/context').then(t=>{m=t;}),import('vitest/suite').then(t=>{i=t;}));var s=new Proxy({},{get(t,e){return m?.commands?.[e]??(()=>{throw new Error(`Command '${String(e)}' not found`)})()}}),a=()=>i?.getCurrentTest();function c(t,e){let o=a();if(!o)return Promise.resolve(success);let n=parseImageSnapshotSubject(t),r=toTaskId(o);return u(r,n,e).then(()=>success)}async function u(t,e,o){if(o?.customizeSnapshotId){let n=await s.imageSnapshotNextIndex(t),{customizeSnapshotId:r,...d}=o,g=r(t,n);return s.matchImageSnapshot(t,e,{...d,snapshotFileId:g})}return s.matchImageSnapshot(t,e,o)}expect.extend({toMatchImageSnapshot:c});var h={beforeEach(t){let e=t.tags,o=e?e.lastIndexOf("!snapshot")<e.lastIndexOf("snapshot"):!1,n=a();setAutoSnapshotOptions(n,{enable:o,...t.parameters?.snapshot});}};var P=h;export{P as default};//# sourceMappingURL=preview.js.map
+import {expect}from'@storybook/test';import {matchImageSnapshot,success}from'vitest-plugin-vis/client';import {setAutoSnapshotOptions}from'vitest-plugin-vis';var s,a;globalThis.__vitest_browser__&&(import('@vitest/browser/context').then(t=>{s=t;}),import('vitest/suite').then(t=>{a=t;}));new Proxy({},{get(t,e){return s?.commands?.[e]??(()=>{throw new Error(`Command '${String(e)}' not found`)})()}});var n=()=>a?.getCurrentTest();function m(t,e){let o=n();return o?matchImageSnapshot(o,t,e).then(()=>success):Promise.resolve(success)}expect.extend({toMatchImageSnapshot:m});var i={beforeEach(t){let e=t.tags,o=e?e.lastIndexOf("!snapshot")<e.lastIndexOf("snapshot"):!1,p=n();setAutoSnapshotOptions(p,{enable:o,...t.parameters?.snapshot});}};var O=i;export{O as default};//# sourceMappingURL=preview.js.map
 //# sourceMappingURL=preview.js.map

package/dist/preview.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/client/vitest_proxy.ts","../src/client/expect/to_match_image_snapshot.ts","../src/client/storybook/expect_extend.ts","../src/preview/vis_annotation.ts","../src/preview.ts"],"names":["browserContext","vitestSuite","m","commands","_target","prop","getCurrentTest","toMatchImageSnapshot","subject","options","test","success","s","parseImageSnapshotSubject","taskId","toTaskId","toMatchImageSnapshotAsync","index","customizeSnapshotId","rest","snapshotFileId","expect","visAnnotations","ctx","tags","enable","setAutoSnapshotOptions","preview_default"],"mappings":"8KAgBA,IAAIA,CACAC,CAAAA,CAAAA,CAEC,WAAmB,kBACvB,GAAA,OAAO,yBAAyB,CAAE,CAAA,IAAA,CAAMC,CAAM,EAAA,CAC7CF,CAAiBE,CAAAA,EAClB,CAAC,CACD,CAAA,OAAO,cAAc,CAAE,CAAA,IAAA,CAAMA,GAAM,CAClCD,CAAAA,CAAcC,EACf,CAAC,CAGK,CAAA,CAAA,IAAMC,EAAW,IAAI,KAAA,CAAuB,EAAC,CAAU,CAC7D,GAAA,CAAIC,EAASC,CAAM,CAAA,CAClB,OACEL,CAAAA,EAAgB,QAAmBK,GAAAA,CAAI,IAEvC,IAAM,CACN,MAAM,IAAI,KAAA,CAAM,YAAY,MAAOA,CAAAA,CAAI,CAAC,CAAA,WAAA,CAAa,CACtD,CAAA,GAGF,CACD,CAAC,EAEYC,CAAiB,CAAA,IAAML,GAAa,cAAe,EAAA,CC5BzD,SAASM,CAAAA,CAKfC,CACAC,CAAAA,CAAAA,CACyB,CACzB,IAAMC,CAAAA,CAAOJ,GAGb,CAAA,GAAI,CAACI,CACJ,CAAA,OAAO,OAAQ,CAAA,OAAA,CAAQC,OAAO,CAAA,CAI/B,IAAMC,CAAIC,CAAAA,yBAAAA,CAA0BL,CAAO,CAAA,CACrCM,CAASC,CAAAA,QAAAA,CAASL,CAAI,CAC5B,CAAA,OAAOM,CAA0BF,CAAAA,CAAAA,CAAQF,CAAGH,CAAAA,CAAO,EAAE,IAAK,CAAA,IAAME,OAAO,CACxE,CAEA,eAAeK,CAA0BF,CAAAA,CAAAA,CAAgBN,CAAiBC,CAAAA,CAAAA,CAAuC,CAChH,GAAIA,GAAS,mBAAqB,CAAA,CACjC,IAAMQ,CAAQ,CAAA,MAAMd,EAAS,sBAAuBW,CAAAA,CAAM,CACpD,CAAA,CAAE,mBAAAI,CAAAA,CAAAA,CAAqB,GAAGC,CAAK,CAAA,CAAIV,EACnCW,CAAiBF,CAAAA,CAAAA,CAAoBJ,EAAQG,CAAK,CAAA,CACxD,OAAOd,CAAAA,CAAS,kBAAmBW,CAAAA,CAAAA,CAAQN,EAAS,CAAE,GAAGW,CAAM,CAAA,cAAA,CAAAC,CAAe,CAAC,CAChF,CAEA,OAAOjB,CAAS,CAAA,kBAAA,CAAmBW,CAAQN,CAAAA,CAAAA,CAASC,CAAO,CAC5D,CCvCAY,OAAO,MAAO,CAAA,CAAE,qBAAAd,CAAqB,CAAC,CCHtC,CAGO,IAAMe,CAAAA,CAAiB,CAC7B,UAAA,CAAWC,CAAmB,CAAA,CAC7B,IAAMC,CAAOD,CAAAA,CAAAA,CAAI,IACXE,CAAAA,CAAAA,CAAUD,CAAeA,CAAAA,CAAAA,CAAK,YAAY,WAAW,CAAA,CAAIA,EAAK,WAAY,CAAA,UAAU,EAAnE,CACjBd,CAAAA,CAAAA,CAAAA,CAAOJ,CAAe,EAAA,CAC5BoB,sBAAuBhB,CAAAA,CAAAA,CAAM,CAAE,MAAAe,CAAAA,CAAAA,CAAQ,GAAGF,CAAAA,CAAI,UAAY,EAAA,QAAS,CAAC,EACrE,CACD,CCRA,CAAA,IAAOI,CAAQL,CAAAA","file":"preview.js","sourcesContent":["import type { BrowserCommands } from '@vitest/browser/context'\nimport type {\n\tHasImageSnapshotCommand,\n\tImageSnapshotNextIndexCommand,\n\tMatchImageSnapshotCommand,\n\tSetupVisSuiteCommand,\n} from 'vitest-plugin-vis/commands'\n\ndeclare module '@vitest/browser/context' {\n\tinterface BrowserCommands\n\t\textends MatchImageSnapshotCommand,\n\t\t\tHasImageSnapshotCommand,\n\t\t\tImageSnapshotNextIndexCommand,\n\t\t\tSetupVisSuiteCommand {}\n}\n\nlet browserContext: Awaited<typeof import('@vitest/browser/context')>\nlet vitestSuite: Awaited<typeof import('vitest/suite')>\n\nif ((globalThis as any).__vitest_browser__) {\n\timport('@vitest/browser/context').then((m) => {\n\t\tbrowserContext = m\n\t})\n\timport('vitest/suite').then((m) => {\n\t\tvitestSuite = m\n\t})\n}\n\nexport const commands = new Proxy<BrowserCommands>({} as any, {\n\tget(_target, prop) {\n\t\treturn (\n\t\t\t(browserContext?.commands as any)?.[prop] ??\n\t\t\t/* v8 ignore start : used in storybook, not in vitest */\n\t\t\t(() => {\n\t\t\t\tthrow new Error(`Command '${String(prop)}' not found`)\n\t\t\t})()\n\t\t\t/* v8 ignore end */\n\t\t)\n\t},\n})\n\nexport const getCurrentTest = () => vitestSuite?.getCurrentTest()\n","import type { AsyncExpectationResult } from '@vitest/expect'\nimport {\n\ttype ToMatchImageSnapshotOptions,\n\tparseImageSnapshotSubject,\n\tsuccess,\n\ttoTaskId,\n} from 'vitest-plugin-vis/client'\nimport { commands, getCurrentTest } from '../vitest_proxy.ts'\n\nexport interface ImageSnapshotMatcher {\n\ttoMatchImageSnapshot(options?: ToMatchImageSnapshotOptions | undefined): Promise<void>\n}\n\nexport function toMatchImageSnapshot(\n\t/**\n\t * The element or locator to take the snapshot of,\n\t * or the base64 value of the image to compare against.\n\t */\n\tsubject: any,\n\toptions?: ToMatchImageSnapshotOptions | undefined,\n): AsyncExpectationResult {\n\tconst test = getCurrentTest()\n\n\t/* v8 ignore start: stub as success when not in a test (e.g. in a story) */\n\tif (!test) {\n\t\treturn Promise.resolve(success)\n\t}\n\t/* v8 ignore end */\n\n\tconst s = parseImageSnapshotSubject(subject)\n\tconst taskId = toTaskId(test)\n\treturn toMatchImageSnapshotAsync(taskId, s, options).then(() => success)\n}\n\nasync function toMatchImageSnapshotAsync(taskId: string, subject: string, options?: ToMatchImageSnapshotOptions) {\n\tif (options?.customizeSnapshotId) {\n\t\tconst index = await commands.imageSnapshotNextIndex(taskId)\n\t\tconst { customizeSnapshotId, ...rest } = options\n\t\tconst snapshotFileId = customizeSnapshotId(taskId, index)\n\t\treturn commands.matchImageSnapshot(taskId, subject, { ...rest, snapshotFileId })\n\t}\n\n\treturn commands.matchImageSnapshot(taskId, subject, options)\n}\n","import { expect } from '@storybook/test'\nimport '../../shared/augment.ts'\nimport { toMatchImageSnapshot } from '../expect/to_match_image_snapshot.ts'\n\nexpect.extend({ toMatchImageSnapshot })\n","import type { ProjectAnnotations, Renderer, StoryContext } from 'storybook/internal/types'\nimport { setAutoSnapshotOptions } from 'vitest-plugin-vis'\nimport { getCurrentTest } from '../client/vitest_proxy.ts'\n\nexport const visAnnotations = {\n\tbeforeEach(ctx: StoryContext) {\n\t\tconst tags = ctx.tags\n\t\tconst enable = !tags ? false : tags.lastIndexOf('!snapshot') < tags.lastIndexOf('snapshot')\n\t\tconst test = getCurrentTest()\n\t\tsetAutoSnapshotOptions(test, { enable, ...ctx.parameters?.snapshot })\n\t},\n} satisfies ProjectAnnotations<Renderer>\n","import './client/storybook/expect_extend.ts'\nimport { visAnnotations } from './preview/vis_annotation.ts'\n\nexport default visAnnotations\n"]}
+{"version":3,"sources":["../src/client/vitest_proxy.ts","../src/client/expect/to_match_image_snapshot.ts","../src/client/storybook/expect_extend.ts","../src/preview/vis_annotation.ts","../src/preview.ts"],"names":["browserContext","vitestSuite","m","_target","prop","getCurrentTest","toMatchImageSnapshot","subject","options","test","matchImageSnapshot","success","expect","visAnnotations","ctx","tags","enable","setAutoSnapshotOptions","preview_default"],"mappings":"8JAgBA,IAAIA,CAAAA,CACAC,CAEC,CAAA,UAAA,CAAmB,qBACvB,OAAO,yBAAyB,CAAE,CAAA,IAAA,CAAMC,CAAM,EAAA,CAC7CF,CAAiBE,CAAAA,EAClB,CAAC,CACD,CAAA,OAAO,cAAc,CAAA,CAAE,KAAMA,CAAM,EAAA,CAClCD,CAAcC,CAAAA,EACf,CAAC,CAGK,CAAA,CAAiB,IAAI,KAAuB,CAAA,EAAW,CAAA,CAC7D,IAAIC,CAASC,CAAAA,CAAAA,CAAM,CAClB,OACEJ,CAAgB,EAAA,QAAA,GAAmBI,CAAI,CAAA,EAAA,CAEvC,IAAM,CACN,MAAM,IAAI,KAAA,CAAM,CAAY,SAAA,EAAA,MAAA,CAAOA,CAAI,CAAC,aAAa,CACtD,CAAA,GAGF,CACD,CAAC,CAEYC,KAAAA,CAAAA,CAAiB,IAAMJ,CAAAA,EAAa,iBC3B1C,SAASK,CAKfC,CAAAA,CAAAA,CACAC,CACyB,CAAA,CACzB,IAAMC,CAAAA,CAAOJ,GAGb,CAAA,OAAKI,CAGEC,CAAAA,kBAAAA,CAAmBD,CAAMF,CAAAA,CAAAA,CAASC,CAAO,CAAA,CAAE,KAAK,IAAMG,OAAO,CAHlD,CAAA,OAAA,CAAQ,OAAQA,CAAAA,OAAO,CAI1C,CCzBAC,OAAO,MAAO,CAAA,CAAE,oBAAAN,CAAAA,CAAqB,CAAC,CCHtC,CAGO,IAAMO,CAAAA,CAAiB,CAC7B,UAAA,CAAWC,CAAmB,CAAA,CAC7B,IAAMC,CAAAA,CAAOD,EAAI,IACXE,CAAAA,CAAAA,CAAUD,CAAeA,CAAAA,CAAAA,CAAK,YAAY,WAAW,CAAA,CAAIA,CAAK,CAAA,WAAA,CAAY,UAAU,CAAnE,CAAA,CAAA,CAAA,CACjBN,CAAOJ,CAAAA,CAAAA,EACbY,CAAAA,sBAAAA,CAAuBR,CAAM,CAAA,CAAE,OAAAO,CAAQ,CAAA,GAAGF,CAAI,CAAA,UAAA,EAAY,QAAS,CAAC,EACrE,CACD,CAAA,KCROI,CAAQL,CAAAA","file":"preview.js","sourcesContent":["import type { BrowserCommands } from '@vitest/browser/context'\nimport type {\n\tHasImageSnapshotCommand,\n\tImageSnapshotNextIndexCommand,\n\tMatchImageSnapshotCommand,\n\tSetupVisSuiteCommand,\n} from 'vitest-plugin-vis/commands'\n\ndeclare module '@vitest/browser/context' {\n\tinterface BrowserCommands\n\t\textends MatchImageSnapshotCommand,\n\t\t\tHasImageSnapshotCommand,\n\t\t\tImageSnapshotNextIndexCommand,\n\t\t\tSetupVisSuiteCommand {}\n}\n\nlet browserContext: Awaited<typeof import('@vitest/browser/context')>\nlet vitestSuite: Awaited<typeof import('vitest/suite')>\n\nif ((globalThis as any).__vitest_browser__) {\n\timport('@vitest/browser/context').then((m) => {\n\t\tbrowserContext = m\n\t})\n\timport('vitest/suite').then((m) => {\n\t\tvitestSuite = m\n\t})\n}\n\nexport const commands = new Proxy<BrowserCommands>({} as any, {\n\tget(_target, prop) {\n\t\treturn (\n\t\t\t(browserContext?.commands as any)?.[prop] ??\n\t\t\t/* v8 ignore start : used in storybook, not in vitest */\n\t\t\t(() => {\n\t\t\t\tthrow new Error(`Command '${String(prop)}' not found`)\n\t\t\t})()\n\t\t\t/* v8 ignore end */\n\t\t)\n\t},\n})\n\nexport const getCurrentTest = () => vitestSuite?.getCurrentTest()\n","import type { AsyncExpectationResult } from '@vitest/expect'\nimport {\n\ttype ToMatchImageSnapshotOptions,\n\tmatchImageSnapshot,\n\tparseImageSnapshotSubject,\n\tsuccess,\n\ttoTaskId,\n} from 'vitest-plugin-vis/client'\nimport { commands, getCurrentTest } from '../vitest_proxy.ts'\n\nexport interface ImageSnapshotMatcher {\n\ttoMatchImageSnapshot(options?: ToMatchImageSnapshotOptions | undefined): Promise<void>\n}\n\nexport function toMatchImageSnapshot(\n\t/**\n\t * The element or locator to take the snapshot of,\n\t * or the base64 value of the image to compare against.\n\t */\n\tsubject: any,\n\toptions?: ToMatchImageSnapshotOptions | undefined,\n): AsyncExpectationResult {\n\tconst test = getCurrentTest()\n\n\t/* v8 ignore start: stub as success when not in a test (e.g. in a story) */\n\tif (!test) return Promise.resolve(success)\n\t/* v8 ignore end */\n\n\treturn matchImageSnapshot(test, subject, options).then(() => success)\n}\n","import { expect } from '@storybook/test'\nimport './augment.ts'\nimport { toMatchImageSnapshot } from '../expect/to_match_image_snapshot.ts'\n\nexpect.extend({ toMatchImageSnapshot })\n","import type { ProjectAnnotations, Renderer, StoryContext } from 'storybook/internal/types'\nimport { setAutoSnapshotOptions } from 'vitest-plugin-vis'\nimport { getCurrentTest } from '../client/vitest_proxy.ts'\n\nexport const visAnnotations = {\n\tbeforeEach(ctx: StoryContext) {\n\t\tconst tags = ctx.tags\n\t\tconst enable = !tags ? false : tags.lastIndexOf('!snapshot') < tags.lastIndexOf('snapshot')\n\t\tconst test = getCurrentTest()\n\t\tsetAutoSnapshotOptions(test, { enable, ...ctx.parameters?.snapshot })\n\t},\n} satisfies ProjectAnnotations<Renderer>\n","import './client/storybook/expect_extend.ts'\nimport { visAnnotations } from './preview/vis_annotation.ts'\n\nexport default visAnnotations\n"]}

package/dist/vitest-setup.d.ts

@@ -1,16 +1,3 @@
-import { ToMatchImageSnapshotOptions } from 'vitest-plugin-vis/client';
-
-interface ImageSnapshotMatcher {
-    toMatchImageSnapshot(options?: ToMatchImageSnapshotOptions | undefined): Promise<void>;
-}
-
-declare global {
-    namespace jest {
-        interface Matchers<R, T> extends ImageSnapshotMatcher {
-        }
-    }
-}
-
 declare const vis: {
     presets: {
         manual(): void;

package/dist/vitest-setup.js

@@ -1,31 +1,6 @@
-import { commands, getCurrentTest } from './chunk-GZMKOHHR.js';
+import { commands } from './chunk-GZMKOHHR.js';
 import { createVis } from 'vitest-plugin-vis/setup';
-import { expect } from 'vitest';
-import { success, parseImageSnapshotSubject, toTaskId } from 'vitest-plugin-vis/client';
 
-function toMatchImageSnapshot(subject, options) {
-  const test = getCurrentTest();
-  if (!test) {
-    return Promise.resolve(success);
-  }
-  const s = parseImageSnapshotSubject(subject);
-  const taskId = toTaskId(test);
-  return toMatchImageSnapshotAsync(taskId, s, options).then(() => success);
-}
-async function toMatchImageSnapshotAsync(taskId, subject, options) {
-  if (options?.customizeSnapshotId) {
-    const index = await commands.imageSnapshotNextIndex(taskId);
-    const { customizeSnapshotId, ...rest } = options;
-    const snapshotFileId = customizeSnapshotId(taskId, index);
-    return commands.matchImageSnapshot(taskId, subject, { ...rest, snapshotFileId });
-  }
-  return commands.matchImageSnapshot(taskId, subject, options);
-}
-
-// src/vitest-setup/expect_extend.ts
-expect.extend({ toMatchImageSnapshot });
-
-// src/vitest-setup.ts
 var vis = createVis(commands);
 
 export { vis };

package/dist/vitest-setup.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/client/expect/to_match_image_snapshot.ts","../src/vitest-setup/expect_extend.ts","../src/vitest-setup.ts"],"names":[],"mappings":";;;;;AAaO,SAAS,oBAAA,CAKf,SACA,OACyB,EAAA;AACzB,EAAA,MAAM,OAAO,cAAe,EAAA;AAG5B,EAAA,IAAI,CAAC,IAAM,EAAA;AACV,IAAO,OAAA,OAAA,CAAQ,QAAQ,OAAO,CAAA;AAAA;AAI/B,EAAM,MAAA,CAAA,GAAI,0BAA0B,OAAO,CAAA;AAC3C,EAAM,MAAA,MAAA,GAAS,SAAS,IAAI,CAAA;AAC5B,EAAA,OAAO,0BAA0B,MAAQ,EAAA,CAAA,EAAG,OAAO,CAAE,CAAA,IAAA,CAAK,MAAM,OAAO,CAAA;AACxE;AAEA,eAAe,yBAAA,CAA0B,MAAgB,EAAA,OAAA,EAAiB,OAAuC,EAAA;AAChH,EAAA,IAAI,SAAS,mBAAqB,EAAA;AACjC,IAAA,MAAM,KAAQ,GAAA,MAAM,QAAS,CAAA,sBAAA,CAAuB,MAAM,CAAA;AAC1D,IAAA,MAAM,EAAE,mBAAA,EAAqB,GAAG,IAAA,EAAS,GAAA,OAAA;AACzC,IAAM,MAAA,cAAA,GAAiB,mBAAoB,CAAA,MAAA,EAAQ,KAAK,CAAA;AACxD,IAAO,OAAA,QAAA,CAAS,mBAAmB,MAAQ,EAAA,OAAA,EAAS,EAAE,GAAG,IAAA,EAAM,gBAAgB,CAAA;AAAA;AAGhF,EAAA,OAAO,QAAS,CAAA,kBAAA,CAAmB,MAAQ,EAAA,OAAA,EAAS,OAAO,CAAA;AAC5D;;;ACvCA,MAAO,CAAA,MAAA,CAAO,EAAE,oBAAA,EAAsB,CAAA;;;ACCzB,IAAA,GAAA,GAAM,UAAU,QAAQ","file":"vitest-setup.js","sourcesContent":["import type { AsyncExpectationResult } from '@vitest/expect'\nimport {\n\ttype ToMatchImageSnapshotOptions,\n\tparseImageSnapshotSubject,\n\tsuccess,\n\ttoTaskId,\n} from 'vitest-plugin-vis/client'\nimport { commands, getCurrentTest } from '../vitest_proxy.ts'\n\nexport interface ImageSnapshotMatcher {\n\ttoMatchImageSnapshot(options?: ToMatchImageSnapshotOptions | undefined): Promise<void>\n}\n\nexport function toMatchImageSnapshot(\n\t/**\n\t * The element or locator to take the snapshot of,\n\t * or the base64 value of the image to compare against.\n\t */\n\tsubject: any,\n\toptions?: ToMatchImageSnapshotOptions | undefined,\n): AsyncExpectationResult {\n\tconst test = getCurrentTest()\n\n\t/* v8 ignore start: stub as success when not in a test (e.g. in a story) */\n\tif (!test) {\n\t\treturn Promise.resolve(success)\n\t}\n\t/* v8 ignore end */\n\n\tconst s = parseImageSnapshotSubject(subject)\n\tconst taskId = toTaskId(test)\n\treturn toMatchImageSnapshotAsync(taskId, s, options).then(() => success)\n}\n\nasync function toMatchImageSnapshotAsync(taskId: string, subject: string, options?: ToMatchImageSnapshotOptions) {\n\tif (options?.customizeSnapshotId) {\n\t\tconst index = await commands.imageSnapshotNextIndex(taskId)\n\t\tconst { customizeSnapshotId, ...rest } = options\n\t\tconst snapshotFileId = customizeSnapshotId(taskId, index)\n\t\treturn commands.matchImageSnapshot(taskId, subject, { ...rest, snapshotFileId })\n\t}\n\n\treturn commands.matchImageSnapshot(taskId, subject, options)\n}\n","import { expect } from 'vitest'\nimport '../shared/augment.ts'\nimport { toMatchImageSnapshot } from '../client/expect/to_match_image_snapshot.ts'\n\nexpect.extend({ toMatchImageSnapshot })\n","// `storybook-addon-vis/vitest-setup` provides code needed in `vitest.setup.ts`.\nimport { createVis } from 'vitest-plugin-vis/setup'\nimport { commands } from './client/vitest_proxy.ts'\nimport './vitest-setup/expect_extend.ts'\n\nexport const vis = createVis(commands)\n"]}
+{"version":3,"sources":["../src/vitest-setup.ts"],"names":[],"mappings":";;;AAIa,IAAA,GAAA,GAAM,UAAU,QAAQ","file":"vitest-setup.js","sourcesContent":["// `storybook-addon-vis/vitest-setup` provides code needed in `vitest.setup.ts`.\nimport { createVis } from 'vitest-plugin-vis/setup'\nimport { commands } from './client/vitest_proxy.ts'\n\nexport const vis = createVis(commands)\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storybook-addon-vis",
-  "version": "0.15.7",
+  "version": "0.16.0",
   "description": "Storybook Vitest visual testing addon",
   "keywords": [
     "image-snapshot",
@@ -53,7 +53,7 @@
   ],
   "dependencies": {
     "type-plus": "^8.0.0-beta.6",
-    "vitest-plugin-vis": "1.0.5"
+    "vitest-plugin-vis": "1.1.0"
   },
   "devDependencies": {
     "@storybook/addon-essentials": "^8.4.2",

package/readme.md

@@ -82,12 +82,30 @@ This default configuration will:
 - Image snapshots of the current test run are saved in the `<root>/__vis__/__results__` directory.
 - Diff images are saved in the `<root>/__vis__/__diffs__` directory.
 
-Note that compare to [`vitest-plugin-vis`][vitest-plugin-vis],
-`storybookVis()` does not provide the `auto` or `manual` presets.
-This is because you will need to [provide your `vitest.setup.ts`][storybook-test-addon#example-config] to make the story configuration available to Vitest anyway. So it is better to do the setup in one place.
-
 You can customize `storybookVis()` by providing additional `options`.
-It is the same option in [`vitest-plugin-vis`][vitest-plugin-vis] minus the `preset`.
+It is the same option in [`vitest-plugin-vis`][vitest-plugin-vis] minus the `preset`:
+
+```ts
+// vitest.config.ts
+import { storybookVis, trimCommonFolder } from 'storybook-addon-vis/vitest-plugin'
+
+export default defineConfig({
+	plugins: [
+		storybookVis({
+			snapshotRootDir: '__vis__',
+			customizeSnapshotSubpath: (subpath) => trimCommonFolder(subpath),
+			customizeSnapshotId: (id, index) => `${id}-${index}`,
+			diffOptions: undefined, // pixelmatch options
+			failureThresholdType: 'pixel',
+			failureThreshold: 0,
+			timeout: 5000 // 30000 on CI
+		})
+	],
+})
+```
+
+`storybookVis()` does not provide the `auto` or `manual` presets because you will need to [provide your `vitest.setup.ts`][storybook-test-addon#example-config] to make the story configuration available to Vitest anyway.
+So it is better to do the setup in one place.
 
 ##### Snapshot folder
 
@@ -175,7 +193,7 @@ v tests
 
 ##### Disable Vitest global API
 
-Note that we recommend to set `globals` to `false` (which is the default).
+We recommend to set `globals` to `false` (which is the default).
 Setting `globals` to `true` actually works ok during test.
 But they don't exist in the story files:
 
@@ -248,7 +266,7 @@ vis.presets.theme({
 
 ### Storybook Configuration
 
-For [Storybook], all you need to is to add the `storybook-addon-vis` to your `.storybook/main.js`:
+For [Storybook], all you need is to add the `storybook-addon-vis` to your `.storybook/main.js`:
 
 ```ts
 // .storybook/main.ts

package/src/client/expect/to_match_image_snapshot.ts

@@ -1,6 +1,7 @@
 import type { AsyncExpectationResult } from '@vitest/expect'
 import {
 	type ToMatchImageSnapshotOptions,
+	matchImageSnapshot,
 	parseImageSnapshotSubject,
 	success,
 	toTaskId,
@@ -22,23 +23,8 @@ export function toMatchImageSnapshot(
 	const test = getCurrentTest()
 
 	/* v8 ignore start: stub as success when not in a test (e.g. in a story) */
-	if (!test) {
-		return Promise.resolve(success)
-	}
+	if (!test) return Promise.resolve(success)
 	/* v8 ignore end */
 
-	const s = parseImageSnapshotSubject(subject)
-	const taskId = toTaskId(test)
-	return toMatchImageSnapshotAsync(taskId, s, options).then(() => success)
-}
-
-async function toMatchImageSnapshotAsync(taskId: string, subject: string, options?: ToMatchImageSnapshotOptions) {
-	if (options?.customizeSnapshotId) {
-		const index = await commands.imageSnapshotNextIndex(taskId)
-		const { customizeSnapshotId, ...rest } = options
-		const snapshotFileId = customizeSnapshotId(taskId, index)
-		return commands.matchImageSnapshot(taskId, subject, { ...rest, snapshotFileId })
-	}
-
-	return commands.matchImageSnapshot(taskId, subject, options)
+	return matchImageSnapshot(test, subject, options).then(() => success)
 }

package/src/client/has_image_snapshot.ts

@@ -4,11 +4,9 @@ import { commands, getCurrentTest } from './vitest_proxy.ts'
 /**
  * Check if the snapshot image exists.
  */
-export async function hasImageSnapshot(options?: ImageSnapshotIdOptions | undefined) {
+export function hasImageSnapshot(options?: ImageSnapshotIdOptions | undefined) {
 	const test = getCurrentTest()
-	if (!test) {
-		return false
-	}
+	if (!test) return false
 
 	const taskId = toTaskId(test)
 	if (options?.customizeSnapshotId) {

package/src/{shared → client/storybook}/augment.ts

@@ -1,6 +1,6 @@
 ///  <reference types="@vitest/browser/context" />
 
-import type { ImageSnapshotMatcher } from '../client/expect/to_match_image_snapshot.ts'
+import type { ImageSnapshotMatcher } from '../expect/to_match_image_snapshot.ts'
 
 declare global {
 	namespace jest {

package/src/client/storybook/expect_extend.ts

@@ -1,5 +1,5 @@
 import { expect } from '@storybook/test'
-import '../../shared/augment.ts'
+import './augment.ts'
 import { toMatchImageSnapshot } from '../expect/to_match_image_snapshot.ts'
 
 expect.extend({ toMatchImageSnapshot })

package/src/client/storybook/param.ts

@@ -7,4 +7,5 @@ export function defineAutoSnapshotParam(snapshot: ToMatchImageSnapshotOptions) {
 	return { snapshot }
 }
 
+// This fix the inferred type cannot be named error
 export type { ToMatchImageSnapshotOptions }

package/src/vitest-setup/expect_extend.ts

@@ -1,5 +1,5 @@
 import { expect } from 'vitest'
-import '../shared/augment.ts'
+import '../client/storybook/augment.ts'
 import { toMatchImageSnapshot } from '../client/expect/to_match_image_snapshot.ts'
 
 expect.extend({ toMatchImageSnapshot })

package/src/vitest-setup.ts

@@ -1,6 +1,5 @@
 // `storybook-addon-vis/vitest-setup` provides code needed in `vitest.setup.ts`.
 import { createVis } from 'vitest-plugin-vis/setup'
 import { commands } from './client/vitest_proxy.ts'
-import './vitest-setup/expect_extend.ts'
 
 export const vis = createVis(commands)