@tomgiee/tsdp 1.0.1 → 1.1.0

package/dist/src/parser/core.d.ts

@@ -0,0 +1,366 @@
+/**
+ * Core parsing infrastructure for SDP (RFC 8866)
+ *
+ * This module consolidates:
+ * - Scanner: Low-level tokenization with position tracking
+ * - Primitive parsers: Basic grammar elements (tokens, integers, addresses, times)
+ * - Attribute parsers: SDP attributes (a= fields)
+ */
+import { Position, TypedTime } from '../types/primitives';
+import { Attribute, RtpmapValue, FmtpValue } from '../types/attributes';
+/**
+ * Scanner class for parsing SDP text
+ *
+ * Maintains position information and provides character-level operations
+ * for parsing SDP fields according to RFC 8866 grammar.
+ */
+export declare class Scanner {
+    private readonly input;
+    private position;
+    private line;
+    private column;
+    /**
+     * Create a new Scanner
+     *
+     * @param input - SDP text to scan
+     */
+    constructor(input: string);
+    /**
+     * Peek at the current character without consuming it
+     *
+     * @returns Current character or null if at EOF
+     */
+    peek(): string | null;
+    /**
+     * 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: number): string | null;
+    /**
+     * 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(): string | null;
+    /**
+     * 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: string | RegExp): string;
+    /**
+     * Read while a condition is true
+     *
+     * @param predicate - Function that returns true to continue reading
+     * @returns String of characters read
+     */
+    readWhile(predicate: (ch: string) => boolean): string;
+    /**
+     * Skip whitespace characters (space and tab)
+     *
+     * Does NOT skip newlines (CRLF/LF/CR).
+     */
+    skipWhitespace(): void;
+    /**
+     * Skip to the next line
+     *
+     * Consumes all characters until and including the next line ending (CRLF/LF/CR).
+     */
+    skipToNextLine(): void;
+    /**
+     * Get current position in the input
+     *
+     * @returns Position object with offset, line, and column
+     */
+    getPosition(): Position;
+    /**
+     * Check if at end of file
+     *
+     * @returns true if no more characters to read
+     */
+    isEOF(): boolean;
+    /**
+     * 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: string): void;
+    /**
+     * 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: (ch: string) => boolean, description: string): string;
+    /**
+     * Expect end of line (CRLF, LF, or CR)
+     *
+     * @throws ParseError if not at end of line
+     */
+    expectEOL(): void;
+    /**
+     * Expect space character
+     *
+     * @throws ParseError if not a space
+     */
+    expectSpace(): void;
+    /**
+     * 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)
+     */
+    private getContext;
+    /**
+     * Get remaining input from current position
+     *
+     * @returns Remaining input string
+     */
+    getRemainingInput(): string;
+    /**
+     * Get a substring of the input
+     *
+     * @param start - Start position
+     * @param end - End position (optional, defaults to current position)
+     * @returns Substring
+     */
+    getSubstring(start: number, end?: number): string;
+}
+/**
+ * Parse a token (RFC 8866 Section 9)
+ *
+ * token = 1*token-char
+ * token-char = %x21 / %x23-27 / %x2A-2B / %x2D-2E / %x30-39 / %x41-5A / %x5E-7E
+ *
+ * Essentially: any visible ASCII character except space and separators like ()[]{}:;,<>?=@\"
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed token string
+ * @throws ParseError if no valid token found
+ */
+export declare function parseToken(scanner: Scanner): string;
+/**
+ * Parse an integer
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed integer
+ * @throws ParseError if no valid integer found
+ */
+export declare function parseInteger(scanner: Scanner): number;
+/**
+ * Parse a byte (0-255)
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed byte value
+ * @throws ParseError if not a valid byte
+ */
+export declare function parseByte(scanner: Scanner): number;
+/**
+ * Parse a non-whitespace string
+ *
+ * Reads characters until whitespace or end of line.
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed string
+ * @throws ParseError if empty
+ */
+export declare function parseNonWSString(scanner: Scanner): string;
+/**
+ * Parse a byte-string (RFC 8866 Section 9)
+ *
+ * byte-string = 1*(%x01-09 / %x0B-0C / %x0E-FF)
+ * (any byte except NUL, CR, LF)
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed byte-string
+ * @throws ParseError if invalid characters found
+ */
+export declare function parseByteString(scanner: Scanner): string;
+/**
+ * Parse an IPv4 address
+ *
+ * Format: a.b.c.d where each octet is 0-255
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed IPv4 address
+ * @throws ParseError if invalid IPv4 address
+ */
+export declare function parseIP4Address(scanner: Scanner): string;
+/**
+ * Parse an IPv6 address
+ *
+ * Supports all IPv6 formats including compression (::) and mixed IPv4
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed IPv6 address
+ * @throws ParseError if invalid IPv6 address
+ */
+export declare function parseIP6Address(scanner: Scanner): string;
+/**
+ * Parse an FQDN (Fully Qualified Domain Name)
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed FQDN
+ * @throws ParseError if invalid FQDN
+ */
+export declare function parseFQDN(scanner: Scanner): string;
+/**
+ * Parse an NTP timestamp
+ *
+ * NTP time is seconds since January 1, 1900 00:00:00 UTC
+ * 0 means unbounded/permanent
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed NTP time
+ * @throws ParseError if invalid
+ */
+export declare function parseNtpTime(scanner: Scanner): number;
+/**
+ * Parse a typed time value
+ *
+ * Format: [-]<integer>[d|h|m|s]
+ * - d = days
+ * - h = hours
+ * - m = minutes
+ * - s or no suffix = seconds
+ * - Can be negative (for timezone offsets)
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed typed time
+ * @throws ParseError if invalid
+ */
+export declare function parseTypedTime(scanner: Scanner): TypedTime;
+/**
+ * Parse an email address or display name with email
+ *
+ * Format: email-address / displayable-name <email-address>
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed email string
+ */
+export declare function parseEmail(scanner: Scanner): string;
+/**
+ * Parse a phone number or display name with phone
+ *
+ * Format: phone-number / displayable-name <phone-number>
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed phone string
+ */
+export declare function parsePhone(scanner: Scanner): string;
+/**
+ * Parse a URI
+ *
+ * @param scanner - Scanner instance
+ * @returns Parsed URI string
+ */
+export declare function parseURI(scanner: Scanner): string;
+/**
+ * Parse attribute field
+ *
+ * Format:
+ * - Property attribute: a=<attribute-name>
+ * - Value attribute: a=<attribute-name>:<attribute-value>
+ *
+ * Property attributes have no value (e.g., a=recvonly, a=sendrecv).
+ * Value attributes have a value after colon (e.g., a=rtpmap:0 PCMU/8000).
+ *
+ * @param scanner - Scanner instance
+ * @returns Attribute object
+ * @throws ParseError if invalid format
+ */
+export declare function parseAttributeField(scanner: Scanner): Attribute;
+/**
+ * Parse rtpmap attribute value
+ *
+ * Format: <payload-type> <encoding-name>/<clock-rate>[/<encoding-params>]
+ *
+ * Examples:
+ * - "0 PCMU/8000"
+ * - "96 H264/90000"
+ * - "97 L16/8000/2" (2 channels)
+ *
+ * @param value - rtpmap attribute value string
+ * @returns Parsed RtpmapValue
+ * @throws ParseError if invalid format
+ */
+export declare function parseRtpmapValue(value: string): RtpmapValue;
+/**
+ * Parse fmtp attribute value
+ *
+ * Format: <format> <format-specific-params>
+ *
+ * Examples:
+ * - "96 profile-level-id=42e01f;packetization-mode=1"
+ * - "97 apt=96"
+ *
+ * @param value - fmtp attribute value string
+ * @returns Parsed FmtpValue
+ * @throws ParseError if invalid format
+ */
+export declare function parseFmtpValue(value: string): FmtpValue;
+/**
+ * Parse ptime attribute value
+ *
+ * Format: <packet-time-in-milliseconds>
+ *
+ * RFC 8866 Section 6.4: ptime-value = non-zero-int-or-real
+ * Decimal values are allowed (e.g., "20.5")
+ *
+ * @param value - ptime attribute value string
+ * @returns Packet time in milliseconds (can be fractional)
+ * @throws ParseError if invalid
+ */
+export declare function parsePtimeValue(value: string): number;
+/**
+ * Parse maxptime attribute value
+ *
+ * Format: <max-packet-time-in-milliseconds>
+ *
+ * RFC 8866 Section 6.5: maxptime-value = non-zero-int-or-real
+ * Decimal values are allowed (e.g., "40.0")
+ *
+ * @param value - maxptime attribute value string
+ * @returns Maximum packet time in milliseconds (can be fractional)
+ * @throws ParseError if invalid
+ */
+export declare function parseMaxptimeValue(value: string): number;
+/**
+ * Parse framerate attribute value
+ *
+ * Format: <frames-per-second>
+ *
+ * @param value - framerate attribute value string
+ * @returns Frame rate (frames per second)
+ * @throws ParseError if invalid
+ */
+export declare function parseFramerateValue(value: string): number;
+/**
+ * Parse quality attribute value
+ *
+ * Format: <quality-value>
+ *
+ * Quality is 0-10, where 10 is best quality.
+ *
+ * @param value - quality attribute value string
+ * @returns Quality value (0-10)
+ * @throws ParseError if invalid
+ */
+export declare function parseQualityValue(value: string): number;
+//# sourceMappingURL=core.d.ts.map

package/dist/src/parser/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/parser/core.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAQ1D,OAAO,EACL,SAAS,EACT,WAAW,EACX,SAAS,EAOV,MAAM,qBAAqB,CAAC;AAM7B;;;;;GAKG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,MAAM,CAAS;IAEvB;;;;OAIG;gBACS,KAAK,EAAE,MAAM;IAOzB;;;;OAIG;IACH,IAAI,IAAI,MAAM,GAAG,IAAI;IAOrB;;;;;OAKG;IACH,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAQnC;;;;;;OAMG;IACH,OAAO,IAAI,MAAM,GAAG,IAAI;IA2BxB;;;;;;;OAOG;IACH,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM;IAwB7C;;;;;OAKG;IACH,SAAS,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,GAAG,MAAM;IAcrD;;;;OAIG;IACH,cAAc,IAAI,IAAI;IAUtB;;;;OAIG;IACH,cAAc,IAAI,IAAI;IAStB;;;;OAIG;IACH,WAAW,IAAI,QAAQ;IAQvB;;;;OAIG;IACH,KAAK,IAAI,OAAO;IAIhB;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IA4B9B;;;;;;;;;OASG;IACH,UAAU,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM;IA0B3E;;;;OAIG;IACH,SAAS,IAAI,IAAI;IAqBjB;;;;OAIG;IACH,WAAW,IAAI,IAAI;IAgBnB;;;;;;;OAOG;IACH,OAAO,CAAC,UAAU;IAQlB;;;;OAIG;IACH,iBAAiB,IAAI,MAAM;IAI3B;;;;;;OAMG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM;CAGlD;AA4ED;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAanD;AAMD;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAuBrD;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAalD;AAMD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAazD;AAED;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAaxD;AAMD;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAexD;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAiBxD;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAiBlD;AAMD;;;;;;;;;GASG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAarD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CAiB1D;AAMD;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAGnD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAGnD;AAED;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAGjD;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,SAAS,CA+B/D;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW,CA8D3D;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CA2BvD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAYrD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAYxD;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAYzD;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAYvD"}