quidproquo-web-react 0.0.239 → 0.0.241

package/lib/commonjs/auth/RefreshAuthTokensProvider.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { AuthenticationInfo } from 'quidproquo-core';
+export type RefreshAuthTokensProviderProps = {
+    children: React.ReactNode;
+    authenticationInfo?: AuthenticationInfo;
+    refreshTokens: (authenticationInfo: AuthenticationInfo) => Promise<any>;
+};
+export declare const RefreshAuthTokensProvider: import("react").NamedExoticComponent<RefreshAuthTokensProviderProps>;

package/lib/commonjs/auth/RefreshAuthTokensProvider.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RefreshAuthTokensProvider = void 0;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const hooks_1 = require("./hooks");
+const RefreshAuthTokensProviderComponent = ({ children, authenticationInfo, refreshTokens }) => {
+    (0, hooks_1.useRefreshTokens)(authenticationInfo, refreshTokens);
+    // This fragment is not useless!
+    return (0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: children });
+};
+exports.RefreshAuthTokensProvider = (0, react_1.memo)(RefreshAuthTokensProviderComponent);

package/lib/commonjs/auth/hooks/useRefreshTokens.d.ts

@@ -1,2 +1,2 @@
-import { AuthState } from '../types';
-export declare const useRefreshTokens: (authState: AuthState, refreshTokens: (authState: AuthState) => void) => void;
+import { AuthenticationInfo } from 'quidproquo-core';
+export declare const useRefreshTokens: (authenticationInfo: AuthenticationInfo | undefined, refreshTokens: (authenticationInfo: AuthenticationInfo) => Promise<any>) => void;

package/lib/commonjs/auth/hooks/useRefreshTokens.js

@@ -2,21 +2,22 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useRefreshTokens = void 0;
 const react_1 = require("react");
-const useRefreshTokens = (authState, refreshTokens) => {
+const useRefreshTokens = (authenticationInfo, refreshTokens) => {
     const refresh = () => {
-        const { refreshToken, expiresAt } = authState.authenticationInfo || {};
-        if (refreshToken && expiresAt) {
+        if (authenticationInfo && authenticationInfo.refreshToken && authenticationInfo.expiresAt) {
             const now = new Date().toISOString();
-            const timeToExpire = new Date(expiresAt).getTime() - new Date(now).getTime();
+            const timeToExpire = new Date(authenticationInfo.expiresAt).getTime() - new Date(now).getTime();
             // Refresh the token 10 minutes before it expires to ensure there's a buffer
             const bufferTime = 10 * 60 * 1000;
             const refreshTime = timeToExpire - bufferTime;
             if (refreshTime > 0) {
-                return setTimeout(() => refreshTokens(authState), refreshTime);
+                return setTimeout(() => {
+                    refreshTokens(authenticationInfo);
+                }, refreshTime);
             }
             else {
                 // If the token is already expired or very close to expiration, refresh immediately
-                refreshTokens(authState);
+                refreshTokens(authenticationInfo);
             }
         }
         return null;
@@ -29,6 +30,6 @@ const useRefreshTokens = (authState, refreshTokens) => {
                 clearTimeout(timerId);
             }
         };
-    }, [authState, refreshTokens]);
+    }, [authenticationInfo, refreshTokens]);
 };
 exports.useRefreshTokens = useRefreshTokens;

package/lib/commonjs/auth/index.d.ts

@@ -1,3 +1,4 @@
 export * from './authContext';
 export * from './hooks';
+export * from './RefreshAuthTokensProvider';
 export * from './types';

package/lib/commonjs/auth/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./authContext"), exports);
 __exportStar(require("./hooks"), exports);
+__exportStar(require("./RefreshAuthTokensProvider"), exports);
 __exportStar(require("./types"), exports);

package/lib/commonjs/hooks/useRunEvery.d.ts

@@ -1 +1 @@
-export declare function useRunEvery<T>(func: () => T, interval: number): T;
+export declare function useRunEvery<T>(func: () => T, intervalSeconds: number): T;

package/lib/commonjs/hooks/useRunEvery.js

@@ -2,21 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useRunEvery = void 0;
 const react_1 = require("react");
-function useRunEvery(func, interval) {
+function useRunEvery(func, intervalSeconds) {
     const [value, setValue] = (0, react_1.useState)(func);
     const intervalRef = (0, react_1.useRef)(null);
     (0, react_1.useEffect)(() => {
         intervalRef.current = window.setInterval(() => {
             const newValue = func();
             setValue(newValue);
-        }, interval * 1000);
+        }, intervalSeconds * 1000);
         return () => {
             if (intervalRef.current !== null) {
                 window.clearInterval(intervalRef.current);
                 intervalRef.current = null;
             }
         };
-    }, [interval]);
+    }, [intervalSeconds]);
     return value;
 }
 exports.useRunEvery = useRunEvery;

package/lib/commonjs/index.d.ts

@@ -4,3 +4,4 @@ export * from './baseUrl';
 export * from './hooks';
 export * from './state';
 export * from './websocket';
+export * from './webSocketQueue';

package/lib/commonjs/index.js

@@ -20,3 +20,4 @@ __exportStar(require("./baseUrl"), exports);
 __exportStar(require("./hooks"), exports);
 __exportStar(require("./state"), exports);
 __exportStar(require("./websocket"), exports);
+__exportStar(require("./webSocketQueue"), exports);

package/lib/commonjs/webSocketQueue/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useSubscribeToWebSocketQueueEvent';
+export * from './useWebsocketQueueSendEvent';

package/lib/commonjs/webSocketQueue/hooks/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./useSubscribeToWebSocketQueueEvent"), exports);
+__exportStar(require("./useWebsocketQueueSendEvent"), exports);

package/lib/commonjs/webSocketQueue/hooks/useSubscribeToWebSocketQueueEvent.d.ts

@@ -0,0 +1,3 @@
+import { WebSocketServiceEventSubscriptionFunction } from 'quidproquo-web';
+import { AnyWebSocketQueueEventMessageWithCorrelation } from 'quidproquo-webserver';
+export declare const useSubscribeToWebSocketQueueEvent: <E extends AnyWebSocketQueueEventMessageWithCorrelation>(subscriptionType: E["type"], callback: WebSocketServiceEventSubscriptionFunction<E>) => void;

package/lib/commonjs/webSocketQueue/hooks/useSubscribeToWebSocketQueueEvent.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSubscribeToWebSocketQueueEvent = void 0;
+const websocket_1 = require("../../websocket");
+const useSubscribeToWebSocketQueueEvent = (subscriptionType, callback) => {
+    (0, websocket_1.useSubscribeToWebSocketEvent)(subscriptionType, callback);
+};
+exports.useSubscribeToWebSocketQueueEvent = useSubscribeToWebSocketQueueEvent;

package/lib/commonjs/webSocketQueue/hooks/useWebsocketQueueSendEvent.d.ts

@@ -0,0 +1,2 @@
+import { AnyWebSocketQueueEventMessageWithCorrelation } from 'quidproquo-webserver';
+export declare const useWebsocketQueueSendEvent: <E extends AnyWebSocketQueueEventMessageWithCorrelation>() => (event: E) => void;

package/lib/commonjs/webSocketQueue/hooks/useWebsocketQueueSendEvent.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useWebsocketQueueSendEvent = void 0;
+const websocket_1 = require("../../websocket");
+const useWebsocketQueueSendEvent = () => {
+    const sendMessage = (0, websocket_1.useWebsocketSendEvent)();
+    return sendMessage;
+};
+exports.useWebsocketQueueSendEvent = useWebsocketQueueSendEvent;

package/lib/commonjs/webSocketQueue/index.d.ts

@@ -0,0 +1 @@
+export * from './hooks';

package/lib/commonjs/webSocketQueue/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./hooks"), exports);

package/lib/commonjs/websocket/WebSocketAuthSync/hooks/useWebsocketAuthSync.js

@@ -15,7 +15,7 @@ const useWebsocketAuthSync = (accessToken) => {
         }
         if (accessToken) {
             const authMessage = {
-                type: quidproquo_webserver_1.WebsocketClientMessageEventType.Authenticate,
+                type: quidproquo_webserver_1.WebSocketQueueClientMessageEventType.Authenticate,
                 payload: {
                     accessToken: accessToken,
                 },
@@ -24,7 +24,7 @@ const useWebsocketAuthSync = (accessToken) => {
         }
         else {
             const authMessage = {
-                type: quidproquo_webserver_1.WebsocketClientMessageEventType.Unauthenticate,
+                type: quidproquo_webserver_1.WebSocketQueueClientMessageEventType.Unauthenticate,
             };
             sendMessage(authMessage);
         }

package/lib/commonjs/websocket/WebSocketAuthSync/hooks/useWebsocketPingPong.js

@@ -2,20 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useWebsocketPingPong = void 0;
 const quidproquo_webserver_1 = require("quidproquo-webserver");
-const react_1 = require("react");
-const hooks_1 = require("../../hooks");
+const hooks_1 = require("../../../hooks");
+const hooks_2 = require("../../hooks");
 const useWebsocketPingPong = () => {
-    const sendMessage = (0, hooks_1.useWebsocketSendEvent)();
-    (0, react_1.useEffect)(() => {
-        const intervalId = setInterval(() => {
-            const pingEvent = {
-                type: quidproquo_webserver_1.WebsocketClientMessageEventType.Ping,
-            };
-            sendMessage(pingEvent);
-        }, 8 * 60 * 1000);
-        return () => {
-            clearInterval(intervalId);
+    const sendMessage = (0, hooks_2.useWebsocketSendEvent)();
+    (0, hooks_1.useRunEvery)(() => {
+        const pingEvent = {
+            type: quidproquo_webserver_1.WebSocketQueueClientMessageEventType.Ping,
         };
-    }, [sendMessage]);
+        sendMessage(pingEvent);
+    }, 8 * 60);
 };
 exports.useWebsocketPingPong = useWebsocketPingPong;

package/lib/commonjs/websocket/hooks/useWebsocketSendEvent.d.ts

@@ -1,2 +1,2 @@
 import { AnyEventMessage } from 'quidproquo-core';
-export declare const useWebsocketSendEvent: () => (event: AnyEventMessage) => void;
+export declare const useWebsocketSendEvent: <E extends AnyEventMessage = AnyEventMessage>() => (event: E) => void;

package/lib/esm/auth/RefreshAuthTokensProvider.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { AuthenticationInfo } from 'quidproquo-core';
+export type RefreshAuthTokensProviderProps = {
+    children: React.ReactNode;
+    authenticationInfo?: AuthenticationInfo;
+    refreshTokens: (authenticationInfo: AuthenticationInfo) => Promise<any>;
+};
+export declare const RefreshAuthTokensProvider: import("react").NamedExoticComponent<RefreshAuthTokensProviderProps>;

package/lib/esm/auth/RefreshAuthTokensProvider.js

@@ -0,0 +1,9 @@
+import { Fragment as _Fragment, jsx as _jsx } from "react/jsx-runtime";
+import { memo } from 'react';
+import { useRefreshTokens } from './hooks';
+const RefreshAuthTokensProviderComponent = ({ children, authenticationInfo, refreshTokens }) => {
+    useRefreshTokens(authenticationInfo, refreshTokens);
+    // This fragment is not useless!
+    return _jsx(_Fragment, { children: children });
+};
+export const RefreshAuthTokensProvider = memo(RefreshAuthTokensProviderComponent);

package/lib/esm/auth/hooks/useRefreshTokens.d.ts

@@ -1,2 +1,2 @@
-import { AuthState } from '../types';
-export declare const useRefreshTokens: (authState: AuthState, refreshTokens: (authState: AuthState) => void) => void;
+import { AuthenticationInfo } from 'quidproquo-core';
+export declare const useRefreshTokens: (authenticationInfo: AuthenticationInfo | undefined, refreshTokens: (authenticationInfo: AuthenticationInfo) => Promise<any>) => void;

package/lib/esm/auth/hooks/useRefreshTokens.js

@@ -1,19 +1,20 @@
 import { useEffect } from 'react';
-export const useRefreshTokens = (authState, refreshTokens) => {
+export const useRefreshTokens = (authenticationInfo, refreshTokens) => {
     const refresh = () => {
-        const { refreshToken, expiresAt } = authState.authenticationInfo || {};
-        if (refreshToken && expiresAt) {
+        if (authenticationInfo && authenticationInfo.refreshToken && authenticationInfo.expiresAt) {
             const now = new Date().toISOString();
-            const timeToExpire = new Date(expiresAt).getTime() - new Date(now).getTime();
+            const timeToExpire = new Date(authenticationInfo.expiresAt).getTime() - new Date(now).getTime();
             // Refresh the token 10 minutes before it expires to ensure there's a buffer
             const bufferTime = 10 * 60 * 1000;
             const refreshTime = timeToExpire - bufferTime;
             if (refreshTime > 0) {
-                return setTimeout(() => refreshTokens(authState), refreshTime);
+                return setTimeout(() => {
+                    refreshTokens(authenticationInfo);
+                }, refreshTime);
             }
             else {
                 // If the token is already expired or very close to expiration, refresh immediately
-                refreshTokens(authState);
+                refreshTokens(authenticationInfo);
             }
         }
         return null;
@@ -26,5 +27,5 @@ export const useRefreshTokens = (authState, refreshTokens) => {
                 clearTimeout(timerId);
             }
         };
-    }, [authState, refreshTokens]);
+    }, [authenticationInfo, refreshTokens]);
 };

package/lib/esm/auth/index.d.ts

@@ -1,3 +1,4 @@
 export * from './authContext';
 export * from './hooks';
+export * from './RefreshAuthTokensProvider';
 export * from './types';

package/lib/esm/auth/index.js

@@ -1,3 +1,4 @@
 export * from './authContext';
 export * from './hooks';
+export * from './RefreshAuthTokensProvider';
 export * from './types';

package/lib/esm/hooks/useRunEvery.d.ts

@@ -1 +1 @@
-export declare function useRunEvery<T>(func: () => T, interval: number): T;
+export declare function useRunEvery<T>(func: () => T, intervalSeconds: number): T;

package/lib/esm/hooks/useRunEvery.js

@@ -1,18 +1,18 @@
 import { useEffect, useRef, useState } from 'react';
-export function useRunEvery(func, interval) {
+export function useRunEvery(func, intervalSeconds) {
     const [value, setValue] = useState(func);
     const intervalRef = useRef(null);
     useEffect(() => {
         intervalRef.current = window.setInterval(() => {
             const newValue = func();
             setValue(newValue);
-        }, interval * 1000);
+        }, intervalSeconds * 1000);
         return () => {
             if (intervalRef.current !== null) {
                 window.clearInterval(intervalRef.current);
                 intervalRef.current = null;
             }
         };
-    }, [interval]);
+    }, [intervalSeconds]);
     return value;
 }

package/lib/esm/index.d.ts

@@ -4,3 +4,4 @@ export * from './baseUrl';
 export * from './hooks';
 export * from './state';
 export * from './websocket';
+export * from './webSocketQueue';

package/lib/esm/index.js

@@ -4,3 +4,4 @@ export * from './baseUrl';
 export * from './hooks';
 export * from './state';
 export * from './websocket';
+export * from './webSocketQueue';

package/lib/esm/webSocketQueue/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useSubscribeToWebSocketQueueEvent';
+export * from './useWebsocketQueueSendEvent';

package/lib/esm/webSocketQueue/hooks/index.js

@@ -0,0 +1,2 @@
+export * from './useSubscribeToWebSocketQueueEvent';
+export * from './useWebsocketQueueSendEvent';

package/lib/esm/webSocketQueue/hooks/useSubscribeToWebSocketQueueEvent.d.ts

@@ -0,0 +1,3 @@
+import { WebSocketServiceEventSubscriptionFunction } from 'quidproquo-web';
+import { AnyWebSocketQueueEventMessageWithCorrelation } from 'quidproquo-webserver';
+export declare const useSubscribeToWebSocketQueueEvent: <E extends AnyWebSocketQueueEventMessageWithCorrelation>(subscriptionType: E["type"], callback: WebSocketServiceEventSubscriptionFunction<E>) => void;

package/lib/esm/webSocketQueue/hooks/useSubscribeToWebSocketQueueEvent.js

@@ -0,0 +1,4 @@
+import { useSubscribeToWebSocketEvent } from '../../websocket';
+export const useSubscribeToWebSocketQueueEvent = (subscriptionType, callback) => {
+    useSubscribeToWebSocketEvent(subscriptionType, callback);
+};

package/lib/esm/webSocketQueue/hooks/useWebsocketQueueSendEvent.d.ts

@@ -0,0 +1,2 @@
+import { AnyWebSocketQueueEventMessageWithCorrelation } from 'quidproquo-webserver';
+export declare const useWebsocketQueueSendEvent: <E extends AnyWebSocketQueueEventMessageWithCorrelation>() => (event: E) => void;

package/lib/esm/webSocketQueue/hooks/useWebsocketQueueSendEvent.js

@@ -0,0 +1,5 @@
+import { useWebsocketSendEvent } from '../../websocket';
+export const useWebsocketQueueSendEvent = () => {
+    const sendMessage = useWebsocketSendEvent();
+    return sendMessage;
+};

package/lib/esm/webSocketQueue/index.d.ts

@@ -0,0 +1 @@
+export * from './hooks';

package/lib/esm/webSocketQueue/index.js

@@ -0,0 +1 @@
+export * from './hooks';

package/lib/esm/websocket/WebSocketAuthSync/hooks/useWebsocketAuthSync.js

@@ -1,5 +1,5 @@
 import { WebsocketServiceEvent } from 'quidproquo-web';
-import { WebsocketClientMessageEventType, } from 'quidproquo-webserver';
+import { WebSocketQueueClientMessageEventType, } from 'quidproquo-webserver';
 import { useEffect } from 'react';
 import { useFastCallback } from '../../../hooks';
 import { useSubscribeToWebsocket, useWebsocketApi, useWebsocketSendEvent } from '../../hooks';
@@ -12,7 +12,7 @@ export const useWebsocketAuthSync = (accessToken) => {
         }
         if (accessToken) {
             const authMessage = {
-                type: WebsocketClientMessageEventType.Authenticate,
+                type: WebSocketQueueClientMessageEventType.Authenticate,
                 payload: {
                     accessToken: accessToken,
                 },
@@ -21,7 +21,7 @@ export const useWebsocketAuthSync = (accessToken) => {
         }
         else {
             const authMessage = {
-                type: WebsocketClientMessageEventType.Unauthenticate,
+                type: WebSocketQueueClientMessageEventType.Unauthenticate,
             };
             sendMessage(authMessage);
         }

package/lib/esm/websocket/WebSocketAuthSync/hooks/useWebsocketPingPong.js

@@ -1,17 +1,12 @@
-import { WebsocketClientMessageEventType } from 'quidproquo-webserver';
-import { useEffect } from 'react';
+import { WebSocketQueueClientMessageEventType } from 'quidproquo-webserver';
+import { useRunEvery } from '../../../hooks';
 import { useWebsocketSendEvent } from '../../hooks';
 export const useWebsocketPingPong = () => {
     const sendMessage = useWebsocketSendEvent();
-    useEffect(() => {
-        const intervalId = setInterval(() => {
-            const pingEvent = {
-                type: WebsocketClientMessageEventType.Ping,
-            };
-            sendMessage(pingEvent);
-        }, 8 * 60 * 1000);
-        return () => {
-            clearInterval(intervalId);
+    useRunEvery(() => {
+        const pingEvent = {
+            type: WebSocketQueueClientMessageEventType.Ping,
         };
-    }, [sendMessage]);
+        sendMessage(pingEvent);
+    }, 8 * 60);
 };

package/lib/esm/websocket/hooks/useWebsocketSendEvent.d.ts

@@ -1,2 +1,2 @@
 import { AnyEventMessage } from 'quidproquo-core';
-export declare const useWebsocketSendEvent: () => (event: AnyEventMessage) => void;
+export declare const useWebsocketSendEvent: <E extends AnyEventMessage = AnyEventMessage>() => (event: E) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quidproquo-web-react",
-  "version": "0.0.239",
+  "version": "0.0.241",
   "description": "",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/esm/index.js",
@@ -32,10 +32,10 @@
   },
   "homepage": "https://github.com/joe-coady/quidproquo#readme",
   "devDependencies": {
-    "quidproquo-core": "0.0.239",
-    "quidproquo-tsconfig": "0.0.239",
-    "quidproquo-webserver": "0.0.239",
-    "quidproquo-web": "0.0.239",
+    "quidproquo-core": "0.0.241",
+    "quidproquo-tsconfig": "0.0.241",
+    "quidproquo-webserver": "0.0.241",
+    "quidproquo-web": "0.0.241",
     "typescript": "^4.9.3"
   },
   "peerDependencies": {