@frelseren/promise-task-maps 0.1.0

package/README.md

@@ -0,0 +1,150 @@
+# Promise Task Maps
+
+Promise-based task mapping operators inspired by RxJS: `switchMap`, `concatMap`, `mergeMap`, and `exhaustMap`.
+
+This package is framework-agnostic and works in browser environments, including LWC.
+
+## Why this library
+
+RxJS operators are excellent for stream pipelines, but many codebases only need Promise-based task control:
+
+- `switchMap`: keep only the latest task result
+- `concatMap`: queue and execute tasks one-by-one
+- `mergeMap`: run tasks concurrently with an optional limit
+- `exhaustMap`: ignore new tasks while one is in progress
+
+## Install
+
+```bash
+npm install @nv/promise-task-maps
+```
+
+## API
+
+```ts
+type PromiseTask<I, O> = (input: I, context: { signal: AbortSignal; callId: number }) => Promise<O> | O;
+
+type TaskRunner<I, O> = {
+  execute(input: I): Promise<O | undefined>;
+  cancel(reason?: string): void;
+};
+```
+
+## Usage
+
+```ts
+import { createSwitchMap } from "@nv/promise-task-maps";
+
+const searchUsers = createSwitchMap(async (query: string, { signal }) => {
+  const response = await fetch(`/api/users?q=${encodeURIComponent(query)}`, { signal });
+  return response.json();
+});
+
+// Typing fast in a search box calls execute repeatedly.
+// Older in-flight calls are canceled/ignored; only the latest resolves with data.
+const result = await searchUsers.execute("nic");
+```
+
+### concatMap example
+
+```ts
+import { createConcatMap } from "@nv/promise-task-maps";
+
+const saveDraft = createConcatMap(async (payload: { id: string; body: string }, { signal }) => {
+  const response = await fetch(`/api/drafts/${payload.id}`, {
+    method: "PUT",
+    headers: { "Content-Type": "application/json" },
+    body: JSON.stringify({ body: payload.body }),
+    signal
+  });
+  return response.ok;
+});
+
+// Calls are queued and executed in order to avoid race conditions.
+await Promise.all([
+  saveDraft.execute({ id: "a1", body: "v1" }),
+  saveDraft.execute({ id: "a1", body: "v2" }),
+  saveDraft.execute({ id: "a1", body: "v3" })
+]);
+```
+
+### mergeMap example
+
+```ts
+import { createMergeMap } from "@nv/promise-task-maps";
+
+const fetchProfile = createMergeMap(
+  async (userId: string, { signal }) => {
+    const response = await fetch(`/api/users/${userId}`, { signal });
+    return response.json();
+  },
+  { concurrency: 3 }
+);
+
+// Up to 3 requests run in parallel; remaining calls wait in queue.
+const profiles = await Promise.all([
+  fetchProfile.execute("u1"),
+  fetchProfile.execute("u2"),
+  fetchProfile.execute("u3"),
+  fetchProfile.execute("u4")
+]);
+```
+
+### exhaustMap example
+
+```ts
+import { createExhaustMap } from "@nv/promise-task-maps";
+
+const submitOrder = createExhaustMap(async (order: { items: string[] }, { signal }) => {
+  const response = await fetch("/api/orders", {
+    method: "POST",
+    headers: { "Content-Type": "application/json" },
+    body: JSON.stringify(order),
+    signal
+  });
+  return response.json();
+});
+
+// Double-click protection: second call returns undefined while first is in flight.
+const firstAttempt = submitOrder.execute({ items: ["sku-1"] });
+const secondAttempt = submitOrder.execute({ items: ["sku-1"] });
+
+await firstAttempt;  // order accepted
+await secondAttempt; // undefined
+```
+
+## LWC example
+
+```ts
+import { LightningElement } from "lwc";
+import { createSwitchMap } from "@nv/promise-task-maps";
+
+export default class UserLookup extends LightningElement {
+  users = [];
+
+  lookup = createSwitchMap(async (query: string, { signal }) => {
+    const res = await fetch(`/services/apexrest/users?q=${encodeURIComponent(query)}`, { signal });
+    return res.json();
+  });
+
+  async handleInput(event: Event) {
+    const target = event.target as HTMLInputElement;
+    const data = await this.lookup.execute(target.value);
+    if (data) {
+      this.users = data;
+    }
+  }
+
+  disconnectedCallback() {
+    this.lookup.cancel("component disconnected");
+  }
+}
+```
+
+## Development
+
+```bash
+npm install
+npm test
+npm run build
+```

package/dist/index.cjs

@@ -0,0 +1,223 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  createConcatMap: () => createConcatMap,
+  createExhaustMap: () => createExhaustMap,
+  createMergeMap: () => createMergeMap,
+  createSwitchMap: () => createSwitchMap
+});
+module.exports = __toCommonJS(index_exports);
+var isAbortError = (error) => {
+  return typeof error === "object" && error !== null && "name" in error && error.name === "AbortError";
+};
+var createController = () => new AbortController();
+function createSwitchMap(task) {
+  let latestCallId = 0;
+  let latestController = createController();
+  return {
+    async execute(input) {
+      latestCallId += 1;
+      const callId = latestCallId;
+      latestController.abort();
+      latestController = createController();
+      try {
+        const result = await task(input, { signal: latestController.signal, callId });
+        return callId === latestCallId ? result : void 0;
+      } catch (error) {
+        if (callId !== latestCallId || isAbortError(error)) {
+          return void 0;
+        }
+        throw error;
+      }
+    },
+    cancel(reason) {
+      latestCallId += 1;
+      latestController.abort(reason);
+      latestController = createController();
+    }
+  };
+}
+function createConcatMap(task) {
+  let active = false;
+  let currentCallId = 0;
+  let currentController = createController();
+  const queue = [];
+  const processQueue = async () => {
+    if (active) {
+      return;
+    }
+    const next = queue.shift();
+    if (!next) {
+      return;
+    }
+    active = true;
+    currentCallId = next.callId;
+    currentController = createController();
+    try {
+      const result = await task(next.input, {
+        signal: currentController.signal,
+        callId: next.callId
+      });
+      next.resolve(result);
+    } catch (error) {
+      if (isAbortError(error)) {
+        next.resolve(void 0);
+      } else {
+        next.reject(error);
+      }
+    } finally {
+      active = false;
+      void processQueue();
+    }
+  };
+  return {
+    execute(input) {
+      const callId = currentCallId + queue.length + 1;
+      return new Promise((resolve, reject) => {
+        queue.push({ input, resolve, reject, callId });
+        void processQueue();
+      });
+    },
+    cancel(reason) {
+      currentController.abort(reason);
+      while (queue.length > 0) {
+        const queued = queue.shift();
+        queued?.resolve(void 0);
+      }
+    }
+  };
+}
+function createMergeMap(task, options = {}) {
+  const concurrency = options.concurrency ?? Number.POSITIVE_INFINITY;
+  if (!Number.isFinite(concurrency) && concurrency !== Number.POSITIVE_INFINITY) {
+    throw new Error("mergeMap concurrency must be a finite positive number or Infinity");
+  }
+  if (concurrency <= 0) {
+    throw new Error("mergeMap concurrency must be greater than 0");
+  }
+  let callId = 0;
+  let activeCount = 0;
+  let generation = 0;
+  const queue = [];
+  const activeControllers = /* @__PURE__ */ new Map();
+  const pumpQueue = () => {
+    while (activeCount < concurrency && queue.length > 0) {
+      const next = queue.shift();
+      if (!next) {
+        break;
+      }
+      if (next.generation !== generation) {
+        next.resolve(void 0);
+        continue;
+      }
+      activeCount += 1;
+      const controller = createController();
+      activeControllers.set(next.callId, controller);
+      void (async () => {
+        try {
+          const result = await task(next.input, {
+            signal: controller.signal,
+            callId: next.callId
+          });
+          next.resolve(result);
+        } catch (error) {
+          if (isAbortError(error) || next.generation !== generation) {
+            next.resolve(void 0);
+          } else {
+            next.reject(error);
+          }
+        } finally {
+          activeCount -= 1;
+          activeControllers.delete(next.callId);
+          pumpQueue();
+        }
+      })();
+    }
+  };
+  return {
+    execute(input) {
+      callId += 1;
+      const thisCallId = callId;
+      const thisGeneration = generation;
+      return new Promise((resolve, reject) => {
+        queue.push({
+          input,
+          resolve,
+          reject,
+          callId: thisCallId,
+          generation: thisGeneration
+        });
+        pumpQueue();
+      });
+    },
+    cancel(reason) {
+      generation += 1;
+      for (const controller of activeControllers.values()) {
+        controller.abort(reason);
+      }
+      while (queue.length > 0) {
+        const queued = queue.shift();
+        queued?.resolve(void 0);
+      }
+    }
+  };
+}
+function createExhaustMap(task) {
+  let active = false;
+  let callId = 0;
+  let generation = 0;
+  let controller = createController();
+  return {
+    async execute(input) {
+      if (active) {
+        return void 0;
+      }
+      callId += 1;
+      const thisCallId = callId;
+      const thisGeneration = generation;
+      active = true;
+      controller = createController();
+      try {
+        const result = await task(input, { signal: controller.signal, callId: thisCallId });
+        return thisGeneration === generation ? result : void 0;
+      } catch (error) {
+        if (isAbortError(error) || thisGeneration !== generation) {
+          return void 0;
+        }
+        throw error;
+      } finally {
+        active = false;
+      }
+    },
+    cancel(reason) {
+      generation += 1;
+      controller.abort(reason);
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createConcatMap,
+  createExhaustMap,
+  createMergeMap,
+  createSwitchMap
+});

package/dist/index.d.cts

@@ -0,0 +1,18 @@
+interface TaskContext {
+    signal: AbortSignal;
+    callId: number;
+}
+type PromiseTask<I, O> = (input: I, context: TaskContext) => Promise<O> | O;
+interface TaskRunner<I, O> {
+    execute(input: I): Promise<O | undefined>;
+    cancel(reason?: string): void;
+}
+interface MergeMapOptions {
+    concurrency?: number;
+}
+declare function createSwitchMap<I, O>(task: PromiseTask<I, O>): TaskRunner<I, O>;
+declare function createConcatMap<I, O>(task: PromiseTask<I, O>): TaskRunner<I, O>;
+declare function createMergeMap<I, O>(task: PromiseTask<I, O>, options?: MergeMapOptions): TaskRunner<I, O>;
+declare function createExhaustMap<I, O>(task: PromiseTask<I, O>): TaskRunner<I, O>;
+
+export { type MergeMapOptions, type PromiseTask, type TaskContext, type TaskRunner, createConcatMap, createExhaustMap, createMergeMap, createSwitchMap };

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+interface TaskContext {
+    signal: AbortSignal;
+    callId: number;
+}
+type PromiseTask<I, O> = (input: I, context: TaskContext) => Promise<O> | O;
+interface TaskRunner<I, O> {
+    execute(input: I): Promise<O | undefined>;
+    cancel(reason?: string): void;
+}
+interface MergeMapOptions {
+    concurrency?: number;
+}
+declare function createSwitchMap<I, O>(task: PromiseTask<I, O>): TaskRunner<I, O>;
+declare function createConcatMap<I, O>(task: PromiseTask<I, O>): TaskRunner<I, O>;
+declare function createMergeMap<I, O>(task: PromiseTask<I, O>, options?: MergeMapOptions): TaskRunner<I, O>;
+declare function createExhaustMap<I, O>(task: PromiseTask<I, O>): TaskRunner<I, O>;
+
+export { type MergeMapOptions, type PromiseTask, type TaskContext, type TaskRunner, createConcatMap, createExhaustMap, createMergeMap, createSwitchMap };

package/dist/index.js

@@ -0,0 +1,195 @@
+// src/index.ts
+var isAbortError = (error) => {
+  return typeof error === "object" && error !== null && "name" in error && error.name === "AbortError";
+};
+var createController = () => new AbortController();
+function createSwitchMap(task) {
+  let latestCallId = 0;
+  let latestController = createController();
+  return {
+    async execute(input) {
+      latestCallId += 1;
+      const callId = latestCallId;
+      latestController.abort();
+      latestController = createController();
+      try {
+        const result = await task(input, { signal: latestController.signal, callId });
+        return callId === latestCallId ? result : void 0;
+      } catch (error) {
+        if (callId !== latestCallId || isAbortError(error)) {
+          return void 0;
+        }
+        throw error;
+      }
+    },
+    cancel(reason) {
+      latestCallId += 1;
+      latestController.abort(reason);
+      latestController = createController();
+    }
+  };
+}
+function createConcatMap(task) {
+  let active = false;
+  let currentCallId = 0;
+  let currentController = createController();
+  const queue = [];
+  const processQueue = async () => {
+    if (active) {
+      return;
+    }
+    const next = queue.shift();
+    if (!next) {
+      return;
+    }
+    active = true;
+    currentCallId = next.callId;
+    currentController = createController();
+    try {
+      const result = await task(next.input, {
+        signal: currentController.signal,
+        callId: next.callId
+      });
+      next.resolve(result);
+    } catch (error) {
+      if (isAbortError(error)) {
+        next.resolve(void 0);
+      } else {
+        next.reject(error);
+      }
+    } finally {
+      active = false;
+      void processQueue();
+    }
+  };
+  return {
+    execute(input) {
+      const callId = currentCallId + queue.length + 1;
+      return new Promise((resolve, reject) => {
+        queue.push({ input, resolve, reject, callId });
+        void processQueue();
+      });
+    },
+    cancel(reason) {
+      currentController.abort(reason);
+      while (queue.length > 0) {
+        const queued = queue.shift();
+        queued?.resolve(void 0);
+      }
+    }
+  };
+}
+function createMergeMap(task, options = {}) {
+  const concurrency = options.concurrency ?? Number.POSITIVE_INFINITY;
+  if (!Number.isFinite(concurrency) && concurrency !== Number.POSITIVE_INFINITY) {
+    throw new Error("mergeMap concurrency must be a finite positive number or Infinity");
+  }
+  if (concurrency <= 0) {
+    throw new Error("mergeMap concurrency must be greater than 0");
+  }
+  let callId = 0;
+  let activeCount = 0;
+  let generation = 0;
+  const queue = [];
+  const activeControllers = /* @__PURE__ */ new Map();
+  const pumpQueue = () => {
+    while (activeCount < concurrency && queue.length > 0) {
+      const next = queue.shift();
+      if (!next) {
+        break;
+      }
+      if (next.generation !== generation) {
+        next.resolve(void 0);
+        continue;
+      }
+      activeCount += 1;
+      const controller = createController();
+      activeControllers.set(next.callId, controller);
+      void (async () => {
+        try {
+          const result = await task(next.input, {
+            signal: controller.signal,
+            callId: next.callId
+          });
+          next.resolve(result);
+        } catch (error) {
+          if (isAbortError(error) || next.generation !== generation) {
+            next.resolve(void 0);
+          } else {
+            next.reject(error);
+          }
+        } finally {
+          activeCount -= 1;
+          activeControllers.delete(next.callId);
+          pumpQueue();
+        }
+      })();
+    }
+  };
+  return {
+    execute(input) {
+      callId += 1;
+      const thisCallId = callId;
+      const thisGeneration = generation;
+      return new Promise((resolve, reject) => {
+        queue.push({
+          input,
+          resolve,
+          reject,
+          callId: thisCallId,
+          generation: thisGeneration
+        });
+        pumpQueue();
+      });
+    },
+    cancel(reason) {
+      generation += 1;
+      for (const controller of activeControllers.values()) {
+        controller.abort(reason);
+      }
+      while (queue.length > 0) {
+        const queued = queue.shift();
+        queued?.resolve(void 0);
+      }
+    }
+  };
+}
+function createExhaustMap(task) {
+  let active = false;
+  let callId = 0;
+  let generation = 0;
+  let controller = createController();
+  return {
+    async execute(input) {
+      if (active) {
+        return void 0;
+      }
+      callId += 1;
+      const thisCallId = callId;
+      const thisGeneration = generation;
+      active = true;
+      controller = createController();
+      try {
+        const result = await task(input, { signal: controller.signal, callId: thisCallId });
+        return thisGeneration === generation ? result : void 0;
+      } catch (error) {
+        if (isAbortError(error) || thisGeneration !== generation) {
+          return void 0;
+        }
+        throw error;
+      } finally {
+        active = false;
+      }
+    },
+    cancel(reason) {
+      generation += 1;
+      controller.abort(reason);
+    }
+  };
+}
+export {
+  createConcatMap,
+  createExhaustMap,
+  createMergeMap,
+  createSwitchMap
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@frelseren/promise-task-maps",
+  "version": "0.1.0",
+  "description": "RxJS-like mapping operators for Promise-based task management",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "author": {
+    "name": "Nikita Verkhoshintcev",
+    "email": "nikita@digitalflask.com",
+    "url": "https://digitalflask.com"
+  },
+  "homepage": "https://digitalflask.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Frelseren/promise-task-maps.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Frelseren/promise-task-maps/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --dts --format esm,cjs --clean",
+    "prepublishOnly": "npm test && npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "keywords": [
+    "promise",
+    "task",
+    "switchMap",
+    "concatMap",
+    "mergeMap",
+    "exhaustMap",
+    "lwc"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "tsup": "^8.3.0",
+    "typescript": "^5.7.0",
+    "vitest": "^2.1.8"
+  }
+}