@bevel-software/platform-core-backend 0.25.2 → 0.27.0

package/dist/modules/workspace/workspace.tools.d.ts

@@ -1,15 +1,21 @@
 import type { Router, RequestHandler } from 'express';
 import type { IToolRegistry } from '../tool-registry/tool.contract.js';
+import { type ToolContext } from '../tool-helpers/tool.contract.js';
 import { type AgentAccessGate } from './agent-access.gate.js';
 import type { IRoutineWritePolicy } from './routine-write-policy.js';
 import type { ToolHandlerFactory } from '../tool-helpers/tool-handler.js';
 import type { ISessionSink } from './session-sink.js';
+import { type ITreeWalker } from '../../shared/fs.contract.js';
 import type { IAccessControl } from '../access/access-control.interface.js';
 import type { SpillStore } from './spill-store.js';
 import type { DocExtractService } from './file-readers/doc-extract.service.js';
+import { type ReadResult } from './file-readers/file-reader.js';
 import type { KbContext } from '../../shared/kb-context.js';
+import { type AgentGuideReader } from '../agent-guide/agent-guide.js';
+import { type FirstRunStarterSource } from './first-run.js';
 import type { IChangeReadGate } from '../access-model/change-gate.js';
 import { AgentUploadStore } from './agent-upload.store.js';
+import type { IAgentDownloadStore } from './agent-download.store.js';
 /** What a write is ALLOWED to do at a path. `create` is the default everywhere. */
 export type WriteMode = 'create' | 'overwrite' | 'update';
 /** What a write actually DID at a path, in the answer the caller reads. */
@@ -29,6 +35,39 @@ export interface SkillSaveCheck {
         content: string;
     }[]): Promise<SkillSaveWarning[][]>;
 }
+/**
+ * The `sessionId` property inside a BUILT tool def's input schema, or
+ * `undefined` for a tool that declares none. `toolDef` wraps the flat inputs
+ * under `body` and copies the schema it is given, so a note registered after
+ * the tools were built has to be written here rather than onto the shared
+ * `SESSION_ID_INPUT` constant.
+ */
+export declare function sessionIdInputOf(def: {
+    inputs?: unknown;
+}): {
+    description?: string;
+} | undefined;
+/**
+ * A read of ONE workspace file, exactly as `read_file` performs it: the read
+ * hook, the access gate, the not-found refusal and the per-extension reader,
+ * in that order. Rejects with the same `ToolError`s `read_file` rejects with.
+ *
+ * `offset`/`limit` and the `__tool_chain_spill__/…` ref are deliberately NOT
+ * here: they are `read_file`'s own arguments, not part of what reading a file
+ * means.
+ */
+export type ReadForTool = (branch: string, path: string, ctx: ToolContext) => Promise<ReadResult>;
+/**
+ * What the workspace tool registration hands back for another module to build
+ * on, rather than re-deriving.
+ *
+ * One member today, and it is the only kind of thing that belongs here: a
+ * behaviour the platform promises TWICE in the same words (`open_page`
+ * answers "the way `read_file` does") and must therefore implement once.
+ */
+export interface WorkspaceToolsPorts {
+    readForTool: ReadForTool;
+}
 /**
  * Workspace domain tools: the file primitives (replacing Mastra's auto-injected
  * Workspace tools) + unzip. Most just re-expose the SAME `LocalFilesystem`
@@ -60,5 +99,33 @@ changeGate?: IChangeReadGate,
  * real composition wires it (`create-core-server.ts`), and without it the
  * two tools are not mounted at all rather than mounted and broken.
  */
-uploads?: AgentUploadStore): void;
+uploads?: AgentUploadStore, 
+/**
+ * The platform's agent guide (see `modules/agent-guide`), which `read_file`
+ * and `file_stat` answer at the guide's name in the repository root — after
+ * the knowledge base's own file of that name, when it has one. Optional for
+ * the harnesses that are about the file primitives; without it the two
+ * tools read the disk and nothing else.
+ */
+agentGuide?: AgentGuideReader, 
+/**
+ * The download-link store behind `request_file_download` — the way an agent
+ * takes files OUT without their content passing through the model. Optional
+ * for the harnesses about the file primitives; without it the tool is not
+ * mounted.
+ */
+downloads?: IAgentDownloadStore, 
+/**
+ * The starter pack the knowledge base was filled from, if any (see
+ * `modules/onboarding`): its untouched pages do not end the `firstRun`
+ * note, and the note names the pages it suggests. Optional; without it the
+ * note reads the knowledge folder alone.
+ */
+starterPacks?: FirstRunStarterSource, 
+/**
+ * The one tree walk (see `shared/fs.contract.ts`), for the `firstRun`
+ * note's look at the knowledge folder. Optional for the harnesses about the
+ * file primitives; without it `start_session` answers the id alone.
+ */
+disk?: ITreeWalker): WorkspaceToolsPorts;
 //# sourceMappingURL=workspace.tools.d.ts.map

package/dist/modules/workspace/workspace.tools.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"workspace.tools.d.ts","sourceRoot":"","sources":["../../../src/modules/workspace/workspace.tools.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEtD,OAAO,KAAK,EAAE,aAAa,EAAc,MAAM,mCAAmC,CAAC;AAGnF,OAAO,EAIL,KAAK,eAAe,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAiB1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,KAAK,EAA0C,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAIpH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAkB/E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAK5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAKtE,OAAO,EAAE,gBAAgB,EAAsB,MAAM,yBAAyB,CAAC;AAmU/E,mFAAmF;AACnF,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE1D,2EAA2E;AAC3E,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;AAmX9D,qFAAqF;AACrF,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,kHAAkH;AAClH,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACzF,mFAAmF;IACnF,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;CACnH;AAsCD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,aAAa,EACvB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,cAAc,EACxB,WAAW,EAAE,kBAAkB,EAC/B,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,iBAAiB,EAC7B,aAAa,EAAE,cAAc,EAC7B,EAAE,EAAE,SAAS,EACb,eAAe,EAAE,eAAe,EAChC,WAAW,EAAE,mBAAmB,EAChC,WAAW,EAAE,YAAY;AACzB;;;;GAIG;AACH,cAAc,CAAC,EAAE,cAAc;AAC/B;;;;;GAKG;AACH,UAAU,CAAC,EAAE,eAAe;AAC5B;;;;;;;GAOG;AACH,OAAO,CAAC,EAAE,gBAAgB,GACzB,IAAI,CAmmFN"}
+{"version":3,"file":"workspace.tools.d.ts","sourceRoot":"","sources":["../../../src/modules/workspace/workspace.tools.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEtD,OAAO,KAAK,EAAE,aAAa,EAAc,MAAM,mCAAmC,CAAC;AACnF,OAAO,EAA4B,KAAK,WAAW,EAAoB,MAAM,kCAAkC,CAAC;AAEhH,OAAO,EAIL,KAAK,eAAe,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAkB1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACtD,OAAO,EAAa,KAAK,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC1E,OAAO,KAAK,EAA0C,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAIpH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAuD,KAAK,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAmBrH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAE5D,OAAO,EAKL,KAAK,gBAAgB,EACtB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAA4D,KAAK,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAItH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAKtE,OAAO,EAAE,gBAAgB,EAAsB,MAAM,yBAAyB,CAAC;AAC/E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAwUrE,mFAAmF;AACnF,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,WAAW,GAAG,QAAQ,CAAC;AAE1D,2EAA2E;AAC3E,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;AAuX9D,qFAAqF;AACrF,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,kHAAkH;AAClH,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IACzF,mFAAmF;IACnF,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,GAAG,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;CACnH;AAwBD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE;IAAE,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAKhG;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,WAAW,GAAG,CACxB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,WAAW,KACb,OAAO,CAAC,UAAU,CAAC,CAAC;AAEzB;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,aAAa,EACvB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,cAAc,EACxB,WAAW,EAAE,kBAAkB,EAC/B,UAAU,EAAE,UAAU,EACtB,UAAU,EAAE,iBAAiB,EAC7B,aAAa,EAAE,cAAc,EAC7B,EAAE,EAAE,SAAS,EACb,eAAe,EAAE,eAAe,EAChC,WAAW,EAAE,mBAAmB,EAChC,WAAW,EAAE,YAAY;AACzB;;;;GAIG;AACH,cAAc,CAAC,EAAE,cAAc;AAC/B;;;;;GAKG;AACH,UAAU,CAAC,EAAE,eAAe;AAC5B;;;;;;;GAOG;AACH,OAAO,CAAC,EAAE,gBAAgB;AAC1B;;;;;;GAMG;AACH,UAAU,CAAC,EAAE,gBAAgB;AAC7B;;;;;GAKG;AACH,SAAS,CAAC,EAAE,mBAAmB;AAC/B;;;;;GAKG;AACH,YAAY,CAAC,EAAE,qBAAqB;AACpC;;;;GAIG;AACH,IAAI,CAAC,EAAE,WAAW,GACjB,mBAAmB,CAqpGrB"}