@pitcher/js-api 1.21.0-beta.2 → 1.21.0-beta.3

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

@@ -0,0 +1,56 @@
+import { Canvas, CanvasCreateRequest, PatchedCanvasUpdateRequest, SharedLink, Instance } from '../../../../types/openapi';
+import { GetCanvasesParams } from '../../../types/canvases';
+import { PaginatedData } from '../../../types/paginatedData';
+
+/**
+ * Fetches a list of canvases to use in your app.
+ *
+ * ```
+ * // The `filters` object is a reserved payload key to transfer the metadata dict over the wire.
+ * api.getCanvases({
+ *   search: 'my search query',
+ *   ordering: '-created_at',
+ *   filters: {
+ *     metadata__mydaterangefiltername__range: ['2023-12-10', '2023-12-22'],
+ *     metadata__mymultiselectfiltername: ['optionAValue', 'optionCValue'],
+ *   },
+ *  fields: 'id,name,metadata',
+ * })
+ * ```
+ */
+export declare function getCanvases(payload: GetCanvasesParams & {
+    filters?: Record<string, any>;
+    fields?: string;
+}): Promise<PaginatedData<Canvas>>;
+export declare function createCanvas(payload: Omit<CanvasCreateRequest, 'instance_id'>): Promise<Canvas>;
+export declare function deleteCanvas(payload: {
+    id: Canvas['id'];
+}): Promise<Canvas>;
+/**
+ * Updates a canvas by ID
+ *
+ * ```
+ * // The fields param is appended to the URL as a query param.
+ * onMounted(() => {
+ *   PitcherAPI.updateCanvas({
+ *     id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *     fields: 'id,name',
+ *     name: 'To 3!',
+ *   }).then((res) => {
+ *     console.log(res)  // logs: { id: '01HH4RCBH631K4JDHWAQB0RPR6', name: 'To 3!' }
+ *   })
+ * })
+ * ```
+ */
+export declare function updateCanvas(payload: PatchedCanvasUpdateRequest & {
+    id: Canvas['id'];
+    instance_id?: Instance['id'];
+    fields?: string;
+}): Promise<Canvas>;
+export declare function getCanvas(payload: {
+    id: Canvas['id'];
+    fields?: string;
+}): Promise<Canvas>;
+export declare function shareCanvas(payload: {
+    id: Canvas['id'];
+}): Promise<SharedLink>;

package/lib/sdk/api/modules/dsr/env.dsr.d.ts

@@ -0,0 +1,10 @@
+import { DsrEnv } from './types.dsr';
+
+/**
+ * Fetches the necessary info for the app to know where it is embedded. LaunchDarkly flags are omitted for now as they are not yet used.
+ *
+ * ```
+ * useDsr().getEnv()
+ * ```
+ */
+export declare function getEnv(): Promise<DsrEnv>;

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

@@ -0,0 +1,5 @@
+import { DSR_MESSAGE_TYPES, DsrMessagePayloads } from './types.dsr';
+
+export declare function on(type: (typeof DSR_MESSAGE_TYPES)[keyof typeof DSR_MESSAGE_TYPES], handler: (data: DsrMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
+export * from './env.dsr';
+export * from './loading.dsr';

package/lib/sdk/api/modules/dsr/loading.dsr.d.ts

@@ -0,0 +1 @@
+export declare function embeddable_ready(): Promise<void>;

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

@@ -0,0 +1,39 @@
+import { PitcherEnv } from '../../../interfaces';
+
+export declare const DSR_MESSAGE: "DSR_MESSAGE";
+export declare const DSR_MESSAGE_TYPES: {
+    readonly ENV_CHANGED: "dsr_env_changed";
+};
+export declare const DSR_API_TYPES: {
+    readonly DSR_REQUEST: "DSR_REQUEST";
+    readonly DSR_RESPONSE: "DSR_RESPONSE";
+};
+export declare const DSR_API_METHOD_TYPES: {
+    readonly GET_ENV: "dsr_get_env";
+    readonly DSR_EMBEDDABLE_READY: "dsr_embeddable_ready";
+};
+export type DsrMessagePayloads = {
+    [DSR_MESSAGE_TYPES.ENV_CHANGED]: DsrEnv;
+};
+export type DsrRequest<Payload = any> = {
+    id: string;
+    type: (typeof DSR_API_TYPES)['DSR_REQUEST'];
+    body: {
+        type: (typeof DSR_API_METHOD_TYPES)[keyof typeof DSR_API_METHOD_TYPES];
+        data: Payload;
+    };
+};
+export type DsrResponse<Response = any> = {
+    id: string;
+    type: (typeof DSR_API_TYPES)['DSR_RESPONSE'];
+    body: Response;
+};
+export type DsrMessage<Payload = any> = {
+    id: string;
+    type: typeof DSR_MESSAGE;
+    body: {
+        type: (typeof DSR_MESSAGE_TYPES)[keyof typeof DSR_MESSAGE_TYPES];
+        data: Payload;
+    };
+};
+export type DsrEnv = Pick<PitcherEnv, 'mode' | 'launch_darkly' | 'client_type'>;

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

@@ -0,0 +1,7 @@
+import { PitcherEnv } from '../../interfaces';
+import { User } from '../../../../types/openapi';
+
+export declare function getEnv(): Promise<PitcherEnv>;
+type UpdateEnvParams = Pick<User, 'language' | 'dark_mode'>;
+export declare function updateMyUser(payload: UpdateEnvParams): Promise<User>;
+export {};

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

@@ -0,0 +1,7 @@
+import { PaginatedData } from '../../../types/paginatedData';
+import { Event, EventRequest, PatchedEventRequest } from '../../../../types/openapi';
+
+export declare function getEvents(payload: Partial<EventRequest>): Promise<PaginatedData<Event>>;
+export declare function createEvent(payload: EventRequest): Promise<Event>;
+export declare function updateEvent(payload: PatchedEventRequest): Promise<Event>;
+export declare function deleteEvent(payload: Partial<Event>): Promise<void>;

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

@@ -0,0 +1,8 @@
+import { Favorite, FavoriteCreateRequest, PaginatedFavoriteList } from '../../../../types/openapi';
+import { GetFavoritesParams } from '../../../types/favorites';
+
+export declare function getFavorites(payload?: GetFavoritesParams): Promise<PaginatedFavoriteList>;
+export declare function createFavorite(payload: FavoriteCreateRequest): Promise<Favorite>;
+export declare function deleteFavorite(payload: {
+    favorite_id: Favorite['id'];
+}): Promise<void>;

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

@@ -0,0 +1,3 @@
+import { SubmitUserFeedbackPayload } from '../../payload.types';
+
+export declare function submitUserFeedback(payload: SubmitUserFeedbackPayload): Promise<any>;

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

@@ -0,0 +1,31 @@
+import { File, FileRetrieve, PaginatedFileList, FileUpdateRequest } from '../../../../types/openapi';
+import { GetRecentFilesPayload, ListFilesPayload } from '../../payload.types';
+import { AllFileCreateRequest, DeviceFile } from '../../../types/files';
+
+export declare function getFiles(payload: ListFilesPayload): Promise<PaginatedFileList>;
+export declare function getRecentFiles(payload?: GetRecentFilesPayload): Promise<File[]>;
+export declare function downloadFile(payload: {
+    file_id: File['id'];
+}): Promise<null>;
+export declare function getAppConfig(payload: {
+    app_name: string;
+}): Promise<Record<string, any>>;
+export declare function getFile(payload: {
+    file_id: FileRetrieve['id'];
+}): Promise<FileRetrieve>;
+export declare function updateFile(payload: FileUpdateRequest & {
+    id: File['id'];
+}): Promise<FileRetrieve>;
+export declare function deleteFile(payload: {
+    file_id: File['id'];
+}): Promise<File['id']>;
+export declare function createFile(payload: Omit<AllFileCreateRequest, 'instance_id'>): Promise<FileRetrieve>;
+/**
+ * Dispatches iOS native file selector and returns the selected file.
+ *
+ * ```
+ * // iOS only method to select a file from the device.
+ * api.selectDeviceFile()
+ * ```
+ */
+export declare function selectDeviceFile(): Promise<DeviceFile>;

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

@@ -0,0 +1,21 @@
+import { File, Folder, FolderRetrieve, FolderCreateRequest, FolderUpdateRequest } from '../../../../types/openapi';
+
+export declare function getFolder(payload?: {
+    id: FolderRetrieve['id'];
+}): Promise<FolderRetrieve>;
+export declare function createFolder(payload: Omit<FolderCreateRequest, 'instance_id'>): Promise<FolderRetrieve>;
+type UpdateFolderPayload = FolderUpdateRequest & {
+    id: Folder['id'];
+};
+export declare function updateFolder(payload: UpdateFolderPayload): Promise<FolderRetrieve>;
+export declare function deleteFolder(payload: {
+    folder_id: FolderRetrieve['id'];
+}): Promise<void>;
+export declare function moveFolderItems(payload: {
+    target_folder_id: Folder['id'];
+    items: {
+        id: File['id'] | Folder['id'];
+        type: 'folder' | 'file';
+    }[];
+}): Promise<FolderRetrieve>;
+export {};

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

@@ -0,0 +1,19 @@
+export * from './open';
+export * from './env';
+export * from './languages';
+export * from './events';
+export * from './canvas';
+export * from './files';
+export * from './search';
+export * from './users';
+export * from './pspdfkit';
+export * from './toast';
+export * from './query';
+export * from './folders';
+export * from './favorites';
+export * from './notifications';
+export * from './track';
+export * from './metadataTemplates';
+export * from './sync';
+export * from './feedback';
+export * from './webView';

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

@@ -0,0 +1,8 @@
+export type Language = [
+    string,
+    string
+];
+/**
+ * Fetches available languages for the logged-in user
+ */
+export declare function getLanguages(): Promise<Language[]>;

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

@@ -0,0 +1,4 @@
+import { PaginatedMetadataTemplateList } from '../../../../types/openapi';
+import { GetInstanceMetadataTemplatesPayload } from '../../payload.types';
+
+export declare function getInstanceMetadataTemplates(payload?: GetInstanceMetadataTemplatesPayload): Promise<PaginatedMetadataTemplateList>;

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

@@ -0,0 +1,3 @@
+import { NotificationPayload } from '../../payload.types';
+
+export declare function notify(payload: NotificationPayload): Promise<void>;

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

@@ -0,0 +1,4 @@
+import { OpenExternalUrlRequestPayload, OpenRequestPayload } from '../../payload.types';
+
+export declare function open(payload?: OpenRequestPayload): Promise<string>;
+export declare function openExternalUrl(payload: OpenExternalUrlRequestPayload): Promise<void>;

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

@@ -0,0 +1,23 @@
+import { File } from '../../../../types/openapi';
+
+/**
+ * @deprecated - not used anymore
+ */
+export declare function fetchDocumentInfo(payload: {
+    fileId: File['id'];
+}): Promise<{
+    pageCount: number;
+    [key: string]: unknown;
+}>;
+/**
+ * @deprecated - use thumbnails instead
+ */
+export declare function renderPageAsImage(payload: {
+    fileId: File['id'];
+    pageNumber: number;
+    params: {
+        width: number;
+    } | {
+        height: number;
+    };
+}): Promise<ArrayBuffer>;

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

@@ -0,0 +1,3 @@
+import { QueryPayload } from '../../payload.types';
+
+export declare function query(payload: QueryPayload): Promise<any>;

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

@@ -0,0 +1,4 @@
+export declare function search(payload: {
+    query: string;
+    includeExpired?: boolean;
+}): Promise<any>;

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

@@ -0,0 +1,9 @@
+/**
+ * Dispatches iOS only sync method for non-files.
+ *
+ * ```
+ * // iOS only method to sync non-files from the server.
+ * api.triggerNonFilesSync()
+ * ```
+ */
+export declare function triggerNonFilesSync(): Promise<void>;

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

@@ -0,0 +1,4 @@
+export declare function toast(payload: {
+    type: string;
+    message: string;
+}): Promise<void>;

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

@@ -0,0 +1,4 @@
+export declare function track(payload: {
+    event_name: string;
+    payload: any;
+}): Promise<any>;

package/lib/sdk/api/modules/ui/app-errors.ui.d.ts

@@ -0,0 +1,3 @@
+import { UiCaptureAppErrorRequest } from './types.ui';
+
+export declare function capture_app_error(payload: UiCaptureAppErrorRequest): Promise<void>;

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

@@ -0,0 +1,9 @@
+import { Canvas } from '../../../../../types/openapi';
+import { UiAppResizeRequest, UiCanvasNavigatePageReuqest, UiUpdateCanvasRequest } from './types.ui';
+
+export declare function update_canvas(payload: UiUpdateCanvasRequest): Promise<Canvas>;
+export declare function app_loaded(): Promise<void>;
+export declare function app_resize(payload: UiAppResizeRequest): Promise<void>;
+export declare function canvas_navigate_next_page(): Promise<void>;
+export declare function canvas_navigate_previous_page(): Promise<void>;
+export declare function canvas_navigate_page(payload: UiCanvasNavigatePageReuqest): Promise<void>;

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

@@ -0,0 +1,7 @@
+import { UiSelectContentRequest, UiSelectContentResponse, UiOpenRequest, UiToastRequest, UiPreselectSfdcMeetingIdRequest, UiPreselectSfdcMeetingIdResponse } from './types.ui';
+
+export declare function ui_select_content(payload?: UiSelectContentRequest): Promise<UiSelectContentResponse>;
+export declare function select_content(payload?: UiSelectContentRequest): Promise<UiSelectContentResponse>;
+export declare function open(payload: UiOpenRequest): Promise<void>;
+export declare function toast(payload: UiToastRequest): Promise<void>;
+export declare function preselect_sfdc_meeting_id(payload: UiPreselectSfdcMeetingIdRequest): Promise<UiPreselectSfdcMeetingIdResponse>;

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

@@ -0,0 +1,15 @@
+import { UiMeetingCanceledPayload, UiCanvasUpdatedPayload, UiSectionListUpdatedPayload, UiAppSetDataPayload, UiAppUpdateDataPayload, UiBroadcastRequest, UiMessagePayloads } from './types.ui';
+
+export declare function on<T extends keyof UiMessagePayloads>(type: T, handler: (data: UiMessagePayloads[T]) => Promise<void>): Promise<() => void>;
+export declare function on_meeting_canceled(handler: (data: UiMeetingCanceledPayload) => Promise<void>): Promise<() => void>;
+export declare function on_canvas_updated(handler: (data: UiCanvasUpdatedPayload) => Promise<void>): Promise<() => void>;
+export declare function on_section_list_updated(handler: (data: UiSectionListUpdatedPayload) => Promise<void>): Promise<() => void>;
+export declare function on_app_set_data(handler: (data: UiAppSetDataPayload) => Promise<void>): Promise<() => void>;
+export declare function on_app_update_data(handler: (data: UiAppUpdateDataPayload) => Promise<void>): Promise<() => void>;
+export declare function ui_broadcast(payload: UiBroadcastRequest): Promise<void>;
+export * from './content.ui';
+export * from './loading.ui';
+export * from './location.ui';
+export * from './app-errors.ui';
+export * from './canvas.ui';
+export * from './post-call.ui';

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

@@ -0,0 +1 @@
+export declare function embeddable_ready(): Promise<void>;

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

@@ -0,0 +1,3 @@
+import { UpdateLocationPitcherEvent } from '../../../interfaces';
+
+export declare function update_location(payload: UpdateLocationPitcherEvent): Promise<any>;

package/lib/sdk/api/modules/ui/post-call.ui.d.ts

@@ -0,0 +1,6 @@
+import { UiCompletePostcallRequest, UiSetPostcallStyleRequest } from './types.ui';
+
+export declare function complete_postcall(payload: UiCompletePostcallRequest): Promise<void>;
+export declare function enable_postcall_submit(): Promise<void>;
+export declare function disable_postcall_submit(): Promise<void>;
+export declare function set_postcall_style(payload: UiSetPostcallStyleRequest): Promise<void>;

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

@@ -0,0 +1,111 @@
+import { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile } from '@content-selector/stores/app';
+import { CanvasSection, ComponentNode, EmbeddableProps, SfEvent } from '../../../../main.lib';
+import { Mutable } from '../../../../types/ts';
+import { Canvas, 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_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 = Record<string, never>;
+export type UiSelectContentResponse = {
+    user_action: 'cancelled' | 'selected';
+    content?: (ContentSelectorSelectedFile | ContentSelectorSelectedPage)[];
+};
+export type UiCaptureAppErrorRequest = Record<string, any>;
+export type UiUpdateCanvasRequest = Mutable<Canvas> & {
+    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: Canvas;
+    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: Canvas;
+};
+export type UiSectionListUpdatedPayload = {
+    section_list_ids: string[];
+    section_list_component_id: string;
+    canvas: Canvas | null;
+};

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

@@ -0,0 +1,6 @@
+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>;

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>;