@adonisjs/transmit-client 0.2.0 → 0.2.2

package/LICENSE.md

@@ -1,9 +1,9 @@
-# The MIT License
-
-Copyright (c) 2023, Romain Lanz, AdonisJS Core Team, contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# The MIT License
+
+Copyright (c) 2023, Romain Lanz, AdonisJS Core Team, contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -35,10 +35,10 @@ AdonisJS Transmit Client is a client for the native Server-Sent-Event (SSE) modu
 
   - [Installation](#installation)
   - [Usage](#usage)
-  - [Subscribing to channels](#subscribing-to-channels)
+  - [Creating a subscription](#creating-a-subscription)
+    - [Unsubscribing](#unsubscribing)
     - [Subscription Request](#subscription-request)
     - [Reconnecting](#reconnecting)
-    - [Unsubscribing](#unsubscribing)
 - [Events](#events)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -77,12 +77,10 @@ Then, you have to call the `create` method on the subscription to register it on
 await subscription.create()
 ```
 
-Once the subscription is created, you can listen for events on the channel using the `onMessage` method. You can define as many listeners as you want.
+You can listen for events on the channel using the `onMessage` method. You can define as many listeners as you want on the same subscription.
 
 ```ts
-import {subscribe} from 'node:diagnostics_channel'
-
-subscribe.onMessage((message) => {
+subscription.onMessage((message) => {
   console.log(message)
 })
 ```
@@ -90,11 +88,13 @@ subscribe.onMessage((message) => {
 You can also listen only once for a message using the `onMessagetOnce` method.
 
 ```ts
-subscribe.onMessageOnce((message) => {
+subscription.onMessageOnce((message) => {
   console.log('I will be called only once')
 })
 ```
 
+Note listeners are local only; you can add them before or after registering your subscription on the server.
+
 ### Unsubscribing
 
 The `onMessage` method returns a function to remove the message handler from the subscription.

package/build/{transmit.d.ts → index.d.ts}

@@ -67,6 +67,7 @@ declare class Subscription {
      */
     $runHandler(message: unknown): void;
     create(): Promise<unknown>;
+    forceCreate(): Promise<unknown>;
     delete(): Promise<void>;
     onMessage<T>(handler: (message: T) => void): () => void;
     onMessageOnce<T>(handler: (message: T) => void): void;
@@ -79,6 +80,7 @@ interface TransmitOptions {
         withCredentials: boolean;
     }) => EventSource;
     eventTargetFactory?: () => EventTarget | null;
+    httpClientFactory?: (baseUrl: string, uid: string) => HttpClient;
     beforeSubscribe?: (request: RequestInit) => void;
     beforeUnsubscribe?: (request: RequestInit) => void;
     maxReconnectAttempts?: number;
@@ -100,4 +102,4 @@ declare class Transmit {
     close(): void;
 }
 
-export { Transmit };
+export { Subscription, Transmit };

package/build/{transmit.js → index.js}

@@ -108,6 +108,9 @@ var Subscription = class {
     if (this.isCreated) {
       return;
     }
+    return this.forceCreate();
+  }
+  async forceCreate() {
     if (__privateGet(this, _getEventSourceStatus).call(this) !== TransmitStatus.Connected) {
       return new Promise((resolve) => {
         setTimeout(() => {
@@ -310,16 +313,16 @@ var Transmit = class {
     if (typeof options.eventTargetFactory === "undefined") {
       options.eventTargetFactory = () => new EventTarget();
     }
+    if (typeof options.httpClientFactory === "undefined") {
+      options.httpClientFactory = (baseUrl, uid) => new HttpClient({ baseUrl, uid });
+    }
     if (typeof options.maxReconnectAttempts === "undefined") {
       options.maxReconnectAttempts = 5;
     }
     __privateSet(this, _uid, options.uidGenerator());
     __privateSet(this, _eventTarget, options.eventTargetFactory());
     __privateSet(this, _hooks2, new Hook());
-    __privateSet(this, _httpClient2, new HttpClient({
-      baseUrl: options.baseUrl,
-      uid: __privateGet(this, _uid)
-    }));
+    __privateSet(this, _httpClient2, options.httpClientFactory(options.baseUrl, __privateGet(this, _uid)));
     if (options.beforeSubscribe) {
       __privateGet(this, _hooks2).register(HookEvent.BeforeSubscribe, options.beforeSubscribe);
     }
@@ -398,7 +401,9 @@ connect_fn = function() {
     __privateMethod(this, _changeStatus, changeStatus_fn).call(this, TransmitStatus.Connected);
     __privateSet(this, _reconnectAttempts, 0);
     for (const subscription of __privateGet(this, _subscriptions).values()) {
-      void subscription.create();
+      if (subscription.isCreated) {
+        void subscription.forceCreate();
+      }
     }
   });
 };
@@ -430,5 +435,6 @@ onError_fn = function() {
   __privateWrapper(this, _reconnectAttempts)._++;
 };
 export {
+  Subscription,
   Transmit
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/transmit-client",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "A client for the native Server-Sent-Event module of AdonisJS.",
   "keywords": [
     "client",
@@ -14,9 +14,9 @@
   "license": "MIT",
   "author": "Romain Lanz <romain.lanz@pm.me>",
   "type": "module",
-  "source": "src/transmit.ts",
-  "main": "./build/transmit.js",
-  "types": "./build/transmit.d.ts",
+  "source": "index.ts",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
   "scripts": {
     "clean": "del-cli build",
     "typecheck": "tsc --noEmit",
@@ -67,7 +67,7 @@
     "target": "es2020",
     "outDir": "build",
     "entry": [
-      "src/transmit.ts"
+      "index.ts"
     ]
   },
   "release-it": {

package/src/subscription.ts

@@ -92,6 +92,10 @@ export class Subscription {
       return
     }
 
+    return this.forceCreate()
+  }
+
+  async forceCreate() {
     if (this.#getEventSourceStatus() !== TransmitStatus.Connected) {
       return new Promise((resolve) => {
         setTimeout(() => {

package/src/transmit.ts

@@ -18,6 +18,7 @@ interface TransmitOptions {
   uidGenerator?: () => string
   eventSourceFactory?: (url: string | URL, options: { withCredentials: boolean }) => EventSource
   eventTargetFactory?: () => EventTarget | null
+  httpClientFactory?: (baseUrl: string, uid: string) => HttpClient
   beforeSubscribe?: (request: RequestInit) => void
   beforeUnsubscribe?: (request: RequestInit) => void
   maxReconnectAttempts?: number
@@ -94,6 +95,10 @@ export class Transmit {
       options.eventTargetFactory = () => new EventTarget()
     }
 
+    if (typeof options.httpClientFactory === 'undefined') {
+      options.httpClientFactory = (baseUrl, uid) => new HttpClient({ baseUrl, uid })
+    }
+
     if (typeof options.maxReconnectAttempts === 'undefined') {
       options.maxReconnectAttempts = 5
     }
@@ -101,10 +106,7 @@ export class Transmit {
     this.#uid = options.uidGenerator()
     this.#eventTarget = options.eventTargetFactory()
     this.#hooks = new Hook()
-    this.#httpClient = new HttpClient({
-      baseUrl: options.baseUrl,
-      uid: this.#uid,
-    })
+    this.#httpClient = options.httpClientFactory(options.baseUrl, this.#uid)
 
     if (options.beforeSubscribe) {
       this.#hooks.register(HookEvent.BeforeSubscribe, options.beforeSubscribe)
@@ -160,7 +162,9 @@ export class Transmit {
       this.#reconnectAttempts = 0
 
       for (const subscription of this.#subscriptions.values()) {
-        void subscription.create()
+        if (subscription.isCreated) {
+          void subscription.forceCreate()
+        }
       }
     })
   }