@oxide/react-asciidoc 2.0.0 → 2.1.0-canary.792ad4d

package/dist/types/index.d.ts

@@ -3,8 +3,10 @@ import RenderInline, { type InlineOverrides, inlineHtml } from './RenderInline';
 import * as Inline from './inline';
 import { Admonition, Audio, CoList, DList, Document, Example, FloatingTitle, Image, Listing, Literal, OList, Open, PageBreak, Paragraph, Pass, Preamble, Quote, Section, Sidebar, Stem, Table, TableOfContents, ThematicBreak, UList, Verse, Video } from './templates';
 import { Title } from './templates/util';
+import { findSection } from './utils/findSection';
+import { plainText } from './utils/plainText';
 import { isOption, prepareDocument, processDocument } from './utils/prepareDocument';
-import type { AdmonitionBlock, AudioBlock, Block, CoListBlock, DListBlock, DocumentBlock, DocumentSection, ImageBlock, ListBlock, LiteralBlock, ParagraphBlock, SectionBlock, TableBlock, VideoBlock } from './utils/prepareDocument';
+import type { AdmonitionBlock, AudioBlock, Block, Cell, CoListBlock, DListBlock, DocumentBlock, DocumentSection, ImageBlock, ListBlock, ListItemBlock, LiteralBlock, ParagraphBlock, SectionBlock, TableBlock, VideoBlock } from './utils/prepareDocument';
 type Overrides = {
     admonition?: typeof Admonition;
     audio?: typeof Audio;
@@ -56,7 +58,7 @@ export declare const useConverterContext: () => Options & {
         sections?: DocumentSection[];
     };
 };
-export { Asciidoc, Content, prepareDocument, Title, parse, processDocument, isOption, RenderInline, inlineHtml, Inline, };
+export { Asciidoc, Content, prepareDocument, Title, parse, processDocument, isOption, findSection, plainText, RenderInline, inlineHtml, Inline, };
 export type { InlineOverrides };
-export type { AdmonitionBlock, AudioBlock, Block, CoListBlock, DListBlock, DocumentBlock, DocumentSection, ImageBlock, ListBlock, LiteralBlock, ParagraphBlock, SectionBlock, TableBlock, VideoBlock, };
+export type { AdmonitionBlock, AudioBlock, Block, Cell, CoListBlock, DListBlock, DocumentBlock, DocumentSection, ImageBlock, ListBlock, ListItemBlock, LiteralBlock, ParagraphBlock, SectionBlock, TableBlock, VideoBlock, };
 export * from './templates';

package/dist/types/inline/index.d.ts

@@ -1,4 +1,4 @@
 export { parseInline, subSpecialchars, subCallouts, subCalloutsRaw } from './parser';
 export type { ParseOptions, ParseState } from './parser';
-export { renderInline, renderInlineAsString } from './renderer';
+export { renderInline, renderInlineAsString, renderInlineAsText } from './renderer';
 export * from './types';

package/dist/types/inline/renderer.d.ts

@@ -1,3 +1,22 @@
 import { InlineNode } from './types';
 export declare function renderInline(nodes: InlineNode[], iconsFont?: boolean): string;
 export declare function renderInlineAsString(nodes: InlineNode[], iconsFont?: boolean): string;
+/**
+ * Render an inline AST back to PLAIN TEXT — the substituted source with no HTML
+ * markup. This is the verbatim-source counterpart to `renderInlineAsString`: it
+ * resolves text-level subs (notably `attributes`) but emits the bare code a
+ * syntax highlighter should tokenize rather than HTML5 elements.
+ *
+ *  - `text` nodes: emitted as-is, with `specialcharacters` entities decoded back
+ *    to literal `< > &` when `decodeEntities` is set (verbatim blocks include
+ *    `specialcharacters` by default, so normally `true`). `raw` passthrough
+ *    nodes (`pass:[]` / `+++`) are already-final author HTML — emitted verbatim,
+ *    never decoded.
+ *  - `quoted` / `anchor` / `footnote` / `button`: flattened to their inner text.
+ *    A highlighter wants the code, not `<em>` / `<a>`; these only appear when the
+ *    author opted into `+quotes` / `+macros` on the block.
+ *  - `callout`: preserved raw as `<N>` — the highlighter resolves callouts itself.
+ *  - `break`: a newline.
+ *  - `image` / `kbd` / `menu` / `indexterm`: no meaningful verbatim text — skipped.
+ */
+export declare function renderInlineAsText(nodes: InlineNode[], decodeEntities?: boolean): string;

package/dist/types/utils/findSection.d.ts

@@ -0,0 +1,7 @@
+import type { Block } from './prepareDocument';
+/**
+ * First block whose `id` matches, depth-first. Descends through child blocks,
+ * list items, and table cells, so any anchored block — not just sections — is
+ * reachable by id.
+ */
+export declare const findSection: (blocks: Block[], id: string) => Block | undefined;

package/dist/types/utils/plainText.d.ts

@@ -0,0 +1,9 @@
+import type { InlineNode } from '../inline';
+/**
+ * Flatten an inline AST to its visible plain text, entity-decoded. The parser
+ * leaves numeric entities (`’`) in text nodes for React to round-trip, so
+ * plain text is where they must be resolved — the library owns both the walk
+ * (coupled to `InlineNode`) and the decode. For tooltips, `alt`/`title`, search
+ * indexing — anywhere a string is needed instead of a React tree.
+ */
+export declare const plainText: (nodes: InlineNode[] | undefined) => string;

package/dist/types/utils/prepareDocument.d.ts

@@ -21,7 +21,7 @@ export type BaseBlock = {
     title?: string | undefined;
     level: number;
 };
-export type Block = BaseBlock | ParagraphBlock | AdmonitionBlock | CoListBlock | ImageBlock | LiteralBlock | SectionBlock | TableBlock | AudioBlock | VideoBlock;
+export type Block = BaseBlock | ParagraphBlock | AdmonitionBlock | ListBlock | CoListBlock | DListBlock | ListItemBlock | ImageBlock | LiteralBlock | SectionBlock | TableBlock | Cell | AudioBlock | VideoBlock;
 export type DocumentSection = {
     id: string;
     title: string;
@@ -99,6 +99,13 @@ export interface LiteralBlock extends BaseBlock {
     type: 'listing';
     source: string;
     language: string | undefined;
+    /** `source` with the block's resolved text-level substitutions applied
+     *  (notably `attributes`), un-escaped and un-highlighted — the plain code a
+     *  syntax highlighter should tokenize. Equals `source` when the block's subs
+     *  make no text-level change. Callout markers are preserved in raw `<N>` form
+     *  (resolve them with `subCalloutsRaw`). Quote/macro subs, if enabled, are
+     *  flattened to their text. */
+    subbedSource: string;
 }
 export interface SectionBlock extends BaseBlock {
     type: 'section';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oxide/react-asciidoc",
-  "version": "2.0.0",
+  "version": "2.1.0-canary.792ad4d",
   "files": [
     "dist"
   ],