secure-channel — API

ChannelMessageType

src/index.ts

export type ChannelMessageType =
  | 'request'
  | 'response'
  | 'event'
  | 'command'
  | 'command-result'

ChannelMessage

src/index.ts

export interface ChannelMessage {
  type: ChannelMessageType
  id?: string
  route?: string
  expectReply?: boolean
  statusCode?: number
  headers?: Record<string, string>
  payload?: any
  error?: string
}

SecureChannelClientOptions

src/index.ts

export interface SecureChannelClientOptions {
  url: string
  serviceId: string
  certificate: string // PEM
  privateKey: string // PEM
  caCertificate?: string // PEM
  reconnectDelayMs?: number
  requestTimeoutMs?: number
  maxSkewMs?: number
  nonceTtlMs?: number
  nonceCacheSize?: number
}

RequestOptions

src/index.ts

export interface RequestOptions {
  route: string
  payload?: any
  expectReply?: boolean
  headers?: Record<string, string>
  timeoutMs?: number
}

SecureChannelServerOptions

src/index.ts

export interface SecureChannelServerOptions {
  wss: WebSocketServer
  verifyClient?: (peerCert: any) => boolean
  onRequest: (route: string, payload: any, raw: ChannelMessage, ws?: any) => Promise<any>
  maxSkewMs?: number
  nonceTtlMs?: number
  nonceCacheSize?: number
}

bindSecureChannelServer

src/index.ts

export function bindSecureChannelServer(options: SecureChannelServerOptions): void