Add options from cypress and jest-image-snapshot to cypress-image-snapshot (#41897)

* Add options from cypress and jest-image-snapshot to cypress-image-snapshot

* Use jest-image-snapshot from DefinitelyTyped

* Don't use relative paths to DefinitelyTyped modules

* Use TypeScript Version: 3.0 to match jest-image-snapshot

* inline jest-image-snapshot

* Don't use include

* Add dom to tsconfig

* Don't export MatchImageSnapshotOptions

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

@@ -4,6 +4,7 @@ import { addMatchImageSnapshotPlugin } from 'cypress-image-snapshot/plugin';
 // $ExpectType void
 command.addMatchImageSnapshotCommand({
     customSnapshotsDir: '../../test/cypress/snapshots',
+    scale: true,
 });
 
 addMatchImageSnapshotPlugin(() => null, {}); // $ExpectType void

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

@@ -3,16 +3,34 @@
 // Definitions by: Alex Kessock <https://github.com/Keysox>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
-export interface Options {
-    customSnapshotsDir?: string;
-    customDiffDir?: string;
-    failureThreshold?: number;
-    failureThresholdType?: 'percent' | 'number';
-    customDiffConfig?: {
-        threshold: number;
-    };
-    capture?: 'viewport';
-}
+/// <reference types="Cypress" />
+
+export interface Options
+    extends Partial<
+        Cypress.ScreenshotOptions & {
+            customDiffConfig?: {
+                readonly threshold?: number;
+                readonly includeAA?: boolean;
+            };
+            customSnapshotsDir?: string;
+            customDiffDir?: string;
+            customSnapshotIdentifier?:
+                | ((parameters: {
+                      testPath: string;
+                      currentTestName: string;
+                      counter: number;
+                      defaultIdentifier: string;
+                  }) => string)
+                | string;
+            diffDirection?: 'horizontal' | 'vertical';
+            noColors?: boolean;
+            failureThreshold?: number;
+            failureThresholdType?: 'pixel' | 'percent';
+            updatePassedSnapshot?: boolean;
+            blur?: number;
+            runInProcess?: boolean;
+        }
+    > {}
 
 declare global {
     namespace Cypress {

types/cypress-image-snapshot/package.json

@@ -0,0 +1,6 @@
+{
+    "private": true,
+    "dependencies": {
+        "cypress": "^3.8.3"
+    }
+}

types/cypress-image-snapshot/tsconfig.json

@@ -1,23 +1,16 @@
 {
     "compilerOptions": {
         "module": "commonjs",
-        "lib": [
-            "es6"
-        ],
+        "lib": ["es6", "dom"],
         "noImplicitAny": true,
         "noImplicitThis": true,
         "strictFunctionTypes": true,
         "strictNullChecks": true,
         "baseUrl": "../",
-        "typeRoots": [
-            "../"
-        ],
+        "typeRoots": ["../"],
         "types": [],
         "noEmit": true,
         "forceConsistentCasingInFileNames": true
     },
-    "files": [
-        "index.d.ts",
-        "cypress-image-snapshot-tests.ts"
-    ]
+    "files": ["index.d.ts", "cypress-image-snapshot-tests.ts"]
 }