@pitcher/js-api 1.19.0 → 1.20.0-beta.14

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

@@ -0,0 +1,115 @@
+import { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile } from '@content-selector/stores/app';
+import { Selection } from '@content-selector/appTypes';
+import { CanvasSection, ComponentNode, EmbeddableProps, SfEvent } from '../../../../main.lib';
+import { Mutable } from '../../../../types/ts';
+import { CanvasRetrieve, User } from '../../../../../types/openapi';
+import { OpenRequestPayload } from '../../../payload.types';
+
+export declare const UI_MESSAGE: "UI_MESSAGE";
+export declare const UI_API_METHOD_TYPES: {
+    readonly UI_BROADCAST: "ui_broadcast";
+    readonly UI_SELECT_CONTENT: "ui_select_content";
+    readonly UI_OPEN: "ui_open";
+    readonly UI_EMBEDDABLE_READY: "ui_embeddable_ready";
+    readonly UI_TOAST: "ui_toast";
+    readonly UI_CAPTURE_APP_ERROR: "ui_capture_app_error";
+    readonly UI_UPDATE_CANVAS: "ui_update_canvas";
+    readonly UI_OPEN_CANVAS_OVERLAY: "ui_open_canvas_overlay";
+    readonly UI_UPDATE_LOCATION: "ui_update_location";
+    readonly UI_PRESELECT_SFDC_MEETING_ID: "ui_preselect_sfdc_meeting_id";
+    readonly UI_SET_POSTCALL_STYLE: "ui_set_postcall_style";
+    readonly UI_ENABLE_POSTCALL_SUBMIT: "ui_enable_postcall_submit";
+    readonly UI_DISABLE_POSTCALL_SUBMIT: "ui_disable_postcall_submit";
+    readonly UI_COMPLETE_POSTCALL: "ui_complete_postcall";
+    readonly UI_CANVAS_NAVIGATE_NEXT_PAGE: "ui_canvas_navigate_next_page";
+    readonly UI_CANVAS_NAVIGATE_PREVIOUS_PAGE: "ui_canvas_navigate_previous_page";
+    readonly UI_CANVAS_NAVIGATE_PAGE: "ui_canvas_navigate_page";
+    readonly UI_APP_LOADED: "ui_app_loaded";
+    readonly UI_APP_RESIZE: "ui_app_resize";
+};
+export declare const UI_MESSAGE_TYPES: {
+    readonly UI_MEETING_CANCELED: "ui_meeting_canceled";
+    readonly UI_CANVAS_UPDATED: "ui_canvas_updated";
+    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";
+};
+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>;
+export type UiSelectContentRequest = {
+    selections?: Selection[];
+};
+export type UiSelectContentResponse = {
+    user_action: 'cancelled' | 'selected';
+    content?: (ContentSelectorSelectedFile | ContentSelectorSelectedPage)[];
+};
+export type UiCaptureAppErrorRequest = Record<string, any>;
+export type UiUpdateCanvasRequest = Mutable<CanvasRetrieve> & {
+    fields?: string;
+};
+export type UiOpenRequest = OpenRequestPayload;
+export type UiCompletePostcallRequest = {
+    was_successfully_submitted?: boolean;
+};
+export type UiSetPostcallStyleRequest = Record<string, any>;
+export type UiAppResizeRequest = {
+    height: number;
+};
+export type UiCanvasNavigatePageReuqest = {
+    page: ComponentNode['id'];
+};
+export interface UiToastRequest {
+    type: 'info' | 'error' | 'warning' | 'success' | 'loading';
+    message: string;
+    duration?: number;
+    closable?: boolean;
+    keepAliveOnHover?: boolean;
+    showIcon?: boolean;
+}
+export interface UiPreselectSfdcMeetingIdRequest {
+    eventId: string;
+}
+export interface UiPreselectSfdcMeetingIdResponse {
+    event: SfEvent | null;
+}
+export type UiMessagePayloads = {
+    [UI_MESSAGE_TYPES.UI_MEETING_CANCELED]: UiMeetingCanceledPayload;
+    [UI_MESSAGE_TYPES.UI_APP_SET_DATA]: UiAppSetDataPayload;
+    [UI_MESSAGE_TYPES.UI_APP_UPDATE_DATA]: UiAppUpdateDataPayload;
+    [UI_MESSAGE_TYPES.UI_CANVAS_UPDATED]: UiCanvasUpdatedPayload;
+    [UI_MESSAGE_TYPES.UI_SECTION_LIST_UPDATED]: UiSectionListUpdatedPayload;
+};
+export type UiMessageEnvelope<T extends (typeof UI_MESSAGE_TYPES)[keyof typeof UI_MESSAGE_TYPES] = (typeof UI_MESSAGE_TYPES)[keyof typeof UI_MESSAGE_TYPES]> = {
+    type: T;
+    body: UiMessagePayloads[T];
+};
+export type UiMeetingCanceledPayload = {
+    accountId?: string;
+    eventId?: string;
+};
+export type UiAppSetDataPayload = {
+    client: string | null;
+    platform: string | undefined;
+    user: User | null;
+    is_edit_mode: boolean;
+    in_call: boolean;
+    canvas: CanvasRetrieve;
+    used_in_section: CanvasSection | null;
+    component_id: string;
+    settings: EmbeddableProps['settings'] | null;
+    width: string | undefined;
+    height: string | undefined;
+    display_mode: string | undefined;
+};
+export type UiAppUpdateDataPayload = {
+    in_call: boolean;
+    is_edit_mode: boolean;
+};
+export type UiCanvasUpdatedPayload = {
+    canvas: CanvasRetrieve;
+};
+export type UiSectionListUpdatedPayload = {
+    section_list_ids: string[];
+    section_list_component_id: string;
+    canvas: CanvasRetrieve | null;
+};

package/lib/sdk/api/modules/users.d.ts

@@ -0,0 +1,7 @@
+import { GetUsersParams, RefreshServiceTokenResponse, RefreshServiceTokenRequest } from '../../../types/users';
+import { PaginatedData } from '../../../types/paginatedData';
+import { User } from '../../../../types/openapi';
+
+export declare function getUsers(payload?: GetUsersParams): Promise<PaginatedData<User>>;
+export declare function refreshServiceToken(payload?: RefreshServiceTokenRequest): Promise<RefreshServiceTokenResponse>;
+export declare function refreshAccessToken(): any;

package/lib/sdk/api/modules/webView.d.ts

@@ -0,0 +1,4 @@
+import { OpenWebViewAlwaysOnTop } from '../../payload.types';
+
+export declare function close(): Promise<any>;
+export declare function openWebViewAlwaysOnTop(payload: OpenWebViewAlwaysOnTop): Promise<void>;

package/lib/sdk/api/onlineRestApiHandlers.d.ts

@@ -0,0 +1,4 @@
+import { PitcherEnv } from '../interfaces';
+
+export declare const setEnv: (e: PitcherEnv) => void;
+export declare const onlineRestApiHandlers: Record<string, any>;

package/lib/sdk/interfaces.d.ts

@@ -0,0 +1,232 @@
+import { Emitter } from './utils/eventEmitter';
+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';
+
+export declare const PITCHER_EVENT: "PITCHER_EVENT";
+export declare enum PitcherMessageType {
+    REQUEST = "PITCHER_REQUEST",
+    RESPONSE = "PITCHER_RESPONSE"
+}
+export declare enum PitcherResponseStatus {
+    OK = "ok",
+    ERROR = "error"
+}
+export interface PitcherMessage {
+    type: typeof PITCHER_EVENT;
+    request: {
+        id: string;
+        type: string;
+        body?: Record<string, any>;
+    };
+}
+type FetchMode = 'postmessage' | 'prefer-online';
+export interface ApiOptions {
+    errorLogger?: (p: any) => string | void;
+    logLevel?: 'off' | 'info' | 'debug';
+    casing?: 'camel' | 'snake';
+    fetchMode?: FetchMode;
+}
+export interface PitcherEnv {
+    mode: 'WEB' | 'IOS' | 'WINDOWS' | 'ANDROID';
+    pitcher: {
+        token_claims: Record<string, any>;
+        organization: PitcherOrg;
+        instance: PitcherInstance;
+        user: User;
+        access_token: string;
+        id_token: string;
+    };
+    launch_darkly?: LaunchDarklyEnv;
+    client_type?: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
+}
+export interface PitcherAPI extends Emitter<ApiEventMap> {
+    request(type: string, body: any, callback: () => any): Promise<PitcherResponse>;
+}
+export interface PitcherInterface extends Emitter<PitcherEventMap> {
+    API: PitcherAPI;
+}
+export interface PitcherResponse {
+    type: PitcherMessageType.RESPONSE;
+    request: {
+        id: string;
+        type: string;
+        body?: Record<string, any>;
+    };
+    response: {
+        status: PitcherResponseStatus;
+        body?: Record<string, any>;
+    };
+}
+export interface OpenCanvasPitcherEvent {
+    account_id?: string;
+    account_name?: string;
+    canvas_id?: string;
+    edit_mode?: 'true' | 'false';
+}
+export interface CreateAndOpenCanvasEvent {
+    account_id?: string;
+}
+export interface StartCallPitcherEvent {
+    account?: {
+        id: string;
+        name: string;
+    };
+    contact_ids?: string[];
+    canvas_id?: string;
+    edit_mode?: 'true' | 'false';
+    post_action?: string;
+    post_action_path?: string;
+}
+export declare enum PitcherEventName {
+    ENV_CHANGED = "env_changed",
+    PHOTOS_CAPTURED = "photos_captured",
+    FILE_DOWNLOADED = "file_downloaded",
+    FILE_UPLOAD_PROGRESS = "file_upload_progress",
+    UPDATE_LOCATION = "update_location",
+    CANVAS_UPDATED = "canvas_updated",
+    CANVAS_UPDATED_SUCCESS = "canvas_updated_success",
+    FILE_CLOSED = "file_closed",
+    APP_BACKGROUNDED = "app_backgrounded",
+    APP_FOREGROUNDED = "app_foregrounded",
+    NON_FILES_SYNC_FINISHED = "non_files_sync_finished",
+    CONTENT_LIST_REFRESH_REQUESTED = "content_list_refresh_requested",
+    NETWORK_CONNECTION_ESTABLISHED = "network_connection_established",
+    NETWORK_CONNECTION_LOST = "network_connection_lost",
+    ENTERED_FULLSCREEN = "entered_fullscreen",
+    EXITED_FULLSCREEN = "exited_fullscreen",
+    SUBMIT_POSTCALL_CLICKED = "submit_postcall_clicked"
+}
+export declare enum PitcherBroadcastedEventName {
+    UI_SHOW_MODAL = "ui:show-modal",
+    UI_HIDE_MODAL = "ui:hide-modal",
+    FAVORITES_CHANGED = "favorites:changed",
+    FILE_DOWNLOAD = "file:download"
+}
+export declare enum PitcherExternalEventName {
+    CREATE_AND_OPEN_CANVAS = "create_and_open_canvas",
+    OPEN_CANVAS = "open_canvas",
+    START_CALL = "start_call"
+}
+interface UpdateLocation {
+    action: string;
+}
+export interface LocationRoute {
+    path: string;
+    query: Record<string, any>;
+    is_restoring: boolean;
+    is_mounted: boolean;
+}
+export type LocationRoutes = Record<string, LocationRoute>;
+export interface UpdateLocationOnRegister extends UpdateLocation {
+    action: 'register';
+    child_app: string;
+    parent_app?: string;
+    path?: string;
+    query?: Record<string, any>;
+}
+export interface UpdateLocationOnUnregister extends UpdateLocation {
+    action: 'unregister';
+    app: string;
+}
+export interface UpdateLocationOnUpdate extends UpdateLocation {
+    action: 'update';
+    routes: Record<string, Omit<LocationRoute, 'is_restoring' | 'is_mounted'>>;
+}
+export interface UpdateLocationOnMounted extends UpdateLocation {
+    action: 'mounted';
+    app: string;
+}
+export interface UpdateLocationOnRestore extends UpdateLocation {
+    action: 'restore';
+    routes: Record<string, Omit<LocationRoute, 'is_mounted'>>;
+}
+export interface UpdateLocationOnRestoreCompleted extends UpdateLocation {
+    action: 'restore_completed';
+    app: string;
+    path: string;
+    query: Record<string, any>;
+}
+export interface UpdateLocationOnGetRoutesRequest extends UpdateLocation {
+    action: 'get_routes_request';
+    app: string;
+}
+export interface UpdateLocationOnGetRoutesResponse extends UpdateLocation {
+    action: 'get_routes_response';
+    app: string;
+    routes: LocationRoutes;
+}
+export type UpdateLocationPitcherEvent = UpdateLocationOnUnregister | UpdateLocationOnRestore | UpdateLocationOnUpdate | UpdateLocationOnRegister | UpdateLocationOnRestoreCompleted | UpdateLocationOnMounted | UpdateLocationOnGetRoutesRequest | UpdateLocationOnGetRoutesResponse;
+export interface PitcherEventMap {
+    [PitcherEventName.ENV_CHANGED]: PitcherEnv;
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.PHOTOS_CAPTURED]: void;
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.NON_FILES_SYNC_FINISHED]: {
+        user_triggered: boolean;
+    };
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.CONTENT_LIST_REFRESH_REQUESTED]: void;
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.FILE_DOWNLOADED]: File;
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.NETWORK_CONNECTION_ESTABLISHED]: void;
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.NETWORK_CONNECTION_LOST]: void;
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.FILE_UPLOAD_PROGRESS]: {
+        upload_uid: string;
+        progress: number;
+    };
+    /**
+     * @see WEB-only
+     */
+    [PitcherEventName.ENTERED_FULLSCREEN]: void;
+    /**
+     * @see WEB-only
+     */
+    [PitcherEventName.EXITED_FULLSCREEN]: void;
+    [PitcherEventName.CANVAS_UPDATED]: Record<string, any>;
+    [PitcherEventName.CANVAS_UPDATED_SUCCESS]: Partial<CanvasRetrieve>;
+    [PitcherEventName.UPDATE_LOCATION]: UpdateLocationPitcherEvent;
+    [PitcherEventName.FILE_CLOSED]: {
+        file_id?: string;
+    };
+    [PitcherEventName.SUBMIT_POSTCALL_CLICKED]: void;
+    [PitcherBroadcastedEventName.UI_SHOW_MODAL]: void;
+    [PitcherBroadcastedEventName.UI_HIDE_MODAL]: void;
+    [PitcherBroadcastedEventName.FAVORITES_CHANGED]: {
+        body: PaginatedData<Favorite>;
+    };
+    [PitcherBroadcastedEventName.FILE_DOWNLOAD]: {
+        body: File['id'];
+    };
+    [PitcherExternalEventName.OPEN_CANVAS]: OpenCanvasPitcherEvent;
+    [PitcherExternalEventName.START_CALL]: StartCallPitcherEvent;
+    [PitcherExternalEventName.CREATE_AND_OPEN_CANVAS]: CreateAndOpenCanvasEvent;
+}
+export interface PitcherEvent {
+    type: keyof PitcherEventMap;
+    body: PitcherEventMap[keyof PitcherEventMap];
+}
+export interface ApiEventMap {
+    event: PitcherEvent;
+}
+export {};