Skip to content

Commit

Permalink
Types: Fix importing non-default types (#185)
Browse files Browse the repository at this point in the history 
* Reformat types file

* Types: Add missing type annotations

* Types: Fix importing non-default types

Fixes #181.
  • Loading branch information
@orgads
orgads authored Dec 12, 2024
1 parent 9ebf662 commit c34a7e7
Showing 1 changed file with 171 additions and 143 deletions.
314 changes: 171 additions & 143 deletions lib/@types/index.d.ts
View file
Original file line number Diff line number Diff line change
@@ -1,156 +1,184 @@
declare module 'drachtio-srf' {
import { Socket } from 'net';
import { EventEmitter } from 'events';
import { Socket } from 'net';
import { EventEmitter } from 'events';

namespace Srf {
type SipMethod = 'ACK' | 'BYE' | 'CANCEL' | 'INFO' | 'INVITE' | 'MESSAGE' | 'NOTIFY' | 'OPTIONS' | 'PRACK' | 'PUBLISH' | 'REFER' | 'REGISTER' | 'SUBSCRIBE' | 'UPDATE';
type SipMessageHeaders = Record<string, string>;
type AOR = { name: string; uri: string; params?: Record<string, any>; };
declare namespace Srf {
type SipMethod = 'ACK' | 'BYE' | 'CANCEL' | 'INFO' | 'INVITE' | 'MESSAGE' | 'NOTIFY' | 'OPTIONS' | 'PRACK' | 'PUBLISH' | 'REFER' | 'REGISTER' | 'SUBSCRIBE' | 'UPDATE';
type SipMessageHeaders = Record<string, string>;
type AOR = { name: string; uri: string; params?: Record<string, any>; };
type Via = { version: string; protocol: string; host: string; port: string; };

export interface SrfConfig {
apiSecret?: string;
host?: string;
port?: number;
secret?: string;
}
export interface SrfConfig {
apiSecret?: string;
host?: string;
port?: number;
secret?: string;
}

export function parseUri(uri: string): { user: string; host: string; params?: Record<string, any>; };
export function stringifyUri(uri: object): string;
interface ParseUriResult {
family?: 'ipv6' | 'ipv4';
scheme: 'sip' | 'sips' | 'tel';
user?: string;
password?: string;
host?: string;
port?: string;
params: Record<string, string | null>;
headers: Record<string, string>;
context?: string;
}

export interface SipMessage {
type: "request" | "response";
body: string;
payload: object[];
source: "network" | "application";
source_address: string;
source_port: string;
protocol: string;
stackTime: string;
calledNumber: string;
callingNumber: string;
raw: string;
get(name: string): string;
has(name: string): boolean;
set(name: string, value: string);
getParsedHeader(name: "contact" | "Contact"): Array<AOR>;
getParsedHeader(name: "via" | "Via"): Array<Via>;
getParsedHeader(name: "To" | "to" | "From" | "from" | "refer-to" | "referred-by" | "p-asserted-identity" | "remote-party-id"): AOR;
getParsedHeader(name: string): string;
}
export function parseUri(uri: string): ParseUriResult;
export function stringifyUri(uri: object): string;

export interface SrfRequest extends SipMessage {
method: SipMethod;
isNewInvite(): boolean
cancel(callback: () => {})
branch: string;
callId: string;
from: string;
headers: Record<string, string>;
msg: any;
sdp: string;
srf: any;
to: string;
uri: string;
registration?: {
type: "unregister" | "register";
expires: number;
contact: Array<AOR>;
aor: string;
};
}
export interface SipMessage {
type: "request" | "response";
body: string;
payload: object[];
source: "network" | "application";
source_address: string;
source_port: string;
protocol: string;
stackTime: string;
calledNumber: string;
callingNumber: string;
raw: string;
get(name: string): string;
has(name: string): boolean;
set(name: string, value: string): void;
getParsedHeader(name: "contact" | "Contact"): Array<AOR>;
getParsedHeader(name: "via" | "Via"): Array<Via>;
getParsedHeader(name: "To" | "to" | "From" | "from" | "refer-to" | "referred-by" | "p-asserted-identity" | "remote-party-id"): AOR;
getParsedHeader(name: string): string;
}

export interface SrfResponse extends SipMessage {
status: number;
statusCode: number;
reason: string;
finalResponseSent: boolean;
send(status: number);
send(status: number, opts: object);
send(status: number, reason: string, opts: object);
send(status: number, reason: string, opts: object, callback: (err, msg) => {});
end();
}
export interface SrfRequest extends SipMessage {
method: SipMethod;
get isNewInvite(): boolean
cancel(callback: (err: any, req: SrfRequest) => void): void;
on(event: 'response', callback: (res?: SrfResponse, ack?: (opts?: { sdp: string }) => void) => void): void;
on(event: 'cancel', callback: (res: SipMessage) => void): void;
branch: string;
callId: string;
from: string;
headers: Record<string, string>;
msg: any;
sdp: string;
srf: any;
to: string;
uri: string;
registration?: {
type: "unregister" | "register";
expires: number;
contact: Array<AOR>;
aor: string;
};
}

export interface Dialog {
sip: { callId: string; localTag: string; remoteTag: string; };
onHold: boolean;
other: Dialog;
type: "uac" | "uas";
local: { uri: string; sdp: string; };
remote: { uri: string; sdp: string; };
req: SrfRequest;
destroy(opts?: { headers: Record<string, string>; }, callback?: (err, msg) => {}): void;
modify(sdp, callback?: (err: any, msg: SrfResponse) => void): void;
modify({ noAck: boolean }, callback?: (err: any, resp: any, resAck: any) => 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[];
request(opts?: { method: SipMethod; headers?: Record<string, string | number>; body?: string; }, callback?: (err, msg) => {});
}
export interface ProxyRequestOptions {
forking?: 'sequential' | 'simultaneous';
remainInDialog?: boolean;
recordRoute?: boolean;
provisionalTimeout?: string;
finalTimeout?: string;
followRedirects?: boolean
}

export interface CreateUASOptions {
localSdp: string;
headers?: SipMessageHeaders;
}
export interface SrfResponse extends SipMessage {
status: number;
statusCode: number;
reason: string;
finalResponseSent: boolean;
send(status: number, opts?: object): void;
send(status: number, reason: string, opts: object): void;
send(status: number, reason: string, opts: object, callback: (err: any, msg: SipMessage) => void): void;
end(): void;
}

export interface CreateUACOptions {
headers?: SipMessageHeaders;
uri?: string;
noAck?: boolean;
localSdp?: string;
proxy?: string;
auth?: { username: string; password: string; };
}
export interface Dialog {
sip: { callId: string; localTag: string; remoteTag: string; };
onHold: boolean;
other: Dialog;
type: "uac" | "uas";
local: { uri: string; sdp: string; };
remote: { uri: string; sdp: string; };
req: SrfRequest;
destroy(opts?: { headers: Record<string, string>; }, callback?: (err: any, msg: SrfRequest) => void): void;
modify(sdp: string, opts?: { noAck: boolean }): Promise<string>;
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[];
request(opts?: SrfRequest): Promise<SrfResponse>;
request(opts: SrfRequest, callback?: (err: any, msg: SrfResponse) => void): void;
}

export interface CreateB2BUAOptions {
headers?: SipMessageHeaders;
responseHeaders?: SipMessageHeaders | ((uacRes: SipMessageHeaders, headers: SipMessageHeaders) => SipMessageHeaders | null);
localSdpA?: string | ((sdp: string, res: SrfResponse) => string | Promise<string>);
localSdpB?: string | ((sdp: string) => string | Promise<string>);
proxyRequestHeaders?: string[];
proxyResponseHeaders?: string[];
passFailure?: boolean;
passProvisionalResponses?: boolean;
proxy?: string;
auth?: { username: string; password: string; };
}
export interface CreateUASOptions {
localSdp: string;
headers?: SipMessageHeaders;
}

class Srf extends EventEmitter {
constructor();
constructor(tags: string | string[]);
connect(config?: SrfConfig): Promise<void>;
disconnect(): void;
use(callback: (req: SrfRequest, res: SrfResponse, next: Function) => void): void;
use(messageType: string, callback: (req: SrfRequest, res: SrfResponse, next: Function) => void): void;
invite(callback: (req: SrfRequest, res: SrfResponse) => void): void;
request(uri: string, opts, method, [body], callback?: (err, requestSent: SrfRequest) => void);
proxyRequest(req: SrfRequest, destination: string | string[], [opts], callback?: (err, results) => {}): void;
createUAS(req: SrfRequest, res: SrfResponse, opts: CreateUASOptions, callback?: (err, dialog: Dialog) => void): Promise<Dialog>;
createUAC(uri: string | CreateUACOptions, opts?: CreateUACOptions, progressCallbacks?: { cbRequest?: (req: SrfRequest) => void; cbProvisional?: (provisionalRes: SrfResponse) => void; }, callback?: (err, dialog: Dialog) => void): Promise<Dialog>;
createB2BUA(req: SrfRequest, res: SrfResponse, uri: string, opts: CreateB2BUAOptions, progressCallbacks?: { cbRequest?: (req: SrfRequest) => void; cbProvisional?: (provisionalRes: Response) => void; cbFinalizedUac?: (uac: Dialog) => void; }, callback?: (err, dialog: Dialog) => {}): Promise<{ uas: Dialog; uac: Dialog }>;
on(event: 'connect', listener: (err: Error, hostPort: string) => void): this;
on(event: 'error', listener: (err: Error) => void): this;
on(event: '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;
on(event: 'cdr:attempt', listener: (source: string, time: string, msg: SipMessage) => void): this;
on(event: 'cdr:start', listener: (source: string, time: string, role: string, msg: SipMessage) => void): this;
on(event: 'cdr:stop', listener: (source: string, time: string, reason: string, msg: SipMessage) => void): this;
locals: {[name: string]: any};
socket: Socket;
}
}
export interface CreateUACOptions {
headers?: SipMessageHeaders;
uri?: string;
noAck?: boolean;
localSdp?: string;
proxy?: string;
auth?: { username: string; password: string; };
}

export = Srf.Srf;
export interface CreateB2BUAOptions {
headers?: SipMessageHeaders;
responseHeaders?: SipMessageHeaders | ((uacRes: SipMessageHeaders, headers: SipMessageHeaders) => SipMessageHeaders | null);
localSdpA?: string | ((sdp: string, res: SrfResponse) => string | Promise<string>);
localSdpB?: string | ((sdp: string) => string | Promise<string>);
proxyRequestHeaders?: string[];
proxyResponseHeaders?: string[];
passFailure?: boolean;
passProvisionalResponses?: boolean;
proxy?: string;
auth?: { username: string; password: string; };
}
}

declare class Srf extends EventEmitter {
constructor();
constructor(tags: string | string[]);
connect(config?: 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;
invite(callback: (req: Srf.SrfRequest, res: Srf.SrfResponse) => void): void;
request(uri: string, opts: Srf.SrfRequest, method: Srf.SipMethod, [body]: string[]): Promise<Srf.SrfRequest>;
request(uri: string, opts: Srf.SrfRequest, method: Srf.SipMethod, [body]: string[], callback?: (err: any, requestSent: Srf.SrfRequest) => void): void;
proxyRequest(req: Srf.SrfRequest, destination: string | string[], opts?: Srf.ProxyRequestOptions, callback?: (err: any, results: string) => void): void;
createUAS(req: Srf.SrfRequest, res: Srf.SrfResponse, opts: Srf.CreateUASOptions): Promise<Srf.Dialog>;
createUAS(req: Srf.SrfRequest, res: Srf.SrfResponse, opts: Srf.CreateUASOptions, callback?: (err: any, dialog: Srf.Dialog) => void): this;
createUAC(uri: string | Srf.CreateUACOptions, opts?: Srf.CreateUACOptions, progressCallbacks?: { cbRequest?: (req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Srf.SrfResponse) => void; }): Promise<Srf.Dialog>;
createUAC(uri: string | Srf.CreateUACOptions, opts?: Srf.CreateUACOptions, progressCallbacks?: { cbRequest?: (req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Srf.SrfResponse) => void; }, callback?: (err: any, dialog: Srf.Dialog) => void): this;
createB2BUA(req: Srf.SrfRequest, res: Srf.SrfResponse, uri: string, opts: Srf.CreateB2BUAOptions, progressCallbacks?: { cbRequest?: (req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Response) => void; cbFinalizedUac?: (uac: Srf.Dialog) => void; }): Promise<{ uas: Srf.Dialog; uac: Srf.Dialog }>;
createB2BUA(req: Srf.SrfRequest, res: Srf.SrfResponse, uri: string, opts: Srf.CreateB2BUAOptions, progressCallbacks?: { cbRequest?: (req: Srf.SrfRequest) => void; cbProvisional?: (provisionalRes: Response) => void; cbFinalizedUac?: (uac: Srf.Dialog) => void; }, callback?: (err: any, dialog: Srf.Dialog) => void): this;
on(event: 'connect', listener: (err: Error, hostPort: string) => void): this;
on(event: 'error', listener: (err: Error) => void): this;
on(event: 'disconnect', listener: () => void): this;
on(event: 'message', listener: (req: Srf.SrfRequest, res: Srf.SrfResponse) => void): this;
on(event: 'request', listener: (req: Srf.SrfRequest, res: Srf.SrfResponse) => void): this;
on(event: 'register' | 'invite' | 'bye' | 'cancel' | 'ack' | 'info' | 'notify' | 'options' | 'prack' | 'publish' | 'refer' | 'subscribe' | 'update', listener: (req: Srf.SrfRequest, res: Srf.SrfResponse) => void): this;
on(event: 'cdr:attempt', listener: (source: string, time: string, msg: Srf.SipMessage) => void): this;
on(event: 'cdr:start', listener: (source: string, time: string, role: string, msg: Srf.SipMessage) => void): this;
on(event: 'cdr:stop', listener: (source: string, time: string, reason: string, msg: Srf.SipMessage) => void): this;
locals: { [name: string]: any };
socket: Socket;
}

export = Srf;

0 comments on commit c34a7e7

Please sign in to comment.