@cad0p/napkin 0.8.1

package/dist/sdk.d.ts

@@ -0,0 +1,179 @@
+import { type AliasEntry } from "./core/aliases.js";
+import { type BaseQueryResult, type BaseView } from "./core/bases.js";
+import { type Bookmark } from "./core/bookmarks.js";
+import { type Canvas } from "./core/canvas.js";
+import { type CreateOptions, type CreateResult, type DeleteResult, type MoveResult, type ReadResult } from "./core/crud.js";
+import { type FileInfo, type FolderInfo } from "./core/files.js";
+import { type AddTemplateResult, type ScaffoldResult, type TemplateInfo } from "./core/init.js";
+import { type VaultOverview } from "./core/overview.js";
+import { type SearchOptions, type SearchResult } from "./core/search.js";
+import { type TagInfo } from "./core/tags.js";
+import { type TaskShowResult, type TaskWithFile } from "./core/tasks.js";
+import { type VaultMetadata } from "./core/vault.js";
+import { type WordCount } from "./core/wordcount.js";
+import type { VaultTemplate } from "./templates/types.js";
+import type { Heading } from "./utils/markdown.js";
+import { type VaultInfo } from "./utils/vault.js";
+export declare class Napkin {
+    readonly vault: VaultInfo;
+    constructor(path: string);
+    info(): VaultMetadata;
+    overview(opts?: {
+        depth?: number;
+        keywords?: number;
+    }): VaultOverview;
+    search(query: string, opts?: SearchOptions): SearchResult[];
+    read(file: string): ReadResult;
+    create(opts: CreateOptions): CreateResult;
+    append(file: string, content: string, inline?: boolean): string;
+    prepend(file: string, content: string, inline?: boolean): string;
+    move(file: string, destination: string): MoveResult;
+    rename(file: string, newName: string): MoveResult;
+    delete(file: string, permanent?: boolean): DeleteResult;
+    fileInfo(file: string): FileInfo;
+    fileList(opts?: {
+        folder?: string;
+        ext?: string;
+    }): string[];
+    folders(parentFolder?: string): string[];
+    folderInfo(folderPath: string): FolderInfo;
+    outline(file: string): Heading[];
+    wordcount(file: string): WordCount;
+    dailyPath(date?: Date): string;
+    dailyEnsure(): {
+        path: string;
+        created: boolean;
+    };
+    dailyRead(): {
+        path: string;
+        content: string;
+    };
+    dailyAppend(content: string, inline?: boolean): string;
+    dailyPrepend(content: string, inline?: boolean): string;
+    tags(fileFilter?: string): {
+        tagCounts: Map<string, number>;
+        tagFiles: Map<string, string[]>;
+    };
+    tagInfo(tagName: string): TagInfo;
+    aliases(fileFilter?: string): AliasEntry[];
+    properties(fileFilter?: string): Map<string, number>;
+    propertyGet(file: string, name: string): {
+        property: string;
+        value: unknown;
+    };
+    propertySet(file: string, name: string, value: string): {
+        path: string;
+        property: string;
+        value: unknown;
+    };
+    propertyRemove(file: string, name: string): {
+        path: string;
+        removed: string;
+    };
+    tasks(opts?: {
+        file?: string;
+        daily?: boolean;
+        done?: boolean;
+        todo?: boolean;
+        status?: string;
+    }): TaskWithFile[];
+    taskShow(file: string, line: number): {
+        currentStatus: string;
+        text: string;
+    };
+    taskUpdate(file: string, line: number, newStatus: string): TaskShowResult;
+    linksOut(file: string): string[];
+    linksBack(file: string): string[];
+    linksUnresolved(): [string, string[]][];
+    orphans(): string[];
+    deadends(): string[];
+    templates(): string[];
+    templateRead(name: string, opts?: {
+        resolve?: boolean;
+        title?: string;
+    }): {
+        template: string;
+        content: string;
+    };
+    templateInsert(templateName: string, file: string): {
+        file: string;
+        template: string;
+        inserted: boolean;
+    };
+    bookmarks(): Bookmark[];
+    bookmarkAdd(entry: Bookmark): {
+        added: Bookmark;
+    };
+    config(): Record<string, unknown>;
+    configGet(key: string): unknown;
+    configSet(key: string, value: string): {
+        config: Record<string, unknown>;
+        parsed: unknown;
+    };
+    bases(): string[];
+    baseViews(opts: {
+        file?: string;
+        path?: string;
+    }): BaseView[];
+    baseQuery(opts: {
+        file?: string;
+        path?: string;
+    }, viewName?: string): Promise<BaseQueryResult>;
+    baseCreate(opts: {
+        name: string;
+        path?: string;
+        content?: string;
+    }): {
+        path: string;
+        created: boolean;
+    };
+    canvases(): string[];
+    canvasRead(file: string): {
+        canvas: Canvas;
+        filePath: string;
+    };
+    canvasCreate(fileName: string, folder?: string): {
+        path: string;
+        created: boolean;
+    };
+    canvasAddNode(file: string, opts: {
+        type?: string;
+        text?: string;
+        noteFile?: string;
+        subpath?: string;
+        url?: string;
+        label?: string;
+        x?: string;
+        y?: string;
+        width?: string;
+        height?: string;
+        color?: string;
+    }): {
+        id: string;
+        type: string;
+        added: boolean;
+    };
+    canvasAddEdge(file: string, opts: {
+        from: string;
+        to: string;
+        fromSide?: string;
+        toSide?: string;
+        label?: string;
+        color?: string;
+    }): {
+        id: string;
+        from: string;
+        to: string;
+        added: boolean;
+    };
+    canvasRemoveNode(file: string, nodeId: string): {
+        id: string;
+        removed: boolean;
+    };
+    static scaffold(path: string, opts?: {
+        template?: string;
+    }): ScaffoldResult;
+    static vaultTemplates(): TemplateInfo[];
+    static registerTemplate(template: VaultTemplate): void;
+    static addTemplate(path: string, template: string): AddTemplateResult;
+}

package/dist/sdk.js

@@ -0,0 +1,232 @@
+import { collectAliases } from "./core/aliases.js";
+import { createBaseItem, getBaseViews, listBases, queryBaseFile, resolveBaseFile, } from "./core/bases.js";
+import { addBookmark, flattenBookmarks, readBookmarks, } from "./core/bookmarks.js";
+import { addCanvasEdge, addCanvasNode, createCanvas, listCanvases, removeCanvasNode, resolveCanvas, } from "./core/canvas.js";
+import { getConfigValue, loadConfig, setConfigValue } from "./core/config.js";
+import { appendFile, createFile, deleteFile, moveFile, prependFile, readFile, renameFile, } from "./core/crud.js";
+import { appendDaily, ensureDaily, getDailyPath, prependDaily, readDaily, } from "./core/daily.js";
+import { getFileInfoResolved, getFileList, getFolderInfo, getFolderList, } from "./core/files.js";
+import { addTemplate, getInitTemplates, scaffoldVault, } from "./core/init.js";
+import { getBacklinks, getDeadends, getOrphans, getOutgoingLinks, getUnresolvedLinks, } from "./core/links.js";
+import { getOutline } from "./core/outline.js";
+import { getOverview } from "./core/overview.js";
+import { collectProperties, readProperty, removeProperty, setProperty, } from "./core/properties.js";
+import { searchVault, } from "./core/search.js";
+import { collectTags, getTagInfo } from "./core/tags.js";
+import { collectTasks, filterTasks, showTask, updateTask, } from "./core/tasks.js";
+import { insertTemplate, listTemplates, readTemplate, } from "./core/templates.js";
+import { getVaultMetadata } from "./core/vault.js";
+import { getWordCount } from "./core/wordcount.js";
+import { registerTemplate } from "./templates/index.js";
+import { findVault } from "./utils/vault.js";
+export class Napkin {
+    vault;
+    constructor(path) {
+        this.vault = findVault(path);
+    }
+    // ── Vault ───────────────────────────────────────────────────────
+    info() {
+        return getVaultMetadata(this.vault);
+    }
+    overview(opts) {
+        return getOverview(this.vault.contentPath, this.vault.configPath, opts);
+    }
+    // ── Search ──────────────────────────────────────────────────────
+    search(query, opts) {
+        return searchVault(this.vault.contentPath, this.vault.configPath, query, opts);
+    }
+    // ── CRUD ────────────────────────────────────────────────────────
+    read(file) {
+        return readFile(this.vault.contentPath, file);
+    }
+    create(opts) {
+        return createFile(this.vault, opts);
+    }
+    append(file, content, inline) {
+        return appendFile(this.vault.contentPath, file, content, inline);
+    }
+    prepend(file, content, inline) {
+        return prependFile(this.vault.contentPath, file, content, inline);
+    }
+    move(file, destination) {
+        return moveFile(this.vault.contentPath, file, destination);
+    }
+    rename(file, newName) {
+        return renameFile(this.vault.contentPath, file, newName);
+    }
+    delete(file, permanent) {
+        return deleteFile(this.vault.contentPath, file, permanent);
+    }
+    // ── Files ───────────────────────────────────────────────────────
+    fileInfo(file) {
+        return getFileInfoResolved(this.vault.contentPath, file);
+    }
+    fileList(opts) {
+        return getFileList(this.vault.contentPath, opts);
+    }
+    folders(parentFolder) {
+        return getFolderList(this.vault.contentPath, parentFolder);
+    }
+    folderInfo(folderPath) {
+        return getFolderInfo(this.vault.contentPath, folderPath);
+    }
+    outline(file) {
+        return getOutline(this.vault.contentPath, file);
+    }
+    wordcount(file) {
+        return getWordCount(this.vault.contentPath, file);
+    }
+    // ── Daily ───────────────────────────────────────────────────────
+    dailyPath(date) {
+        return getDailyPath(this.vault.configPath, date);
+    }
+    dailyEnsure() {
+        return ensureDaily(this.vault);
+    }
+    dailyRead() {
+        return readDaily(this.vault);
+    }
+    dailyAppend(content, inline) {
+        return appendDaily(this.vault, content, inline);
+    }
+    dailyPrepend(content, inline) {
+        return prependDaily(this.vault, content, inline);
+    }
+    // ── Tags ────────────────────────────────────────────────────────
+    tags(fileFilter) {
+        return collectTags(this.vault.contentPath, fileFilter);
+    }
+    tagInfo(tagName) {
+        return getTagInfo(this.vault.contentPath, tagName);
+    }
+    // ── Aliases ─────────────────────────────────────────────────────
+    aliases(fileFilter) {
+        return collectAliases(this.vault.contentPath, fileFilter);
+    }
+    // ── Properties ──────────────────────────────────────────────────
+    properties(fileFilter) {
+        return collectProperties(this.vault.contentPath, fileFilter);
+    }
+    propertyGet(file, name) {
+        return readProperty(this.vault.contentPath, file, name);
+    }
+    propertySet(file, name, value) {
+        return setProperty(this.vault.contentPath, file, name, value);
+    }
+    propertyRemove(file, name) {
+        return removeProperty(this.vault.contentPath, file, name);
+    }
+    // ── Tasks ───────────────────────────────────────────────────────
+    tasks(opts) {
+        const all = collectTasks(this.vault, {
+            file: opts?.file,
+            daily: opts?.daily,
+        });
+        return filterTasks(all, {
+            done: opts?.done,
+            todo: opts?.todo,
+            status: opts?.status,
+        });
+    }
+    taskShow(file, line) {
+        return showTask(this.vault.contentPath, file, line);
+    }
+    taskUpdate(file, line, newStatus) {
+        return updateTask(this.vault.contentPath, file, line, newStatus);
+    }
+    // ── Links ───────────────────────────────────────────────────────
+    linksOut(file) {
+        return getOutgoingLinks(this.vault.contentPath, file);
+    }
+    linksBack(file) {
+        return getBacklinks(this.vault.contentPath, file);
+    }
+    linksUnresolved() {
+        return getUnresolvedLinks(this.vault.contentPath);
+    }
+    orphans() {
+        return getOrphans(this.vault.contentPath);
+    }
+    deadends() {
+        return getDeadends(this.vault.contentPath);
+    }
+    // ── Templates ───────────────────────────────────────────────────
+    templates() {
+        return listTemplates(this.vault);
+    }
+    templateRead(name, opts) {
+        return readTemplate(this.vault, name, opts);
+    }
+    templateInsert(templateName, file) {
+        return insertTemplate(this.vault, templateName, file);
+    }
+    // ── Bookmarks ───────────────────────────────────────────────────
+    bookmarks() {
+        const items = readBookmarks(this.vault.obsidianPath);
+        return flattenBookmarks(items);
+    }
+    bookmarkAdd(entry) {
+        return addBookmark(this.vault.obsidianPath, entry);
+    }
+    // ── Config ──────────────────────────────────────────────────────
+    config() {
+        return loadConfig(this.vault.configPath);
+    }
+    configGet(key) {
+        return getConfigValue(this.vault.configPath, key);
+    }
+    configSet(key, value) {
+        return setConfigValue(this.vault.configPath, key, value);
+    }
+    // ── Bases ───────────────────────────────────────────────────────
+    bases() {
+        return listBases(this.vault.contentPath);
+    }
+    baseViews(opts) {
+        const baseFile = resolveBaseFile(this.vault.contentPath, opts);
+        if (!baseFile)
+            throw new Error("Base file not found");
+        return getBaseViews(this.vault.contentPath, baseFile);
+    }
+    async baseQuery(opts, viewName) {
+        const baseFile = resolveBaseFile(this.vault.contentPath, opts);
+        if (!baseFile)
+            throw new Error("Base file not found");
+        return queryBaseFile(this.vault.contentPath, baseFile, viewName);
+    }
+    baseCreate(opts) {
+        return createBaseItem(this.vault.contentPath, opts);
+    }
+    // ── Canvas ──────────────────────────────────────────────────────
+    canvases() {
+        return listCanvases(this.vault.contentPath);
+    }
+    canvasRead(file) {
+        return resolveCanvas(this.vault.contentPath, file);
+    }
+    canvasCreate(fileName, folder) {
+        return createCanvas(this.vault.contentPath, fileName, folder);
+    }
+    canvasAddNode(file, opts) {
+        return addCanvasNode(this.vault.contentPath, file, opts);
+    }
+    canvasAddEdge(file, opts) {
+        return addCanvasEdge(this.vault.contentPath, file, opts);
+    }
+    canvasRemoveNode(file, nodeId) {
+        return removeCanvasNode(this.vault.contentPath, file, nodeId);
+    }
+    // ── Init (static) ──────────────────────────────────────────────
+    static scaffold(path, opts) {
+        return scaffoldVault(path, opts?.template);
+    }
+    static vaultTemplates() {
+        return getInitTemplates();
+    }
+    static registerTemplate(template) {
+        registerTemplate(template);
+    }
+    static addTemplate(path, template) {
+        return addTemplate(path, template);
+    }
+}

package/dist/templates/coding.d.ts

@@ -0,0 +1,2 @@
+import type { VaultTemplate } from "./types.js";
+export declare const coding: VaultTemplate;

package/dist/templates/coding.js

@@ -0,0 +1,104 @@
+export const coding = {
+    name: "coding",
+    description: "Software project knowledge base",
+    dirs: ["decisions", "architecture", "guides", "changelog", "daily"],
+    files: {
+        "decisions/_about.md": `# Decisions
+
+Architecture Decision Records (ADRs). One file per decision.
+`,
+        "architecture/_about.md": `# Architecture
+
+System design docs, diagrams, and technical specs.
+`,
+        "guides/_about.md": `# Guides
+
+How-tos, setup instructions, onboarding docs, and troubleshooting.
+`,
+        "changelog/_about.md": `# Changelog
+
+Release notes and version history.
+`,
+        "Templates/Decision.md": `---
+status: proposed
+date: "{{date}}"
+---
+# {{title}}
+
+## Context
+What prompted this decision?
+
+## Decision
+What did we decide?
+
+## Consequences
+What are the trade-offs?
+`,
+        "Templates/Architecture.md": `---
+date: "{{date}}"
+---
+# {{title}}
+
+## Overview
+What is this component/system?
+
+## Design
+How does it work?
+
+## Dependencies
+What does it depend on? What depends on it?
+
+## Open questions
+- 
+`,
+        "Templates/Guide.md": `---
+date: "{{date}}"
+---
+# {{title}}
+
+## Prerequisites
+- 
+
+## Steps
+1. 
+
+## Troubleshooting
+- 
+`,
+        "Templates/Changelog.md": `---
+version: ""
+date: "{{date}}"
+---
+# {{title}}
+
+## Added
+- 
+
+## Changed
+- 
+
+## Fixed
+- 
+`,
+    },
+    napkinMd: `# Project name
+
+## What is this?
+Brief description of the project.
+
+## Tech stack
+- Language:
+- Framework:
+- Database:
+- Infrastructure:
+
+## Key conventions
+- 
+
+## Key decisions
+- 
+
+## Active work
+- 
+`,
+};

package/dist/templates/company.d.ts

@@ -0,0 +1,2 @@
+import type { VaultTemplate } from "./types.js";
+export declare const company: VaultTemplate;

package/dist/templates/company.js

@@ -0,0 +1,121 @@
+export const company = {
+    name: "company",
+    description: "Team and organization knowledge base",
+    dirs: [
+        "people",
+        "projects",
+        "runbooks",
+        "infrastructure",
+        "onboarding",
+        "daily",
+    ],
+    files: {
+        "people/_about.md": `# People
+
+Team members, roles, and ownership. One note per person.
+`,
+        "projects/_about.md": `# Projects
+
+Active projects and initiatives. Archive completed ones.
+`,
+        "runbooks/_about.md": `# Runbooks
+
+Operational procedures. Step-by-step guides for recurring tasks.
+`,
+        "infrastructure/_about.md": `# Infrastructure
+
+Tools, services, repositories, and how they connect.
+`,
+        "onboarding/_about.md": `# Onboarding
+
+Getting new team members and agents up to speed.
+`,
+        "Templates/Person.md": `---
+role: ""
+team: ""
+owner: ""
+---
+# {{title}}
+
+## Role
+What does this person do?
+
+## Responsibilities
+- 
+
+## Contact
+- 
+`,
+        "Templates/Runbook.md": `---
+owner: ""
+last_verified: "{{date}}"
+---
+# {{title}}
+
+## Goal
+What does this runbook accomplish?
+
+## Steps
+1. 
+
+## Verification
+- [ ] How to confirm it worked
+
+## Troubleshooting
+- 
+`,
+        "Templates/Project.md": `---
+status: active
+owner: ""
+started: "{{date}}"
+---
+# {{title}}
+
+## Objective
+What are we trying to achieve?
+
+## Key results
+- [ ] 
+
+## Team
+- 
+
+## Notes
+- 
+`,
+        "Templates/Onboarding.md": `---
+role: ""
+date: "{{date}}"
+---
+# Onboarding — {{title}}
+
+## Checklist
+- [ ] Access granted
+- [ ] Tools set up
+- [ ] Key docs reviewed
+- [ ] First task assigned
+
+## Notes
+- 
+`,
+    },
+    napkinMd: `# Company name
+
+## What do we do?
+Brief description.
+
+## Team
+- 
+
+## Communication
+- Primary channel:
+- Task tracking:
+- Documentation:
+
+## Key tools & services
+- 
+
+## Active projects
+- 
+`,
+};

package/dist/templates/index.d.ts

@@ -0,0 +1,4 @@
+import type { VaultTemplate } from "./types.js";
+export type { VaultTemplate };
+export declare const TEMPLATES: Record<string, VaultTemplate>;
+export declare function registerTemplate(template: VaultTemplate): void;

package/dist/templates/index.js

@@ -0,0 +1,15 @@
+import { coding } from "./coding.js";
+import { company } from "./company.js";
+import { personal } from "./personal.js";
+import { product } from "./product.js";
+import { research } from "./research.js";
+export const TEMPLATES = {
+    coding,
+    personal,
+    research,
+    company,
+    product,
+};
+export function registerTemplate(template) {
+    TEMPLATES[template.name] = template;
+}

package/dist/templates/personal.d.ts

@@ -0,0 +1,2 @@
+import type { VaultTemplate } from "./types.js";
+export declare const personal: VaultTemplate;