@tomgiee/tsdp 1.0.0

package/dist/src/builder/media-builder.js

@@ -0,0 +1,385 @@
+"use strict";
+/**
+ * Media builder for SDP (RFC 8866)
+ *
+ * Provides a fluent builder API for creating SDP media descriptions.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaBuilder = void 0;
+exports.mediaBuilder = mediaBuilder;
+exports.audioBuilder = audioBuilder;
+exports.videoBuilder = videoBuilder;
+const media_1 = require("../types/media");
+const fields_1 = require("../types/fields");
+const attributes_1 = require("../types/attributes");
+const network_1 = require("../types/network");
+const primitives_1 = require("../types/primitives");
+const errors_1 = require("../types/errors");
+// ============================================================================
+// Media Builder
+// ============================================================================
+/**
+ * Fluent builder for creating SDP media descriptions
+ *
+ * Usage:
+ * ```typescript
+ * const media = new MediaBuilder()
+ *   .type('audio')
+ *   .port(49170)
+ *   .protocol('RTP/AVP')
+ *   .formats(['0', '8'])
+ *   .rtpmap(0, 'PCMU', 8000)
+ *   .rtpmap(8, 'PCMA', 8000)
+ *   .build();
+ * ```
+ */
+class MediaBuilder {
+    constructor() {
+        this._formats = [];
+        this._connections = [];
+        this._bandwidths = [];
+        this._attributes = [];
+    }
+    /**
+     * Set the media type
+     *
+     * @param type - Media type ('audio', 'video', 'text', 'application', 'message', 'image')
+     */
+    type(type) {
+        this._type = type;
+        return this;
+    }
+    /**
+     * Set the port
+     *
+     * @param port - Port number (0-65535)
+     */
+    port(port) {
+        this._port = (0, media_1.createSimplePort)(port);
+        return this;
+    }
+    /**
+     * Set the port range
+     *
+     * @param base - Base port number
+     * @param count - Number of ports
+     */
+    portRange(base, count) {
+        this._port = (0, media_1.createPortRange)(base, count);
+        return this;
+    }
+    /**
+     * Disable this media stream (set port to 0)
+     */
+    disabled() {
+        this._port = (0, media_1.createSimplePort)(0);
+        return this;
+    }
+    /**
+     * Set the transport protocol
+     *
+     * @param proto - Protocol (e.g., 'RTP/AVP', 'RTP/SAVP', 'RTP/SAVPF', 'udp', 'TCP/RTP/AVP')
+     */
+    protocol(proto) {
+        this._protocol = proto;
+        return this;
+    }
+    /**
+     * Set the formats (payload types for RTP)
+     *
+     * @param formats - Array of format strings
+     */
+    formats(formats) {
+        this._formats = formats.map((f) => f);
+        return this;
+    }
+    /**
+     * Add a single format
+     */
+    addFormat(format) {
+        this._formats.push(format);
+        return this;
+    }
+    /**
+     * Set the media information/title
+     */
+    information(info) {
+        this._information = info;
+        return this;
+    }
+    /**
+     * Add a connection
+     *
+     * @param address - Connection address (IPv4, IPv6, or FQDN)
+     * @param addrType - Address type, auto-detected if not provided
+     */
+    connection(address, addrType) {
+        const detectedAddrType = addrType !== null && addrType !== void 0 ? addrType : this.detectAddressType(address);
+        const connectionAddress = this.parseAddress(address, detectedAddrType);
+        this._connections.push((0, fields_1.createConnection)('IN', detectedAddrType, connectionAddress));
+        return this;
+    }
+    /**
+     * Add a connection with multicast TTL
+     */
+    connectionMulticast(address, ttl, addrType) {
+        const detectedAddrType = addrType !== null && addrType !== void 0 ? addrType : this.detectAddressType(address);
+        let connectionAddress;
+        if (detectedAddrType === 'IP4') {
+            connectionAddress = (0, network_1.createIP4MulticastAddress)((0, network_1.createIP4Address)(address), ttl);
+        }
+        else {
+            connectionAddress = (0, network_1.createIP6MulticastAddress)((0, network_1.createIP6Address)(address));
+        }
+        this._connections.push((0, fields_1.createConnection)('IN', detectedAddrType, connectionAddress));
+        return this;
+    }
+    /**
+     * Add bandwidth information
+     *
+     * @param type - Bandwidth type ('CT' or 'AS')
+     * @param kbps - Bandwidth in kilobits per second
+     */
+    addBandwidth(type, kbps) {
+        this._bandwidths.push((0, fields_1.createBandwidth)(type, kbps));
+        return this;
+    }
+    /**
+     * Set AS (Application Specific) bandwidth
+     */
+    bandwidth(kbps) {
+        return this.addBandwidth('AS', kbps);
+    }
+    /**
+     * Set encryption key (OBSOLETE per RFC 8866)
+     *
+     * @param keyValue - The key value (e.g., "clear:password" or "base64:encoded")
+     */
+    key(keyValue) {
+        this._key = (0, primitives_1.createKey)(keyValue);
+        return this;
+    }
+    /**
+     * Add an attribute
+     */
+    addAttribute(attr) {
+        this._attributes.push(attr);
+        return this;
+    }
+    /**
+     * Add a custom property attribute
+     */
+    addPropertyAttribute(name) {
+        this._attributes.push({ kind: 'property', name });
+        return this;
+    }
+    /**
+     * Add a custom value attribute
+     */
+    addValueAttribute(name, value) {
+        this._attributes.push((0, attributes_1.createValueAttribute)(name, value));
+        return this;
+    }
+    /**
+     * Set direction to sendrecv
+     */
+    sendrecv() {
+        return this.addAttribute((0, attributes_1.createSendrecv)());
+    }
+    /**
+     * Set direction to recvonly
+     */
+    recvonly() {
+        return this.addAttribute((0, attributes_1.createRecvonly)());
+    }
+    /**
+     * Set direction to sendonly
+     */
+    sendonly() {
+        return this.addAttribute((0, attributes_1.createSendonly)());
+    }
+    /**
+     * Set direction to inactive
+     */
+    inactive() {
+        return this.addAttribute((0, attributes_1.createInactive)());
+    }
+    /**
+     * Add an rtpmap attribute
+     *
+     * @param payloadType - RTP payload type (0-127)
+     * @param encodingName - Encoding name (e.g., 'PCMU', 'H264')
+     * @param clockRate - Clock rate (e.g., 8000, 90000)
+     * @param encodingParams - Optional encoding parameters (e.g., 2 for stereo)
+     */
+    rtpmap(payloadType, encodingName, clockRate, encodingParams) {
+        return this.addAttribute((0, attributes_1.createRtpmap)(payloadType, encodingName, clockRate, encodingParams));
+    }
+    /**
+     * Add an fmtp attribute
+     *
+     * @param format - Format/payload type
+     * @param parameters - Format-specific parameters
+     */
+    fmtp(format, parameters) {
+        return this.addAttribute((0, attributes_1.createFmtp)(format.toString(), parameters));
+    }
+    /**
+     * Set the ptime attribute
+     *
+     * @param milliseconds - Packet time in milliseconds
+     */
+    ptime(milliseconds) {
+        return this.addAttribute((0, attributes_1.createPtime)(milliseconds));
+    }
+    /**
+     * Set the maxptime attribute
+     *
+     * @param milliseconds - Maximum packet time in milliseconds
+     */
+    maxptime(milliseconds) {
+        return this.addAttribute((0, attributes_1.createMaxptime)(milliseconds));
+    }
+    /**
+     * Set the framerate attribute (for video)
+     */
+    framerate(fps) {
+        return this.addValueAttribute('framerate', fps.toString());
+    }
+    /**
+     * Set the quality attribute (for video, 0-10)
+     */
+    quality(q) {
+        if (q < 0 || q > 10) {
+            throw errors_1.BuilderError.invalidConfiguration('Quality must be between 0 and 10');
+        }
+        return this.addValueAttribute('quality', q.toString());
+    }
+    /**
+     * Add mid attribute (media identification)
+     */
+    mid(id) {
+        return this.addValueAttribute('mid', id);
+    }
+    /**
+     * Add ice-ufrag attribute
+     */
+    iceUfrag(ufrag) {
+        return this.addValueAttribute('ice-ufrag', ufrag);
+    }
+    /**
+     * Add ice-pwd attribute
+     */
+    icePwd(pwd) {
+        return this.addValueAttribute('ice-pwd', pwd);
+    }
+    /**
+     * Add fingerprint attribute
+     */
+    fingerprint(hashFunc, fingerprint) {
+        return this.addValueAttribute('fingerprint', `${hashFunc} ${fingerprint}`);
+    }
+    /**
+     * Add setup attribute
+     */
+    setup(role) {
+        return this.addValueAttribute('setup', role);
+    }
+    /**
+     * Add RTCP attribute
+     */
+    rtcp(port, address) {
+        let value = port.toString();
+        if (address) {
+            const addrType = this.detectAddressType(address);
+            value = `${port} IN ${addrType} ${address}`;
+        }
+        return this.addValueAttribute('rtcp', value);
+    }
+    /**
+     * Add rtcp-mux attribute
+     */
+    rtcpMux() {
+        return this.addPropertyAttribute('rtcp-mux');
+    }
+    /**
+     * Add rtcp-rsize attribute
+     */
+    rtcpRsize() {
+        return this.addPropertyAttribute('rtcp-rsize');
+    }
+    /**
+     * Build the media description
+     *
+     * @throws BuilderError if required fields are missing
+     */
+    build() {
+        // Validate required fields
+        if (!this._type) {
+            throw errors_1.BuilderError.missingRequired('media type');
+        }
+        if (!this._port) {
+            throw errors_1.BuilderError.missingRequired('port');
+        }
+        if (!this._protocol) {
+            throw errors_1.BuilderError.missingRequired('protocol');
+        }
+        if (this._formats.length === 0) {
+            throw errors_1.BuilderError.missingRequired('formats (at least one format required)');
+        }
+        const media = {
+            type: this._type,
+            port: this._port,
+            proto: this._protocol,
+            formats: this._formats,
+        };
+        return {
+            media,
+            information: this._information,
+            connections: this._connections,
+            bandwidths: this._bandwidths,
+            key: this._key,
+            attributes: this._attributes,
+        };
+    }
+    // ============================================================================
+    // Private Helpers
+    // ============================================================================
+    detectAddressType(address) {
+        if (address.includes(':')) {
+            return 'IP6';
+        }
+        return 'IP4';
+    }
+    parseAddress(address, addrType) {
+        if (addrType === 'IP6' || address.includes(':')) {
+            return (0, network_1.createIP6Address)(address);
+        }
+        if (/^\d{1,3}(\.\d{1,3}){3}$/.test(address)) {
+            return (0, network_1.createIP4Address)(address);
+        }
+        return (0, network_1.createFQDN)(address);
+    }
+}
+exports.MediaBuilder = MediaBuilder;
+// ============================================================================
+// Factory Functions
+// ============================================================================
+/**
+ * Create a new media builder
+ */
+function mediaBuilder() {
+    return new MediaBuilder();
+}
+/**
+ * Create an audio media builder pre-configured for audio
+ */
+function audioBuilder() {
+    return new MediaBuilder().type('audio');
+}
+/**
+ * Create a video media builder pre-configured for video
+ */
+function videoBuilder() {
+    return new MediaBuilder().type('video');
+}

package/dist/src/builder/session-builder.d.ts

@@ -0,0 +1,195 @@
+/**
+ * Session builder for SDP (RFC 8866)
+ *
+ * Provides a fluent builder API for creating SDP session descriptions.
+ */
+import { SessionDescription } from '../types/session';
+import { TimeDescription } from '../types/time';
+import { Attribute } from '../types/attributes';
+import { MediaDescription } from '../types/media';
+import { MediaBuilder } from './media-builder';
+/**
+ * Fluent builder for creating SDP session descriptions
+ *
+ * Usage:
+ * ```typescript
+ * const sdp = new SessionBuilder()
+ *   .origin('alice', '2890844526', '2890842807', '192.168.1.1')
+ *   .sessionName('My Session')
+ *   .connection('192.168.1.100')
+ *   .addAudioMedia(49170, 'RTP/AVP', ['0', '8'])
+ *   .build();
+ * ```
+ */
+export declare class SessionBuilder {
+    private _version;
+    private _origin?;
+    private _sessionName?;
+    private _sessionInformation?;
+    private _uri?;
+    private _emails;
+    private _phones;
+    private _connection?;
+    private _bandwidths;
+    private _timeDescriptions;
+    private _key?;
+    private _attributes;
+    private _mediaDescriptions;
+    /**
+     * Set the origin field
+     *
+     * @param username - Username (use '-' if no username)
+     * @param sessId - Session ID (recommend NTP timestamp string)
+     * @param sessVersion - Session version (recommend NTP timestamp string)
+     * @param address - Origin address (IPv4, IPv6, or FQDN)
+     * @param addrType - Address type ('IP4' or 'IP6'), auto-detected if not provided
+     */
+    origin(username: string, sessId: string, sessVersion: string, address: string, addrType?: 'IP4' | 'IP6'): this;
+    /**
+     * Set the origin with auto-generated session ID and version
+     *
+     * @param username - Username (use '-' if no username)
+     * @param address - Origin address
+     */
+    originAuto(username: string, address: string): this;
+    /**
+     * Set the session name
+     *
+     * @param name - Session name (use ' ' if no meaningful name)
+     */
+    sessionName(name: string): this;
+    /**
+     * Set the session information/title
+     */
+    sessionInformation(info: string): this;
+    /**
+     * Set the URI for more information
+     */
+    uri(uri: string): this;
+    /**
+     * Add an email address
+     */
+    addEmail(email: string): this;
+    /**
+     * Add a phone number
+     */
+    addPhone(phone: string): this;
+    /**
+     * Set the session-level connection
+     *
+     * @param address - Connection address (IPv4, IPv6, or FQDN)
+     * @param addrType - Address type, auto-detected if not provided
+     */
+    connection(address: string, addrType?: 'IP4' | 'IP6'): this;
+    /**
+     * Set the session-level connection with multicast TTL
+     */
+    connectionMulticast(address: string, ttl: number, addrType?: 'IP4' | 'IP6'): this;
+    /**
+     * Add bandwidth information
+     *
+     * @param type - Bandwidth type ('CT' for conference total, 'AS' for application specific)
+     * @param kbps - Bandwidth in kilobits per second
+     */
+    addBandwidth(type: 'CT' | 'AS' | string, kbps: number): this;
+    /**
+     * Add a time description
+     *
+     * @param startTime - Start time (NTP timestamp, 0 for unbounded)
+     * @param stopTime - Stop time (NTP timestamp, 0 for unbounded)
+     */
+    addTiming(startTime: number, stopTime: number): this;
+    /**
+     * Add permanent timing (0 to 0 = unbounded session)
+     */
+    permanentTiming(): this;
+    /**
+     * Add a time description object
+     */
+    addTimeDescription(timeDescription: TimeDescription): this;
+    /**
+     * Set encryption key (OBSOLETE per RFC 8866)
+     *
+     * @param keyValue - The key value (e.g., "clear:password" or "base64:encoded")
+     */
+    key(keyValue: string): this;
+    /**
+     * Add a session-level attribute
+     */
+    addAttribute(attr: Attribute): this;
+    /**
+     * Add a custom property attribute
+     */
+    addPropertyAttribute(name: string): this;
+    /**
+     * Add a custom value attribute
+     */
+    addValueAttribute(name: string, value: string): this;
+    /**
+     * Set direction to sendrecv
+     */
+    sendrecv(): this;
+    /**
+     * Set direction to recvonly
+     */
+    recvonly(): this;
+    /**
+     * Set direction to sendonly
+     */
+    sendonly(): this;
+    /**
+     * Set direction to inactive
+     */
+    inactive(): this;
+    /**
+     * Add a category attribute
+     */
+    category(cat: string): this;
+    /**
+     * Add keywords attribute
+     */
+    keywords(keywords: string): this;
+    /**
+     * Add tool attribute
+     */
+    tool(tool: string): this;
+    /**
+     * Add charset attribute
+     */
+    charset(charset: string): this;
+    /**
+     * Add a media description
+     */
+    addMedia(mediaDescription: MediaDescription): this;
+    /**
+     * Add a media description using a builder
+     *
+     * @param builderFn - Function that configures the media builder
+     */
+    addMediaBuilder(builderFn: (builder: MediaBuilder) => MediaBuilder): this;
+    /**
+     * Add an audio media description
+     *
+     * @param port - Port number
+     * @param proto - Protocol (e.g., 'RTP/AVP')
+     * @param formats - Format list (e.g., ['0', '8'] for PCMU and PCMA)
+     */
+    addAudioMedia(port: number, proto: string, formats: string[]): this;
+    /**
+     * Add a video media description
+     */
+    addVideoMedia(port: number, proto: string, formats: string[]): this;
+    /**
+     * Build the session description
+     *
+     * @throws BuilderError if required fields are missing
+     */
+    build(): SessionDescription;
+    private detectAddressType;
+    private parseAddress;
+}
+/**
+ * Create a new session builder
+ */
+export declare function sessionBuilder(): SessionBuilder;
+//# sourceMappingURL=session-builder.d.ts.map

package/dist/src/builder/session-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-builder.d.ts","sourceRoot":"","sources":["../../../src/builder/session-builder.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,OAAO,EAAE,eAAe,EAAsE,MAAM,eAAe,CAAC;AACpH,OAAO,EAAE,SAAS,EAAwF,MAAM,qBAAqB,CAAC;AACtI,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAYlD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAM/C;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,OAAO,CAAC,mBAAmB,CAAC,CAAc;IAC1C,OAAO,CAAC,IAAI,CAAC,CAAM;IACnB,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,WAAW,CAAC,CAAa;IACjC,OAAO,CAAC,WAAW,CAAmB;IACtC,OAAO,CAAC,iBAAiB,CAAyB;IAClD,OAAO,CAAC,IAAI,CAAC,CAAM;IACnB,OAAO,CAAC,WAAW,CAAmB;IACtC,OAAO,CAAC,kBAAkB,CAA0B;IAEpD;;;;;;;;OAQG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,GACvB,IAAI;IAOP;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAKnD;;;;OAIG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQ/B;;OAEG;IACH,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAKtC;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAKtB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK7B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK7B;;;;;OAKG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI;IAO3D;;OAEG;IACH,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI;IAYjF;;;;;OAKG;IACH,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAK5D;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAKpD;;OAEG;IACH,eAAe,IAAI,IAAI;IAKvB;;OAEG;IACH,kBAAkB,CAAC,eAAe,EAAE,eAAe,GAAG,IAAI;IAK1D;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAK3B;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,IAAI;IAKnC;;OAEG;IACH,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAKxC;;OAEG;IACH,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAKpD;;OAEG;IACH,QAAQ,IAAI,IAAI;IAIhB;;OAEG;IACH,QAAQ,IAAI,IAAI;IAIhB;;OAEG;IACH,QAAQ,IAAI,IAAI;IAIhB;;OAEG;IACH,QAAQ,IAAI,IAAI;IAIhB;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI3B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIhC;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIxB;;OAEG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI9B;;OAEG;IACH,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,IAAI;IAKlD;;;;OAIG;IACH,eAAe,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,YAAY,KAAK,YAAY,GAAG,IAAI;IAOzE;;;;;;OAMG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAUnE;;OAEG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAUnE;;;;OAIG;IACH,KAAK,IAAI,kBAAkB;IAgD3B,OAAO,CAAC,iBAAiB;IAQzB,OAAO,CAAC,YAAY;CAcrB;AAMD;;GAEG;AACH,wBAAgB,cAAc,IAAI,cAAc,CAE/C"}