drachtio-srf 5.0.13 → 5.0.14

package/.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
         with:
           node-version: 20.x
       - run: npm install
-      - run: npm run jslint
+      - run: npm run lint
       - name: Install Docker Compose
         run: |
           sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose

package/README.md

@@ -15,7 +15,7 @@ Please visit [drachtio.org](https://drachtio.org) for getting started instructio
     host: '192.168.32.5',
     port: 9022,
     secret: 'cymru'
-  }) ;
+  });
   
   srf.invite((req, res) => {
     srf.proxyRequest(req, ['sip.example1.com', 'sip.example2.com'], {
@@ -37,7 +37,7 @@ Please visit [drachtio.org](https://drachtio.org) for getting started instructio
     host: '192.168.32.5',
     port: 9022,
     secret: 'cymru'
-  }) ;
+  });
     const Srf = require('drachtio-srf');
   const srf = new Srf();
 

package/eslint.config.mjs

@@ -0,0 +1,134 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import pluginPromise from 'eslint-plugin-promise';
+import stylisticJs from '@stylistic/eslint-plugin';
+
+export default [
+  { files: ["**/*.js"], languageOptions: { sourceType: "commonjs" } },
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        "DTRACE_HTTP_CLIENT_REQUEST": false,
+        "LTTNG_HTTP_CLIENT_REQUEST": false,
+        "COUNTER_HTTP_CLIENT_REQUEST": false,
+        "DTRACE_HTTP_CLIENT_RESPONSE": false,
+        "LTTNG_HTTP_CLIENT_RESPONSE": false,
+        "COUNTER_HTTP_CLIENT_RESPONSE": false,
+        "DTRACE_HTTP_SERVER_REQUEST": false,
+        "LTTNG_HTTP_SERVER_REQUEST": false,
+        "COUNTER_HTTP_SERVER_REQUEST": false,
+        "DTRACE_HTTP_SERVER_RESPONSE": false,
+        "LTTNG_HTTP_SERVER_RESPONSE": false,
+        "COUNTER_HTTP_SERVER_RESPONSE": false,
+        "DTRACE_NET_STREAM_END": false,
+        "LTTNG_NET_STREAM_END": false,
+        "COUNTER_NET_SERVER_CONNECTION_CLOSE": false,
+        "DTRACE_NET_SERVER_CONNECTION": false,
+        "LTTNG_NET_SERVER_CONNECTION": false,
+        "COUNTER_NET_SERVER_CONNECTION": false
+      },
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: false,
+          modules: false
+        },
+        ecmaVersion: 2020
+      },
+    }
+  },
+  {
+    plugins: {
+      '@stylistic/js': stylisticJs
+    },
+  },
+  { ignores: ["test/**"] },
+  pluginJs.configs.recommended,
+  pluginPromise.configs['flat/recommended'],
+  { rules: {
+    "promise/always-return": "error",
+    "promise/no-return-wrap": "error",
+    "promise/param-names": "error",
+    "promise/catch-or-return": "error",
+    "promise/no-native": "off",
+    "promise/no-nesting": "warn",
+    "promise/no-promise-in-callback": "warn",
+    "promise/no-callback-in-promise": "warn",
+    "promise/no-return-in-finally": "warn",
+
+    // Possible Errors
+    "no-control-regex": 2,
+    "no-debugger": 2,
+    "no-dupe-args": 2,
+    "no-dupe-keys": 2,
+    "no-duplicate-case": 2,
+    "no-empty-character-class": 2,
+    "no-ex-assign": 2,
+    "no-extra-boolean-cast": 2,
+    "no-func-assign": 2,
+    "no-invalid-regexp": 2,
+    "no-irregular-whitespace": 2,
+    "no-negated-in-lhs": 2,
+    "no-obj-calls": 2,
+    "no-proto": 2,
+    "no-unexpected-multiline": 2,
+    "no-unreachable": 2,
+    "use-isnan": 2,
+    "valid-typeof": 2,
+
+    // Best Practices
+    "no-fallthrough": 2,
+    "no-octal": 2,
+    "no-redeclare": 2,
+    "no-self-assign": 2,
+    "no-unused-labels": 2,
+
+    // Strict Mode
+    "strict": [2, "never"],
+
+    // Variables
+    "no-delete-var": 2,
+    "no-undef": 2,
+    "no-unused-vars": [2, { args: "none" }],
+
+    // Node.js and CommonJS
+    "no-mixed-requires": 2,
+    "no-new-require": 2,
+    "no-path-concat": 2,
+    "no-restricted-modules": [2, "sys", "_linklist"],
+
+    // Stylistic Issues
+    "@stylistic/js/arrow-parens": [2, "always"],
+    "@stylistic/js/arrow-spacing": [2, { before: true, after: true }],
+    "@stylistic/js/comma-dangle": [2, "only-multiline"],
+    "@stylistic/js/comma-spacing": 2,
+    "@stylistic/js/eol-last": 2,
+    "@stylistic/js/indent": [2, 2, { SwitchCase: 1 }],
+    "@stylistic/js/keyword-spacing": 2,
+    "@stylistic/js/max-len": [2, 120, 2],
+    "@stylistic/js/new-parens": 2,
+    "@stylistic/js/no-extra-parens": [2, "functions"],
+    "@stylistic/js/no-extra-semi": 2,
+    "@stylistic/js/no-mixed-spaces-and-tabs": 2,
+    "@stylistic/js/no-multiple-empty-lines": [2, { max: 2 }],
+    "@stylistic/js/no-trailing-spaces": [2, { skipBlankLines: false }],
+    "@stylistic/js/quotes": [2, "single", { avoidEscape: true }],
+    "@stylistic/js/semi": 2,
+    "@stylistic/js/semi-spacing": ["error", {"before": false, "after": true}],
+    "@stylistic/js/space-before-blocks": [2, "always"],
+    "@stylistic/js/space-before-function-paren": [2, "never"],
+    "@stylistic/js/space-in-parens": [2, "never"],
+    "@stylistic/js/space-infix-ops": 2,
+    "@stylistic/js/space-unary-ops": 2,
+
+    // ECMAScript 6
+    "constructor-super": 2,
+    "no-class-assign": 2,
+    "no-confusing-arrow": 2,
+    "no-const-assign": 2,
+    "no-dupe-class-members": 2,
+    "no-new-symbol": 2,
+    "no-this-before-super": 2,
+    "prefer-const": 2
+  } }
+];

package/lib/@types/index.d.ts

@@ -8,10 +8,10 @@ declare namespace Srf {
   type Via = { version: string; protocol: string; host: string; port: string; };
 
   export interface SrfConfig {
-    apiSecret?: string;
     host?: string;
     port?: number;
     secret?: string;
+    logger?: (message: string) => void;
   }
 
   interface ParseUriResult {
@@ -32,7 +32,10 @@ declare namespace Srf {
   export interface SipMessage {
     type: "request" | "response";
     body: string;
-    payload: object[];
+    payload: {
+      type: string | null;
+      content?: string;
+    }[];
     source: "network" | "application";
     source_address: string;
     source_port: string;
@@ -60,9 +63,9 @@ declare namespace Srf {
     callId: string;
     from: string;
     headers: Record<string, string>;
-    msg: any;
+    msg: SipMessage;
     sdp: string;
-    srf: any;
+    srf: Srf;
     to: string;
     uri: string;
     registration?: {
@@ -93,7 +96,7 @@ declare namespace Srf {
     end(): void;
   }
 
-  export interface Dialog {
+  export class Dialog extends EventEmitter {
     sip: { callId: string; localTag: string; remoteTag: string; };
     onHold: boolean;
     other: Dialog;
@@ -106,19 +109,17 @@ declare namespace Srf {
     modify(opts: { noAck: boolean }): Promise<string>;
     modify(sdp: string, opts?: { noAck: boolean }, callback?: (err: any, msg: SrfResponse) => void): void;
     modify(opts: { noAck: boolean }, callback?: (err: any, resp?: string, resAck?: (sdp: string) => void) => void): void;
-    on(messageType: "ack", callback: (msg: SrfRequest) => void): void;
-    on(messageType: "destroy", callback: (msg: SrfRequest) => void): void;
-    on(messageType: "info", callback: (req: SrfRequest, res: SrfResponse) => void): void;
-    on(messageType: "message", callback: (req: SrfRequest, res: SrfResponse) => void): void;
-    on(messageType: "modify", callback: (req: SrfRequest, res: SrfResponse) => void): void;
-    on(messageType: "notify", callback: (req: SrfRequest, res: SrfResponse) => void): void;
-    on(messageType: "options", callback: (req: SrfRequest, res: SrfResponse) => void): void;
-    on(messageType: "refer", callback: (req: SrfRequest, res: SrfResponse) => void): void;
-    on(messageType: "refresh", callback: (msg: SrfRequest) => void): void;
-    on(messageType: "update", callback: (req: SrfRequest, res: SrfResponse) => void): void;
-    on(messageType: "modify", callback: (req: SrfRequest, res: SrfResponse) => void): void;
-    once(messageType: string, callback: (msg: SrfResponse) => void): void;
-    listeners(messageType: string): any[];
+    on(messageType: "ack", callback: (msg: SrfRequest) => void): this;
+    on(messageType: "destroy", callback: (msg: SrfRequest) => void): this;
+    on(messageType: "info", callback: (req: SrfRequest, res: SrfResponse) => void): this;
+    on(messageType: "message", callback: (req: SrfRequest, res: SrfResponse) => void): this;
+    on(messageType: "modify", callback: (req: SrfRequest, res: SrfResponse) => void): this;
+    on(messageType: "notify", callback: (req: SrfRequest, res: SrfResponse) => void): this;
+    on(messageType: "options", callback: (req: SrfRequest, res: SrfResponse) => void): this;
+    on(messageType: "refer", callback: (req: SrfRequest, res: SrfResponse) => void): this;
+    on(messageType: "refresh", callback: (msg: SrfRequest) => void): this;
+    on(messageType: "update", callback: (req: SrfRequest, res: SrfResponse) => void): this;
+    once(messageType: string, callback: (msg: SrfResponse) => void): this;
     request(opts?: SrfRequest): Promise<SrfResponse>;
     request(opts: SrfRequest, callback?: (err: any, msg: SrfResponse) => void): void;
   }
@@ -155,6 +156,7 @@ declare class Srf extends EventEmitter {
   constructor();
   constructor(tags: string | string[]);
   connect(config?: Srf.SrfConfig): Promise<void>;
+  listen(opts?: Srf.SrfConfig): Promise<void>;
   disconnect(): void;
   use(callback: (req: Srf.SrfRequest, res: Srf.SrfResponse, next: Function) => void): void;
   use(messageType: string, callback: (req: Srf.SrfRequest, res: Srf.SrfResponse, next: Function) => void): void;

package/lib/connect.js

@@ -1,7 +1,7 @@
-const EventEmitter = require('events').EventEmitter ;
-const proto = require('./proto') ;
+const EventEmitter = require('events').EventEmitter;
+const proto = require('./proto');
 const merge = require('utils-merge');
-const methods = require('sip-methods') ;
+const methods = require('sip-methods');
 
 exports = module.exports = createServer;
 
@@ -21,8 +21,8 @@ function createServer() {
   merge(app, EventEmitter.prototype);
   app.stack = [];
   app.params = [];
-  app._cachedEvents = [] ;
-  app.routedMethods = {} ;
+  app._cachedEvents = [];
+  app.routedMethods = {};
   app.locals = Object.create(null);
   for (var i = 0; i < arguments.length; ++i) {
     app.use(arguments[i]);
@@ -30,30 +30,30 @@ function createServer() {
 
   //create methods app.invite, app.register, etc..
   methods.forEach((method) => {
-    app[method.toLowerCase()] = app.use.bind(app, method.toLowerCase()) ;
-  }) ;
+    app[method.toLowerCase()] = app.use.bind(app, method.toLowerCase());
+  });
 
   //special handling for cdr events
   app.on = function(event, listener) {
     if (0 === event.indexOf('cdr:')) {
       if (app.client) {
         app.client.on(event, function() {
-          var args = Array.prototype.slice.call(arguments) ;
-          EventEmitter.prototype.emit.apply(app, [event].concat(args)) ;
-        }) ;
+          var args = Array.prototype.slice.call(arguments);
+          EventEmitter.prototype.emit.apply(app, [event].concat(args));
+        });
       }
       else {
-        this._cachedEvents.push(event) ;
+        this._cachedEvents.push(event);
       }
     }
     //delegate all others to standard EventEmitter prototype
-    return EventEmitter.prototype.addListener.call(app, event, listener) ;
-  } ;
+    return EventEmitter.prototype.addListener.call(app, event, listener);
+  };
 
   return app;
 }
 
 createServer.Agent = require('./drachtio-agent');
-createServer.Request = require('./request') ;
-createServer.Response = require('./response') ;
-createServer.onSend = require('./on-send') ;
+createServer.Request = require('./request');
+createServer.Response = require('./response');
+createServer.onSend = require('./on-send');