@getpipher/armory-todo 0.5.3 → 0.5.4

package/README.md

@@ -21,6 +21,17 @@
 
 ---
 
+## Public API
+
+The package `exports` entry (`./src/index.ts`) is the **stable public surface** —
+`addTodo`, `listTodos`, `updateTodo`, `getTodo`, `completeTodo`, `parkTodo`,
+`deleteTodo`, and the `Todo` / `AddInput` / `UpdateInput` / `ListFilter` /
+`Priority` / `Status` / `Store` types (plus `TodoError`). Other `src/*` paths
+are internal and may change without notice. Depend on `@getpipher/armory-todo`
+(the public entry), never deep-import `src/*`.
+
+---
+
 ## The problem
 
 pi sessions are ephemeral conversation branches. A TODO you tell to session A is invisible to session B unless you manually write it to a notes file *and* remember to read it next time. Every existing pi todo extension (`@juicesharp/rpiv-todo`, `@xynogen/pix-todo`, `@gonrocca/zero-pi-todo`, …) is **conversation-branch-scoped** — they persist via pi's `appendEntry()` and survive compaction + `/reload` *within a single session*. None bridge across separate sessions, and none make a fresh session aware of pending work on its own.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getpipher/armory-todo",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "description": "Global, cross-session TODO for pi \u2014 persists across all sessions and is auto-injected into every prompt. The disk-backed counterpart to branch-scoped pi todo extensions.",
   "keywords": [
     "pi-package",
@@ -21,6 +21,12 @@
   "bugs": {
     "url": "https://github.com/getpipher/armory-todo/issues"
   },
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.ts"
+    }
+  },
   "files": [
     "extensions",
     "src",
@@ -35,7 +41,7 @@
     ]
   },
   "scripts": {
-    "test": "for t in todo-store todo-title-notes todo-archive todo-config todo-migrate todo-health todo-hard-prune todo-auto-prune registry projects panel-data todo-caps todo-backup; do node test/$t.test.mts || exit 1; done"
+    "test": "for t in todo-store todo-title-notes todo-archive todo-config todo-migrate todo-health todo-hard-prune todo-auto-prune registry projects panel-data todo-caps todo-backup public-api; do node test/$t.test.mts || exit 1; done"
   },
   "peerDependencies": {
     "@earendil-works/pi-ai": "*",
@@ -53,4 +59,4 @@
       "optional": true
     }
   }
-}
+}

package/src/index.d.ts

@@ -0,0 +1,78 @@
+// src/index.d.ts
+/**
+ * Typed declarations for the public stable API of @getpipher/armory-todo.
+ *
+ * Consumed via the package `exports` `types` condition (see package.json) so
+ * that TypeScript consumers type-check against this declaration instead of
+ * pulling the raw `.ts` implementation source. Runtime (tsx/jiti/node) uses the
+ * `default` condition (`./src/index.ts`).
+ *
+ * Hand-written (no build step — getpipher convention). Keep in sync with
+ * src/index.ts re-exports.
+ */
+export type Priority = "low" | "med" | "high" | "critical";
+export type Status = "open" | "in_progress" | "parked" | "done" | "cancelled";
+
+export interface Todo {
+  id: string;
+  title: string;
+  notes: string;
+  project: string;
+  tags: string[];
+  priority: Priority;
+  status: Status;
+  source: string;
+  createdAt: string;
+  updatedAt: string;
+  closedAt: string | null;
+}
+
+export interface AddInput {
+  title: string;
+  notes?: string;
+  project?: string;
+  tags?: string[];
+  priority?: Priority;
+  source?: string;
+}
+
+export interface UpdateInput {
+  title?: string;
+  notes?: string;
+  project?: string;
+  tags?: string[];
+  priority?: Priority;
+  status?: Status;
+}
+
+export interface ListFilter {
+  status?: Status | "all";
+  project?: string;
+  tag?: string;
+  text?: string;
+  since?: string;
+  before?: string;
+  limit?: number;
+  page?: number;
+}
+
+export interface Store {
+  version: 3;
+  updatedAt: string;
+  todos: Todo[];
+}
+
+export class TodoError extends Error {}
+
+export function addTodo(input: AddInput): Todo;
+export function listTodos(filter?: ListFilter): Todo[];
+export function updateTodo(id: string, patch: UpdateInput): Todo;
+export function getTodo(id: string): Todo;
+export function completeTodo(id: string): Todo;
+export function parkTodo(id: string): Todo;
+export function deleteTodo(id: string): Todo;
+export function clearTodos(status?: Status): number;
+export function renderOpenBlock(max?: number): string;
+export function getStorePath(): string;
+export function loadStore(): Store;
+export function saveStore(store: Store): void;

package/src/index.ts

@@ -0,0 +1,39 @@
+// src/index.ts
+/**
+ * Public stable API of @getpipher/armory-todo.
+ *
+ * This `exports` entry (see package.json) is the stable surface — the functions
+ * and types re-exported here. Other `src/*` paths are internal and may change
+ * without notice. Depend on `@getpipher/armory-todo` (this public entry), never
+ * deep-import `src/*`.
+ *
+ * Consumers (e.g. @getpipher/armory-fleet) import from here so that evolution
+ * of armory-todo is decoupled: a breaking change can only touch a consumer's
+ * adapter, never its core, and the version pin + CI typecheck catch drift.
+ */
+export {
+  addTodo,
+  listTodos,
+  updateTodo,
+  getTodo,
+  completeTodo,
+  parkTodo,
+  deleteTodo,
+  clearTodos,
+  renderOpenBlock,
+  getStorePath,
+  loadStore,
+  saveStore,
+} from "./todo-store.ts";
+
+export type {
+  Todo,
+  AddInput,
+  UpdateInput,
+  ListFilter,
+  Priority,
+  Status,
+  Store,
+} from "./todo-store.ts";
+
+export { TodoError } from "./todo-store.ts";