Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
import type { Position } from 'unist';
export interface AuthoredJsxBody {
leading: string;
afterOpenTag: string;
}
export interface EscapeProvenanceEntry {
offset: number;
char: string;
}
export interface EntityReferenceSpan {
offset: number;
length: number;
raw: string;
}
export interface EscapeProvenanceTextData {
escapedChars: EscapeProvenanceEntry[];
}
export type EscapeProvenanceValidation =
| { kind: 'absent' }
| { kind: 'malformed' }
| { kind: 'valid'; data: EscapeProvenanceTextData };
export function validateEscapeProvenance(data: unknown): EscapeProvenanceValidation {
if (typeof data !== 'object' || data === null || !Object.hasOwn(data, 'escapedChars')) {
return { kind: 'absent' };
}
const escapedChars = (data as { escapedChars?: unknown }).escapedChars;
if (!Array.isArray(escapedChars)) return { kind: 'malformed' };
const valid = escapedChars.every((entry) => {
if (typeof entry !== 'object' || entry === null) return false;
const offset = (entry as { offset?: unknown }).offset;
return (
typeof offset === 'number' &&
Number.isInteger(offset) &&
offset >= 0 &&
typeof (entry as { char?: unknown }).char === 'string'
);
});
return valid ? { kind: 'valid', data: { escapedChars } } : { kind: 'malformed' };
}
export function hasEscapeProvenance<T>(data: T): data is T & EscapeProvenanceTextData {
return validateEscapeProvenance(data).kind === 'valid';
}
export const PROMOTED_MDAST_TYPES = [
'wikiLink',
'wikiLinkEmbed',
'mdxJsxFlowElement',
'mdxJsxTextElement',
'rawMdxFallback',
'mark',
'underline',
'tag',
'comment',
'commentBlock',
'footnoteReference',
'footnoteDefinition',
] as const;
export type PromotedMdastType = (typeof PROMOTED_MDAST_TYPES)[number];
export interface WikiLinkMdast {
type: 'wikiLink';
value: string;
data: {
target: string;
alias: string | null;
anchor: string | null;
sourceTarget?: string | null;
sourceAnchor?: string | null;
sourceAlias?: string | null;
[key: string]: unknown;
};
children: Array<{ type: 'text'; value: string }>;
position?: Position;
}
export interface WikiLinkEmbedMdast {
type: 'wikiLinkEmbed';
value: string;
data: {
target: string;
alias: string | null;
anchor: string | null;
sourceTarget?: string | null;
sourceAnchor?: string | null;
sourceAlias?: string | null;
[key: string]: unknown;
};
children: Array<{ type: 'text'; value: string }>;
position?: Position;
}
export interface RawMdxFallbackMdast {
type: 'rawMdxFallback';
value: string;
data: {
reason: string;
originalSpan: { start: number; end: number };
[key: string]: unknown;
};
position?: Position;
}
export interface CommentMdast {
type: 'comment';
// biome-ignore lint/suspicious/noExplicitAny: see RootContentMap note above
children: Array<any>;
data?: {
sourceForm?: 'percent' | 'html';
[key: string]: unknown;
};
position?: Position;
}
export interface CommentBlockMdast {
type: 'commentBlock';
// biome-ignore lint/suspicious/noExplicitAny: see RootContentMap note above
children: Array<any>;
data?: {
sourceForm?: 'percent' | 'html';
sourceLayout?: 'inline' | 'block';
[key: string]: unknown;
};
position?: Position;
}
export interface MarkMdast {
type: 'mark';
// biome-ignore lint/suspicious/noExplicitAny: see RootContentMap note above
children: Array<any>;
data?: { sourceRaw?: string; [key: string]: unknown };
position?: Position;
}
export interface UnderlineMdast {
type: 'underline';
// biome-ignore lint/suspicious/noExplicitAny: see RootContentMap note above
children: Array<any>;
data?: {
sourceForm?: 'u' | 'ins';
sourceRaw?: string;
[key: string]: unknown;
};
position?: Position;
}
export interface TagMdast {
type: 'tag';
value: string;
data?: { sourceRaw?: string; [key: string]: unknown };
position?: Position;
}
export interface SourceDocBoundary {
bom?: true;
leading?: string;
trailing?: string;
}
declare module 'mdast' {
interface RootData {
sourceDocBoundary?: SourceDocBoundary;
}
interface TextData {
escapedChars?: EscapeProvenanceEntry[];
sourceRaw?: string;
entityRefSpans?: EntityReferenceSpan[];
}
interface EmphasisData {
sourceDelimiter?: '*' | '_';
}
interface StrongData {
sourceDelimiter?: '**' | '__';
}
interface LinkData {
sourceStyle?: string;
sourceRaw?: string;
sourceUrlForm?: 'angle-bracketed';
sourceGuardedDestinationOpen?: true;
sourceTitleMarker?: 'single' | 'double' | 'paren';
}
interface LinkReferenceData {
sourceRaw?: string;
resolvedUrl?: string;
resolvedTitle?: string | null;
}
interface ThematicBreakData {
sourceRaw?: string;
}
interface BreakData {
sourceStyle?: string;
sourceRaw?: string;
}
interface HeadingData {
sourceStyle?: string;
sourceTrailingHashes?: number;
sourceLeadingIndent?: number;
sourceInteriorSpacing?: number;
sourceUnderlineLength?: number;
sourceContiguousNext?: boolean;
}
interface CodeData {
sourceFenceChar?: string;
sourceFenceLength?: number;
sourceClosingFenceLength?: number;
sourceUnclosedFence?: true;
sourceFenceIndent?: number;
sourceInfoPadding?: number;
sourceStyle?: 'indented' | 'fenced';
sourceIndents?: string[];
}
interface InlineCodeData {
sourceFenceChar?: string;
sourceFenceLength?: number;
sourcePadded?: boolean;
}
interface ListData {
bulletMarker?: string;
listMarkerDelimiter?: string;
}
interface ListItemData {
sourceMarkerSpacing?: number;
sourceOrdinal?: number;
sourceCheckboxChar?: 'X';
sourceContinuationIndent?: number;
}
interface DeleteData {
sourceDelimiter?: '~' | '~~';
}
interface BlockquoteData {
sourceMarkerSpacings?: Array<number | 'single' | 'none' | 'lazy'>;
}
interface TableData {
sourceDashCounts?: number[];
sourceOuterPipes?: { leading: boolean; trailing: boolean };
sourceAlignmentPadding?: Array<{ left: number; right: number }>;
}
interface TableCellData {
sourcePadding?: { left: number; right: number };
}
interface DefinitionData {
sourceLayout?: 'multiline' | 'inline';
sourceTitleMarker?: 'single' | 'double' | 'paren';
sourceUrlForm?: 'angle-bracketed';
sourceGuardedDestinationOpen?: true;
}
interface ImageData {
sourceUrlForm?: 'angle-bracketed';
sourceGuardedDestinationOpen?: true;
}
interface RootContentMap {
wikiLink: WikiLinkMdast;
rawMdxFallback: RawMdxFallbackMdast;
wikiLinkEmbed: WikiLinkEmbedMdast;
mark: MarkMdast;
underline: UnderlineMdast;
tag: TagMdast;
comment: CommentMdast;
commentBlock: CommentBlockMdast;
}
}
declare module 'mdast-util-mdx-jsx' {
interface MdxJsxFlowElementData {
sourceRaw?: string;
htmlBoundary?: { opener: string; closer: string };
sourceBody?: AuthoredJsxBody;
}
interface MdxJsxTextElementData {
sourceRaw?: string;
}
}
declare module 'mdast-util-mdx-expression' {
interface MdxFlowExpressionData {
sourceRaw?: string;
}
interface MdxTextExpressionData {
sourceRaw?: string;
}
}
declare module 'mdast-util-math' {
interface InlineMathData {
sourceDelimiter?: string;
}
}