@copilotkit/markdown 0.0.1 → 2.0.0-rc.13

package/dist/index.d.mts

@@ -0,0 +1,361 @@
+//#region src/parser/types.d.ts
+type SegmentGranularity = "grapheme" | "word" | "sentence";
+/**
+ * Segmenter configuration for parse-time text segmentation.
+ * @public
+ */
+type SegmenterOptions = false | true | {
+  locale?: string;
+  granularity?: SegmentGranularity;
+};
+/**
+ * Options for the streaming markdown parser.
+ * @public
+ */
+type StreamingMarkdownParserOptions = {
+  segmenter: SegmenterOptions;
+  enableTables: boolean;
+  enableAutolinks: boolean;
+};
+/**
+ * Supported streaming markdown AST node kinds.
+ * @public
+ */
+type StreamingMarkdownNodeType = "document" | "paragraph" | "heading" | "blockquote" | "list" | "list-item" | "code-block" | "table" | "table-row" | "table-cell" | "thematic-break" | "text" | "em" | "strong" | "strikethrough" | "inline-code" | "soft-break" | "hard-break" | "image" | "link" | "autolink" | "citation";
+/**
+ * Parsing mode for block-level processing.
+ * @public
+ */
+type ParseMode = "block" | "paragraph" | "heading" | "blockquote" | "list-item" | "code-fence" | "table";
+/**
+ * Parser warning variants.
+ * @public
+ */
+type StreamingMarkdownWarning = {
+  code: "unterminated_construct";
+  kind: string;
+  at: number;
+} | {
+  code: "invalid_citation_definition";
+  at: number;
+} | {
+  code: "unmatched_closer";
+  token: string;
+  at: number;
+} | {
+  code: "segmenter_unavailable";
+  at: number;
+} | {
+  code: "unknown_construct";
+  at: number;
+};
+/**
+ * Parse-time text segment for animation-friendly rendering.
+ * @public
+ */
+type TextSegment = {
+  text: string;
+  start: number;
+  end: number;
+  kind: SegmentGranularity;
+  isWhitespace: boolean;
+  /**
+   * Hint for renderers to avoid line-breaking before this segment.
+   * @public
+   */
+  noBreakBefore?: boolean;
+};
+/**
+ * Shared fields on all AST nodes.
+ * @public
+ */
+type StreamingMarkdownAstNodeBase = {
+  id: number;
+  type: StreamingMarkdownNodeType;
+  parentId: number | null;
+  closed: boolean;
+  range: {
+    start: number;
+    end: number;
+  };
+};
+/**
+ * AST node representing the document root.
+ * @public
+ */
+type StreamingMarkdownDocumentNode = StreamingMarkdownAstNodeBase & {
+  type: "document";
+  children: number[];
+};
+/**
+ * AST node representing a paragraph.
+ * @public
+ */
+type StreamingMarkdownParagraphNode = StreamingMarkdownAstNodeBase & {
+  type: "paragraph";
+  children: number[];
+};
+/**
+ * AST node representing a heading.
+ * @public
+ */
+type StreamingMarkdownHeadingNode = StreamingMarkdownAstNodeBase & {
+  type: "heading";
+  level: 1 | 2 | 3 | 4 | 5 | 6;
+  children: number[];
+};
+/**
+ * AST node representing a blockquote.
+ * @public
+ */
+type StreamingMarkdownBlockquoteNode = StreamingMarkdownAstNodeBase & {
+  type: "blockquote";
+  children: number[];
+};
+/**
+ * AST node representing a list.
+ * @public
+ */
+type StreamingMarkdownListNode = StreamingMarkdownAstNodeBase & {
+  type: "list";
+  ordered: boolean;
+  start: number | null;
+  tight: boolean;
+  children: number[];
+};
+/**
+ * AST node representing a list item.
+ * @public
+ */
+type StreamingMarkdownListItemNode = StreamingMarkdownAstNodeBase & {
+  type: "list-item";
+  children: number[];
+};
+/**
+ * AST node representing a fenced code block.
+ * @public
+ */
+type StreamingMarkdownCodeBlockNode = StreamingMarkdownAstNodeBase & {
+  type: "code-block";
+  fence: "```" | "~~~";
+  info?: string;
+  meta?: string;
+  text: string;
+};
+/**
+ * AST node representing a table.
+ * @public
+ */
+type StreamingMarkdownTableNode = StreamingMarkdownAstNodeBase & {
+  type: "table";
+  align: Array<"left" | "right" | "center" | "none">;
+  children: number[];
+};
+/**
+ * AST node representing a table row.
+ * @public
+ */
+type StreamingMarkdownTableRowNode = StreamingMarkdownAstNodeBase & {
+  type: "table-row";
+  isHeader: boolean;
+  children: number[];
+};
+/**
+ * AST node representing a table cell.
+ * @public
+ */
+type StreamingMarkdownTableCellNode = StreamingMarkdownAstNodeBase & {
+  type: "table-cell";
+  children: number[];
+};
+/**
+ * AST node representing a thematic break.
+ * @public
+ */
+type StreamingMarkdownThematicBreakNode = StreamingMarkdownAstNodeBase & {
+  type: "thematic-break";
+};
+/**
+ * AST node representing a text run.
+ * @public
+ */
+type StreamingMarkdownTextNode = StreamingMarkdownAstNodeBase & {
+  type: "text";
+  text: string;
+  segments: TextSegment[];
+};
+/**
+ * AST node representing emphasis.
+ * @public
+ */
+type StreamingMarkdownEmphasisNode = StreamingMarkdownAstNodeBase & {
+  type: "em";
+  children: number[];
+};
+/**
+ * AST node representing strong emphasis.
+ * @public
+ */
+type StreamingMarkdownStrongNode = StreamingMarkdownAstNodeBase & {
+  type: "strong";
+  children: number[];
+};
+/**
+ * AST node representing strikethrough.
+ * @public
+ */
+type StreamingMarkdownStrikethroughNode = StreamingMarkdownAstNodeBase & {
+  type: "strikethrough";
+  children: number[];
+};
+/**
+ * AST node representing inline code.
+ * @public
+ */
+type StreamingMarkdownInlineCodeNode = StreamingMarkdownAstNodeBase & {
+  type: "inline-code";
+  text: string;
+};
+/**
+ * AST node representing a soft line break.
+ * @public
+ */
+type StreamingMarkdownSoftBreakNode = StreamingMarkdownAstNodeBase & {
+  type: "soft-break";
+};
+/**
+ * AST node representing a hard line break.
+ * @public
+ */
+type StreamingMarkdownHardBreakNode = StreamingMarkdownAstNodeBase & {
+  type: "hard-break";
+};
+/**
+ * AST node representing a link.
+ * @public
+ */
+type StreamingMarkdownLinkNode = StreamingMarkdownAstNodeBase & {
+  type: "link";
+  url: string;
+  title?: string;
+  children: number[];
+};
+/**
+ * AST node representing an image.
+ * @public
+ */
+type StreamingMarkdownImageNode = StreamingMarkdownAstNodeBase & {
+  type: "image";
+  url: string;
+  title?: string;
+  alt: string;
+};
+/**
+ * AST node representing an autolink.
+ * @public
+ */
+type StreamingMarkdownAutolinkNode = StreamingMarkdownAstNodeBase & {
+  type: "autolink";
+  url: string;
+  text: string;
+};
+/**
+ * AST node representing a citation reference.
+ * @public
+ */
+type StreamingMarkdownCitationNode = StreamingMarkdownAstNodeBase & {
+  type: "citation";
+  idRef: string;
+  number?: number;
+};
+/**
+ * Union of all AST node shapes.
+ * @public
+ */
+type StreamingMarkdownAstNode = StreamingMarkdownDocumentNode | StreamingMarkdownParagraphNode | StreamingMarkdownHeadingNode | StreamingMarkdownBlockquoteNode | StreamingMarkdownListNode | StreamingMarkdownListItemNode | StreamingMarkdownCodeBlockNode | StreamingMarkdownTableNode | StreamingMarkdownTableRowNode | StreamingMarkdownTableCellNode | StreamingMarkdownThematicBreakNode | StreamingMarkdownTextNode | StreamingMarkdownEmphasisNode | StreamingMarkdownStrongNode | StreamingMarkdownStrikethroughNode | StreamingMarkdownInlineCodeNode | StreamingMarkdownSoftBreakNode | StreamingMarkdownHardBreakNode | StreamingMarkdownImageNode | StreamingMarkdownLinkNode | StreamingMarkdownAutolinkNode | StreamingMarkdownCitationNode;
+/**
+ * Citation definition captured during parsing.
+ * @public
+ */
+type CitationDefinition = {
+  id: string;
+  text: string;
+  url?: string;
+};
+/**
+ * Citation parser state.
+ * @public
+ */
+type CitationState = {
+  order: string[];
+  numbers: Record<string, number>;
+  definitions: Record<string, CitationDefinition>;
+};
+/**
+ * Immutable state for streaming markdown parsing.
+ * @public
+ */
+type StreamingMarkdownParserState = {
+  nextId: number;
+  nodes: StreamingMarkdownAstNode[];
+  rootId: number | null;
+  stack: number[];
+  mode: ParseMode;
+  warnings: StreamingMarkdownWarning[];
+  citations: CitationState;
+  lineBuffer: string;
+  isComplete: boolean;
+  index: number;
+  line: number;
+  column: number;
+  options: StreamingMarkdownParserOptions;
+  source: string;
+  pathToId: Record<string, number>;
+  pendingCarriageReturn: boolean;
+  hasWarnedSegmenterUnavailable: boolean;
+};
+//#endregion
+//#region src/parser/state.d.ts
+/**
+ * Creates a new streaming markdown parser state.
+ *
+ * @param options - Optional parser option overrides.
+ * @returns New immutable parser state.
+ * @public
+ */
+declare function createStreamingMarkdownParserState(options?: Partial<StreamingMarkdownParserOptions>): StreamingMarkdownParserState;
+/**
+ * Parses a streaming chunk and returns the next immutable parser state.
+ *
+ * @param state - Current parser state.
+ * @param chunk - Incoming text chunk.
+ * @returns Updated parser state.
+ * @public
+ */
+declare function parseStreamingMarkdownChunk(state: StreamingMarkdownParserState, chunk: string): StreamingMarkdownParserState;
+/**
+ * Finalizes parsing by closing any provisional nodes and flushing trailing CR.
+ *
+ * @param state - Current parser state.
+ * @returns Final parser state.
+ * @public
+ */
+declare function finalizeStreamingMarkdown(state: StreamingMarkdownParserState): StreamingMarkdownParserState;
+//#endregion
+//#region src/dev-warning.d.ts
+/**
+ * Dev-only, once-per-session warning emitted when CopilotKit's built-in default
+ * markdown renderer encounters markdown it won't render richly — math
+ * (`$$…$$` / `\[…\]`) or a language-tagged fenced code block (rendered as plain,
+ * un-highlighted code). Helps people upgrading from the bundled Streamdown
+ * default notice the behavioral change and points them at the migration guide.
+ *
+ * No-op in production and after the first warning. Only the built-in default
+ * renderers call this — a custom `markdownRenderer` never triggers it.
+ *
+ * @internal
+ */
+declare function warnUnsupportedRichSyntaxOnce(content: string): void;
+//#endregion
+export { type CitationDefinition, type CitationState, type ParseMode, type SegmenterOptions, type StreamingMarkdownAstNode, type StreamingMarkdownNodeType, type StreamingMarkdownParserOptions, type StreamingMarkdownParserState, type StreamingMarkdownWarning, type TextSegment, createStreamingMarkdownParserState, finalizeStreamingMarkdown, parseStreamingMarkdownChunk, warnUnsupportedRichSyntaxOnce };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/parser/types.ts","../src/parser/state.ts","../src/dev-warning.ts"],"mappings":";KAAK,kBAAA;;;;;KAMO,gBAAA;EAIN,MAAA;EACA,WAAA,GAAc,kBAAA;AAAA;;;;;KAOR,8BAAA;EACV,SAAA,EAAW,gBAAA;EACX,YAAA;EACA,eAAA;AAAA;;;;;KAOU,yBAAA;;;AAAZ;;KA4BY,SAAA;;;AAAZ;;KAaY,wBAAA;EACN,IAAA;EAAgC,IAAA;EAAc,EAAA;AAAA;EAC9C,IAAA;EAAqC,EAAA;AAAA;EACrC,IAAA;EAA0B,KAAA;EAAe,EAAA;AAAA;EACzC,IAAA;EAA+B,EAAA;AAAA;EAC/B,IAAA;EAA2B,EAAA;AAAA;;;;AAMjC;KAAY,WAAA;EACV,IAAA;EACA,KAAA;EACA,GAAA;EACA,IAAA,EAAM,kBAAA;EACN,YAAA;EADA;;;;EAMA,aAAA;AAAA;AAOF;;;;AAAA,KAAY,4BAAA;EACV,EAAA;EACA,IAAA,EAAM,yBAAA;EACN,QAAA;EACA,MAAA;EACA,KAAA;IAAS,KAAA;IAAe,GAAA;EAAA;AAAA;AAO1B;;;;AAAA,KAAY,6BAAA,GAAgC,4BAAA;EAC1C,IAAA;EACA,QAAA;AAAA;;AAOF;;;KAAY,8BAAA,GAAiC,4BAAA;EAC3C,IAAA;EACA,QAAA;AAAA;;;AAOF;;KAAY,4BAAA,GAA+B,4BAAA;EACzC,IAAA;EACA,KAAA;EACA,QAAA;AAAA;;;;AAOF;KAAY,+BAAA,GAAkC,4BAAA;EAC5C,IAAA;EACA,QAAA;AAAA;;;;;KAOU,yBAAA,GAA4B,4BAAA;EACtC,IAAA;EACA,OAAA;EACA,KAAA;EACA,KAAA;EACA,QAAA;AAAA;;;;;KAOU,6BAAA,GAAgC,4BAAA;EAC1C,IAAA;EACA,QAAA;AAAA;;;;;KAOU,8BAAA,GAAiC,4BAAA;EAC3C,IAAA;EACA,KAAA;EACA,IAAA;EACA,IAAA;EACA,IAAA;AAAA;;;;;KAOU,0BAAA,GAA6B,4BAAA;EACvC,IAAA;EACA,KAAA,EAAO,KAAA;EACP,QAAA;AAAA;;;;;KAOU,6BAAA,GAAgC,4BAAA;EAC1C,IAAA;EACA,QAAA;EACA,QAAA;AAAA;AAHF;;;;AAAA,KAUY,8BAAA,GAAiC,4BAAA;EAC3C,IAAA;EACA,QAAA;AAAA;;;AAFF;;KASY,kCAAA,GACV,4BAAA;EACE,IAAA;AAAA;;;;;KAOQ,yBAAA,GAA4B,4BAAA;EACtC,IAAA;EACA,IAAA;EACA,QAAA,EAAU,WAAA;AAAA;AAHZ;;;;AAAA,KAUY,6BAAA,GAAgC,4BAAA;EAC1C,IAAA;EACA,QAAA;AAAA;;;;AAFF;KASY,2BAAA,GAA8B,4BAAA;EACxC,IAAA;EACA,QAAA;AAAA;;;;;KAOU,kCAAA,GACV,4BAAA;EACE,IAAA;EACA,QAAA;AAAA;;;;;KAOQ,+BAAA,GAAkC,4BAAA;EAC5C,IAAA;EACA,IAAA;AAAA;;;;;KAOU,8BAAA,GAAiC,4BAAA;EAC3C,IAAA;AAAA;;;;;KAOU,8BAAA,GAAiC,4BAAA;EAC3C,IAAA;AAAA;;AATF;;;KAgBY,yBAAA,GAA4B,4BAAA;EACtC,IAAA;EACA,GAAA;EACA,KAAA;EACA,QAAA;AAAA;;AAJF;;;KAWY,0BAAA,GAA6B,4BAAA;EACvC,IAAA;EACA,GAAA;EACA,KAAA;EACA,GAAA;AAAA;;;AAJF;;KAWY,6BAAA,GAAgC,4BAAA;EAC1C,IAAA;EACA,GAAA;EACA,IAAA;AAAA;;;;;KAOU,6BAAA,GAAgC,4BAAA;EAC1C,IAAA;EACA,KAAA;EACA,MAAA;AAAA;;;;;KAOU,wBAAA,GACR,6BAAA,GACA,8BAAA,GACA,4BAAA,GACA,+BAAA,GACA,yBAAA,GACA,6BAAA,GACA,8BAAA,GACA,0BAAA,GACA,6BAAA,GACA,8BAAA,GACA,kCAAA,GACA,yBAAA,GACA,6BAAA,GACA,2BAAA,GACA,kCAAA,GACA,+BAAA,GACA,8BAAA,GACA,8BAAA,GACA,0BAAA,GACA,yBAAA,GACA,6BAAA,GACA,6BAAA;AAhCJ;;;;AAAA,KAsCY,kBAAA;EACV,EAAA;EACA,IAAA;EACA,GAAA;AAAA;;AA/BF;;;KAsCY,aAAA;EACV,KAAA;EACA,OAAA,EAAS,MAAA;EACT,WAAA,EAAa,MAAA,SAAe,kBAAA;AAAA;;;;;KAOlB,4BAAA;EACV,MAAA;EACA,KAAA,EAAO,wBAAA;EACP,MAAA;EACA,KAAA;EACA,IAAA,EAAM,SAAA;EACN,QAAA,EAAU,wBAAA;EACV,SAAA,EAAW,aAAA;EACX,UAAA;EACA,UAAA;EACA,KAAA;EACA,IAAA;EACA,MAAA;EACA,OAAA,EAAS,8BAAA;EACT,MAAA;EACA,QAAA,EAAU,MAAA;EACV,qBAAA;EACA,6BAAA;AAAA;;;;;;;;AA7XF;;iBCkBgB,kCAAA,CACd,OAAA,GAAU,OAAA,CAAQ,8BAAA,IACjB,4BAAA;;;;;;;ADRH;;iBCoDgB,2BAAA,CACd,KAAA,EAAO,4BAAA,EACP,KAAA,WACC,4BAAA;;;;;;;;iBAkBa,yBAAA,CACd,KAAA,EAAO,4BAAA,GACN,4BAAA;;;;;;;;;ADvFH;;;;;;iBE2BgB,6BAAA,CAA8B,OAAA"}