@pallasoft/ps-core-components 2.21.0 → 2.22.0

package/dist/esm/hooks/use-ps-change-queue.js

@@ -0,0 +1,31 @@
+import { useCallback, useEffect, useRef } from 'react';
+export const usePsChangeQueue = ({ onDrained, onFailed, send, }) => {
+    const pending = useRef([]);
+    const isRunning = useRef(false);
+    const latest = useRef({ onDrained, onFailed, send });
+    useEffect(() => {
+        latest.current = { onDrained, onFailed, send };
+    }, [onDrained, onFailed, send]);
+    const run = useCallback(async () => {
+        if (isRunning.current)
+            return;
+        isRunning.current = true;
+        await Promise.resolve();
+        while (pending.current.length > 0) {
+            const batch = pending.current;
+            pending.current = [];
+            await latest.current.send(batch).catch(() => {
+                const dropped = pending.current;
+                pending.current = [];
+                latest.current.onFailed(batch, dropped);
+            });
+        }
+        isRunning.current = false;
+        latest.current.onDrained();
+    }, []);
+    const enqueue = useCallback((change) => {
+        pending.current = [...pending.current, change];
+        void run();
+    }, [run]);
+    return { enqueue };
+};

package/dist/esm/index.js

@@ -56,6 +56,9 @@ export * from './models/ps-element-size';
 export * from './models/ps-voice-orb';
 export * from './models/ps-navigation-progress';
 export * from './hooks/use-ps-debounced-value';
+export * from './hooks/use-ps-change-queue';
+export * from './interfaces/ps-change-queue-input';
+export * from './interfaces/ps-change-queue-result';
 export * from './hooks/use-ps-optimistic-rows';
 export * from './interfaces/ps-optimistic-rows-input';
 export * from './interfaces/ps-optimistic-rows-result';

package/dist/esm/interfaces/ps-change-queue-input.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/interfaces/ps-change-queue-result.js

@@ -0,0 +1 @@
+export {};

package/dist/hooks/use-ps-change-queue.d.ts

@@ -0,0 +1,3 @@
+import type { PsChangeQueueInput } from '../interfaces/ps-change-queue-input';
+import type { PsChangeQueueResult } from '../interfaces/ps-change-queue-result';
+export declare const usePsChangeQueue: <Change>({ onDrained, onFailed, send, }: PsChangeQueueInput<Change>) => PsChangeQueueResult<Change>;

package/dist/hooks/use-ps-change-queue.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePsChangeQueue = void 0;
+const react_1 = require("react");
+const usePsChangeQueue = ({ onDrained, onFailed, send, }) => {
+    const pending = (0, react_1.useRef)([]);
+    const isRunning = (0, react_1.useRef)(false);
+    const latest = (0, react_1.useRef)({ onDrained, onFailed, send });
+    (0, react_1.useEffect)(() => {
+        latest.current = { onDrained, onFailed, send };
+    }, [onDrained, onFailed, send]);
+    const run = (0, react_1.useCallback)(async () => {
+        if (isRunning.current)
+            return;
+        isRunning.current = true;
+        await Promise.resolve();
+        while (pending.current.length > 0) {
+            const batch = pending.current;
+            pending.current = [];
+            await latest.current.send(batch).catch(() => {
+                const dropped = pending.current;
+                pending.current = [];
+                latest.current.onFailed(batch, dropped);
+            });
+        }
+        isRunning.current = false;
+        latest.current.onDrained();
+    }, []);
+    const enqueue = (0, react_1.useCallback)((change) => {
+        pending.current = [...pending.current, change];
+        void run();
+    }, [run]);
+    return { enqueue };
+};
+exports.usePsChangeQueue = usePsChangeQueue;

package/dist/index.d.ts

@@ -56,6 +56,9 @@ export * from './models/ps-element-size';
 export * from './models/ps-voice-orb';
 export * from './models/ps-navigation-progress';
 export * from './hooks/use-ps-debounced-value';
+export * from './hooks/use-ps-change-queue';
+export * from './interfaces/ps-change-queue-input';
+export * from './interfaces/ps-change-queue-result';
 export * from './hooks/use-ps-optimistic-rows';
 export * from './interfaces/ps-optimistic-rows-input';
 export * from './interfaces/ps-optimistic-rows-result';

package/dist/index.js

@@ -72,6 +72,9 @@ __exportStar(require("./models/ps-element-size"), exports);
 __exportStar(require("./models/ps-voice-orb"), exports);
 __exportStar(require("./models/ps-navigation-progress"), exports);
 __exportStar(require("./hooks/use-ps-debounced-value"), exports);
+__exportStar(require("./hooks/use-ps-change-queue"), exports);
+__exportStar(require("./interfaces/ps-change-queue-input"), exports);
+__exportStar(require("./interfaces/ps-change-queue-result"), exports);
 __exportStar(require("./hooks/use-ps-optimistic-rows"), exports);
 __exportStar(require("./interfaces/ps-optimistic-rows-input"), exports);
 __exportStar(require("./interfaces/ps-optimistic-rows-result"), exports);

package/dist/interfaces/ps-change-queue-input.d.ts

@@ -0,0 +1,5 @@
+export interface PsChangeQueueInput<Change> {
+    onDrained: () => void;
+    onFailed: (failed: Change[], dropped: Change[]) => void;
+    send: (changes: Change[]) => Promise<unknown>;
+}

package/dist/interfaces/ps-change-queue-input.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/ps-change-queue-result.d.ts

@@ -0,0 +1,3 @@
+export interface PsChangeQueueResult<Change> {
+    enqueue: (change: Change) => void;
+}

package/dist/interfaces/ps-change-queue-result.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pallasoft/ps-core-components",
-	"version": "2.21.0",
+	"version": "2.22.0",
 	"private": false,
 	"main": "./dist/index.js",
 	"module": "./dist/esm/index.js",