fixed typings

Author: DavertMik

lib/step.js

@@ -1,6 +1,20 @@
 // refactored step class, moved to helper
+/**
+ * Step is wrapper around a helper method.
+ * It is used to create a new step that is a combination of other steps.
+ */
+const BaseStep = require('./step/base')
+const StepConfig = require('./step/config')
 const Step = require('./step/helper')
+
+/**
+ * MetaStep is a step that is used to wrap other steps.
+ * It is used to create a new step that is a combination of other steps.
+ * It is used to create a new step that is a combination of other steps.
+ */
 const MetaStep = require('./step/meta')
 
 module.exports = Step
 module.exports.MetaStep = MetaStep
+module.exports.BaseStep = BaseStep
+module.exports.StepConfig = StepConfig

lib/step/base.js

@@ -8,7 +8,6 @@ const STACK_LINE = 4
 /**
  * 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.
- * @param {CodeceptJS.Helper} helper
  * @param {string} name
  */
 class Step {
@@ -21,7 +20,7 @@ class Step {
     /** @member {Array<*>} */
     this.args = []
 
-    /** @member {StepConfig} */
+    /** @member {Record<string,any>} */
     this.opts = {}
     /** @member {string} */
     this.actor = 'I' // I = actor
@@ -33,7 +32,7 @@ class Step {
     this.prefix = this.suffix = ''
     /** @member {string} */
     this.comment = ''
-    /** @member {MetaStep} */
+    /** @member {import('./meta')} */
     this.metaStep = undefined
     /** @member {string} */
     this.stack = ''

lib/step/config.js

@@ -1,22 +1,42 @@
+/**
+ * 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 {
-  constructor(opts) {
+  constructor(opts = {}) {
+    /** @member {{ opts: Record<string, any>, timeout: number|undefined, retry: number|undefined }} */
     this.config = {
       opts,
       timeout: undefined,
       retry: undefined,
     }
   }
 
+  /**
+   * Set the options for the step.
+   * @param {object} opts - The options for the step.
+   * @returns {StepConfig} - The step configuration object.
+   */
   opts(opts) {
     this.config.opts = opts
     return this
   }
 
+  /**
+   * Set the timeout for the step.
+   * @param {number} timeout - The timeout for the step.
+   * @returns {StepConfig} - The step configuration object.
+   */
   timeout(timeout) {
     this.config.timeout = timeout
     return this
   }
 
+  /**
+   * Set the retry for the step.
+   * @param {number} retry - The retry for the step.
+   * @returns {StepConfig} - The step configuration object.
+   */
   retry(retry) {
     this.config.retry = retry
     return this

lib/step/meta.js

@@ -3,10 +3,10 @@ const event = require('../event')
 const { humanizeString } = require('../utils')
 
 class MetaStep extends Step {
-  constructor(obj, method) {
+  constructor(actor, method) {
     if (!method) method = ''
     super(method)
-    this.actor = obj
+    this.actor = actor
   }
 
   /** @return {boolean} */

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>

typings/jsdoc.conf.js

@@ -16,7 +16,10 @@ module.exports = {
       './lib/recorder.js',
       './lib/secret.js',
       './lib/session.js',
-      './lib/step.js',
+      './lib/step/config.js',
+      './lib/step/base.js',
+      './lib/step/helper.js',
+      './lib/step/meta.js',
       './lib/store.js',
       './lib/mocha/ui.js',
       './lib/mocha/featureConfig.js',