iosignal 5.2.0 → 6.1.0

package/src/client/IOWS.js

@@ -1,78 +0,0 @@
-import { IOCore } from "./IOCore.js";
-import { SIZE_LIMIT } from "../common/constants.js";
-import { WebSocket } from "ws";
-
-//  Node.js 'ws' websocket
-export class IOWS extends IOCore {
-  constructor(url) {
-    super(url);
-    if (url) this.open();
-  }
-
-
-
-  /**
-   * Closes ws WebSocket and cleans resources.
-   */
-  close() {
-    if (this.socket) {
-      this.socket.removeAllListeners();
-      if (this.socket.readyState !== WebSocket.CLOSED) {
-        this.socket.close();
-      }
-    }
-    super.close();
-  }
-
-  keepConnection() {
-    if (!this.autoReconnect) return;
-    // Reconnect only if the socket is closed and the state reflects that.
-    if ((!this.socket || this.socket.readyState === WebSocket.CLOSED) ) {
-      this.open();
-    }
-  }
-
-
-
-  createConnection(url) {
-    // node WebSocket
-    this.socket = new WebSocket(url);
-    this.stateChange('connecting','connecting')
-
-    this.socket.onopen = () => {
-      this.socket.on('message', this.onWebSocketMessage.bind(this));
-      this.emit('open');
-    };
-
-    this.socket.onerror = (e) => {
-      this.emit('error', e)
-    }
-
-    this.socket.onclose = () => {
-      this.emit('close');
-    }
-  }
-
-  onWebSocketMessage(data) {
-    this.rxCounter++;
-    this.lastTxRxTime = Date.now();
-    this.rxBytes += data.byteLength
-    this.emit('socket_data', data);
-  }
-
-  socket_send(data) {
-    if (this.socket?.readyState === 1) {
-      this.socket.send(data)
-      this.txCounter++;
-      this.txBytes += data.byteLength
-      this.lastTxRxTime = Date.now();
-    } else {
-      console.log('.')
-    }
-  }
-
-}
-
-
-
-

package/src/client/browser/IOWebSocket.js

@@ -1,202 +0,0 @@
-import {version} from "../../../package.json";
-import { IOCore } from "../IOCore.js";
-import Boho from 'boho'
-import * as constants from '../../common/constants.js'
-
-/**
- * @typedef {import("boho").Boho} Boho
- * @typedef {import("boho").MBP} MBP
- * @typedef {import("boho").Buffer} Buffer
- */
-
-const Buffer = Boho.Buffer
-
-/**
- * Browser WebSocket client extending IOCore.
- * @augments {IOCore}
- */
-export default class IO extends IOCore {
-  /**
-   * The version of the client.
-   * @type {string}
-   */
-  static version = version
-  /**
-   * The binary type for WebSocket messages.
-   * @type {string}
-   */
-  static binaryType = "arraybuffer"
-  /**
-   * The Boho library instance.
-   * @type {Boho}
-   */
-  static Boho = Boho;
-  /**
-   * The MBP (MessagePack-Boho) instance.
-   * @type {MBP}
-   */
-  static MBP = Boho.MBP;
-  /**
-   * The Buffer class from Boho.
-   * @type {Buffer}
-   */
-  static Buffer = Boho.Buffer;
-  /**
-   * Constants used by the client.
-   * @type {object}
-   */
-  static constants = constants
-
-  /**
-   * Tracks the number of IO instances created.
-   * @type {number}
-   */
-  static instanceCount = 0;
-
-  /**
-   * Tracks the number of WebSocket objects created.
-   * @type {number}
-   */
-  static webSocketCount = 0;
-
-
-
-  /**
-   * Creates an instance of IO.
-   * @param {string} url - The WebSocket URL to connect to.
-   */
-  constructor(url) {
-    super(url);
-    IO.instanceCount++;
-    this.boundBrowserVisiblePing = this.browserVisiblePing.bind(this)
-    document.addEventListener('visibilitychange', this.boundBrowserVisiblePing);
-    if (url) this.open();
-  }
-
-  /**
-   * Pings the server when the browser tab becomes visible.
-   */
-  browserVisiblePing() {
-    if (document.visibilityState === 'visible') {
-      this.ping()
-    }
-  }
-
-
-  
-
-  /**
-   * Permanently stops the connection and cleans up its specific resources.
-   * For complete cleanup and to make the instance unusable, use destroy().
-   */
-  stop() {
-    super.stop();
-  }
-
-  /**
-   * Permanently destroys the instance, cleaning up all resources including global event listeners.
-   * The instance will not be usable after this.
-   */
-  destroy() {
-    document.removeEventListener('visibilitychange', this.boundBrowserVisiblePing);
-    super.destroy();
-  }
-
-
-  /**
-   * Keeps the connection alive by re-connecting if closed.
-   */
-  keepConnection() {
-    if (!this.autoReconnect) return;
-    // Reconnect only if the socket is closed and the state reflects that.
-    if ((!this.socket || this.socket.readyState === WebSocket.CLOSED) ) {
-      this.open();
-    }
-  }
-
-
-
-  /**
-   * Creates a new WebSocket connection.
-   * @param {string} url - The WebSocket URL to connect to.
-   */
-  createConnection(url) {
-    // Web Browser WebSocket
-    IO.webSocketCount++;
-    this.socket = new WebSocket(url);
-    this.socket.binaryType = IO.binaryType
-
-    this.stateChange('connecting','connecting')
-
-    this.socket.onopen = () => {
-
-      if (!this.socket) {
-        return;
-      }
-
-      if (this.socket.binaryType == "arraybuffer") {
-        this.socket.onmessage = this.onWebSocketMessage.bind(this);
-      } else {  // blob
-        this.socket.onmessage = this.onWebSocketMessageBlob.bind(this);
-      }
-      this.emit('open');
-    };
-
-    this.socket.onerror = (e) => {
-      this.emit('error', e)
-    }
-
-    this.socket.onclose = () => {
-      this.emit('close');
-    }
-  }
-
-  /**
-   * Handles incoming WebSocket messages (arraybuffer type).
-   * @param {MessageEvent} event - The WebSocket message event.
-   */
-  onWebSocketMessage(event) {
-    // event.data is arrayBuffer  or text_message
-    this.rxCounter++;
-    this.lastTxRxTime = Date.now();
-    let buffer = Buffer.from(event.data)
-    this.rxBytes += buffer.byteLength
-    this.emit('socket_data', buffer);
-  }
-
-  /**
-   * Handles incoming WebSocket messages (blob type).
-   * @param {MessageEvent} event - The WebSocket message event.
-   */
-  async onWebSocketMessageBlob(event) {
-    // event.data is Blob or text_message
-    this.rxCounter++;
-    this.lastTxRxTime = Date.now();
-    let buffer;
-    if (event.data instanceof Blob) {
-      let ab = await event.data.arrayBuffer()
-      buffer = Buffer.from(ab)
-    } else {
-      buffer = Buffer.from(event.data)
-    }
-    this.rxBytes += buffer.byteLength
-    this.emit('socket_data', buffer);
-  }
-
-  /**
-   * Sends data over the WebSocket.
-   * @param {BufferSource} data - The data to send.
-   */
-  socket_send(data) {
-    if (this.socket?.readyState === 1) {
-      this.socket.send(data)
-      this.txCounter++;
-      this.txBytes += data.byteLength
-      this.lastTxRxTime = Date.now();
-    } else {
-      console.log('.')
-    }
-  }
-
-}
-

package/src/common/constants.js

@@ -1,210 +0,0 @@
-
-/**
- * @typedef {object} STATE
- * @property {number} CONNECTING
- * @property {number} OPEN
- * @property {number} SERVER_READY
- * @property {number} AUTH_REQ
- * @property {number} AUTH_RES
- * @property {number} AUTH_FAIL
- * @property {number} AUTH_CLEAR
- * @property {number} CID_REQ
- * @property {number} CID_RES
- * @property {number} READY
- * @property {number} CLOSING
- * @property {number} CLOSED
- * @property {number} STOP
- * @property {number} REDIRECTING
- */
-// Client STATE: name and number
-export const STATE = {
-  CONNECTING:    0,
-  OPEN:          1,
-  SERVER_READY: 10,
-  AUTH_REQ:     11,
-  AUTH_RES:     12,
-  AUTH_FAIL:    13,
-  AUTH_CLEAR:   14,
-
-  CID_REQ:      17,
-  CID_RES:      18,
-  READY:        19,
-  CLOSING:       2,
-  CLOSED:        3,
-  STOP:          4,
-  REDIRECTING:   5
-}
-for (let c in STATE) { STATE[STATE[c]] = c }
-
-
-/**
- * @typedef {object} ENC_MODE
- * @property {number} NO
- * @property {number} YES
- * @property {number} AUTO
- */
-export let ENC_MODE = {
-  NO: 0,
-  YES: 1,
-  AUTO: 2
-}
-
-for (let c in ENC_MODE) { ENC_MODE[ENC_MODE[c]] = c }
-
-
-/**
- * @typedef {object} SIZE_LIMIT
- * @property {number} TAG_LEN1
- * @property {number} TAG_LEN2
- * @property {number} CONNECTION_CHECKER_PERIOD
- * @property {number} CLIENT_PING_PERIOD
- * @property {number} PROMISE_TIMEOUT
- * @property {number} DID
- * @property {number} CID
- */
-export const SIZE_LIMIT = {
-  TAG_LEN1: 255,
-  TAG_LEN2: 65535,
-  CONNECTION_CHECKER_PERIOD: 3000,
-  CLIENT_PING_PERIOD: 40000,
-  PROMISE_TIMEOUT: 5000,
-  DID: 8,
-  CID: 12
-}
-
-/**
- * @typedef {object} PAYLOAD_TYPE
- * @property {number} EMPTY
- * @property {number} TEXT
- * @property {number} BINARY
- * @property {number} OBJECT
- * @property {number} MJSON
- * @property {number} MBA
- */
-export let PAYLOAD_TYPE = {
-  EMPTY: 0,
-  TEXT: 1,
-  BINARY: 2,
-  OBJECT: 3, // one stringifiable object. it's string.
-  MJSON: 4, // multiple stringifiable obejct. it's top-level array JSON string.
-  MBA: 5  // "meta_buffer_arguments" arbitary types.  it's meta-buffer-pack.
-}
-for (let c in PAYLOAD_TYPE) { PAYLOAD_TYPE[PAYLOAD_TYPE[c]] = c }
-
-
-/**
- * @typedef {object} IOMsg
- * @property {number} SERVER_READY
- * @property {number} CID_REQ
- * @property {number} CID_RES
- * @property {number} QUOTA_LEVEL
- * @property {number} AUTH_CLEAR
- * @property {number} SERVER_REDIRECT
- * @property {number} LOOP
- * @property {number} ECHO
- * @property {number} PING
- * @property {number} PONG
- * @property {number} CLOSE
- * @property {number} SIGNAL
- * @property {number} SIGNAL_REQ
- * @property {number} SIGNAL_E2E
- * @property {number} SUBSCRIBE
- * @property {number} SUBSCRIBE_REQ
- * @property {number} UNSUBSCRIBE
- * @property {number} SERVER_SIGNAL
- * @property {number} IAM
- * @property {number} IAM_RES
- * @property {number} SET
- * @property {number} RESPONSE_CODE
- * @property {number} RESPONSE_MBP
- * @property {number} CALL
- * @property {number} RESPONSE
- * @property {number} FLOW_MODE
- * @property {number} WAIT
- * @property {number} RESUME
- * @property {number} TIME_OUT
- * @property {number} OVER_SIZE
- * @property {number} OVER_FLOW
- */
-// IO message's one-byte headers.
-export let IOMsg = {
-
-  /* 
-  * 0~127dec.  reserved. for text stream.
-  * 0~31: control code
-  * 32~126: ascii charactor
-  * 127: DEL
-  */
-
-  // ADMIN_REQ: 0xA0,
-
-  // DO NOT USE: 0xB0~ 0xBF
-  // Boho module using this numbers.
-
-  // reserved ~0xBF
-
-  // C. IO status contorl.
-  SERVER_READY: 0xC0,
-  CID_REQ: 0xC1,
-  CID_RES: 0xC2,
-  QUOTA_LEVEL: 0xC3,
-  AUTH_CLEAR: 0xC4,
-  SERVER_REDIRECT: 0xC5,
-  // ..
-  LOOP: 0xCB,
-  ECHO: 0xCC,
-  PING: 0xCD,
-  PONG: 0xCE,
-  CLOSE: 0xCF,
-  // ~CF
-
-
-  // D. IO data signaling
-  SIGNAL: 0xD0,
-  SIGNAL_REQ: 0xD1,
-  SIGNAL_E2E: 0xD2,
-  SUBSCRIBE: 0xD3,
-  SUBSCRIBE_REQ: 0xD4,
-  UNSUBSCRIBE: 0xD5,
-  SERVER_SIGNAL: 0xD6,
-
-  // ..
-  IAM: 0xD9,
-  IAM_RES: 0xDA,
-
-  //.. 
-  SET: 0xDB,   //
-  // RESPONSE_CODE: 0xDC,
-  RESPONSE_MBP: 0xDD,
-  CALL: 0xDE, // rpc call
-  // RESPONSE: 0xDF,
-  // ~DF
-
-
-  // F. Framing Flow control related framing protocol.(CongPacket)
-  FLOW_MODE: 0xF0,
-  WAIT: 0xF1,
-  RESUME: 0xF2,
-  //..
-  TIME_OUT: 0xFD,
-  OVER_SIZE: 0xFE,
-  OVER_FLOW: 0xFF
-
-}
-
-for (let c in IOMsg) { IOMsg[IOMsg[c]] = c }
-// console.log( IOMsg );
-
-
-/**
- * @typedef {object} STATUS
- * @property {number} OK
- * @property {number} ERROR
- */
-// service response status code
-export const STATUS = {
-  OK: 0,
-  //0~127: success
-  //128~255: fail
-  ERROR: 255
-}

package/src/common/payload.js

@@ -1,82 +0,0 @@
-import MBP from 'meta-buffer-pack'
-import { PAYLOAD_TYPE, IOMsg } from "./constants.js";
-const encoder = new TextEncoder()
-
-
-export function getSignalPack(tag, ...args) {
-  if (typeof tag !== 'string') throw TypeError('tag should be string.')
-  let tagEncoded = encoder.encode(tag)
-  let payload = parsePayload(args)
-
-  let sigPack;
-  if (payload.type == PAYLOAD_TYPE.EMPTY) {
-    sigPack = MBP.pack(
-      MBP.MB('#MsgType', '8', IOMsg.SIGNAL),
-      MBP.MB('#tagLen', '8', tagEncoded.byteLength),
-      MBP.MB('#tag', tagEncoded),
-      MBP.MB('#payloadType', '8', payload.type)
-    )
-  } else if (payload.type == PAYLOAD_TYPE.MBA) {
-    let mbaBuffer = MBP.pack(MBP.MBA(...args))
-    sigPack = MBP.pack(
-      MBP.MB('#MsgType', '8', IOMsg.SIGNAL),
-      MBP.MB('#tagLen', '8', tagEncoded.byteLength),
-      MBP.MB('#tag', tagEncoded),
-      MBP.MB('#payloadType', '8', payload.type),
-      MBP.MB('#mbaBuffer', mbaBuffer)
-    )
-  } else {
-    sigPack = MBP.pack(
-      MBP.MB('#MsgType', '8', IOMsg.SIGNAL),
-      MBP.MB('#tagLen', '8', tagEncoded.byteLength),
-      MBP.MB('#tag', tagEncoded),
-      MBP.MB('#payloadType', '8', payload.type),
-      MBP.MB('#payload', payload.buffer)
-    )
-  }
-  return sigPack
-}
-
-
-export function parsePayload(args) {
-  let type, pack;
-  if (args.length == 0) {
-    type = PAYLOAD_TYPE.EMPTY
-    pack = null
-  } else if (args.length == 1) {
-    if (typeof args[0] === 'string' || typeof args[0] === 'number') {
-      type = PAYLOAD_TYPE.TEXT
-      pack = encoder.encode(args[0] + ".") // add null byte area.
-      pack[pack.byteLength - 1] = 0 // set byte-zero : '\0'  in C/C++
-
-    } else if (ArrayBuffer.isView(args[0]) || args[0] instanceof ArrayBuffer) {
-      type = PAYLOAD_TYPE.BINARY
-      pack = MBP.B8(args[0])
-    } else if (typeof args[0] === 'object') {
-      type = PAYLOAD_TYPE.OBJECT
-      pack = encoder.encode(JSON.stringify(args[0]))
-    } else {
-      throw new Error('unknown payload arguments')
-    }
-  } else { // two or more arguments.
-    let containsBuffer = false
-    args.forEach(item => {
-      if (ArrayBuffer.isView(item) || item instanceof ArrayBuffer) containsBuffer = true;
-    })
-
-    if (containsBuffer) {
-      type = PAYLOAD_TYPE.MBA;
-    } else {
-      type = PAYLOAD_TYPE.MJSON;
-      pack = encoder.encode(JSON.stringify(args))
-    }
-
-  }
-
-  return { type: type, buffer: pack }
-}
-
-export function getPayloadFromSignalPack(signalPack) {
-  let tagLen = signalPack.readUint8(1)
-  return signalPack.subarray(3 + tagLen)
-}

package/src/common/quotaTable.js

@@ -1,68 +0,0 @@
-// table index related with:
-// - AUTH database level
-// - serverOption.defaultQuotaIndex
-
-// quota example
-// index range: 0~255.
-export let quotaTable = {
-  // CongSocket
-  0: { // default. anonymouse:
-    signalSize: 1500,
-    publishCounter: 10,
-    trafficRate: 10000
-  },
-  1: { // auth_ultralight:  eg. Arduino Uno.
-    signalSize: 255,
-    publishCounter: 10,
-    trafficRate: 100000
-  },
-  2: { // auth_light:  eg. authorized ESP.
-    signalSize: 65535,
-    publishCounter: 10,
-    trafficRate: 1048576
-  },
-
-  // WebSocket (browser and node app)
-  3: { // authorized basic.
-    signalSize: 1048576,
-    publishCounter: 10,
-    trafficRate: 1048576 * 20
-  },
-
-  // WebSocket (browser and node app)
-  10: { //  anonymouse
-    signalSize: 1500,
-    publishCounter: 5,
-    trafficRate: 1048576 * 20
-  },
-
-  11: { // authorized basic.
-    signalSize: 65535,
-    publishCounter: 10,
-    trafficRate: 1048576 * 20
-  },
-
-  12: { // authorized power.
-    signalSize: 1048576,
-    publishCounter: 100,
-    trafficRate: 1048576 * 20
-  },
-
-  // you can add your custom quota levels.
-
-  // Remote service node
-  // High Quota, No root permission.
-  200: {
-    signalSize: 1048576 * 20,
-    publishCounter: 10000,
-    trafficRate: 1048576 * 100
-  },
-  // super admin or root user.
-  // to monitor, metric, sudo command, db access.
-  255: {
-    signalSize: 1048576 * 20,
-    publishCounter: 10000,
-    trafficRate: 1048576 * 100
-  }
-}
-

package/src/common/util.js

@@ -1,64 +0,0 @@
-import { networkInterfaces } from 'os';
-
-export function isPrivateIP(ip) {
-  if (ip.indexOf("0.0.0.0") === 0) return true
-  if (ip.indexOf("127.0.0.1") === 0) return true
-  if (ip.indexOf("192.168.") === 0) return true
-  if (ip.indexOf("10.") === 0) return true
-  if (ip.indexOf("172.") === 0) {
-    if (ip.indexOf("172.16.") === 0) return true
-    if (ip.indexOf("172.17.") === 0) return true
-    if (ip.indexOf("172.18.") === 0) return true
-    if (ip.indexOf("172.19.") === 0) return true
-    if (ip.indexOf("172.20.") === 0) return true
-    if (ip.indexOf("172.21.") === 0) return true
-    if (ip.indexOf("172.22.") === 0) return true
-    if (ip.indexOf("172.23.") === 0) return true
-    if (ip.indexOf("172.24.") === 0) return true
-    if (ip.indexOf("172.25.") === 0) return true
-    if (ip.indexOf("172.26.") === 0) return true
-    if (ip.indexOf("172.27.") === 0) return true
-    if (ip.indexOf("172.28.") === 0) return true
-    if (ip.indexOf("172.29.") === 0) return true
-    if (ip.indexOf("172.30.") === 0) return true
-    if (ip.indexOf("172.31.") === 0) return true
-  }
-
-  return false
-}
-
-export function numberWithCommas(x) {
-  return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',')
-}
-
-export function getIPv4HexString(ipStr) {
-  let ipv4 = ipStr.split('.')
-  return Buffer.from(ipv4).toString('hex')
-}
-
-export function getLocalAddress() {
-  const nets = networkInterfaces();
-  // console.log(nets)
-  const results = Object.create(null); // Or just '{}', an empty object
-  let localAddress = ''
-  for (const name of Object.keys(nets)) {
-    for (const net of nets[name]) {
-      // Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses
-      // 'IPv4' is in Node <= 17, from 18 it's a number 4 or 6
-      const familyV4Value = typeof net.family === 'string' ? 'IPv4' : 4
-      if (net.family === familyV4Value && !net.internal) {
-        if (!results[name]) {
-          results[name] = [];
-        }
-        results[name].push(net.address);
-        localAddress = net.address
-      }
-    }
-  }
-
-  // console.log('localAddress:', localAddress)
-  return localAddress
-}
-
-
-export const delay = ms => new Promise(resolve => setTimeout(resolve, ms));