mdq-cli 0.1.0

package/types/query.d.ts

@@ -0,0 +1,118 @@
+import { type Token } from 'marked';
+import { MarkdownEditor } from './edit.js';
+export { MarkdownEditor };
+export declare class MarkdownQuery {
+    private source;
+    private matches;
+    constructor(source: string, matches?: MatchedRange[]);
+    query(selector: string, matcher?: Matcher): MarkdownQuery;
+    section(matcher?: Matcher, options?: SelectorOptions): MarkdownQuery;
+    heading(matcher?: Matcher, options?: SelectorOptions): MarkdownQuery;
+    paragraph(matcher?: Matcher): MarkdownQuery;
+    table(matcher?: Matcher): MarkdownQuery;
+    list(matcher?: Matcher): MarkdownQuery;
+    item(matcher?: Matcher): MarkdownQuery;
+    code(matcher?: Matcher): MarkdownQuery;
+    blockquote(matcher?: Matcher): MarkdownQuery;
+    comment(matcher?: Matcher): MarkdownQuery;
+    html(matcher?: Matcher): MarkdownQuery;
+    hr(): MarkdownQuery;
+    text(): string;
+    nodes(): NodeInfo[];
+    rows(): Record<string, string>[];
+    entries(): Record<string, string>;
+    frontmatter(): Record<string, unknown>;
+    count(): number;
+    exists(): boolean;
+    at(index: number): MarkdownQuery;
+    slice(from?: number, to?: number): MarkdownQuery;
+    first(): MarkdownQuery;
+    last(): MarkdownQuery;
+    each(): MarkdownQuery[];
+    preceding(): MarkdownQuery;
+    following(): MarkdownQuery;
+    replace(content: Markdown): MarkdownQuery;
+    replaceEach(replacer: (match: MarkdownQuery, index: number) => Markdown): MarkdownQuery;
+    remove(): MarkdownQuery;
+    insertBefore(markdown: Markdown): MarkdownQuery;
+    insertAfter(markdown: Markdown): MarkdownQuery;
+    prepend(markdown: Markdown): MarkdownQuery;
+    append(markdown: Markdown): MarkdownQuery;
+    addRow(row: Record<string, string>): MarkdownQuery;
+    addItem(text: string): MarkdownQuery;
+    setEntry(key: string, value: string | null): MarkdownQuery;
+    setFrontmatter(key: string, value: unknown): MarkdownQuery;
+    toString(): string;
+    valueOf(): string;
+    /** Compatibility aliases. Each delegates to the canonical name above; prefer those. */
+    get(): string;
+    meta(): NodeInfo[];
+    toJson(): Record<string, string>[];
+    keyValue(): Record<string, string>;
+    setKeyValue(key: string, value: string | null): MarkdownQuery;
+    before(): MarkdownQuery;
+    after(): MarkdownQuery;
+    private editor;
+    private run;
+    private sectionsOf;
+    private itemsOf;
+    private expandSections;
+    private narrow;
+    private filterByText;
+    private matchText;
+    private valueMatcher;
+    private tokenText;
+    private isComment;
+    private insertAll;
+    private containerStart;
+    private containerEnd;
+}
+export declare class MdqError extends Error {
+}
+export declare class MdqSelectorError extends MdqError {
+    index: number;
+    constructor(message: string, index: number);
+}
+export declare class MdqOperationError extends MdqError {
+    constructor(message: string);
+}
+export declare function mdq(source: Markdown): MarkdownQuery;
+export declare function parseQuery(input: string): QuerySegment[];
+export declare function buildTokenIndex(source: string): MatchedRange[];
+export type Markdown = string | MarkdownQuery;
+export type Matcher = string | RegExp | ((text: string) => boolean);
+export type SelectorType = 'comment' | 'html' | 'section' | 'section1' | 'section2' | 'section3' | 'section4' | 'section5' | 'section6' | 'table' | 'heading' | 'paragraph' | 'list' | 'item' | 'code' | 'blockquote' | 'hr' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+export interface SelectorOptions {
+    depth?: 1 | 2 | 3 | 4 | 5 | 6;
+}
+export interface TextMatcher {
+    mode: 'exact' | 'contains' | 'regex' | 'predicate';
+    value: string;
+    negated: boolean;
+    flags?: string;
+    predicate?: (text: string) => boolean;
+}
+export interface QuerySegment {
+    selector: SelectorType;
+    textMatch?: TextMatcher;
+    index: number | null;
+    slice: {
+        from?: number;
+        to?: number;
+    } | null;
+}
+export interface MatchedRange {
+    token: Token;
+    start: number;
+    length: number;
+    trailing?: {
+        start: number;
+        length: number;
+    };
+    innerTokens?: MatchedRange[];
+}
+export interface NodeInfo {
+    type: string;
+    depth: number | null;
+    text: string;
+}