hafez 1.2.0 → 1.4.0

package/dist/document.d.ts

@@ -0,0 +1,117 @@
+import type { SessionLogEntry, SessionLogType } from './types.js';
+export declare function parseSessionLogHeading(line: string): {
+    date: string;
+    agent: string;
+    type: SessionLogType;
+} | null;
+export declare function formatSessionLogEntry(entry: SessionLogEntry): string;
+/**
+ * Split a Session Log section's content into raw entry blocks, each beginning
+ * with a parseable entry heading. Non-entry text before the first heading is
+ * not an entry and is dropped. Document owns entry block splitting — merge's
+ * dedup/sort policy stays in merge.ts.
+ */
+export declare function splitLogEntries(content: string): string[];
+export declare function firstNonEmptyLine(s: string | null | undefined): string;
+/** The one wiki-link syntax the vault recognizes: [[slug]] or
+ * [[slug|display text]] — slug in group 1, display text in group 2.
+ * Padding inside the brackets is Obsidian-idiomatic ([[ slug ]], [[slug | Label]])
+ * and is absorbed by the pattern, so both captures come out already trimmed —
+ * every consumer (Related coverage, mention harvesting, export) sees the bare slug.
+ * Non-global — wrap with `new RegExp(WIKI_LINK_RE.source, 'g')` for iteration. */
+export declare const WIKI_LINK_RE: RegExp;
+/** What documentFor needs to know about a file to bind its section set.
+ *
+ * KIND is the whole context — deliberately no type/subtype narrowing. A file
+ * can legitimately carry sections outside its current type's contract (a
+ * promote race merged in a capture's Notes, a plan-shaped note never had its
+ * subtype persisted, a hand edit added Open Questions to a plain entity), and
+ * a narrower binding demotes those headings to non-structural text that the
+ * next section rewrite silently deletes. The kind-level union makes every
+ * same-kind heading a boundary, so no same-kind section is ever swallowed;
+ * the cost is that a same-kind heading quoted at line start inside a section
+ * strands as its own section on rewrite — visible and recoverable, unlike
+ * deletion. Cross-KIND headings (a session-only ## Decisions quoted in an
+ * entity Brief) are still not boundaries. */
+export interface DocContext {
+    kind: 'entity' | 'knowledge' | 'session';
+}
+/** The structural set a context binds — exposed for introspection and the
+ * contract-coverage tests; runtime consumers go through documentFor. */
+export declare function structuralSectionsFor(ctx: DocContext): ReadonlySet<string>;
+/** The Document operations bound to one file's structural section set. */
+export declare function documentFor(ctx: DocContext): Doc;
+/** Bind from a parsed vault file — kind from Layout. */
+export declare function documentForFile(parsed: {
+    kind: 'entity' | 'knowledge' | 'session';
+}): Doc;
+export interface DocSection {
+    heading: string;
+    content: string;
+}
+export interface Doc {
+    findNextStructuralHeading(body: string, from: number): number;
+    findSection(body: string, heading: string): {
+        start: number;
+        headingEnd: number;
+        end: number;
+        content: string;
+    } | null;
+    splitStructural(body: string): {
+        preamble: string;
+        sections: DocSection[];
+    };
+    setSection(body: string, heading: string, content: string, insertBefore?: string): string;
+    appendToSection(body: string, heading: string, content: string): string;
+    renameSection(body: string, from: string, to: string): string;
+    ensureSection(body: string, heading: string, opts?: {
+        after?: string;
+    }): string;
+    prependSessionLogEntry(body: string, entry: string): string;
+    bodyBeforeSessionLog(body: string): string;
+    countSessionLogEntries(body: string): number;
+    parseSessionLog(body: string): Array<{
+        date: string;
+        agent: string;
+        type: SessionLogType;
+        summary: string;
+    }>;
+    extractOldestSessionLogEntry(body: string): {
+        entry: string;
+        remaining: string;
+    } | null;
+    getBrief(body: string): string | null;
+    setBrief(body: string, content: string): string;
+    removeBrief(body: string): string;
+    getNextActions(body: string): string[];
+    addNextAction(body: string, action: string): string;
+    completeNextAction(body: string, query: string): {
+        matched: string;
+        body: string;
+    };
+    removeNextAction(body: string, query: string): {
+        matched: string;
+        body: string;
+    };
+    clearNextActions(body: string): string;
+    syncRelatedSection(body: string, frontmatter: {
+        parent?: string;
+        related?: string[];
+    }): string;
+}
+export declare function getBrief(body: string): string | null;
+export declare function getNextActions(body: string): string[];
+export declare function parseSessionLog(body: string): Array<{
+    date: string;
+    agent: string;
+    type: SessionLogType;
+    summary: string;
+}>;
+export declare function countSessionLogEntries(body: string): number;
+/**
+ * One-line summary for a doc: frontmatter description first, then the first
+ * non-empty line of the kind's primary section (entity: Brief; knowledge:
+ * Synthesis, falling back to Goal for plans; session: Summary).
+ * Shared by the vault index and the OKF export so the two surfaces agree.
+ */
+export declare function deriveSummary(kind: 'entity' | 'knowledge' | 'session', fm: Record<string, any>, body: string): string;