structured-context 0.9.0

package/dist/plugins/markdown/parse-embedded.d.ts

@@ -0,0 +1,90 @@
+import type { BaseNode, Relationship, SchemaMetadata } from '../../plugin-api';
+/** Type values that identify a space_on_a_page container (not themselves space nodes). */
+export declare const ON_A_PAGE_TYPES: string[];
+type StackEntry = {
+    depth: number;
+    title: string;
+    /** Empty string marks an untyped heading placeholder (typed-page mode, i.e. not space_on_a_page). */
+    nodeType: string;
+    /** Preferred wikilink key used when this heading acts as a parent. */
+    refTarget: string;
+};
+/** Detect a bare wikilink `[[...]]` and return the inner target, or undefined. */
+export declare function isWikilink(text: string): string | undefined;
+/** Extract [key:: value] bracketed inline fields, return cleaned text and fields. */
+export declare function extractBracketedFields(text: string): {
+    cleanText: string;
+    fields: Record<string, string>;
+};
+/**
+ * Extract unbracketed dataview fields (key:: value on own line).
+ * Keys must be identifier-style (letters, digits, hyphens, underscores - no spaces).
+ * Lines matching the pattern are consumed as fields; other lines kept as content.
+ */
+export declare function extractUnbracketedFields(text: string): {
+    remainingText: string;
+    fields: Record<string, string>;
+};
+/**
+ * Extract a trailing Obsidian block anchor from heading text.
+ * e.g. "My Title ^anchor-id" -> { cleanText: "My Title", anchor: "anchor-id" }
+ */
+export declare function extractAnchor(text: string): {
+    cleanText: string;
+    anchor?: string;
+};
+/**
+ * If the anchor name exactly matches a space node type (optionally followed by digits),
+ * return that type. Otherwise return undefined.
+ * Examples: "mission" -> "mission", "goal1" -> "goal", "myanchor" -> undefined
+ *
+ * Also checks relationship types (for parent-side relationships where child type may not be in hierarchy).
+ */
+export declare function anchorToNodeType(anchor: string, hierarchy: readonly string[], relationships?: Relationship[]): string | undefined;
+/**
+ * Turn a full heading string into an Obsidian section-target key component.
+ * - normalizes observed Obsidian separators (#, ^, :, \) to spaces
+ * - compresses whitespace runs to single spaces
+ * - does _NOT_ (and should not) manipulate anchors or inline fields
+ */
+export declare function normalizeHeadingSectionTarget(rawHeadingText: string): string;
+/**
+ * Returns the default space node type for a new heading based on its parent's effective type.
+ * The first heading in a document defaults to the first type in the hierarchy; each child is the next in sequence.
+ */
+export declare function defaultNodeType(stack: StackEntry[], hierarchy: readonly string[]): string;
+export interface ExtractEmbeddedOptions {
+    /**
+     * Title of the containing page. If provided (and pageType is not a space_on_a_page type),
+     * the page acts as a virtual depth-0 parent for first-level embedded headings.
+     */
+    pageTitle?: string;
+    /**
+     * Node type of the containing page.
+     * - If set to a real node type: only headings with an explicit `[type:: x]` field or a
+     *   type-named anchor become nodes (typed-page mode).
+     * - If an on-a-page type (`space_on_a_page` / `ost_on_a_page`) or undefined: all headings
+     *   become nodes with depth-based type inference ("space on a page" behaviour).
+     */
+    pageType?: string;
+    metadata: SchemaMetadata;
+    /**
+     * Field name remapping (file field name → canonical field name).
+     * Applied to all extracted inline fields, YAML blocks, and paragraph fields.
+     * Example: { "record_type": "type" } renames `record_type` to `type` in extracted data.
+     */
+    fieldMap?: Record<string, string>;
+}
+export interface ExtractEmbeddedResult {
+    nodes: BaseNode[];
+    preambleNodeCount: number;
+    terminatedHeadings: string[];
+}
+/**
+ * Extract space nodes from markdown body text.
+ *
+ * Used by both readSpaceOnAPage (single space_on_a_page file) and readSpaceDirectory
+ * (directory) to find embedded sub-nodes within a page's content.
+ */
+export declare function extractEmbeddedNodes(body: string, options: ExtractEmbeddedOptions): ExtractEmbeddedResult;
+export {};