@api-client/core 0.3.0

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@api-client/core",
+  "description": "The ARC core client library. Works in NodeJS and in a ES enabled browser.",
+  "version": "0.3.0",
+  "license": "Apache-2.0",
+  "main": "build/index.js",
+  "module": "build/index.js",
+  "types": "build/index.d.ts",
+  "type": "module",
+  "author": {
+    "name": "Pawel Uchida-Psztyc",
+    "email": "pawel.psztyc@gmail.com"
+  },
+  "contributors": [
+    "Your name can be here!"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/api-client/core.git"
+  },
+  "bugs": {
+    "url": "https://github.com/api-client/core/issues",
+    "email": "arc@mulesoft.com"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^16.2.1",
+    "@commitlint/config-conventional": "^16.2.1",
+    "@esm-bundle/chai": "^4.3.4-fix.0",
+    "@pawel-up/data-mock": "^0.1.7",
+    "@types/chai": "^4.2.22",
+    "@types/chai-as-promised": "^7.1.5",
+    "@types/cors": "^2.8.12",
+    "@types/express-ntlm": "^2.3.3",
+    "@types/fs-extra": "^9.0.13",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^17.0.18",
+    "@types/sinon": "^10.0.11",
+    "@typescript-eslint/eslint-plugin": "^5.12.0",
+    "@typescript-eslint/parser": "^5.12.0",
+    "@web/dev-server-esbuild": "^0.2.16",
+    "@web/test-runner": "^0.13.21",
+    "@web/test-runner-playwright": "^0.8.8",
+    "chai": "^4.3.4",
+    "chai-as-promised": "^7.1.1",
+    "cors": "^2.8.5",
+    "eslint": "^8.9.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-no-only-tests": "^2.6.0",
+    "eslint-plugin-unused-imports": "^2.0.0",
+    "express": "^4.17.1",
+    "express-ntlm": "^2.6.1",
+    "husky": "^7.0.4",
+    "lint-staged": "^12.3.4",
+    "mocha": "^9.1.3",
+    "shrink-ray-current": "^4.1.3",
+    "sinon": "^13.0.1",
+    "ssl-root-cas": "^1.3.1",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.4.4"
+  },
+  "scripts": {
+    "build-ts": "tsc",
+    "build": "npm run build-ts && npm run lint",
+    "lint": "tsc --noEmit && eslint \"**/*.{js,ts}\" --quiet --fix",
+    "prepare": "husky install && npm run build-ts",
+    "tsc:watch": "tsc --watch",
+    "test:browser": "wtr --playwright --browsers chromium firefox webkit --coverage",
+    "test:browser:watch": "wtr --watch --playwright --browsers chromium",
+    "test:mocha": "mocha --require test/http-server-fixture.js",
+    "test:mocha:watch": "mocha --watch --require test/http-server-fixture.js",
+    "test:mocha:watch2": "node scripts/test-node-watch.js",
+    "test:mocha:watch3": "mocha --watch --recursive --parallel --require test/http-server-fixture.js",
+    "test": "npm run test:mocha && npm run test:browser"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.js": [
+      "eslint --fix"
+    ]
+  },
+  "dependencies": {
+    "@metrichor/jmespath": "^0.3.1",
+    "@pawel-up/jexl": "^3.0.0",
+    "@xmldom/xmldom": "^0.8.1",
+    "form-data": "^4.0.0",
+    "xpath": "^0.0.32"
+  },
+  "engines": {
+    "node": ">=15"
+  }
+}

package/readme.md

@@ -0,0 +1,51 @@
+# API Client Core Library
+
+The core library of the API Client application. This build on top of the experience of Advanced REST Client.
+
+Contains the core models, events, and logic related to ARC. This replaces the `events`, `lib`, and parts of `base` libraries.
+
+## Purpose
+
+The core library provides the libraries that ARC and related projects are re-using under the hood.
+
+The library is structured as follows:
+
+- models - the data model libraries providing the data schema definition for ARC and related projects and the common logic to manipulate the data
+- runtime - the executable part of the library; contains classes that executes an HTTP request, runs a series of requests defined in a project, etc
+- utilities - helper libraries that can be shared across the ARC ecosystem
+
+## What it isn't
+
+This library provides no user flows and any kind of UI. This is a core library to be used to build those.
+
+## Runtime
+
+These libraries can be run in a web browser, NodeJS, or both. By default this library exports the NodeJS interfaces. These are using native NodeJS APIs so they won't work in a web browser.
+Libraries exported in the `browser.js` file are save to execute in a plain web environment.
+
+Note that when using platforms like Electron you can use both when NodeJS APIs are exposed to the renderer process.
+
+## Use cases
+
+These libraries can be used, among others, to:
+
+- create a very basic, developer oriented, API definition (not a specification)
+- create lists of HTTP requests to be executed in an API tests
+- create lists of HTTP requests to be executed in an API monitoring
+- to share semi-ready documentation for an API (when API specification does not exist, otherwise you would use API Console by MuleSoft :)
+
+## Community driven
+
+The entire ARC project is community driven. We build tools for API developers to make them successful without investing into very expensive enterprise solutions. We are happy to hear from you. If your ideas can benefit the community we will implement them. That's on us. But you are welcome to clone the project, build your idea, and send us a PR. We will accept it if it won't influence the stability of the project and it's safe to marge with the main branch.
+
+## Documentation
+
+Please, see the `docs` folder for the use documentation.
+
+## TODO
+
+Tasks planned for the future releases.
+
+- [ ] Add support for AMF parser to parse HTTP project data
+- [ ] Add client certificate class logic
+- [ ] Add HTTP project mocking class