xflight 2.0.0 → 3.0.0

package/LICENSE

@@ -1,11 +1,201 @@
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
- http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Joel Chen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -18,6 +18,10 @@
 npm install xflight
 ```
 
+## Requirements
+
+This package requires **Node.js >= 22.12**.
+
 ## Usage
 
 ```js

package/dist/index.d.ts

@@ -0,0 +1,140 @@
+/** Timestamp in milliseconds since epoch */
+export type Timestamp = number;
+/** Factory function that creates a promise */
+export type PromiseFactory<T> = () => Promise<T>;
+/** Internal record for tracking an inflight operation */
+export interface InflightItem<T> {
+    /** When the operation started */
+    readonly start: Timestamp;
+    /** Last check time for elapsed time tracking */
+    lastXTime: Timestamp;
+    /** The tracked promise */
+    readonly value: Promise<T>;
+}
+/**
+ * Inflight manages deduplication of asynchronous operations by key.
+ * It ensures only one promise per key is active at a time, returning the same promise for concurrent requests.
+ * Useful for avoiding duplicate network or resource-intensive calls.
+ *
+ * @template T The type of the resolved value of the managed promises.
+ *
+ * @example
+ * ```ts
+ * const inflight = new Inflight<Response>();
+ *
+ * // Multiple concurrent calls with same key return the same promise
+ * const [a, b] = await Promise.all([
+ *   inflight.promise("user:123", () => fetch("/api/user/123")),
+ *   inflight.promise("user:123", () => fetch("/api/user/123")),
+ * ]);
+ * // Only one fetch was made, a === b
+ * ```
+ */
+export declare class Inflight<T = unknown> {
+    /** Map of inflight items by key */
+    private readonly _inflights;
+    /** The Promise implementation used by this instance */
+    readonly Promise: PromiseConstructor;
+    /**
+     * Create a new Inflight instance.
+     *
+     * Uses native Promise by default. Pass a custom Promise implementation if needed:
+     *
+     * ```ts
+     * import Bluebird from "bluebird";
+     * const inflight = new Inflight(Bluebird);
+     * ```
+     *
+     * @param PromiseImpl - Optional custom Promise implementation to use.
+     */
+    constructor(PromiseImpl?: PromiseConstructor);
+    /**
+     * Get or create a promise for a given key.
+     * If a promise for the key is already inflight, returns it.
+     * Otherwise, calls the provided factory to create a new promise, tracks it, and returns it.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @param factory - Function that returns a promise.
+     * @returns The inflight promise for the key.
+     */
+    promise(key: string, factory: PromiseFactory<T>): Promise<T>;
+    /**
+     * Manually add an inflight item for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @param value - The promise to track.
+     * @param now - Optional timestamp for when the operation started (defaults to now).
+     * @returns The promise that was added.
+     * @throws If key already exists.
+     */
+    add(key: string, value: Promise<T>, now?: Timestamp): Promise<T>;
+    /**
+     * Get the inflight promise for a key, if any.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @returns The inflight promise for the key, or undefined if none exists.
+     */
+    get(key: string): Promise<T> | undefined;
+    /**
+     * Remove the inflight item for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @throws If key does not exist.
+     */
+    remove(key: string): void;
+    /**
+     * Whether there are no inflight items.
+     */
+    get isEmpty(): boolean;
+    /**
+     * The number of inflight items.
+     */
+    get count(): number;
+    /**
+     * Get the start time (ms since epoch) for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @returns The start time, or undefined if not found.
+     */
+    getStartTime(key: string): Timestamp | undefined;
+    /**
+     * Get the elapsed time (ms) since the start for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @param now - Optional current timestamp (defaults to Date.now()).
+     * @returns The elapsed time in ms, or -1 if not found.
+     */
+    time(key: string, now?: Timestamp): number;
+    /**
+     * Alias for {@link time}.
+     */
+    elapseTime(key: string, now?: Timestamp): number;
+    /**
+     * Get the last check time (ms since epoch) for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @returns The last check time, or undefined if not found.
+     */
+    getCheckTime(key: string): Timestamp | undefined;
+    /**
+     * Get the elapsed time (ms) since the last check for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @param now - Optional current timestamp (defaults to Date.now()).
+     * @returns The elapsed time in ms, or -1 if not found.
+     */
+    lastCheckTime(key: string, now?: Timestamp): number;
+    /**
+     * Alias for {@link lastCheckTime}.
+     */
+    elapseCheckTime(key: string, now?: Timestamp): number;
+    /**
+     * Reset the last check time for a key, or for all inflight items if no key is provided.
+     *
+     * @param key - Optional unique identifier. If omitted, resets all.
+     * @param now - Optional timestamp to set as the new last check time (defaults to Date.now()).
+     * @returns This instance for chaining.
+     */
+    resetCheckTime(key?: string, now?: Timestamp): this;
+}
+export default Inflight;

package/dist/index.js

@@ -0,0 +1,195 @@
+/** Simple assert that works in browser and Node.js */
+function assert(condition, message) {
+    if (!condition)
+        throw new Error(message);
+}
+/**
+ * Inflight manages deduplication of asynchronous operations by key.
+ * It ensures only one promise per key is active at a time, returning the same promise for concurrent requests.
+ * Useful for avoiding duplicate network or resource-intensive calls.
+ *
+ * @template T The type of the resolved value of the managed promises.
+ *
+ * @example
+ * ```ts
+ * const inflight = new Inflight<Response>();
+ *
+ * // Multiple concurrent calls with same key return the same promise
+ * const [a, b] = await Promise.all([
+ *   inflight.promise("user:123", () => fetch("/api/user/123")),
+ *   inflight.promise("user:123", () => fetch("/api/user/123")),
+ * ]);
+ * // Only one fetch was made, a === b
+ * ```
+ */
+export class Inflight {
+    /** Map of inflight items by key */
+    _inflights = new Map();
+    /** The Promise implementation used by this instance */
+    Promise;
+    /**
+     * Create a new Inflight instance.
+     *
+     * Uses native Promise by default. Pass a custom Promise implementation if needed:
+     *
+     * ```ts
+     * import Bluebird from "bluebird";
+     * const inflight = new Inflight(Bluebird);
+     * ```
+     *
+     * @param PromiseImpl - Optional custom Promise implementation to use.
+     */
+    constructor(PromiseImpl) {
+        this.Promise = PromiseImpl ?? globalThis.Promise;
+    }
+    /**
+     * Get or create a promise for a given key.
+     * If a promise for the key is already inflight, returns it.
+     * Otherwise, calls the provided factory to create a new promise, tracks it, and returns it.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @param factory - Function that returns a promise.
+     * @returns The inflight promise for the key.
+     */
+    promise(key, factory) {
+        const existing = this._inflights.get(key);
+        if (existing) {
+            return existing.value;
+        }
+        // Safe cleanup - don't throw if already removed manually
+        const cleanup = () => {
+            this._inflights.delete(key);
+        };
+        try {
+            const p = factory();
+            assert(p && typeof p.then === "function", `xflight: promiseFactory for key ${key} didn't return a promise`);
+            this.add(key, p).then(cleanup, cleanup);
+            return p;
+        }
+        catch (err) {
+            return this.Promise.reject(err);
+        }
+    }
+    /**
+     * Manually add an inflight item for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @param value - The promise to track.
+     * @param now - Optional timestamp for when the operation started (defaults to now).
+     * @returns The promise that was added.
+     * @throws If key already exists.
+     */
+    add(key, value, now) {
+        assert(!this._inflights.has(key), `xflight: item ${key} already exist`);
+        const timestamp = now ?? Date.now();
+        this._inflights.set(key, { start: timestamp, lastXTime: timestamp, value });
+        return value;
+    }
+    /**
+     * Get the inflight promise for a key, if any.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @returns The inflight promise for the key, or undefined if none exists.
+     */
+    get(key) {
+        return this._inflights.get(key)?.value;
+    }
+    /**
+     * Remove the inflight item for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @throws If key does not exist.
+     */
+    remove(key) {
+        assert(this._inflights.has(key), `xflight: removing non-existing item ${key}`);
+        this._inflights.delete(key);
+    }
+    /**
+     * Whether there are no inflight items.
+     */
+    get isEmpty() {
+        return this._inflights.size === 0;
+    }
+    /**
+     * The number of inflight items.
+     */
+    get count() {
+        return this._inflights.size;
+    }
+    /**
+     * Get the start time (ms since epoch) for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @returns The start time, or undefined if not found.
+     */
+    getStartTime(key) {
+        return this._inflights.get(key)?.start;
+    }
+    /**
+     * Get the elapsed time (ms) since the start for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @param now - Optional current timestamp (defaults to Date.now()).
+     * @returns The elapsed time in ms, or -1 if not found.
+     */
+    time(key, now) {
+        const item = this._inflights.get(key);
+        return item ? (now ?? Date.now()) - item.start : -1;
+    }
+    /**
+     * Alias for {@link time}.
+     */
+    elapseTime(key, now) {
+        return this.time(key, now);
+    }
+    /**
+     * Get the last check time (ms since epoch) for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @returns The last check time, or undefined if not found.
+     */
+    getCheckTime(key) {
+        return this._inflights.get(key)?.lastXTime;
+    }
+    /**
+     * Get the elapsed time (ms) since the last check for a key.
+     *
+     * @param key - Unique identifier for the inflight operation.
+     * @param now - Optional current timestamp (defaults to Date.now()).
+     * @returns The elapsed time in ms, or -1 if not found.
+     */
+    lastCheckTime(key, now) {
+        const item = this._inflights.get(key);
+        return item ? (now ?? Date.now()) - item.lastXTime : -1;
+    }
+    /**
+     * Alias for {@link lastCheckTime}.
+     */
+    elapseCheckTime(key, now) {
+        return this.lastCheckTime(key, now);
+    }
+    /**
+     * Reset the last check time for a key, or for all inflight items if no key is provided.
+     *
+     * @param key - Optional unique identifier. If omitted, resets all.
+     * @param now - Optional timestamp to set as the new last check time (defaults to Date.now()).
+     * @returns This instance for chaining.
+     */
+    resetCheckTime(key, now) {
+        const timestamp = now ?? Date.now();
+        if (key) {
+            const item = this._inflights.get(key);
+            if (item) {
+                item.lastXTime = timestamp;
+            }
+        }
+        else {
+            for (const item of this._inflights.values()) {
+                item.lastXTime = timestamp;
+            }
+        }
+        return this;
+    }
+}
+// Default export for backwards compatibility
+export default Inflight;

package/package.json

@@ -1,26 +1,40 @@
 {
   "name": "xflight",
-  "version": "2.0.0",
+  "version": "3.0.0",
   "description": "Handle inflight promise to avoid async duplication",
+  "engines": {
+    "node": ">=22.12.0"
+  },
   "type": "module",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.js",
   "exports": {
     ".": {
-      "import": "./dist-esm/esm/index.js",
-      "require": "./dist-cjs/cjs/index.cjs"
-    }
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
   },
   "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.json",
     "test": "vitest run",
+    "ci:check": "tsc --noEmit -p tsconfig.json && npm test",
     "test:ui": "vitest --ui",
     "coverage": "vitest run --coverage",
-    "build": "rm -rf dist-* && tsc --build tsconfig.esm.json && tsc --build tsconfig.cjs.json && ts2mjs --cjs --remove-source --skip-ts dist-cjs"
+    "prepublishOnly": "xrun build",
+    "postpack": "publish-util-postpack"
+  },
+  "homepage": "https://github.com/jchip/fynjs/tree/main/packages/xflight",
+  "bugs": {
+    "url": "https://github.com/jchip/fynjs/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jchip/xflight.git"
+    "url": "https://github.com/jchip/fynjs.git",
+    "directory": "packages/xflight"
   },
   "files": [
-    "lib"
+    "dist"
   ],
   "keywords": [
     "inflight",
@@ -28,37 +42,5 @@
   ],
   "author": "Joel Chen",
   "license": "Apache-2.0",
-  "devDependencies": {
-    "@types/node": "^22.15.29",
-    "@vitest/coverage-v8": "^3.2.0",
-    "@xarc/run": "^1.1.2",
-    "tsx": "^4.19.4",
-    "typescript": "^5.8.3",
-    "vitest": "^3.2.0",
-    "ts2mjs": "github:jchip/ts2mjs#main"
-  },
-  "dependencies": {
-    "optional-require": "^2.0.1"
-  },
-  "nyc": {
-    "all": true,
-    "reporter": [
-      "lcov",
-      "text",
-      "text-summary"
-    ],
-    "exclude": [
-      "coverage",
-      "*clap.js",
-      "gulpfile.js",
-      "dist",
-      "test"
-    ],
-    "check-coverage": true,
-    "statements": 100,
-    "branches": 100,
-    "functions": 100,
-    "lines": 100,
-    "cache": true
-  }
+  "sideEffects": false
 }