iosignal 4.6.1 → 4.7.0

package/src/server/Server.js

@@ -3,13 +3,13 @@ import EventEmitter from 'events'
 import { WebSocketServer } from 'ws'
 import { Manager } from './Manager.js'
 import { serverOption } from './serverOption.js'
-import { STATUS } from '../api/api_constant.js'
+import { STATUS } from '../services/constant.js'
 
 export class Server extends EventEmitter {
 
   constructor(options, authManager) {
     super();
-    this.apiNames = new Set()
+    this.serviceNames = new Set()
     this.wss = {};
     this.port = null;
     this.congPort = null;
@@ -130,63 +130,63 @@ export class Server extends EventEmitter {
   }
 
 /**
- * API register.
- * target:  api_name <string>
- * api: api_module <function module|class instance>
+ * RPC service register.
+ * target:  service_name <string>
+ * service: service_module <function module|class instance>
  * return this
  */
-  api(target, api) {
+  attach(target, service_module) {
 
     if( typeof target !== 'string'){
-      throw new Error(`api( target ,api ) target name is not a string.`)
+      throw new Error(`service( target ,service ) target name is not a string.`)
     }
-    if (!api.checkPermission || typeof api.checkPermission != 'function') {
-      throw new Error(`API ${target} : no checkPermission or not a function.`)
+    if (!service_module.checkPermission || typeof service_module.checkPermission != 'function') {
+      throw new Error(`Service ${target} : no checkPermission or not a function.`)
     }
-    if(!api.commands || !Array.isArray(api.commands) ){
-      throw new Error(`API ${target} : no commands or !Array.`)
+    if(!service_module.commands || !Array.isArray(service_module.commands) ){
+      throw new Error(`Service ${target} : no commands or !Array.`)
     }
     
-    // API TYPE 1. single request() function.
-    if ( api.request && typeof api.request == 'function' ) {
+    // Service TYPE 1. single call() function.
+    if ( service_module.call && typeof service_module.call == 'function' ) {
       this.on(target, async (remote, req) => {
         try {
-          if (!api.checkPermission(remote, req)) {
+          if (!service_module.checkPermission(remote, req)) {
             remote.response(req.mid, STATUS.ERROR, "NO_PERMISSION.")
             return
           }
-          if( api.commands.includes( req.topic )){
-            // console.log('server api req', req )
-            await api.request(remote, req)
+          if( service_module.commands.includes( req.topic )){
+            // console.log('server service_module req', req )
+            await service_module.call(remote, req)
           }else{
             remote.response(req.mid, STATUS.ERROR, "UNKNOWN_COMMAND");
           }
         } catch (error) {
-          console.error(`Unhandled API Error in target [${target}]:`, error);
+          console.error(`Unhandled Service Error in target [${target}]:`, error);
           remote.response(req.mid, STATUS.ERROR, "INTERNAL_SERVER_ERROR");
         }
       })
     } else {
-      // API TYPE 2. multiple functions.
+      // Service TYPE 2. multiple functions.
       this.on(target, async (remote, req) => {
         try {
-          if (!api.checkPermission(remote, req)) {
+          if (!service_module.checkPermission(remote, req)) {
             remote.response(req.mid, STATUS.ERROR, "NO_PERMISSION.")
             return
           }
-          if( api.commands.includes( req.topic )){
-            await api[req.topic](remote, req)
+          if( service_module.commands.includes( req.topic )){
+            await service_module[req.topic](remote, req)
           }else{
             remote.response(req.mid, STATUS.ERROR, "UNKNOWN_COMMAND");
           }
         } catch (error) {
-          console.error(`Unhandled API Error in target [${target}]:`, error);
+          console.error(`Unhandled Service Error in target [${target}]:`, error);
           remote.response(req.mid, STATUS.ERROR, "INTERNAL_SERVER_ERROR");
         }
       })
     }
-    this.apiNames.add(target)
-    // console.log(`[API registed: ${target} ] accept commands: ${api.commands}`)
+    this.serviceNames.add(target)
+    // console.log(`[Service attached: ${target} ] accept commands: ${service_module.commands}`)
     return this
   }
 
@@ -196,8 +196,8 @@ export class Server extends EventEmitter {
       this.manager.close()
     }
 
-    this.apiNames.forEach(v => this.removeAllListeners(v))
-    this.apiNames.clear()
+    this.serviceNames.forEach(v => this.removeAllListeners(v))
+    this.serviceNames.clear()
 
     let serverCount = 0;
     if (this.wss) serverCount++;

package/src/{api/RedisAPI.js → services/RedisService.js}

@@ -1,14 +1,14 @@
 /**
- * RedisAPI <IOSignal API>
+ * RedisService <IOSignal RPC Service>
  * 
  * iosignal 클라이언트의 redis 질의 요청을 받으면, 
  * redisClient 로 연결된 redis-server 에게 질의 후 결과를 되돌려 준다. 
  * 
  * client ex:  
- * await io.req('redis','hget','user:id' )
+ * await io.call('redis','hget','user:id' )
  * 
  */
-import { STATUS } from './api_constant.js'
+import { STATUS } from './constant.js'
 
 const MIN_LEVEL = 200;
 const COMMANDS = [
@@ -18,10 +18,10 @@ const COMMANDS = [
   'sMembers', 'exists', 'sRem', 'del', 'keys', 'save'
 ]
 
-export class RedisAPI {
+export class RedisService {
   constructor(redisClient, _minLevel) {
     if (!redisClient) {
-      throw new Error("RedisAPI constructor: no redisClient")
+      throw new Error("RedisService constructor: no redisClient")
     }
     this.redisClient = redisClient
     this.minLevel = _minLevel ? _minLevel : MIN_LEVEL
@@ -32,7 +32,7 @@ export class RedisAPI {
     return (remote.level >= this.minLevel) ? true : false;
   }
 
-  async request(remote, req) {
+  async call(remote, req) {
     let result;
     try {
       let cmd = req.topic

package/src/{api/api_reply.js → services/replyService.js}

@@ -1,9 +1,9 @@
 
 /**
- * simple IOSignal API example.
+ * simple IOSignal RPC Service example.
  */
 
-import { STATUS } from './api_constant.js'
+import { STATUS } from './constant.js'
 export const commands = ['echo', 'date', 'unixtime'];
 
 const MIN_LEVEL = 0;
@@ -12,7 +12,7 @@ export function checkPermission(remote) {
 }
 
 /**
- * client api call example:  await io.req('reply','echo','hello')
+ * client api call example:  await io.call('reply','echo','hello')
  */
 export async function echo(remote, req) {
   if (!req.args)
@@ -22,7 +22,7 @@ export async function echo(remote, req) {
 }
 
 /**
- * client api call example:  await io.req('reply','date')
+ * client api call example:  await io.call('reply','date')
  */
 export async function date(remote, req) {
   let r = new Date().toUTCString()
@@ -30,7 +30,7 @@ export async function date(remote, req) {
 }
 
 /**
- * client api call example:  await io.req('reply','unixtime')
+ * client api call example:  await io.call('reply','unixtime')
  */
 export async function unixtime(remote, req) {
   let r = Math.floor(Date.now() / 1000)

package/src/{api/api_sudo.js → services/sudoService.js}

@@ -1,4 +1,4 @@
-import { STATUS } from './api_constant.js'
+import { STATUS } from './constant.js'
 
 export const commands = [
   'cid', 'remotes', 'clients',
@@ -14,7 +14,7 @@ export function checkPermission(remote) {
   return (remote.level >= MIN_LEVEL) ? true : false;
 }
 
-export async function request(remote, req) {
+export async function call(remote, req) {
   let result;
   let status = 0;
   try {
@@ -70,7 +70,7 @@ export async function request(remote, req) {
       }
     } else {
       status = STATUS.ERROR;
-      result = "api sudo: no such a cmd: " + cmd
+      result = "service sudo: no such a cmd: " + cmd
     }
 
     remote.response(req.mid, status, result)

package/tsconfig.json

@@ -5,7 +5,7 @@
     "outDir": "./dist/types",
     "allowJs": true,
     "moduleResolution": "node",
-    "target": "es2015",
+    "target": "es2020",
     "lib": ["es2020", "dom"],
     "baseUrl": ".",
     "paths": {