@bpmsoftwaresolutions/ai-engine-client 1.1.54 → 1.1.56

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpmsoftwaresolutions/ai-engine-client",
-  "version": "1.1.54",
+  "version": "1.1.56",
   "description": "Thin npm client for the AI Engine operator and retrieval APIs",
   "type": "module",
   "main": "./src/index.js",

package/src/index.js

@@ -1,5 +1,5 @@
 const DEFAULT_TIMEOUT_MS = 30000;
-export const AI_ENGINE_CLIENT_VERSION = '1.1.54';
+export const AI_ENGINE_CLIENT_VERSION = '1.1.56';
 export const GOVERNED_MUTATION_REQUIRED_CAPABILITIES = [
   'executeVerifiedMutation',
   'post_mutation_verification',
@@ -440,6 +440,10 @@ export class AIEngineClient {
       acceptHandoff: (request) => this.acceptCommunicationHandoff(request),
       whoIsOnline: (request) => this.whoIsOnline(request),
       findOnlineParticipant: (request) => this.findOnlineParticipant(request),
+      getPresenceBoard: (request) => this.getPresenceBoard(request),
+      getChannelPresence: (request) => this.getChannelPresence(request),
+      markParticipantOnline: (request) => this.markParticipantOnline(request),
+      markParticipantOffline: (request) => this.markParticipantOffline(request),
       sendToParticipant: (request) => this.sendToParticipant(request),
       sendToRole: (request) => this.sendToRole(request),
       getMyInbox: (request) => this.getMyInbox(request),
@@ -456,6 +460,10 @@ export class AIEngineClient {
       requestClosure: (request) => this.requestCollaborationClosure(request),
       whoIsOnline: (request) => this.whoIsOnline(request),
       findOnlineParticipant: (request) => this.findOnlineParticipant(request),
+      getPresenceBoard: (request) => this.getPresenceBoard(request),
+      getChannelPresence: (request) => this.getChannelPresence(request),
+      markParticipantOnline: (request) => this.markParticipantOnline(request),
+      markParticipantOffline: (request) => this.markParticipantOffline(request),
       sendToParticipant: (request) => this.sendToParticipant(request),
       sendToRole: (request) => this.sendToRole(request),
       getMyInbox: (request) => this.getMyInbox(request),
@@ -649,6 +657,153 @@ export class AIEngineClient {
     return this._request('/api/agent-communications/deployment-capabilities');
   }
 
+  async getPresenceBoard({
+    workflowRunId,
+    workflow_run_id,
+    transferChannelId,
+    transfer_channel_id,
+    participantRole,
+    participant_role,
+    role,
+    capability,
+    includeStale,
+    include_stale,
+  } = {}) {
+    const normalizedTransferChannelId = cleanText(transfer_channel_id) || cleanText(transferChannelId);
+    const path = normalizedTransferChannelId
+      ? `/api/operator/projections/agent-communications/presence/${encodeURIComponent(normalizedTransferChannelId)}`
+      : '/api/operator/projections/agent-communications/presence';
+    return this._requestLogaProjection(path, {
+      query: {
+        workflow_run_id: cleanText(workflow_run_id) || cleanText(workflowRunId),
+        transfer_channel_id: normalizedTransferChannelId,
+        participant_role: cleanText(participant_role) || cleanText(participantRole) || cleanText(role),
+        capability: cleanText(capability),
+        include_stale: include_stale ?? includeStale,
+      },
+    });
+  }
+
+  async getChannelPresence({
+    transferChannelId,
+    transfer_channel_id,
+    channelId,
+    channel_id,
+    workflowRunId,
+    workflow_run_id,
+    participantRole,
+    participant_role,
+    role,
+    capability,
+    includeStale,
+    include_stale,
+  } = {}) {
+    const normalizedTransferChannelId = cleanText(transfer_channel_id) || cleanText(transferChannelId) || cleanText(channel_id) || cleanText(channelId);
+    if (!normalizedTransferChannelId) {
+      throw new Error('transferChannelId is required.');
+    }
+    return this._requestLogaProjection(`/api/operator/projections/agent-communications/presence/${encodeURIComponent(normalizedTransferChannelId)}`, {
+      query: {
+        workflow_run_id: cleanText(workflow_run_id) || cleanText(workflowRunId),
+        participant_role: cleanText(participant_role) || cleanText(participantRole) || cleanText(role),
+        capability: cleanText(capability),
+        include_stale: include_stale ?? includeStale,
+      },
+    });
+  }
+
+  async markParticipantOnline({
+    transferChannelId,
+    transfer_channel_id,
+    channelId,
+    channel_id,
+    workTransferPacketId,
+    work_transfer_packet_id,
+    packetId,
+    packet_id,
+    workflowRunId,
+    workflow_run_id,
+    participantRole,
+    participant_role,
+    currentPhase,
+    current_phase,
+    currentTaskSummary,
+    current_task_summary,
+    agentSessionId,
+    agent_session_id,
+    actorSessionId,
+    actor_session_id,
+    observedAt,
+    observed_at,
+    metadata = {},
+  } = {}) {
+    const normalizedTransferChannelId = cleanText(transfer_channel_id) || cleanText(transferChannelId) || cleanText(channel_id) || cleanText(channelId);
+    if (!normalizedTransferChannelId) throw new Error('transferChannelId is required.');
+    return this._request(`/api/agent-communications/transfer-channels/${encodeURIComponent(normalizedTransferChannelId)}/presence/online`, {
+      method: 'POST',
+      body: {
+        transfer_channel_id: normalizedTransferChannelId,
+        work_transfer_packet_id: cleanText(work_transfer_packet_id) || cleanText(workTransferPacketId) || cleanText(packet_id) || cleanText(packetId),
+        workflow_run_id: cleanText(workflow_run_id) || cleanText(workflowRunId),
+        participant_role: cleanText(participant_role) || cleanText(participantRole),
+        current_phase: cleanText(current_phase) || cleanText(currentPhase),
+        current_task_summary: cleanText(current_task_summary) || cleanText(currentTaskSummary),
+        agent_session_id: cleanText(agent_session_id) || cleanText(agentSessionId),
+        actor_session_id: cleanText(actor_session_id) || cleanText(actorSessionId),
+        observed_at: cleanText(observed_at) || cleanText(observedAt),
+        metadata: isPlainObject(metadata) ? metadata : {},
+        is_active: true,
+        activity_state: 'active',
+      },
+    });
+  }
+
+  async markParticipantOffline({
+    transferChannelId,
+    transfer_channel_id,
+    channelId,
+    channel_id,
+    workTransferPacketId,
+    work_transfer_packet_id,
+    packetId,
+    packet_id,
+    workflowRunId,
+    workflow_run_id,
+    participantRole,
+    participant_role,
+    currentPhase,
+    current_phase,
+    currentTaskSummary,
+    current_task_summary,
+    agentSessionId,
+    agent_session_id,
+    actorSessionId,
+    actor_session_id,
+    observedAt,
+    observed_at,
+    metadata = {},
+  } = {}) {
+    const normalizedTransferChannelId = cleanText(transfer_channel_id) || cleanText(transferChannelId) || cleanText(channel_id) || cleanText(channelId);
+    if (!normalizedTransferChannelId) throw new Error('transferChannelId is required.');
+    return this._request(`/api/agent-communications/transfer-channels/${encodeURIComponent(normalizedTransferChannelId)}/presence/offline`, {
+      method: 'POST',
+      body: {
+        transfer_channel_id: normalizedTransferChannelId,
+        work_transfer_packet_id: cleanText(work_transfer_packet_id) || cleanText(workTransferPacketId) || cleanText(packet_id) || cleanText(packetId),
+        workflow_run_id: cleanText(workflow_run_id) || cleanText(workflowRunId),
+        participant_role: cleanText(participant_role) || cleanText(participantRole),
+        current_phase: cleanText(current_phase) || cleanText(currentPhase),
+        current_task_summary: cleanText(current_task_summary) || cleanText(currentTaskSummary),
+        agent_session_id: cleanText(agent_session_id) || cleanText(agentSessionId),
+        actor_session_id: cleanText(actor_session_id) || cleanText(actorSessionId),
+        observed_at: cleanText(observed_at) || cleanText(observedAt),
+        metadata: isPlainObject(metadata) ? metadata : {},
+        is_active: false,
+        activity_state: 'offline',
+      },
+    });
+  }
+
   async reviewCollaborationProposal({
     transferChannelId,
     transfer_channel_id,
@@ -1310,6 +1465,7 @@ export class AIEngineClient {
     transfer_channel_id,
     participantRole,
     participant_role,
+    role,
     capability,
     includeStale,
     include_stale,
@@ -1322,7 +1478,7 @@ export class AIEngineClient {
     return this._request(basePath, {
       query: {
         workflow_run_id: cleanText(workflow_run_id) || cleanText(workflowRunId),
-        participant_role: cleanText(participant_role) || cleanText(participantRole),
+        participant_role: cleanText(participant_role) || cleanText(participantRole) || cleanText(role),
         capability: cleanText(capability),
         include_stale: include_stale ?? includeStale,
         limit,
@@ -1337,13 +1493,14 @@ export class AIEngineClient {
     transfer_channel_id,
     participantRole,
     participant_role,
+    role,
     capability,
   } = {}) {
     const normalizedTransferChannelId = cleanText(transfer_channel_id) || cleanText(transferChannelId);
     const body = {
       workflow_run_id: cleanText(workflow_run_id) || cleanText(workflowRunId),
       transfer_channel_id: normalizedTransferChannelId,
-      participant_role: cleanText(participant_role) || cleanText(participantRole),
+      participant_role: cleanText(participant_role) || cleanText(participantRole) || cleanText(role),
       capability: cleanText(capability),
     };
     const path = normalizedTransferChannelId
@@ -1370,6 +1527,7 @@ export class AIEngineClient {
     recipient_agent_session_id,
     recipientRole,
     recipient_role,
+    role,
     participantId,
     participant_id,
     recipientParticipantId,
@@ -1397,7 +1555,7 @@ export class AIEngineClient {
         sender_agent_session_id: cleanText(sender_agent_session_id) || cleanText(senderAgentSessionId),
         sender_role: cleanText(sender_role) || cleanText(senderRole),
         recipient_agent_session_id: cleanText(recipient_agent_session_id) || cleanText(recipientAgentSessionId),
-        recipient_role: cleanText(recipient_role) || cleanText(recipientRole),
+        recipient_role: cleanText(recipient_role) || cleanText(recipientRole) || cleanText(role),
         participant_id: cleanText(participant_id) || cleanText(participantId) || cleanText(recipient_participant_id) || cleanText(recipientParticipantId),
         message_kind: cleanText(message_kind) || cleanText(messageKind),
         payload: isPlainObject(payload) ? payload : {},
@@ -1423,6 +1581,7 @@ export class AIEngineClient {
     recipient_role,
     participantRole,
     participant_role,
+    role,
     recipientAgentSessionId,
     recipient_agent_session_id,
     workflowRunId,
@@ -1448,7 +1607,7 @@ export class AIEngineClient {
         sender_agent_session_id: cleanText(sender_agent_session_id) || cleanText(senderAgentSessionId),
         sender_role: cleanText(sender_role) || cleanText(senderRole),
         recipient_agent_session_id: cleanText(recipient_agent_session_id) || cleanText(recipientAgentSessionId),
-        recipient_role: cleanText(recipient_role) || cleanText(recipientRole) || cleanText(participant_role) || cleanText(participantRole),
+        recipient_role: cleanText(recipient_role) || cleanText(recipientRole) || cleanText(role) || cleanText(participant_role) || cleanText(participantRole),
         message_kind: cleanText(message_kind) || cleanText(messageKind),
         payload: isPlainObject(payload) ? payload : {},
         scope: isPlainObject(scope) ? scope : {},