@pitcher/js-api 1.22.0-beta.3 → 1.22.0-beta.5

package/lib/sdk/api/modules/ui/index.d.ts

@@ -113,6 +113,7 @@ declare function onAppUpdateData(handler: (data: UiAppUpdateDataPayload) => Prom
  */
 declare function uiBroadcast(payload: UiBroadcastRequest): Promise<void>;
 declare const _default: {
+    promptPia(payload: import('../../../../main.lib').UiPromptPiaRequest): Promise<import('../../../../main.lib').UiPromptPiaResponse>;
     completePostcall(payload: import('../../../../main.lib').UiCompletePostcallRequest): Promise<void>;
     cancelMeeting(): Promise<void>;
     resumeMeeting(): Promise<void>;

package/lib/sdk/api/modules/ui/pia.ui.d.ts

@@ -1,8 +1,18 @@
 import { UiPromptPiaRequest, UiPromptPiaResponse } from './types.ui';
 /**
- * Prompts Pitcher Intelligent Assistant (PIA) with your query.
+ * Sends a query to the Pitcher Intelligent Assistant (PIA) and handles the streamed response.
  *
  * @example
+ * // Subscribe to PIA's streamed responses
+ * const cleanup = await useUi().on(
+ *   UI_MESSAGE_TYPES.UI_PROMPT_PIA_RESPONSE_STREAMED,
+ *   async ({ chunk, partial_response }) => {
+ *     console.log('PIA response chunk:', chunk);
+ *     console.log('PIA partial response:', partial_response);
+ *   }
+ * );
+ * // Prompt PIA with a question and ensure cleanup is called afterwards
  * useUi().promptPia({ prompt: "What's my most presented file?" })
+ *   .finally(cleanup);
  */
 export declare function promptPia(payload: UiPromptPiaRequest): Promise<UiPromptPiaResponse>;

package/lib/sdk/api/modules/ui/types.ui.d.ts

@@ -39,7 +39,7 @@ export declare const UI_MESSAGE_TYPES: {
     readonly UI_SECTION_LIST_UPDATED: "ui_section_list_updated";
     readonly UI_APP_SET_DATA: "ui_app_set_data";
     readonly UI_APP_UPDATE_DATA: "ui_app_update_data";
-    readonly UI_PROMPT_RESPONSE_STREAMED: "ui_prompt_response_streamed";
+    readonly UI_PROMPT_PIA_RESPONSE_STREAMED: "ui_prompt_pia_response_streamed";
 };
 export declare const UI_NATIVE_MESSAGE_TYPES: readonly ["ui_app_set_data", "ui_app_update_data", "ui_canvas_updated"];
 export type UiBroadcastRequest = Record<string, any>;
@@ -140,7 +140,7 @@ export type UiMessagePayloads = {
     [UI_MESSAGE_TYPES.UI_APP_UPDATE_DATA]: UiAppUpdateDataPayload;
     [UI_MESSAGE_TYPES.UI_CANVAS_UPDATED]: UiCanvasUpdatedPayload;
     [UI_MESSAGE_TYPES.UI_SECTION_LIST_UPDATED]: UiSectionListUpdatedPayload;
-    [UI_MESSAGE_TYPES.UI_PROMPT_RESPONSE_STREAMED]: UiPromptResponseStreamedPayload;
+    [UI_MESSAGE_TYPES.UI_PROMPT_PIA_RESPONSE_STREAMED]: UiPromptPiaResponseStreamedPayload;
 };
 export type UiMessageEnvelope<T extends (typeof UI_MESSAGE_TYPES)[keyof typeof UI_MESSAGE_TYPES] = (typeof UI_MESSAGE_TYPES)[keyof typeof UI_MESSAGE_TYPES]> = {
     /** Message type */
@@ -198,7 +198,7 @@ export type UiSectionListUpdatedPayload = {
     /** Canvas data */
     canvas: CanvasRetrieve | null;
 };
-export type UiPromptResponseStreamedPayload = {
+export type UiPromptPiaResponseStreamedPayload = {
     /** PIA response so far */
     partial_response: string;
     /** Current chunk of the response */

package/lib/sdk/main.d.ts

@@ -24,6 +24,7 @@ export declare function usePitcherApi(options?: ApiOptions): ReturnType<typeof c
  * @returns UI API object with methods described below.
  */
 export declare function useUi(): {
+    promptPia(payload: import('./api/modules/ui/types.ui').UiPromptPiaRequest): Promise<import('./api/modules/ui/types.ui').UiPromptPiaResponse>;
     completePostcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
     cancelMeeting(): Promise<void>;
     resumeMeeting(): Promise<void>;
@@ -311,6 +312,7 @@ export declare function useApi(options?: ApiOptions): {
     on: (type: typeof import('./api/modules/dsr/types.dsr').DSR_MESSAGE_TYPES[keyof typeof import('./api/modules/dsr/types.dsr').DSR_MESSAGE_TYPES], handler: (data: import('./api/modules/dsr/types.dsr').DsrMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
 } | {
     ui: {
+        promptPia(payload: import('./api/modules/ui/types.ui').UiPromptPiaRequest): Promise<import('./api/modules/ui/types.ui').UiPromptPiaResponse>;
         completePostcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
         cancelMeeting(): Promise<void>;
         resumeMeeting(): Promise<void>;
@@ -476,6 +478,7 @@ export declare function useApi(options?: ApiOptions): {
         openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
         API: import('./api/LowLevelApi').LowLevelApi;
     };
+    promptPia(payload: import('./api/modules/ui/types.ui').UiPromptPiaRequest): Promise<import('./api/modules/ui/types.ui').UiPromptPiaResponse>;
     completePostcall(payload: import('./api/modules/ui/types.ui').UiCompletePostcallRequest): Promise<void>;
     cancelMeeting(): Promise<void>;
     resumeMeeting(): Promise<void>;

package/lib/util/network.d.ts

@@ -13,3 +13,4 @@ export declare function derivePatchRequestFields<T extends object>(current: T, u
     updatedFields: string[];
     payload: Partial<T>;
 };
+export declare function requestStream(url: string, body: Record<string, any>, token: string, onStreamedChunk?: (chunk: string, response: string) => void): Promise<string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.22.0-beta.3",
+  "version": "1.22.0-beta.5",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",