codeceptjs 2.3.4 → 2.4.1

package/package.json

@@ -1,10 +1,15 @@
 {
   "name": "codeceptjs",
-  "version": "2.3.4",
-  "description": "Modern Era Acceptance Testing Framework for NodeJS",
+  "version": "2.4.1",
+  "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
     "end2end",
+    "end 2 end",
+    "puppeteer",
+    "webdriver",
+    "testcafe",
+    "protractor",
     "bdd",
     "tdd",
     "testing"
@@ -20,7 +25,8 @@
     "bin",
     "docs",
     "lib",
-    "translations"
+    "translations",
+    "typings"
   ],
   "main": "lib/index.js",
   "typings": "typings/index.d.ts",
@@ -32,19 +38,27 @@
     "build": "tsc -p ./",
     "json-server": "./node_modules/json-server/bin/index.js test/data/rest/db.json -p 8010 --watch -m test/data/rest/headers.js",
     "json-server:graphql": "node test/data/graphql/index.js",
-    "lint": "eslint bin/ examples/ lib/ test/ translations/ gulpfile.js",
-    "lint-fix": "eslint bin/ examples/ lib/ test/ translations/ gulpfile.js --fix",
-    "docs": "gulp docs",
-    "test": "mocha test/unit --recursive && mocha test/runner --recursive",
-    "dev:graphql": "nodemon test/data/graphql/index.js"
+    "lint": "eslint bin/ examples/ lib/ test/ translations/ runio.js",
+    "lint-fix": "eslint bin/ examples/ lib/ test/ translations/ runio.js --fix",
+    "docs": "./runio.js docs",
+    "test:unit": "mocha test/unit --recursive",
+    "test:runner": "mocha test/runner --recursive",
+    "test": "npm run test:unit && npm run test:runner",
+    "def": "./runio.js def",
+    "dev:graphql": "nodemon test/data/graphql/index.js",
+    "publish:site": "./runio.js publish:site"
   },
   "dependencies": {
+    "@codeceptjs/configure": "^0.4.0",
+    "@types/mocha": "^5.2.7",
     "allure-js-commons": "^1.3.2",
-    "axios": "^0.19.0",
+    "arrify": "^2.0.1",
+    "axios": "^0.19.1",
     "chalk": "^1.1.3",
-    "commander": "^2.20.0",
+    "commander": "^2.20.3",
     "css-to-xpath": "^0.1.0",
     "cucumber-expressions": "^6.6.2",
+    "envinfo": "^7.3.1",
     "escape-string-regexp": "^1.0.3",
     "figures": "^2.0.0",
     "fn-args": "^4.0.0",
@@ -56,51 +70,57 @@
     "lodash.clonedeep": "^4.5.0",
     "lodash.merge": "^4.6.2",
     "mkdirp": "^0.5.1",
-    "mocha": "^6.2.0",
+    "mocha": "^6.2.2",
     "mocha-junit-reporter": "^1.23.1",
     "ms": "^2.1.2",
-    "parse-function": "^5.2.11",
+    "parse-function": "^5.5.0",
     "promise-retry": "^1.1.1",
     "requireg": "^0.1.8",
-    "resq": "^1.6.0",
+    "resq": "^1.7.0",
     "semver": "^6.2.0",
     "sprintf-js": "^1.1.1"
   },
   "devDependencies": {
-    "@codeceptjs/detox-helper": "^1.0.1",
-    "@pollyjs/adapter-puppeteer": "^2.6.2",
-    "@pollyjs/core": "^2.6.2",
+    "@codeceptjs/detox-helper": "^1.0.2",
+    "@pollyjs/adapter-puppeteer": "^2.6.3",
+    "@pollyjs/core": "^2.6.3",
     "@types/inquirer": "^0.0.35",
-    "@types/mocha": "^5.2.7",
     "@types/node": "^8.10.54",
-    "@wdio/sauce-service": "^5.13.2",
-    "@wdio/selenium-standalone-service": "^5.13.2",
-    "@wdio/utils": "^5.13.2",
-    "apollo-server-express": "^2.9.4",
+    "@wdio/sauce-service": "^5.16.10",
+    "@wdio/selenium-standalone-service": "^5.16.10",
+    "@wdio/utils": "^5.16.15",
+    "apollo-server-express": "^2.9.16",
     "chai": "^3.4.1",
     "chai-as-promised": "^5.2.0",
+    "chai-subset": "^1.6.0",
     "documentation": "^8.1.2",
-    "eslint": "^4.17.0",
-    "eslint-config-airbnb-base": "^12.1.0",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-mocha": "^5.3.0",
+    "eslint": "^6.8.0",
+    "eslint-config-airbnb-base": "^14.0.0",
+    "eslint-plugin-import": "^2.19.1",
+    "eslint-plugin-mocha": "^6.2.2",
     "express": "^4.17.1",
     "faker": "^4.1.0",
     "graphql": "^14.5.8",
     "husky": "^1.2.1",
+    "jsdoc": "^3.6.2",
+    "jsdoc-typeof-plugin": "^1.0.0",
     "json-server": "^0.10.1",
     "nightmare": "^3.0.2",
-    "nodemon": "^1.19.2",
+    "nodemon": "^1.19.4",
     "protractor": "^5.4.1",
     "puppeteer": "^1.20.0",
+    "qrcode-terminal": "^0.12.0",
     "rosie": "^1.6.0",
+    "runio.js": "^1.0.19",
     "sinon": "^1.17.2",
     "sinon-chai": "^2.14.0",
-    "testcafe": "^1.5.0",
+    "testcafe": "^1.7.1",
+    "ts-morph": "^3.1.3",
+    "tsd-jsdoc": "^2.3.0",
     "typescript": "^2.9.2",
     "wdio-docker-service": "^1.5.0",
-    "webdriverio": "^5.13.2",
-    "xmldom": "^0.1.27",
+    "webdriverio": "^5.18.4",
+    "xmldom": "^0.1.31",
     "xpath": "0.0.27"
   },
   "engines": {

package/typings/Mocha.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="Mocha" />
+
+declare module "mocha/lib/reporters/base" {
+  export = Mocha.reporters.Base;
+}
+
+declare module "mocha/lib/suite" {
+  export = Mocha.Suite;
+}
+
+declare module "mocha/lib/context" {
+  export = Mocha.Context;
+}
+
+declare module "mocha/lib/test" {
+  export = Mocha.Test;
+}
+
+declare module "mocha/lib/mocha" {
+  export = Mocha;
+}

package/typings/Protractor.d.ts

@@ -0,0 +1,16 @@
+import * as Protractor from "protractor";
+
+declare global {
+  namespace NodeJS {
+    interface Global {
+      // Used by Protractor helper
+      by: Protractor.ProtractorBy;
+      By: Protractor.ProtractorBy;
+      ExpectedConditions: Protractor.ProtractorExpectedConditions;
+      element: typeof Protractor.element;
+      $: typeof Protractor.$;
+      $$: typeof Protractor.$$;
+      browser: Protractor.ProtractorBrowser;
+    }
+  }
+}

package/typings/index.d.ts

@@ -0,0 +1,169 @@
+// Type definitions for CodeceptJS
+// Project: https://github.com/codeception/codeceptjs/
+/// <reference path="./types.d.ts" />
+/// <reference types="webdriverio" />
+/// <reference types="Mocha" />
+
+declare namespace CodeceptJS {
+  type WithTranslation<T> = T &
+    import("./utils").Translate<T, CodeceptJS.Translation.Actions>;
+
+  // Could get extended by user generated typings
+  interface Methods extends ActorStatic {}
+  interface I {}
+  interface IHook {}
+  interface IScenario {}
+  interface CallbackOrder extends Array<any> {}
+  interface SupportObject {
+    I: CodeceptJS.I;
+  }
+  namespace Translation {
+    interface Actions {}
+  }
+
+  // Extending JSDoc generated typings
+  interface Step {
+    isMetaStep(): this is MetaStep;
+  }
+
+  // Types who are not be defined by JSDoc
+  type actor = <T extends { [action: string]: Function }>(
+    customSteps?: T & ThisType<WithTranslation<Methods & T>>
+  ) => WithTranslation<Methods & T>;
+
+  type ILocator =
+    | { id: string }
+    | { xpath: string }
+    | { css: string }
+    | { name: string }
+    | { frame: string }
+    | { android: string }
+    | { ios: string }
+    | { android: string, ios: string }
+    | { react: string };
+
+  type LocatorOrString = string | ILocator | Locator;
+
+  interface HookCallback<U extends any[]> { (...args: U): void; }
+  interface Scenario extends IScenario { only: IScenario, skip: IScenario }
+  interface IData { Scenario: IScenario, only: { Scenario: IScenario } }
+
+  interface IScenario {
+    <T extends any[] = CallbackOrder>(
+      title: string,
+      callback: HookCallback<T>
+    ): ScenarioConfig;
+    <T extends any[] = CallbackOrder>(
+      title: string,
+      opts: { [key: string]: any },
+      callback: HookCallback<T>
+    ): ScenarioConfig;
+  }
+  interface IHook {
+    <T extends any[] = CallbackOrder>(callback: HookCallback<T>): void;
+  }
+
+  interface Globals {
+    codeceptjs: typeof codeceptjs;
+  }
+}
+
+// Globals
+declare const codecept_dir: string;
+declare const output_dir: string;
+
+declare const actor: CodeceptJS.actor;
+declare const codecept_actor: CodeceptJS.actor;
+declare const Helper: typeof CodeceptJS.Helper;
+declare const codecept_helper: typeof CodeceptJS.Helper;
+declare const pause: typeof CodeceptJS.pause;
+declare const within: typeof CodeceptJS.within;
+declare const session: typeof CodeceptJS.session;
+declare const DataTable: typeof CodeceptJS.DataTable;
+declare const codeceptjs: typeof CodeceptJS.index;
+declare const locate: typeof CodeceptJS.Locator.build;
+declare function inject(): CodeceptJS.SupportObject;
+declare function inject<T extends keyof CodeceptJS.SupportObject>(
+  name: T
+): CodeceptJS.SupportObject[T];
+declare const secret: typeof CodeceptJS.Secret.secret;
+
+// BDD
+declare const Given: typeof CodeceptJS.addStep;
+declare const When: typeof CodeceptJS.addStep;
+declare const Then: typeof CodeceptJS.addStep;
+
+declare const Feature: typeof CodeceptJS.Feature;
+declare const Scenario: CodeceptJS.Scenario;
+declare const xScenario: CodeceptJS.IScenario;
+declare function Data(data: any): CodeceptJS.IData;
+declare function xData(data: any): CodeceptJS.IData;
+
+// Hooks
+declare const BeforeSuite: CodeceptJS.IHook;
+declare const AfterSuite: CodeceptJS.IHook;
+declare const Background: CodeceptJS.IHook;
+declare const Before: CodeceptJS.IHook;
+declare const After: CodeceptJS.IHook;
+
+interface Window {
+  codeceptjs: typeof CodeceptJS.browserCodecept;
+  resq: any;
+}
+
+declare namespace NodeJS {
+  interface Process {
+    profile: string;
+  }
+
+  interface Global extends CodeceptJS.Globals {
+    codecept_dir: typeof codecept_dir;
+    output_dir: typeof output_dir;
+
+    actor: typeof actor;
+    codecept_actor: typeof codecept_actor;
+    Helper: typeof Helper;
+    codecept_helper: typeof codecept_helper;
+    pause: typeof pause;
+    within: typeof within;
+    session: typeof session;
+    DataTable: typeof DataTable;
+    locate: typeof locate;
+    inject: typeof inject;
+    secret: typeof secret;
+
+    // BDD
+    Given: typeof Given;
+    When: typeof When;
+    Then: typeof Then;
+  }
+}
+
+declare namespace Mocha {
+  interface MochaGlobals {
+    Feature: typeof Feature;
+    Scenario: typeof Scenario;
+    xScenario: typeof xScenario;
+    Data: typeof Data;
+    xData: typeof xData;
+    BeforeSuite: typeof BeforeSuite;
+    AfterSuite: typeof AfterSuite;
+    Background: typeof Background;
+    Before: typeof Before;
+    After: typeof After;
+  }
+
+  interface Suite {
+    tags: any[]
+    comment: string
+    feature: any
+  }
+
+  interface Test {
+    tags: any[]
+  }
+}
+
+declare module "codeceptjs" {
+  export = codeceptjs;
+}

package/typings/jsdoc.conf.js

@@ -0,0 +1,34 @@
+module.exports = {
+  source: {
+    include: [
+      './docs/build',
+      './lib/actor.js',
+      './lib/codecept.js',
+      './lib/config.js',
+      './lib/container.js',
+      './lib/data/table.js',
+      './lib/event.js',
+      './lib/helper.js',
+      './lib/helper/clientscripts/nightmare.js',
+      './lib/index.js',
+      './lib/interfaces',
+      './lib/locator.js',
+      './lib/output.js',
+      './lib/pause.js',
+      './lib/recorder.js',
+      './lib/secret.js',
+      './lib/session.js',
+      './lib/step.js',
+      './lib/store.js',
+      './lib/ui.js',
+      './lib/within.js',
+      require.resolve('@codeceptjs/detox-helper'),
+    ],
+  },
+  opts: {
+    template: 'node_modules/tsd-jsdoc/dist',
+    recurse: true,
+    destination: './typings/',
+  },
+  plugins: ['jsdoc.namespace.js', 'jsdoc-typeof-plugin'],
+};

package/typings/jsdoc.namespace.js

@@ -0,0 +1,29 @@
+// Helps tsd-jsdoc to exports all typings into the CodeceptJS namespace,
+// instead of the global.
+
+let namespaceAdded = false;
+const kinds = ['class', 'constant', 'function', 'typedef', 'interface', 'namespace'];
+const namespace = 'CodeceptJS';
+
+module.exports = {
+  handlers: {
+    beforeParse(event) {
+      if (!namespaceAdded) {
+        event.source += `/** @namespace ${namespace} */`;
+        namespaceAdded = true;
+      }
+    },
+    newDoclet: ({ doclet }) => {
+      if (doclet.undocumented
+        || doclet.memberof
+        || !kinds.includes(doclet.kind)
+        || (doclet.kind === 'namespace' && doclet.longname === 'CodeceptJS')
+      ) {
+        return;
+      }
+      doclet.memberof = namespace;
+      doclet.longname = `${doclet.memberof}.${doclet.longname}`;
+      if (doclet.scope === 'global') doclet.scope = 'static';
+    },
+  },
+};