polarity-integration-utils 0.1.0 → 0.1.4

package/README.md

@@ -6,4 +6,28 @@ This library is intended for use in development of Polarity Integrations.
 
 ## Contribution Instructions
 
-> NOTE: Don't forget to add your implementations to the `./test/index.test.js` to ensure your implementation is accessible from the main index.js
+> NOTE: Don't forget to add your implementations to the `./test/index.test.js` to ensure your implementation is accessible from the main index.js
+
+### Continuous Integration
+
+All pull requests run the **build → lint → test** pipeline via GitHub Actions. Ensure local runs are green before opening a PR.
+
+#### PR Checks
+
+Pull requests targeting `develop`, `main`, or any `support/*` branch trigger the shared build workflow which runs linting, tests with coverage, and uploads results to Codecov.
+
+#### Release (main branch)
+
+Pushes to `main` trigger the full release workflow:
+
+1. **Build & test** — runs the shared build pipeline.
+2. **Release** — creates a GitHub Release tagged with the package version (e.g., `v3.1.6`), marks it as the latest release, and publishes to npm under the `latest` dist-tag.
+3. **Deploy docs** — after a successful release, builds TypeDoc documentation and deploys to GitHub Pages.
+
+#### Release (support branches)
+
+Pushes to `support/*` branches (e.g., `support/1.0`, `support/2.0`) trigger the same release workflow with the following differences:
+
+- **Docs are not deployed** — only `main` publishes documentation to GitHub Pages.
+- **GitHub Release is not marked as latest** — the release is still created with the full version tag (e.g., `v2.0.9`) but will not appear as the "Latest" release in the GitHub UI.
+- **npm publish uses a version-specific dist-tag** — instead of `latest`, support branches publish under `v{major}-latest` (e.g., `v2-latest`, `v1-latest`). This ensures `npm install polarity-integration-utils` continues to resolve to the current major version while older versions remain installable via their dist-tag (e.g., `npm install polarity-integration-utils@v2-latest`).

package/dist/es/helpers/async/parallelLimit.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const parallelLimit = (tasksQueue, simultaneousTaskRunningLimit, returnErrors = false) => __awaiter(void 0, void 0, void 0, function* () {
+const parallelLimit = (tasksQueue_1, simultaneousTaskRunningLimit_1, ...args_1) => __awaiter(void 0, [tasksQueue_1, simultaneousTaskRunningLimit_1, ...args_1], void 0, function* (tasksQueue, simultaneousTaskRunningLimit, returnErrors = false) {
     const results = [];
     const runTasks = (tasksIterator) => __awaiter(void 0, void 0, void 0, function* () {
         for (const [index, task] of tasksIterator) {

package/dist/es/helpers/time/sleep.js

@@ -9,5 +9,5 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const sleep = (ms = 2000) => __awaiter(void 0, void 0, void 0, function* () { return new Promise((r) => setTimeout(r, ms)); });
+const sleep = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (ms = 2000) { return new Promise((r) => setTimeout(r, ms)); });
 exports.default = sleep;

package/dist/es/requests/createRequestWithDefaults.js

@@ -25,8 +25,8 @@ function _setupLimiter(options) {
     limiter = new bottleneck_1.default({
         maxConcurrent: options.maxConcurrentRequests
             ? Number.parseInt(options.maxConcurrentRequests, 10)
-            : 10,
-        highWater: 50,
+            : 10, // no more than 5 lookups can be running at single time
+        highWater: 50, // no more than 50 lookups can be queued up
         strategy: bottleneck_1.default.strategy.OVERFLOW,
         minTime: options.minimumMillisecondsRequestWillTake
             ? Number.parseInt(options.minimumMillisecondsRequestWillTake, 10)

package/dist/es/requests/createRequestsInParallel.js

@@ -25,7 +25,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fp_1 = require("lodash/fp");
 const helpers_1 = __importDefault(require("../helpers"));
-const createRequestsInParallel = (requestWithDefaults) => (allRequestsOptions, responseGetPath = 'body', possibleSimultaneousRequests = 10, returnErrors = false) => __awaiter(void 0, void 0, void 0, function* () {
+const createRequestsInParallel = (requestWithDefaults) => (allRequestsOptions_1, ...args_1) => __awaiter(void 0, [allRequestsOptions_1, ...args_1], void 0, function* (allRequestsOptions, responseGetPath = 'body', possibleSimultaneousRequests = 10, returnErrors = false) {
     const unexecutedRequestFunctions = (0, fp_1.map)((_a) => {
         var { entity } = _a, requestOptions = __rest(_a, ["entity"]);
         return () => __awaiter(void 0, void 0, void 0, function* () {

package/dist/lib/helpers/async/parallelLimit.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const parallelLimit = (tasksQueue, simultaneousTaskRunningLimit, returnErrors = false) => __awaiter(void 0, void 0, void 0, function* () {
+const parallelLimit = (tasksQueue_1, simultaneousTaskRunningLimit_1, ...args_1) => __awaiter(void 0, [tasksQueue_1, simultaneousTaskRunningLimit_1, ...args_1], void 0, function* (tasksQueue, simultaneousTaskRunningLimit, returnErrors = false) {
     const results = [];
     const runTasks = (tasksIterator) => __awaiter(void 0, void 0, void 0, function* () {
         for (const [index, task] of tasksIterator) {

package/dist/lib/helpers/time/sleep.js

@@ -9,5 +9,5 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const sleep = (ms = 2000) => __awaiter(void 0, void 0, void 0, function* () { return new Promise((r) => setTimeout(r, ms)); });
+const sleep = (...args_1) => __awaiter(void 0, [...args_1], void 0, function* (ms = 2000) { return new Promise((r) => setTimeout(r, ms)); });
 exports.default = sleep;

package/dist/lib/requests/createRequestWithDefaults.js

@@ -25,8 +25,8 @@ function _setupLimiter(options) {
     limiter = new bottleneck_1.default({
         maxConcurrent: options.maxConcurrentRequests
             ? Number.parseInt(options.maxConcurrentRequests, 10)
-            : 10,
-        highWater: 50,
+            : 10, // no more than 5 lookups can be running at single time
+        highWater: 50, // no more than 50 lookups can be queued up
         strategy: bottleneck_1.default.strategy.OVERFLOW,
         minTime: options.minimumMillisecondsRequestWillTake
             ? Number.parseInt(options.minimumMillisecondsRequestWillTake, 10)

package/dist/lib/requests/createRequestsInParallel.js

@@ -25,7 +25,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const fp_1 = require("lodash/fp");
 const helpers_1 = __importDefault(require("../helpers"));
-const createRequestsInParallel = (requestWithDefaults) => (allRequestsOptions, responseGetPath = 'body', possibleSimultaneousRequests = 10, returnErrors = false) => __awaiter(void 0, void 0, void 0, function* () {
+const createRequestsInParallel = (requestWithDefaults) => (allRequestsOptions_1, ...args_1) => __awaiter(void 0, [allRequestsOptions_1, ...args_1], void 0, function* (allRequestsOptions, responseGetPath = 'body', possibleSimultaneousRequests = 10, returnErrors = false) {
     const unexecutedRequestFunctions = (0, fp_1.map)((_a) => {
         var { entity } = _a, requestOptions = __rest(_a, ["entity"]);
         return () => __awaiter(void 0, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "polarity-integration-utils",
-  "version": "0.1.0",
+  "version": "0.1.4",
   "description": "A utility library for building Polarity Integrations",
   "files": [
     "dist"
@@ -15,18 +15,18 @@
     "build:lib": "tsc -p tsconfig.build.json --outDir dist/lib",
     "build": "npm run clean && npm run build:lib && npm run build:es",
     "prepublishOnly": "npm run ci && npm run build",
-    "fullPublish": "npm run prepublishOnly && npm publish"
+    "fullPublish": "npm install && npm run prepublishOnly && npm publish"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/polarity-integration-utils/polarity-integration-utils.git"
+    "url": "git+https://github.com/polarityio/polarity-integration-utils.git"
   },
   "author": "Polarity IO <support@polarity.io>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/polarity-integration-utils/polarity-integration-utils/issues"
+    "url": "https://github.com/polarityio/polarity-integration-utils/issues"
   },
-  "homepage": "https://github.com/polarity-integration-utils/polarity-integration-utils#readme",
+  "homepage": "https://github.com/polarityio/polarity-integration-utils#readme",
   "devDependencies": {
     "@types/jest": "^24.0.14",
     "nock": "^13.3.1",
@@ -35,8 +35,8 @@
   },
   "dependencies": {
     "bottleneck": "^2.19.5",
-    "lodash": "^4.17.21",
-    "postman-request": "^2.88.1-postman.32"
+    "lodash": "^4.18.1",
+    "postman-request": "^2.88.1-postman.48"
   },
   "sideEffects": false
 }