@tomgiee/tsdp 1.0.0

package/dist/src/parser/scanner.js

@@ -0,0 +1,284 @@
+"use strict";
+/**
+ * Scanner for SDP parsing (RFC 8866)
+ *
+ * Provides low-level tokenization and character-level operations
+ * with position tracking for detailed error reporting.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Scanner = void 0;
+const errors_1 = require("../types/errors");
+/**
+ * Scanner class for parsing SDP text
+ *
+ * Maintains position information and provides character-level operations
+ * for parsing SDP fields according to RFC 8866 grammar.
+ */
+class Scanner {
+    /**
+     * Create a new Scanner
+     *
+     * @param input - SDP text to scan
+     */
+    constructor(input) {
+        this.input = input;
+        this.position = 0;
+        this.line = 1;
+        this.column = 1;
+    }
+    /**
+     * Peek at the current character without consuming it
+     *
+     * @returns Current character or null if at EOF
+     */
+    peek() {
+        if (this.isEOF()) {
+            return null;
+        }
+        return this.input[this.position];
+    }
+    /**
+     * Peek ahead n characters without consuming
+     *
+     * @param n - Number of characters to peek ahead
+     * @returns Character at position+n or null if beyond EOF
+     */
+    peekAhead(n) {
+        const pos = this.position + n;
+        if (pos >= this.input.length) {
+            return null;
+        }
+        return this.input[pos];
+    }
+    /**
+     * Advance to the next character and return the current one
+     *
+     * Updates line and column tracking when encountering newlines.
+     *
+     * @returns Current character or null if at EOF
+     */
+    advance() {
+        if (this.isEOF()) {
+            return null;
+        }
+        const ch = this.input[this.position];
+        this.position++;
+        // Update line and column tracking
+        if (ch === '\n') {
+            this.line++;
+            this.column = 1;
+        }
+        else if (ch === '\r') {
+            // Handle CRLF and CR
+            if (this.peek() === '\n') {
+                // CRLF - consume the LF too
+                this.position++;
+            }
+            this.line++;
+            this.column = 1;
+        }
+        else {
+            this.column++;
+        }
+        return ch;
+    }
+    /**
+     * Read characters until a delimiter is found
+     *
+     * Does NOT consume the delimiter.
+     *
+     * @param delimiter - String or RegExp to match
+     * @returns String of characters read (may be empty)
+     */
+    readUntil(delimiter) {
+        let result = '';
+        while (!this.isEOF()) {
+            const ch = this.peek();
+            if (typeof delimiter === 'string') {
+                // String delimiter - check for exact match
+                if (ch === delimiter) {
+                    break;
+                }
+            }
+            else {
+                // RegExp delimiter - test current character
+                if (delimiter.test(ch)) {
+                    break;
+                }
+            }
+            result += this.advance();
+        }
+        return result;
+    }
+    /**
+     * Read while a condition is true
+     *
+     * @param predicate - Function that returns true to continue reading
+     * @returns String of characters read
+     */
+    readWhile(predicate) {
+        let result = '';
+        while (!this.isEOF()) {
+            const ch = this.peek();
+            if (!predicate(ch)) {
+                break;
+            }
+            result += this.advance();
+        }
+        return result;
+    }
+    /**
+     * Skip whitespace characters (space and tab)
+     *
+     * Does NOT skip newlines (CRLF/LF/CR).
+     */
+    skipWhitespace() {
+        while (!this.isEOF()) {
+            const ch = this.peek();
+            if (ch !== ' ' && ch !== '\t') {
+                break;
+            }
+            this.advance();
+        }
+    }
+    /**
+     * Skip to the next line
+     *
+     * Consumes all characters until and including the next line ending (CRLF/LF/CR).
+     */
+    skipToNextLine() {
+        while (!this.isEOF()) {
+            const ch = this.advance();
+            if (ch === '\n' || ch === '\r') {
+                break;
+            }
+        }
+    }
+    /**
+     * Get current position in the input
+     *
+     * @returns Position object with offset, line, and column
+     */
+    getPosition() {
+        return {
+            offset: this.position,
+            line: this.line,
+            column: this.column,
+        };
+    }
+    /**
+     * Check if at end of file
+     *
+     * @returns true if no more characters to read
+     */
+    isEOF() {
+        return this.position >= this.input.length;
+    }
+    /**
+     * Expect a specific string at the current position
+     *
+     * Consumes the string if it matches, throws otherwise.
+     *
+     * @param expected - String to expect
+     * @throws ParseError if string doesn't match
+     */
+    expect(expected) {
+        const start = this.getPosition();
+        for (let i = 0; i < expected.length; i++) {
+            const ch = this.peek();
+            if (ch === null) {
+                throw new errors_1.ParseError(`Expected "${expected}" but reached end of input`, start.line, start.column, this.getContext(start));
+            }
+            if (ch !== expected[i]) {
+                throw new errors_1.ParseError(`Expected "${expected}" but found "${ch}"`, start.line, start.column, this.getContext(start));
+            }
+            this.advance();
+        }
+    }
+    /**
+     * Expect a character that matches a condition
+     *
+     * Consumes the character if it matches, throws otherwise.
+     *
+     * @param predicate - Function that returns true for valid character
+     * @param description - Description of expected character for error messages
+     * @returns The matched character
+     * @throws ParseError if character doesn't match
+     */
+    expectChar(predicate, description) {
+        const pos = this.getPosition();
+        const ch = this.peek();
+        if (ch === null) {
+            throw new errors_1.ParseError(`Expected ${description} but reached end of input`, pos.line, pos.column, this.getContext(pos));
+        }
+        if (!predicate(ch)) {
+            throw new errors_1.ParseError(`Expected ${description} but found "${ch}"`, pos.line, pos.column, this.getContext(pos));
+        }
+        this.advance();
+        return ch;
+    }
+    /**
+     * Expect end of line (CRLF, LF, or CR)
+     *
+     * @throws ParseError if not at end of line
+     */
+    expectEOL() {
+        const pos = this.getPosition();
+        const ch = this.peek();
+        if (ch === null) {
+            // EOF is acceptable as EOL
+            return;
+        }
+        if (ch !== '\r' && ch !== '\n') {
+            throw new errors_1.ParseError(`Expected end of line but found "${ch}"`, pos.line, pos.column, this.getContext(pos));
+        }
+        this.advance();
+    }
+    /**
+     * Expect space character
+     *
+     * @throws ParseError if not a space
+     */
+    expectSpace() {
+        const pos = this.getPosition();
+        const ch = this.peek();
+        if (ch !== ' ') {
+            throw new errors_1.ParseError(`Expected space but found "${ch}"`, pos.line, pos.column, this.getContext(pos));
+        }
+        this.advance();
+    }
+    /**
+     * Get context around a position for error messages
+     *
+     * Returns a snippet of the input around the position.
+     *
+     * @param pos - Position to get context for
+     * @returns Context string (may be empty)
+     */
+    getContext(pos) {
+        const lines = this.input.split('\n');
+        if (pos.line - 1 < lines.length) {
+            return lines[pos.line - 1];
+        }
+        return '';
+    }
+    /**
+     * Get remaining input from current position
+     *
+     * @returns Remaining input string
+     */
+    getRemainingInput() {
+        return this.input.substring(this.position);
+    }
+    /**
+     * Get a substring of the input
+     *
+     * @param start - Start position
+     * @param end - End position (optional, defaults to current position)
+     * @returns Substring
+     */
+    getSubstring(start, end) {
+        return this.input.substring(start, end !== null && end !== void 0 ? end : this.position);
+    }
+}
+exports.Scanner = Scanner;

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

@@ -0,0 +1,35 @@
+/**
+ * Session description parser for SDP (RFC 8866)
+ *
+ * Main entry point for parsing complete SDP session descriptions
+ */
+import { SessionDescription } from '../types/session';
+/**
+ * Parse a complete SDP session description
+ *
+ * RFC 8866 Section 5 defines the exact ordering of fields:
+ * 1. v= (version) [required, exactly one]
+ * 2. o= (origin) [required, exactly one]
+ * 3. s= (session name) [required, exactly one]
+ * 4. i= (session information) [optional, at most one]
+ * 5. u= (URI) [optional, at most one]
+ * 6. e= (email) [optional, multiple]
+ * 7. p= (phone) [optional, multiple]
+ * 8. c= (connection) [optional, at most one at session level]
+ * 9. b= (bandwidth) [optional, multiple]
+ * 10. Time descriptions [required, at least one]:
+ *     - t= (timing) [required]
+ *     - r= (repeat) [optional, multiple]
+ *     - z= (timezone) [optional, at most one]
+ * 11. k= (key) [optional, at most one]
+ * 12. a= (attributes) [optional, multiple]
+ * 13. Media descriptions [optional, zero or more]:
+ *     - m= (media) [required]
+ *     - i= c= b= k= a= (optional media-level fields)
+ *
+ * @param input - Raw SDP text
+ * @returns Parsed SessionDescription
+ * @throws ParseError if input is invalid or not RFC 8866 compliant
+ */
+export declare function parseSessionDescription(input: string): SessionDescription;
+//# sourceMappingURL=session-parser.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"session-parser.d.ts","sourceRoot":"","sources":["../../../src/parser/session-parser.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAmBH,OAAO,EAAE,kBAAkB,EAA4B,MAAM,kBAAkB,CAAC;AAYhF;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB,CAkNzE"}

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

@@ -0,0 +1,207 @@
+"use strict";
+/**
+ * Session description parser for SDP (RFC 8866)
+ *
+ * Main entry point for parsing complete SDP session descriptions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseSessionDescription = parseSessionDescription;
+const scanner_1 = require("./scanner");
+const field_parser_1 = require("./field-parser");
+const time_parser_1 = require("./time-parser");
+const attribute_parser_1 = require("./attribute-parser");
+const media_parser_1 = require("./media-parser");
+const errors_1 = require("../types/errors");
+const session_1 = require("../types/session");
+const line_reader_1 = require("../utils/line-reader");
+// ============================================================================
+// Session Parser
+// ============================================================================
+/**
+ * Parse a complete SDP session description
+ *
+ * RFC 8866 Section 5 defines the exact ordering of fields:
+ * 1. v= (version) [required, exactly one]
+ * 2. o= (origin) [required, exactly one]
+ * 3. s= (session name) [required, exactly one]
+ * 4. i= (session information) [optional, at most one]
+ * 5. u= (URI) [optional, at most one]
+ * 6. e= (email) [optional, multiple]
+ * 7. p= (phone) [optional, multiple]
+ * 8. c= (connection) [optional, at most one at session level]
+ * 9. b= (bandwidth) [optional, multiple]
+ * 10. Time descriptions [required, at least one]:
+ *     - t= (timing) [required]
+ *     - r= (repeat) [optional, multiple]
+ *     - z= (timezone) [optional, at most one]
+ * 11. k= (key) [optional, at most one]
+ * 12. a= (attributes) [optional, multiple]
+ * 13. Media descriptions [optional, zero or more]:
+ *     - m= (media) [required]
+ *     - i= c= b= k= a= (optional media-level fields)
+ *
+ * @param input - Raw SDP text
+ * @returns Parsed SessionDescription
+ * @throws ParseError if input is invalid or not RFC 8866 compliant
+ */
+function parseSessionDescription(input) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+    // Parse lines
+    const lines = (0, line_reader_1.parseLines)(input);
+    if (lines.length === 0) {
+        throw new errors_1.ParseError('Empty SDP input', 0, 0);
+    }
+    let index = 0;
+    // Helper to get current line
+    const current = () => lines[index];
+    // Helper to consume a line
+    const consume = () => {
+        if (index >= lines.length) {
+            throw new errors_1.ParseError('Unexpected end of SDP', 0, 0);
+        }
+        return lines[index++];
+    };
+    // Helper to expect a specific line type
+    const expect = (type, fieldName) => {
+        var _a;
+        const line = current();
+        if (!line || line.type !== type) {
+            throw new errors_1.ParseError(`Expected ${fieldName} field (${type}=) at line ${index + 1}, but got ${line ? line.type + '=' : 'end of input'}`, (_a = line === null || line === void 0 ? void 0 : line.lineNumber) !== null && _a !== void 0 ? _a : 0, 0);
+        }
+        return consume();
+    };
+    // ========================================================================
+    // 1. Parse required session-level fields (v=, o=, s=)
+    // ========================================================================
+    // v= version (required, exactly one)
+    const vLine = expect('v', 'version');
+    const version = (0, field_parser_1.parseVersionField)(new scanner_1.Scanner(vLine.value));
+    // o= origin (required, exactly one)
+    const oLine = expect('o', 'origin');
+    const origin = (0, field_parser_1.parseOriginField)(new scanner_1.Scanner(oLine.value));
+    // s= session name (required, exactly one)
+    const sLine = expect('s', 'session name');
+    const sessionName = (0, field_parser_1.parseSessionNameField)(new scanner_1.Scanner(sLine.value));
+    // ========================================================================
+    // 2. Parse optional session-level fields (i=, u=, e=, p=, c=, b=)
+    // ========================================================================
+    let sessionInformation;
+    let uri;
+    const emails = [];
+    const phones = [];
+    let connection;
+    const bandwidths = [];
+    // i= session information (optional, at most one)
+    if (((_a = current()) === null || _a === void 0 ? void 0 : _a.type) === 'i') {
+        const iLine = consume();
+        sessionInformation = (0, field_parser_1.parseInformationField)(new scanner_1.Scanner(iLine.value));
+    }
+    // u= URI (optional, at most one)
+    if (((_b = current()) === null || _b === void 0 ? void 0 : _b.type) === 'u') {
+        const uLine = consume();
+        uri = (0, field_parser_1.parseUriField)(new scanner_1.Scanner(uLine.value));
+    }
+    // e= email (optional, multiple)
+    while (((_c = current()) === null || _c === void 0 ? void 0 : _c.type) === 'e') {
+        const eLine = consume();
+        emails.push((0, field_parser_1.parseEmailField)(new scanner_1.Scanner(eLine.value)));
+    }
+    // p= phone (optional, multiple)
+    while (((_d = current()) === null || _d === void 0 ? void 0 : _d.type) === 'p') {
+        const pLine = consume();
+        phones.push((0, field_parser_1.parsePhoneField)(new scanner_1.Scanner(pLine.value)));
+    }
+    // c= connection (optional, at most one at session level)
+    if (((_e = current()) === null || _e === void 0 ? void 0 : _e.type) === 'c') {
+        const cLine = consume();
+        connection = (0, field_parser_1.parseConnectionField)(new scanner_1.Scanner(cLine.value));
+    }
+    // b= bandwidth (optional, multiple)
+    while (((_f = current()) === null || _f === void 0 ? void 0 : _f.type) === 'b') {
+        const bLine = consume();
+        bandwidths.push((0, field_parser_1.parseBandwidthField)(new scanner_1.Scanner(bLine.value)));
+    }
+    // ========================================================================
+    // 3. Parse time descriptions (required, at least one)
+    // ========================================================================
+    const timeDescriptions = [];
+    // Must have at least one time description
+    if (((_g = current()) === null || _g === void 0 ? void 0 : _g.type) !== 't') {
+        throw new errors_1.ParseError(`Expected at least one time description (t=) at line ${index + 1}`, (_j = (_h = current()) === null || _h === void 0 ? void 0 : _h.lineNumber) !== null && _j !== void 0 ? _j : 0, 0);
+    }
+    // Parse time descriptions until we hit k=, a=, m=, or end
+    while (((_k = current()) === null || _k === void 0 ? void 0 : _k.type) === 't') {
+        const tLine = consume();
+        const timing = (0, time_parser_1.parseTimingField)(new scanner_1.Scanner(tLine.value));
+        // Parse optional repeat times (r=)
+        const repeats = [];
+        while (((_l = current()) === null || _l === void 0 ? void 0 : _l.type) === 'r') {
+            const rLine = consume();
+            repeats.push((0, time_parser_1.parseRepeatField)(new scanner_1.Scanner(rLine.value)));
+        }
+        // Parse optional timezone adjustments (z=)
+        let timezone;
+        if (((_m = current()) === null || _m === void 0 ? void 0 : _m.type) === 'z') {
+            const zLine = consume();
+            timezone = (0, time_parser_1.parseTimezoneField)(new scanner_1.Scanner(zLine.value));
+        }
+        timeDescriptions.push((0, time_parser_1.parseTimeDescription)(timing, repeats, timezone));
+    }
+    // ========================================================================
+    // 4. Parse session-level key and attributes (k=, a=)
+    // ========================================================================
+    let key;
+    const attributes = [];
+    // k= key (optional, at most one)
+    if (((_o = current()) === null || _o === void 0 ? void 0 : _o.type) === 'k') {
+        const kLine = consume();
+        key = (0, field_parser_1.parseKeyField)(new scanner_1.Scanner(kLine.value));
+    }
+    // a= attributes (optional, multiple)
+    while (((_p = current()) === null || _p === void 0 ? void 0 : _p.type) === 'a') {
+        const aLine = consume();
+        attributes.push((0, attribute_parser_1.parseAttributeField)(new scanner_1.Scanner(aLine.value)));
+    }
+    // ========================================================================
+    // 5. Parse media descriptions (optional, zero or more)
+    // ========================================================================
+    const mediaDescriptions = [];
+    // Parse media descriptions until end of input
+    while (((_q = current()) === null || _q === void 0 ? void 0 : _q.type) === 'm') {
+        const mLine = consume();
+        // Collect media-level fields (i=, c=, b=, k=, a=)
+        const mediaLines = [];
+        while (current() && ['i', 'c', 'b', 'k', 'a'].includes(current().type)) {
+            const line = consume();
+            mediaLines.push({ type: line.type, value: line.value });
+        }
+        // Parse media description
+        const mediaDescription = (0, media_parser_1.parseMediaDescription)(new scanner_1.Scanner(mLine.value), mediaLines);
+        mediaDescriptions.push(mediaDescription);
+    }
+    // ========================================================================
+    // 6. Validate no unexpected fields remain
+    // ========================================================================
+    if (current()) {
+        const line = current();
+        throw new errors_1.ParseError(`Unexpected field at line ${line.lineNumber}: ${line.type}=`, line.lineNumber, 0);
+    }
+    // ========================================================================
+    // 7. Create and return session description
+    // ========================================================================
+    return (0, session_1.createSessionDescription)({
+        version,
+        origin,
+        sessionName,
+        sessionInformation,
+        uri,
+        emails,
+        phones,
+        connection,
+        bandwidths,
+        timeDescriptions,
+        key,
+        attributes,
+        mediaDescriptions,
+    });
+}

package/dist/src/parser/time-parser.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Time parsers for SDP (RFC 8866)
+ *
+ * Parsers for time description fields (t=, r=, z=)
+ */
+import { Scanner } from './scanner';
+import { Timing, Repeat, Timezone, TimeDescription } from '../types/time';
+/**
+ * Parse timing field
+ *
+ * Format: t=<start-time> <stop-time>
+ *
+ * Both times are NTP timestamps (seconds since Jan 1, 1900).
+ * 0 means unbounded/permanent.
+ *
+ * @param scanner - Scanner instance
+ * @returns Timing object
+ * @throws ParseError if invalid format
+ */
+export declare function parseTimingField(scanner: Scanner): Timing;
+/**
+ * Parse repeat field
+ *
+ * Format: r=<repeat-interval> <active-duration> <offsets-from-start-time>
+ *
+ * repeat-interval: Time between repetitions (typed time)
+ * active-duration: Duration of each session (typed time)
+ * offsets-from-start-time: One or more offsets (typed times)
+ *
+ * Example: r=7d 1h 0 25h
+ * - Repeats weekly (7 days)
+ * - Each session is 1 hour
+ * - Sessions occur at start time (0) and 25 hours after start
+ *
+ * @param scanner - Scanner instance
+ * @returns Repeat object
+ * @throws ParseError if invalid format
+ */
+export declare function parseRepeatField(scanner: Scanner): Repeat;
+/**
+ * Parse timezone field
+ *
+ * Format: z=<adjustment-time> <offset> [<adjustment-time> <offset> ...]
+ *
+ * adjustment-time: NTP timestamp when adjustment takes effect
+ * offset: Typed time offset to apply
+ *
+ * Example: z=2882844526 -1h 2898848070 0
+ * - At time 2882844526, apply -1h offset (fall back)
+ * - At time 2898848070, apply 0 offset (return to standard)
+ *
+ * @param scanner - Scanner instance
+ * @returns Timezone object
+ * @throws ParseError if invalid format
+ */
+export declare function parseTimezoneField(scanner: Scanner): Timezone;
+/**
+ * Parse a time description
+ *
+ * A time description consists of:
+ * - One timing field (t=) [required]
+ * - Zero or more repeat fields (r=) [optional]
+ * - Zero or one timezone field (z=) [optional]
+ *
+ * This is typically used when parsing the time section of an SDP,
+ * but the individual field parsers above can be used for line-by-line parsing.
+ *
+ * @param timing - Timing field
+ * @param repeats - Repeat fields (optional)
+ * @param timezone - Timezone field (optional)
+ * @returns TimeDescription object
+ */
+export declare function parseTimeDescription(timing: Timing, repeats?: Repeat[], timezone?: Timezone): TimeDescription;
+//# sourceMappingURL=time-parser.d.ts.map

package/dist/src/parser/time-parser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"time-parser.d.ts","sourceRoot":"","sources":["../../../src/parser/time-parser.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAGpC,OAAO,EACL,MAAM,EACN,MAAM,EACN,QAAQ,EAER,eAAe,EAMhB,MAAM,eAAe,CAAC;AAOvB;;;;;;;;;;;GAWG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAsBzD;AAMD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CA2CzD;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,QAAQ,CAgD7D;AAMD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,MAAM,EAAO,EACtB,QAAQ,CAAC,EAAE,QAAQ,GAClB,eAAe,CAEjB"}