iosignal 5.2.0 → 6.1.0

package/dist/types/client/IOCore.d.ts

@@ -77,7 +77,7 @@ export class IOCore {
      * @type {Boho}
      */
     boho: Boho;
-    serverTimeNonce: any;
+    serverTimeNonce: import("buffer").Buffer;
     /**
      * Indicates if the connection is TLS (wss).
      * @type {boolean}
@@ -319,8 +319,8 @@ export class IOCore {
      */
     subscribe(tag: string): void;
     /**
-     * Subscribes stored channels.
-     * called client state become 'ready'
+     * Sends subscriptions stored by listen()/link() on each CID-ready transition,
+     * including reconnection. This automates subscription setup for simple clients.
      */
     subscribe_channels(): void;
     /**
@@ -330,7 +330,13 @@ export class IOCore {
      */
     unsubscribe(tag?: string): void;
     /**
-     * Listens for signals on a specific tag.
+     * Convenience API for simple clients (for example, CLI tools): register a
+     * tag handler once and remember its subscription in channels. Register before
+     * connection readiness; the CID-ready flow subscribes on initial connection
+     * and again after reconnect, without application-level ready/subscribe code.
+     * This does not send a subscription immediately, even if already ready.
+     * For precise subscription/send ordering or dynamic subscriptions, use
+     * on() with subscribe() in a ready handler instead. Direct signals use on('@').
      * @param {string} tag - The tag to listen on.
      * @param {Function} handler - The callback function to handle the signal.
      * @throws {TypeError} If tag is not a string, handler is not a function, or tag length is invalid.
@@ -408,5 +414,5 @@ export type SIZE_LIMIT = import("../common/constants.js").SIZE_LIMIT;
 export type ENC_MODE = import("../common/constants.js").ENC_MODE;
 export type STATE = import("../common/constants.js").STATE;
 export type quotaTable = any;
-export type Boho = import("boho").Boho;
 export type Buffer = import("boho").Buffer;
+import Boho from "boho";

package/dist/types/client/browser/IOWebSocket.d.ts

@@ -15,9 +15,9 @@ export default class IO extends IOCore {
     static binaryType: string;
     /**
      * The Boho library instance.
-     * @type {Boho}
+     * @type {typeof Boho}
      */
-    static Boho: Boho;
+    static Boho: typeof Boho;
     /**
      * The MBP (MessagePack-Boho) instance.
      * @type {MBP}
@@ -73,7 +73,7 @@ export default class IO extends IOCore {
      */
     socket_send(data: BufferSource): void;
 }
-export type Boho = import("boho").Boho;
-export type MBP = typeof import("meta-buffer-pack");
+export type MBP = import("boho").MBP;
 export type Buffer = import("boho").Buffer;
 import { IOCore } from "../IOCore.js";
+import Boho from 'boho';

package/dist/types/common/payload.d.ts

@@ -1,6 +1,6 @@
-export function getSignalPack(tag: any, ...args: any[]): Buffer<ArrayBufferLike>;
+export function getSignalPack(tag: any, ...args: any[]): import("buffer").Buffer;
 export function parsePayload(args: any): {
     type: number;
-    buffer: Uint8Array<ArrayBuffer> | Buffer<ArrayBufferLike> | null | undefined;
+    buffer: Uint8Array<ArrayBuffer> | import("buffer").Buffer | null | undefined;
 };
 export function getPayloadFromSignalPack(signalPack: any): any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iosignal",
-  "version": "5.2.0",
+  "version": "6.1.0",
   "description": "iosignal",
   "type": "module",
   "exports": {
@@ -17,7 +17,11 @@
   "unpkg": "./dist/browser/iife/io.js",
   "scripts": {
     "build": "rollup -c && npm run build:types",
-    "build:types": "tsc --project tsconfig.json"
+    "build:types": "tsc --project tsconfig.json",
+    "test": "node --test --test-timeout=15000 checks/*.test.mjs test/integration/*.test.mjs",
+    "verify": "node scripts/verify.mjs",
+    "prepack": "npm run verify",
+    "test:integration": "node --test --test-timeout=15000 test/integration/*.test.mjs"
   },
   "author": {
     "name": "Taeo Lee",
@@ -36,7 +40,7 @@
     "typescript": "^6.0.3"
   },
   "dependencies": {
-    "boho": "^2.1.3",
+    "boho": "^2.2.0",
     "eventemitter3": "^5.0.4",
     "meta-buffer-pack": "^2.1.3",
     "ws": "^8.21.3"
@@ -47,7 +51,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/remocons/iosignal.git",
+    "url": "git+https://github.com/remocons/iosignal.git",
     "directory": "packages/iosignal"
   },
   "keywords": [
@@ -63,5 +67,19 @@
     "iot",
     "arduino",
     "auth"
+  ],
+  "files": [
+    "dist/browser/esm/io.d.ts",
+    "dist/browser/esm/io.js",
+    "dist/browser/esm/io.js.map",
+    "dist/browser/iife/io.js",
+    "dist/browser/iife/io.js.map",
+    "dist/node/iosignal.cjs",
+    "dist/node/iosignal.js",
+    "dist/types/client/IOCore.d.ts",
+    "dist/types/client/browser/IOWebSocket.d.ts",
+    "dist/types/common/constants.d.ts",
+    "dist/types/common/payload.d.ts",
+    "dist/types/common/quotaTable.d.ts"
   ]
 }

package/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-    "liveServer.settings.port": 5501
-}

package/index.js

@@ -1,26 +0,0 @@
-import pkg from './package.json' with { type: 'json' };
-export const version = pkg.version;
-export { IOCongSocket } from './src/client/IOCongSocket.js'
-export { IOWS as IO } from './src/client/IOWS.js'
-export { pack, CongRx } from './src/client/CongPacket.js'
-export { Server } from './src/server/Server.js'
-export { serverOption } from './src/server/serverOption.js'
-export { FileLogger } from './src/server/FileLogger.js'
-export { getSignalPack, parsePayload, getPayloadFromSignalPack } from './src/common/payload.js'
-export * from './src/common/constants.js'
-export * from './src/common/util.js'
-
-// MBP
-export { default as MBP } from 'meta-buffer-pack'
-
-// boho auth
-export { default as Boho} from 'boho'
-export { BohoAuth } from './src/auth/BohoAuth.js'
-export { FileKeyProvider } from './src/auth/key_providers/FileKeyProvider.js'
-export { RedisKeyProvider } from './src/auth/key_providers/RedisKeyProvider.js'
-export { StringKeyProvider } from './src/auth/key_providers/StringKeyProvider.js'
-
-// services
-export * as replyService from './src/services/replyService.js'
-export * as sudoService from './src/services/sudoService.js'
-export { RedisService } from './src/services/RedisService.js'

package/rollup.config.js

@@ -1,59 +0,0 @@
-import resolve from '@rollup/plugin-node-resolve'
-import commonjs from '@rollup/plugin-commonjs'
-import json from '@rollup/plugin-json'
-import terser from '@rollup/plugin-terser'
-import dts from 'rollup-plugin-dts'
-
-export default [
-   {
-    input: './src/client/browser/IOWebSocket.js',
-    output: [
-      {
-        file: './dist/browser/esm/io.js',
-        format: 'es',
-        sourcemap: true,
-      },
-      {
-        file: './dist/browser/iife/io.js',
-        format: 'iife',
-        name: 'IO',
-        sourcemap: true,
-      }
-    ],
-    plugins: [
-      resolve({
-        preferBuiltins: false
-      }),
-      commonjs(),
-      json(),
-      terser() 
-    ]
-  },
-  {
-    input: './src/client/browser/IOWebSocket.js',
-    output: { file: './dist/browser/esm/io.d.ts', format: 'es' },
-    plugins: [dts()]
-  }
-
-  ,{
-    input: './index.js',
-    output: [
-      { 
-        file: './dist/node/iosignal.js',
-        format: 'es' 
-      },
-      {
-        file: "./dist/node/iosignal.cjs",
-        format: 'cjs'
-      }
-    ],
-    plugins: [
-      resolve({
-        preferBuiltins: true
-      }), 
-      json(),      
-      commonjs()
-    ]
-  }
-
-]

package/src/auth/BohoAuth.js

@@ -1,196 +0,0 @@
-import MBP from 'meta-buffer-pack'
-import Boho from 'boho'
-import { quotaTable } from '../common/quotaTable.js'
-import { serverOption } from '../server/serverOption.js'
-import { IOMsg, STATE } from '../common/constants.js'
-import { FileLogger } from '../server/FileLogger.js'
-
-const decoder = new TextDecoder()
-export class BohoAuth {
-  constructor(keyProvider) {
-    if (!keyProvider) {
-      throw new Error('BohoAuth must be initialized with a keyProvider.');
-    }
-    this.keyProvider = keyProvider;
-    this.keepOldConnection = true;
-    this.authLogger;
-    if (serverOption.fileLogger.auth.use) {
-      this.authLogger = new FileLogger(serverOption.fileLogger.auth.path)
-      console.log('Auth: begin file logger.[auth]')
-    }
-  }
-
-  send_auth_fail(peer, reason) {
-    if (this.authLogger) {
-      let peerInfo = `FAIL #${peer.ssid} reason:${reason} `
-      this.authLogger.log(peerInfo)
-    }
-    // console.log('##### AUTH_FAIL reason: ', reason)
-    peer.setState(STATE.AUTH_FAIL)
-    // add some delay time.
-    setTimeout(e => {
-      peer.send(Buffer.from([Boho.BohoMsg.AUTH_FAIL]))
-    }, serverOption.auth.delay_auth_fail)
-  }
-
-
-  async verify_auth_req(auth_req, peer) {
-    try {
-      //1. unpack 
-      let infoPack = MBP.unpack(auth_req, Boho.Meta.AUTH_REQ)
-      if (!infoPack) {
-        this.send_auth_fail(peer, 'unpack auth_pack fail');
-        return
-      }
-
-      let id = ""
-      if (infoPack.id8.includes(0)) {
-        id = decoder.decode(infoPack.id8.subarray(0, infoPack.id8.indexOf(0)));
-      } else {
-        id = decoder.decode(infoPack.id8);
-      }
-
-      //2. get key of id from DB
-      let authInfo = await this.keyProvider.getAuth(id)
-      if (!authInfo) {
-        this.send_auth_fail(peer, 'NO ID:' + id);
-        return
-      }
-
-      if (serverOption.debug.showAuthInfo) {
-        console.log('[debug]showAuthInfo', authInfo)
-      }
-
-      peer.boho.copy_id8(infoPack.id8)
-      // type of key
-      let authKey;
-      const SHA256_HASH_BASE64_LEN = 44
-      if (authInfo.key.length == SHA256_HASH_BASE64_LEN) {
-        // hashed key
-        authKey = Buffer.from(authInfo.key, 'base64')
-        peer.boho.copy_key(authKey)
-      } else {
-        // plain key
-        peer.boho.set_key(authInfo.key)
-      }
-
-      //3. check hmac
-      let auth_res = peer.boho.verify_auth_req(infoPack)
-      if (!auth_res) {
-        this.send_auth_fail(peer, 'hmac dismatched');
-        return
-      }
-
-      //4. get info
-
-      //5. check duplicate login.
-      if (peer.manager.cid2remote.has(authInfo.cid)) {
-        let old = peer.manager.cid2remote.get(authInfo.cid)
-        console.log('[WARN]DUPLICATE_LOGIN detected.', old.cid)
-        old.ping(); // check the connection.
-        if (old == peer) {
-          console.log('## trying to RELOGIN after login.')
-          return
-        }
-
-        let authClearSignal = MBP.pack(
-          MBP.MB('#MsgType', '8', IOMsg.AUTH_CLEAR),
-          MBP.MB('#reason', 'duplicate login.')
-        )
-        if (this.keepOldConnection) { // default true
-          // keep old connection. reject new connection by sending auth_fail signal.
-          // peer.send(authClearSignal)
-          if( peer.socketType == 'websocket'){
-            this.send_auth_fail(peer, 'duplicate login')
-          }else{
-            peer.close(); //arduino 
-          }
-        } else {
-          // accept new connection. stop the old connection by sending auth_clear signal.
-          old.send(authClearSignal)
-          peer.close()
-        }
-        return
-      }
-
-      //6. delete current (or anonymouse)cid if exist.
-      if (peer.cid) {
-        // console.log('if peer has cid', peer.cid)
-        peer.manager.cid2remote.delete(peer.cid)
-      }
-
-      //7. setting info.
-      peer.did = id
-      peer.cid = authInfo.cid
-      peer.nick = authInfo.cid // temporary: nick as cid
-      if (authInfo.uid) peer.uid = authInfo.uid
-
-      //8. setting quota level. 
-      let quotaLevel = serverOption.defaultQuotaIndex;
-      if (authInfo.level) quotaLevel = authInfo.level;
-      quotaLevel = parseInt(quotaLevel)
-      let newQuota = quotaTable[quotaLevel];
-      if (!newQuota) {
-        let err = 'no index quotaTable for auth.level: ' + quotaLevel
-        this.send_auth_fail(peer, err);
-        return
-      } else {
-        peer.level = quotaLevel;
-        peer.quota = newQuota;
-      }
-
-      if (peer.level === serverOption.adminLevel) {
-        console.log('## LOGIN ADMIN CID:', peer.cid)
-        peer.isAdmin = true;
-      }
-      // send quota.level
-      peer.send(Buffer.from([IOMsg.QUOTA_LEVEL, quotaLevel]))
-
-      //9. set cid2remote
-      peer.manager.cid2remote.set(peer.cid, peer)
-      //10. send ack.
-      peer.send(auth_res)
-      peer.setState(STATE.AUTH_RES)
-      if (this.authLogger) {
-        let peerInfo = `OK #${peer.ssid} cid: ${peer.cid} did:${peer.did}`
-        if (peer.isAdmin) peerInfo = "#ADMIN# " + peerInfo
-        this.authLogger.log(peerInfo)
-      }
-      return authInfo
-    } catch (error) {
-      console.log('verify_auth_req error', error)
-      this.send_auth_fail(peer, '[BohoAuth]caught: unknown error:' + error);
-    }
-  }
-
-  async getAuth(id) {
-    return this.keyProvider.getAuth(id);
-  }
-
-  async getAuthIdList() {
-    if (typeof this.keyProvider.getAuthIdList === 'function') {
-      return this.keyProvider.getAuthIdList();
-    }
-  }
-
-  async addAuth(id, keyStr, cid, level = 0) {
-    if (typeof this.keyProvider.addAuth === 'function') {
-      return this.keyProvider.addAuth(id, keyStr, cid, level);
-    }
-  }
-
-  async delAuth(id) {
-    if (typeof this.keyProvider.delAuth === 'function') {
-      return this.keyProvider.delAuth(id);
-    }
-  }
-
-  async save() {
-    if (typeof this.keyProvider.save === 'function') {
-      return this.keyProvider.save();
-    }
-  }
-
-
-}
-

package/src/auth/key_providers/FileKeyProvider.js

@@ -1,59 +0,0 @@
-import { readFileSync } from 'fs'
-import Boho from 'boho'
-import path from 'path'
-
-export class FileKeyProvider {
-  constructor(_path) {
-    this.AUTH = new Map();
-    let pathObj = path.parse(_path)
-    this.path = path.resolve(_path)
-    console.log('auth from file path:', this.path)
-    let ext = pathObj.ext;
-    if (ext.toLowerCase() == '.js') {
-      // Read auth data from file
-      console.log("#JS path:", this.path);
-      this.loadAuthInfoFile_JS(this.path)
-    } else if (ext.toLowerCase() == '.json') {
-      console.log("#JSON path:", this.path);
-      this.loadAuthInfoFile_JSON(this.path)
-    } else {
-      console.log('no authinfofile path.')
-    }
-  }
-
-  //loaded when server start.
-  loadAuthInfoFile_JS(path) {
-    import(path).then((file) => {
-      console.log(file.authInfo);
-      file.authInfo.forEach(item => {
-        this.addAuth(...item)
-      })
-      console.log('total AUTH INFO size: ', this.AUTH.size)
-    }).catch(e => {
-      console.log(e)
-    })
-  }
-
-  loadAuthInfoFile_JSON(path) {
-    let file = readFileSync(path)
-    file = new TextDecoder().decode(file)
-    let list = JSON.parse(file)
-    list.forEach(item => {
-      this.addAuth(...item)
-    })
-    console.log('total AUTH INFO size: ', this.AUTH.size)
-  }
-
-  async getAuth(id) {
-    return this.AUTH.get(id)
-  }
-
-  async getAuthIdList() {
-    return Array.from(this.AUTH.keys())
-  }
-
-  addAuth(id, keyStr, cid, level = 0) {
-    let Base64hashKey = Buffer.from(Boho.sha256.hash(keyStr)).toString('base64')
-    this.AUTH.set(id, { key: Base64hashKey, cid: cid, level: level })
-  }
-}

package/src/auth/key_providers/RedisKeyProvider.js

@@ -1,46 +0,0 @@
-import Boho from 'boho'
-const DEVICE_PREFIX = "device:"
-
-export class RedisKeyProvider {
-  constructor(redisClient) {
-    if (!redisClient) {
-      throw new Error("RedisKeyProvider constructor: no redisClient")
-    }
-    this.redis = redisClient
-  }
-
-  // get device key from DB. (for Boho auth.)
-  async getAuth(id) {
-    try {
-      let result = await this.redis.hGetAll(DEVICE_PREFIX + id)
-      if (result && result.key) return result
-      else return null;
-    } catch (error) {
-      console.log('getAuth', error)
-    }
-  }
-
-  //sudoService call
-  async getAuthIdList() {
-    let result = await this.redis.keys(DEVICE_PREFIX + '*')
-    result = result.map(v => {
-      return v.split(':')[1]
-    })
-    if (result) return result
-  }
-
-  // add device auth info
-  async addAuth(id, keyStr, cid = '', level = 0) {
-    let Base64hashKey = Buffer.from(Boho.sha256.hash(keyStr)).toString('base64')
-    return this.redis.hSet(DEVICE_PREFIX + id, { 'key': Base64hashKey, 'cid': cid, 'level': level })
-  }
-
-  //sudoService call
-  async delAuth(id) {
-    return this.redis.del(DEVICE_PREFIX + id)
-  }
-
-  async save(id) {
-    return this.redis.save()
-  }
-}

package/src/auth/key_providers/StringKeyProvider.js

@@ -1,54 +0,0 @@
-/**
- * StringKeyProvider.js
- * 
- * authInfo <String>
- *  id: max 8chars
- *  key: ~44 base64 chars recomended
- *  cid: 
- *  level: range: 0~255
- *  separator: ',' for multiple devices.
- * 
- * example => authInfo = 'id1.key1.cid1.255,id2.key2.cid2.200'
- */
-
-import Boho from 'boho'
-
-export class StringKeyProvider {
-  constructor(authInfo) {
-
-    if (!authInfo) {
-      throw TypeError("StringKeyProvider constructor() missing authInfo.")
-    }
-
-    let id_keys = authInfo.split(',')
-
-    this.AUTH = new Map();
-
-    if (id_keys.length >= 1) {
-      id_keys.forEach(v => {
-        let [ did, key, cid, level ]  = v.split('.')
-        level = parseInt(level)
-        if (did && key && cid && typeof level == 'number') {
-          this.addAuth(did, key, cid, level)
-        } else {
-          throw TypeError("StringKeyProvider invalid authInfo.")
-        }
-      })
-    } else {
-      throw TypeError("StringKeyProvider invalid authInfo.")
-    }
-
-  }
-
-  async getAuth(id) {
-    return this.AUTH.get(id)
-  }
-  async getAuthIdList() {
-    return Array.from(this.AUTH.keys())
-  }
-
-  addAuth(id, keyStr, cid, level = 0) {
-    let Base64hashKey = Buffer.from(Boho.sha256.hash(keyStr)).toString('base64')
-    this.AUTH.set(id, { key: Base64hashKey, cid: cid, level: level })
-  }
-}