sat-wait 0.0.1

package/.prettierrc

@@ -0,0 +1,11 @@
+{
+	"singleQuote": true,
+	"trailingComma": "all",
+	"arrowParens": "avoid",
+	"printWidth": 120,
+	"tabWidth": 2,
+	"useTabs": false,
+	"semi": true,
+	"bracketSpacing": true,
+	"proseWrap": "never"
+}

package/built/index.d.ts

@@ -0,0 +1 @@
+export * from './wait';

package/built/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./wait"), exports);
+//# sourceMappingURL=index.js.map

package/built/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAuB"}

package/built/wait.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Asynchronously sleeps for the specified number of milliseconds.
+ *
+ * @param {number} [millisecond=5000] - The number of milliseconds to sleep. Defaults to 5 seconds (5000 milliseconds).
+ * @returns {Promise<void>} A Promise that resolves after the specified sleep duration.
+ */
+declare function sleep(millisecond?: number): Promise<unknown>;
+export type IWaiterOpts = {
+    timeout?: number;
+    interval?: number;
+    dontThrow?: boolean;
+    falseIfError?: boolean;
+    stopIfNoError?: boolean;
+    message?: string | ((timeout: number, callbackError?: any) => Promise<string> | string);
+    waiterError?: new (...args: any[]) => any;
+    analyseResult?: (...args: any[]) => boolean | Promise<boolean>;
+    before?: () => Promise<void> | any;
+    after?: () => Promise<void> | any;
+    callEveryCycle?: () => Promise<void> | any;
+};
+/**
+ * @example
+ * const {waitFor} = require('sat-utils');
+ *
+ * waitResult();
+ * async function waitResult() {
+ *  await waitFor(async () => new Promise(res => setTimeout(res, 2500)), {
+ *    timeout: 5000,
+ *    interval: 500
+ *  })
+ * }
+ *
+ * @param {Function} callback
+ * @param {!Object} options execution options
+ * @param {number} [options.timeout] execution time
+ * @param {number} [options.interval] call interval
+ * @param {boolean} [options.dontThrow] if during waiting cylce result was not achived - last call back execution result will be returned as a waiting cycle result
+ * @param {boolean} [options.falseIfError] if call back throws an error - counted as negative result
+ * @param {boolean} [options.stopIfNoError] if callback did not throw error - counted as successful result
+ * @param {Error|new (...args: any[]) => any} [options.waiterError] error which will be thrown if result will not achieved
+ * @param {Function} [options.analyseResult] custom analyser of the call back result
+ * @param {Function} [options.before] call before waiting cycle
+ * @param {Function} [options.after] call after waiting cycle, even if result was not achived, if result achived - also will be executed
+ * @param {Function} [options.callEveryCycle] call every time after main call back execution if result was not achived
+ * @returns {any} any result that call back will return
+ */
+declare function waitFor(callback: any, options?: IWaiterOpts): Promise<any>;
+declare namespace waitFor {
+    var setDefaultOpts: (opts: IWaiterOpts) => void;
+}
+export { waitFor, sleep };

package/built/wait.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitFor = waitFor;
+exports.sleep = sleep;
+/* eslint-disable sonarjs/cognitive-complexity */
+const sat_utils_1 = require("sat-utils");
+/**
+ * Asynchronously sleeps for the specified number of milliseconds.
+ *
+ * @param {number} [millisecond=5000] - The number of milliseconds to sleep. Defaults to 5 seconds (5000 milliseconds).
+ * @returns {Promise<void>} A Promise that resolves after the specified sleep duration.
+ */
+async function sleep(millisecond = 5 * 1000) {
+    return new Promise(resolve => setTimeout(resolve, millisecond));
+}
+const defaultOptions = {};
+/**
+ * @example
+ * const {waitFor} = require('sat-utils');
+ *
+ * waitResult();
+ * async function waitResult() {
+ *  await waitFor(async () => new Promise(res => setTimeout(res, 2500)), {
+ *    timeout: 5000,
+ *    interval: 500
+ *  })
+ * }
+ *
+ * @param {Function} callback
+ * @param {!Object} options execution options
+ * @param {number} [options.timeout] execution time
+ * @param {number} [options.interval] call interval
+ * @param {boolean} [options.dontThrow] if during waiting cylce result was not achived - last call back execution result will be returned as a waiting cycle result
+ * @param {boolean} [options.falseIfError] if call back throws an error - counted as negative result
+ * @param {boolean} [options.stopIfNoError] if callback did not throw error - counted as successful result
+ * @param {Error|new (...args: any[]) => any} [options.waiterError] error which will be thrown if result will not achieved
+ * @param {Function} [options.analyseResult] custom analyser of the call back result
+ * @param {Function} [options.before] call before waiting cycle
+ * @param {Function} [options.after] call after waiting cycle, even if result was not achived, if result achived - also will be executed
+ * @param {Function} [options.callEveryCycle] call every time after main call back execution if result was not achived
+ * @returns {any} any result that call back will return
+ */
+async function waitFor(callback, options = {}) {
+    if (!(0, sat_utils_1.isObject)(options)) {
+        throw new TypeError(`waitFor(): second argument should be an object, current arg is ${(0, sat_utils_1.getType)(options)}`);
+    }
+    let callbackError;
+    const mergedOpts = { ...defaultOptions, ...options };
+    const { message, timeout = 5000, interval = 250, dontThrow = false, analyseResult, falseIfError = true, stopIfNoError, waiterError = Error, callEveryCycle = () => { }, before = () => { }, after = () => { }, } = mergedOpts;
+    if (!(0, sat_utils_1.isFunction)(callback) && !(0, sat_utils_1.isAsyncFunction)(callback)) {
+        throw new TypeError(`waitFor(): first argument should be a function, async function or arrow function current arg is ${(0, sat_utils_1.getType)(callback)}`);
+    }
+    if (!(0, sat_utils_1.isNumber)(interval)) {
+        throw new TypeError(`waitFor(): second argument property "interval" should be a number, current arg is ${(0, sat_utils_1.getType)(interval)}`);
+    }
+    if (!(0, sat_utils_1.isNumber)(interval)) {
+        throw new TypeError(`waitFor(): second argument property "interval" should be a number, current arg is ${(0, sat_utils_1.getType)(interval)}`);
+    }
+    if (!(0, sat_utils_1.isNumber)(timeout)) {
+        throw new TypeError(`waitFor(): second argument property "timeout" should be a number, current arg is ${(0, sat_utils_1.getType)(timeout)}`);
+    }
+    if (!(0, sat_utils_1.isFunction)(before) && !(0, sat_utils_1.isAsyncFunction)(before)) {
+        throw new TypeError(`waitFor(): second argument property "before" should be a function, async function or arrow function, current arg is ${(0, sat_utils_1.getType)(before)}`);
+    }
+    if (!(0, sat_utils_1.isFunction)(after) && !(0, sat_utils_1.isAsyncFunction)(after)) {
+        throw new TypeError(`waitFor(): second argument property "after" should be a function, async function or arrow function, current arg is ${(0, sat_utils_1.getType)(before)}`);
+    }
+    if (!(0, sat_utils_1.isFunction)(callEveryCycle) && !(0, sat_utils_1.isAsyncFunction)(callEveryCycle)) {
+        throw new TypeError(`waitFor(): second argument property "callEveryCycle" should be a function, async function or arrow function, current arg is ${(0, sat_utils_1.getType)(callEveryCycle)}`);
+    }
+    if (analyseResult && !(0, sat_utils_1.isFunction)(analyseResult) && !(0, sat_utils_1.isAsyncFunction)(analyseResult)) {
+        throw new TypeError(`waitFor(): second argument property "analyseResult" should be a function, async function or arrow function, current arg is ${(0, sat_utils_1.getType)(analyseResult)}`);
+    }
+    const start = Date.now();
+    let result;
+    await before();
+    while (Date.now() - start < timeout) {
+        if (falseIfError) {
+            try {
+                result = await callback();
+                if (stopIfNoError)
+                    return result;
+            }
+            catch (error) {
+                callbackError = error;
+                result = false;
+            }
+        }
+        else {
+            result = await callback();
+        }
+        if (analyseResult && (await analyseResult(result))) {
+            await after();
+            return result;
+        }
+        if (result) {
+            await after();
+            return result;
+        }
+        try {
+            await callEveryCycle();
+        }
+        catch (error) {
+            callbackError = error;
+        }
+        await sleep(interval);
+    }
+    await after();
+    if (dontThrow) {
+        return result;
+    }
+    if (!result) {
+        const callbackErrorMessagePart = callbackError || '';
+        let errorMessage = `Required condition was not achieved during ${timeout} ms. ${callbackErrorMessagePart}`;
+        if ((0, sat_utils_1.isString)(message)) {
+            errorMessage = message;
+        }
+        else if ((0, sat_utils_1.isFunction)(message) || (0, sat_utils_1.isAsyncFunction)(message)) {
+            errorMessage = await message(timeout, callbackError);
+        }
+        throw new waiterError(errorMessage);
+    }
+}
+waitFor.setDefaultOpts = function (opts) {
+    Object.keys(defaultOptions).forEach(key => {
+        delete defaultOptions[key];
+    });
+    Object.assign(defaultOptions, opts);
+};
+//# sourceMappingURL=wait.js.map

package/built/wait.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wait.js","sourceRoot":"","sources":["../lib/wait.ts"],"names":[],"mappings":";;AA4MS,0BAAO;AAAE,sBAAK;AA5MvB,iDAAiD;AACjD,yCAA+F;AAE/F;;;;;GAKG;AACH,KAAK,UAAU,KAAK,CAAC,WAAW,GAAG,CAAC,GAAG,IAAI;IACzC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;AAClE,CAAC;AAiBD,MAAM,cAAc,GAAG,EAAE,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,KAAK,UAAU,OAAO,CAAC,QAAQ,EAAE,UAAuB,EAAE;IACxD,IAAI,CAAC,IAAA,oBAAQ,EAAC,OAAO,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,SAAS,CAAC,kEAAkE,IAAA,mBAAO,EAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC5G,CAAC;IAED,IAAI,aAAa,CAAC;IAClB,MAAM,UAAU,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,OAAO,EAAE,CAAC;IACrD,MAAM,EACJ,OAAO,EACP,OAAO,GAAG,IAAI,EACd,QAAQ,GAAG,GAAG,EACd,SAAS,GAAG,KAAK,EACjB,aAAa,EACb,YAAY,GAAG,IAAI,EACnB,aAAa,EACb,WAAW,GAAG,KAAK,EACnB,cAAc,GAAG,GAAG,EAAE,GAAE,CAAC,EACzB,MAAM,GAAG,GAAG,EAAE,GAAE,CAAC,EACjB,KAAK,GAAG,GAAG,EAAE,GAAE,CAAC,GACjB,GAAG,UAAU,CAAC;IAEf,IAAI,CAAC,IAAA,sBAAU,EAAC,QAAQ,CAAC,IAAI,CAAC,IAAA,2BAAe,EAAC,QAAQ,CAAC,EAAE,CAAC;QACxD,MAAM,IAAI,SAAS,CACjB,mGAAmG,IAAA,mBAAO,EACxG,QAAQ,CACT,EAAE,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAA,oBAAQ,EAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,SAAS,CACjB,qFAAqF,IAAA,mBAAO,EAAC,QAAQ,CAAC,EAAE,CACzG,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAA,oBAAQ,EAAC,QAAQ,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,SAAS,CACjB,qFAAqF,IAAA,mBAAO,EAAC,QAAQ,CAAC,EAAE,CACzG,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAA,oBAAQ,EAAC,OAAO,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,SAAS,CACjB,oFAAoF,IAAA,mBAAO,EAAC,OAAO,CAAC,EAAE,CACvG,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAA,sBAAU,EAAC,MAAM,CAAC,IAAI,CAAC,IAAA,2BAAe,EAAC,MAAM,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,SAAS,CACjB,uHAAuH,IAAA,mBAAO,EAC5H,MAAM,CACP,EAAE,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAA,sBAAU,EAAC,KAAK,CAAC,IAAI,CAAC,IAAA,2BAAe,EAAC,KAAK,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,SAAS,CACjB,sHAAsH,IAAA,mBAAO,EAC3H,MAAM,CACP,EAAE,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,IAAA,sBAAU,EAAC,cAAc,CAAC,IAAI,CAAC,IAAA,2BAAe,EAAC,cAAc,CAAC,EAAE,CAAC;QACpE,MAAM,IAAI,SAAS,CACjB,+HAA+H,IAAA,mBAAO,EACpI,cAAc,CACf,EAAE,CACJ,CAAC;IACJ,CAAC;IAED,IAAI,aAAa,IAAI,CAAC,IAAA,sBAAU,EAAC,aAAa,CAAC,IAAI,CAAC,IAAA,2BAAe,EAAC,aAAa,CAAC,EAAE,CAAC;QACnF,MAAM,IAAI,SAAS,CACjB,8HAA8H,IAAA,mBAAO,EACnI,aAAa,CACd,EAAE,CACJ,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,IAAI,MAAM,CAAC;IAEX,MAAM,MAAM,EAAE,CAAC;IAEf,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,OAAO,EAAE,CAAC;QACpC,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC;gBACH,MAAM,GAAG,MAAM,QAAQ,EAAE,CAAC;gBAE1B,IAAI,aAAa;oBAAE,OAAO,MAAM,CAAC;YACnC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,aAAa,GAAG,KAAK,CAAC;gBACtB,MAAM,GAAG,KAAK,CAAC;YACjB,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,MAAM,QAAQ,EAAE,CAAC;QAC5B,CAAC;QAED,IAAI,aAAa,IAAI,CAAC,MAAM,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YACnD,MAAM,KAAK,EAAE,CAAC;YACd,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,KAAK,EAAE,CAAC;YAEd,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,cAAc,EAAE,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,aAAa,GAAG,KAAK,CAAC;QACxB,CAAC;QAED,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,KAAK,EAAE,CAAC;IAEd,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,wBAAwB,GAAG,aAAa,IAAI,EAAE,CAAC;QACrD,IAAI,YAAY,GAAG,8CAA8C,OAAO,QAAQ,wBAAwB,EAAE,CAAC;QAE3G,IAAI,IAAA,oBAAQ,EAAC,OAAO,CAAC,EAAE,CAAC;YACtB,YAAY,GAAG,OAAiB,CAAC;QACnC,CAAC;aAAM,IAAI,IAAA,sBAAU,EAAC,OAAO,CAAC,IAAI,IAAA,2BAAe,EAAC,OAAO,CAAC,EAAE,CAAC;YAC3D,YAAY,GAAG,MAAO,OAA8E,CAClG,OAAO,EACP,aAAa,CACd,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,WAAW,CAAC,YAAY,CAAC,CAAC;IACtC,CAAC;AACH,CAAC;AAED,OAAO,CAAC,cAAc,GAAG,UAAU,IAAiB;IAClD,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACxC,OAAO,cAAc,CAAC,GAAG,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;AACtC,CAAC,CAAC"}

package/licence

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Potapov Dmytro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "sat-wait",
+  "version": "0.0.1",
+  "description": "Universal waiting library",
+  "scripts": {
+    "test": "mocha ./specs/**/*.spec.ts --require ts-node/register --timeout 30000",
+    "lint": "eslint --ext .ts ./",
+    "tsc": "rm -rf ./built && tsc"
+  },
+  "main": "./built/index.js",
+  "exports": {
+    ".": {
+      "require": "./built/index.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Simple-Automation-Testing/sat-wait.git"
+  },
+  "keywords": [
+    "waiting",
+    "wait for"
+  ],
+  "author": "Potapov Dmitriy",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Simple-Automation-Testing/sat-wait/issues"
+  },
+  "homepage": "https://github.com/Simple-Automation-Testing/sat-wait#readme",
+  "devDependencies": {
+    "@types/mocha": "^10.0.8",
+    "@types/node": "^22.5.5",
+    "@typescript-eslint/eslint-plugin": "^8.6.0",
+    "@typescript-eslint/parser": "^8.6.0",
+    "assertior": "^0.0.28",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jsdoc": "^50.2.4",
+    "eslint-plugin-no-only-tests": "^3.3.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-promise": "^7.1.0",
+    "eslint-plugin-sonarjs": "^2.0.2",
+    "eslint-plugin-unicorn": "^55.0.0",
+    "mocha": "^10.7.3",
+    "ts-node": "^10.9.2",
+    "tslint": "^6.1.3",
+    "typescript": "^5.6.2"
+  },
+  "dependencies": {
+    "sat-utils": "^3.0.0"
+  }
+}

package/readme.md

@@ -0,0 +1,41 @@
+# SAT WAITING LIBRARY
+
+![npm downloads](https://img.shields.io/npm/dm/sat-wait.svg?style=flat-square)
+
+## Content
+
+- [waitForCondition](#waitforcondition)
+
+## waitForCondition
+
+```js
+	const {waitForCondition} = require('sat-utils')
+
+	waitForCondition.setDefaultOpts({
+  	timeout: 2500, // default waiting time is 2500 ms
+  	interval: 250,	// default re-check condition interval time is 250 ms
+  	message: 'Failed',	// default error message is "Failed"
+  	waiterError: TypeError,	// default error is TypeError
+	});
+
+	test()
+	async function test() {
+  	await waitForCondition(async () => {
+  		const result = await someAsyncLogic()
+  		return result;
+  	})
+	}
+
+	test1()
+	async function test1() {
+  await waitForCondition(async () => {
+  	const result = await someAsyncLogic()
+  	return result;
+  }, {
+  	analyseResult: (result) => result.status === 200;
+  	timeout: 25000,
+  	interval: 250,
+  	message: (time) => throw new Error(`My custom error throw function with time ${time}`)
+  })
+	}
+```

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es2020",
+    "sourceMap": true,
+    "outDir": "built",
+    "declaration": true,
+    "allowJs": true
+  },
+  "exclude": [
+    "node_modules",
+    "built",
+    "specs",
+    "example",
+    "playground.*"
+  ]
+}