@north-light/crouter-api 0.3.220 → 0.3.221

package/dist/api/client.d.ts

@@ -12,6 +12,7 @@ import type { AttachEnsureRequest, AttachEnsureResultDTO } from './dto/attach.js
 import type { DeleteProfileRequest, DeleteProfileResultDTO, EnsureProfileRequest, ProfileDTO } from './dto/profiles.js';
 import type { FilePeekDTO } from './dto/files.js';
 import type { MemoryDocRefDTO } from './dto/memory.js';
+import type { ChatInventoryDTO } from './dto/chat-inventory.js';
 import type { CredentialRemovalResultDTO, CredentialResultDTO, InstallCredentialRequest, ModelAuthListDTO } from './dto/modelauth.js';
 import type { CreateHumanBridgeRequest, HumanBridgeResultDTO, HumanCancelRequest, HumanCancelResultDTO, HumanResolveRequest, HumanResolveResultDTO } from './dto/human.js';
 import type { CancelReviewRequest, CreateReviewRequest, ListReviewsQuery, ReviewCancelResultDTO, ReviewDocumentBaseDTO, ReviewDTO, ReviewListDTO, ReviewSubmitResultDTO } from './dto/reviews.js';
@@ -151,6 +152,11 @@ export declare class CrtrClient {
     /** The node's conversation exactly as it ran — raw `.jsonl` bytes plus the
      *  assembled system prompt. For exports; `getSnapshot` is for renderers. */
     getSession(id: string): Promise<NodeSessionDTO>;
+    /** What a non-terminal chat surface may offer for this node: the chat-capable
+     *  slash commands its live engine registered, and the memory documents an
+     *  inline `/name` token resolves to. Never revives — a node whose broker is
+     *  not live answers `broker_live: false` with empty arrays. */
+    getChatInventory(id: string): Promise<ChatInventoryDTO>;
     getArtifacts(id: string, q?: ArtifactsQuery): Promise<ArtifactListDTO>;
     getContext(id: string): Promise<ContextListDTO>;
     /** Read an absolute host path as UTF-8 (capped, `truncated` when clipped) for
@@ -160,6 +166,9 @@ export declare class CrtrClient {
      *  node would read — the node's own precedence chain, not this process's.
      *  Pair with `peekFile` to render the document. */
     resolveMemoryDoc(name: string, nodeId: string): Promise<MemoryDocRefDTO>;
+    /** Create-or-return by name. Supplied `projects` are shape-checked even when
+     *  the profile already exists; their directories are only required to exist
+     *  when this call creates the profile. */
     ensureProfile(name: string, req?: EnsureProfileRequest): Promise<ProfileDTO>;
     listProfiles(): Promise<ProfileDTO[]>;
     getProfile(name: string): Promise<ProfileDTO>;

package/dist/api/client.js

@@ -267,6 +267,13 @@ export class CrtrClient {
     getSession(id) {
         return this.request('GET', routes.nodeSession(this.nodePath(id)));
     }
+    /** What a non-terminal chat surface may offer for this node: the chat-capable
+     *  slash commands its live engine registered, and the memory documents an
+     *  inline `/name` token resolves to. Never revives — a node whose broker is
+     *  not live answers `broker_live: false` with empty arrays. */
+    getChatInventory(id) {
+        return this.request('GET', routes.nodeChatInventory(this.nodePath(id)));
+    }
     getArtifacts(id, q) {
         return this.request('GET', withQuery(routes.nodeArtifacts(this.nodePath(id)), q));
     }
@@ -287,6 +294,9 @@ export class CrtrClient {
         return this.request('GET', withQuery(routes.memoryResolve(), { name, node: nodeId }));
     }
     // ---- Profiles ----------------------------------------------------------
+    /** Create-or-return by name. Supplied `projects` are shape-checked even when
+     *  the profile already exists; their directories are only required to exist
+     *  when this call creates the profile. */
     ensureProfile(name, req) {
         return this.request('PUT', routes.profile(name), req ?? {});
     }

package/dist/api/dto/chat-inventory.d.ts

@@ -0,0 +1,43 @@
+/** One command a chat surface may advertise. Builtin and non-opted-in rows are
+ *  dropped before this DTO exists, so `source` never carries `'builtin'`. */
+export interface ChatInventoryCommandDTO {
+    /** No leading slash, exactly as the engine dispatches it. */
+    name: string;
+    description: string;
+    source: 'command' | 'template';
+    /** Argument shape to display beside the name, when the command supplies one. */
+    argument_hint?: string;
+    /** Deterministic expansion metadata for a memory-slash command — the same
+     *  material the terminal preview uses, so a chat preview cannot drift from
+     *  what submission sends. */
+    expansion?: {
+        kind: 'memory-slash';
+        commandName: string;
+        body: string;
+    };
+    /** Raw prompt-template content (frontmatter stripped), for `source: 'template'`. */
+    template?: string;
+}
+/** One resolvable inline memory reference. Metadata only — never the document
+ *  body or its source path. `shortForm` stays camelCase to mirror the broker's
+ *  own `RefMeta`, which is where these rows come from. */
+export interface ChatInventoryMemoryRefDTO {
+    /** Canonical `/`-joined name, e.g. `taste/writing`. */
+    name: string;
+    kind: 'knowledge' | 'preference';
+    scope: 'node' | 'project' | 'profile' | 'user' | 'builtin';
+    shortForm: string;
+}
+/** `GET /v1/nodes/{id}/chat-inventory` result.
+ *
+ *  `broker_live` reports whether the node's engine was reachable at all. There
+ *  is no per-part error flag: a part that failed and a part that is genuinely
+ *  empty both arrive as an empty array, and a client's behavior is identical
+ *  for both. A dormant node answers 200 with `broker_live: false` — this read
+ *  never revives an engine. */
+export interface ChatInventoryDTO {
+    node_id: string;
+    broker_live: boolean;
+    commands: ChatInventoryCommandDTO[];
+    memory_refs: ChatInventoryMemoryRefDTO[];
+}

package/dist/api/dto/chat-inventory.js

@@ -0,0 +1,11 @@
+// Chat-inventory DTO. Backs `GET /v1/nodes/{id}/chat-inventory` — the one read
+// a non-terminal chat surface makes to learn what the node's live engine will
+// accept: the slash commands that can complete their outcome from a chat
+// conversation, and the memory documents an inline `/name` token resolves to.
+//
+// Eligibility is decided in crouter and disclosed here. A client never filters
+// by name, infers capability, or invents a row: what is absent from these
+// arrays is not offered.
+//
+// PURITY (spec §3.1): Node built-ins + `src/api/*` only.
+export {};

package/dist/api/dto/profiles.d.ts

@@ -1,8 +1,22 @@
+/** The disclosure ladder, lowest to highest. Index order is the ordering. */
+export declare const PROFILE_PROJECT_MEMORY_VALUES: readonly ["none", "name", "preview", "content"];
+/** How much of a project's memory stores the profile relationship lets an
+ *  automatic delivery disclose. */
+export type ProfileProjectMemory = (typeof PROFILE_PROJECT_MEMORY_VALUES)[number];
+/** One project directory in a profile's purview. */
+export interface ProfileProject {
+    /** Absolute, real-path-resolved directory. */
+    path: string;
+    /** Maximum rung automatic boot and workspace-open delivery may reach from
+     *  this project's memory stores, regardless of the node's working directory.
+     *  An authored lower rung stays lower; targeted reads are never capped. */
+    memory: ProfileProjectMemory;
+}
 /** `PUT /v1/profiles/{name}` body — idempotent ensure. Every field applies
  *  only at create; an existing same-named profile is returned untouched. */
 export interface EnsureProfileRequest {
-    /** Absolute project directories in the profile's purview. */
-    projects?: string[];
+    /** Project directories in the profile's purview, each with its memory cap. */
+    projects?: ProfileProject[];
     /** Persona kind for node creates under the profile that omit kind. */
     default_kind?: string;
     /** Profile facts (identity, role); each entry reaches every broker
@@ -37,9 +51,9 @@ export interface ProfileDTO {
     /** Stable profile-directory id (`<slug>-<id>`). */
     id: string;
     name: string;
-    projects: string[];
-    /** Where nodes under this profile run — one of `projects` (the first unless
-     *  re-pointed), or null when the profile owns none. */
+    projects: ProfileProject[];
+    /** Where nodes under this profile run — one of `projects[].path` (the first
+     *  unless re-pointed), or null when the profile owns none. */
     home: string | null;
     /** ISO timestamp when the profile was paused, or null while active. */
     paused_at: string | null;

package/dist/api/dto/profiles.js

@@ -1,3 +1,4 @@
 // Profile DTOs (spec §6.6). Profile deletion crosses profile, canvas, cron,
 // inbox, and review state, so every consumer routes it through crtrd.
-export {};
+/** The disclosure ladder, lowest to highest. Index order is the ordering. */
+export const PROFILE_PROJECT_MEMORY_VALUES = ['none', 'name', 'preview', 'content'];

package/dist/api/index.d.ts

@@ -27,3 +27,4 @@ export * from './dto/memory.js';
 export * from './dto/inbox.js';
 export * from './dto/reviews.js';
 export * from './dto/review-comments.js';
+export * from './dto/chat-inventory.js';

package/dist/api/index.js

@@ -28,3 +28,4 @@ export * from './dto/memory.js';
 export * from './dto/inbox.js';
 export * from './dto/reviews.js';
 export * from './dto/review-comments.js';
+export * from './dto/chat-inventory.js';

package/dist/api/routes.d.ts

@@ -11,6 +11,7 @@ export declare const routes: {
     readonly nodeSnapshot: (id: string) => string;
     readonly nodeSubject: (id: string) => string;
     readonly nodeSession: (id: string) => string;
+    readonly nodeChatInventory: (id: string) => string;
     readonly nodeTranscript: (id: string) => string;
     readonly nodeContext: (id: string) => string;
     readonly nodeArtifacts: (id: string) => string;

package/dist/api/routes.js

@@ -27,6 +27,7 @@ export const routes = {
     nodeSnapshot: (id) => `${V}/nodes/${id}/snapshot`,
     nodeSubject: (id) => `${V}/nodes/${id}/subject`,
     nodeSession: (id) => `${V}/nodes/${id}/session`,
+    nodeChatInventory: (id) => `${V}/nodes/${id}/chat-inventory`,
     nodeTranscript: (id) => `${V}/nodes/${id}/transcript`,
     nodeContext: (id) => `${V}/nodes/${id}/context`,
     nodeArtifacts: (id) => `${V}/nodes/${id}/artifacts`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@north-light/crouter-api",
-  "version": "0.3.220",
+  "version": "0.3.221",
   "description": "Typed crtrd /v1 API contract — DTOs, route builders, the error contract, and the CrtrClient. Zero runtime dependencies.",
   "type": "module",
   "main": "./dist/api/index.js",