@tomgiee/tsdp 1.0.0

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

@@ -0,0 +1,366 @@
+"use strict";
+/**
+ * Session builder for SDP (RFC 8866)
+ *
+ * Provides a fluent builder API for creating SDP session descriptions.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionBuilder = void 0;
+exports.sessionBuilder = sessionBuilder;
+const fields_1 = require("../types/fields");
+const time_1 = require("../types/time");
+const attributes_1 = require("../types/attributes");
+const network_1 = require("../types/network");
+const primitives_1 = require("../types/primitives");
+const errors_1 = require("../types/errors");
+const media_builder_1 = require("./media-builder");
+// ============================================================================
+// Session 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();
+ * ```
+ */
+class SessionBuilder {
+    constructor() {
+        this._version = 0;
+        this._emails = [];
+        this._phones = [];
+        this._bandwidths = [];
+        this._timeDescriptions = [];
+        this._attributes = [];
+        this._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, sessId, sessVersion, address, addrType) {
+        const detectedAddrType = addrType !== null && addrType !== void 0 ? addrType : this.detectAddressType(address);
+        const unicastAddress = this.parseAddress(address, detectedAddrType);
+        this._origin = (0, fields_1.createOrigin)(username, sessId, sessVersion, 'IN', detectedAddrType, unicastAddress);
+        return this;
+    }
+    /**
+     * Set the origin with auto-generated session ID and version
+     *
+     * @param username - Username (use '-' if no username)
+     * @param address - Origin address
+     */
+    originAuto(username, address) {
+        const now = Date.now().toString();
+        return this.origin(username, now, now, address);
+    }
+    /**
+     * Set the session name
+     *
+     * @param name - Session name (use ' ' if no meaningful name)
+     */
+    sessionName(name) {
+        if (name.length === 0) {
+            throw errors_1.BuilderError.invalidConfiguration('Session name cannot be empty (use " " if no meaningful name)');
+        }
+        this._sessionName = name;
+        return this;
+    }
+    /**
+     * Set the session information/title
+     */
+    sessionInformation(info) {
+        this._sessionInformation = info;
+        return this;
+    }
+    /**
+     * Set the URI for more information
+     */
+    uri(uri) {
+        this._uri = uri;
+        return this;
+    }
+    /**
+     * Add an email address
+     */
+    addEmail(email) {
+        this._emails.push(email);
+        return this;
+    }
+    /**
+     * Add a phone number
+     */
+    addPhone(phone) {
+        this._phones.push(phone);
+        return 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, addrType) {
+        const detectedAddrType = addrType !== null && addrType !== void 0 ? addrType : this.detectAddressType(address);
+        const connectionAddress = this.parseAddress(address, detectedAddrType);
+        this._connection = (0, fields_1.createConnection)('IN', detectedAddrType, connectionAddress);
+        return this;
+    }
+    /**
+     * Set the session-level 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._connection = (0, fields_1.createConnection)('IN', detectedAddrType, connectionAddress);
+        return 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, kbps) {
+        this._bandwidths.push((0, fields_1.createBandwidth)(type, kbps));
+        return 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, stopTime) {
+        this._timeDescriptions.push((0, time_1.createTimeDescription)((0, time_1.createTiming)(startTime, stopTime)));
+        return this;
+    }
+    /**
+     * Add permanent timing (0 to 0 = unbounded session)
+     */
+    permanentTiming() {
+        this._timeDescriptions.push((0, time_1.createTimeDescription)((0, time_1.createPermanentTiming)()));
+        return this;
+    }
+    /**
+     * Add a time description object
+     */
+    addTimeDescription(timeDescription) {
+        this._timeDescriptions.push(timeDescription);
+        return this;
+    }
+    /**
+     * 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 a session-level 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 a category attribute
+     */
+    category(cat) {
+        return this.addValueAttribute('cat', cat);
+    }
+    /**
+     * Add keywords attribute
+     */
+    keywords(keywords) {
+        return this.addValueAttribute('keywds', keywords);
+    }
+    /**
+     * Add tool attribute
+     */
+    tool(tool) {
+        return this.addValueAttribute('tool', tool);
+    }
+    /**
+     * Add charset attribute
+     */
+    charset(charset) {
+        return this.addValueAttribute('charset', charset);
+    }
+    /**
+     * Add a media description
+     */
+    addMedia(mediaDescription) {
+        this._mediaDescriptions.push(mediaDescription);
+        return this;
+    }
+    /**
+     * Add a media description using a builder
+     *
+     * @param builderFn - Function that configures the media builder
+     */
+    addMediaBuilder(builderFn) {
+        const builder = new media_builder_1.MediaBuilder();
+        const configuredBuilder = builderFn(builder);
+        this._mediaDescriptions.push(configuredBuilder.build());
+        return 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, proto, formats) {
+        const builder = new media_builder_1.MediaBuilder()
+            .type('audio')
+            .port(port)
+            .protocol(proto)
+            .formats(formats);
+        this._mediaDescriptions.push(builder.build());
+        return this;
+    }
+    /**
+     * Add a video media description
+     */
+    addVideoMedia(port, proto, formats) {
+        const builder = new media_builder_1.MediaBuilder()
+            .type('video')
+            .port(port)
+            .protocol(proto)
+            .formats(formats);
+        this._mediaDescriptions.push(builder.build());
+        return this;
+    }
+    /**
+     * Build the session description
+     *
+     * @throws BuilderError if required fields are missing
+     */
+    build() {
+        // Validate required fields
+        if (!this._origin) {
+            throw errors_1.BuilderError.missingRequired('origin');
+        }
+        if (!this._sessionName) {
+            throw errors_1.BuilderError.missingRequired('sessionName');
+        }
+        // Add permanent timing if no time descriptions
+        if (this._timeDescriptions.length === 0) {
+            this._timeDescriptions.push((0, time_1.createTimeDescription)((0, time_1.createPermanentTiming)()));
+        }
+        // Validate connection coverage
+        const hasSessionConnection = this._connection !== undefined;
+        if (!hasSessionConnection && this._mediaDescriptions.length > 0) {
+            const allMediaHaveConnection = this._mediaDescriptions.every((md) => md.connections.length > 0);
+            if (!allMediaHaveConnection) {
+                throw errors_1.BuilderError.invalidConfiguration('Connection information required: must be present at session level or in every media description');
+            }
+        }
+        return {
+            version: this._version,
+            origin: this._origin,
+            sessionName: this._sessionName,
+            sessionInformation: this._sessionInformation,
+            uri: this._uri,
+            emails: this._emails,
+            phones: this._phones,
+            connection: this._connection,
+            bandwidths: this._bandwidths,
+            timeDescriptions: this._timeDescriptions,
+            key: this._key,
+            attributes: this._attributes,
+            mediaDescriptions: this._mediaDescriptions,
+        };
+    }
+    // ============================================================================
+    // Private Helpers
+    // ============================================================================
+    detectAddressType(address) {
+        // Simple heuristic: if it contains ':', it's IPv6
+        if (address.includes(':')) {
+            return 'IP6';
+        }
+        return 'IP4';
+    }
+    parseAddress(address, addrType) {
+        // Check if it's an IP address or FQDN
+        if (addrType === 'IP6' || address.includes(':')) {
+            return (0, network_1.createIP6Address)(address);
+        }
+        // Check if it looks like an IPv4 address (contains dots and numbers only)
+        if (/^\d{1,3}(\.\d{1,3}){3}$/.test(address)) {
+            return (0, network_1.createIP4Address)(address);
+        }
+        // Otherwise treat as FQDN
+        return (0, network_1.createFQDN)(address);
+    }
+}
+exports.SessionBuilder = SessionBuilder;
+// ============================================================================
+// Factory Function
+// ============================================================================
+/**
+ * Create a new session builder
+ */
+function sessionBuilder() {
+    return new SessionBuilder();
+}

package/dist/src/index.d.ts

@@ -0,0 +1,67 @@
+/**
+ * TSDP - TypeScript SDP Library
+ *
+ * A complete, RFC 8866-compliant SDP (Session Description Protocol) library
+ * for TypeScript/JavaScript applications.
+ *
+ * Features:
+ * - Full RFC 8866 compliance
+ * - Type-safe with branded types
+ * - Fluent builder APIs
+ * - Comprehensive validation
+ * - Parse and serialize SDP
+ *
+ * @example
+ * ```typescript
+ * import { parseSessionDescription, serializeSessionDescription, SessionBuilder } from 'tsdp';
+ *
+ * // Parse SDP
+ * const sdp = parseSessionDescription(sdpString);
+ *
+ * // Build SDP
+ * const session = new SessionBuilder()
+ *   .origin('alice', '123', '456', '192.168.1.1')
+ *   .sessionName('My Call')
+ *   .connection('192.168.1.100')
+ *   .addAudioMedia(49170, 'RTP/AVP', ['0', '8'])
+ *   .build();
+ *
+ * // Serialize SDP
+ * const sdpString = serializeSessionDescription(session);
+ *
+ * // Validate SDP
+ * const result = validateSdp(session);
+ * if (!result.valid) {
+ *   console.error(result.errors);
+ * }
+ * ```
+ *
+ * @packageDocumentation
+ */
+export { SessionDescription, createSessionDescription, createMinimalSessionDescription, } from './types/session';
+export { MediaDescription, Media, Port, SimplePort, PortRange, createMedia, createSimplePort, createPortRange, createMediaDescription, isSimplePort, isPortRange, getPortNumber, getPortNumbers, } from './types/media';
+export { Origin, Connection, Bandwidth, createOrigin, createConnection, createBandwidth, } from './types/fields';
+export { TimeDescription, Timing, Repeat, Timezone, TimezoneAdjustment, createTiming, createPermanentTiming, createRepeat, createTimezoneAdjustment, createTimezone, createTimeDescription, } from './types/time';
+export { Attribute, PropertyAttribute, ValueAttribute, RtpmapValue, FmtpValue, createPropertyAttribute, createValueAttribute, createRecvonly, createSendrecv, createSendonly, createInactive, createRtpmap, createFmtp, createPtime, createMaxptime, isPropertyAttribute, isValueAttribute, isDirectionAttribute, } from './types/attributes';
+export { IP4Address, IP6Address, FQDN, ExtensionAddress, UnicastAddress, IP4MulticastAddress, IP6MulticastAddress, FQDNMulticastAddress, MulticastAddress, ConnectionAddress, createIP4Address, createIP6Address, createFQDN, createExtensionAddress, createIP4MulticastAddress, createIP6MulticastAddress, createFQDNMulticastAddress, isMulticastAddress, isUnicastAddress, isIP4MulticastAddress, isIP6MulticastAddress, isFQDNMulticastAddress, } from './types/network';
+export { Position, Version, SessionName, Username, SessionId, SessionVersion, Information, URI, Email, Phone, Key, BandwidthType, Protocol, Format, AttributeName, AttributeValue, NetType, AddrType, MediaType, NtpTime, TimeUnit, TypedTime, createVersion, createSessionName, createUsername, createNtpTime, createTypedTime, } from './types/primitives';
+export { SdpError, ParseError, GrammarError, ValidationError, SerializationError, BuilderError, } from './types/errors';
+export { parseSessionDescription } from './parser/session-parser';
+export { parseVersionField, parseOriginField, parseSessionNameField, parseInformationField, parseUriField, parseEmailField, parsePhoneField, parseConnectionField, parseBandwidthField, parseKeyField, } from './parser/field-parser';
+export { parseTimingField, parseRepeatField, parseTimezoneField, parseTimeDescription, } from './parser/time-parser';
+export { parseAttributeField, parseRtpmapValue, parseFmtpValue, parsePtimeValue, parseMaxptimeValue, parseFramerateValue, parseQualityValue, } from './parser/attribute-parser';
+export { parseMediaField, parseMediaDescription } from './parser/media-parser';
+export { serializeSessionDescription } from './serializer/session-serializer';
+export { serializeVersionField, serializeOriginField, serializeSessionNameField, serializeInformationField, serializeUriField, serializeEmailField, serializePhoneField, serializeConnectionField, serializeConnectionAddress, serializeBandwidthField, serializeKeyField, } from './serializer/field-serializer';
+export { serializeTimingField, serializeRepeatField, serializeTimezoneField, serializeTimeDescription, } from './serializer/time-serializer';
+export { serializeAttributeField } from './serializer/attribute-serializer';
+export { serializeMediaField, serializeMediaDescription } from './serializer/media-serializer';
+export { validateSdp, validateSemanticConstraints, ValidationOptions, } from './validator/semantic-validator';
+export { validateSessionDescription, ValidationResult, validResult, invalidResult, } from './validator/session-validator';
+export { validateMediaDescription, validateAllMediaDescriptions } from './validator/media-validator';
+export { SessionBuilder, sessionBuilder } from './builder/session-builder';
+export { MediaBuilder, mediaBuilder, audioBuilder, videoBuilder } from './builder/media-builder';
+export { isIP4Address, isIP6Address, isFQDN, isIP4MulticastAddress as isIP4MulticastRange, isIP6MulticastAddress as isIP6MulticastRange, parseIP4Address, parseIP6Address, parseFQDN, parseUnicastAddress, detectAddressType, } from './utils/address-parser';
+export { parseTypedTime, serializeTypedTime, typedTimeToSeconds, secondsToTypedTime, addTypedTimes, compareTypedTimes, typedTimesEqual, normalizeTypedTime, } from './utils/time-converter';
+export { splitLines, parseLine, parseLines, joinLines, formatLine, isValidLineType, getLineTypeName, ParsedLine, } from './utils/line-reader';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAOH,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,+BAA+B,GAChC,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EACL,gBAAgB,EAChB,KAAK,EACL,IAAI,EACJ,UAAU,EACV,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,YAAY,EACZ,WAAW,EACX,aAAa,EACb,cAAc,GACf,MAAM,eAAe,CAAC;AAMvB,OAAO,EACL,MAAM,EACN,UAAU,EACV,SAAS,EACT,YAAY,EACZ,gBAAgB,EAChB,eAAe,GAChB,MAAM,gBAAgB,CAAC;AAMxB,OAAO,EACL,eAAe,EACf,MAAM,EACN,MAAM,EACN,QAAQ,EACR,kBAAkB,EAClB,YAAY,EACZ,qBAAqB,EACrB,YAAY,EACZ,wBAAwB,EACxB,cAAc,EACd,qBAAqB,GACtB,MAAM,cAAc,CAAC;AAMtB,OAAO,EACL,SAAS,EACT,iBAAiB,EACjB,cAAc,EACd,WAAW,EACX,SAAS,EACT,uBAAuB,EACvB,oBAAoB,EACpB,cAAc,EACd,cAAc,EACd,cAAc,EACd,cAAc,EACd,YAAY,EACZ,UAAU,EACV,WAAW,EACX,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAM5B,OAAO,EACL,UAAU,EACV,UAAU,EACV,IAAI,EACJ,gBAAgB,EAChB,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,UAAU,EACV,sBAAsB,EACtB,yBAAyB,EACzB,yBAAyB,EACzB,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,EACrB,sBAAsB,GACvB,MAAM,iBAAiB,CAAC;AAMzB,OAAO,EACL,QAAQ,EACR,OAAO,EACP,WAAW,EACX,QAAQ,EACR,SAAS,EACT,cAAc,EACd,WAAW,EACX,GAAG,EACH,KAAK,EACL,KAAK,EACL,GAAG,EACH,aAAa,EACb,QAAQ,EACR,MAAM,EACN,aAAa,EACb,cAAc,EACd,OAAO,EACP,QAAQ,EACR,SAAS,EACT,OAAO,EACP,QAAQ,EACR,SAAS,EACT,aAAa,EACb,iBAAiB,EACjB,cAAc,EACd,aAAa,EACb,eAAe,GAChB,MAAM,oBAAoB,CAAC;AAM5B,OAAO,EACL,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,eAAe,EACf,kBAAkB,EAClB,YAAY,GACb,MAAM,gBAAgB,CAAC;AAMxB,OAAO,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAGlE,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,EACrB,aAAa,EACb,eAAe,EACf,eAAe,EACf,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,GACd,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,mBAAmB,EACnB,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAM/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,iCAAiC,CAAC;AAG9E,OAAO,EACL,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,yBAAyB,EACzB,iBAAiB,EACjB,mBAAmB,EACnB,mBAAmB,EACnB,wBAAwB,EACxB,0BAA0B,EAC1B,uBAAuB,EACvB,iBAAiB,GAClB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,8BAA8B,CAAC;AAEtC,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAE5E,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAM/F,OAAO,EACL,WAAW,EACX,2BAA2B,EAC3B,iBAAiB,GAClB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EACL,0BAA0B,EAC1B,gBAAgB,EAChB,WAAW,EACX,aAAa,GACd,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,wBAAwB,EAAE,4BAA4B,EAAE,MAAM,6BAA6B,CAAC;AAMrG,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAE3E,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAOjG,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,MAAM,EACN,qBAAqB,IAAI,mBAAmB,EAC5C,qBAAqB,IAAI,mBAAmB,EAC5C,eAAe,EACf,eAAe,EACf,SAAS,EACT,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,kBAAkB,GACnB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EACL,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,EACT,UAAU,EACV,eAAe,EACf,eAAe,EACf,UAAU,GACX,MAAM,qBAAqB,CAAC"}