npm - iosignal - Versions diffs - 3.2.0 → 3.3.0 - Mend

iosignal 3.2.0 → 3.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (35) hide show

package/README.ko.md +1 -1
package/README.md +1 -225
package/dist/io.d.ts +5 -3
package/dist/io.js +4 -4
package/dist/io.js.map +1 -1
package/dist/io.min.js +4 -4
package/dist/io.min.js.map +1 -1
package/dist/iosignal.js +188 -174
package/dist/types/client/IOCore.d.ts +5 -3
package/examples/react-chat-js/dist/assets/index-e2KOTYW8.js +65 -0
package/examples/react-chat-js/dist/index.html +1 -1
package/examples/react-chat-js/package-lock.json +1 -1
package/examples/server/index.js +62 -9
package/examples/server/package-lock.json +833 -2
package/examples/server/package.json +1 -0
package/examples/server/public/index.html +26 -0
package/examples/svelte-chat-js/package-lock.json +11 -95
package/examples/svelte-chat-js/package.json +1 -0
package/examples/svelte-chat-js/src/app.html +1 -0
package/examples/svelte-chat-js/src/routes/+layout.svelte +0 -4
package/examples/svelte-chat-js/src/routes/+page.svelte +5 -0
package/examples/svelte-chat-js/svelte.config.js +10 -2
package/package.json +1 -1
package/src/api/RedisAPI.js +19 -31
package/src/api/api_reply.js +14 -6
package/src/api/api_sudo.js +2 -8
package/src/auth/Auth_Redis.js +8 -3
package/src/auth/BohoAuth.js +12 -12
package/src/client/CongPacket.js +2 -0
package/src/client/IOCore.js +28 -12
package/src/server/Manager.js +3 -4
package/src/server/Metric.js +1 -2
package/src/server/RemoteCore.js +27 -34
package/src/server/Server.js +69 -60
package/src/server/serverOption.js +3 -2

package/README.ko.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[ [English](README.md) | 한국어 ]
+[ [English](./README.md) | 한국어 ]
 # IOSignal

package/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-[ English | [한국어](README.ko.md) ]
+[ English | [한국어](./README.ko.md) ]
 # IOSignal
@@ -525,230 +525,6 @@ Fri, 09 Feb 2024 14:24:37 GMT
 ```
-## Features
-### Built-in Message Trasport Protocol
-- pub/sub multicast by channel name.
-- uni-cast: one to one messaging by CID.
-- `CID` is a Communication Id
-- CID subscribing: subscribe one peer using CID.
-- HomeChannel: group by IP address.
-### Built-in Security
-- Authentication
-- Encryption
-- E2EE
-- thanks to the `Boho` [ [github](https://github.com/remocons/boho) ]
-## Connection
- - Web browser use WebSocket.
- - Node.js use WebSocket or CongSocket.
- - Arduino use CongSocket.
-## IOSignal Server Architecture
-![IOSignal](./docs/iosignal_architecture.png)
-## IOSignal repositories.
-- Javascript: `iosignal` [ [github](https://github.com/remocons/iosignal) | [npm](https://www.npmjs.com/package/iosignal) ]
-    - Node.js server ( WebSocket, CongSocket)
-    - Node.js client ( WebSocket, CongSocket)
-    - Web Browser client( WebSocket)
-- CLI program
-    - `iosignal-cli` [ [github](https://github.com/remocons/iosignal-cli) | [npm](https://www.npmjs.com/package/iosignal-cli) ]
-    - install: `npm i -g iosignal-cli` or `sudo npm i -g iosignal-cli`
-    - support mac, linux and windows.
-    - server and client
-- Arduino iosignal library and examples:
-    - use Arduino Library Manager: `iosignal`
-    - or `iosignal-arduino` [ [github](https://github.com/remocons/iosignal-arduino) ]
-    - web app : http://test.iosignal.net
-- Arduino remocon library and examples:
-    - use Arduino Library Manager: `remocon`
-    - or `remocon-arduino` [ [github](https://github.com/remocons/remocon-arduino) ]
-    - web app : https://remocon.kr
-### Browser client : ESM
-- local file: "dist/io.js"
-- CDN: https://cdn.jsdelivr.net/npm/iosignal/dist/io.js
-```html
-<html>
-  <script type="module">
-    import IO from "../dist/io.js"
-    const io = new IO('wss://io.iosignal.net/ws')
-    io.listen('channel#topic', (...args)={
-      console.log( args )
-    })
-    io.on('ready',()=>{
-      console.log('ready cid:', io.cid )
-    })
-  </script>
-</html>
-```
-### Browser Client : UMD(IIFE)
-- local file: "dist/io.min.js"
-- CDN: https://cdn.jsdelivr.net/npm/iosignal/dist/io.min.js
-```html
-<html>
-  <script src="../dist/io.min.js"></script>
-  <script>
-    console.log('IO', IO)  // default global variable name is IO
-    var io1 = new IO('ws://localhost:7777')
-    var io2 = new IO('ws://localhost:7777')
-    var io3 = new IO('ws://localhost:7777')
-    io1.on('error', errorHandler )
-    io2.on('error', errorHandler )
-    io3.on('error', errorHandler )
-    let channelName = 'io'
-    // classic style subsribing
-    io1.on('ready',e=>{
-      io1.subscribe(channelName)
-      io1.on(channelName, (...args)=>{
-        // console.log('io1 received', args )
-        let msg = '[io1] ' + JSON.stringify( args )
-        addMessage(msg)
-      })
-    })
-    // iosignal style subscribing
-    io2.listen(channelName, (...args)=>{
-      // console.log('io2 receive', args )
-      let msg = '[io2] ' + JSON.stringify( args )
-        addMessage(msg)
-    })
-    setInterval(e=>{
-      io3.signal(channelName, 'single string')   // single string payload
-      io3.signal(channelName, Date.now(), 'a', 2 , {key: 3} ) //multiple payload
-      io3.signal(channelName ) // pure signal without payload.
-    },3000)
-    function addMessage(msg){
-      // ...
-    }
-    function errorHandler(e){
-      // ...
-    }
-  </script>
-</html>
-```
-### NodeJS Client
-```js
-  import { IO } from "iosignal"
-  const io = new IO('wss://io.iosignal.net/ws')
-  io.on('ready', ()=>{
-    console.log('ready cid:', io.cid)
-    io.signal('#screen','playToggle')
-  });
-  io.listen('#notify', (...args)=>{
-    console.log( args )
-  })
-  io.on('error',err=>{
-      console.log('err', err)
-  })
-```
-## IOSignal Server
-```js
-import { Server } from "iosignal"
-const server = new Server(
-  {
-    port: 7777,
-    congPort: 8888,
-    showMetric: 2,
-    showMessage: 'message' // show signal message
-  })
-```
-- port: <Number> IOSignal over WebSocket
-- congPort: <Number> IOsignal over CongSocket
-- showMetric: 1|2|3 show clients cid(state) info
-- showMessage: "none"|"message" show signal buffer message
-- timeout <milliseconds> ping period & timeout (min. 1000)
-### IOSignal API
-IOSignal API examples
-- src/api_reply.js  // 'echo', 'date', 'unixtime'
-- src/api_sudo.js   // server admin monitoring command
-- src/RedisAPI.js   // redis command and response service
-To register an API service with the server, use the api() method
-`api('api_name', module )`
-```js
-// node.js
-import { Server ,api_reply  } from 'iosignal'
-const server = new Server( { port: 7777 }  )
-server.api('reply', api_reply) // attach api module
-```
-Example of a client calling the reply API
-```js
-  // web browser api client example
-  <script src="../dist/io.min.js"></script>
-  <script>
-      const io = new IO('ws://localhost:7777')
-      io.on('ready', async ()=>{
-        let res_echo = await io.req('reply', 'echo', 'hello' )
-        let res_date = await io.req('reply', 'date' )
-        let res_unixtime = await io.req('reply', 'unixtime' )
-        if( res_echo.ok ) console.log( res_echo.body  )
-        if( res_date.ok ) console.log( res_date.body  )
-        if( res_unixtime.ok ) console.log( res_unixtime.body  )
-      });
-  </script>
-// result
-[ 'hello' ]
-Fri, 09 Feb 2024 14:24:37 GMT
-1707488677
-```
 ## Features
 ### Built-in Message Trasport Protocol

package/dist/io.d.ts CHANGED Viewed

@@ -211,6 +211,8 @@ declare class IOCore extends EventEmitter<string | symbol, any> {
      * @param {Buffer} buffer - The incoming data buffer.
      */
     onData(buffer: Buffer$1): void;
+    did: any;
+    uid: any;
     /**
      * Sends an IAM (I Am) message to the server.
      * @param {string} [title] - Optional title for the IAM message.
@@ -302,9 +304,9 @@ declare class IOCore extends EventEmitter<string | symbol, any> {
      */
     get(storeName: string): Promise<any>;
     /**
-     * Sends a request to a target and topic.
-     * @param {string} target - The target of the request.
-     * @param {string} topic - The topic of the request.
+     * Sends a request to a target and topic.(remote api call)
+     * @param {string} target - The target(api name) of the request.
+     * @param {string} topic - The topic(api function name) of the request.
      * @param {...any} args - Optional arguments for the request.
      * @returns {Promise<any>}
      */