@pushwoosh/rpc-gateway-ai-assistant 0.1.599 → 0.1.601

package/data.js

@@ -5156,5 +5156,436 @@ export const data = {
         "type": "S",
         "key": "agentProfile",
         "methods": {}
+    },
+    "pushwoosh.uds.onyx.v1.BoardService": {
+        "type": "S",
+        "key": "board",
+        "methods": {
+            "GetBoard": {
+                "request": "pushwoosh.uds.onyx.v1.GetBoardRequest",
+                "response": "pushwoosh.uds.onyx.v1.GetBoardResponse",
+                "method": "get",
+                "path": "/api/v1/applications/{application}/board"
+            },
+            "MoveCard": {
+                "request": "pushwoosh.uds.onyx.v1.MoveCardRequest",
+                "response": "pushwoosh.uds.onyx.v1.MoveCardResponse",
+                "method": "post",
+                "path": "/api/v1/applications/{application}/board/cards/{card_id}/move"
+            },
+            "OpenCardChat": {
+                "request": "pushwoosh.uds.onyx.v1.OpenCardChatRequest",
+                "response": "pushwoosh.uds.onyx.v1.OpenCardChatResponse",
+                "method": "post",
+                "path": "/api/v1/applications/{application}/board/cards/{card_id}/chat"
+            },
+            "GetAgentAccess": {
+                "request": "pushwoosh.uds.onyx.v1.GetAgentAccessRequest",
+                "response": "pushwoosh.uds.onyx.v1.GetAgentAccessResponse",
+                "method": "get",
+                "path": "/api/v1/applications/{application}/board/access"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.Card": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "number"
+            },
+            "kind": {
+                "type": "string"
+            },
+            "state": {
+                "type": "string"
+            },
+            "owner": {
+                "type": "string"
+            },
+            "column": {
+                "type": "string"
+            },
+            "goalId": {
+                "type": "number"
+            },
+            "parentId": {
+                "type": "number"
+            },
+            "chatId": {
+                "type": "number"
+            },
+            "skill": {
+                "type": "string"
+            },
+            "createdAt": {
+                "type": "Date"
+            },
+            "updatedAt": {
+                "type": "Date"
+            },
+            "view": {
+                "type": "pushwoosh.uds.onyx.v1.CardView"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.CardView": {
+        "type": "I",
+        "fields": {
+            "label": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string"
+            },
+            "description": {
+                "type": "string"
+            },
+            "parent": {
+                "type": "pushwoosh.uds.onyx.v1.CardParent"
+            },
+            "chips": {
+                "type": "string",
+                "array": true
+            },
+            "dates": {
+                "type": "pushwoosh.uds.onyx.v1.CardDates"
+            },
+            "progress": {
+                "type": "pushwoosh.uds.onyx.v1.CardProgress"
+            },
+            "status": {
+                "type": "pushwoosh.uds.onyx.v1.CardStatus"
+            },
+            "note": {
+                "type": "string"
+            },
+            "error": {
+                "type": "string"
+            },
+            "result": {
+                "type": "pushwoosh.uds.onyx.v1.CardResult"
+            },
+            "actions": {
+                "type": "pushwoosh.uds.onyx.v1.CardAction",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.CardParent": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "number"
+            },
+            "title": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.CardDates": {
+        "type": "I",
+        "fields": {
+            "left": {
+                "type": "string"
+            },
+            "right": {
+                "type": "string"
+            },
+            "warn": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.CardProgress": {
+        "type": "I",
+        "fields": {
+            "segments": {
+                "type": "pushwoosh.uds.onyx.v1.CardProgressSegments"
+            },
+            "bar": {
+                "type": "pushwoosh.uds.onyx.v1.CardProgressBar"
+            }
+        },
+        "oneofs": {
+            "kind": {
+                "oneof": [
+                    "segments",
+                    "bar"
+                ]
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.CardProgressSegments": {
+        "type": "I",
+        "fields": {
+            "done": {
+                "type": "number"
+            },
+            "active": {
+                "type": "number"
+            },
+            "of": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.CardProgressBar": {
+        "type": "I",
+        "fields": {
+            "pct": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.CardStatus": {
+        "type": "I",
+        "fields": {
+            "text": {
+                "type": "string"
+            },
+            "busy": {
+                "type": "boolean"
+            },
+            "failed": {
+                "type": "boolean"
+            },
+            "counter": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.ResultTone": {
+        "type": "E",
+        "values": [
+            "RESULT_TONE_UNSPECIFIED",
+            "RESULT_TONE_UP",
+            "RESULT_TONE_DOWN",
+            "RESULT_TONE_NEUTRAL"
+        ]
+    },
+    "pushwoosh.uds.onyx.v1.CardResult": {
+        "type": "I",
+        "fields": {
+            "num": {
+                "type": "string"
+            },
+            "label": {
+                "type": "string"
+            },
+            "uplift": {
+                "type": "string"
+            },
+            "tone": {
+                "type": "pushwoosh.uds.onyx.v1.ResultTone"
+            },
+            "stats": {
+                "type": "pushwoosh.uds.onyx.v1.CardStat",
+                "array": true
+            },
+            "pending": {
+                "type": "boolean"
+            },
+            "summary": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.CardStat": {
+        "type": "I",
+        "fields": {
+            "k": {
+                "type": "string"
+            },
+            "v": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.ActionColor": {
+        "type": "E",
+        "values": [
+            "ACTION_COLOR_UNSPECIFIED",
+            "ACTION_COLOR_PRIMARY",
+            "ACTION_COLOR_SECONDARY"
+        ]
+    },
+    "pushwoosh.uds.onyx.v1.CardAction": {
+        "type": "I",
+        "fields": {
+            "label": {
+                "type": "string"
+            },
+            "transition": {
+                "type": "string"
+            },
+            "color": {
+                "type": "pushwoosh.uds.onyx.v1.ActionColor"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.BoardColumn": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "string"
+            },
+            "title": {
+                "type": "string"
+            },
+            "sum": {
+                "type": "number",
+                "optional": true
+            },
+            "cards": {
+                "type": "pushwoosh.uds.onyx.v1.Card",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.BoardGoal": {
+        "type": "I",
+        "fields": {
+            "id": {
+                "type": "number"
+            },
+            "metric": {
+                "type": "string"
+            },
+            "unit": {
+                "type": "string"
+            },
+            "currency": {
+                "type": "string"
+            },
+            "target": {
+                "type": "number"
+            },
+            "periodStart": {
+                "type": "Date"
+            },
+            "periodEnd": {
+                "type": "Date"
+            },
+            "summary": {
+                "type": "string"
+            },
+            "value": {
+                "type": "number"
+            },
+            "proven": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.BoardPulse": {
+        "type": "I",
+        "fields": {
+            "nextWakeAt": {
+                "type": "Date"
+            },
+            "plannedCount": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.GetBoardRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "includeHidden": {
+                "type": "boolean"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.GetBoardResponse": {
+        "type": "I",
+        "fields": {
+            "goal": {
+                "type": "pushwoosh.uds.onyx.v1.BoardGoal"
+            },
+            "columns": {
+                "type": "pushwoosh.uds.onyx.v1.BoardColumn",
+                "array": true
+            },
+            "planned": {
+                "type": "pushwoosh.uds.onyx.v1.Card",
+                "array": true
+            },
+            "pulse": {
+                "type": "pushwoosh.uds.onyx.v1.BoardPulse"
+            },
+            "pendingForUser": {
+                "type": "number"
+            },
+            "hidden": {
+                "type": "pushwoosh.uds.onyx.v1.Card",
+                "array": true
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.MoveCardRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "cardId": {
+                "type": "number"
+            },
+            "transition": {
+                "type": "string"
+            },
+            "patch": {
+                "type": "JsonObject"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.MoveCardResponse": {
+        "type": "I",
+        "fields": {
+            "card": {
+                "type": "pushwoosh.uds.onyx.v1.Card"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.OpenCardChatRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            },
+            "cardId": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.OpenCardChatResponse": {
+        "type": "I",
+        "fields": {
+            "chatId": {
+                "type": "number"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.GetAgentAccessRequest": {
+        "type": "I",
+        "fields": {
+            "application": {
+                "type": "string"
+            }
+        }
+    },
+    "pushwoosh.uds.onyx.v1.GetAgentAccessResponse": {
+        "type": "I",
+        "fields": {
+            "enabled": {
+                "type": "boolean"
+            },
+            "hasGoal": {
+                "type": "boolean"
+            }
+        }
     }
 };

package/index.d.ts

@@ -3,11 +3,13 @@ import { AiGenService as pushwoosh_aigen_v1_AiGenService } from './pushwoosh_aig
 import { AssistantService as pushwoosh_accounts_assistant_v1_AssistantService } from './pushwoosh_accounts_assistant_v1';
 import { TemplatesService as pushwoosh_templates_v1_TemplatesService } from './pushwoosh_templates_v1';
 import { AgentProfileService as pushwoosh_uds_onyx_v1_AgentProfileService } from './pushwoosh_uds_onyx_v1';
+import { BoardService as pushwoosh_uds_onyx_v1_BoardService } from './pushwoosh_uds_onyx_v1';
 export type API = {
     agentRunner: pushwoosh_agentrunner_v1_AgentRunner;
     aiGen: pushwoosh_aigen_v1_AiGenService;
     assistant: pushwoosh_accounts_assistant_v1_AssistantService;
     templates: pushwoosh_templates_v1_TemplatesService;
     agentProfile: pushwoosh_uds_onyx_v1_AgentProfileService;
+    board: pushwoosh_uds_onyx_v1_BoardService;
 };
 export { data } from './data';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pushwoosh/rpc-gateway-ai-assistant",
-    "version": "0.1.599",
+    "version": "0.1.601",
     "description": "AI Assistant api gateway HTTP API Types and Data",
     "main": "index.js",
     "module": "index.js",

package/pushwoosh_uds_onyx_v1.d.ts

@@ -1,6 +1,182 @@
+import { RpcMethod, JsonObject } from './commonTypes';
 /**
  * AgentProfileService turns the marketing agent on per application (ai_agent_profiles).
  * Private port :9191 only: identity comes from account-id / user-id metadata.
  */
 export interface AgentProfileService {
 }
+export type BoardService_GetBoard = RpcMethod<GetBoardRequest, GetBoardResponse>;
+export type BoardService_MoveCard = RpcMethod<MoveCardRequest, MoveCardResponse>;
+export type BoardService_OpenCardChat = RpcMethod<OpenCardChatRequest, OpenCardChatResponse>;
+export type BoardService_GetAgentAccess = RpcMethod<GetAgentAccessRequest, GetAgentAccessResponse>;
+/**
+ * BoardService is the marketing agent's board: cards laid out in columns, each rendered by its kind.
+ * Public port; the account and application come from the caller's auth.
+ */
+export interface BoardService {
+    GetBoard: BoardService_GetBoard;
+    /** Applies one of the card's view.actions; any other transition is FailedPrecondition. */
+    MoveCard: BoardService_MoveCard;
+    /** The chat that last touched the card; with none, the application's advisor chat. */
+    OpenCardChat: BoardService_OpenCardChat;
+    GetAgentAccess: BoardService_GetAgentAccess;
+}
+export type Card = {
+    id: number;
+    kind: string;
+    state: string;
+    /** agent | user | system | closed */
+    owner: string;
+    /** A GetBoardResponse.columns id; empty for planned and hidden cards. */
+    column: string;
+    goalId: number;
+    parentId: number;
+    chatId: number;
+    skill: string;
+    createdAt: Date;
+    updatedAt: Date;
+    view: CardView;
+};
+/** CardView is the whole card as the board draws it; every layer is optional. */
+export type CardView = {
+    label: string;
+    title: string;
+    description: string;
+    parent: CardParent;
+    chips: string[];
+    dates: CardDates;
+    progress: CardProgress;
+    status: CardStatus;
+    note: string;
+    error: string;
+    result: CardResult;
+    actions: CardAction[];
+};
+/** The card this one is a new version of. */
+export type CardParent = {
+    id: number;
+    title: string;
+};
+export type CardDates = {
+    left: string;
+    right: string;
+    /** Draws the dates as a warning, e.g. a decision about to expire. */
+    warn: boolean;
+};
+export type CardProgress_kind_segments = {
+    type: 'segments';
+    data: CardProgressSegments;
+};
+export type CardProgress_kind_bar = {
+    type: 'bar';
+    data: CardProgressBar;
+};
+export type CardProgress_kind = CardProgress_kind_segments | CardProgress_kind_bar;
+export type CardProgress = {
+    kind: CardProgress_kind;
+};
+/** "Job 2 of 6": done segments, then active ones, out of `of`. */
+export type CardProgressSegments = {
+    done: number;
+    active: number;
+    of: number;
+};
+export type CardProgressBar = {
+    /** 0..100 */
+    pct: number;
+};
+export type CardStatus = {
+    text: string;
+    busy: boolean;
+    failed: boolean;
+    /** The right-hand side of the status line, e.g. "Day 1 of 12". */
+    counter: string;
+};
+export type ResultTone = 'RESULT_TONE_UNSPECIFIED' | 'RESULT_TONE_UP' | 'RESULT_TONE_DOWN' | 'RESULT_TONE_NEUTRAL';
+export type CardResult = {
+    num: string;
+    label: string;
+    uplift: string;
+    tone: ResultTone;
+    stats: CardStat[];
+    /** Measured but not final yet. */
+    pending: boolean;
+    summary: string;
+};
+export type CardStat = {
+    k: string;
+    v: string;
+};
+export type ActionColor = 'ACTION_COLOR_UNSPECIFIED' | 'ACTION_COLOR_PRIMARY' | 'ACTION_COLOR_SECONDARY';
+export type CardAction = {
+    label: string;
+    /** The state MoveCard takes; empty means the button opens the card's chat (OpenCardChat). */
+    transition: string;
+    color: ActionColor;
+};
+export type BoardColumn = {
+    id: string;
+    title: string;
+    /** Sum of payload.result.value of the column's cards; unset when none carries one. */
+    sum?: number;
+    cards: Card[];
+};
+export type BoardGoal = {
+    id: number;
+    metric: string;
+    unit: string;
+    currency: string;
+    target: number;
+    periodStart: Date;
+    periodEnd: Date;
+    summary: string;
+    /** Sums of payload.result.value / payload.result.proven over the goal's closed cards. */
+    value: number;
+    proven: number;
+};
+export type BoardPulse = {
+    /** The earliest wake-up of an agent card; unset when none is scheduled. */
+    nextWakeAt: Date;
+    plannedCount: number;
+};
+export type GetBoardRequest = {
+    application: string;
+    includeHidden: boolean;
+};
+export type GetBoardResponse = {
+    /** Unset when the application has no active goal. */
+    goal: BoardGoal;
+    columns: BoardColumn[];
+    /** Agent cards outside every column, newest first. */
+    planned: Card[];
+    pulse: BoardPulse;
+    /** Cards waiting for the user across all columns. */
+    pendingForUser: number;
+    /** Filled only with include_hidden. */
+    hidden: Card[];
+};
+export type MoveCardRequest = {
+    application: string;
+    cardId: number;
+    transition: string;
+    /** Merged into the card's payload (RFC 7386). */
+    patch: JsonObject;
+};
+export type MoveCardResponse = {
+    card: Card;
+};
+export type OpenCardChatRequest = {
+    application: string;
+    cardId: number;
+};
+export type OpenCardChatResponse = {
+    chatId: number;
+};
+export type GetAgentAccessRequest = {
+    application: string;
+};
+export type GetAgentAccessResponse = {
+    /** An enabled agent profile and the account's consent. */
+    enabled: boolean;
+    hasGoal: boolean;
+};