@tomgiee/tsdp 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Thomas Giesler
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,124 @@
+# TSDP - TypeScript SDP Library
+
+[![npm version](https://img.shields.io/npm/v/tsdp.svg)](https://www.npmjs.com/package/tsdp)
+[![CI](https://github.com/tomgie/tsdp/actions/workflows/ci.yml/badge.svg)](https://github.com/tomgie/tsdp/actions/workflows/ci.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+> **Note:** This project was developed with assistance from [Claude](https://claude.ai).
+
+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
+
+## Installation
+
+```bash
+npm install tsdp
+```
+
+## Usage
+
+### Parsing SDP
+
+```typescript
+import { parseSessionDescription, validateSdp } from 'tsdp';
+
+const sdpString = `v=0
+o=alice 2890844526 2890842807 IN IP4 192.168.1.1
+s=Call
+c=IN IP4 192.168.1.100
+t=0 0
+m=audio 49170 RTP/AVP 0 8
+a=rtpmap:0 PCMU/8000
+a=rtpmap:8 PCMA/8000
+`;
+
+const session = parseSessionDescription(sdpString);
+const result = validateSdp(session);
+
+if (!result.valid) {
+  console.error(result.errors);
+}
+```
+
+### Building SDP
+
+```typescript
+import { SessionBuilder, serializeSessionDescription } from 'tsdp';
+
+const session = new SessionBuilder()
+  .origin('alice', '123456789', '123456789', '192.168.1.1')
+  .sessionName('Phone Call')
+  .connection('192.168.1.100')
+  .addMediaBuilder((b) =>
+    b
+      .type('audio')
+      .port(49170)
+      .protocol('RTP/AVP')
+      .formats(['0', '8'])
+      .rtpmap(0, 'PCMU', 8000)
+      .rtpmap(8, 'PCMA', 8000)
+      .ptime(20)
+      .sendrecv()
+  )
+  .build();
+
+const sdpString = serializeSessionDescription(session);
+```
+
+### Validation Options
+
+```typescript
+import { validateSdp } from 'tsdp';
+
+const result = validateSdp(session, {
+  allowDeprecatedKeyField: true,
+  requireSessionConnection: false,
+  skipSemanticValidation: false,
+});
+```
+
+## API
+
+### Core Functions
+
+- `parseSessionDescription(input: string)` - Parse SDP string to session object
+- `serializeSessionDescription(session)` - Serialize session object to SDP string
+- `validateSdp(session, options?)` - Validate session with optional configuration
+
+### Builders
+
+- `SessionBuilder` - Fluent builder for session descriptions
+- `MediaBuilder` - Fluent builder for media descriptions
+- `audioBuilder()` - Pre-configured audio media builder
+- `videoBuilder()` - Pre-configured video media builder
+
+### Types
+
+- `SessionDescription` - Complete SDP session
+- `MediaDescription` - Media stream description
+- `Attribute` - SDP attribute (property or value)
+- `ValidationResult` - Validation result with errors
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Run tests
+pnpm test
+
+# Build
+pnpm build
+```
+
+## License
+
+MIT

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

@@ -0,0 +1,221 @@
+/**
+ * Media builder for SDP (RFC 8866)
+ *
+ * Provides a fluent builder API for creating SDP media descriptions.
+ */
+import { MediaDescription } from '../types/media';
+import { Attribute } from '../types/attributes';
+/**
+ * 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();
+ * ```
+ */
+export declare class MediaBuilder {
+    private _type?;
+    private _port?;
+    private _protocol?;
+    private _formats;
+    private _information?;
+    private _connections;
+    private _bandwidths;
+    private _key?;
+    private _attributes;
+    /**
+     * Set the media type
+     *
+     * @param type - Media type ('audio', 'video', 'text', 'application', 'message', 'image')
+     */
+    type(type: 'audio' | 'video' | 'text' | 'application' | 'message' | 'image' | string): this;
+    /**
+     * Set the port
+     *
+     * @param port - Port number (0-65535)
+     */
+    port(port: number): this;
+    /**
+     * Set the port range
+     *
+     * @param base - Base port number
+     * @param count - Number of ports
+     */
+    portRange(base: number, count: number): this;
+    /**
+     * Disable this media stream (set port to 0)
+     */
+    disabled(): this;
+    /**
+     * Set the transport protocol
+     *
+     * @param proto - Protocol (e.g., 'RTP/AVP', 'RTP/SAVP', 'RTP/SAVPF', 'udp', 'TCP/RTP/AVP')
+     */
+    protocol(proto: string): this;
+    /**
+     * Set the formats (payload types for RTP)
+     *
+     * @param formats - Array of format strings
+     */
+    formats(formats: string[]): this;
+    /**
+     * Add a single format
+     */
+    addFormat(format: string): this;
+    /**
+     * Set the media information/title
+     */
+    information(info: string): this;
+    /**
+     * Add a 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;
+    /**
+     * Add a connection with multicast TTL
+     */
+    connectionMulticast(address: string, ttl: number, addrType?: 'IP4' | 'IP6'): this;
+    /**
+     * Add bandwidth information
+     *
+     * @param type - Bandwidth type ('CT' or 'AS')
+     * @param kbps - Bandwidth in kilobits per second
+     */
+    addBandwidth(type: 'CT' | 'AS' | string, kbps: number): this;
+    /**
+     * Set AS (Application Specific) bandwidth
+     */
+    bandwidth(kbps: number): 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 an 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 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: number, encodingName: string, clockRate: number, encodingParams?: number): this;
+    /**
+     * Add an fmtp attribute
+     *
+     * @param format - Format/payload type
+     * @param parameters - Format-specific parameters
+     */
+    fmtp(format: string | number, parameters: string): this;
+    /**
+     * Set the ptime attribute
+     *
+     * @param milliseconds - Packet time in milliseconds
+     */
+    ptime(milliseconds: number): this;
+    /**
+     * Set the maxptime attribute
+     *
+     * @param milliseconds - Maximum packet time in milliseconds
+     */
+    maxptime(milliseconds: number): this;
+    /**
+     * Set the framerate attribute (for video)
+     */
+    framerate(fps: number): this;
+    /**
+     * Set the quality attribute (for video, 0-10)
+     */
+    quality(q: number): this;
+    /**
+     * Add mid attribute (media identification)
+     */
+    mid(id: string): this;
+    /**
+     * Add ice-ufrag attribute
+     */
+    iceUfrag(ufrag: string): this;
+    /**
+     * Add ice-pwd attribute
+     */
+    icePwd(pwd: string): this;
+    /**
+     * Add fingerprint attribute
+     */
+    fingerprint(hashFunc: string, fingerprint: string): this;
+    /**
+     * Add setup attribute
+     */
+    setup(role: 'active' | 'passive' | 'actpass' | 'holdconn'): this;
+    /**
+     * Add RTCP attribute
+     */
+    rtcp(port: number, address?: string): this;
+    /**
+     * Add rtcp-mux attribute
+     */
+    rtcpMux(): this;
+    /**
+     * Add rtcp-rsize attribute
+     */
+    rtcpRsize(): this;
+    /**
+     * Build the media description
+     *
+     * @throws BuilderError if required fields are missing
+     */
+    build(): MediaDescription;
+    private detectAddressType;
+    private parseAddress;
+}
+/**
+ * Create a new media builder
+ */
+export declare function mediaBuilder(): MediaBuilder;
+/**
+ * Create an audio media builder pre-configured for audio
+ */
+export declare function audioBuilder(): MediaBuilder;
+/**
+ * Create a video media builder pre-configured for video
+ */
+export declare function videoBuilder(): MediaBuilder;
+//# sourceMappingURL=media-builder.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"media-builder.d.ts","sourceRoot":"","sources":["../../../src/builder/media-builder.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,gBAAgB,EAAkD,MAAM,gBAAgB,CAAC;AAElG,OAAO,EACL,SAAS,EAUV,MAAM,qBAAqB,CAAC;AAiB7B;;;;;;;;;;;;;;GAcG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,KAAK,CAAC,CAAY;IAC1B,OAAO,CAAC,KAAK,CAAC,CAAO;IACrB,OAAO,CAAC,SAAS,CAAC,CAAW;IAC7B,OAAO,CAAC,QAAQ,CAAgB;IAChC,OAAO,CAAC,YAAY,CAAC,CAAc;IACnC,OAAO,CAAC,YAAY,CAAoB;IACxC,OAAO,CAAC,WAAW,CAAmB;IACtC,OAAO,CAAC,IAAI,CAAC,CAAM;IACnB,OAAO,CAAC,WAAW,CAAmB;IAEtC;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI;IAK3F;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAKxB;;;;;OAKG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAK5C;;OAEG;IACH,QAAQ,IAAI,IAAI;IAKhB;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAK7B;;;;OAIG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAKhC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAK/B;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK/B;;;;;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;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAI7B;;;;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;;;;;;;OAOG;IACH,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI;IAInG;;;;;OAKG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IAIvD;;;;OAIG;IACH,KAAK,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAIjC;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAIpC;;OAEG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI5B;;OAEG;IACH,OAAO,CAAC,CAAC,EAAE,MAAM,GAAG,IAAI;IAOxB;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAIrB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI7B;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIzB;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,IAAI;IAIxD;;OAEG;IACH,KAAK,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,IAAI;IAIhE;;OAEG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI;IAS1C;;OAEG;IACH,OAAO,IAAI,IAAI;IAIf;;OAEG;IACH,SAAS,IAAI,IAAI;IAIjB;;;;OAIG;IACH,KAAK,IAAI,gBAAgB;IAoCzB,OAAO,CAAC,iBAAiB;IAOzB,OAAO,CAAC,YAAY;CAWrB;AAMD;;GAEG;AACH,wBAAgB,YAAY,IAAI,YAAY,CAE3C;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,YAAY,CAE3C;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,YAAY,CAE3C"}