@pitcher/js-api 1.22.0-alpha.6 → 1.22.0-beta.1

package/lib/sdk/interfaces.d.ts

@@ -1,6 +1,7 @@
 import { Emitter } from './utils/eventEmitter';
-import { Favorite, File, Instance, User, Canvas } from '../../types/openapi';
+import { Favorite, File, User, CanvasRetrieve } from '../../types/openapi';
 import { PitcherOrg } from '../types/organization.types';
+import { PitcherInstance } from '../types/instance.types';
 import { PaginatedData } from '../types/paginatedData';
 import { LaunchDarklyEnv } from '../types/launchDarkly.types';
 import { CLIENT_TYPE } from '../constants/cdp.const';
@@ -34,7 +35,7 @@ export interface PitcherEnv {
     pitcher: {
         token_claims: Record<string, any>;
         organization: PitcherOrg;
-        instance: Instance;
+        instance: PitcherInstance;
         user: User;
         access_token: string;
         id_token: string;
@@ -53,6 +54,7 @@ export interface PitcherResponse {
     request: {
         id: string;
         type: string;
+        body?: Record<string, any>;
     };
     response: {
         status: PitcherResponseStatus;
@@ -109,54 +111,171 @@ export declare enum PitcherExternalEventName {
     OPEN_CANVAS = "open_canvas",
     START_CALL = "start_call"
 }
+/**
+ * Base interface for update location actions.
+ */
 interface UpdateLocation {
+    /**
+     * The action to be performed.
+     */
     action: string;
 }
+/**
+ * Represents a route in the location.
+ */
 export interface LocationRoute {
+    /**
+     * The path of the route.
+     */
     path: string;
+    /**
+     * The query parameters of the route.
+     */
     query: Record<string, any>;
+    /**
+     * Indicates if the route is being restored.
+     */
     is_restoring: boolean;
+    /**
+     * Indicates if the route is mounted.
+     */
     is_mounted: boolean;
 }
+/**
+ * A record of location routes.
+ */
 export type LocationRoutes = Record<string, LocationRoute>;
+/**
+ * Interface for the 'register' update location action.
+ */
 export interface UpdateLocationOnRegister extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'register';
+    /**
+     * The child application identifier.
+     */
     child_app: string;
+    /**
+     * The parent application identifier (optional).
+     */
     parent_app?: string;
+    /**
+     * The path of the route (optional).
+     */
     path?: string;
+    /**
+     * The query parameters of the route (optional).
+     */
     query?: Record<string, any>;
 }
+/**
+ * Interface for the 'unregister' update location action.
+ */
 export interface UpdateLocationOnUnregister extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'unregister';
+    /**
+     * The application identifier.
+     */
     app: string;
 }
+/**
+ * Interface for the 'update' update location action.
+ */
 export interface UpdateLocationOnUpdate extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'update';
+    /**
+     * The routes to be updated.
+     */
     routes: Record<string, Omit<LocationRoute, 'is_restoring' | 'is_mounted'>>;
 }
+/**
+ * Interface for the 'mounted' update location action.
+ */
 export interface UpdateLocationOnMounted extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'mounted';
+    /**
+     * The application identifier.
+     */
     app: string;
 }
+/**
+ * Interface for the 'restore' update location action.
+ */
 export interface UpdateLocationOnRestore extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'restore';
+    /**
+     * The routes to be restored.
+     */
     routes: Record<string, Omit<LocationRoute, 'is_mounted'>>;
 }
+/**
+ * Interface for the 'restore_completed' update location action.
+ */
 export interface UpdateLocationOnRestoreCompleted extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'restore_completed';
+    /**
+     * The application identifier.
+     */
     app: string;
+    /**
+     * The path of the route.
+     */
     path: string;
+    /**
+     * The query parameters of the route.
+     */
     query: Record<string, any>;
 }
+/**
+ * Interface for the 'get_routes_request' update location action.
+ */
 export interface UpdateLocationOnGetRoutesRequest extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'get_routes_request';
+    /**
+     * The application identifier.
+     */
     app: string;
 }
+/**
+ * Interface for the 'get_routes_response' update location action.
+ */
 export interface UpdateLocationOnGetRoutesResponse extends UpdateLocation {
+    /**
+     * The action type.
+     */
     action: 'get_routes_response';
+    /**
+     * The application identifier.
+     */
     app: string;
+    /**
+     * The routes in the response.
+     */
     routes: LocationRoutes;
 }
+/**
+ * Union type for all update location pitcher events.
+ */
 export type UpdateLocationPitcherEvent = UpdateLocationOnUnregister | UpdateLocationOnRestore | UpdateLocationOnUpdate | UpdateLocationOnRegister | UpdateLocationOnRestoreCompleted | UpdateLocationOnMounted | UpdateLocationOnGetRoutesRequest | UpdateLocationOnGetRoutesResponse;
 export interface PitcherEventMap {
     [PitcherEventName.ENV_CHANGED]: PitcherEnv;
@@ -202,7 +321,7 @@ export interface PitcherEventMap {
      */
     [PitcherEventName.EXITED_FULLSCREEN]: void;
     [PitcherEventName.CANVAS_UPDATED]: Record<string, any>;
-    [PitcherEventName.CANVAS_UPDATED_SUCCESS]: Partial<Canvas>;
+    [PitcherEventName.CANVAS_UPDATED_SUCCESS]: Partial<CanvasRetrieve>;
     [PitcherEventName.UPDATE_LOCATION]: UpdateLocationPitcherEvent;
     [PitcherEventName.FILE_CLOSED]: {
         file_id?: string;