creevey 0.9.0-beta.2 → 0.9.0-beta.20

package/lib/types/types.d.ts

@@ -1,14 +1,15 @@
 /// <reference types="node" />
 /// <reference types="chai" />
-import type { API as StorybookAPI } from '@storybook/api';
-import type { DecoratorFunction } from '@storybook/addons';
+import type { DecoratorFunction } from '@storybook/csf';
 import type { IKey } from 'selenium-webdriver/lib/input';
 import type { Worker as ClusterWorker } from 'cluster';
 import type { until, WebDriver, WebElementPromise } from 'selenium-webdriver';
 import type Pixelmatch from 'pixelmatch';
 import type { Context } from 'mocha';
+import { StoryContextForEnhancers } from '@storybook/csf';
 export declare type DiffOptions = typeof Pixelmatch extends (x1: any, x2: any, x3: any, x4: any, x5: any, options?: infer T) => void ? T : never;
 export declare type SetStoriesData = {
+    v?: number;
     globalParameters: {
         creevey?: CreeveyStoryParams;
     };
@@ -20,16 +21,14 @@ export declare type SetStoriesData = {
     }>;
     stories: StoriesRaw;
 };
-export declare type StoriesRaw = StorybookAPI extends {
-    setStories: (stories: infer SS) => void;
-} ? SS : never;
+export declare type StoriesRaw = Record<string, StoryContextForEnhancers>;
 export declare type StoryInput = StoriesRaw extends {
     [id: string]: infer S;
 } ? S : never;
-export interface StoryMeta<StoryFnReturnType = unknown> {
+export interface StoryMeta {
     title: string;
     component?: unknown;
-    decorators?: DecoratorFunction<StoryFnReturnType>[];
+    decorators?: DecoratorFunction[];
     parameters?: {
         creevey?: CreeveyStoryParams;
         [name: string]: unknown;
@@ -52,14 +51,14 @@ export interface CSFStory<StoryFnReturnType = unknown> {
      */
     story?: {
         name?: string;
-        decorators?: DecoratorFunction<StoryFnReturnType>[];
+        decorators?: DecoratorFunction[];
         parameters?: {
             creevey?: CreeveyStoryParams;
             [name: string]: unknown;
         };
     };
     storyName?: string;
-    decorators?: DecoratorFunction<StoryFnReturnType>[];
+    decorators?: DecoratorFunction[];
     parameters?: {
         creevey?: CreeveyStoryParams;
         [name: string]: unknown;
@@ -73,6 +72,11 @@ export interface CreeveyStory {
 }
 export interface Capabilities {
     browserName: string;
+    browserVersion?: string;
+    platformName?: string;
+    /**
+     * @deprecated use `browserVersion` instead
+     */
     version?: string;
     [prop: string]: unknown;
 }
@@ -87,7 +91,7 @@ export declare type BrowserConfig = Capabilities & {
     _storybookGlobals?: StorybookGlobals;
     /**
      * Specify custom docker image. Used only with `useDocker == true`
-     * @default `selenoid/${browserName}:${version ?? 'latest'}`
+     * @default `selenoid/${browserName}:${browserVersion ?? 'latest'}`
      */
     dockerImage?: string;
     /**
@@ -141,11 +145,6 @@ export interface Config {
      * @default path.join(process.cwd(), './report')
      */
     reportDir: string;
-    /**
-     * Absolute path to storybook config directory
-     * @default path.join(process.cwd(), './.storybook')
-     */
-    storybookDir: string;
     /**
      * How much test would be retried
      * @default 0
@@ -172,18 +171,6 @@ export interface Config {
      * Works only with `useDocker == false`
      */
     selenoidPath?: string;
-    /**
-     * Creevey extract tests by using babel transformations
-     * and load stories to nodejs directly.
-     * In some edge cases it may fail to load tests.
-     * In that case you can enable this option.
-     * Creevey uses Storybook webpack config to build nodejs bundle with tests.
-     * But it slightly slower and doesn't work if you use custom bundler for Storybook
-     *
-     * Affects only for Storybook 6.2+
-     * @default false
-     */
-    useWebpackToExtractTests: boolean;
     /**
      * Creevey has two built-in stories providers.
      *
@@ -208,11 +195,7 @@ export interface Config {
      * }
      * ```
      */
-    storiesProvider: (config: Config, options: {
-        watch: boolean;
-        debug: boolean;
-        port: number;
-    }, storiesListener: (stories: Map<string, StoryInput[]>) => void) => Promise<StoriesRaw>;
+    storiesProvider: StoriesProvider;
     /**
      * Define custom babel options for load stories transformation
      */
@@ -249,21 +232,32 @@ export interface Config {
     testsRegex?: RegExp;
     testsDir?: string;
     tsConfig?: string;
+    /**
+     * Telemetry contains information about Creevey and Storybook versions, used Creevey config, browsers and tests meta.
+     * It's being sent only for projects from git.skbkontur.ru
+     * @default false
+     */
+    disableTelemetry?: boolean;
+}
+export interface StoriesProvider<T = any> {
+    (config: Config, options: T, storiesListener: (stories: Map<string, StoryInput[]>) => void): Promise<StoriesRaw>;
+    providerName?: string;
 }
 export declare type CreeveyConfig = Partial<Config>;
 export interface Options {
+    _: string[];
     config?: string;
     port: number;
     ui: boolean;
     update: boolean | string;
-    webpack: boolean;
     debug: boolean;
-    extract: boolean | string;
+    trace: boolean;
     tests: boolean;
     browser?: string;
     reporter?: string;
     screenDir?: string;
     reportDir?: string;
+    storybookUrl?: string;
     saveReport: boolean;
     failFast?: boolean;
 }
@@ -402,13 +396,12 @@ export interface CreeveyUpdate {
     removedTests?: TestMeta[];
 }
 export interface SkipOption {
-    reason?: string;
     in?: string | string[] | RegExp;
     kinds?: string | string[] | RegExp;
     stories?: string | string[] | RegExp;
     tests?: string | string[] | RegExp;
 }
-export declare type SkipOptions = boolean | string | SkipOption | SkipOption[] | Record<string, SkipOption | SkipOption[]>;
+export declare type SkipOptions = boolean | string | Record<string, SkipOption | SkipOption[]>;
 export declare type CreeveyTestFunction = (this: {
     browser: WebDriver;
     until: typeof until;

package/package.json

@@ -13,9 +13,27 @@
     "addon",
     "test"
   ],
-  "version": "0.9.0-beta.2",
-  "bin": {
-    "creevey": "./lib/cjs/cli.js"
+  "version": "0.9.0-beta.20",
+  "bin": "./lib/cjs/cli.js",
+  "exports": {
+    ".": {
+      "types": "./lib/types/index.d.ts",
+      "default": "./lib/cjs/index.js"
+    },
+    "./addon": {
+      "types": "./lib/types/client/addon/index.d.ts",
+      "module": "./lib/esm/client/addon/index.js",
+      "default": "./lib/cjs/client/addon/index.js"
+    },
+    "./preset": {
+      "types": "./lib/types/client/addon/preset.js",
+      "module": "./lib/esm/client/addon/preset.js",
+      "default": "./lib/cjs/client/addon/preset.js"
+    },
+    "./lib/cjs/client/addon/preview.js": {
+      "default": "./lib/cjs/client/addon/preview.js"
+    },
+    "./package.json": "./package.json"
   },
   "main": "lib/cjs/index.js",
   "module": "lib/esm/index.js",
@@ -29,187 +47,168 @@
   "scripts": {
     "commit": "git-cz",
     "clean": "rimraf lib",
-    "lint": "run-p --continue-on-error lint:*",
+    "lint": "redrun -p \"lint:*\"",
     "lint:tsc": "tsc --noEmit",
     "lint:eslint": "eslint --ext .js,.ts,.tsx ./",
     "lint:prettier": "prettier --check *.{md,json,js,ts} ./**/*.{js,ts,tsx}",
-    "pretest:e2e": "yarn build && yarn pack -f creevey.tgz",
-    "bootstrap:storybook": "cd ../storybook && yarn install && yarn bootstrap --core",
-    "test": "run-p test:*",
-    "test:unit": "mocha ./tests/{client,server}/**/*.test.ts ./tests/*.test.ts",
-    "test:e2e": "mocha ./tests/e2e/*.test.ts",
-    "start": "run-p start:*",
+    "test": "jest --config jest.config.js",
+    "start": "redrun -p \"start:*\"",
     "start:client": "webpack-dev-server",
-    "start:storybook": "start-storybook --ci -p 6006",
+    "start:storybook": "storybook dev --ci -p 6006",
     "start:creevey": "yarn creevey --ui",
-    "start:creevey:github": "yarn creevey:github --ui",
     "creevey": "node --require ./scripts/babel-register -- src/cli",
     "creevey:github": "yarn creevey --config .creevey/github.config.ts",
     "creevey:gitlab": "yarn creevey --config .creevey/gitlab.config.ts",
     "creevey:hybrid": "yarn creevey --config .creevey/hybrid.config.ts",
-    "fix": "run-s fix:*",
+    "fix": "redrun \"fix:*\"",
     "fix:eslint": "eslint --fix ./",
     "fix:prettier": "prettier --write .",
     "prebuild": "yarn clean && mkdir lib",
-    "build": "run-p --continue-on-error build:*",
+    "build": "yarn prebuild && redrun -p \"build:*\" && yarn postbuild",
     "build:types": "tsc --emitDeclarationOnly -p scripts/tsconfig.prod.json",
-    "build:creevey": "run-p \"build:creevey:* --extensions .ts,.tsx --ignore src/client/web\"",
-    "build:creevey:cjs": "cross-env BABEL_MODE=cjs babel src --out-dir lib/cjs",
-    "build:creevey:esm": "cross-env BABEL_MODE=esm babel src --out-dir lib/esm",
-    "build:client": "webpack --mode production",
-    "postbuild": "run-p copy:*",
-    "copy:index": "cpx scripts/dist/types/* lib/types/",
-    "copy:html": "cpx src/client/web/index.html lib/cjs/client/web",
+    "build:creevey:cjs": "cross-env BABEL_MODE=cjs babel src --out-dir lib/cjs --extensions=.ts,.tsx --ignore=src/client/web",
+    "build:creevey:esm": "cross-env BABEL_MODE=esm babel src --out-dir lib/esm --extensions=.ts,.tsx --ignore=src/client/web",
+    "build:client": "webpack --mode production && cpx src/client/web/index.html lib/cjs/client/web",
+    "postbuild": "redrun -p \"copy:*\"",
+    "copy:types": "cpx \"scripts/dist/types/*\" lib/types",
+    "copy:web": "cpx \"lib/cjs/client/web/*\" lib/esm/client/web",
     "version": "conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md",
-    "build-storybook": "build-storybook",
+    "build-storybook": "storybook build",
     "chromatic": "npx chromatic --project-token t3010eknrh",
     "prepare": "husky install"
   },
   "engines": {
-    "node": ">=10.10"
+    "node": ">=18.0"
   },
   "dependencies": {
-    "@babel/code-frame": "^7.12.13",
-    "@babel/generator": "^7.15.0",
-    "@babel/helpers": "^7.15.3",
-    "@babel/parser": "^7.15.3",
-    "@babel/plugin-transform-runtime": "^7.15.0",
-    "@babel/preset-env": "^7.15.0",
-    "@babel/preset-typescript": "^7.15.0",
-    "@babel/register": "^7.15.3",
-    "@babel/runtime-corejs3": "^7.15.3",
-    "@babel/traverse": "^7.15.0",
-    "@babel/types": "^7.15.0",
-    "@koa/cors": "^3.2.0",
-    "@octokit/core": "^3.3.1",
-    "@storybook/components": "^6.4.19",
-    "@storybook/csf": "0.0.2--canary.87bc651.0",
-    "@storybook/testing-library": "^0.0.9",
-    "@storybook/theming": "^6.4.19",
-    "@types/chai": "^4.2.15",
-    "@types/selenium-webdriver": "^4.0.12",
+    "@babel/plugin-transform-runtime": "^7.22.0",
+    "@babel/preset-env": "^7.22.0",
+    "@babel/preset-typescript": "^7.22.0",
+    "@babel/register": "^7.22.0",
+    "@babel/runtime-corejs3": "^7.22.0",
+    "@koa/cors": "^3.3.0",
+    "@octokit/core": "^4.0.4",
+    "@storybook/components": "^7.6.20",
+    "@storybook/core-events": "^7.6.20",
+    "@storybook/csf": "^0.1.2",
+    "@storybook/manager-api": "^7.6.20",
+    "@storybook/preview-api": "^7.6.20",
+    "@storybook/theming": "^7.6.20",
+    "@types/chai": "^4.3.1",
+    "@types/selenium-webdriver": "^4.1.26",
     "airbnb-js-shims": "^2.2.1",
     "babel-plugin-tsconfig-paths": "^1.0.3",
-    "chai": "^4.3.4",
+    "chai": "^4.3.6",
     "chalk": "^4.1.2",
-    "chokidar": "^3.5.1",
-    "core-js": "^3.16.3",
-    "dockerode": "^3.2.1",
-    "event-source-polyfill": "1.0.25",
+    "chokidar": "^3.5.3",
+    "core-js": "^3.23.4",
+    "dockerode": "^3.3.2",
     "find-cache-dir": "^3.3.1",
     "get-tsconfig": "^4.2.0",
-    "global-jsdom": "8.3.0",
-    "jsdom": "^16.5.2",
-    "koa": "^2.13.1",
+    "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
     "koa-mount": "^4.0.0",
     "koa-static": "^5.0.0",
-    "loader-utils": "^2.0.0",
     "lodash": "^4.17.21",
-    "loglevel": "^1.7.1",
+    "loglevel": "^1.8.0",
     "loglevel-plugin-prefix": "^0.8.4",
-    "micromatch": "^4.0.4",
-    "minimist": "^1.2.5",
-    "mocha": "~9.1.0",
-    "null-loader": "^4.0.1",
-    "ora": "^5.4.0",
-    "pirates": "^4.0.1",
-    "pixelmatch": "^5.2.1",
+    "micromatch": "^4.0.5",
+    "minimist": "^1.2.6",
+    "mocha": "~10.0.0",
+    "ora": "^5.4.1",
+    "pirates": "^4.0.5",
+    "pixelmatch": "^5.3.0",
     "pngjs": "^6.0.0",
-    "polished": "^4.1.1",
-    "qs": "^6.10.1",
+    "polished": "^4.2.2",
+    "qs": "^6.11.0",
     "regenerator-runtime": "^0.13.7",
-    "resolve-from": "^5.0.0",
-    "schema-utils": "^3.0.0",
-    "selenium-webdriver": "^4.0.0-beta.3",
-    "shelljs": "^0.8.4",
-    "ts-node": "^10.9.1",
-    "tsconfig-paths": "^3.11.0",
-    "webpack-node-externals": "^3.0.0",
-    "ws": "^7.4.6"
+    "selenium-webdriver": "^4.25.0",
+    "shelljs": "^0.8.5",
+    "tsconfig-paths": "^4.0.0",
+    "uuid": "^10.0.0",
+    "ws": "^8.8.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.13.14",
-    "@babel/core": "^7.15.0",
-    "@babel/plugin-proposal-class-properties": "^7.13.0",
-    "@babel/preset-react": "^7.13.13",
-    "@mdx-js/mdx": "^1.6.22",
-    "@storybook/addon-essentials": "^6.4.19",
-    "@storybook/addon-postcss": "^2.0.0",
-    "@storybook/addons": "^6.4.19",
-    "@storybook/api": "^6.4.19",
-    "@storybook/channels": "^6.4.19",
-    "@storybook/client-api": "^6.4.19",
-    "@storybook/client-logger": "^6.4.19",
-    "@storybook/core": "^6.4.19",
-    "@storybook/core-client": "^6.4.19",
-    "@storybook/core-common": "^6.4.19",
-    "@storybook/core-events": "^6.4.19",
-    "@storybook/core-server": "^6.4.19",
-    "@storybook/preview-web": "^6.4.19",
-    "@storybook/react": "^6.4.19",
-    "@types/babel__code-frame": "^7.0.2",
-    "@types/babel__generator": "^7.6.2",
-    "@types/babel__traverse": "^7.11.1",
-    "@types/dockerode": "^3.2.3",
+    "@babel/cli": "^7.22.0",
+    "@babel/core": "^7.22.0",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/preset-react": "^7.22.0",
+    "@storybook/addon-essentials": "^7.6.20",
+    "@storybook/addon-interactions": "^7.6.20",
+    "@storybook/addon-links": "^7.6.20",
+    "@storybook/addon-onboarding": "^1.0.10",
+    "@storybook/addons": "^7.6.20",
+    "@storybook/api": "^7.6.20",
+    "@storybook/channels": "^7.6.20",
+    "@storybook/client-api": "^7.6.20",
+    "@storybook/client-logger": "^7.6.20",
+    "@storybook/core-client": "^7.6.20",
+    "@storybook/core-common": "^7.6.20",
+    "@storybook/core-server": "^7.6.20",
+    "@storybook/preview-web": "^7.6.20",
+    "@storybook/react": "^7.6.20",
+    "@storybook/react-webpack5": "^7.6.20",
+    "@storybook/testing-library": "^0.2.2",
+    "@types/cpx": "^1",
+    "@types/dockerode": "^3.3.9",
     "@types/find-cache-dir": "^3.2.0",
     "@types/koa": "^2.13.1",
     "@types/koa-bodyparser": "^4.3.7",
     "@types/koa-mount": "^4.0.1",
     "@types/koa-static": "^4.0.1",
-    "@types/koa__cors": "^3.1.1",
-    "@types/loader-utils": "^2.0.2",
-    "@types/lodash": "^4.14.172",
+    "@types/koa__cors": "^3.3.0",
+    "@types/lodash": "^4.14.182",
     "@types/micromatch": "^4.0.1",
     "@types/minimist": "^1.2.1",
-    "@types/mocha": "^9.0.0",
-    "@types/node": "^14.14.37",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.19.50",
     "@types/pixelmatch": "^5.2.2",
     "@types/pngjs": "^6.0.0",
     "@types/qs": "^6.9.6",
     "@types/react": "^17.0.19",
     "@types/react-dom": "^17.0.3",
-    "@types/resize-observer-browser": "^0.1.5",
-    "@types/shelljs": "^0.8.8",
-    "@types/tmp": "^0.2.0",
-    "@types/webpack": "^4.41.26",
-    "@types/webpack-dev-server": "^3.11.3",
-    "@types/webpack-node-externals": "^2.5.1",
-    "@types/ws": "^7.4.0",
-    "@typescript-eslint/eslint-plugin": "^4.29.3",
-    "@typescript-eslint/parser": "^4.29.3",
-    "babel-loader": "^8.2.1",
-    "browserstack-local": "^1.4.8",
-    "chromatic": "^5.7.0",
-    "conventional-changelog-cli": "^2.1.1",
-    "cpx": "1.5.0",
+    "@types/resize-observer-browser": "^0.1.7",
+    "@types/shelljs": "^0.8.11",
+    "@types/tmp": "^0.2.3",
+    "@types/uuid": "^10",
+    "@types/webpack": "^5.28.0",
+    "@types/ws": "^8.5.3",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
+    "babel-loader": "^8.2.5",
+    "browserstack-local": "^1.5.1",
+    "chromatic": "^6.7.0",
+    "conventional-changelog-cli": "^2.2.2",
+    "cpx": "^1.5.0",
     "cross-env": "7.0.3",
-    "dotenv": "^10.0.0",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-import": "^2.24.2",
-    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "dotenv": "^16.0.1",
+    "eslint": "^8.19.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-jsx-a11y": "^6.6.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^3.4.1",
-    "eslint-plugin-react": "^7.23.1",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "git-cz": "^4.7.4",
-    "husky": "^7.0.2",
-    "immer": "^9.0.1",
-    "lint-staged": "^11.1.2",
-    "npm-run-all": "^4.1.5",
-    "pinst": "^2.1.6",
-    "prettier": "^2.2.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-react": "^7.30.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "git-cz": "^4.9.0",
+    "husky": "^8.0.1",
+    "immer": "^9.0.15",
+    "jest": "^28.1.3",
+    "lint-staged": "^13.0.3",
+    "pinst": "^3.0.0",
+    "prettier": "^2.7.1",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-is": "^17.0.2",
+    "redrun": "^11.0.5",
     "rimraf": "^3.0.2",
+    "storybook": "^7.6.20",
     "tmp": "^0.2.1",
-    "typescript": "~4.4.2",
-    "use-immer": "^0.6.0",
-    "webpack": "^4.44.2",
-    "webpack-cli": "^3.3.12",
-    "webpack-dev-server": "^3.11.2"
+    "typescript": "~4.7.4",
+    "use-immer": "^0.7.0",
+    "webpack": "^5.73.0",
+    "webpack-cli": "^4.10.0",
+    "webpack-dev-server": "^4.9.3"
   },
   "config": {
     "commitizen": {
@@ -229,7 +228,7 @@
     "displayName": "Creevey"
   },
   "volta": {
-    "node": "14.19.0",
-    "yarn": "1.22.17"
+    "node": "20.16.0",
+    "yarn": "4.4.0"
   }
 }

package/types/global.d.ts

@@ -0,0 +1,5 @@
+/* eslint-disable no-var */
+
+declare var __CREEVEY_SERVER_HOST__: string;
+declare var __CREEVEY_SERVER_PORT__: number;
+declare var __CREEVEY_CLIENT_PORT__: number | null;