node-datachannel 0.12.0 → 0.20.0-alpha.2

package/lib/index.d.cts

@@ -1,300 +0,0 @@
-import * as stream from 'stream';
-
-export as namespace NodeDataChannel;
-
-// Enum in d.ts is tricky
-export type LogLevel = 'Verbose' | 'Debug' | 'Info' | 'Warning' | 'Error' | 'Fatal';
-
-// SCTP Settings
-export interface SctpSettings {
-    recvBufferSize?: number;
-    sendBufferSize?: number;
-    maxChunksOnQueue?: number;
-    initialCongestionWindow?: number;
-    congestionControlModule?: number;
-    delayedSackTime?: number;
-}
-
-// Functions
-export function preload(): void;
-export function initLogger(level: LogLevel, callback?: (level: LogLevel, message: string) => void): void;
-export function cleanup(): void;
-export function setSctpSettings(settings: SctpSettings): void;
-
-// Proxy Server
-export type ProxyServerType = 'Socks5' | 'Http';
-export interface ProxyServer {
-    type: ProxyServerType;
-    ip: string;
-    port: number;
-    username?: string;
-    password?: string;
-}
-
-export const enum RelayType {
-    TurnUdp = 'TurnUdp',
-    TurnTcp = 'TurnTcp',
-    TurnTls = 'TurnTls',
-}
-
-export interface IceServer {
-    hostname: string;
-    port: number;
-    username?: string;
-    password?: string;
-    relayType?: RelayType;
-}
-
-export type TransportPolicy = 'all' | 'relay';
-
-export interface RtcConfig {
-    iceServers: (string | IceServer)[];
-    proxyServer?: ProxyServer;
-    bindAddress?: string;
-    enableIceTcp?: boolean;
-    enableIceUdpMux?: boolean;
-    disableAutoNegotiation?: boolean;
-    forceMediaTransport?: boolean;
-    portRangeBegin?: number;
-    portRangeEnd?: number;
-    maxMessageSize?: number;
-    mtu?: number;
-    iceTransportPolicy?: TransportPolicy;
-}
-
-// Lowercase to match the description type string from libdatachannel
-export enum DescriptionType {
-    Unspec = 'unspec',
-    Offer = 'offer',
-    Answer = 'answer',
-    Pranswer = 'pranswer',
-    Rollback = 'rollback',
-}
-
-export interface DataChannelInitConfig {
-    protocol?: string;
-    negotiated?: boolean;
-    id?: number;
-    unordered?: boolean; // Reliability
-    maxPacketLifeTime?: number; // Reliability
-    maxRetransmits?: number; // Reliability
-}
-
-export interface SelectedCandidateInfo {
-    address: string;
-    port: number;
-    type: string;
-    transportType: string;
-    candidate: string;
-    mid: string;
-    priority: number;
-}
-
-// Must be same as rtc enum class Direction
-export const enum Direction {
-    SendOnly = 'SendOnly',
-    RecvOnly = 'RecvOnly',
-    SendRecv = 'SendRecv',
-    Inactive = 'Inactive',
-    Unknown = 'Unknown',
-}
-
-export class RtcpReceivingSession {
-    //
-}
-
-export class Audio {
-    constructor(mid: string, dir: Direction);
-    addAudioCodec(payloadType: number, codec: string, profile?: string): void;
-    addOpusCodec(payloadType: number, profile?: string): string;
-
-    direction(): Direction;
-    generateSdp(eol: string, addr: string, port: number): string;
-    mid(): string;
-    setDirection(dir: Direction): void;
-    description(): string;
-    removeFormat(fmt: string): void;
-    addSSRC(ssrc: number, name?: string, msid?: string, trackID?: string): void;
-    removeSSRC(ssrc: number): void;
-    replaceSSRC(oldSsrc: number, ssrc: number, name?: string, msid?: string, trackID?: string): void;
-    hasSSRC(ssrc: number): boolean;
-    getSSRCs(): number[];
-    getCNameForSsrc(ssrc: number): string;
-    setBitrate(bitRate: number): void;
-    getBitrate(): number;
-    hasPayloadType(payloadType: number): boolean;
-    addRTXCodec(payloadType: number, originalPayloadType: number, clockRate: number): void;
-    addRTPMap(): void;
-    parseSdpLine(line: string): void;
-}
-
-export class Video {
-    constructor(mid: string, dir: Direction);
-    addVideoCodec(payloadType: number, codec: string, profile?: string): void;
-    addH264Codec(payloadType: number, profile?: string): void;
-    addVP8Codec(payloadType: number): void;
-    addVP9Codec(payloadType: number): void;
-
-    direction(): Direction;
-    generateSdp(eol: string, addr: string, port: number): string;
-    mid(): string;
-    setDirection(dir: Direction): void;
-    description(): string;
-    removeFormat(fmt: string): void;
-    addSSRC(ssrc: number, name?: string, msid?: string, trackID?: string): void;
-    removeSSRC(ssrc: number): void;
-    replaceSSRC(oldSsrc: number, ssrc: number, name?: string, msid?: string, trackID?: string): void;
-    hasSSRC(ssrc: number): boolean;
-    getSSRCs(): number[];
-    getCNameForSsrc(ssrc: number): string;
-    setBitrate(bitRate: number): void;
-    getBitrate(): number;
-    hasPayloadType(payloadType: number): boolean;
-    addRTXCodec(payloadType: number, originalPayloadType: number, clockRate: number): void;
-    addRTPMap(): void;
-    parseSdpLine(line: string): void;
-}
-
-export class Track {
-    direction(): Direction;
-    mid(): string;
-    type(): string;
-    close(): void;
-    sendMessage(msg: string): boolean;
-    sendMessageBinary(buffer: Buffer): boolean;
-    isOpen(): boolean;
-    isClosed(): boolean;
-    bufferedAmount(): number;
-    maxMessageSize(): number;
-    requestBitrate(bitRate: number): boolean;
-    setBufferedAmountLowThreshold(newSize: number): void;
-    requestKeyframe(): boolean;
-    setMediaHandler(handler: RtcpReceivingSession): void;
-    onOpen(cb: () => void): void;
-    onClosed(cb: () => void): void;
-    onError(cb: (err: string) => void): void;
-    onMessage(cb: (msg: Buffer) => void): void;
-}
-
-export interface Channel {
-    close(): void;
-    sendMessage(msg: string): boolean;
-    sendMessageBinary(buffer: Uint8Array): boolean;
-    isOpen(): boolean;
-    bufferedAmount(): number;
-    maxMessageSize(): number;
-    setBufferedAmountLowThreshold(newSize: number): void;
-    onOpen(cb: () => void): void;
-    onClosed(cb: () => void): void;
-    onError(cb: (err: string) => void): void;
-    onBufferedAmountLow(cb: () => void): void;
-    onMessage(cb: (msg: string | Buffer) => void): void;
-}
-export class DataChannel implements Channel {
-    getLabel(): string;
-    getId(): number;
-    getProtocol(): string;
-
-    // Channel implementation
-    close(): void;
-    sendMessage(msg: string): boolean;
-    sendMessageBinary(buffer: Uint8Array): boolean;
-    isOpen(): boolean;
-    bufferedAmount(): number;
-    maxMessageSize(): number;
-    setBufferedAmountLowThreshold(newSize: number): void;
-    onOpen(cb: () => void): void;
-    onClosed(cb: () => void): void;
-    onError(cb: (err: string) => void): void;
-    onBufferedAmountLow(cb: () => void): void;
-    onMessage(cb: (msg: string | Buffer) => void): void;
-}
-
-export interface WebSocketConfiguration {
-    disableTlsVerification?: boolean; // default = false, if true, don't verify the TLS certificate
-    proxyServer?: ProxyServer; // only non-authenticated http supported for now
-    protocols?: string[];
-    connectionTimeout?: number; // miliseconds, zero to disable
-    pingInterval?: number; // millisecondrs, zero to disable
-    maxOutstandingPings?: number;
-    caCertificatePemFile?: string;
-    certificatePemFile?: string;
-    keyPemFile?: string;
-    keyPemPass?: string;
-    maxMessageSize: number;
-}
-export class WebSocket implements Channel {
-    constructor(config?: WebSocketConfiguration);
-    open(url: string): void;
-    forceClose(): void;
-    remoteAddress(): string | undefined;
-    path(): string | undefined;
-
-    // Channel implementation
-    close(): void;
-    sendMessage(msg: string): boolean;
-    sendMessageBinary(buffer: Uint8Array): boolean;
-    isOpen(): boolean;
-    bufferedAmount(): number;
-    maxMessageSize(): number;
-    setBufferedAmountLowThreshold(newSize: number): void;
-    onOpen(cb: () => void): void;
-    onClosed(cb: () => void): void;
-    onError(cb: (err: string) => void): void;
-    onBufferedAmountLow(cb: () => void): void;
-    onMessage(cb: (msg: string | Buffer) => void): void;
-}
-
-export interface WebSocketServerConfiguration {
-    port?: number; // default 8080
-    enableTls?: boolean; // default = false;
-    certificatePemFile?: string;
-    keyPemFile?: string;
-    keyPemPass?: string;
-    bindAddress?: string;
-    connectionTimeout?: number; // milliseconds
-    maxMessageSize?: number;
-}
-
-export class WebSocketServer {
-    constructor(config?: WebSocketServerConfiguration);
-    port(): number;
-    stop(): void;
-    onClient(cb: (ws: WebSocket) => void): void;
-}
-
-export class PeerConnection {
-    constructor(peerName: string, config: RtcConfig);
-    close(): void;
-    setLocalDescription(type?: DescriptionType): void;
-    setRemoteDescription(sdp: string, type: DescriptionType): void;
-    localDescription(): { type: string; sdp: string } | null;
-    remoteDescription(): { type: string; sdp: string } | null;
-    addRemoteCandidate(candidate: string, mid: string): void;
-    createDataChannel(label: string, config?: DataChannelInitConfig): DataChannel;
-    addTrack(media: Video | Audio): Track;
-    hasMedia(): boolean;
-    state(): RTCPeerConnectionState;
-    iceState(): RTCIceConnectionState;
-    signalingState(): RTCSignalingState;
-    gatheringState(): RTCIceGatheringState;
-    onLocalDescription(cb: (sdp: string, type: DescriptionType) => void): void;
-    onLocalCandidate(cb: (candidate: string, mid: string) => void): void;
-    onStateChange(cb: (state: string) => void): void;
-    onIceStateChange(cb: (state: string) => void): void;
-    onSignalingStateChange(cb: (state: string) => void): void;
-    onGatheringStateChange(cb: (state: string) => void): void;
-    onDataChannel(cb: (dc: DataChannel) => void): void;
-    onTrack(cb: (track: Track) => void): void;
-    bytesSent(): number;
-    bytesReceived(): number;
-    rtt(): number;
-    getSelectedCandidatePair(): { local: SelectedCandidateInfo; remote: SelectedCandidateInfo } | null;
-    maxDataChannelId(): number;
-    maxMessageSize(): number;
-}
-
-export class DataChannelStream extends stream.Duplex {
-    constructor(rawChannel: DataChannel, options?: Omit<stream.DuplexOptions, 'objectMode'>);
-    get label(): string;
-}

package/lib/index.d.ts

@@ -1,300 +0,0 @@
-import * as stream from 'stream';
-
-export as namespace NodeDataChannel;
-
-// Enum in d.ts is tricky
-export type LogLevel = 'Verbose' | 'Debug' | 'Info' | 'Warning' | 'Error' | 'Fatal';
-
-// SCTP Settings
-export interface SctpSettings {
-    recvBufferSize?: number;
-    sendBufferSize?: number;
-    maxChunksOnQueue?: number;
-    initialCongestionWindow?: number;
-    congestionControlModule?: number;
-    delayedSackTime?: number;
-}
-
-// Functions
-export function preload(): void;
-export function initLogger(level: LogLevel, callback?: (level: LogLevel, message: string) => void): void;
-export function cleanup(): void;
-export function setSctpSettings(settings: SctpSettings): void;
-
-// Proxy Server
-export type ProxyServerType = 'Socks5' | 'Http';
-export interface ProxyServer {
-    type: ProxyServerType;
-    ip: string;
-    port: number;
-    username?: string;
-    password?: string;
-}
-
-export const enum RelayType {
-    TurnUdp = 'TurnUdp',
-    TurnTcp = 'TurnTcp',
-    TurnTls = 'TurnTls',
-}
-
-export interface IceServer {
-    hostname: string;
-    port: number;
-    username?: string;
-    password?: string;
-    relayType?: RelayType;
-}
-
-export type TransportPolicy = 'all' | 'relay';
-
-export interface RtcConfig {
-    iceServers: (string | IceServer)[];
-    proxyServer?: ProxyServer;
-    bindAddress?: string;
-    enableIceTcp?: boolean;
-    enableIceUdpMux?: boolean;
-    disableAutoNegotiation?: boolean;
-    forceMediaTransport?: boolean;
-    portRangeBegin?: number;
-    portRangeEnd?: number;
-    maxMessageSize?: number;
-    mtu?: number;
-    iceTransportPolicy?: TransportPolicy;
-}
-
-// Lowercase to match the description type string from libdatachannel
-export enum DescriptionType {
-    Unspec = 'unspec',
-    Offer = 'offer',
-    Answer = 'answer',
-    Pranswer = 'pranswer',
-    Rollback = 'rollback',
-}
-
-export interface DataChannelInitConfig {
-    protocol?: string;
-    negotiated?: boolean;
-    id?: number;
-    unordered?: boolean; // Reliability
-    maxPacketLifeTime?: number; // Reliability
-    maxRetransmits?: number; // Reliability
-}
-
-export interface SelectedCandidateInfo {
-    address: string;
-    port: number;
-    type: string;
-    transportType: string;
-    candidate: string;
-    mid: string;
-    priority: number;
-}
-
-// Must be same as rtc enum class Direction
-export const enum Direction {
-    SendOnly = 'SendOnly',
-    RecvOnly = 'RecvOnly',
-    SendRecv = 'SendRecv',
-    Inactive = 'Inactive',
-    Unknown = 'Unknown',
-}
-
-export class RtcpReceivingSession {
-    //
-}
-
-export class Audio {
-    constructor(mid: string, dir: Direction);
-    addAudioCodec(payloadType: number, codec: string, profile?: string): void;
-    addOpusCodec(payloadType: number, profile?: string): string;
-
-    direction(): Direction;
-    generateSdp(eol: string, addr: string, port: number): string;
-    mid(): string;
-    setDirection(dir: Direction): void;
-    description(): string;
-    removeFormat(fmt: string): void;
-    addSSRC(ssrc: number, name?: string, msid?: string, trackID?: string): void;
-    removeSSRC(ssrc: number): void;
-    replaceSSRC(oldSsrc: number, ssrc: number, name?: string, msid?: string, trackID?: string): void;
-    hasSSRC(ssrc: number): boolean;
-    getSSRCs(): number[];
-    getCNameForSsrc(ssrc: number): string;
-    setBitrate(bitRate: number): void;
-    getBitrate(): number;
-    hasPayloadType(payloadType: number): boolean;
-    addRTXCodec(payloadType: number, originalPayloadType: number, clockRate: number): void;
-    addRTPMap(): void;
-    parseSdpLine(line: string): void;
-}
-
-export class Video {
-    constructor(mid: string, dir: Direction);
-    addVideoCodec(payloadType: number, codec: string, profile?: string): void;
-    addH264Codec(payloadType: number, profile?: string): void;
-    addVP8Codec(payloadType: number): void;
-    addVP9Codec(payloadType: number): void;
-
-    direction(): Direction;
-    generateSdp(eol: string, addr: string, port: number): string;
-    mid(): string;
-    setDirection(dir: Direction): void;
-    description(): string;
-    removeFormat(fmt: string): void;
-    addSSRC(ssrc: number, name?: string, msid?: string, trackID?: string): void;
-    removeSSRC(ssrc: number): void;
-    replaceSSRC(oldSsrc: number, ssrc: number, name?: string, msid?: string, trackID?: string): void;
-    hasSSRC(ssrc: number): boolean;
-    getSSRCs(): number[];
-    getCNameForSsrc(ssrc: number): string;
-    setBitrate(bitRate: number): void;
-    getBitrate(): number;
-    hasPayloadType(payloadType: number): boolean;
-    addRTXCodec(payloadType: number, originalPayloadType: number, clockRate: number): void;
-    addRTPMap(): void;
-    parseSdpLine(line: string): void;
-}
-
-export class Track {
-    direction(): Direction;
-    mid(): string;
-    type(): string;
-    close(): void;
-    sendMessage(msg: string): boolean;
-    sendMessageBinary(buffer: Buffer): boolean;
-    isOpen(): boolean;
-    isClosed(): boolean;
-    bufferedAmount(): number;
-    maxMessageSize(): number;
-    requestBitrate(bitRate: number): boolean;
-    setBufferedAmountLowThreshold(newSize: number): void;
-    requestKeyframe(): boolean;
-    setMediaHandler(handler: RtcpReceivingSession): void;
-    onOpen(cb: () => void): void;
-    onClosed(cb: () => void): void;
-    onError(cb: (err: string) => void): void;
-    onMessage(cb: (msg: Buffer) => void): void;
-}
-
-export interface Channel {
-    close(): void;
-    sendMessage(msg: string): boolean;
-    sendMessageBinary(buffer: Uint8Array): boolean;
-    isOpen(): boolean;
-    bufferedAmount(): number;
-    maxMessageSize(): number;
-    setBufferedAmountLowThreshold(newSize: number): void;
-    onOpen(cb: () => void): void;
-    onClosed(cb: () => void): void;
-    onError(cb: (err: string) => void): void;
-    onBufferedAmountLow(cb: () => void): void;
-    onMessage(cb: (msg: string | Buffer) => void): void;
-}
-export class DataChannel implements Channel {
-    getLabel(): string;
-    getId(): number;
-    getProtocol(): string;
-
-    // Channel implementation
-    close(): void;
-    sendMessage(msg: string): boolean;
-    sendMessageBinary(buffer: Uint8Array): boolean;
-    isOpen(): boolean;
-    bufferedAmount(): number;
-    maxMessageSize(): number;
-    setBufferedAmountLowThreshold(newSize: number): void;
-    onOpen(cb: () => void): void;
-    onClosed(cb: () => void): void;
-    onError(cb: (err: string) => void): void;
-    onBufferedAmountLow(cb: () => void): void;
-    onMessage(cb: (msg: string | Buffer) => void): void;
-}
-
-export interface WebSocketConfiguration {
-    disableTlsVerification?: boolean; // default = false, if true, don't verify the TLS certificate
-    proxyServer?: ProxyServer; // only non-authenticated http supported for now
-    protocols?: string[];
-    connectionTimeout?: number; // miliseconds, zero to disable
-    pingInterval?: number; // millisecondrs, zero to disable
-    maxOutstandingPings?: number;
-    caCertificatePemFile?: string;
-    certificatePemFile?: string;
-    keyPemFile?: string;
-    keyPemPass?: string;
-    maxMessageSize: number;
-}
-export class WebSocket implements Channel {
-    constructor(config?: WebSocketConfiguration);
-    open(url: string): void;
-    forceClose(): void;
-    remoteAddress(): string | undefined;
-    path(): string | undefined;
-
-    // Channel implementation
-    close(): void;
-    sendMessage(msg: string): boolean;
-    sendMessageBinary(buffer: Uint8Array): boolean;
-    isOpen(): boolean;
-    bufferedAmount(): number;
-    maxMessageSize(): number;
-    setBufferedAmountLowThreshold(newSize: number): void;
-    onOpen(cb: () => void): void;
-    onClosed(cb: () => void): void;
-    onError(cb: (err: string) => void): void;
-    onBufferedAmountLow(cb: () => void): void;
-    onMessage(cb: (msg: string | Buffer) => void): void;
-}
-
-export interface WebSocketServerConfiguration {
-    port?: number; // default 8080
-    enableTls?: boolean; // default = false;
-    certificatePemFile?: string;
-    keyPemFile?: string;
-    keyPemPass?: string;
-    bindAddress?: string;
-    connectionTimeout?: number; // milliseconds
-    maxMessageSize?: number;
-}
-
-export class WebSocketServer {
-    constructor(config?: WebSocketServerConfiguration);
-    port(): number;
-    stop(): void;
-    onClient(cb: (ws: WebSocket) => void): void;
-}
-
-export class PeerConnection {
-    constructor(peerName: string, config: RtcConfig);
-    close(): void;
-    setLocalDescription(type?: DescriptionType): void;
-    setRemoteDescription(sdp: string, type: DescriptionType): void;
-    localDescription(): { type: string; sdp: string } | null;
-    remoteDescription(): { type: string; sdp: string } | null;
-    addRemoteCandidate(candidate: string, mid: string): void;
-    createDataChannel(label: string, config?: DataChannelInitConfig): DataChannel;
-    addTrack(media: Video | Audio): Track;
-    hasMedia(): boolean;
-    state(): RTCPeerConnectionState;
-    iceState(): RTCIceConnectionState;
-    signalingState(): RTCSignalingState;
-    gatheringState(): RTCIceGatheringState;
-    onLocalDescription(cb: (sdp: string, type: DescriptionType) => void): void;
-    onLocalCandidate(cb: (candidate: string, mid: string) => void): void;
-    onStateChange(cb: (state: string) => void): void;
-    onIceStateChange(cb: (state: string) => void): void;
-    onSignalingStateChange(cb: (state: string) => void): void;
-    onGatheringStateChange(cb: (state: string) => void): void;
-    onDataChannel(cb: (dc: DataChannel) => void): void;
-    onTrack(cb: (track: Track) => void): void;
-    bytesSent(): number;
-    bytesReceived(): number;
-    rtt(): number;
-    getSelectedCandidatePair(): { local: SelectedCandidateInfo; remote: SelectedCandidateInfo } | null;
-    maxDataChannelId(): number;
-    maxMessageSize(): number;
-}
-
-export class DataChannelStream extends stream.Duplex {
-    constructor(rawChannel: DataChannel, options?: Omit<stream.DuplexOptions, 'objectMode'>);
-    get label(): string;
-}

package/lib/index.js

@@ -1,58 +0,0 @@
-import nodeDataChannel from './node-datachannel.js';
-import DataChannelStream from './datachannel-stream.js';
-import WebSocketServer from './websocket-server.js';
-
-const {
-    initLogger,
-    cleanup,
-    preload,
-    setSctpSettings,
-    RtcpReceivingSession,
-    Track,
-    Video,
-    Audio,
-    DataChannel,
-    PeerConnection,
-    WebSocket,
-} = nodeDataChannel;
-
-export const DescriptionType = {
-    Unspec: 'unspec',
-    Offer: 'offer',
-    Answer: 'answer',
-    Pranswer: 'pranswer',
-    Rollback: 'rollback',
-};
-
-export {
-    initLogger,
-    cleanup,
-    preload,
-    setSctpSettings,
-    RtcpReceivingSession,
-    Track,
-    Video,
-    Audio,
-    DataChannel,
-    PeerConnection,
-    WebSocket,
-    WebSocketServer,
-    // Extra exports
-    DataChannelStream,
-};
-
-export default {
-    initLogger,
-    cleanup,
-    preload,
-    setSctpSettings,
-    RtcpReceivingSession,
-    Track,
-    Video,
-    Audio,
-    DataChannel,
-    PeerConnection,
-    WebSocket,
-    WebSocketServer,
-    DataChannelStream,
-};

package/lib/node-datachannel.js

@@ -1,7 +0,0 @@
-// createRequire is native in node version >= 12
-import { createRequire } from 'module';
-const require = createRequire(import.meta.url);
-
-const nodeDataChannel = require('../build/Release/node_datachannel.node');
-
-export default nodeDataChannel;

package/polyfill/Events.d.ts

@@ -1,9 +0,0 @@
-/// <reference lib="dom" />
-
-export class RTCPeerConnectionIceEvent extends Event {
-    readonly candidate: RTCIceCandidate | null;
-}
-
-export class RTCDataChannelEvent extends Event {
-    readonly channel: RTCDataChannel | null;
-}

package/polyfill/Events.js

@@ -1,29 +0,0 @@
-export class RTCPeerConnectionIceEvent extends Event {
-    #candidate;
-
-    constructor(candidate) {
-        super('icecandidate');
-
-        this.#candidate = candidate;
-    }
-
-    get candidate() {
-        return this.#candidate;
-    }
-}
-
-export class RTCDataChannelEvent extends Event {
-    #channel;
-
-    constructor(type, eventInitDict) {
-        super(type);
-
-        if (type && !eventInitDict.channel) throw new TypeError('channel member is required');
-
-        this.#channel = eventInitDict?.channel;
-    }
-
-    get channel() {
-        return this.#channel;
-    }
-}