@breign/db-schemas 0.1.51 → 0.1.52

package/dist/types/agent.d.ts

@@ -39,6 +39,7 @@ export type Agent = {
     maxToolSteps?: number;
     contextualKnowledgeConversation?: ContextualKnowledgeConversationConfig;
     memoryConfiguration?: AgentMemoryConfiguration;
+    sandboxConfiguration?: AgentSandboxConfiguration;
     speechToText?: SpeechToTextConfig;
 };
 export type AgentMemoryConfiguration = {
@@ -46,6 +47,17 @@ export type AgentMemoryConfiguration = {
     agentMemoryEnabled?: boolean;
     organizationMemoryEnabled?: boolean;
 };
+export type AgentSandboxNetworkConfiguration = {
+    enabled?: boolean;
+    allowedUrlPrefixes?: string[];
+    allowedMethods?: ('GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS')[];
+};
+export type AgentSandboxConfiguration = {
+    enabled?: boolean;
+    pythonEnabled?: boolean;
+    network?: AgentSandboxNetworkConfiguration;
+    workspaceScope?: 'conversation' | 'agentUser';
+};
 export type ContextualKnowledgeConversationBackend = 'weaviate' | 'qdrant' | 'colpali';
 export type ContextualKnowledgeConversationConfig = {
     enabled: boolean;

package/dist/types/conversation.d.ts

@@ -33,6 +33,7 @@ export type ConversationMessage = {
         id: string;
         text: string;
     }[];
+    workspaceFiles?: string[];
     flowNode?: string;
     flowNodeRequirementsChecked?: boolean;
     flowNodeRequirementsMet?: boolean;

package/dist/types/index.d.ts

@@ -17,3 +17,4 @@ export * from './skill';
 export * from './scheduled-task';
 export * from './scheduled-task-run';
 export * from './speech-to-text';
+export * from './workspace-file';

package/dist/types/index.js

@@ -33,3 +33,4 @@ __exportStar(require("./skill"), exports);
 __exportStar(require("./scheduled-task"), exports);
 __exportStar(require("./scheduled-task-run"), exports);
 __exportStar(require("./speech-to-text"), exports);
+__exportStar(require("./workspace-file"), exports);

package/dist/types/workspace-file.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Persistent agent workspace — one row per virtual file under /home/user/.
+ *
+ * Shared between brain-api (storage adapters + Bash_exec sandbox) and any other
+ * consumer. The path is a virtual filesystem key (e.g. '/home/user/rapport.md');
+ * identity (organisationId / conversationId / agentId / userId) never comes from
+ * the path, always from the server-side chat context.
+ *
+ * Content is UTF-8 text only: it is stored in a `text` column, which cannot hold
+ * a NUL byte. The invariant is enforced at write time inside the sandbox
+ * filesystem, not here.
+ */
+export type WorkspaceFile = {
+    id: string;
+    /**
+     * British spelling "organisationId" — aligned with Agent.organisationId
+     * (domain + Mongo storage). In PostgreSQL the COLUMN is organizationId ("z"),
+     * mapped inside the PG adapter (cf. agents-pg.adapter.ts).
+     */
+    organisationId: string;
+    /** Set for the 'conversation' scope (phase 1). Mutually exclusive with agentId/userId. */
+    conversationId?: string;
+    /** Set for the 'agentUser' scope. Mutually exclusive with conversationId. */
+    agentId?: string;
+    /** Set for the 'agentUser' scope. Mutually exclusive with conversationId. */
+    userId?: string;
+    /** e.g. '/home/user/rapport.md' — validated server-side, never by the model alone. */
+    path: string;
+    content: string;
+    /** utf8 byte length — avoids a length() on every listing. */
+    size: number;
+    mimeType: string;
+    /** Optimistic lock — incremented on every write. Also used as the canvas ETag. */
+    version: number;
+    createdAt: string;
+    updatedAt: string;
+};
+/** Listing entry: never carries the content. */
+export type WorkspaceFileEntry = Pick<WorkspaceFile, 'path' | 'size' | 'mimeType' | 'version' | 'updatedAt'>;

package/dist/types/workspace-file.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breign/db-schemas",
-  "version": "0.1.51",
+  "version": "0.1.52",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/types/agent.ts

@@ -34,6 +34,7 @@ export type Agent = {
   maxToolSteps?: number;
   contextualKnowledgeConversation?: ContextualKnowledgeConversationConfig;
   memoryConfiguration?: AgentMemoryConfiguration;
+  sandboxConfiguration?: AgentSandboxConfiguration;
   speechToText?: SpeechToTextConfig;
 };
 
@@ -43,6 +44,19 @@ export type AgentMemoryConfiguration = {
   organizationMemoryEnabled?: boolean;
 };
 
+export type AgentSandboxNetworkConfiguration = {
+  enabled?: boolean;
+  allowedUrlPrefixes?: string[];
+  allowedMethods?: ('GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'OPTIONS')[];
+};
+
+export type AgentSandboxConfiguration = {
+  enabled?: boolean;
+  pythonEnabled?: boolean;
+  network?: AgentSandboxNetworkConfiguration;
+  workspaceScope?: 'conversation' | 'agentUser';
+};
+
 export type ContextualKnowledgeConversationBackend = 'weaviate' | 'qdrant' | 'colpali';
 
 export type ContextualKnowledgeConversationConfig = {

package/src/types/conversation.ts

@@ -32,6 +32,7 @@ export type ConversationMessage = {
     id: string;
     text: string;
   }[];
+  workspaceFiles?: string[];
   flowNode?: string;
   flowNodeRequirementsChecked?: boolean;
   flowNodeRequirementsMet?: boolean;

package/src/types/index.ts

@@ -17,3 +17,4 @@ export * from './skill';
 export * from './scheduled-task';
 export * from './scheduled-task-run';
 export * from './speech-to-text';
+export * from './workspace-file';

package/src/types/workspace-file.ts

@@ -0,0 +1,43 @@
+/**
+ * Persistent agent workspace — one row per virtual file under /home/user/.
+ *
+ * Shared between brain-api (storage adapters + Bash_exec sandbox) and any other
+ * consumer. The path is a virtual filesystem key (e.g. '/home/user/rapport.md');
+ * identity (organisationId / conversationId / agentId / userId) never comes from
+ * the path, always from the server-side chat context.
+ *
+ * Content is UTF-8 text only: it is stored in a `text` column, which cannot hold
+ * a NUL byte. The invariant is enforced at write time inside the sandbox
+ * filesystem, not here.
+ */
+export type WorkspaceFile = {
+  id: string;
+  /**
+   * British spelling "organisationId" — aligned with Agent.organisationId
+   * (domain + Mongo storage). In PostgreSQL the COLUMN is organizationId ("z"),
+   * mapped inside the PG adapter (cf. agents-pg.adapter.ts).
+   */
+  organisationId: string;
+  /** Set for the 'conversation' scope (phase 1). Mutually exclusive with agentId/userId. */
+  conversationId?: string;
+  /** Set for the 'agentUser' scope. Mutually exclusive with conversationId. */
+  agentId?: string;
+  /** Set for the 'agentUser' scope. Mutually exclusive with conversationId. */
+  userId?: string;
+  /** e.g. '/home/user/rapport.md' — validated server-side, never by the model alone. */
+  path: string;
+  content: string;
+  /** utf8 byte length — avoids a length() on every listing. */
+  size: number;
+  mimeType: string;
+  /** Optimistic lock — incremented on every write. Also used as the canvas ETag. */
+  version: number;
+  createdAt: string;
+  updatedAt: string;
+};
+
+/** Listing entry: never carries the content. */
+export type WorkspaceFileEntry = Pick<
+  WorkspaceFile,
+  'path' | 'size' | 'mimeType' | 'version' | 'updatedAt'
+>;