@pitcher/js-api 1.22.0-beta.6 → 1.22.0-rc.0

package/lib/sdk/interfaces.d.ts

@@ -4,7 +4,7 @@ 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';
+import { CDP_EVENT_TYPE, CLIENT_TYPE } from '../constants/cdp.const';
 export declare const PITCHER_EVENT: "PITCHER_EVENT";
 export declare enum PitcherMessageType {
     REQUEST = "PITCHER_REQUEST",
@@ -41,6 +41,11 @@ export interface PitcherEnv {
     };
     launch_darkly?: LaunchDarklyEnv;
     client_type?: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
+    state?: {
+        active_file?: {
+            id: File['id'];
+        };
+    };
 }
 export interface PitcherAPI extends Emitter<ApiEventMap> {
     request(type: string, body: any, callback: () => any): Promise<PitcherResponse>;
@@ -98,6 +103,7 @@ export declare enum PitcherEventName {
     ENTERED_FULLSCREEN = "entered_fullscreen",
     EXITED_FULLSCREEN = "exited_fullscreen",
     SUBMIT_POSTCALL_CLICKED = "submit_postcall_clicked",
+    ANALYTICS_CAPTURED = "analytics_captured",
     OPEN_FOLDER_REQUESTED = "open_folder_requested"
 }
 export declare enum PitcherBroadcastedEventName {
@@ -312,6 +318,13 @@ export interface PitcherEventMap {
         upload_uid: string;
         progress: number;
     };
+    /**
+     * @see iOS-only
+     */
+    [PitcherEventName.ANALYTICS_CAPTURED]: {
+        type: (typeof CDP_EVENT_TYPE)[keyof typeof CDP_EVENT_TYPE];
+        payload: any;
+    };
     /**
      * @see WEB-only
      */

package/lib/sdk/main.d.ts

@@ -83,6 +83,10 @@ export declare function useAdmin(): {
         id: import('../main.lib').File["id"];
     }): Promise<import('../main.lib').File>;
     getFiles(payload: Record<string, any>): Promise<import('../main.lib').PaginatedFileList>;
+    open(payload: {
+        id: import('../main.lib').File["id"];
+    }): Promise<void>;
+    close(): Promise<void>;
     selectContent(payload: import('./api/modules/admin/types.admin').AdminSelectContentRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectContentResponse>;
     getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
     createCanvas(payload: import('../main.lib').CanvasCreateRequest): Promise<import('../main.lib').CanvasRetrieve>;
@@ -188,6 +192,10 @@ export declare function useApi(options?: ApiOptions): {
     shareCanvas(payload: {
         id: import('../main.lib').CanvasRetrieve["id"];
     }): Promise<import('../main.lib').SharedLink>;
+    getCanvasRecommendedFiles(payload: {
+        canvas_id: import('../main.lib').CanvasRetrieve["id"];
+        match?: ("tags" | "metadata")[];
+    }): Promise<import('../main.lib').CanvasRecommendedFiles>;
     getFiles(payload: import('./payload.types').ListFilesPayload & {
         filters?: Record<string, any>;
         fields?: string;
@@ -203,6 +211,10 @@ export declare function useApi(options?: ApiOptions): {
         id?: import('../main.lib').FileRetrieve["id"];
         file_id?: import('../main.lib').FileRetrieve["id"];
     }): Promise<import('../main.lib').FileRetrieve>;
+    getFileRevisionData(payload: {
+        file_id: import('../main.lib').FileRetrieve["id"];
+        revision_id: import('../main.lib').FileRevision["id"];
+    }): Promise<import('../main.lib').FileRetrieve>;
     updateFile(payload: import('../main.lib').FileUpdateRequest & {
         id: import('../main.lib').File["id"];
     }): Promise<import('../main.lib').FileRetrieve>;
@@ -211,6 +223,10 @@ export declare function useApi(options?: ApiOptions): {
     }): Promise<import('../main.lib').File["id"]>;
     createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
     selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
+    getFileRevisions(payload: {
+        id?: import('../main.lib').FileRetrieve["id"];
+        file_id?: import('../main.lib').FileRetrieve["id"];
+    }): Promise<import('../main.lib').FileRevision[]>;
     search(payload: {
         query: string;
         includeExpired?: boolean;
@@ -270,6 +286,7 @@ export declare function useApi(options?: ApiOptions): {
     submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
+    share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
     API: import('./api/LowLevelApi').LowLevelApi;
 } | {
     getAppConfig(payload: {
@@ -279,6 +296,10 @@ export declare function useApi(options?: ApiOptions): {
         id: import('../main.lib').File["id"];
     }): Promise<import('../main.lib').File>;
     getFiles(payload: Record<string, any>): Promise<import('../main.lib').PaginatedFileList>;
+    open(payload: {
+        id: import('../main.lib').File["id"];
+    }): Promise<void>;
+    close(): Promise<void>;
     selectContent(payload: import('./api/modules/admin/types.admin').AdminSelectContentRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectContentResponse>;
     getInstanceMetadataTemplates(payload?: import('./payload.types').GetInstanceMetadataTemplatesPayload): Promise<import('../main.lib').PaginatedMetadataTemplateList>;
     createCanvas(payload: import('../main.lib').CanvasCreateRequest): Promise<import('../main.lib').CanvasRetrieve>;
@@ -394,6 +415,10 @@ export declare function useApi(options?: ApiOptions): {
         shareCanvas(payload: {
             id: import('../main.lib').CanvasRetrieve["id"];
         }): Promise<import('../main.lib').SharedLink>;
+        getCanvasRecommendedFiles(payload: {
+            canvas_id: import('../main.lib').CanvasRetrieve["id"];
+            match?: ("tags" | "metadata")[];
+        }): Promise<import('../main.lib').CanvasRecommendedFiles>;
         getFiles(payload: import('./payload.types').ListFilesPayload & {
             filters?: Record<string, any>;
             fields?: string;
@@ -409,6 +434,10 @@ export declare function useApi(options?: ApiOptions): {
             id?: import('../main.lib').FileRetrieve["id"];
             file_id?: import('../main.lib').FileRetrieve["id"];
         }): Promise<import('../main.lib').FileRetrieve>;
+        getFileRevisionData(payload: {
+            file_id: import('../main.lib').FileRetrieve["id"];
+            revision_id: import('../main.lib').FileRevision["id"];
+        }): Promise<import('../main.lib').FileRetrieve>;
         updateFile(payload: import('../main.lib').FileUpdateRequest & {
             id: import('../main.lib').File["id"];
         }): Promise<import('../main.lib').FileRetrieve>;
@@ -417,6 +446,10 @@ export declare function useApi(options?: ApiOptions): {
         }): Promise<import('../main.lib').File["id"]>;
         createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
         selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
+        getFileRevisions(payload: {
+            id?: import('../main.lib').FileRetrieve["id"];
+            file_id?: import('../main.lib').FileRetrieve["id"];
+        }): Promise<import('../main.lib').FileRevision[]>;
         search(payload: {
             query: string;
             includeExpired?: boolean;
@@ -476,6 +509,7 @@ export declare function useApi(options?: ApiOptions): {
         submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
         close(): Promise<any>;
         openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
+        share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
         API: import('./api/LowLevelApi').LowLevelApi;
     };
     promptPia(payload: import('./api/modules/ui/types.ui').UiPromptPiaRequest): Promise<import('./api/modules/ui/types.ui').UiPromptPiaResponse>;
@@ -551,6 +585,10 @@ export declare function useApi(options?: ApiOptions): {
     shareCanvas(payload: {
         id: import('../main.lib').CanvasRetrieve["id"];
     }): Promise<import('../main.lib').SharedLink>;
+    getCanvasRecommendedFiles(payload: {
+        canvas_id: import('../main.lib').CanvasRetrieve["id"];
+        match?: ("tags" | "metadata")[];
+    }): Promise<import('../main.lib').CanvasRecommendedFiles>;
     getFiles(payload: import('./payload.types').ListFilesPayload & {
         filters?: Record<string, any>;
         fields?: string;
@@ -566,6 +604,10 @@ export declare function useApi(options?: ApiOptions): {
         id?: import('../main.lib').FileRetrieve["id"];
         file_id?: import('../main.lib').FileRetrieve["id"];
     }): Promise<import('../main.lib').FileRetrieve>;
+    getFileRevisionData(payload: {
+        file_id: import('../main.lib').FileRetrieve["id"];
+        revision_id: import('../main.lib').FileRevision["id"];
+    }): Promise<import('../main.lib').FileRetrieve>;
     updateFile(payload: import('../main.lib').FileUpdateRequest & {
         id: import('../main.lib').File["id"];
     }): Promise<import('../main.lib').FileRetrieve>;
@@ -574,6 +616,10 @@ export declare function useApi(options?: ApiOptions): {
     }): Promise<import('../main.lib').File["id"]>;
     createFile(payload: Omit<import('../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../main.lib').FileRetrieve>;
     selectDeviceFile(): Promise<import('../main.lib').DeviceFile>;
+    getFileRevisions(payload: {
+        id?: import('../main.lib').FileRetrieve["id"];
+        file_id?: import('../main.lib').FileRetrieve["id"];
+    }): Promise<import('../main.lib').FileRevision[]>;
     search(payload: {
         query: string;
         includeExpired?: boolean;
@@ -629,5 +675,6 @@ export declare function useApi(options?: ApiOptions): {
     submitUserFeedback(payload: import('./payload.types').SubmitUserFeedbackPayload): Promise<any>;
     close(): Promise<any>;
     openWebViewAlwaysOnTop(payload: import('./payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
+    share(payload: import('./payload.types').SharePayload): Promise<import('./payload.types').ShareResponse>;
     API: import('./api/LowLevelApi').LowLevelApi;
 };

package/lib/sdk/payload.types.d.ts

@@ -105,6 +105,13 @@ export interface OpenRequestPayload {
      * Id of the file to open.
      */
     fileId?: File['id'];
+    /**
+     * Ids of the files to open and the strategy to open them with.
+     */
+    files?: {
+        ids: File['id'][];
+        strategy: 'simultaneous' | 'swap';
+    };
     /**
      * Id of the canvas from which the file is opened.
      */
@@ -113,6 +120,10 @@ export interface OpenRequestPayload {
      * Optional, page index to open. Default is `null`.
      */
     pageIndex?: MiniPage['page_index'];
+    /**
+     * Optional, video start timestamp in seconds. Default is `null`.
+     */
+    startTime?: number;
     /**
      * URL of the file content.
      */
@@ -185,3 +196,29 @@ export interface OpenWebViewAlwaysOnTop {
         x: number;
     };
 }
+/**
+ * Payload for iOS sharing dialog.
+ */
+export interface SharePayload {
+    /**
+     * Text to be shared.
+     */
+    text: string;
+    /**
+     * Subject
+     */
+    subject?: string;
+}
+/**
+ * Represents a response to a iOS sharing dialog.
+ */
+export type ShareResponse = {
+    /**
+     * Action taken by the user.
+     */
+    user_action: 'cancelled' | 'shared';
+    /**
+     * Type of share action.
+     */
+    activity_type?: string;
+};

package/lib/theme/light.d.ts

@@ -1,4 +1,5 @@
 import { ThemeCommonVars } from 'naive-ui';
+import { BasicPalette } from '@theme/theme.types';
 export declare const lightPalette: import('vue').Ref<{
     base: string;
     primary: string;
@@ -27,6 +28,34 @@ export declare const lightPalette: import('vue').Ref<{
     boxShadow: string;
     boxShadow2: string;
     boxShadow3: string;
+}, BasicPalette | {
+    base: string;
+    primary: string;
+    primary2: string;
+    primary3: string;
+    primary4: string;
+    primary5: string;
+    primary6: string;
+    primary6_1: string;
+    accent: string;
+    text: string;
+    text2: string;
+    text3: string;
+    error: string;
+    error2: string;
+    error3: string;
+    warning: string;
+    warning2: string;
+    warning3: string;
+    success: string;
+    success2: string;
+    success3: string;
+    info: string;
+    info2: string;
+    info3: string;
+    boxShadow: string;
+    boxShadow2: string;
+    boxShadow3: string;
 }>;
 export declare const lightThemeOverrides: import('vue').ComputedRef<{
     common: {

package/lib/theme/theme.utils.d.ts

@@ -1,2 +1,19 @@
 import { BasicPalette } from '@theme/theme.types';
+import { Paragraphs } from '../components/CRichTextEditor/extensions/paragraphExtended';
+export declare const fontSizePresets: number[];
 export declare function exportObjectToGlobalCssProperties(colorPalette: Partial<BasicPalette>): void;
+export declare const textStylePresets: ({
+    id: string;
+    class: string;
+    style: {
+        fontSize: string;
+    };
+    value: number;
+} | {
+    id: string;
+    class: string;
+    style: {
+        fontSize: string;
+    };
+    value: Paragraphs;
+})[];

package/lib/types/call.d.ts

@@ -17,13 +17,21 @@ export declare enum PostAction {
     REDIRECT = "redirect"
 }
 export type CallPresentationHistory = {
-    type: 'canvas' | 'section' | 'file';
+    type: 'canvas' | 'section' | 'file' | 'page' | 'canvas_page';
     notesContent?: string;
     duration?: number;
     timeStarted?: string;
     name?: string;
+    page?: number;
+    component_ids?: string[];
     id: string;
 }[];
+export type ContentRating = -1 | 0 | 1;
+export type CallPresentationHistoryMetadata = {
+    [id: string]: {
+        rating: ContentRating;
+    };
+};
 export interface Call {
     selectedEvent: SfEventExtended | null;
     selectedAccount: SfAccountMini | null;
@@ -37,6 +45,7 @@ export interface Call {
     postAction?: string | null;
     postActionPath?: string | null;
     presentationHistory?: CallPresentationHistory;
+    presentationHistoryMetadata?: CallPresentationHistoryMetadata;
     recentAccounts?: SfAccount[];
 }
 export declare const INITIAL_CALL_STATE: Call;

package/lib/types/canvasTheme.d.ts

@@ -0,0 +1,11 @@
+export type CanvasTypographyPresetId = 'h_1' | 'h_2' | 'h_3' | 'big_text' | 'normal_text' | 'small_text';
+export type CanvasTypographyPreset = {
+    id: CanvasTypographyPresetId;
+    color: string;
+    font_family: string;
+    font_size: string;
+    font_weight: '400' | '700';
+    letter_spacing: string;
+    line_height: string;
+    text_transform: 'capitalize' | 'lowercase' | 'none' | 'uppercase';
+};

package/lib/types/canvases.d.ts

@@ -11,6 +11,7 @@ export interface GetCanvasesParams {
     page?: number;
     page_size?: number;
     section_ids?: string[];
+    tags__in?: string[];
 }
 export declare enum CanvasesViewsTypes {
     SAVED = "saved",

package/lib/types/instanceSettings.types.d.ts

@@ -24,6 +24,9 @@ export type InstanceSettings = OrganizationSettings & {
         content_grid_autofill_files_filter_iteratee?: string;
         section_content_grid_autofill_files_filter_iteratee?: string;
         show_extra_exit_button_in_fullscreen_mode?: boolean;
+        show_fallback_section_name_on_collapsibles?: boolean;
         capture_component_enter_exit_events?: 'all' | 'named_components';
+        enable_collection_player_component?: boolean;
     };
+    ios?: InstanceSettings;
 };

package/lib/types/instanceTags.types.d.ts

@@ -0,0 +1,3 @@
+import { CanvasType } from './canvases';
+export type InstanceTagsCanvasType = Exclude<CanvasType, 'section-template'>;
+export type InstanceTagsType = 'files' | 'canvases';

package/lib/types/launchDarkly.types.d.ts

@@ -1,4 +1,4 @@
-export type LaunchDarklyBooleanFlagKey = 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_canvas_duplication' | 'allow_canvas_history' | 'allow_canvas_ownership_change' | 'allow_content_grid_autofill' | 'allow_creating_canvas_with_no_template' | 'allow_embeddable_hiding' | 'allow_note_taking' | 'allow_rep_canvas_metadata_edit' | 'are_sections_system_controlled' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_file_edit_content' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'display_section_list_name' | 'enable_analytics' | 'enable_canvas_node_debugging' | 'enable_experimental_canvas_builder_dnd' | 'enable_knock_notifications' | 'hide_asset_uploader' | 'interpolate_rep_canvases_on_edit_mode' | 'is_fe_sentry_enabled' | 'is_meeting_bar_account_selection_disabled' | 'is_meeting_bar_hidden' | 'is_rep_canvas_creation_disabled' | 'is_shared_link_creation_disabled' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'launch_in_present_mode_on_creation' | 'reorder_component_in_drawer' | 'show_asset_manager_for_multimedia' | 'show_content_selector_list_view' | 'show_popularity_icons' | 'show_system_filters' | 'allow_canvases_tables_columns_settings' | 'prefer_online_handlers' | 'use_short_url_for_shared_link' | 'enable_suggested_tags' | 'enable_folder_details_edit' | 'enable_file_revisions' | 'show_clear_all_annotations_button' | 'allow_saving_annotations_in_personal_layer';
+export type LaunchDarklyBooleanFlagKey = 'allow_ai_prompts_in_canvas_text' | 'allow_bulk_actions_canvases_files' | 'allow_canvas_duplication' | 'allow_canvas_history' | 'allow_canvas_ownership_change' | 'allow_content_grid_autofill' | 'allow_creating_canvas_with_no_template' | 'allow_embeddable_hiding' | 'allow_note_taking' | 'allow_rep_canvas_metadata_edit' | 'allow_rep_file_rating' | 'allow_rep_file_upload' | 'are_sections_system_controlled' | 'copy_context_to_canvas' | 'copy_template_metadata_to_canvas' | 'disable_canvas_edit_for_reps' | 'disable_file_edit_content' | 'disable_fullscreen_canvas_builder' | 'disable_impact_web_browser_fullscreen' | 'display_section_list_name' | 'enable_analytics' | 'enable_canvas_node_debugging' | 'enable_canvas_tokens' | 'enable_experimental_canvas_builder_dnd' | 'enable_knock_notifications' | 'enable_metadata_in_file_uploads_with_default_values' | 'enable_pipe_character_multi_search' | 'hide_asset_uploader' | 'interpolate_rep_canvases_on_edit_mode' | 'is_fe_sentry_enabled' | 'is_meeting_bar_account_selection_disabled' | 'is_meeting_bar_hidden' | 'is_rep_canvas_creation_disabled' | 'is_shared_link_creation_disabled' | 'is_timeline_component_allowed' | 'launch_in_full_screen_on_present_mode' | 'launch_in_present_mode_on_creation' | 'reorder_component_in_drawer' | 'show_asset_manager_for_multimedia' | 'show_content_selector_list_view' | 'show_popularity_icons' | 'show_system_filters' | 'allow_canvases_tables_columns_settings' | 'prefer_online_handlers' | 'use_short_url_for_shared_link' | 'enable_suggested_tags' | 'enable_folder_details_edit' | 'enable_file_revisions' | 'show_clear_all_annotations_button' | 'allow_saving_annotations_in_personal_layer' | 'enable_embedded_video' | 'enable_embedded_video_autoplay' | 'enable_app_developer_role' | 'enable_instance_editor_role' | 'include_files_content_in_print';
 export type LaunchDarklyNumberFlagKey = 'canvas_section_selector_page_size' | 'canvas_section_selector_selected_items_with_thumbnail_size';
 type LaunchDarklyObjectFlags = {
     canvas_table_pagination: CanvasTablePagination;
@@ -10,6 +10,7 @@ export type LaunchDarklyStringFlagKey = keyof typeof LaunchDarklyStringFlags;
 declare const LaunchDarklyStringFlags: {
     readonly section_list_mode: readonly ["pagination", "collapsibles"];
     readonly canvas_component_grouping: readonly ["page", "page_break", "none"];
+    readonly batch_open_content_grid_ar_files: readonly ["off", "simultaneous", "swap"];
 };
 type LaunchDarklyStringFlagValue<K extends LaunchDarklyStringFlagKey = LaunchDarklyStringFlagKey> = K extends LaunchDarklyStringFlagKey ? (typeof LaunchDarklyStringFlags)[K][number] : never;
 type CanvasManagerVisibility = {

package/lib/types/metadataHighlightProperty.d.ts

@@ -0,0 +1,8 @@
+export type MetadataHighlightProperty = {
+    background_color?: string;
+    color?: string;
+    icon?: string;
+    key: string;
+    match_value: string | string[] | number | boolean;
+    text: string;
+};

package/lib/types/organizationSettings.types.d.ts

@@ -1,8 +1,17 @@
 import { TranslationOverrides } from './translations';
+import { MetadataHighlightProperty } from './metadataHighlightProperty';
 export type OrganizationSettings = {
     impact_show_only_saved_canvases_in_canvas_manager?: boolean;
     translation_overrides?: TranslationOverrides;
     file_annotations_mode?: 'admin' | 'personal';
-    allow_rep_file_upload?: boolean;
-    disable_canvas_edit_for_reps?: boolean;
+    minimum_event_duration_in_call?: number;
+    enable_content_rating_in_call?: boolean;
+    display_metadata_filters_in_modal?: boolean;
+    enable_js_api_recommended_files?: boolean;
+    metadata_highlight_properties?: MetadataHighlightProperty[];
+    business_logic_ids_to_section_ids_resolver?: string;
+    section_thumbnail_url_transformer?: string;
+    pipe_multi_search_separator?: string;
+    enable_crm_privacy_mode?: boolean;
+    ios?: OrganizationSettings;
 };

package/lib/types/recentFiles.types.d.ts

@@ -2,5 +2,6 @@ import { Instance, File } from '../../types/openapi';
 export type RecentFile = Pick<File, 'id' | 'name' | 'content_type' | 'instance_id'> & {
     tags?: Readonly<File['tags']>;
     thumbnail_url?: string | null;
+    page_index?: number;
 };
 export type InstanceRecentFilesMap = Record<Instance['id'], RecentFile[]>;

package/lib/util/date.d.ts

@@ -9,3 +9,4 @@ export declare const isSameOrBefore: (dateStr?: string | null) => boolean;
 export declare const isAfter: (dateStr?: string | null) => boolean;
 export declare const isSameOrAfter: (dateStr?: string | null) => boolean;
 export declare const msToSeconds: (ms: number) => number;
+export declare const secondsToHumanReadable: (seconds: number) => string;

package/lib/util/jwt.d.ts

@@ -0,0 +1 @@
+export declare function jwtDecode(token: string): Record<string, any> | null;

package/lib/util/network.d.ts

@@ -13,4 +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>;
+export declare function requestStream(url: string, body: Record<string, any>, token: string, onStreamedChunk?: (chunk: string, response: string) => void, signal?: AbortSignal): Promise<string>;

package/lib/util/string.d.ts

@@ -1,5 +1,5 @@
 export declare function highlight(input: string, search: string): string;
 export declare function prefixHttps(url: string): string;
 export declare function stripHtmlTags(htmlString: string | undefined): string;
-export declare function stripHtmlPreservingLineBreaks(htmlString: string | undefined): string;
+export declare function sanitizeHtml(htmlString: string | undefined): string;
 export declare function stripHtmlTagsAndTrim(htmlString: string | undefined): string;

package/lib/util/usage-tracking.util.d.ts

@@ -0,0 +1,5 @@
+interface UsageTrackingOptions {
+    onTrack: (id: string, payload: Record<string, any>) => void;
+}
+export declare function initializeUsageTracking(options: UsageTrackingOptions): () => void;
+export {};

package/lib/util/userAgents.d.ts

@@ -6,3 +6,4 @@ export declare const isPitcherOrIosDevice: boolean;
 export declare const isTouchScreen: boolean;
 export declare const isMac: boolean;
 export declare const isWindows: boolean;
+export declare const isSafari: boolean;

package/package.json

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

package/types/openapi/index.d.ts

@@ -4,16 +4,15 @@ export type { AccountRequest } from './models/AccountRequest';
 export type { App } from './models/App';
 export type { AppInstallationRequest } from './models/AppInstallationRequest';
 export type { AppOrganization } from './models/AppOrganization';
-export type { AppOrganizationRequest } from './models/AppOrganizationRequest';
 export type { AppPublish } from './models/AppPublish';
 export type { AppRelease } from './models/AppRelease';
-export type { AppRequest } from './models/AppRequest';
 export type { AppsDBEntry } from './models/AppsDBEntry';
 export type { AppsDBEntryRequest } from './models/AppsDBEntryRequest';
 export { AppTypeEnum } from './models/AppTypeEnum';
 export type { AuthToken } from './models/AuthToken';
 export type { AuthTokenRequest } from './models/AuthTokenRequest';
 export type { BulkDeleteErrorDetail } from './models/BulkDeleteErrorDetail';
+export type { BulkDeleteMixedObjectsRequest } from './models/BulkDeleteMixedObjectsRequest';
 export type { BulkDeleteRequest } from './models/BulkDeleteRequest';
 export type { BulkDeleteResponse } from './models/BulkDeleteResponse';
 export type { BulkUpdateMetadata } from './models/BulkUpdateMetadata';
@@ -47,7 +46,6 @@ export type { ContentDistributionGroupMembershipCreate } from './models/ContentD
 export type { ContentDistributionGroupMembershipCreateRequest } from './models/ContentDistributionGroupMembershipCreateRequest';
 export type { ContentDistributionGroupRequest } from './models/ContentDistributionGroupRequest';
 export { DefaultExpiresAtEnum } from './models/DefaultExpiresAtEnum';
-export type { DeletedApp } from './models/DeletedApp';
 export type { DeletedCanvas } from './models/DeletedCanvas';
 export type { DeletedContentDistributionGroup } from './models/DeletedContentDistributionGroup';
 export type { DeletedEnvironment } from './models/DeletedEnvironment';
@@ -159,7 +157,6 @@ export type { MiniFolderRequest } from './models/MiniFolderRequest';
 export type { MiniInstance } from './models/MiniInstance';
 export type { MiniInstanceRequest } from './models/MiniInstanceRequest';
 export type { MiniPage } from './models/MiniPage';
-export type { MiniPageRequest } from './models/MiniPageRequest';
 export type { MiniRegion } from './models/MiniRegion';
 export type { MiniRegionRequest } from './models/MiniRegionRequest';
 export type { MiniSharedLink } from './models/MiniSharedLink';
@@ -183,7 +180,6 @@ export type { OrganizationChangePercentages } from './models/OrganizationChangeP
 export type { OrganizationUpdate } from './models/OrganizationUpdate';
 export type { OrganizationUpdateRequest } from './models/OrganizationUpdateRequest';
 export type { PaginatedAppList } from './models/PaginatedAppList';
-export type { PaginatedAppReleaseList } from './models/PaginatedAppReleaseList';
 export type { PaginatedAuthTokenList } from './models/PaginatedAuthTokenList';
 export type { PaginatedCanvasList } from './models/PaginatedCanvasList';
 export type { PaginatedCollaborationList } from './models/PaginatedCollaborationList';
@@ -207,7 +203,6 @@ export type { PaginatedRevisionList } from './models/PaginatedRevisionList';
 export type { PaginatedSearchResultList } from './models/PaginatedSearchResultList';
 export type { PaginatedStorageRegionList } from './models/PaginatedStorageRegionList';
 export type { PaginatedUserList } from './models/PaginatedUserList';
-export type { PatchedAppRequest } from './models/PatchedAppRequest';
 export type { PatchedCanvasUpdateRequest } from './models/PatchedCanvasUpdateRequest';
 export type { PatchedCollaborationRequest } from './models/PatchedCollaborationRequest';
 export type { PatchedContentDistributionGroupRequest } from './models/PatchedContentDistributionGroupRequest';
@@ -225,6 +220,10 @@ export type { PatchedMetadataTemplateRequest } from './models/PatchedMetadataTem
 export type { PatchedOrganizationUpdateRequest } from './models/PatchedOrganizationUpdateRequest';
 export type { PatchedRegionRequest } from './models/PatchedRegionRequest';
 export type { PatchedUserRequest } from './models/PatchedUserRequest';
+export type { PSPDFKitAuthPayload } from './models/PSPDFKitAuthPayload';
+export type { PSPDFKitAuthPayloadRequest } from './models/PSPDFKitAuthPayloadRequest';
+export type { PSPDFKitToken } from './models/PSPDFKitToken';
+export type { PSPDFKitTokenRequest } from './models/PSPDFKitTokenRequest';
 export type { Region } from './models/Region';
 export type { RegionRequest } from './models/RegionRequest';
 export type { Revision } from './models/Revision';
@@ -252,3 +251,4 @@ export type { UploadCreate } from './models/UploadCreate';
 export type { UploadCreateRequest } from './models/UploadCreateRequest';
 export type { User } from './models/User';
 export type { UserRequest } from './models/UserRequest';
+export { UserRoleEnum } from './models/UserRoleEnum';

package/types/openapi/models/AppRelease.d.ts

@@ -1,9 +1,6 @@
 import { MiniUser } from './MiniUser';
 export type AppRelease = {
     version: string;
-    readonly created_by: MiniUser;
+    created_by: MiniUser;
     readonly created_at: string;
-    readonly modified_at: string;
-    readonly modified_by: MiniUser;
-    readonly owned_by: MiniUser;
 };

package/types/openapi/models/BulkDeleteMixedObjectsRequest.d.ts

@@ -0,0 +1,7 @@
+export type BulkDeleteMixedObjectsRequest = {
+    instance_id: string;
+    file_ids?: Array<string>;
+    folder_ids?: Array<string>;
+    canvas_ids?: Array<string>;
+    favorite_ids?: Array<string>;
+};

package/types/openapi/models/DeletedInstance.d.ts

@@ -9,7 +9,7 @@ export type DeletedInstance = {
     color?: string | null;
     logo?: string | null;
     readonly last_login: string;
-    storage_region?: StorageRegionEnum;
+    readonly storage_region: StorageRegionEnum;
     readonly environment: MiniEnvironment;
     readonly region: MiniRegion;
     readonly role: InstanceMembershipRoleEnum;

package/types/openapi/models/FavoriteUpdate.d.ts

@@ -3,7 +3,7 @@ import { MiniFolder } from './MiniFolder';
 import { MiniPage } from './MiniPage';
 export type FavoriteUpdate = {
     readonly id: string;
-    name?: string;
+    name: string;
     readonly thumbnail_url: string;
     readonly file: FavoriteFile | null;
     readonly page: MiniPage | null;

package/types/openapi/models/FavoriteUpdateRequest.d.ts

@@ -1,6 +1,3 @@
 export type FavoriteUpdateRequest = {
-    name?: string;
-    file_id?: string;
-    page_index?: number;
-    folder_id?: string;
+    name: string;
 };

package/types/openapi/models/FileCreate.d.ts

@@ -33,6 +33,7 @@ export type FileCreate = {
     readonly role: CollaborationRoleEnum;
     permissions?: FilePermission;
     readonly pspdfkit_server_url: string | null;
+    readonly pspdfkit_document_id: string | null;
     readonly pspdfkit_auth_payload: Record<string, any> | null;
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;

package/types/openapi/models/FileRetrieve.d.ts

@@ -33,6 +33,7 @@ export type FileRetrieve = {
     readonly role: CollaborationRoleEnum;
     permissions?: FilePermission;
     readonly pspdfkit_server_url: string | null;
+    readonly pspdfkit_document_id: string | null;
     readonly pspdfkit_auth_payload: Record<string, any> | null;
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;

package/types/openapi/models/FileUpdate.d.ts

@@ -33,6 +33,7 @@ export type FileUpdate = {
     readonly role: CollaborationRoleEnum;
     permissions?: FilePermission;
     readonly pspdfkit_server_url: string | null;
+    readonly pspdfkit_document_id: string | null;
     readonly pspdfkit_auth_payload: Record<string, any> | null;
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;

package/types/openapi/models/FolderFile.d.ts

@@ -10,6 +10,7 @@ export type FolderFile = {
     readonly thumbnail_url: string;
     readonly tags: Array<string>;
     permissions?: FilePermission;
+    readonly metadata: Record<string, any>;
     readonly created_by: MiniUser;
     readonly owned_by: MiniUser;
     readonly modified_at: string;

package/types/openapi/models/Instance.d.ts

@@ -9,7 +9,7 @@ export type Instance = {
     color?: string | null;
     logo?: string | null;
     readonly last_login: string;
-    storage_region?: StorageRegionEnum;
+    readonly storage_region: StorageRegionEnum;
     readonly environment: MiniEnvironment;
     readonly region: MiniRegion;
     readonly role: InstanceMembershipRoleEnum;