🤖 Merge PR DefinitelyTyped#74206 fix: [jest-image-snapshot] use real signature by @dword-design

Author: dword-design

types/jest-image-snapshot/index.d.ts

@@ -134,7 +134,10 @@ export interface MatchImageSnapshotOptions {
  *   import { toMatchImageSnapshot } from 'jest-image-snapshot';
  *   expect.extend({ toMatchImageSnapshot });
  */
-export function toMatchImageSnapshot(options?: MatchImageSnapshotOptions): { message(): string; pass: boolean };
+export function toMatchImageSnapshot(
+    received: Buffer,
+    options?: MatchImageSnapshotOptions,
+): { message(): string; pass: boolean };
 
 /**
  * Configurable function that can be passed to jest's expect.extend.
@@ -145,7 +148,7 @@ export function toMatchImageSnapshot(options?: MatchImageSnapshotOptions): { mes
  */
 export function configureToMatchImageSnapshot(
     options: MatchImageSnapshotOptions,
-): () => { message(): string; pass: boolean };
+): (received: Buffer, options?: MatchImageSnapshotOptions) => { message(): string; pass: boolean };
 
 /**
  * Mutates original state with new state

types/jest-image-snapshot/jest-image-snapshot-tests.ts

@@ -4,14 +4,24 @@ import {
     toMatchImageSnapshot,
     updateSnapshotState,
 } from "jest-image-snapshot";
+import sharp from "sharp";
 
-it("should be able to use toMatchImageSnapshot in a test", () => {
+it("should be able to use toMatchImageSnapshot in a test", async () => {
     expect.extend({ toMatchImageSnapshot });
 
-    expect(400).toMatchImageSnapshot();
+    expect(
+        await sharp({
+            create: {
+                background: { b: 0, g: 255, r: 0 },
+                channels: 3,
+                height: 48,
+                width: 48,
+            },
+        }).png().toBuffer(),
+    ).toMatchImageSnapshot();
 });
 
-it("should be able to use configureToMatchImageSnapshot in a test", () => {
+it("should be able to use configureToMatchImageSnapshot in a test", async () => {
     const matchFn = configureToMatchImageSnapshot({
         allowSizeMismatch: true,
         noColors: true,
@@ -25,10 +35,19 @@ it("should be able to use configureToMatchImageSnapshot in a test", () => {
     });
     expect.extend({ toMatchImageSnapshot: matchFn });
 
-    expect("Me").toMatchImageSnapshot();
+    expect(
+        await sharp({
+            create: {
+                background: { b: 0, g: 255, r: 0 },
+                channels: 3,
+                height: 48,
+                width: 48,
+            },
+        }).png().toBuffer(),
+    ).toMatchImageSnapshot();
 });
 
-it("Should be able to use configuration directly in toMatchImageSnapshot", () => {
+it("Should be able to use configuration directly in toMatchImageSnapshot", async () => {
     expect.extend({ toMatchImageSnapshot });
 
     const options: MatchImageSnapshotOptions = {
@@ -52,27 +71,91 @@ it("Should be able to use configuration directly in toMatchImageSnapshot", () =>
         failureThresholdType: "percent",
     };
 
-    expect("Me").toMatchImageSnapshot(options);
+    expect(
+        await sharp({
+            create: {
+                background: { b: 0, g: 255, r: 0 },
+                channels: 3,
+                height: 48,
+                width: 48,
+            },
+        }).png().toBuffer(),
+    ).toMatchImageSnapshot(options);
 });
 
-it("Should be able to use string as customSnapshotIdentifier", () => {
+it("Should be able to use string as customSnapshotIdentifier", async () => {
     const options: MatchImageSnapshotOptions = {
         customSnapshotIdentifier: "string identifier",
     };
 
-    expect("Me").toMatchImageSnapshot(options);
+    expect(
+        await sharp({
+            create: {
+                background: { b: 0, g: 255, r: 0 },
+                channels: 3,
+                height: 48,
+                width: 48,
+            },
+        }).png().toBuffer(),
+    ).toMatchImageSnapshot(options);
 });
 
-it("Should be able to use callback as customSnapshotIdentifier", () => {
+it("Should be able to use callback as customSnapshotIdentifier", async () => {
     const options: MatchImageSnapshotOptions = {
         customSnapshotIdentifier: () => "string identifier",
     };
 
-    expect("Me").toMatchImageSnapshot(options);
+    expect(
+        await sharp({
+            create: {
+                background: { b: 0, g: 255, r: 0 },
+                channels: 3,
+                height: 48,
+                width: 48,
+            },
+        }).png().toBuffer(),
+    ).toMatchImageSnapshot(options);
 });
 
 it("mutates original state", () => {
     const originalState = { some: "value" };
     updateSnapshotState(originalState, { another: "val" });
     expect(originalState).toEqual({ some: "value", another: "val" });
 });
+
+it("should be able to use toMatchImageSnapshot without expect", async () => {
+    const result = toMatchImageSnapshot.call(
+        expect.getState(),
+        await sharp({
+            create: {
+                background: { b: 0, g: 255, r: 0 },
+                channels: 3,
+                height: 48,
+                width: 48,
+            },
+        }).png().toBuffer(),
+        {
+            allowSizeMismatch: true,
+        },
+    );
+    expect(result.pass).toEqual(true);
+});
+
+it("should be able to use configureToMatchImageSnapshot without expect", async () => {
+    const matchFn = configureToMatchImageSnapshot({
+        allowSizeMismatch: true,
+    });
+
+    const result = matchFn.call(
+        expect.getState(),
+        await sharp({
+            create: {
+                background: { b: 0, g: 255, r: 0 },
+                channels: 3,
+                height: 48,
+                width: 48,
+            },
+        }).png().toBuffer(),
+    );
+    expect(result.pass).toEqual(true);
+});

types/jest-image-snapshot/package.json

@@ -11,7 +11,8 @@
         "ssim.js": "^3.1.1"
     },
     "devDependencies": {
-        "@types/jest-image-snapshot": "workspace:."
+        "@types/jest-image-snapshot": "workspace:.",
+        "sharp": "*"
     },
     "owners": [
         {