@service-broker/webclient 2.0.1 → 2.1.0

package/dist/index.d.ts

@@ -1,13 +1,19 @@
-interface ServiceFilter {
+export interface ServiceSelector {
     name: string;
     capabilities?: string[];
 }
 export interface ServiceHandler {
-    (request: Message): Message | void | Promise<Message | void>;
+    (request: MessageWithHeader): Message | void | Promise<Message | void>;
 }
-interface Message {
-    header?: Record<string, unknown>;
-    payload?: string;
+type MessageHeader = Record<string, unknown>;
+type MessagePayload = string;
+export interface MessageWithHeader {
+    header: MessageHeader;
+    payload?: MessagePayload;
+}
+export interface Message {
+    header?: MessageHeader;
+    payload?: MessagePayload;
 }
 export declare class ServiceBroker {
     private readonly url;
@@ -25,14 +31,15 @@ export declare class ServiceBroker {
     private onServiceResponse;
     private onServiceRequest;
     private send;
-    request(service: ServiceFilter, req: Message): Promise<Message>;
-    requestTo(endpointId: string | null, service: ServiceFilter, req: Message): Promise<Message>;
-    advertise(service: ServiceFilter, handler: ServiceHandler): void;
+    request(service: ServiceSelector, req: Message): Promise<Message>;
+    requestTo(endpointId: string | null, service: ServiceSelector, req: Message): Promise<Message>;
+    advertise(service: ServiceSelector, handler: ServiceHandler): void;
     unadvertise(serviceName: string): void;
     setServiceHandler(serviceName: string, handler: ServiceHandler): void;
     publish(topic: string, text: string): void;
     subscribe(topic: string, handler: (text: string) => void): void;
     unsubscribe(topic: string): void;
+    status(): Promise<any>;
     isConnected(): boolean;
     addConnectListener(listener: Function): void;
 }

package/dist/index.js

@@ -84,7 +84,12 @@ export class ServiceBroker {
             Promise.resolve(provider.handler(msg))
                 .then(res => {
                 if (msg.header.id) {
-                    this.send(Object.assign(Object.assign({}, res === null || res === void 0 ? void 0 : res.header), { to: msg.header.from, id: msg.header.id, type: "ServiceResponse" }), res === null || res === void 0 ? void 0 : res.payload);
+                    this.send({
+                        ...res?.header,
+                        to: msg.header.from,
+                        id: msg.header.id,
+                        type: "ServiceResponse"
+                    }, res?.payload);
                 }
             })
                 .catch(err => {
@@ -133,7 +138,7 @@ export class ServiceBroker {
         };
         if (endpointId)
             header.to = endpointId;
-        this.send(Object.assign(Object.assign({}, req.header), header), req.payload);
+        this.send({ ...req.header, ...header }, req.payload);
         return promise;
     }
     advertise(service, handler) {
@@ -174,6 +179,12 @@ export class ServiceBroker {
     unsubscribe(topic) {
         return this.unadvertise("#" + topic);
     }
+    async status() {
+        const id = ++this.pendingIdGen;
+        this.send({ id, type: "SbStatusRequest" });
+        const res = await new Promise((fulfill, reject) => this.pendingResponses.set(id, { fulfill, reject }));
+        return JSON.parse(res.payload);
+    }
     isConnected() {
         return this.ws != null;
     }

package/package.json

@@ -1,19 +1,22 @@
 {
   "name": "@service-broker/webclient",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Browser ESM client library for communicating with the service broker",
   "type": "module",
   "main": "dist/index.js",
+  "scripts": {
+    "build": "tsc"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/service-broker/service-broker-webclient.git"
+    "url": "git+https://github.com/service-broker/webclient.git"
   },
   "author": "Hai Phan <hai.phan@gmail.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/service-broker/service-broker-webclient/issues"
+    "url": "https://github.com/service-broker/webclient/issues"
   },
-  "homepage": "https://github.com/service-broker/service-broker-webclient#readme",
+  "homepage": "https://github.com/service-broker/webclient#readme",
   "devDependencies": {
     "typescript": "^5.8.3"
   }

package/src/index.ts

@@ -1,21 +1,24 @@
 
-interface ServiceFilter {
+export interface ServiceSelector {
   name: string
   capabilities?: string[]
 }
 
 export interface ServiceHandler {
-  (request: Message): Message | void | Promise<Message | void>
+  (request: MessageWithHeader): Message | void | Promise<Message | void>
 }
 
-interface MessageWithHeader {
-  header: Record<string, unknown>
-  payload?: string
+type MessageHeader = Record<string, unknown>
+type MessagePayload = string
+
+export interface MessageWithHeader {
+  header: MessageHeader
+  payload?: MessagePayload
 }
 
-interface Message {
-  header?: Record<string, unknown>
-  payload?: string
+export interface Message {
+  header?: MessageHeader
+  payload?: MessagePayload
 }
 
 interface PendingResponse {
@@ -41,12 +44,12 @@ function messageFromString(text: string): MessageWithHeader {
 export class ServiceBroker {
 
   private readonly providers = new Map<string, {
-    advertisedService?: ServiceFilter
+    advertisedService?: ServiceSelector
     handler: ServiceHandler
   }>()
   private ws: WebSocket | null = null
   private readonly connectListeners: Function[] = []
-  private pendingSend: Message[] = []
+  private pendingSend: MessageWithHeader[] = []
   private readonly pendingResponses = new Map<number, PendingResponse>()
   private pendingIdGen = 0
 
@@ -106,7 +109,7 @@ export class ServiceBroker {
   }
 
   private onServiceRequest(msg: MessageWithHeader) {
-    const service = msg.header.service as ServiceFilter
+    const service = msg.header.service as ServiceSelector
     const provider = this.providers.get(service.name)
     if (provider) {
       Promise.resolve(provider.handler(msg))
@@ -137,7 +140,7 @@ export class ServiceBroker {
     }
   }
 
-  private send(header: Message['header'], payload?: Message['payload']) {
+  private send(header: MessageHeader, payload?: MessagePayload) {
     if (!this.ws) {
       this.pendingSend.push({ header, payload })
       return;
@@ -151,16 +154,16 @@ export class ServiceBroker {
   }
 
 
-  request(service: ServiceFilter, req: Message) {
+  request(service: ServiceSelector, req: Message) {
     return this.requestTo(null, service, req);
   }
 
-  requestTo(endpointId: string | null, service: ServiceFilter, req: Message) {
+  requestTo(endpointId: string | null, service: ServiceSelector, req: Message) {
     const id = ++this.pendingIdGen
     const promise = new Promise<Message>((fulfill, reject) => {
       this.pendingResponses.set(id, { fulfill, reject })
     })
-    const header: Message['header'] = {
+    const header: MessageHeader = {
       id: id,
       type: "ServiceRequest",
       service
@@ -170,7 +173,7 @@ export class ServiceBroker {
     return promise;
   }
 
-  advertise(service: ServiceFilter, handler: ServiceHandler) {
+  advertise(service: ServiceSelector, handler: ServiceHandler) {
     if (this.providers.has(service.name)) {
       throw new Error(service.name + " provider already exists")
     }
@@ -214,6 +217,15 @@ export class ServiceBroker {
     return this.unadvertise("#" + topic)
   }
 
+  async status() {
+    const id = ++this.pendingIdGen
+    this.send({ id, type: "SbStatusRequest" })
+    const res = await new Promise<Message>((fulfill, reject) =>
+      this.pendingResponses.set(id, { fulfill, reject })
+    )
+    return JSON.parse(res.payload!)
+  }
+
   isConnected() {
     return this.ws != null
   }

package/tsconfig.json

@@ -1,9 +1,9 @@
 {
   "compilerOptions": {
     "module": "esnext",
-    "target": "es2017",
-    "strict": true,
+    "target": "es2020",
     "moduleResolution": "bundler",
+    "strict": true,
     "declaration": true,
     "newLine": "LF",
     "rootDir": "src",