npm - durablews - Versions diffs - 1.0.0 → 1.0.1 - Mend

durablews 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

package/README.md +13 -9
package/dist/{durablews.js → durablews.es.js} +6 -6
package/dist/durablews.umd.js +1 -0
package/dist/index.d.ts +44 -1
package/package.json +9 -6
package/dist/client.d.ts +0 -2
package/dist/durablews.umd.cjs +0 -1
package/dist/types.d.ts +0 -34

package/README.md CHANGED Viewed

@@ -7,7 +7,6 @@ DurableWS is a resilient, TypeScript-based WebSocket client designed for modern
 -   **Automatic Reconnection**: Implements exponential backoff strategy to handle disconnections gracefully.
 -   **Idle Detection**: Automatically detects idle states and triggers custom handlers.
 -   **Message Queueing**: Outgoing messages are queued when the connection is down and sent when it's restored.
--   **Subscription Management**: Simplifies subscribing to topics/channels with ease.
 -   **TypeScript Support**: Fully typed interfaces for a better development experience.
 ## Installation
@@ -27,29 +26,35 @@ yarn add durablews
 To get started with DurableWS, first import the client in your project:
 ```ts
-import { createClient } from "durablews";
+import { defineClient } from "durablews";
 ```
 Create a new WebSocket client instance by specifying the configuration:
 ```ts
-const client = await createClient({
+const client = await defineClient({
     url: "wss://your.websocket.server",
     autoConnect: true, // Automatically connects
     maxReconnectAttempts: 5,
     maxQueueSize: 50,
     idleTimeout: 300000, // 5 minutes
     getToken: async () => {
-        const response = await fetch("/my/token/issuer").then((r) => r.json());
-        return response.token;
-    },
+        const response = await fetch("/my/token/issuer");
+        const data = await response.json();
+        return data.token;
+    }
 });
 ```
 ### Sending Messages
 ```typescript
-client.send({ action: "greet", data: { message: "Hello, World!" } });
+client.send({
+    action: "greet",
+    data: {
+        message: "Hello, World!"
+    }
+});
 ```
 ### Handling Events
@@ -78,14 +83,13 @@ client.onIdle(() => {
 ## API Reference
-### `createClient(config: WebSocketClientConfig): Promise<WebSocketClient>`
+### `defineClient(config: WebSocketClientConfig): Promise<WebSocketClient>`
 Initializes and returns a WebSocket client instance.
 #### Config Options
 -   `url`: WebSocket server URL.
--   `accessToken` (optional): Token for authentication.
 -   `autoConnect` (optional): Whether to connect immediately upon instantiation.
 -   `maxReconnectAttempts` (optional): Maximum number of reconnection attempts.
 -   `maxQueueSize` (optional): Maximum size of the message queue.

package/dist/{durablews.js → durablews.es.js} RENAMED Viewed

@@ -10,16 +10,16 @@ async function b(s) {
     { length: N },
     (o, n) => Math.pow(2, n) * 1e3
   ), m = s.idleTimeout || 5 * 60 * 1e3;
-  let O;
+  let f;
   const u = () => {
-    clearTimeout(O), O = setTimeout(() => {
+    clearTimeout(f), f = setTimeout(() => {
       r.idle.forEach((o) => o());
     }, m);
   };
   window.addEventListener("mousemove", u), window.addEventListener("keydown", u), window.addEventListener("mousedown", u), u(), s.getToken ? d = await s.getToken() : !d && s.authTokenURL && (d = (await fetch(s.authTokenURL).then(
     (n) => n.json()
   )).token);
-  const f = (o = 0) => {
+  const O = (o = 0) => {
     let n = s.url;
     d && (n += `?token=${encodeURIComponent(d)}`), e = new WebSocket(n), e.onopen = () => {
       let t;
@@ -50,7 +50,7 @@ async function b(s) {
     }, e.onclose = (t) => {
       e && e.readyState !== (WebSocket == null ? void 0 : WebSocket.CLOSED) && o < N - 1 && // Exclude normal closure from reconnection attempts
       t.code !== 1e3 && setTimeout(
-        () => f(o + 1),
+        () => O(o + 1),
         h[o]
       ), r.close.forEach((a) => a(t));
     }, e.onerror = (t) => {
@@ -59,7 +59,7 @@ async function b(s) {
   }, p = (o) => {
     (e == null ? void 0 : e.readyState) === (WebSocket == null ? void 0 : WebSocket.OPEN) ? e.send(JSON.stringify(o)) : (e == null ? void 0 : e.readyState) !== (WebSocket == null ? void 0 : WebSocket.CLOSED) && (i.push(o), i.length > S && i.shift());
   }, C = () => {
-    (!e || e.readyState === (WebSocket == null ? void 0 : WebSocket.CLOSED)) && f();
+    (!e || e.readyState === (WebSocket == null ? void 0 : WebSocket.CLOSED)) && O();
   }, T = () => {
     e && e.close();
   }, D = () => new Promise((o, n) => {
@@ -116,5 +116,5 @@ async function b(s) {
   }, s.autoConnect !== !1 && C(), l;
 }
 export {
-  b as createClient
+  b as defineClient
 };

package/dist/durablews.umd.js ADDED Viewed

@@ -0,0 +1 @@

package/dist/index.d.ts CHANGED Viewed

@@ -1 +1,44 @@
-export * from "./client";
+export declare function defineClient(config: WebSocketClientConfig): Promise<WebSocketClient>;
+declare type OnCloseHandler = (event: CloseEvent) => void;
+declare type OnErrorHandler = (error: Event) => void;
+declare type OnIdleHandler = () => void;
+declare type OnMessageHandler = (message: Record<string, unknown>) => void;
+declare type OnOpenHandler = () => void;
+declare interface WebSocketClient {
+    send: (message: Record<string, unknown>) => void;
+    connect: () => void;
+    disconnect: () => void;
+    isReady: () => Promise<void>;
+    getStatus: () => WebSocketClientState;
+    onMessage: (listener: OnMessageHandler) => void;
+    onError: (listener: OnErrorHandler) => void;
+    onOpen: (listener: OnOpenHandler) => void;
+    onClose: (listener: OnCloseHandler) => void;
+    onIdle: (listener: OnIdleHandler) => void;
+}
+declare interface WebSocketClientConfig {
+    url: string;
+    autoConnect?: boolean;
+    maxReconnectAttempts?: number;
+    maxQueueSize?: number;
+    idleTimeout?: number;
+    authTokenURL?: string;
+    getToken?: () => Promise<string> | string;
+}
+declare enum WebSocketClientState {
+    DISCONNECTED = "DISCONNECTED",
+    CONNECTING = "CONNECTING",
+    CONNECTED = "CONNECTED",
+    CLOSING = "CLOSING",
+    CLOSED = "CLOSED"
+}
+export { }

package/package.json CHANGED Viewed

@@ -1,15 +1,16 @@
 {
     "name": "durablews",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "description": "A resilient, TypeScript-based WebSocket client",
     "type": "module",
-    "main": "./dist/durablews.umd.cjs",
-    "module": "./dist/durablews.js",
+    "main": "./dist/durablews.umd.js",
+    "module": "./dist/durablews.es.js",
     "types": "./dist/index.d.ts",
     "exports": {
         ".": {
-            "import": "./dist/durablews.js",
-            "require": "./dist/durablews.umd.cjs"
+            "types": "./dist/index.d.ts",
+            "import": "./dist/durablews.es.js",
+            "require": "./dist/durablews.umd.js"
         }
     },
     "files": [
@@ -33,12 +34,14 @@
         "eslint": "^8.56.0",
         "eslint-config-prettier": "^9.1.0",
         "eslint-plugin-prettier": "^5.1.3",
+        "jsdom": "^24.0.0",
         "prettier": "3.2.5",
         "rimraf": "^5.0.5",
         "typescript": "^5.3.3",
         "vite": "^5.1.1",
         "vite-plugin-dts": "^3.7.2",
-        "vitest": "^1.2.2"
+        "vitest": "^1.2.2",
+        "vitest-websocket-mock": "^0.3.0"
     },
     "repository": {
         "type": "git",

package/dist/client.d.ts DELETED Viewed

	@@ -1,2 +0,0 @@
1	- import type { WebSocketClientConfig, WebSocketClient } from "./types";
2	- export declare function createClient(config: WebSocketClientConfig): Promise<WebSocketClient>;

package/dist/durablews.umd.cjs DELETED Viewed

@@ -1 +0,0 @@

- (function(i,a){typeof exports=="object"&&typeof module<"u"?a(exports):typeof define=="function"&&define.amd?define(["exports"],a):(i=typeof globalThis<"u"?globalThis:i||self,a(i.durablews={}))})(this,function(i){"use strict";var a=(s=>(s.DISCONNECTED="DISCONNECTED",s.CONNECTING="CONNECTING",s.CONNECTED="CONNECTED",s.CLOSING="CLOSING",s.CLOSED="CLOSED",s))(a||{});let l=null;async function p(s){if(l)return l;let e=null;const h=s.maxQueueSize||10,d=[];let u;const N=s.maxReconnectAttempts||5,m=Array.from({length:N},(o,n)=>Math.pow(2,n)*1e3),T=s.idleTimeout||5*60*1e3;let O;const f=()=>{clearTimeout(O),O=setTimeout(()=>{r.idle.forEach(o=>o())},T)};window.addEventListener("mousemove",f),window.addEventListener("keydown",f),window.addEventListener("mousedown",f),f(),s.getToken?u=await s.getToken():!u&&s.authTokenURL&&(u=(await fetch(s.authTokenURL).then(n=>n.json())).token);const C=(o=0)=>{let n=s.url;u&&(n+=`?token=${encodeURIComponent(u)}`),e=new WebSocket(n),e.onopen=()=>{let t;for(;d.length>0;){t=d.shift();try{if(t&&(e==null?void 0:e.readyState)===(WebSocket==null?void 0:WebSocket.OPEN))e.send(JSON.stringify(t));else throw new Error("Message not sent due to WebSocket not being in OPEN state")}catch(c){console.error(c),d.unshift(t);break}}r.open.forEach(c=>c())},e.onmessage=t=>{try{const c=JSON.parse(t.data);r.message.forEach(E=>E(c))}catch(c){t!=null&&t.data&&typeof(t==null?void 0:t.data)=="string"||(t==null?void 0:t.data)instanceof String?r.message.forEach(E=>E({data:t==null?void 0:t.data})):(console.log(typeof t),console.log(t),console.error("Failed to parse message data:",c))}},e.onclose=t=>{e&&e.readyState!==(WebSocket==null?void 0:WebSocket.CLOSED)&&o<N-1&&t.code!==1e3&&setTimeout(()=>C(o+1),m[o]),r.close.forEach(c=>c(t))},e.onerror=t=>{r.error.forEach(c=>c(t))}},y=o=>{(e==null?void 0:e.readyState)===(WebSocket==null?void 0:WebSocket.OPEN)?e.send(JSON.stringify(o)):(e==null?void 0:e.readyState)!==(WebSocket==null?void 0:WebSocket.CLOSED)&&(d.push(o),d.length>h&&d.shift())},S=()=>{(!e||e.readyState===(WebSocket==null?void 0:WebSocket.CLOSED))&&C()},D=()=>{e&&e.close()},g=()=>new Promise((o,n)=>{(e==null?void 0:e.readyState)===(WebSocket==null?void 0:WebSocket.OPEN)?o():(e==null||e.addEventListener("open",()=>o(),{once:!0}),e==null||e.addEventListener("error",n,{once:!0}))}),k=()=>{if(!e)return a.DISCONNECTED;switch(e.readyState){case WebSocket.CONNECTING:return a.CONNECTING;case WebSocket.OPEN:return a.CONNECTED;case WebSocket.CLOSING:return a.CLOSING;case WebSocket.CLOSED:return a.CLOSED;default:return a.DISCONNECTED}},r={message:[],error:[],open:[],close:[],idle:[]};return l={send:y,onMessage:o=>(r.message.push(o),()=>{const n=r.message.indexOf(o);n!==-1&&r.message.splice(n,1)}),onError:o=>(r.error.push(o),()=>{const n=r.error.indexOf(o);n!==-1&&r.error.splice(n,1)}),onOpen:o=>(r.open.push(o),()=>{const n=r.open.indexOf(o);n!==-1&&r.open.splice(n,1)}),onClose:o=>(r.close.push(o),()=>{const n=r.close.indexOf(o);n!==-1&&r.close.splice(n,1)}),onIdle:o=>(r.idle.push(o),()=>{const n=r.idle.indexOf(o);n!==-1&&r.idle.splice(n,1)}),connect:S,disconnect:D,isReady:g,getStatus:k},s.autoConnect!==!1&&S(),l}i.createClient=p,Object.defineProperty(i,Symbol.toStringTag,{value:"Module"})});

package/dist/types.d.ts DELETED Viewed

@@ -1,34 +0,0 @@
-export interface WebSocketClientConfig {
-    url: string;
-    accessToken?: string;
-    autoConnect?: boolean;
-    maxReconnectAttempts?: number;
-    maxQueueSize?: number;
-    idleTimeout?: number;
-    authTokenURL?: string;
-    getToken?: () => Promise<string> | string;
-}
-export interface WebSocketClient {
-    send: (message: Record<string, unknown>) => void;
-    connect: () => void;
-    disconnect: () => void;
-    isReady: () => Promise<void>;
-    getStatus: () => WebSocketClientState;
-    onMessage: (listener: OnMessageHandler) => void;
-    onError: (listener: OnErrorHandler) => void;
-    onOpen: (listener: OnOpenHandler) => void;
-    onClose: (listener: OnCloseHandler) => void;
-    onIdle: (listener: OnIdleHandler) => void;
-}
-export declare enum WebSocketClientState {
-    DISCONNECTED = "DISCONNECTED",
-    CONNECTING = "CONNECTING",
-    CONNECTED = "CONNECTED",
-    CLOSING = "CLOSING",
-    CLOSED = "CLOSED"
-}
-export type OnMessageHandler = (message: Record<string, unknown>) => void;
-export type OnErrorHandler = (error: Event) => void;
-export type OnOpenHandler = () => void;
-export type OnCloseHandler = (event: CloseEvent) => void;
-export type OnIdleHandler = () => void;