rtf-codec 0.0.0 → 1.1.0

package/dist/diagnostics-BgG_KAiN.d.ts

@@ -0,0 +1,52 @@
+//#region src/diagnostics.d.ts
+type RtfDiagnosticSeverity = "info" | "warning";
+interface RtfDiagnostic {
+  readonly code: string;
+  readonly severity: RtfDiagnosticSeverity;
+  readonly message: string;
+  readonly tokenIndex?: number;
+}
+type RtfDiagnosticSink = (diagnostic: RtfDiagnostic) => void;
+declare const NOOP_RTF_DIAGNOSTIC_SINK: RtfDiagnosticSink;
+declare const RtfDiagnosticCodes: {
+  readonly UNBALANCED_GROUP: "rtf/unbalanced-group";
+  readonly UNKNOWN_DESTINATION_SKIPPED: "rtf/unknown-destination-skipped";
+  readonly CONTENT_DESTINATION_SKIPPED: "rtf/content-destination-skipped";
+  readonly UNSUPPORTED_CODEPAGE: "rtf/unsupported-codepage";
+  readonly UNSUPPORTED_PICTURE_FORMAT: "rtf/unsupported-picture-format";
+  readonly PICTURE_SIZE_UNSTATED: "rtf/picture-size-unstated";
+  readonly TABLE_ROW_WITHOUT_DEFINITION: "rtf/table-row-without-definition";
+  readonly TABLE_COLUMN_WIDTH_INVALID: "rtf/table-column-width-invalid";
+  readonly NESTED_TABLE_FLATTENED: "rtf/nested-table-flattened";
+  readonly SECTION_BREAK_UNREPRESENTED: "rtf/section-break-unrepresented";
+  readonly BOOKMARK_UNPAIRED: "rtf/bookmark-unpaired";
+  readonly CONSTRUCT_UNREPRESENTED: "rtf/construct-unrepresented";
+  readonly EMBEDDED_OBJECT_DROPPED: "rtf/embedded-object-dropped";
+  readonly PACKAGE_TABLE_DROPPED: "rtf/package-table-dropped";
+};
+declare class RtfParseError extends Error {
+  readonly code: string;
+  constructor(code: string, message: string);
+}
+declare class RtfNotAnRtfDocumentError extends RtfParseError {
+  constructor(message?: string);
+}
+declare class RtfInputTooLargeError extends RtfParseError {
+  readonly byteLength: number;
+  readonly maxInputBytes: number;
+  constructor(byteLength: number, maxInputBytes: number);
+}
+declare class RtfNestingLimitExceededError extends RtfParseError {
+  readonly maxGroupDepth: number;
+  constructor(maxGroupDepth: number);
+}
+declare class RtfWriteError extends Error {
+  readonly code: string;
+  constructor(code: string, message: string);
+}
+declare class RtfUnsupportedDocumentKindError extends RtfWriteError {
+  readonly documentKind: string;
+  constructor(documentKind: string);
+}
+//#endregion
+export { RtfDiagnosticSink as a, RtfNotAnRtfDocumentError as c, RtfWriteError as d, RtfDiagnosticSeverity as i, RtfParseError as l, RtfDiagnostic as n, RtfInputTooLargeError as o, RtfDiagnosticCodes as r, RtfNestingLimitExceededError as s, NOOP_RTF_DIAGNOSTIC_SINK as t, RtfUnsupportedDocumentKindError as u };

package/dist/diagnostics.cjs

@@ -0,0 +1,76 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/diagnostics.ts
+const NOOP_RTF_DIAGNOSTIC_SINK = () => {};
+const RtfDiagnosticCodes = {
+	UNBALANCED_GROUP: "rtf/unbalanced-group",
+	UNKNOWN_DESTINATION_SKIPPED: "rtf/unknown-destination-skipped",
+	CONTENT_DESTINATION_SKIPPED: "rtf/content-destination-skipped",
+	UNSUPPORTED_CODEPAGE: "rtf/unsupported-codepage",
+	UNSUPPORTED_PICTURE_FORMAT: "rtf/unsupported-picture-format",
+	PICTURE_SIZE_UNSTATED: "rtf/picture-size-unstated",
+	TABLE_ROW_WITHOUT_DEFINITION: "rtf/table-row-without-definition",
+	TABLE_COLUMN_WIDTH_INVALID: "rtf/table-column-width-invalid",
+	NESTED_TABLE_FLATTENED: "rtf/nested-table-flattened",
+	SECTION_BREAK_UNREPRESENTED: "rtf/section-break-unrepresented",
+	BOOKMARK_UNPAIRED: "rtf/bookmark-unpaired",
+	CONSTRUCT_UNREPRESENTED: "rtf/construct-unrepresented",
+	EMBEDDED_OBJECT_DROPPED: "rtf/embedded-object-dropped",
+	PACKAGE_TABLE_DROPPED: "rtf/package-table-dropped"
+};
+var RtfParseError = class extends Error {
+	code;
+	constructor(code, message) {
+		super(message);
+		this.name = "RtfParseError";
+		this.code = code;
+	}
+};
+var RtfNotAnRtfDocumentError = class extends RtfParseError {
+	constructor(message = "input does not begin with '{\\rtf'") {
+		super("rtf/not-an-rtf-document", message);
+		this.name = "RtfNotAnRtfDocumentError";
+	}
+};
+var RtfInputTooLargeError = class extends RtfParseError {
+	byteLength;
+	maxInputBytes;
+	constructor(byteLength, maxInputBytes) {
+		super("rtf/input-too-large", `input is ${String(byteLength)} bytes, over the ${String(maxInputBytes)}-byte limit`);
+		this.name = "RtfInputTooLargeError";
+		this.byteLength = byteLength;
+		this.maxInputBytes = maxInputBytes;
+	}
+};
+var RtfNestingLimitExceededError = class extends RtfParseError {
+	maxGroupDepth;
+	constructor(maxGroupDepth) {
+		super("rtf/nesting-limit-exceeded", `group nesting exceeded the ${String(maxGroupDepth)}-level limit`);
+		this.name = "RtfNestingLimitExceededError";
+		this.maxGroupDepth = maxGroupDepth;
+	}
+};
+var RtfWriteError = class extends Error {
+	code;
+	constructor(code, message) {
+		super(message);
+		this.name = "RtfWriteError";
+		this.code = code;
+	}
+};
+var RtfUnsupportedDocumentKindError = class extends RtfWriteError {
+	documentKind;
+	constructor(documentKind) {
+		super("rtf/unsupported-document-kind", `RTF is a wordprocessing format; a '${documentKind}' ContentDocument has no RTF representation`);
+		this.name = "RtfUnsupportedDocumentKindError";
+		this.documentKind = documentKind;
+	}
+};
+//#endregion
+exports.NOOP_RTF_DIAGNOSTIC_SINK = NOOP_RTF_DIAGNOSTIC_SINK;
+exports.RtfDiagnosticCodes = RtfDiagnosticCodes;
+exports.RtfInputTooLargeError = RtfInputTooLargeError;
+exports.RtfNestingLimitExceededError = RtfNestingLimitExceededError;
+exports.RtfNotAnRtfDocumentError = RtfNotAnRtfDocumentError;
+exports.RtfParseError = RtfParseError;
+exports.RtfUnsupportedDocumentKindError = RtfUnsupportedDocumentKindError;
+exports.RtfWriteError = RtfWriteError;

package/dist/diagnostics.d.cts

@@ -0,0 +1,2 @@
+import { a as RtfDiagnosticSink, c as RtfNotAnRtfDocumentError, d as RtfWriteError, i as RtfDiagnosticSeverity, l as RtfParseError, n as RtfDiagnostic, o as RtfInputTooLargeError, r as RtfDiagnosticCodes, s as RtfNestingLimitExceededError, t as NOOP_RTF_DIAGNOSTIC_SINK, u as RtfUnsupportedDocumentKindError } from "./diagnostics-BgG_KAiN.cjs";
+export { NOOP_RTF_DIAGNOSTIC_SINK, RtfDiagnostic, RtfDiagnosticCodes, RtfDiagnosticSeverity, RtfDiagnosticSink, RtfInputTooLargeError, RtfNestingLimitExceededError, RtfNotAnRtfDocumentError, RtfParseError, RtfUnsupportedDocumentKindError, RtfWriteError };

package/dist/diagnostics.d.ts

@@ -0,0 +1,2 @@
+import { a as RtfDiagnosticSink, c as RtfNotAnRtfDocumentError, d as RtfWriteError, i as RtfDiagnosticSeverity, l as RtfParseError, n as RtfDiagnostic, o as RtfInputTooLargeError, r as RtfDiagnosticCodes, s as RtfNestingLimitExceededError, t as NOOP_RTF_DIAGNOSTIC_SINK, u as RtfUnsupportedDocumentKindError } from "./diagnostics-BgG_KAiN.js";
+export { NOOP_RTF_DIAGNOSTIC_SINK, RtfDiagnostic, RtfDiagnosticCodes, RtfDiagnosticSeverity, RtfDiagnosticSink, RtfInputTooLargeError, RtfNestingLimitExceededError, RtfNotAnRtfDocumentError, RtfParseError, RtfUnsupportedDocumentKindError, RtfWriteError };

package/dist/diagnostics.js

@@ -0,0 +1,68 @@
+//#region src/diagnostics.ts
+const NOOP_RTF_DIAGNOSTIC_SINK = () => {};
+const RtfDiagnosticCodes = {
+	UNBALANCED_GROUP: "rtf/unbalanced-group",
+	UNKNOWN_DESTINATION_SKIPPED: "rtf/unknown-destination-skipped",
+	CONTENT_DESTINATION_SKIPPED: "rtf/content-destination-skipped",
+	UNSUPPORTED_CODEPAGE: "rtf/unsupported-codepage",
+	UNSUPPORTED_PICTURE_FORMAT: "rtf/unsupported-picture-format",
+	PICTURE_SIZE_UNSTATED: "rtf/picture-size-unstated",
+	TABLE_ROW_WITHOUT_DEFINITION: "rtf/table-row-without-definition",
+	TABLE_COLUMN_WIDTH_INVALID: "rtf/table-column-width-invalid",
+	NESTED_TABLE_FLATTENED: "rtf/nested-table-flattened",
+	SECTION_BREAK_UNREPRESENTED: "rtf/section-break-unrepresented",
+	BOOKMARK_UNPAIRED: "rtf/bookmark-unpaired",
+	CONSTRUCT_UNREPRESENTED: "rtf/construct-unrepresented",
+	EMBEDDED_OBJECT_DROPPED: "rtf/embedded-object-dropped",
+	PACKAGE_TABLE_DROPPED: "rtf/package-table-dropped"
+};
+var RtfParseError = class extends Error {
+	code;
+	constructor(code, message) {
+		super(message);
+		this.name = "RtfParseError";
+		this.code = code;
+	}
+};
+var RtfNotAnRtfDocumentError = class extends RtfParseError {
+	constructor(message = "input does not begin with '{\\rtf'") {
+		super("rtf/not-an-rtf-document", message);
+		this.name = "RtfNotAnRtfDocumentError";
+	}
+};
+var RtfInputTooLargeError = class extends RtfParseError {
+	byteLength;
+	maxInputBytes;
+	constructor(byteLength, maxInputBytes) {
+		super("rtf/input-too-large", `input is ${String(byteLength)} bytes, over the ${String(maxInputBytes)}-byte limit`);
+		this.name = "RtfInputTooLargeError";
+		this.byteLength = byteLength;
+		this.maxInputBytes = maxInputBytes;
+	}
+};
+var RtfNestingLimitExceededError = class extends RtfParseError {
+	maxGroupDepth;
+	constructor(maxGroupDepth) {
+		super("rtf/nesting-limit-exceeded", `group nesting exceeded the ${String(maxGroupDepth)}-level limit`);
+		this.name = "RtfNestingLimitExceededError";
+		this.maxGroupDepth = maxGroupDepth;
+	}
+};
+var RtfWriteError = class extends Error {
+	code;
+	constructor(code, message) {
+		super(message);
+		this.name = "RtfWriteError";
+		this.code = code;
+	}
+};
+var RtfUnsupportedDocumentKindError = class extends RtfWriteError {
+	documentKind;
+	constructor(documentKind) {
+		super("rtf/unsupported-document-kind", `RTF is a wordprocessing format; a '${documentKind}' ContentDocument has no RTF representation`);
+		this.name = "RtfUnsupportedDocumentKindError";
+		this.documentKind = documentKind;
+	}
+};
+//#endregion
+export { NOOP_RTF_DIAGNOSTIC_SINK, RtfDiagnosticCodes, RtfInputTooLargeError, RtfNestingLimitExceededError, RtfNotAnRtfDocumentError, RtfParseError, RtfUnsupportedDocumentKindError, RtfWriteError };

package/dist/group.cjs

@@ -0,0 +1,40 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/group.ts
+function matchingGroupEnd(tokens, start) {
+	let depth = 0;
+	for (let index = start; index < tokens.length; index += 1) {
+		const kind = tokens[index]?.kind;
+		if (kind === "groupStart") {
+			depth += 1;
+			continue;
+		}
+		if (kind === "groupEnd") {
+			depth -= 1;
+			if (depth === 0) return index;
+		}
+	}
+	return tokens.length;
+}
+function groupHead(tokens, start) {
+	let cursor = start + 1;
+	let ignorable = false;
+	const first = tokens[cursor];
+	if (first?.kind === "controlSymbol" && first.symbol === "*") {
+		ignorable = true;
+		cursor += 1;
+	}
+	const head = tokens[cursor];
+	if (head?.kind !== "controlWord") return {
+		destination: void 0,
+		ignorable,
+		contentStart: cursor
+	};
+	return {
+		destination: head.name,
+		ignorable,
+		contentStart: cursor + 1
+	};
+}
+//#endregion
+exports.groupHead = groupHead;
+exports.matchingGroupEnd = matchingGroupEnd;

package/dist/group.d.cts

@@ -0,0 +1,11 @@
+import { RtfToken } from "./tokenize.cjs";
+//#region src/group.d.ts
+interface GroupHead {
+  readonly destination: string | undefined;
+  readonly ignorable: boolean;
+  readonly contentStart: number;
+}
+declare function matchingGroupEnd(tokens: readonly RtfToken[], start: number): number;
+declare function groupHead(tokens: readonly RtfToken[], start: number): GroupHead;
+//#endregion
+export { GroupHead, groupHead, matchingGroupEnd };

package/dist/group.d.ts

@@ -0,0 +1,11 @@
+import { RtfToken } from "./tokenize.js";
+//#region src/group.d.ts
+interface GroupHead {
+  readonly destination: string | undefined;
+  readonly ignorable: boolean;
+  readonly contentStart: number;
+}
+declare function matchingGroupEnd(tokens: readonly RtfToken[], start: number): number;
+declare function groupHead(tokens: readonly RtfToken[], start: number): GroupHead;
+//#endregion
+export { GroupHead, groupHead, matchingGroupEnd };

package/dist/group.js

@@ -0,0 +1,38 @@
+//#region src/group.ts
+function matchingGroupEnd(tokens, start) {
+	let depth = 0;
+	for (let index = start; index < tokens.length; index += 1) {
+		const kind = tokens[index]?.kind;
+		if (kind === "groupStart") {
+			depth += 1;
+			continue;
+		}
+		if (kind === "groupEnd") {
+			depth -= 1;
+			if (depth === 0) return index;
+		}
+	}
+	return tokens.length;
+}
+function groupHead(tokens, start) {
+	let cursor = start + 1;
+	let ignorable = false;
+	const first = tokens[cursor];
+	if (first?.kind === "controlSymbol" && first.symbol === "*") {
+		ignorable = true;
+		cursor += 1;
+	}
+	const head = tokens[cursor];
+	if (head?.kind !== "controlWord") return {
+		destination: void 0,
+		ignorable,
+		contentStart: cursor
+	};
+	return {
+		destination: head.name,
+		ignorable,
+		contentStart: cursor + 1
+	};
+}
+//#endregion
+export { groupHead, matchingGroupEnd };