bare-rpc 1.0.0 → 1.2.0

package/index.d.ts

@@ -1,11 +1,5 @@
 import Buffer, { BufferEncoding } from 'bare-buffer'
-import {
-  Readable,
-  ReadableOptions,
-  Writable,
-  WritableOptions,
-  Duplex
-} from 'bare-stream'
+import { Readable, ReadableOptions, Writable, WritableOptions, Duplex } from 'bare-stream'
 
 declare const constants: {
   type: { REQUEST: 1; RESPONSE: 2; STREAM: 3 }
@@ -23,6 +17,16 @@ declare const constants: {
   }
 }
 
+interface RPCIncomingEvent {
+  readonly rpc: RPC
+  readonly command: number
+  readonly data: Buffer | null
+}
+
+declare class RPCIncomingEvent {
+  constructor(rpc: RPC, command: number, data: Buffer)
+}
+
 interface RPCIncomingRequest {
   readonly rpc: RPC
   readonly id: number
@@ -41,6 +45,18 @@ declare class RPCIncomingRequest {
   constructor(rpc: RPC, id: number, command: number, data: Buffer)
 }
 
+interface RPCOutgoingEvent {
+  readonly rpc: RPC
+  readonly command: number
+  readonly sent: boolean
+
+  send(data?: Buffer | string | null, encoding?: BufferEncoding): void
+}
+
+declare class RPCOutgoingEvent {
+  constructor(rpc: RPC, command: number)
+}
+
 interface RPCOutgoingRequest {
   readonly rpc: RPC
   readonly id: number
@@ -57,7 +73,7 @@ interface RPCOutgoingRequest {
 }
 
 declare class RPCOutgoingRequest {
-  constructor(rpc: RPC, command: number)
+  constructor(rpc: RPC, id: number, command: number)
 }
 
 declare class RPCIncomingStream extends Readable {
@@ -79,18 +95,18 @@ declare class RPCOutgoingStream extends Writable {
 }
 
 interface RPC {
+  event(command: number): RPCOutgoingEvent
   request(command: number): RPCOutgoingRequest
 }
 
 declare class RPC {
-  constructor(
-    stream: Duplex,
-    onrequest: (req: RPCIncomingRequest) => void | Promise<void>
-  )
+  constructor(stream: Duplex, onrequest: (req: RPCIncomingRequest) => void | Promise<void>)
 }
 
 declare namespace RPC {
   export {
+    type RPCIncomingEvent as IncomingEvent,
+    type RPCOutgoingEvent as OutgoingEvent,
     type RPCIncomingRequest as IncomingRequest,
     type RPCOutgoingRequest as OutgoingRequest,
     type RPCIncomingStream as IncomingStream,

package/index.js

@@ -3,8 +3,10 @@ const b4a = require('b4a')
 const c = require('compact-encoding')
 const m = require('./lib/messages')
 const { type: t, stream: s } = require('./lib/constants')
+const IncomingEvent = require('./lib/incoming-event')
 const IncomingRequest = require('./lib/incoming-request')
 const IncomingStream = require('./lib/incoming-stream')
+const OutgoingEvent = require('./lib/outgoing-event')
 const OutgoingRequest = require('./lib/outgoing-request')
 const OutgoingStream = require('./lib/outgoing-stream')
 const CommandRouter = require('./lib/command-router')
@@ -37,10 +39,11 @@ module.exports = exports = class RPC {
     this._ondata = this._ondata.bind(this)
     this._ondrain = this._ondrain.bind(this)
 
-    this._stream
-      .on('error', this._onerror)
-      .on('data', this._ondata)
-      .on('drain', this._ondrain)
+    this._stream.on('error', this._onerror).on('data', this._ondata).on('drain', this._ondrain)
+  }
+
+  event(command) {
+    return new OutgoingEvent(this, command)
   }
 
   request(command) {
@@ -60,6 +63,16 @@ module.exports = exports = class RPC {
     }
   }
 
+  _sendEvent(request, data = null) {
+    this._sendMessage({
+      type: t.REQUEST,
+      id: 0,
+      command: request.command,
+      stream: 0,
+      data
+    })
+  }
+
   _sendRequest(request, data = null) {
     this._outgoingRequests.set(request.id, request)
 
@@ -76,25 +89,13 @@ module.exports = exports = class RPC {
     if (isInitiator) {
       this._outgoingRequests.set(request.id, request)
 
-      request._requestStream = new OutgoingStream(
-        this,
-        request,
-        t.REQUEST,
-        opts
-      )
+      request._requestStream = new OutgoingStream(this, request, t.REQUEST, opts)
     } else {
       this._incomingRequests.set(request.id, request)
 
-      request._requestStream = new IncomingStream(
-        this,
-        request,
-        t.REQUEST,
-        opts
-      )
+      request._requestStream = new IncomingStream(this, request, t.REQUEST, opts)
 
-      request._requestStream.on('close', () =>
-        this._incomingRequests.delete(request.id)
-      )
+      request._requestStream.on('close', () => this._incomingRequests.delete(request.id))
     }
   }
 
@@ -112,25 +113,13 @@ module.exports = exports = class RPC {
     if (isInitiator) {
       this._outgoingResponses.set(request.id, request)
 
-      request._responseStream = new OutgoingStream(
-        this,
-        request,
-        t.RESPONSE,
-        opts
-      )
+      request._responseStream = new OutgoingStream(this, request, t.RESPONSE, opts)
     } else {
       this._incomingResponses.set(request.id, request)
 
-      request._responseStream = new IncomingStream(
-        this,
-        request,
-        t.RESPONSE,
-        opts
-      )
+      request._responseStream = new IncomingStream(this, request, t.RESPONSE, opts)
 
-      request._responseStream.on('close', () =>
-        this._incomingResponses.delete(request.id)
-      )
+      request._responseStream.on('close', () => this._incomingResponses.delete(request.id))
     }
   }
 
@@ -164,8 +153,7 @@ module.exports = exports = class RPC {
   _onbeforeframe() {
     if (this._buffered < 4) return
 
-    const buffer =
-      this._buffer.length === 1 ? this._buffer[0] : b4a.concat(this._buffer)
+    const buffer = this._buffer.length === 1 ? this._buffer[0] : b4a.concat(this._buffer)
 
     this._buffer = [buffer]
     this._frame = 4 + c.uint32.decode(c.state(0, 4, buffer))
@@ -176,8 +164,7 @@ module.exports = exports = class RPC {
   _onafterframe() {
     if (this._buffered < this._frame) return
 
-    const buffer =
-      this._buffer.length === 1 ? this._buffer[0] : b4a.concat(this._buffer)
+    const buffer = this._buffer.length === 1 ? this._buffer[0] : b4a.concat(this._buffer)
 
     const frame = this._frame
 
@@ -201,19 +188,18 @@ module.exports = exports = class RPC {
 
     switch (message.type) {
       case t.REQUEST:
-        const request = new IncomingRequest(
-          this,
-          message.id,
-          message.command,
-          message.data
-        )
+        const request =
+          message.id === 0
+            ? new IncomingEvent(this, message.command, message.data)
+            : new IncomingRequest(this, message.id, message.command, message.data)
 
         try {
           await this._onrequest(request)
         } catch (err) {
           safetyCatch(err)
 
-          this._sendError(request, err)
+          if (message.id) this._sendError(request, err)
+          else this._stream.destroy(err)
         }
         break
       case t.RESPONSE:

package/lib/incoming-event.js

@@ -0,0 +1,7 @@
+module.exports = class RPCIncomingEvent {
+  constructor(rpc, command, data) {
+    this.rpc = rpc
+    this.command = command
+    this.data = data
+  }
+}

package/lib/messages.js

@@ -95,10 +95,7 @@ exports.header = {
 
     state.start = frame
 
-    c.uint32.encode(
-      state,
-      end - start + (hasData && m.data ? m.data.byteLength : 0)
-    )
+    c.uint32.encode(state, end - start + (hasData && m.data ? m.data.byteLength : 0))
 
     state.start = end
   }

package/lib/outgoing-event.js

@@ -0,0 +1,27 @@
+const c = require('compact-encoding')
+const errors = require('./errors')
+
+module.exports = class RPCOutgoingEvent {
+  constructor(rpc, command) {
+    this.rpc = rpc
+    this.command = command
+    this.sent = false
+  }
+
+  send(data, encoding) {
+    if (this.sent) {
+      throw errors.ALREADY_SENT('Event has already been sent')
+    }
+
+    encoding =
+      encoding && encoding !== 'buffer'
+        ? c.from(encoding)
+        : typeof data === 'string'
+          ? c.raw.utf8
+          : null
+
+    this.sent = true
+
+    this.rpc._sendEvent(this, encoding ? c.encode(encoding, data) : data)
+  }
+}

package/lib/outgoing-request.js

@@ -44,9 +44,7 @@ module.exports = class RPCOutgoingRequest {
 
     this.received = true
 
-    return encoding
-      ? this._promise.then((data) => c.decode(encoding, data))
-      : this._promise
+    return encoding ? this._promise.then((data) => c.decode(encoding, data)) : this._promise
   }
 
   createRequestStream(opts = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-rpc",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "librpc ABI compatible RPC for Bare",
   "exports": {
     ".": {
@@ -11,7 +11,8 @@
     "./errors": {
       "types": "./lib/errors.d.ts",
       "default": "./lib/errors.js"
-    }
+    },
+    "./messages": "./lib/messages.js"
   },
   "files": [
     "index.js",
@@ -19,7 +20,8 @@
     "lib"
   ],
   "scripts": {
-    "test": "prettier . --check && bare test.js"
+    "test": "prettier . --check && bare test.js",
+    "format": "prettier --write ."
   },
   "repository": {
     "type": "git",
@@ -42,7 +44,7 @@
     "bare-ipc": "^1.1.0",
     "brittle": "^3.2.1",
     "prettier": "^3.4.2",
-    "prettier-config-standard": "^7.0.0"
+    "prettier-config-holepunch": "^2.0.0"
   },
   "peerDependencies": {
     "bare-buffer": "*"