qansigliere-api-utils 0.0.0-stage → 2026.11.1

package/.prettierignore

@@ -0,0 +1,2 @@
+package.json
+.gitlab-ci.yml

package/.prettierrc

@@ -0,0 +1,12 @@
+{
+    "singleQuote": true,
+    "arrowParens": "avoid",
+    "proseWrap": "always",
+    "tabWidth": 4,
+    "useTabs": false,
+    "trailingComma": "all",
+    "bracketSpacing": true,
+    "semi": true,
+    "printWidth": 120,
+    "jsxSingleQuote": true
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 QANSIGLIERE
+
+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/README.md

@@ -1,3 +1,2 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# QANSIGLIERE-API-UTILS
+later

package/TODO

@@ -0,0 +1,11 @@
+Добавить поддержку .TS
+Добавить механизм RETRY и кол-во попыток
+Добавить в package.json нормальное описание
+Добавить в package.json keyworks
+Добавить в package.json homepage = website
+Добавить в package.json FEEDBACK
+Добавить README
+Добавить тесты
+Добавить Warnings если запросы превысил > 1 sec timeout
+Показывать Execution time
+Добавить описание каждой функции 

package/eslint.config.mjs

@@ -0,0 +1,9 @@
+import js from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([
+  { files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: globals.browser } },
+  tseslint.configs.recommended,
+]);

package/index.js

@@ -0,0 +1 @@
+export { getAPI, postAPI, patchAPI, putAPI, deleteAPI } from './library/library';

package/library/library.js

@@ -0,0 +1,148 @@
+import axios from 'axios';
+import { sleep } from '../utils/utils';
+import { Logger } from '../logger/logger';
+
+// eslint-disable-next-line no-undef
+const TIMEOUT = process.env.TIMEOUT ?? 180000;
+// eslint-disable-next-line no-undef
+const DELAY = process.env.DELAY ?? 1000;
+// eslint-disable-next-line no-undef
+const LOG_LEVEL = process.env.LOG_LEVEL ?? 0; // 0 - OFF, 1 - ALL LOGS, 2 - URLS ONLY, 3 - RESPONSE BODY ONLY
+
+export async function getAPI(
+    url,
+    headers,
+    { delay = DELAY, timeout = TIMEOUT, track = '', logLevel = LOG_LEVEL } = {},
+) {
+    await sleep(delay);
+
+    const logger = new Logger(track, logLevel);
+
+    logger.logRequest('GET', url, '', headers);
+
+    const request = await axios({
+        validateStatus: function (status) {
+            return status <= 502; // Resolve only if the status code is equal or less than 502
+        },
+        method: 'get',
+        url,
+        headers,
+        timeout,
+    });
+
+    logger.logResponse(request);
+
+    return request;
+}
+
+export async function postAPI(
+    url,
+    headers,
+    requestBody,
+    { delay = DELAY, timeout = TIMEOUT, track = '', logLevel = LOG_LEVEL } = {},
+) {
+    await sleep(delay);
+
+    const logger = new Logger(track, logLevel);
+
+    logger.logRequest('POST', url, requestBody, headers);
+
+    const request = await axios({
+        validateStatus: function (status) {
+            return status <= 502; // Resolve only if the status code is equal or less than 502
+        },
+        method: 'post',
+        url,
+        headers,
+        data: requestBody,
+        timeout,
+    });
+
+    logger.logResponse(request);
+
+    return request;
+}
+
+export async function patchAPI(
+    url,
+    headers,
+    requestBody,
+    { delay = DELAY, timeout = TIMEOUT, track = '', logLevel = LOG_LEVEL } = {},
+) {
+    await sleep(delay);
+
+    const logger = new Logger(track, logLevel);
+
+    logger.logRequest('PATCH', url, requestBody, headers);
+
+    const request = await axios({
+        validateStatus: function (status) {
+            return status <= 502; // Resolve only if the status code is equal or less than 502
+        },
+        method: 'patch',
+        url,
+        headers,
+        data: requestBody,
+        timeout,
+    });
+
+    logger.logResponse(request);
+
+    return request;
+}
+
+export async function putAPI(
+    url,
+    headers,
+    requestBody,
+    { delay = DELAY, timeout = TIMEOUT, track = '', logLevel = LOG_LEVEL } = {},
+) {
+    await sleep(delay);
+
+    const logger = new Logger(track, logLevel);
+
+    logger.logRequest('PUT', url, requestBody, headers);
+
+    const request = await axios({
+        validateStatus: function (status) {
+            return status <= 502; // Resolve only if the status code is equal or less than 502
+        },
+        method: 'put',
+        url,
+        headers,
+        data: requestBody,
+        timeout,
+    });
+
+    logger.logResponse(request);
+
+    return request;
+}
+
+export async function deleteAPI(
+    url,
+    headers,
+    requestBody,
+    { delay = DELAY, timeout = TIMEOUT, track = '', logLevel = LOG_LEVEL } = {},
+) {
+    await sleep(delay);
+
+    const logger = new Logger(track, logLevel);
+
+    logger.logRequest('DELETE', url, requestBody, headers);
+
+    const request = await axios({
+        validateStatus: function (status) {
+            return status <= 502; // Resolve only if the status code is equal or less than 502
+        },
+        method: 'delete',
+        url,
+        headers,
+        data: requestBody,
+        timeout,
+    });
+
+    logger.logResponse(request);
+
+    return request;
+}

package/logger/logger.js

@@ -0,0 +1,79 @@
+import { v4 as uuidv4 } from 'uuid';
+
+function isObject(data) {
+    return typeof data === 'object';
+}
+
+function printObject(data) {
+    return isObject(data) ? JSON.stringify(data) : data;
+}
+
+export class Logger {
+    constructor(track, logLevel) {
+        this.track = track ?? uuidv4();
+        this.logLevel = logLevel ?? '0'; // 0 - OFF, 1 - ALL LOGS, 2 - URLS ONLY, 3 - RESPONSE BODY ONLY
+    }
+
+    logRequest(apiMethod, url, requestBody, headers) {
+        const event = {
+            timestamp: new Date().toISOString(),
+            apiMethod,
+            url,
+            requestBody,
+            headers,
+            track: this.track,
+        };
+
+        this.displayLog(event);
+    }
+
+    logResponse(response) {
+        const event = {
+            timestamp: new Date().toISOString(),
+            responseStatus: response.status,
+            response: response.data,
+            responseHeaders: response.headers,
+            track: this.track,
+        };
+
+        this.displayLog(event);
+    }
+
+    displayLog(event) {
+        if (this.logLevel === 2) {
+            delete event.timestamp;
+            delete event.apiMethod;
+            delete event.responseStatus;
+            delete event.requestBody;
+            delete event.response;
+            delete event.responseHeaders;
+            delete event.track;
+        }
+
+        if (this.logLevel === 3) {
+            delete event.timestamp;
+            delete event.apiMethod;
+            delete event.responseStatus;
+            delete event.url;
+            delete event.response;
+            delete event.responseHeaders;
+            delete event.track;
+        }
+
+        let log = '';
+        if (event.timestamp) log += `========================${event.timestamp}========================\n`;
+        if (event.apiMethod) log += `METHOD: ${event.apiMethod}\n`;
+        if (event.url) log += `URL: ${event.url}\n`;
+        if (event.responseStatus) log += `STATUS: ${event.responseStatus}\n`;
+
+        if (event.requestBody) log += `BODY: \n${printObject(event.requestBody)}\n`;
+        if (event.response) log += `RESPONSE: \n${printObject(event.response)}\n`;
+
+        if (event.headers) log += `REQUEST HEADERS: ${printObject(event.headers)}\n`;
+        if (event.responseHeaders) log += `RESPONSE HEADERS: ${printObject(event.responseHeaders)}\n`;
+
+        if (event.track) log += `TRACK: ${event.track}\n`;
+
+        if (this.logLevel) console.log(log);
+    }
+}

package/package.json

@@ -1,6 +1,38 @@
 {
   "name": "qansigliere-api-utils",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "2026.11.01",
+  "description": "later",
+  "keywords": [
+    "qansigliere",
+    "npm",
+    "npmjs",
+    "api",
+    "rest api",
+    "api automation"
+  ],
+  "homepage": "https://github.com/QANSIGLIERE/QANSIGLIERE-API-UTILS#readme",
+  "bugs": {
+    "url": "https://github.com/QANSIGLIERE/QANSIGLIERE-API-UTILS/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/QANSIGLIERE/QANSIGLIERE-API-UTILS.git"
+  },
+  "license": "MIT",
+  "author": "QANSIGLIERE.COM",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "axios": "^1.21.0",
+    "uuid": "^14.0.3"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.13.0",
+    "globals": "^17.13.0",
+    "typescript-eslint": "^8.72.1"
+  }
+}

package/utils/utils.js

@@ -0,0 +1,3 @@
+export async function sleep(milliseconds) {
+    return new Promise(resolve => setTimeout(resolve, milliseconds));
+}