@iblai/iblai-js 1.26.10 → 1.26.11

package/dist/data-layer/playwright/human-support-tab-helpers.d.ts

@@ -0,0 +1,262 @@
+import { Locator, Page } from '@playwright/test';
+/**
+ * Support tab helpers — Playwright bindings for the `AgentHumanSupportTab`
+ * component from `@iblai/web-containers` (Edit Agent modal → Runtime →
+ * Support).
+ *
+ * All UI strings below mirror `AGENT_HUMAN_SUPPORT_TAB_LABELS` from
+ * `@iblai/web-containers/next`. If a consumer renames a label via the
+ * `labels` prop, override these constants per spec — don't edit this file.
+ *
+ * Scoping rule (see playwright-testing skill §12): capture the Edit Agent
+ * dialog FIRST via `getEditAgentDialog(page)`, then resolve every in-panel
+ * locator from that dialog. Radix portals (select option lists, popover
+ * contents) render OUTSIDE the dialog subtree — those queries intentionally
+ * run on the `page` and are commented as such.
+ */
+export declare const SUPPORT_LABELS: {
+    /** Sidebar segment label (host app) + tab panel value. */
+    readonly tabName: "Support";
+    /** The host sidebar trigger's `aria-controls` panel id suffix. */
+    readonly panelValue: "human_support";
+    /** Category strip pill that hosts the Support segment. */
+    readonly navCategory: "Runtime";
+    readonly header: {
+        readonly title: "Support";
+        readonly description: "Review and respond to support requests submitted for this agent.";
+    };
+    readonly toggle: {
+        /** `aria-label` on the availability switch in the info box. */
+        readonly enable: "Enable support";
+    };
+    readonly filters: {
+        readonly searchUser: "Search for User";
+        readonly searchUsersPlaceholder: "Search users...";
+        readonly allUsers: "All Users";
+        readonly allStatuses: "All Statuses";
+    };
+    readonly status: {
+        readonly open: "Open";
+        readonly inProgress: "In Progress";
+        readonly closed: "Closed";
+    };
+    readonly list: {
+        readonly noTickets: "No support tickets found";
+        readonly untitled: "Support request";
+        /** `aria-label` of the ticket-list region. */
+        readonly regionLabel: "Support ticket list";
+    };
+    readonly detail: {
+        readonly selectPrompt: "Select a ticket to view details.";
+        readonly statusLabel: "Status";
+        readonly requestSection: "Request";
+        readonly conversationSection: "Conversation";
+        readonly supportTeam: "Support Team";
+        readonly noMessages: "No replies yet.";
+        readonly replyPlaceholder: "Write a reply to the user…";
+        readonly sendReply: "Send Reply";
+        readonly closedNotice: "This ticket is closed. Set it back to Open or In Progress to reply.";
+        /** `aria-label` of the ticket-detail region. */
+        readonly regionLabel: "Support ticket details";
+    };
+    readonly testIds: {
+        readonly infoBox: "human-support-info-box";
+        readonly toggle: "human-support-toggle";
+        readonly ticketList: "human-support-ticket-list";
+        readonly ticketDetail: "human-support-ticket-detail";
+        readonly ticketDescription: "human-support-ticket-description";
+        /** Ticket rows render as `human-support-ticket-item-<id>`. */
+        readonly ticketItemPrefix: "human-support-ticket-item-";
+    };
+    readonly chat: {
+        /** Accessible name of the chat textbox in the host app. */
+        readonly inputName: "Ask anything";
+        readonly sendButton: "Send message";
+        /** Stable class markers from `CSS_CLASS_NAMES.CHAT` in web-containers. */
+        readonly userQueryClass: ".chat-user-message-query";
+        readonly aiResponseClass: ".chat-ai-message-response";
+        readonly stopStreamingClass: ".chat-stop-streaming-button";
+    };
+};
+/** The three ticket statuses accepted by `setTicketStatus` / filters. */
+export type SupportTicketStatus = keyof typeof SUPPORT_LABELS.status;
+/**
+ * Capture the Edit Agent dialog itself. Every other helper resolves its
+ * locators from this dialog, so in-panel controls never collide with
+ * elements mounted on the page behind the modal.
+ *
+ * The dialog carries no stable test id in the host, so it is identified by
+ * its visible title ("Edit Agent" by default — override for hosts that
+ * rename the modal).
+ */
+export declare function getEditAgentDialog(page: Page, dialogTitle?: string): Locator;
+/**
+ * Check whether the Support tab is currently reachable in the Edit Agent
+ * dialog. Returns false instead of throwing so callers can guard
+ * permission-gated hosts (the segment is admin-only).
+ */
+export declare function isSupportTabVisible(page: Page): Promise<boolean>;
+/**
+ * The host sidebar trigger for the Support segment. Matched by its
+ * `aria-controls="panel-human_support"` (stable across label renames);
+ * `:visible` excludes the hidden responsive twin the host renders for the
+ * other breakpoint.
+ */
+export declare function getSupportTabTrigger(dialog: Locator): Locator;
+/**
+ * Switch to the Support tab. Assumes the Edit Agent dialog is open.
+ * Returns the dialog locator so callers can keep every follow-up query
+ * scoped without re-capturing it.
+ */
+export declare function switchToSupportTab(page: Page): Promise<Locator>;
+/** The info box at the top of the pane (conversational description). */
+export declare function getSupportInfoBox(dialog: Locator): Locator;
+/**
+ * The availability switch inside the info box — the same "human support"
+ * tool toggle exposed on the Tools tab. Hidden when the tenant's tool
+ * catalog has no human-support tool.
+ */
+export declare function getSupportToggle(dialog: Locator): Locator;
+/** Read the current on/off state of the availability toggle. */
+export declare function isSupportEnabled(dialog: Locator): Promise<boolean>;
+/**
+ * Flip the availability toggle to the requested state (no-op when already
+ * there). Waits for `aria-checked` to settle, which tracks the persisted
+ * mentor-settings round trip.
+ */
+export declare function setSupportEnabled(dialog: Locator, enabled: boolean): Promise<void>;
+/** Turn the support tool on. */
+export declare function enableSupport(dialog: Locator): Promise<void>;
+/** Turn the support tool off. */
+export declare function disableSupport(dialog: Locator): Promise<void>;
+/** The ticket-list region. Only mounted when at least one ticket exists. */
+export declare function getTicketList(dialog: Locator): Locator;
+/**
+ * A ticket row matched by (a substring of) its subject. Rows carry
+ * `data-testid="human-support-ticket-item-<id>"`; the id is server-side,
+ * so text matching within the list is the stable route for specs.
+ */
+export declare function getTicketRow(dialog: Locator, subject: string | RegExp): Locator;
+/** A ticket row by its zero-based position in the list. */
+export declare function getTicketRowByIndex(dialog: Locator, index: number): Locator;
+/** Assert a ticket with the given subject text is listed. */
+export declare function expectTicketInList(dialog: Locator, subject: string | RegExp, timeoutMs?: number): Promise<void>;
+/** Assert the empty state ("No support tickets found") is shown. */
+export declare function expectNoTickets(dialog: Locator): Promise<void>;
+/** Assert a listed ticket row shows the expected status badge. */
+export declare function expectTicketStatusInList(dialog: Locator, subject: string | RegExp, status: SupportTicketStatus): Promise<void>;
+/** The status-filter trigger next to the user search. */
+export declare function getStatusFilter(dialog: Locator): Locator;
+/**
+ * Filter the list by ticket status ('all' clears the filter). Changing
+ * the filter re-queries the backend, so this doubles as a refresh hook.
+ */
+export declare function filterTicketsByStatus(dialog: Locator, status: SupportTicketStatus | 'all'): Promise<void>;
+/** The "Search for User" combobox trigger (opens the requester popover). */
+export declare function getUserFilter(dialog: Locator): Locator;
+/**
+ * Filter the list by requester. Types `search` into the popover's search
+ * box, then clicks the entry whose label (email, else username) matches
+ * `optionText`.
+ */
+export declare function filterTicketsByUser(dialog: Locator, search: string, optionText?: string | RegExp): Promise<void>;
+/** Clear the requester filter via the "All Users" popover entry. */
+export declare function clearUserFilter(dialog: Locator): Promise<void>;
+/**
+ * Force the ticket list to re-query by bouncing the status filter
+ * (all → open → all). Each argument change issues a fresh request for
+ * uncached filter combinations, which is how specs pick up tickets
+ * created out-of-band (e.g. by the agent during a chat).
+ */
+export declare function refreshTickets(dialog: Locator): Promise<void>;
+/**
+ * Wait for a ticket to appear in the list, refreshing between polls.
+ * Agent-created tickets land after the chat tool call completes
+ * server-side, so allow a generous deadline.
+ *
+ * Pass `opts.refresh` to override the default status-filter bounce with a
+ * stronger strategy (e.g. close and re-open the modal, or reload the page
+ * and navigate back) — the callback runs between polls and must leave the
+ * Support tab open.
+ */
+export declare function waitForTicketInList(dialog: Locator, subject: string | RegExp, opts?: {
+    timeoutMs?: number;
+    refresh?: () => Promise<void>;
+}): Promise<void>;
+/** The detail pane (desktop two-column layout). */
+export declare function getTicketDetail(dialog: Locator): Locator;
+/** The rendered ticket body (HTML/Markdown/plain, already formatted). */
+export declare function getTicketDescription(dialog: Locator): Locator;
+/**
+ * Open a ticket from the list and wait for its detail to render. Returns
+ * the detail pane locator for chained assertions.
+ */
+export declare function openTicket(dialog: Locator, subject: string | RegExp): Promise<Locator>;
+/** Assert the opened ticket's rendered body contains the given text. */
+export declare function expectTicketDescriptionContains(dialog: Locator, text: string | RegExp): Promise<void>;
+/**
+ * Change the opened ticket's status via the detail pane's Status select.
+ * Selecting "Closed" routes through the dedicated close endpoint and
+ * replaces the composer with the closed notice.
+ */
+export declare function setTicketStatus(dialog: Locator, status: SupportTicketStatus): Promise<void>;
+/** Assert the closed notice is shown (composer hidden). */
+export declare function expectTicketClosedNotice(dialog: Locator): Promise<void>;
+/** The reply composer textarea in the opened ticket. */
+export declare function getReplyComposer(dialog: Locator): Locator;
+/**
+ * Send a reply on the opened ticket and wait for the composer to clear
+ * (the component empties it only after the API call succeeds).
+ */
+export declare function replyToTicket(dialog: Locator, message: string): Promise<void>;
+/** Assert a message (from either side) is visible in the conversation. */
+export declare function expectMessageInConversation(dialog: Locator, message: string | RegExp): Promise<void>;
+/** Assert the opened ticket has no replies yet. */
+export declare function expectNoRepliesYet(dialog: Locator): Promise<void>;
+/** The main chat textbox. */
+export declare function getChatInput(page: Page): Locator;
+/**
+ * Send a message to the agent from the main chat surface and wait for the
+ * user bubble to render. Does NOT wait for the AI response — pair with
+ * `waitForAgentChatResponse`.
+ */
+export declare function sendAgentChatMessage(page: Page, message: string): Promise<void>;
+/**
+ * Wait for the agent's reply to finish. LLM latency plus tool execution
+ * (the support-ticket tool call) makes this the slow step — default 90s.
+ * Returns the reply text for content assertions.
+ */
+export declare function waitForAgentChatResponse(page: Page, timeoutMs?: number): Promise<string>;
+/**
+ * Ask the agent (via chat) to open a support ticket with a distinctive
+ * subject, and wait for its reply. The explicit "subject" phrasing gives
+ * the support tool an exact string to file, which the spec then looks
+ * for in the ticket list.
+ */
+export declare function requestSupportTicketViaChat(page: Page, opts: {
+    subject: string;
+    description?: string;
+}): Promise<string>;
+/**
+ * Full flow: with support enabled, ask the agent for a ticket in chat,
+ * then verify it shows up in the Support tab.
+ *
+ * The Edit Agent modal is host-specific to open/close, so the caller
+ * provides `openEditAgentModal` (and optionally `closeEditAgentModal`,
+ * used to get the modal out of the chat's way before sending). Steps:
+ *
+ *  1. `openEditAgentModal()` → Support tab → ensure the toggle is ON.
+ *  2. `closeEditAgentModal()` (when provided) → chat-request the ticket.
+ *  3. `openEditAgentModal()` → Support tab → wait for the ticket row.
+ *
+ * Returns the dialog locator with the Support tab open and the new
+ * ticket listed, so specs can keep asserting (open it, reply, close it).
+ */
+export declare function createSupportTicketViaChatAndVerify(page: Page, opts: {
+    subject: string;
+    description?: string;
+    openEditAgentModal: () => Promise<void>;
+    closeEditAgentModal?: () => Promise<void>;
+    /** Deadline for the ticket to appear in the list (default 90s). */
+    listTimeoutMs?: number;
+}): Promise<Locator>;

package/dist/data-layer/playwright/index.d.ts

@@ -35,5 +35,6 @@ export { TASKS_LABELS, isTasksTabVisible, switchToTasksTab, getScheduleTaskButto
 export type { TaskRepeat, TaskStatus } from './tasks-tab-helpers';
 export * from './evaluation-tab-helpers';
 export * from './lti-tab-helpers';
+export * from './human-support-tab-helpers';
 export { createPlaywrightConfig, generateProjectConfig, generateBrowserSetupProjects, getBrowserKey, } from './playwright-config';
 export type { PlatformConfig, CreatePlaywrightConfigOptions } from './playwright-config';