@robert.tools/testing 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robert Willemelis
+
+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

@@ -0,0 +1,45 @@
+# @robert.tools/testing
+
+A set of helper for testing
+
+## Installation
+
+```bash
+npm install @robert.tools/testing
+```
+
+## 📜 Usage
+
+### 🟢 Installation
+
+```bash
+npm install @robert.tools/testing
+```
+
+### 📝 Sample usage
+
+```typescript
+import { spyOnCommand } from '@robert.tools/testing';
+
+const spy = spyOnCommand('hello');
+command('curl someurl') // 'result: hello'
+```
+
+## 🗃️ commands
+
+After an npm install with `npm i` the following commands are available:
+
+* spy on command and return result: `spyOnCommand(result)`
+* spy on URLs and return result: `spyOnURLs(results)`
+
+## ⚖️ Notes
+
+This software is hand-crafted, test-driven and assisted by AI tools. I know each
+line of my code. ✌️
+
+| Tool | Comment |
+| --- | --- |
+| ![assisted by Jest](https://img.shields.io/badge/Jest-TDD-008800?logo=jest) | Test-driven development with Jest |
+| ![assisted by robert.tools](https://img.shields.io/badge/robert.tools-ecosystem-008800) | Part of the robert.tools ecosystem |
+| ![assisted by GitHub Copilot](https://img.shields.io/badge/GitHub_Copilot-assisted-8A2BE2?logo=githubcopilot) | Code completion |
+| ![assisted by OpenAI](https://img.shields.io/badge/OpenAI-assisted-8A2BE2?logo=openai) | chatGPT research |

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import type { URL_ITEMS } from './index.d';
+/**
+ * 🎯 Creates a spy on the `cmd.command` function and mocks its implementation to return the specified result.
+ * @param result ➡️ The mock value to return. (optional)
+ * @returns {jest.SpyInstance} 📤 The spy instance.
+ */
+export declare const spyOnCommand: (result?: string) => jest.SpyInstance<string, [command: string, doLog?: boolean | undefined, showError?: boolean | undefined], any>;
+/**
+ * 🎯 Creates a spy to mock the `cmd.command` function for specific URL requests.
+ * @param {URL_ITEMS} results ➡️ The URL items to mock.
+ * @returns {jest.SpyInstance} 📤 The spy instance.
+ */
+export declare const spyOnURLs: (results: URL_ITEMS) => jest.SpyInstance<string, [command: string, doLog?: boolean | undefined, showError?: boolean | undefined], any>;

package/dist/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.spyOnURLs = exports.spyOnCommand = void 0;
+// 📦 external dependencies
+const cmd = require("@robert.tools/cmd");
+// 📦 internal dependencies
+const utils_1 = require("./utils/utils");
+/**
+ * 🎯 Creates a spy on the `cmd.command` function and mocks its implementation to return the specified result.
+ * @param result ➡️ The mock value to return. (optional)
+ * @returns {jest.SpyInstance} 📤 The spy instance.
+ */
+const spyOnCommand = (result = '') => {
+    return jest.spyOn(cmd, 'command').mockImplementation(() => {
+        return result;
+    });
+};
+exports.spyOnCommand = spyOnCommand;
+/**
+ * 🎯 Creates a spy to mock the `cmd.command` function for specific URL requests.
+ * @param {URL_ITEMS} results ➡️ The URL items to mock.
+ * @returns {jest.SpyInstance} 📤 The spy instance.
+ */
+const spyOnURLs = (results) => {
+    return jest
+        .spyOn(cmd, 'command')
+        .mockImplementation((request) => {
+        return (0, utils_1.mockRequest)(request, results);
+    });
+};
+exports.spyOnURLs = spyOnURLs;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,2BAA2B;AAC3B,yCAAyC;AAEzC,2BAA2B;AAC3B,yCAA4C;AAK5C;;;;GAIG;AACI,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAE,EAAE,EAAE;IAChD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,kBAAkB,CAAC,GAAW,EAAE;QAC9D,OAAO,MAAM,CAAC;IAClB,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAJW,QAAA,YAAY,gBAIvB;AAEF;;;;GAIG;AACI,MAAM,SAAS,GAAG,CAAC,OAAkB,EAAE,EAAE;IAC5C,OAAO,IAAI;SACN,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC;SACrB,kBAAkB,CAAC,CAAC,OAAe,EAAU,EAAE;QAC5C,OAAO,IAAA,mBAAW,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACX,CAAC,CAAC;AANW,QAAA,SAAS,aAMpB"}

package/dist/utils/utils.d.ts

@@ -0,0 +1,8 @@
+import type { RAW, URL_ITEMS } from '../index.d';
+/**
+ * 🎯 Mocks a request based on the provided mocked results.
+ * @param {string} request ➡️ The request string, typically a curl command.
+ * @param {URL_ITEMS} results ➡️ object containing mocked results.
+ * @returns {RAW} 📤 mocked result for the given request.
+ */
+export declare const mockRequest: (request: string, results: URL_ITEMS) => RAW;

package/dist/utils/utils.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mockRequest = void 0;
+// 📦 external dependencies
+const uri_1 = require("@robert.tools/uri");
+const curl_1 = require("@robert.tools/curl");
+const log_1 = require("@robert.tools/log");
+const utils_1 = require("@robert.tools/utils");
+/**
+ * 🎯 Mocks a request based on the provided mocked results.
+ * @param {string} request ➡️ The request string, typically a curl command.
+ * @param {URL_ITEMS} results ➡️ object containing mocked results.
+ * @returns {RAW} 📤 mocked result for the given request.
+ */
+const mockRequest = (request, results) => {
+    const forwards = results?.forwards || {};
+    const urlID = (0, uri_1.getUrlID)(request);
+    const domainID = (0, uri_1.getHostname)(urlID);
+    const orders = results?.orders || {};
+    const order = orders?.[domainID] || [];
+    const data = (0, curl_1.getCurlData)(request);
+    let ID = urlID;
+    if (data.data?.forwarding) {
+        const lastOrder = order[order.length - 1];
+        if (lastOrder && forwards[lastOrder]) {
+            ID = lastOrder;
+        }
+    }
+    const result = forwards?.[ID];
+    if (!result) {
+        log_1.LOG.FAIL(`No mock result for URL ID: ${ID}`);
+        return forwards?.['fallback'] || '<invalid>';
+    }
+    return (0, utils_1.toType)(result);
+};
+exports.mockRequest = mockRequest;
+//# sourceMappingURL=utils.js.map

package/dist/utils/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils/utils.ts"],"names":[],"mappings":";;;AAAA,2BAA2B;AAC3B,2CAA0D;AAC1D,6CAAiD;AACjD,2CAAwC;AACxC,+CAA6C;AAK7C;;;;;GAKG;AACI,MAAM,WAAW,GAAG,CAAC,OAAe,EAAE,OAAkB,EAAO,EAAE;IACpE,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,EAAE,CAAC;IACzC,MAAM,KAAK,GAAG,IAAA,cAAQ,EAAC,OAAO,CAAC,CAAC;IAChC,MAAM,QAAQ,GAAG,IAAA,iBAAW,EAAC,KAAK,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,IAAI,EAAE,CAAC;IACrC,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACvC,MAAM,IAAI,GAAG,IAAA,kBAAW,EAAC,OAAO,CAAC,CAAC;IAClC,IAAI,EAAE,GAAG,KAAK,CAAC;IACf,IAAI,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC1C,IAAI,SAAS,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACnC,EAAE,GAAG,SAAS,CAAC;QACnB,CAAC;IACL,CAAC;IACD,MAAM,MAAM,GAAQ,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC;IACnC,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,SAAG,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;QAC7C,OAAO,QAAQ,EAAE,CAAC,UAAU,CAAC,IAAI,WAAW,CAAC;IACjD,CAAC;IACD,OAAY,IAAA,cAAM,EAAC,MAAM,CAAC,CAAC;AAC/B,CAAC,CAAC;AApBW,QAAA,WAAW,eAoBtB"}

package/package.json

@@ -0,0 +1,70 @@
+{
+    "name": "@robert.tools/testing",
+    "version": "1.0.0",
+    "description": "A set of helper for testing",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": "./dist/index.js"
+    },
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "init": "robi init",
+        "release": "robi release",
+        "status": "robi status",
+        "version": "robi version",
+        "verbose": "robi verbose",
+        "pub": "npm whoami && npm publish --access public",
+        "build": "rm -rf dist && tsc -p tsconfig.build.json",
+        "test": "jest --coverage --runInBand --verbose",
+        "lint": "eslint .",
+        "check": "npm run lint && npm test && npm run build",
+        "prepublishOnly": "npm run check"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/robert-tools/testing.git"
+    },
+    "bugs": {
+        "url": "https://github.com/robert-tools/testing/issues"
+    },
+    "homepage": "https://github.com/robert-tools/testing#readme",
+    "keywords": [
+        "typescript",
+        "node",
+        "testing",
+        "robert.tools"
+    ],
+    "author": "Robert Willemelis",
+    "license": "MIT",
+    "engines": {
+        "node": ">=22"
+    },
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "devDependencies": {
+        "@robert.tools/setup": "^1.2.0",
+        "@types/jest": "^29.5.14",
+        "@types/node": "^24.0.0",
+        "@typescript-eslint/eslint-plugin": "^8.0.0",
+        "@typescript-eslint/parser": "^8.0.0",
+        "eslint": "^9.0.0",
+        "eslint-config-prettier": "^10.1.8",
+        "eslint-plugin-prettier": "^5.5.6",
+        "jest": "^29.7.0",
+        "jest-environment-jsdom": "^29.6.2",
+        "ts-jest": "^29.4.0",
+        "typescript": "^5.9.0"
+    },
+    "dependencies": {
+        "@robert.tools/cmd": "^1.0.0",
+        "@robert.tools/curl": "^1.0.1",
+        "@robert.tools/log": "^1.0.0",
+        "@robert.tools/uri": "^1.0.0",
+        "@robert.tools/utils": "^1.2.0"
+    }
+}