orbitmap 0.3.0 → 0.4.1

package/dist/adapters/local/shapes.d.ts

@@ -0,0 +1,209 @@
+/**
+ * Envelope builders for local mode (spec §2.2).
+ *
+ * Everything the LocalAdapter returns is produced here, byte-shape-compatible with the
+ * Agent API envelopes the golden fixtures in `tests/contract/fixtures/` describe:
+ * same field names, same nesting, same enums. Fields the local store cannot know
+ * (server-only concepts) are filled with the stable placeholders of §2.2 — never omitted.
+ *
+ * Pure functions only: no file I/O, no validation (that is `rules.ts`).
+ */
+import type { AreaFile, DocumentRecord, IntentRecord, MissionRecord, TaskRecord, WorkspaceFile } from './types.js';
+/**
+ * The API splits an entity number into `task_number` (the bare code) and
+ * `display_number` (`TS-<code>`); locally we store the prefixed form.
+ */
+export declare function stripEntityPrefix(entityNumber: string): string;
+/** The implicit local agent, in the `/context` agent shape. */
+export declare function agentShape(): {
+    id: string;
+    name: string;
+    slug: string;
+    introduction: string;
+};
+/** Workspace as embedded in `areas` list items. */
+export declare function workspaceShape(workspace: WorkspaceFile): {
+    id: string;
+    name: string;
+    slug: string;
+};
+/** Workspace as embedded in the task-detail `area` block (adds `docs_tenant_id`). */
+export declare function workspaceShapeWithTenant(workspace: WorkspaceFile): {
+    id: string;
+    name: string;
+    slug: string;
+    docs_tenant_id: null;
+};
+/** Area block of `/context`. */
+export declare function contextAreaShape(area: AreaFile): {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    git_url: string | null;
+    default_branch: string;
+};
+/** One row of the `areas` list. */
+export declare function areaListItem(area: AreaFile, workspace: WorkspaceFile, current: boolean): Record<string, unknown>;
+/** `GET /areas` envelope. */
+export declare function areasListEnvelope(areas: readonly AreaFile[], workspace: WorkspaceFile, currentSlug?: string): {
+    data: Array<Record<string, unknown>>;
+    meta: {
+        count: number;
+    };
+};
+/** `POST /areas` envelope (create-area). */
+export declare function areaCreateEnvelope(area: AreaFile, workspace: WorkspaceFile): {
+    data: Record<string, unknown>;
+};
+/** `GET /areas/{id}/members` envelope — exactly `me` + `local-agent` (spec §1). */
+export declare function areaMembersEnvelope(): {
+    data: {
+        agents: Array<Record<string, unknown>>;
+        users: Array<Record<string, unknown>>;
+    };
+    meta: {
+        agents_count: number;
+        users_count: number;
+    };
+};
+/** Task counts by status, plus `total` — the `task_stats` block of the overview. */
+export declare function taskStats(tasks: readonly TaskRecord[]): Record<string, number>;
+/** `GET /areas/{id}/overview` envelope. */
+export declare function areaOverviewEnvelope(area: AreaFile, tasks: readonly TaskRecord[]): {
+    data: Record<string, unknown>;
+};
+/** Number of `##` headings in a document body (the API's `sections_count`). */
+export declare function countSections(body: string): number;
+/** Document entry as embedded in `/context` and task detail. */
+export declare function documentEntry(document: DocumentRecord, body: string): Record<string, unknown>;
+export interface ContextInput {
+    workspace: WorkspaceFile;
+    area?: AreaFile;
+    activeMission?: MissionRecord | null;
+    tasks: readonly TaskRecord[];
+    documents: readonly Record<string, unknown>[];
+}
+/** `GET /context` envelope. */
+export declare function contextEnvelope(input: ContextInput): {
+    data: Record<string, unknown>;
+};
+/** One row of `GET /tasks`. */
+export declare function taskListItem(task: TaskRecord, description: string | null): Record<string, unknown>;
+/** `GET /tasks` envelope. */
+export declare function tasksListEnvelope(items: Array<Record<string, unknown>>): {
+    data: Array<Record<string, unknown>>;
+    meta: {
+        count: number;
+    };
+};
+/** The `task` block of the task-detail envelope. */
+export declare function taskShape(task: TaskRecord, area: AreaFile, description: string | null): Record<string, unknown>;
+/** Compact task shape used for subtasks and dependency references. */
+export declare function taskSummary(task: TaskRecord): Record<string, unknown>;
+export interface TaskDetailInput {
+    task: TaskRecord;
+    area: AreaFile;
+    workspace: WorkspaceFile;
+    description: string | null;
+    logs: readonly WorkLogEntry[];
+    subtasks: readonly TaskRecord[];
+    dependsOn: readonly TaskRecord[];
+    blocks: readonly TaskRecord[];
+    related: readonly TaskRecord[];
+    documents?: readonly Record<string, unknown>[];
+}
+/** `data` of `GET /tasks/{id}` — also the payload `start` returns. */
+export declare function taskDetailData(input: TaskDetailInput): Record<string, unknown>;
+/** `GET /tasks/{id}` envelope. */
+export declare function taskDetailEnvelope(input: TaskDetailInput): {
+    data: Record<string, unknown>;
+};
+/** `POST /tasks` envelope. */
+export declare function taskCreateEnvelope(task: TaskRecord, area: AreaFile, options?: {
+    sourceIssueNumber?: string | null;
+}): {
+    data: Record<string, unknown>;
+};
+/** `PATCH /tasks/{id}/status` envelope. */
+export declare function taskStatusEnvelope(task: TaskRecord): {
+    data: Record<string, unknown>;
+};
+/** `POST /tasks/{id}/subtasks` envelope. */
+export declare function subtasksEnvelope(parent: TaskRecord, subtasks: readonly TaskRecord[]): {
+    data: Record<string, unknown>;
+};
+/** `PATCH /tasks/{id}/content` envelope. */
+export declare function taskContentEnvelope(task: TaskRecord, updatedFields: readonly string[], description: string | null): {
+    data: Record<string, unknown>;
+};
+/** `POST /tasks/{id}/assign` envelope. */
+export declare function assignTaskEnvelope(task: TaskRecord): {
+    data: Record<string, unknown>;
+};
+/** `POST /assign` (generic item assignment) envelope. */
+export declare function assignItemEnvelope(id: string, assignedAgent: string | null, assignedUser: string | null): {
+    data: Record<string, unknown>;
+};
+/** `POST /tasks/{id}/dependencies` envelope. */
+export declare function dependencyAddEnvelope(task: TaskRecord, target: TaskRecord, type: string, note: string | null): {
+    data: Record<string, unknown>;
+};
+/** `DELETE /tasks/{id}/dependencies/{target}` envelope. */
+export declare function dependencyRemoveEnvelope(task: TaskRecord, target: TaskRecord, type: string): {
+    data: Record<string, unknown>;
+};
+/** `POST /tasks/{id}/logs` envelope. */
+export declare function logWorkEnvelope(logId: string, task: TaskRecord, type: string): {
+    data: Record<string, unknown>;
+};
+/** One parsed `### <iso> · <type> · <author>` work-log entry. */
+export interface WorkLogEntry {
+    created_at: string;
+    type: string;
+    author: string;
+    content: string;
+}
+/**
+ * Split a task body into its description text and the *raw* work-log section
+ * (starting at the `## Work Log` heading). The work-log slice is returned verbatim so
+ * rewrites never reflow existing entries (spec §4.5).
+ */
+export declare function splitTaskBody(body: string): {
+    description: string;
+    workLog: string;
+};
+/** The task description, or `null` when the body carries none. */
+export declare function parseDescription(body: string): string | null;
+/** Parse the `## Work Log` section into entries, oldest first. */
+export declare function parseWorkLog(body: string): WorkLogEntry[];
+/** Build the initial body of a new task file. */
+export declare function buildTaskBody(description?: string | null): string;
+/** Replace the description while preserving the work-log section byte-for-byte. */
+export declare function replaceDescription(body: string, description: string): string;
+/**
+ * Append one work-log entry. The existing body — including every earlier entry — is
+ * copied verbatim; only new bytes are added at the end (spec §4.5, append-only).
+ */
+export declare function appendWorkLogEntry(body: string, entry: WorkLogEntry): string;
+/** Work-log entry in the API's `logs[]` shape. */
+export declare function workLogEntryShape(entry: WorkLogEntry, task: TaskRecord, index: number): Record<string, unknown>;
+/** `GET /prompts/work-on-next-task` envelope, built from local records. */
+export declare function workPromptEnvelope(area: AreaFile, task: TaskRecord | null, description: string | null): {
+    data: {
+        content: string;
+        has_task: boolean;
+    };
+};
+/** `GET /prompts/import-docs` envelope. */
+export declare function importDocsPromptEnvelope(area: AreaFile): {
+    data: {
+        content: string;
+    };
+};
+/** The active mission of the workspace, or `null`. */
+export declare function findActiveMission(missions: readonly MissionRecord[]): MissionRecord | null;
+/** Intent numbers, for reference validation (rules.ts rule 3). */
+export declare function intentNumbers(intents: readonly IntentRecord[]): string[];
+/** Mission numbers, for reference validation (rules.ts rule 3). */
+export declare function missionNumbers(missions: readonly MissionRecord[]): string[];