@rizom/brain 0.2.0-alpha.50 → 0.2.0-alpha.51

package/dist/plugins.d.ts

@@ -197,18 +197,58 @@ interface EntityTypeConfig {
  * Core entity service interface for read-only operations
  * Used by core plugins that need entity access but shouldn't modify entities
  */
+interface GetEntityRequest$1 {
+    entityType: string;
+    id: string;
+}
+type GetEntityRawRequest = GetEntityRequest$1;
+interface ListEntitiesRequest$1 {
+    entityType: string;
+    options?: ListOptions | undefined;
+}
+interface CountEntitiesRequest$1 {
+    entityType: string;
+    options?: Pick<ListOptions, "publishedOnly" | "filter"> | undefined;
+}
+interface CreateEntityRequest<T extends BaseEntity> {
+    entity: EntityInput<T>;
+    options?: CreateEntityOptions | undefined;
+}
+interface CreateEntityFromMarkdownRequest {
+    input: CreateEntityFromMarkdownInput;
+    options?: CreateEntityOptions | undefined;
+}
+interface UpdateEntityRequest<T extends BaseEntity> {
+    entity: T;
+    options?: EntityJobOptions | undefined;
+}
+interface DeleteEntityRequest {
+    entityType: string;
+    id: string;
+}
+interface UpsertEntityRequest<T extends BaseEntity> {
+    entity: T;
+    options?: EntityJobOptions | undefined;
+}
+interface EntitySearchRequest$1 {
+    query: string;
+    options?: SearchOptions | undefined;
+}
+interface SearchWithDistancesRequest {
+    query: string;
+}
 interface ICoreEntityService {
-    getEntity<T extends BaseEntity>(entityType: string, id: string): Promise<T | null>;
+    getEntity<T extends BaseEntity>(request: GetEntityRequest$1): Promise<T | null>;
     /**
      * Get entity without content resolution (raw)
      * Used internally to avoid recursion when resolving image references
      */
-    getEntityRaw<T extends BaseEntity>(entityType: string, id: string): Promise<T | null>;
-    listEntities<T extends BaseEntity>(type: string, options?: ListOptions): Promise<T[]>;
-    search<T extends BaseEntity = BaseEntity>(query: string, options?: SearchOptions): Promise<SearchResult<T>[]>;
+    getEntityRaw<T extends BaseEntity>(request: GetEntityRawRequest): Promise<T | null>;
+    listEntities<T extends BaseEntity>(request: ListEntitiesRequest$1): Promise<T[]>;
+    search<T extends BaseEntity = BaseEntity>(request: EntitySearchRequest$1): Promise<SearchResult<T>[]>;
     getEntityTypes(): string[];
     hasEntityType(type: string): boolean;
-    countEntities(entityType: string, options?: Pick<ListOptions, "publishedOnly" | "filter">): Promise<number>;
+    countEntities(request: CountEntitiesRequest$1): Promise<number>;
     getEntityCounts(): Promise<Array<{
         entityType: string;
         count: number;
@@ -220,18 +260,18 @@ interface ICoreEntityService {
  * Entity service interface for managing brain entities
  */
 interface EntityService extends ICoreEntityService {
-    createEntity<T extends BaseEntity>(entity: EntityInput<T>, options?: CreateEntityOptions): Promise<EntityMutationResult>;
-    createEntityFromMarkdown(input: CreateEntityFromMarkdownInput, options?: CreateEntityOptions): Promise<EntityMutationResult>;
-    updateEntity<T extends BaseEntity>(entity: T, options?: EntityJobOptions): Promise<EntityMutationResult>;
-    deleteEntity(entityType: string, id: string): Promise<boolean>;
-    upsertEntity<T extends BaseEntity>(entity: T, options?: EntityJobOptions): Promise<EntityMutationResult & {
+    createEntity<T extends BaseEntity>(request: CreateEntityRequest<T>): Promise<EntityMutationResult>;
+    createEntityFromMarkdown(request: CreateEntityFromMarkdownRequest): Promise<EntityMutationResult>;
+    updateEntity<T extends BaseEntity>(request: UpdateEntityRequest<T>): Promise<EntityMutationResult>;
+    deleteEntity(request: DeleteEntityRequest): Promise<boolean>;
+    upsertEntity<T extends BaseEntity>(request: UpsertEntityRequest<T>): Promise<EntityMutationResult & {
         created: boolean;
     }>;
     storeEmbedding(data: StoreEmbeddingData): Promise<void>;
     serializeEntity(entity: BaseEntity): string;
     deserializeEntity(markdown: string, entityType: string): Partial<BaseEntity>;
     countEmbeddings(): Promise<number>;
-    searchWithDistances(query: string): Promise<Array<{
+    searchWithDistances(request: SearchWithDistancesRequest): Promise<Array<{
         entityId: string;
         entityType: string;
         distance: number;
@@ -695,6 +735,16 @@ declare const AnchorProfileSchema: z.ZodObject<{
 }>;
 type AnchorProfile = z.infer<typeof AnchorProfileSchema>;
 
+/**
+ * Best-effort extension metadata carried across public DTO boundaries.
+ *
+ * Individual keys are not stable public API. When a metadata value becomes a
+ * documented contract, hoist it to a typed top-level field on the owning DTO
+ * schema and keep this bag only as optional extension data.
+ */
+declare const ExtensionMetadataSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+type ExtensionMetadata = z.infer<typeof ExtensionMetadataSchema>;
+
 declare const MessageResponseSchema: z.ZodUnion<[z.ZodObject<{
     success: z.ZodBoolean;
     data: z.ZodOptional<z.ZodUnknown>;
@@ -749,9 +799,15 @@ type MessageWithPayload<T = unknown> = BaseMessage & {
     payload: T;
 };
 interface MessageSendOptions {
+    target?: string;
+    metadata?: z.infer<typeof ExtensionMetadataSchema>;
     broadcast?: boolean;
 }
-type MessageSender<T = unknown, R = unknown> = (type: string, payload: T, options?: MessageSendOptions) => Promise<MessageResponse<R>>;
+interface MessageSendRequest<T = unknown> extends MessageSendOptions {
+    type: string;
+    payload: T;
+}
+type MessageSender<T = unknown, R = unknown> = (request: MessageSendRequest<T>) => Promise<MessageResponse<R>>;
 interface MessageContext {
     userId?: string;
     channelId?: string;
@@ -897,13 +953,29 @@ interface Channel<TPayload, TResponse = unknown> {
     readonly _response?: TResponse;
 }
 declare function defineChannel<TPayload, TResponse = unknown>(name: string, schema: z.ZodType<TPayload>): Channel<TPayload, TResponse>;
+interface GetEntityRequest {
+    entityType: string;
+    id: string;
+}
+interface ListEntitiesRequest {
+    entityType: string;
+    options?: unknown;
+}
+interface CountEntitiesRequest {
+    entityType: string;
+    options?: unknown;
+}
+interface EntitySearchRequest {
+    query: string;
+    options?: unknown;
+}
 interface IEntityService {
-    getEntity<T = unknown>(entityType: string, id: string): Promise<T | null>;
-    listEntities<T = unknown>(type: string, options?: unknown): Promise<T[]>;
-    search<T = unknown>(query: string, options?: unknown): Promise<T[]>;
+    getEntity<T = unknown>(request: GetEntityRequest): Promise<T | null>;
+    listEntities<T = unknown>(request: ListEntitiesRequest): Promise<T[]>;
+    search<T = unknown>(request: EntitySearchRequest): Promise<T[]>;
     getEntityTypes(): string[];
     hasEntityType(type: string): boolean;
-    countEntities(entityType: string, options?: unknown): Promise<number>;
+    countEntities(request: CountEntitiesRequest): Promise<number>;
     getEntityCounts(): Promise<Array<{
         entityType: string;
         count: number;
@@ -1054,6 +1126,19 @@ declare abstract class InterfacePlugin<TConfig = unknown, TTrackingInfo extends
     shutdown(): Promise<void>;
 }
 
+interface SendMessageToChannelRequest {
+    /** The channel/room to send to (null for single-channel interfaces like CLI) */
+    channelId: string | null;
+    /** The message to send */
+    message: string;
+}
+type SendMessageWithIdRequest = SendMessageToChannelRequest;
+interface EditMessageRequest {
+    channelId: string | null;
+    messageId: string;
+    newMessage: string;
+}
+
 declare abstract class MessageInterfacePlugin<TConfig = unknown, TTrackingInfo extends MessageJobTrackingInfo = MessageJobTrackingInfo> extends InterfacePlugin<TConfig, TTrackingInfo> {
     private readonly messageDelegate;
     protected constructor(id: string, packageJson: {
@@ -1061,15 +1146,15 @@ declare abstract class MessageInterfacePlugin<TConfig = unknown, TTrackingInfo e
         version: string;
         description?: string;
     }, config: Partial<TConfig>, configSchema: z.ZodTypeAny);
-    protected abstract sendMessageToChannel(channelId: string | null, message: string): void;
+    protected abstract sendMessageToChannel(request: SendMessageToChannelRequest): void;
     protected onRegister(_context: InterfacePluginContext): Promise<void>;
     protected onReady(_context: InterfacePluginContext): Promise<void>;
     protected onShutdown(): Promise<void>;
     protected getTools(): Promise<Tool[]>;
     protected getResources(): Promise<Resource[]>;
     protected getInstructions(): Promise<string | undefined>;
-    protected sendMessageWithId(_channelId: string | null, _message: string): Promise<string | undefined>;
-    protected editMessage(_channelId: string, _messageId: string, _newMessage: string): Promise<boolean>;
+    protected sendMessageWithId(_request: SendMessageWithIdRequest): Promise<string | undefined>;
+    protected editMessage(_request: EditMessageRequest): Promise<boolean>;
     protected supportsMessageEditing(): boolean;
     protected onProgressUpdate(_event: JobProgressEvent): Promise<void>;
     protected trackAgentResponseForJob(jobId: string, messageId: string, channelId: string): void;
@@ -1106,15 +1191,5 @@ declare abstract class ServicePlugin<TConfig = unknown> implements Plugin {
     shutdown(): Promise<void>;
 }
 
-/**
- * Best-effort extension metadata carried across public DTO boundaries.
- *
- * Individual keys are not stable public API. When a metadata value becomes a
- * documented contract, hoist it to a typed top-level field on the owning DTO
- * schema and keep this bag only as optional extension data.
- */
-declare const ExtensionMetadataSchema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
-type ExtensionMetadata = z.infer<typeof ExtensionMetadataSchema>;
-
 export { AgentResponseSchema, AnchorProfileSchema, AppInfoSchema, BaseMessageSchema, BrainCharacterSchema, ChatContextSchema, ConversationSchema, EntityPlugin, ExtensionMetadataSchema, InterfacePlugin, MessageInterfacePlugin, MessageResponseSchema, MessageSchema, PendingConfirmationSchema, ServicePlugin, ToolResultDataSchema, createResource, createTool, defineChannel, toolError, toolSuccess, urlCaptureConfigSchema };
 export type { AgentNamespace, AgentResponse, AnchorProfile, AppInfo, BaseJobTrackingInfo, BaseMessage, BasePluginContext, BrainCharacter, Channel, ChatContext, Conversation, EntityPluginContext, ExtensionMetadata, IConversationsNamespace, IEntitiesNamespace, IEvalNamespace, IIdentityNamespace, IInsightsNamespace, IMessagingNamespace, IPromptsNamespace, IServiceTemplatesNamespace, IViewsNamespace, InterfacePluginContext, JobProgressContext, JobProgressEvent, JobProgressStatus, Message, MessageContext, MessageJobTrackingInfo, MessageResponse, MessageRole, MessageSendOptions, MessageSender, MessageWithPayload, PendingConfirmation, Plugin, PluginConfig, PluginConfigInput, PluginFactory, Prompt, Resource, ResourceTemplate, ServicePluginContext, Tool, ToolConfirmation, ToolContext, ToolResponse, ToolResultData, ToolVisibility };