codeceptjs 3.7.0-beta.3 → 3.7.0-beta.5

package/lib/utils.js

@@ -4,6 +4,7 @@ const path = require('path')
 const getFunctionArguments = require('fn-args')
 const deepClone = require('lodash.clonedeep')
 const { convertColorToRGBA, isColorProperty } = require('./colorUtils')
+const Fuse = require('fuse.js')
 
 function deepMerge(target, source) {
   const merge = require('lodash.merge')
@@ -484,3 +485,60 @@ module.exports.humanizeFunction = function (fn) {
 
   return simplified
 }
+
+/**
+ * Searches through a given data source using the Fuse.js library for fuzzy searching.
+ *
+ * @function searchWithFusejs
+ * @param {Array|Object} source - The data source to search through. This can be an array of objects or strings.
+ * @param {string} searchString - The search query string to match against the source.
+ * @param {Object} [opts] - Optional configuration object for Fuse.js.
+ * @param {boolean} [opts.includeScore=true] - Whether to include the score of the match in the results.
+ * @param {number} [opts.threshold=0.6] - Determines the match threshold; lower values mean stricter matching.
+ * @param {boolean} [opts.caseSensitive=false] - Whether the search should be case-sensitive.
+ * @param {number} [opts.distance=100] - Determines how far apart the search term is allowed to be from the target.
+ * @param {number} [opts.maxPatternLength=32] - The maximum length of the search pattern. Patterns longer than this are ignored.
+ * @param {boolean} [opts.ignoreLocation=false] - Whether the location of the match is ignored when scoring.
+ * @param {boolean} [opts.ignoreFieldNorm=false] - When true, the field's length is not considered when scoring.
+ * @param {Array<string>} [opts.keys=[]] - List of keys to search in the objects of the source array.
+ * @param {boolean} [opts.shouldSort=true] - Whether the results should be sorted by score.
+ * @param {string} [opts.sortFn] - A custom sorting function for sorting results.
+ * @param {number} [opts.minMatchCharLength=1] - The minimum number of characters that must match.
+ * @param {boolean} [opts.useExtendedSearch=false] - Enables extended search capabilities.
+ *
+ * @returns {Array<Object>} - An array of search results. Each result contains an item and, if `includeScore` is true, a score.
+ *
+ * @example
+ * const data = [
+ *   { title: "Old Man's War", author: "John Scalzi" },
+ *   { title: "The Lock Artist", author: "Steve Hamilton" },
+ * ];
+ *
+ * const options = {
+ *   keys: ['title', 'author'],
+ *   includeScore: true,
+ *   threshold: 0.4,
+ *   caseSensitive: false,
+ *   distance: 50,
+ *   ignoreLocation: true,
+ * };
+ *
+ * const results = searchWithFusejs(data, 'lock', options);
+ * console.log(results);
+ */
+module.exports.searchWithFusejs = function (source, searchString, opts) {
+  const fuse = new Fuse(source, opts)
+
+  return fuse.search(searchString)
+}
+
+module.exports.humanizeString = function (string) {
+  // split strings by words, then make them all lowercase
+  const _result = string
+    .replace(/([a-z](?=[A-Z]))/g, '$1 ')
+    .split(' ')
+    .map(word => word.toLowerCase())
+
+  _result[0] = _result[0] === 'i' ? this.ucfirst(_result[0]) : _result[0]
+  return _result.join(' ').trim()
+}

package/lib/within.js

@@ -3,7 +3,7 @@ const store = require('./store')
 const recorder = require('./recorder')
 const container = require('./container')
 const event = require('./event')
-const Step = require('./step')
+const MetaStep = require('./step/meta')
 const { isAsyncFunction } = require('./utils')
 
 /**
@@ -76,7 +76,7 @@ function within(context, fn) {
 
 module.exports = within
 
-class WithinStep extends Step.MetaStep {
+class WithinStep extends MetaStep {
   constructor(locator, fn) {
     super('Within')
     this.args = [locator]

package/lib/workers.js

@@ -1,11 +1,6 @@
 const path = require('path')
 const mkdirp = require('mkdirp')
 const { Worker } = require('worker_threads')
-const {
-  Suite,
-  Test,
-  reporters: { Base },
-} = require('mocha')
 const { EventEmitter } = require('events')
 const ms = require('ms')
 const Codecept = require('./codecept')
@@ -17,6 +12,7 @@ const { replaceValueDeep, deepClone } = require('./utils')
 const mainConfig = require('./config')
 const output = require('./output')
 const event = require('./event')
+const { repackTestForWorkersTransport: repackTest } = require('./mocha/test')
 const recorder = require('./recorder')
 const runHook = require('./hooks')
 const WorkerStorage = require('./workerStorage')
@@ -78,12 +74,6 @@ const simplifyObject = object => {
     }, {})
 }
 
-const repackTest = test => {
-  test = Object.assign(new Test(test.title || '', () => {}), test)
-  test.parent = Object.assign(new Suite(test.parent.title), test.parent)
-  return test
-}
-
 const createWorkerObjects = (testGroups, config, testRoot, options, selectedRuns) => {
   selectedRuns = options && options.all && config.multiple ? Object.keys(config.multiple) : selectedRuns
   if (selectedRuns === undefined || !selectedRuns.length || config.multiple === undefined) {
@@ -459,7 +449,7 @@ class Workers extends EventEmitter {
   }
 
   _finishRun() {
-    event.dispatcher.emit(event.workers.after)
+    event.dispatcher.emit(event.workers.after, { tests: this.workers.map(worker => worker.tests) })
     if (this.isFailed()) {
       process.exitCode = 1
     } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codeceptjs",
-  "version": "3.7.0-beta.3",
+  "version": "3.7.0-beta.5",
   "description": "Supercharged End 2 End Testing Framework for NodeJS",
   "keywords": [
     "acceptance",
@@ -31,7 +31,9 @@
   "main": "lib/index.js",
   "exports": {
     ".": "./lib/index.js",
-    "./els": "./lib/els.js"
+    "./els": "./lib/els.js",
+    "./effects": "./lib/effects.js",
+    "./steps": "./lib/steps.js"
   },
   "types": "typings/index.d.ts",
   "bin": {
@@ -114,14 +116,14 @@
     "uuid": "11.0.4"
   },
   "optionalDependencies": {
-    "@codeceptjs/detox-helper": "1.1.4"
+    "@codeceptjs/detox-helper": "1.1.5"
   },
   "devDependencies": {
     "@apollo/server": "^4",
     "@codeceptjs/expect-helper": "^0.2.2",
     "@codeceptjs/mock-request": "0.3.1",
     "@eslint/eslintrc": "3.2.0",
-    "@eslint/js": "9.17.0",
+    "@eslint/js": "9.18.0",
     "@faker-js/faker": "9.3.0",
     "@pollyjs/adapter-puppeteer": "6.0.6",
     "@pollyjs/core": "5.1.0",
@@ -166,7 +168,7 @@
     "tsd-jsdoc": "2.5.0",
     "typedoc": "0.27.6",
     "typedoc-plugin-markdown": "4.4.1",
-    "typescript": "5.7.2",
+    "typescript": "5.7.3",
     "wdio-docker-service": "1.5.0",
     "webdriverio": "^9.5.1",
     "xml2js": "0.6.2",

package/typings/index.d.ts

@@ -451,9 +451,6 @@ declare namespace CodeceptJS {
   }
 
   // Extending JSDoc generated typings
-  interface Step {
-    isMetaStep(): this is MetaStep
-  }
 
   // Types who are not be defined by JSDoc
   type actor = <T extends { [action: string]: (...args: any[]) => void }>(customSteps?: T & ThisType<WithTranslation<Methods & T>>) => WithTranslation<Methods & T>
@@ -502,7 +499,7 @@ declare namespace CodeceptJS {
     (title: string, opts: { [key: string]: any }, callback: HookCallback): ScenarioConfig
   }
   interface IHook {
-    (callback: HookCallback): void
+    (callback: HookCallback): HookConfig
   }
 
   interface Globals {
@@ -516,6 +513,10 @@ declare namespace CodeceptJS {
     useForSnippets?: boolean
     preferForRegexpMatch?: boolean
   }
+
+  interface HookConfig {
+    retry(retries?: number): HookConfig
+  }
 }
 
 // Globals

package/typings/promiseBasedTypes.d.ts

@@ -608,17 +608,11 @@ declare namespace CodeceptJS {
          * ```js
          * // taps outside to hide keyboard per default
          * I.hideDeviceKeyboard();
-         * I.hideDeviceKeyboard('tapOutside');
-         *
-         * // or by pressing key
-         * I.hideDeviceKeyboard('pressKey', 'Done');
          * ```
          *
          * Appium: support Android and iOS
-         * @param [strategy] - Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
-         * @param [key] - Optional key
          */
-        hideDeviceKeyboard(strategy?: 'tapOutside' | 'pressKey', key?: string): Promise<any>;
+        hideDeviceKeyboard(): Promise<any>;
         /**
          * Send a key event to the device.
          * List of keys: https://developer.android.com/reference/android/view/KeyEvent.html
@@ -1775,11 +1769,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1914,11 +1903,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -2962,11 +2946,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6353,11 +6332,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8174,11 +8148,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9333,11 +9302,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;

package/typings/types.d.ts

@@ -608,17 +608,11 @@ declare namespace CodeceptJS {
          * ```js
          * // taps outside to hide keyboard per default
          * I.hideDeviceKeyboard();
-         * I.hideDeviceKeyboard('tapOutside');
-         *
-         * // or by pressing key
-         * I.hideDeviceKeyboard('pressKey', 'Done');
          * ```
          *
          * Appium: support Android and iOS
-         * @param [strategy] - Desired strategy to close keyboard (‘tapOutside’ or ‘pressKey’)
-         * @param [key] - Optional key
          */
-        hideDeviceKeyboard(strategy?: 'tapOutside' | 'pressKey', key?: string): void;
+        hideDeviceKeyboard(): void;
         /**
          * Send a key event to the device.
          * List of keys: https://developer.android.com/reference/android/view/KeyEvent.html
@@ -1802,11 +1796,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type MockServerConfig = {
         port?: number;
         host?: string;
@@ -1941,11 +1930,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     class MockServer {
         /**
          * Start the mock server
@@ -3055,11 +3039,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PlaywrightConfig = {
         url?: string;
         browser?: 'chromium' | 'firefox' | 'webkit' | 'electron';
@@ -6597,11 +6576,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type PuppeteerConfig = {
         url: string;
         basicAuth?: any;
@@ -8554,11 +8528,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type RESTConfig = {
         endpoint?: string;
         prettyPrintJson?: boolean;
@@ -9773,11 +9742,6 @@ declare namespace CodeceptJS {
     // @ts-ignore
     // @ts-ignore
     // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
-    // @ts-ignore
     type WebDriverConfig = {
         url: string;
         browser: string;
@@ -12213,24 +12177,49 @@ declare namespace CodeceptJS {
     function session(sessionName: CodeceptJS.LocatorOrString, config: ((...params: any[]) => any) | {
         [key: string]: any;
     }, fn?: (...params: any[]) => any): any;
+    /**
+     * StepConfig is a configuration object for a step.
+     * It is used to create a new step that is a combination of other steps.
+     */
+    class StepConfig {
+        config: any;
+        /**
+         * Set the options for the step.
+         * @param opts - The options for the step.
+         * @returns - The step configuration object.
+         */
+        opts(opts: any): StepConfig;
+        /**
+         * Set the timeout for the step.
+         * @param timeout - The timeout for the step.
+         * @returns - The step configuration object.
+         */
+        timeout(timeout: number): StepConfig;
+        /**
+         * Set the retry for the step.
+         * @param retry - The retry for the step.
+         * @returns - The step configuration object.
+         */
+        retry(retry: number): StepConfig;
+    }
     /**
      * Each command in test executed through `I.` object is wrapped in Step.
      * Step allows logging executed commands and triggers hook before and after step execution.
      */
     class Step {
-        constructor(helper: CodeceptJS.Helper, name: string);
-        actor: string;
-        helper: CodeceptJS.Helper;
+        constructor(name: string);
         name: string;
+        timeouts: Map<number, number>;
+        args: any[];
+        opts: Record<string, any>;
+        actor: string;
         helperMethod: string;
         status: string;
-        suffix: string;
         prefix: string;
         comment: string;
-        args: any[];
-        metaStep: MetaStep;
+        metaStep: any;
         stack: string;
-        getTimeout(): number | undefined;
+        timeout: any;
         /**
          * @param timeout - timeout in milliseconds or 0 if no timeout
          * @param order - order defines the priority of timeout, timeouts set with lower order override those set with higher order.
@@ -12239,7 +12228,6 @@ declare namespace CodeceptJS {
         setTimeout(timeout: number, order: number): void;
         setTrace(): void;
         setArguments(args: any[]): void;
-        run(...args: any[]): any;
         setStatus(status: string): void;
         humanize(): string;
         humanizeArgs(): string;
@@ -12248,11 +12236,6 @@ declare namespace CodeceptJS {
         toCliStyled(): string;
         toCode(): string;
         hasBDDAncestor(): boolean;
-        static MetaStep: typeof MetaStep;
-    }
-    class MetaStep extends Step {
-        isBDD(): boolean;
-        run(): any;
     }
     /**
      * global values for current session
@@ -12261,7 +12244,9 @@ declare namespace CodeceptJS {
         var debugMode: boolean;
         var timeouts: boolean;
         var dryRun: boolean;
+        var onPause: boolean;
         var currentTest: CodeceptJS.Test | null;
+        var currentStep: any;
     }
     /**
      * Describe a "suite" with the given `title`
@@ -12954,22 +12939,12 @@ declare namespace CodeceptJS {
 }
 
 /**
- * timeouts set with order below zero only override timeouts of higher order if their value is smaller
- */
-declare var testOrSuite: any;
-
-/**
- * 0-9 - designated for override of timeouts set from code, 5 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=true
- */
-declare var stepTimeoutHard: any;
-
-/**
- * 10-19 - designated for timeouts set from code, 15 is order of I.setTimeout(t) operation
+ * corresponding helper
  */
-declare var codeLimitTime: any;
+declare var helper: CodeceptJS.Helper;
 
 /**
- * 20-29 - designated for timeout settings which could be overriden in tests code, 25 is used by stepTimeout plugin when stepTimeout.config.overrideStepLimits=false
+ * name of method to be executed
  */
-declare var stepTimeoutSoft: any;
+declare var helperMethod: string;