@augment-vir/common 31.32.3 → 31.33.1

package/dist/augments/promise/promise-queue.d.ts

@@ -11,6 +11,7 @@ import { ListenTarget } from 'typed-event-target';
 export type PromiseQueueItem<T = void> = {
     /** The original queue item that was added. */
     original: () => MaybePromise<T>;
+    id: undefined | PropertyKey;
     /**
      * A {@link DeferredPromise} instance with a promise that is resolved once this queue item has
      * met its turn and has finished executing.
@@ -63,14 +64,23 @@ export declare class PromiseQueueUpdateEvent extends PromiseQueueUpdateEvent_bas
 export declare class PromiseQueue extends ListenTarget<PromiseQueueUpdateEvent> {
     protected queue: PromiseQueueItem<any>[];
     protected currentlyAwaiting: undefined | PromiseQueueItem<any>;
+    protected queueItemIds: Set<PropertyKey>;
     /** The current size of the queue. */
     get size(): number;
     /**
-     * Add an item to the queue.
+     * Add an item to the queue. Only await this if you want to wait for the promise to be added
+     * _and_ resolved (or rejected).
      *
      * @returns A promise that resolves at the same time as the added item.
      */
-    add<T = void>(item: PromiseQueueItem<T>['original']): Promise<T>;
+    add<T = void>(item: PromiseQueueItem<T>['original'], id?: PropertyKey): Promise<T>;
+    /**
+     * Checks if the given id is currently in the queue.
+     *
+     * @returns `true` if the item is in the queue and has not been resolved or rejected. `false` if
+     *   the item has never been in the queue or has been resolved / rejected from the queue.
+     */
+    hasItemById(id: PropertyKey): boolean;
     /** Handles a queue item finishing, whether it be a rejection or a resolution. */
     protected handleItemSettle({ rejection, resolution, }: RequireExactlyOne<{
         rejection: unknown;

package/dist/augments/promise/promise-queue.js

@@ -21,21 +21,27 @@ export class PromiseQueueUpdateEvent extends defineTypedCustomEvent()('promise-q
 export class PromiseQueue extends ListenTarget {
     queue = [];
     currentlyAwaiting = undefined;
+    queueItemIds = new Set();
     /** The current size of the queue. */
     get size() {
         return this.queue.length;
     }
     /**
-     * Add an item to the queue.
+     * Add an item to the queue. Only await this if you want to wait for the promise to be added
+     * _and_ resolved (or rejected).
      *
      * @returns A promise that resolves at the same time as the added item.
      */
-    add(item) {
+    add(item, id) {
         const newItem = {
             original: item,
+            id,
             wrapper: new DeferredPromise(),
         };
         this.queue.push(newItem);
+        if (id != undefined) {
+            this.queueItemIds.add(id);
+        }
         this.dispatch(new PromiseQueueUpdateEvent({
             detail: {
                 queueSize: this.size,
@@ -45,6 +51,15 @@ export class PromiseQueue extends ListenTarget {
         this.triggerNextQueueItem();
         return newItem.wrapper.promise;
     }
+    /**
+     * Checks if the given id is currently in the queue.
+     *
+     * @returns `true` if the item is in the queue and has not been resolved or rejected. `false` if
+     *   the item has never been in the queue or has been resolved / rejected from the queue.
+     */
+    hasItemById(id) {
+        return this.queueItemIds.has(id);
+    }
     /** Handles a queue item finishing, whether it be a rejection or a resolution. */
     handleItemSettle({ rejection, resolution, }) {
         const item = this.currentlyAwaiting;
@@ -64,6 +79,9 @@ export class PromiseQueue extends ListenTarget {
         else {
             item.wrapper.resolve(resolution);
         }
+        if (item.id != undefined) {
+            this.queueItemIds.delete(item.id);
+        }
         this.currentlyAwaiting = undefined;
         this.triggerNextQueueItem();
         return item;

package/dist/augments/string/casing/capitalization.js

@@ -6,7 +6,7 @@
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export function maybeCapitalize(input, casingOptions) {
-    // eslint-disable-next-line sonarjs/deprecation, @typescript-eslint/no-deprecated
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     return casingOptions.capitalizeFirstLetter ? capitalizeFirstLetter(input) : input;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.32.3",
+    "version": "31.33.1",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -33,16 +33,16 @@
     "types": "dist/index.d.ts",
     "scripts": {
         "compile": "virmator compile",
-        "test": "concurrently --colors --kill-others-on-fail -c red,blue --names node,web \"npm run test:node\" \"npm run test:web\"",
+        "test": "runstorm --names node,web \"npm run test:node\" \"npm run test:web\"",
         "test:coverage": "virmator --no-deps test web coverage",
         "test:node": "virmator --no-deps test node",
         "test:update": "npm test",
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.32.3",
-        "@augment-vir/core": "^31.32.3",
-        "@date-vir/duration": "^7.4.0",
+        "@augment-vir/assert": "^31.33.1",
+        "@augment-vir/core": "^31.33.1",
+        "@date-vir/duration": "^7.4.2",
         "ansi-styles": "^6.2.1",
         "deepcopy-esm": "^2.1.1",
         "json5": "^2.2.3",
@@ -55,9 +55,9 @@
         "@web/test-runner-commands": "^0.9.0",
         "@web/test-runner-playwright": "^0.11.1",
         "@web/test-runner-visual-regression": "^0.10.0",
-        "concurrently": "^9.2.0",
-        "execute-in-browser": "^1.0.8",
+        "execute-in-browser": "^1.0.9",
         "istanbul-smart-text-reporter": "^1.1.5",
+        "runstorm": "^0.6.2",
         "typescript": "^5.9.2"
     },
     "engines": {