drachtio-srf 4.5.23 → 4.5.26

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

@@ -0,0 +1,64 @@
+declare module 'drachtio-srf' {
+    import { Socket } from 'net';
+    import { EventEmitter } from 'events';
+  
+    type SipMethod = 'ACK' | 'BYE' | 'CANCEL' | 'INFO' | 'INVITE' | 'MESSAGE' | 'NOTIFY' | 'OPTIONS' | 'PRACK' | 'PUBLISH' | 'REFER' | 'REGISTER' | 'SUBSCRIBE' | 'UPDATE';
+  
+    interface SrfConfig {
+      apiSecret?: string;
+      host?: string;
+      port?: number;
+      secret?: string;
+    }
+  
+    interface SrfRequest {
+      headers: {[name: string]: any};
+      msg: any;
+      method: SipMethod;
+      uri: string;
+      from: string;
+      to: string;
+      callId: string;
+      branch: string;
+      sdp: string;
+      get(name: string): string;
+      has(name: string): boolean;
+    }
+  
+    interface SrfResponse {
+      headers: {[name: string]: any};
+      status: number;
+      send(sdp?: string): void;
+      end(): void;
+      set(name: string, value: string | number): void;
+      get(name: string): string;
+    }
+  
+    class Srf extends EventEmitter {
+      connect(config?: SrfConfig): Promise<void>;
+      disconnect(): void;
+      register(options: any): void;
+      invite(sipUri: string, options: any): void;
+      bye(request: SrfRequest, options: any): void;
+      cancel(request: SrfRequest, options: any): void;
+      ack(request: SrfRequest, options: any): void;
+      info(request: SrfRequest, options: any): void;
+      message(request: SrfRequest, options: any): void;
+      notify(request: SrfRequest, options: any): void;
+      options(request: SrfRequest, options: any): void;
+      prack(request: SrfRequest, options: any): void;
+      publish(request: SrfRequest, options: any): void;
+      refer(request: SrfRequest, target: string, options: any): void;
+      subscribe(request: SrfRequest, target: string, options: any): void;
+      update(request: SrfRequest, options: any): void;
+      on(event: 'connect' | 'error' | 'disconnect', listener: () => void): this;
+      on(event: 'message', listener: (req: SrfRequest, res: SrfResponse) => void): this;
+      on(event: 'request', listener: (req: SrfRequest, res: SrfResponse) => void): this;
+      on(event: 'register' | 'invite' | 'bye' | 'cancel' | 'ack' | 'info' | 'notify' | 'options' | 'prack' | 'publish' | 'refer' | 'subscribe' | 'update', listener: (req: SrfRequest, res: SrfResponse) => void): this;
+      locals: {[name: string]: any};
+      socket: Socket;
+    }
+  
+    export default Srf
+  }
+  

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "drachtio-srf",
-  "version": "4.5.23",
+  "version": "4.5.26",
   "description": "drachtio signaling resource framework",
   "main": "lib/srf.js",
+  "types": "lib/@types/index.d.ts",
   "scripts": {
     "test": "NODE_ENV=test node test/ ",
     "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
@@ -35,6 +36,7 @@
     "uuid-random": "^1.3.2"
   },
   "devDependencies": {
+    "@types/node": "^16.0.0",
     "config": "^3.3.7",
     "eslint": "^8.30.0",
     "eslint-plugin-promise": "^6.1.1",
@@ -42,6 +44,7 @@
     "nyc": "^15.1.0",
     "should": "^13.2.3",
     "sip-message-examples": "^0.0.6",
-    "tape": "^5.5.3"
+    "tape": "^5.5.3",
+    "typescript": "^4.3.2"
   }
 }