@pallasoft/ps-core-components 2.32.0 → 2.33.0

package/dist/esm/hooks/use-ps-debounced-revalidate.js

@@ -0,0 +1,23 @@
+import { useCallback, useEffect, useRef } from 'react';
+export const usePsDebouncedRevalidate = (revalidator, delayMilliseconds) => {
+    const latest = useRef(revalidator);
+    const timer = useRef(null);
+    latest.current = revalidator;
+    const fire = useCallback(() => {
+        timer.current = null;
+        if (latest.current.state !== 'idle') {
+            timer.current = setTimeout(fire, delayMilliseconds);
+            return;
+        }
+        void latest.current.revalidate();
+    }, [delayMilliseconds]);
+    useEffect(() => () => {
+        if (timer.current !== null)
+            clearTimeout(timer.current);
+    }, []);
+    return useCallback(() => {
+        if (timer.current !== null)
+            clearTimeout(timer.current);
+        timer.current = setTimeout(fire, delayMilliseconds);
+    }, [delayMilliseconds, fire]);
+};

package/dist/esm/hooks/use-ps-live.js

@@ -0,0 +1,34 @@
+import { useEffect, useRef } from 'react';
+export const usePsLive = (input) => {
+    const latest = useRef(input);
+    const { enabled, open, path } = input;
+    const eventKey = input.events.join(',');
+    latest.current = input;
+    useEffect(() => {
+        if (!enabled)
+            return;
+        let isActive = true;
+        let close = null;
+        void open({
+            events: latest.current.events,
+            fetchToken: () => latest.current.fetchToken(),
+            onEvent: (name, payload) => latest.current.onEvent(name, payload),
+            onResume: () => {
+                const { onResume } = latest.current;
+                if (onResume !== undefined)
+                    onResume();
+            },
+            path,
+        }).then((handle) => {
+            if (isActive)
+                close = () => handle.close();
+            else
+                handle.close();
+        });
+        return () => {
+            isActive = false;
+            if (close !== null)
+                close();
+        };
+    }, [enabled, eventKey, open, path]);
+};

package/dist/esm/index.js

@@ -76,6 +76,8 @@ 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-live';
+export * from './hooks/use-ps-debounced-revalidate';
 export * from './hooks/use-ps-optimistic-rows';
 export * from './hooks/use-ps-optimistic-fetcher';
 export * from './hooks/use-ps-optimistic-save';
@@ -88,6 +90,9 @@ export * from './services/ps-optimistic-save-service';
 export * from './services/ps-client-param-revalidation-service';
 export * from './interfaces/ps-fetcher-like';
 export * from './interfaces/ps-fetcher-submit-options';
+export * from './interfaces/ps-live-handle';
+export * from './interfaces/ps-live-input';
+export * from './interfaces/ps-live-open-options';
 export * from './interfaces/ps-optimistic-fetcher-input';
 export * from './interfaces/ps-optimistic-fetcher-result';
 export * from './interfaces/ps-revalidator-like';

package/dist/esm/interfaces/ps-live-handle.js

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

package/dist/esm/interfaces/ps-live-input.js

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

package/dist/esm/interfaces/ps-live-open-options.js

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

package/dist/hooks/use-ps-debounced-revalidate.d.ts

@@ -0,0 +1,2 @@
+import type { PsRevalidatorLike } from '../interfaces/ps-revalidator-like';
+export declare const usePsDebouncedRevalidate: (revalidator: PsRevalidatorLike, delayMilliseconds: number) => (() => void);

package/dist/hooks/use-ps-debounced-revalidate.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePsDebouncedRevalidate = void 0;
+const react_1 = require("react");
+const usePsDebouncedRevalidate = (revalidator, delayMilliseconds) => {
+    const latest = (0, react_1.useRef)(revalidator);
+    const timer = (0, react_1.useRef)(null);
+    latest.current = revalidator;
+    const fire = (0, react_1.useCallback)(() => {
+        timer.current = null;
+        if (latest.current.state !== 'idle') {
+            timer.current = setTimeout(fire, delayMilliseconds);
+            return;
+        }
+        void latest.current.revalidate();
+    }, [delayMilliseconds]);
+    (0, react_1.useEffect)(() => () => {
+        if (timer.current !== null)
+            clearTimeout(timer.current);
+    }, []);
+    return (0, react_1.useCallback)(() => {
+        if (timer.current !== null)
+            clearTimeout(timer.current);
+        timer.current = setTimeout(fire, delayMilliseconds);
+    }, [delayMilliseconds, fire]);
+};
+exports.usePsDebouncedRevalidate = usePsDebouncedRevalidate;

package/dist/hooks/use-ps-live.d.ts

@@ -0,0 +1,2 @@
+import type { PsLiveInput } from '../interfaces/ps-live-input';
+export declare const usePsLive: (input: PsLiveInput) => void;

package/dist/hooks/use-ps-live.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePsLive = void 0;
+const react_1 = require("react");
+const usePsLive = (input) => {
+    const latest = (0, react_1.useRef)(input);
+    const { enabled, open, path } = input;
+    const eventKey = input.events.join(',');
+    latest.current = input;
+    (0, react_1.useEffect)(() => {
+        if (!enabled)
+            return;
+        let isActive = true;
+        let close = null;
+        void open({
+            events: latest.current.events,
+            fetchToken: () => latest.current.fetchToken(),
+            onEvent: (name, payload) => latest.current.onEvent(name, payload),
+            onResume: () => {
+                const { onResume } = latest.current;
+                if (onResume !== undefined)
+                    onResume();
+            },
+            path,
+        }).then((handle) => {
+            if (isActive)
+                close = () => handle.close();
+            else
+                handle.close();
+        });
+        return () => {
+            isActive = false;
+            if (close !== null)
+                close();
+        };
+    }, [enabled, eventKey, open, path]);
+};
+exports.usePsLive = usePsLive;

package/dist/index.d.ts

@@ -76,6 +76,8 @@ 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-live';
+export * from './hooks/use-ps-debounced-revalidate';
 export * from './hooks/use-ps-optimistic-rows';
 export * from './hooks/use-ps-optimistic-fetcher';
 export * from './hooks/use-ps-optimistic-save';
@@ -88,6 +90,9 @@ export * from './services/ps-optimistic-save-service';
 export * from './services/ps-client-param-revalidation-service';
 export * from './interfaces/ps-fetcher-like';
 export * from './interfaces/ps-fetcher-submit-options';
+export * from './interfaces/ps-live-handle';
+export * from './interfaces/ps-live-input';
+export * from './interfaces/ps-live-open-options';
 export * from './interfaces/ps-optimistic-fetcher-input';
 export * from './interfaces/ps-optimistic-fetcher-result';
 export * from './interfaces/ps-revalidator-like';

package/dist/index.js

@@ -92,6 +92,8 @@ __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-live"), exports);
+__exportStar(require("./hooks/use-ps-debounced-revalidate"), exports);
 __exportStar(require("./hooks/use-ps-optimistic-rows"), exports);
 __exportStar(require("./hooks/use-ps-optimistic-fetcher"), exports);
 __exportStar(require("./hooks/use-ps-optimistic-save"), exports);
@@ -104,6 +106,9 @@ __exportStar(require("./services/ps-optimistic-save-service"), exports);
 __exportStar(require("./services/ps-client-param-revalidation-service"), exports);
 __exportStar(require("./interfaces/ps-fetcher-like"), exports);
 __exportStar(require("./interfaces/ps-fetcher-submit-options"), exports);
+__exportStar(require("./interfaces/ps-live-handle"), exports);
+__exportStar(require("./interfaces/ps-live-input"), exports);
+__exportStar(require("./interfaces/ps-live-open-options"), exports);
 __exportStar(require("./interfaces/ps-optimistic-fetcher-input"), exports);
 __exportStar(require("./interfaces/ps-optimistic-fetcher-result"), exports);
 __exportStar(require("./interfaces/ps-revalidator-like"), exports);

package/dist/interfaces/ps-live-handle.d.ts

@@ -0,0 +1,3 @@
+export interface PsLiveHandle {
+    close: () => void;
+}

package/dist/interfaces/ps-live-handle.js

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

package/dist/interfaces/ps-live-input.d.ts

@@ -0,0 +1,11 @@
+import type { PsLiveHandle } from './ps-live-handle';
+import type { PsLiveOpenOptions } from './ps-live-open-options';
+export interface PsLiveInput {
+    enabled: boolean;
+    events: string[];
+    fetchToken: () => Promise<string | null>;
+    onEvent: (name: string, payload: unknown) => void;
+    onResume?: () => void;
+    open: (options: PsLiveOpenOptions) => Promise<PsLiveHandle>;
+    path: string;
+}

package/dist/interfaces/ps-live-input.js

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

package/dist/interfaces/ps-live-open-options.d.ts

@@ -0,0 +1,7 @@
+export interface PsLiveOpenOptions {
+    events: string[];
+    fetchToken: () => Promise<string | null>;
+    onEvent: (name: string, payload: unknown) => void;
+    onResume: () => void;
+    path: string;
+}

package/dist/interfaces/ps-live-open-options.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.32.0",
+	"version": "2.33.0",
 	"private": false,
 	"main": "./dist/index.js",
 	"module": "./dist/esm/index.js",