ringcentral-softphone 1.3.2 → 1.3.4

package/dist/esm/index.js

@@ -1,204 +0,0 @@
-import EventEmitter from "node:events";
-import tls from "node:tls";
-import waitFor from "wait-for-async";
-import InboundCallSession from "./call-session/inbound.js";
-import OutboundCallSession from "./call-session/outbound.js";
-import { InboundMessage, OutboundMessage, RequestMessage, ResponseMessage, } from "./sip-message/index.js";
-import { branch, generateAuthorization, localKey, randomInt, uuid, } from "./utils.js";
-import Codec from "./codec.js";
-class Softphone extends EventEmitter {
-    sipInfo;
-    client;
-    codec;
-    fakeDomain = uuid() + ".invalid";
-    fakeEmail = uuid() + "@" + this.fakeDomain;
-    intervalHandle;
-    connected = false;
-    constructor(sipInfo) {
-        super();
-        if (sipInfo.codec === undefined) {
-            sipInfo.codec = "OPUS/16000";
-        }
-        this.codec = new Codec(sipInfo.codec);
-        this.sipInfo = sipInfo;
-        if (this.sipInfo.domain === undefined) {
-            this.sipInfo.domain = "sip.ringcentral.com";
-        }
-        if (this.sipInfo.outboundProxy === undefined) {
-            this.sipInfo.outboundProxy = "sip10.ringcentral.com:5096";
-        }
-        const tokens = this.sipInfo.outboundProxy.split(":");
-        this.client = tls.connect({
-            host: tokens[0],
-            port: parseInt(tokens[1], 10),
-            rejectUnauthorized: !this.sipInfo.ignoreTlsCertErrors,
-        }, () => {
-            this.connected = true;
-        });
-        let cache = "";
-        this.client.on("data", (data) => {
-            cache += data.toString("utf-8");
-            if (!cache.endsWith("\r\n")) {
-                return; // haven't received a complete message yet
-            }
-            // received two empty body messages
-            const tempMessages = cache
-                .split("\r\nContent-Length: 0\r\n\r\n")
-                .filter((message) => message.trim() !== "");
-            cache = "";
-            for (let i = 0; i < tempMessages.length; i++) {
-                if (!tempMessages[i].includes("Content-Length: ")) {
-                    tempMessages[i] = tempMessages[i] + "\r\nContent-Length: 0";
-                }
-            }
-            for (const message of tempMessages) {
-                this.emit("message", InboundMessage.fromString(message));
-            }
-        });
-    }
-    instanceId = uuid();
-    registerCallId = uuid();
-    async register() {
-        if (!this.connected) {
-            await waitFor({
-                interval: 100,
-                times: 100,
-                condition: () => this.connected,
-            });
-            if (!this.connected) {
-                throw new Error("Failed to register: connect to TLS timeout");
-            }
-        }
-        const sipRegister = async () => {
-            const fromTag = uuid();
-            const requestMessage = new RequestMessage(`REGISTER sip:${this.sipInfo.domain} SIP/2.0`, {
-                Via: `SIP/2.0/TLS ${this.client.localAddress}:${this.client.localPort};rport;branch=${branch()};alias`,
-                "Max-Forwards": "70",
-                From: `<sip:${this.sipInfo.username}@${this.sipInfo.domain}>;tag=${fromTag}`,
-                To: `<sip:${this.sipInfo.username}@${this.sipInfo.domain}>`,
-                "Call-ID": this.registerCallId,
-                Contact: `<sip:${this.sipInfo.username}@${this.client.localAddress}:${this.client.localPort};transport=TLS;ob>;reg-id=1;+sip.instance="<urn:uuid:${this.instanceId}>"`,
-                Expires: 3600,
-                Allow: "PRACK, INVITE, ACK, BYE, CANCEL, UPDATE, INFO, SUBSCRIBE, NOTIFY, REFER, MESSAGE, OPTIONS",
-            });
-            const inboundMessage = await this.send(requestMessage, true);
-            if (inboundMessage.subject.startsWith("SIP/2.0 200 ")) {
-                // sometimes the server will return 200 OK directly
-                return;
-            }
-            const wwwAuth = inboundMessage.getHeader("Www-Authenticate");
-            const nonce = wwwAuth.match(/, nonce="(.+?)"/)[1];
-            const newMessage = requestMessage.fork();
-            newMessage.headers.Authorization = generateAuthorization(this.sipInfo, nonce, "REGISTER");
-            const message = await this.send(newMessage, true);
-            if (!message.subject.startsWith("SIP/2.0 200 ")) {
-                throw new Error("Failed to register: " + message.subject);
-            }
-        };
-        await sipRegister();
-        this.intervalHandle = setInterval(() => {
-            sipRegister();
-        }, 30 * 1000);
-        this.on("message", (inboundMessage) => {
-            if (!inboundMessage.subject.startsWith("INVITE sip:")) {
-                return;
-            }
-            const outboundMessage = new OutboundMessage("SIP/2.0 100 Trying", {
-                Via: inboundMessage.headers.Via,
-                "Call-ID": inboundMessage.getHeader("Call-ID"),
-                From: inboundMessage.headers.From,
-                To: inboundMessage.headers.To,
-                CSeq: inboundMessage.headers.CSeq,
-                "Content-Length": "0",
-            });
-            this.send(outboundMessage);
-            this.emit("invite", inboundMessage);
-        });
-    }
-    enableDebugMode() {
-        this.on("message", (message) => console.log(`Receiving...(${new Date()})\n` + message.toString()));
-        const tlsWrite = this.client.write.bind(this.client);
-        this.client.write = (message) => {
-            console.log(`Sending...(${new Date()})\n` + message);
-            return tlsWrite(message);
-        };
-    }
-    revoke() {
-        clearInterval(this.intervalHandle);
-        this.removeAllListeners();
-        this.client.removeAllListeners();
-        this.client.destroy();
-    }
-    send(message, waitForReply = false) {
-        this.client.write(message.toString());
-        if (!waitForReply) {
-            return new Promise((resolve) => {
-                resolve(undefined);
-            });
-        }
-        return new Promise((resolve) => {
-            const messageListerner = (inboundMessage) => {
-                // "12563 INVITE" vs "12563 ACK"
-                if (inboundMessage.headers.CSeq.trim().split(/\s+/)[0] !==
-                    message.headers.CSeq.trim().split(/\s+/)[0]) {
-                    return;
-                }
-                if (inboundMessage.subject.startsWith("SIP/2.0 100 ")) {
-                    return; // ignore
-                }
-                this.off("message", messageListerner);
-                resolve(inboundMessage);
-            };
-            this.on("message", messageListerner);
-        });
-    }
-    async answer(inviteMessage) {
-        const inboundCallSession = new InboundCallSession(this, inviteMessage);
-        await inboundCallSession.answer();
-        return inboundCallSession;
-    }
-    // decline an inbound call
-    async decline(inviteMessage) {
-        const newMessage = new ResponseMessage(inviteMessage, 603);
-        await this.send(newMessage);
-    }
-    async call(callee) {
-        const offerSDP = `
-v=0
-o=- ${Date.now()} 0 IN IP4 ${this.client.localAddress}
-s=rc-softphone-ts
-c=IN IP4 ${this.client.localAddress}
-t=0 0
-m=audio ${randomInt()} RTP/SAVP ${this.codec.id} 101
-a=rtpmap:${this.codec.id} ${this.codec.name}
-a=rtpmap:101 telephone-event/8000
-a=fmtp:101 0-15
-a=sendrecv
-a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${localKey}
-  `.trim();
-        const inviteMessage = new RequestMessage(`INVITE sip:${callee}@${this.sipInfo.domain} SIP/2.0`, {
-            Via: `SIP/2.0/TLS ${this.client.localAddress}:${this.client.localPort};rport;branch=${branch()};alias`,
-            "Max-Forwards": 70,
-            From: `<sip:${this.sipInfo.username}@${this.sipInfo.domain}>;tag=${uuid()}`,
-            To: `<sip:${callee}@sip.ringcentral.com>`,
-            Contact: ` <sip:${this.sipInfo.username}@${this.client.localAddress}:${this.client.localPort};transport=TLS;ob>`,
-            "Call-ID": uuid(),
-            Route: `<sip:${this.sipInfo.outboundProxy};transport=tls;lr>`,
-            Allow: `PRACK, INVITE, ACK, BYE, CANCEL, UPDATE, INFO, SUBSCRIBE, NOTIFY, REFER, MESSAGE, OPTIONS`,
-            Supported: `replaces, 100rel, timer, norefersub`,
-            "Session-Expires": 1800,
-            "Min-SE": 90,
-            "Content-Type": "application/sdp",
-        }, offerSDP);
-        const inboundMessage = await this.send(inviteMessage, true);
-        const proxyAuthenticate = inboundMessage.getHeader("Proxy-Authenticate");
-        const nonce = proxyAuthenticate.match(/, nonce="(.+?)"/)[1];
-        const newMessage = inviteMessage.fork();
-        newMessage.headers["Proxy-Authorization"] = generateAuthorization(this.sipInfo, nonce, "INVITE");
-        const progressMessage = await this.send(newMessage, true);
-        const outboundCallSession = new OutboundCallSession(this, progressMessage);
-        outboundCallSession.sdp = offerSDP;
-        return outboundCallSession;
-    }
-}
-export default Softphone;

package/dist/esm/sip-message/inbound/index.d.ts

@@ -1,5 +0,0 @@
-import SipMessage from "../sip-message.js";
-declare class InboundMessage extends SipMessage {
-    static fromString(str: string): SipMessage;
-}
-export default InboundMessage;

package/dist/esm/sip-message/inbound/index.js

@@ -1,17 +0,0 @@
-import { uuid } from "../../utils.js";
-import SipMessage from "../sip-message.js";
-class InboundMessage extends SipMessage {
-    static fromString(str) {
-        const sipMessage = new SipMessage();
-        const [init, ...body] = str.split("\r\n\r\n");
-        sipMessage.body = body.join("\r\n\r\n");
-        const [subject, ...headers] = init.split("\r\n");
-        sipMessage.subject = subject;
-        sipMessage.headers = Object.fromEntries(headers.map((line) => line.split(": ")));
-        if (sipMessage.headers.To && !sipMessage.headers.To.includes(";tag=")) {
-            sipMessage.headers.To += ";tag=" + uuid(); // generate local tag
-        }
-        return sipMessage;
-    }
-}
-export default InboundMessage;

package/dist/esm/sip-message/index.js

@@ -1,5 +0,0 @@
-export { default as RequestMessage } from "./outbound/request.js";
-export { default as ResponseMessage } from "./outbound/response.js";
-export { default as OutboundMessage } from "./outbound/index.js";
-export { default as InboundMessage } from "./inbound/index.js";
-export { default as SipMessage } from "./sip-message.js";

package/dist/esm/sip-message/outbound/index.d.ts

@@ -1,5 +0,0 @@
-import SipMessage from "../sip-message.js";
-declare class OutboundMessage extends SipMessage {
-    constructor(subject?: string, headers?: {}, body?: string);
-}
-export default OutboundMessage;

package/dist/esm/sip-message/outbound/index.js

@@ -1,9 +0,0 @@
-import SipMessage from "../sip-message.js";
-class OutboundMessage extends SipMessage {
-    constructor(subject = "", headers = {}, body = "") {
-        super(subject, headers, body);
-        this.headers["Content-Length"] = this.body.length.toString();
-        this.headers["User-Agent"] = "ringcentral-softphone-ts";
-    }
-}
-export default OutboundMessage;

package/dist/esm/sip-message/outbound/request.d.ts

@@ -1,7 +0,0 @@
-import OutboundMessage from "./index.js";
-declare class RequestMessage extends OutboundMessage {
-    constructor(subject?: string, headers?: {}, body?: string);
-    newCseq(): void;
-    fork(): RequestMessage;
-}
-export default RequestMessage;

package/dist/esm/sip-message/outbound/request.js

@@ -1,23 +0,0 @@
-import OutboundMessage from "./index.js";
-import { branch } from "../../utils.js";
-let cseq = Math.floor(Math.random() * 10000);
-class RequestMessage extends OutboundMessage {
-    constructor(subject = "", headers = {}, body = "") {
-        super(subject, headers, body);
-        if (this.headers.CSeq === undefined) {
-            this.newCseq();
-        }
-    }
-    newCseq() {
-        this.headers.CSeq = `${++cseq} ${this.subject.split(" ")[0]}`;
-    }
-    fork() {
-        const newMessage = new RequestMessage(this.subject, { ...this.headers }, this.body);
-        newMessage.newCseq();
-        if (newMessage.headers.Via) {
-            newMessage.headers.Via = newMessage.headers.Via.replace(/;branch=.+?$/, `;branch=${branch()}`);
-        }
-        return newMessage;
-    }
-}
-export default RequestMessage;

package/dist/esm/sip-message/outbound/response.d.ts

@@ -1,6 +0,0 @@
-import OutboundMessage from "./index.js";
-import type InboundMessage from "../inbound/index.js";
-declare class ResponseMessage extends OutboundMessage {
-    constructor(inboundMessage: InboundMessage, responseCode: number, headers?: {}, body?: string);
-}
-export default ResponseMessage;

package/dist/esm/sip-message/outbound/response.js

@@ -1,20 +0,0 @@
-import OutboundMessage from "./index.js";
-import responseCodes from "../response-codes.js";
-class ResponseMessage extends OutboundMessage {
-    constructor(inboundMessage, responseCode, headers = {}, body = "") {
-        super(undefined, { ...headers }, body);
-        this.subject = `SIP/2.0 ${responseCode} ${responseCodes[responseCode]}`;
-        const requiredKeys = new Set(["via", "from", "to", "call-id", "cseq"]);
-        const allKeys = Object.keys(inboundMessage.headers).reduce((acc, key) => {
-            acc[key.toLowerCase()] = key;
-            return acc;
-        }, {});
-        for (const key of requiredKeys) {
-            if (allKeys[key]) {
-                const originalKey = allKeys[key];
-                this.headers[originalKey] = inboundMessage.headers[originalKey];
-            }
-        }
-    }
-}
-export default ResponseMessage;

package/dist/esm/sip-message/response-codes.d.ts

@@ -1,4 +0,0 @@
-declare const responseCodes: {
-    [key: number]: string;
-};
-export default responseCodes;

package/dist/esm/sip-message/response-codes.js

@@ -1,81 +0,0 @@
-// Ref: https://en.wikipedia.org/wiki/List_of_SIP_response_codes'
-const responseCodes = {
-    100: "Trying",
-    180: "Ringing",
-    181: "Call is Being Forwarded",
-    182: "Queued",
-    183: "Session Progress",
-    199: "Early Dialog Terminated",
-    200: "OK",
-    202: "Accepted",
-    204: "No Notification",
-    300: "Multiple Choices",
-    301: "Moved Permanently",
-    302: "Moved Temporarily",
-    305: "Use Proxy",
-    380: "Alternative Service",
-    400: "Bad Request",
-    401: "Unauthorized",
-    402: "Payment Required",
-    403: "Forbidden",
-    404: "Not Found",
-    405: "Method Not Allowed",
-    406: "Not Acceptable",
-    407: "Proxy Authentication Required",
-    408: "Request Timeout",
-    409: "Conflict",
-    410: "Gone",
-    411: "Length Required",
-    412: "Conditional Request Failed",
-    413: "Request Entity Too Large",
-    414: "Request-URI Too Long",
-    415: "Unsupported Media Type",
-    416: "Unsupported URI Scheme",
-    417: "Unknown Resource-Priority",
-    420: "Bad Extension",
-    421: "Extension Required",
-    422: "Session Interval Too Small",
-    423: "Interval Too Brief",
-    424: "Bad Location Information",
-    425: "Bad Alert Message",
-    428: "Use Identity Header",
-    429: "Provide Referrer Identity",
-    430: "Flow Failed",
-    433: "Anonymity Disallowed",
-    436: "Bad Identity-Info",
-    437: "Unsupported Certificate",
-    438: "Invalid Identity Header",
-    439: "First Hop Lacks Outbound Support",
-    440: "Max-Breadth Exceeded",
-    469: "Bad Info Package",
-    470: "Consent Needed",
-    480: "Temporarily Unavailable",
-    481: "Call/Transaction Does Not Exist",
-    482: "Loop Detected",
-    483: "Too Many Hops",
-    484: "Address Incomplete",
-    485: "Ambiguous",
-    486: "Busy Here",
-    487: "Request Terminated",
-    488: "Not Acceptable Here",
-    489: "Bad Event",
-    491: "Request Pending",
-    493: "Undecipherable",
-    494: "Security Agreement Required",
-    500: "Server Internal Error",
-    501: "Not Implemented",
-    502: "Bad Gateway",
-    503: "Service Unavailable",
-    504: "Server Time-out",
-    505: "Version Not Supported",
-    513: "Message Too Large",
-    555: "Push Notification Service Not Supported",
-    580: "Precondition Failure",
-    600: "Busy Everywhere",
-    603: "Decline",
-    604: "Does Not Exist Anywhere",
-    606: "Not Acceptable",
-    607: "Unwanted",
-    608: "Rejected",
-};
-export default responseCodes;

package/dist/esm/sip-message/sip-message.d.ts

@@ -1,11 +0,0 @@
-declare class SipMessage {
-    subject: string;
-    headers: {
-        [key: string]: string;
-    };
-    body: string;
-    constructor(subject?: string, headers?: {}, body?: string);
-    toString(): string;
-    getHeader(key: string): string | undefined;
-}
-export default SipMessage;

package/dist/esm/sip-message/sip-message.js

@@ -1,32 +0,0 @@
-class SipMessage {
-    subject;
-    headers;
-    body;
-    constructor(subject = "", headers = {}, body = "") {
-        this.subject = subject;
-        this.headers = headers;
-        this.body = body
-            .trim()
-            .split(/[\r\n]+/)
-            .join("\r\n");
-        if (this.body.length > 0) {
-            this.body += "\r\n";
-        }
-    }
-    toString() {
-        const r = [
-            this.subject,
-            ...Object.keys(this.headers).map((key) => `${key}: ${this.headers[key]}`),
-            "",
-            this.body,
-        ].join("\r\n");
-        return r;
-    }
-    getHeader(key) {
-        const foundKey = Object.keys(this.headers).find((k) => k.toLowerCase() === key.toLowerCase());
-        if (foundKey) {
-            return this.headers[foundKey];
-        }
-    }
-}
-export default SipMessage;

package/dist/esm/types.d.ts

@@ -1,9 +0,0 @@
-export type SoftPhoneOptions = {
-    domain: string;
-    outboundProxy: string;
-    username: string;
-    password: string;
-    authorizationId: string;
-    codec?: "OPUS/16000" | "OPUS/48000/2" | "PCMU/8000";
-    ignoreTlsCertErrors?: boolean;
-};

package/dist/esm/types.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/utils.d.ts

@@ -1,8 +0,0 @@
-import { SoftPhoneOptions } from "./types.js";
-export declare const generateAuthorization: (sipInfo: SoftPhoneOptions, nonce: string, method: "REGISTER" | "INVITE") => string;
-export declare const uuid: () => `${string}-${string}-${string}-${string}-${string}`;
-export declare const branch: () => string;
-export declare const randomInt: () => number;
-export declare const withoutTag: (s: string) => string;
-export declare const extractAddress: (s: string) => string;
-export declare const localKey: string;

package/dist/esm/utils.js

@@ -1,28 +0,0 @@
-import crypto from "node:crypto";
-const md5 = (s) => crypto.createHash("md5").update(s).digest("hex");
-const generateResponse = (sipInfo, endpoint, nonce) => {
-    const ha1 = md5(`${sipInfo.authorizationId}:${sipInfo.domain}:${sipInfo.password}`);
-    const ha2 = md5(endpoint);
-    const response = md5(`${ha1}:${nonce}:${ha2}`);
-    return response;
-};
-export const generateAuthorization = (sipInfo, nonce, method) => {
-    const authObj = {
-        "Digest algorithm": "MD5",
-        username: sipInfo.authorizationId,
-        realm: sipInfo.domain,
-        nonce,
-        uri: `sip:${sipInfo.domain}`,
-        response: generateResponse(sipInfo, `${method}:sip:${sipInfo.domain}`, nonce),
-    };
-    return Object.keys(authObj)
-        .map((key) => `${key}="${authObj[key]}"`)
-        .join(", ");
-};
-export const uuid = () => crypto.randomUUID();
-export const branch = () => "z9hG4bK-" + uuid();
-export const randomInt = () => Math.floor(Math.random() * (65535 - 1024 + 1)) + 1024;
-export const withoutTag = (s) => s.replace(/;tag=.*$/, "");
-export const extractAddress = (s) => s.match(/<(sip:.+?)>/)?.[1];
-const keyAndSalt = crypto.randomBytes(30);
-export const localKey = keyAndSalt.toString("base64").replace(/=+$/, "");

package/dist/{cjs/call-session → call-session}/inbound.d.ts

@@ -1,6 +1,6 @@
-import CallSession from "./index.js";
-import { type InboundMessage } from "../sip-message/index.js";
 import type Softphone from "../index.js";
+import { type InboundMessage } from "../sip-message/index.js";
+import CallSession from "./index.js";
 declare class InboundCallSession extends CallSession {
     constructor(softphone: Softphone, inviteMessage: InboundMessage);
     answer(): Promise<void>;

package/dist/{cjs/call-session → call-session}/outbound.d.ts

@@ -1,6 +1,6 @@
-import CallSession from "./index.js";
-import { type InboundMessage } from "../sip-message/index.js";
 import type Softphone from "../index.js";
+import { type InboundMessage } from "../sip-message/index.js";
+import CallSession from "./index.js";
 declare class OutboundCallSession extends CallSession {
     constructor(softphone: Softphone, answerMessage: InboundMessage);
     init(): void;

package/dist/{esm/sip-message → sip-message}/index.d.ts

@@ -1,5 +1,5 @@
+export { default as InboundMessage } from "./inbound/index.js";
+export { default as OutboundMessage } from "./outbound/index.js";
 export { default as RequestMessage } from "./outbound/request.js";
 export { default as ResponseMessage } from "./outbound/response.js";
-export { default as OutboundMessage } from "./outbound/index.js";
-export { default as InboundMessage } from "./inbound/index.js";
 export { default as SipMessage } from "./sip-message.js";

package/dist/{cjs/sip-message → sip-message}/outbound/response.d.ts

@@ -1,5 +1,5 @@
-import OutboundMessage from "./index.js";
 import type InboundMessage from "../inbound/index.js";
+import OutboundMessage from "./index.js";
 declare class ResponseMessage extends OutboundMessage {
     constructor(inboundMessage: InboundMessage, responseCode: number, headers?: {}, body?: string);
 }