@pitcher/js-api 1.22.0-alpha.5 → 1.22.0-beta.0

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

@@ -1,56 +1,188 @@
-import { MiniPage, File, Canvas } from '../../types/openapi';
+import { MiniPage, File, CanvasRetrieve } from '../../types/openapi';
 
+/**
+ * Payload for getting instance metadata templates.
+ */
 export interface GetInstanceMetadataTemplatesPayload {
+    /**
+     * Ordering of the metadata templates. String containing field name to order by.
+     */
     ordering?: string;
+    /**
+     * Page number for pagination.
+     */
     page?: number;
+    /**
+     * Number of items per page.
+     */
     page_size?: number;
+    /**
+     * Search query for filtering metadata templates.
+     */
     search?: string;
 }
+/**
+ * Payload for listing files with optional filters.
+ */
 export type ListFilesPayload = Partial<Omit<File, 'type'>> & {
+    /**
+     * Range filter for creation date.
+     */
     created_at__range?: string;
+    /**
+     * Range filter for expiration date.
+     */
     expires_at__range?: string;
+    /**
+     * Range filter for update date.
+     */
     updated_at__range?: string;
+    /**
+     * Filter for file IDs.
+     */
     id__in?: string;
+    /**
+     * Filter for file types.
+     */
     type?: File['type'] | File['type'][];
+    /**
+     * Filter for content types.
+     */
     content_type?: File['content_type'] | File['content_type'][];
 };
+/**
+ * Payload for getting recent files.
+ */
 export type GetRecentFilesPayload = {
+    /**
+     * Number of recent files to retrieve.
+     */
     size?: number;
 };
+/**
+ * Payload for sending a notification.
+ */
 export interface NotificationPayload {
+    /**
+     * Content of the notification.
+     */
     content: string;
+    /**
+     * Type of the notification.
+     */
     type?: 'native' | 'alert';
 }
+/**
+ * Payload for executing a query.
+ */
 export interface QueryPayload {
+    /**
+     * The query string to execute.
+     */
     query: string;
+    /**
+     * Optional arguments for the query.
+     */
     args?: string[][];
 }
+/**
+ * Payload for submitting user feedback.
+ */
 export interface SubmitUserFeedbackPayload {
+    /**
+     * Type of feedback being submitted.
+     */
     type: 'bug' | 'feedback';
+    /**
+     * Data associated with the feedback.
+     */
     data: Record<string, any>;
 }
+/**
+ * Payload object for opening a file.
+ */
 export interface OpenRequestPayload {
+    /**
+     * Id of the file to open.
+     */
     fileId?: File['id'];
-    fromCanvasId?: Canvas['id'];
+    /**
+     * Id of the canvas from which the file is opened.
+     */
+    fromCanvasId?: CanvasRetrieve['id'];
+    /**
+     * Optional, page index to open. Default is `null`.
+     */
     pageIndex?: MiniPage['page_index'];
+    /**
+     * URL of the file content.
+     */
     url?: File['content_url'];
+    /**
+     * Indicates if the canvas is in view.
+     */
     canvasInView?: boolean;
+    /**
+     * Indicates if the user is in a call.
+     */
     isInCall?: boolean;
+    /**
+     * Optional, overrides over the context of the current canvas, useful for injecting file annotation data. Default is {}.
+     */
     context?: Record<string, any>;
+    /**
+     * Search query string within the file.
+     */
     search?: string;
+    /**
+     * Indicates if the file should be opened in a new tab.
+     */
     newTab?: boolean;
 }
+/**
+ * Payload object for opening an external URL.
+ */
 export interface OpenExternalUrlRequestPayload {
+    /**
+     * The URL to open.
+     */
     url: string;
+    /**
+     * The target where the URL should be opened. Defaults to '_blank'.
+     */
     target?: '_self' | '_blank';
+    /**
+     * Additional options for opening the URL.
+     */
     options?: string;
 }
+/**
+ * Payload object for opening a web view that is always on top.
+ */
 export interface OpenWebViewAlwaysOnTop {
+    /**
+     * The URL to open in the web view.
+     */
     url: string;
+    /**
+     * Settings for the modal window.
+     */
     modal_settings: {
+        /**
+         * The width of the modal window.
+         */
         width: number;
+        /**
+         * The height of the modal window.
+         */
         height: number;
+        /**
+         * The y-coordinate of the modal window.
+         */
         y: number;
+        /**
+         * The x-coordinate of the modal window.
+         */
         x: number;
     };
 }

package/lib/sdk/utils/httpFetch.d.ts

@@ -0,0 +1,15 @@
+type FetchOptions = {
+    method?: string;
+    headers?: Record<string, string>;
+    body?: string;
+    credentials?: RequestCredentials;
+    params?: Record<string, any>;
+};
+export declare function createHttpClient(origin: string, token: string): {
+    get: (endpoint: string, options?: FetchOptions) => Promise<any>;
+    post: (endpoint: string, body?: object, options?: FetchOptions) => Promise<any>;
+    put: (endpoint: string, body: object, options?: FetchOptions) => Promise<any>;
+    delete: (endpoint: string, options?: FetchOptions) => Promise<any>;
+    patch: (endpoint: string, body: object, options?: FetchOptions) => Promise<any>;
+};
+export {};

package/lib/sdk/utils/object.d.ts

@@ -0,0 +1 @@
+export declare function truncateObject(obj: any, currentDepth?: number, lengthTrigger?: number): any;

package/lib/sdk/utils/object.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/theme/light.d.ts

@@ -969,9 +969,11 @@ export declare const lightThemeOverrides: import('vue').ComputedRef<{
         fontSizeLarge: string;
         borderColor: string;
         tdColorHover: string;
+        tdColorSorting: string;
         tdColorStriped: string;
         thColor: string;
         thColorHover: string;
+        thColorSorting: string;
         tdColor: string;
         tdTextColor: string;
         thTextColor: string;
@@ -981,15 +983,19 @@ export declare const lightThemeOverrides: import('vue').ComputedRef<{
         thIconColorActive: string;
         borderColorModal: string;
         tdColorHoverModal: string;
+        tdColorSortingModal: string;
         tdColorStripedModal: string;
         thColorModal: string;
         thColorHoverModal: string;
+        thColorSortingModal: string;
         tdColorModal: string;
         borderColorPopover: string;
         tdColorHoverPopover: string;
+        tdColorSortingPopover: string;
         tdColorStripedPopover: string;
         thColorPopover: string;
         thColorHoverPopover: string;
+        thColorSortingPopover: string;
         tdColorPopover: string;
         boxShadowBefore: string;
         boxShadowAfter: string;
@@ -1019,9 +1025,11 @@ export declare const lightThemeOverrides: import('vue').ComputedRef<{
         fontSizeLarge: string;
         borderColor: string;
         tdColorHover: string;
+        tdColorSorting: string;
         tdColorStriped: string;
         thColor: string;
         thColorHover: string;
+        thColorSorting: string;
         tdColor: string;
         tdTextColor: string;
         thTextColor: string;
@@ -1031,15 +1039,19 @@ export declare const lightThemeOverrides: import('vue').ComputedRef<{
         thIconColorActive: string;
         borderColorModal: string;
         tdColorHoverModal: string;
+        tdColorSortingModal: string;
         tdColorStripedModal: string;
         thColorModal: string;
         thColorHoverModal: string;
+        thColorSortingModal: string;
         tdColorModal: string;
         borderColorPopover: string;
         tdColorHoverPopover: string;
+        tdColorSortingPopover: string;
         tdColorStripedPopover: string;
         thColorPopover: string;
         thColorHoverPopover: string;
+        thColorSortingPopover: string;
         tdColorPopover: string;
         boxShadowBefore: string;
         boxShadowAfter: string;

package/lib/types/app.d.ts

@@ -23,6 +23,16 @@ export type ModuleSettings = {
 export type EmbeddedLocationProperties = {
     start_in_loading_mode?: boolean;
 };
+export type EmbeddedAppShortcut = {
+    id: string;
+    order_override?: number;
+    icon?: string;
+};
+export type EmbeddedAppShortcutsDict = {
+    fullscreen: EmbeddedAppShortcut[];
+    presentation: EmbeddedAppShortcut[];
+    edit: EmbeddedAppShortcut[];
+};
 export type Module = {
     enabled: boolean;
     headless?: boolean;
@@ -36,6 +46,7 @@ export type Module = {
         };
         settings?: Record<string, unknown>;
     };
+    shortcuts: EmbeddedAppShortcutsDict;
 } & EmbeddedLocationProperties;
 export type AppJson = {
     name: string;

package/lib/types/call.d.ts

@@ -1,6 +1,6 @@
 import { RouteLocation } from 'vue-router';
-import { SfEventExtended, SfAccountMini, SfUser, SfContactBasic } from './sfdc';
-import { Canvas } from '../../types/openapi';
+import { SfEventExtended, SfAccountMini, SfAccount, SfUser, SfContactBasic } from './sfdc';
+import { CanvasRetrieve } from '../../types/openapi';
 
 export declare const CALL_STORAGE_KEY = "call";
 export interface EventDate {
@@ -31,12 +31,13 @@ export interface Call {
     selectedContacts: SfContactBasic[];
     selectedUsers: SfUser[];
     accountPreselected: boolean;
-    selectedCanvas: Canvas | null;
+    selectedCanvas: CanvasRetrieve | null;
     callState: CallState;
     callStoppedAt: RouteLocation | null;
     eventDate: EventDate;
     postAction?: string | null;
     postActionPath?: string | null;
     presentationHistory?: CallPresentationHistory;
+    recentAccounts?: SfAccount[];
 }
 export declare const INITIAL_CALL_STATE: Call;

package/lib/types/files.d.ts

@@ -1,12 +1,38 @@
-import { FileCreateRequest } from '../../types/openapi';
+import { Favorite, FileCreateRequest } from '../../types/openapi';
+import { RecentFile } from './recentFiles.types';
+import { CompactFile, CompactFolder } from '@browser/stores/api';
 
 export interface DeviceFileCreateRequest extends Omit<FileCreateRequest, 'content'> {
     path: string;
 }
 export type AllFileCreateRequest = FileCreateRequest | DeviceFileCreateRequest;
+export declare enum ViewCompactItemType {
+    File = "file",
+    Folder = "folder"
+}
+export type ViewCompactFile = Omit<CompactFile, 'created_by'> & {
+    type: ViewCompactItemType.File;
+    favoriteId?: Favorite['id'];
+    createdBy: string;
+    content_type?: string;
+};
+export type ViewCompactFolder = Omit<CompactFolder, 'created_by'> & {
+    type: ViewCompactItemType.Folder;
+    favoriteId?: Favorite['id'];
+    content_type?: null;
+    thubmnail_url?: null;
+    file_thumbnail_urls?: string[];
+    folders_count?: number;
+    files_count?: number;
+};
 export interface DeviceFile {
     name: string;
     type: string;
     path: string;
     size: number;
 }
+export type ViewCompactFileFolder = ViewCompactFolder | ViewCompactFile;
+export type RenderableFile = (Favorite & {
+    thumbnail_url?: string;
+    file_thumbnail_urls?: string[];
+}) | RecentFile | ViewCompactFileFolder;

package/lib/types/filter.d.ts

@@ -0,0 +1,5 @@
+import { MetadataTemplateField } from '../../types/openapi';
+
+export type MetadataTemplateFieldWithComponentName = MetadataTemplateField & {
+    componentName: string;
+};

package/lib/types/instance.types.d.ts

@@ -0,0 +1,18 @@
+import { Instance, InstanceUpdate, InstanceUpdateRequest, InstanceRequest, PatchedInstanceUpdateRequest } from '../../types/openapi';
+import { InstanceSettings } from './instanceSettings.types';
+
+export interface PitcherInstance extends Omit<Instance, 'settings'> {
+    readonly settings?: InstanceSettings;
+}
+export interface PitcherInstanceUpdate extends Omit<InstanceUpdate, 'settings'> {
+    settings?: InstanceSettings | null;
+}
+export interface PitcherInstanceUpdateRequest extends Omit<InstanceUpdateRequest, 'settings'> {
+    settings?: InstanceSettings | null;
+}
+export interface PitcherPatchedInstanceUpdateRequest extends Omit<PatchedInstanceUpdateRequest, 'settings'> {
+    settings?: InstanceSettings | null;
+}
+export interface PitcherInstanceRequest extends Omit<InstanceRequest, 'settings'> {
+    settings?: InstanceSettings | null;
+}

package/lib/types/{instanceSettings.d.ts → instanceSettings.types.d.ts}

@@ -1,4 +1,5 @@
 import { ComponentTypes } from '../apps/canvas-builder/types/canvas';
+import { OrganizationSettings } from './organizationSettings.types';
 
 export declare enum CanvasExcludedComponentTypesEnum {
     Root = "Root",
@@ -11,11 +12,18 @@ export type CanvasComponentTypes = Exclude<keyof typeof ComponentTypes, CanvasEx
 export type CanvasComponentAvailability = {
     [component in CanvasComponentTypes]: boolean;
 };
-export type InstanceSettings = {
+export type AutohideSectionOnCreated = {
+    autohide_in_shared_link?: string;
+    start_date?: Date;
+};
+export type InstanceSettings = OrganizationSettings & {
     canvas?: {
+        autohide_section_on_created?: AutohideSectionOnCreated;
         component_availability?: CanvasComponentAvailability & {
             apps?: Record<string, boolean>;
         };
-        autofill_metadata_mismatch_properties?: string[];
+        content_grid_autofill_files_filter_iteratee?: string;
+        section_content_grid_autofill_files_filter_iteratee?: string;
+        show_extra_exit_button_in_fullscreen_mode?: boolean;
     };
 };

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

@@ -1,11 +1,9 @@
-import { TranslationOverrides } from './translations';
-
-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_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_experimental_canvas_builder_dnd' | '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_popularity_icons' | 'show_system_filters';
+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_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_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';
+export type LaunchDarklyNumberFlagKey = 'canvas_section_selector_page_size' | 'canvas_section_selector_selected_items_with_thumbnail_size';
 type LaunchDarklyObjectFlags = {
     canvas_table_pagination: CanvasTablePagination;
     canvas_manager_table_columns: CanvasManagerTableColumns;
     context_crm_shape: Record<string, any>;
-    translation_overrides: TranslationOverrides;
 };
 export type LaunchDarklyObjectFlagKey = keyof LaunchDarklyObjectFlags;
 export type LaunchDarklyStringFlagKey = keyof typeof LaunchDarklyStringFlags;
@@ -32,6 +30,8 @@ export type LaunchDarklyEnv = {
     [K in LaunchDarklyBooleanFlagKey]?: boolean;
 } & {
     [K in LaunchDarklyStringFlagKey]?: LaunchDarklyStringFlagValue<K>;
+} & {
+    [K in LaunchDarklyNumberFlagKey]?: number;
 } & {
     [K in keyof LaunchDarklyObjectFlags]?: LaunchDarklyObjectFlags[K];
 } & {

package/lib/types/organization.types.d.ts

@@ -6,9 +6,9 @@ export interface PitcherOrg extends Omit<Organization, 'metadata' | 'settings'>
     readonly metadata: OrganizationMetadata;
     readonly settings: OrganizationSettings;
 }
-export interface OrganizationUpdateExtended extends Omit<OrganizationUpdate, 'settings'> {
+export interface PitcherOrganizationUpdate extends Omit<OrganizationUpdate, 'settings'> {
     settings?: OrganizationSettings | null;
 }
-export interface OrganizationUpdateRequestExtended extends Omit<OrganizationUpdateRequest, 'settings'> {
+export interface PitcherOrganizationUpdateRequest extends Omit<OrganizationUpdateRequest, 'settings'> {
     settings?: OrganizationSettings | null;
 }

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

@@ -1,3 +1,7 @@
+import { TranslationOverrides } from './translations';
+
 export type OrganizationSettings = {
     impact_show_only_saved_canvases_in_canvas_manager?: boolean;
+    translation_overrides?: TranslationOverrides;
+    file_annotations?: 'admin' | 'personal';
 };

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

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

package/lib/types/users.d.ts

@@ -1,12 +1,25 @@
 import { Ref } from 'vue';
 
+/**
+ * Parameters for getting users
+ */
 export interface GetUsersParams {
+    /** Search term, can be a string or a Vue ref to a string */
     search?: Ref<string> | string;
+    /** Filters for the user query, can be any type of Vue ref */
     filters?: Ref<any>;
 }
+/**
+ * Request parameters for refreshing a service token
+ */
 export interface RefreshServiceTokenRequest {
+    /** Optional provider for the service token */
     provider?: string;
 }
+/**
+ * Response from refreshing a service token
+ */
 export interface RefreshServiceTokenResponse {
+    /** The new access token */
     access_token: string;
 }

package/lib/util/fullscreen.util.d.ts

@@ -11,6 +11,6 @@ export type DocumentWithFullscreen = Document & {
     msExitFullscreen?: () => Promise<void>;
 };
 export declare function requestFullscreen(el?: FullscreenElement | null): Promise<void>;
-export declare function exitFullscreen(): void;
+export declare function exitFullscreen(): Promise<void>;
 export declare function toggleFullscreen(element: FullscreenElement): void;
 export declare function isFullscreen(): boolean;

package/lib/util/string.d.ts

@@ -1,4 +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 stripHtmlTagsAndTrim(htmlString: string | undefined): string;

package/package.json

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