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

package/lib/composables/instanceTagsActions.use.d.ts

@@ -1,10 +1,14 @@
 import { Tag, Instance } from '../../types/openapi';
+import { InstanceTagsCanvasType, InstanceTagsType } from '../types/instanceTags.types';
 export default function useInstanceTagsActions(): {
-    fetchInstanceTags: ({ search, instanceId, page, pageSize, }: {
+    fetchInstanceTags: ({ search, instanceId, page, pageSize, includeHidden, canvasType, type, }: {
         search: string;
         instanceId?: Instance["id"];
         page?: number;
         pageSize?: number;
+        includeHidden?: boolean;
+        canvasType?: InstanceTagsCanvasType;
+        type?: InstanceTagsType[];
     }) => Promise<Tag[]>;
     fetchAllInstanceTags: ({ search, instanceId }: {
         search?: string;

package/lib/composables/openFileStack.use.d.ts

@@ -0,0 +1,20 @@
+interface StackItem {
+    fileId: string;
+    pageIndex: number;
+    startTime?: number;
+}
+export default function useOpenFileStack(): {
+    resetStack: () => void;
+    pushToStack: (fileId: string, pageIndex: number, startTime?: number) => void;
+    popFromStack: () => StackItem | undefined;
+    fileStack: Readonly<import('vue').Ref<readonly {
+        readonly fileId: string;
+        readonly pageIndex: number;
+        readonly startTime?: number | undefined;
+    }[], readonly {
+        readonly fileId: string;
+        readonly pageIndex: number;
+        readonly startTime?: number | undefined;
+    }[]>>;
+};
+export {};

package/lib/composables/presentationHistory.use.d.ts

@@ -0,0 +1,12 @@
+import { Ref } from 'vue';
+import { Call, ContentRating } from '../types/call';
+import { CDP_EVENT_TYPE } from '../constants/cdp.const';
+export default function usePresentationHistory(): {
+    updatePresentationHistory: (p: {
+        eventName: (typeof CDP_EVENT_TYPE)[keyof typeof CDP_EVENT_TYPE];
+        payload: any;
+        call: Ref<Call>;
+        canvasName?: string;
+    }) => void;
+    setMetadataItem: (call: Ref<Call>, id: string, rating: ContentRating) => void;
+};

package/lib/composables/recentFiles.use.d.ts

@@ -7,5 +7,6 @@ export default function useRecentFiles({ instanceId, app, }: {
 }): {
     addRecentFile: (file: RecentFile) => void;
     instanceRecentFiles: ComputedRef<RecentFile[]>;
-    updateRecentFiles: (files: Partial<RecentFile>[]) => void;
+    updateRecentFiles: (files: Partial<RecentFile>[]) => RecentFile[];
+    updatePageInRecentFile: (fileId: string, pageIndex: number) => void;
 };

package/lib/composables/suggestedTags.use.d.ts

@@ -1,3 +1,8 @@
+import { InstanceTagsCanvasType, InstanceTagsType } from '../types/instanceTags.types';
 export default function useSuggestedTags(): {
-    fetchSuggestedInstanceTags: (search: string) => Promise<string[]>;
+    fetchSuggestedInstanceTags: (search: string, { includeHidden, canvasType, type, }?: {
+        includeHidden?: boolean;
+        canvasType?: InstanceTagsCanvasType;
+        type?: InstanceTagsType[];
+    }) => Promise<string[]>;
 };

package/lib/composables/useAssetUpload.d.ts

@@ -1,5 +1,5 @@
 import { AxiosProgressEvent } from 'axios';
 export declare function useAssetUpload(): {
-    isUploading: import('vue').Ref<boolean>;
+    isUploading: import('vue').Ref<boolean, boolean>;
     uploadAsset: (file: File, onUploadProgress?: (progress: AxiosProgressEvent, file: File) => void) => Promise<import('../../types/openapi').FileRetrieve>;
 };

package/lib/composables/useCanvasTablesPagination.d.ts

@@ -1,13 +1,15 @@
-interface PaginationPayload<T> {
+import { Ref, UnwrapRef } from 'vue';
+type PaginationPayload<T> = {
     storageKey?: string;
     initialFilters: T;
     initialOrdering: string;
-}
-declare const _default: <T>({ storageKey, initialFilters, initialOrdering }: PaginationPayload<T>) => {
-    search: import('vue').Ref<string>;
-    pageSize: import('vue').Ref<number>;
-    selectedFilters: import('vue').Ref<T | import('vue').UnwrapRef<T>>;
-    page: import('vue').Ref<number>;
-    ordering: import('vue').Ref<string>;
 };
+type PaginationReturn<T> = {
+    search: Ref<string>;
+    pageSize: Ref<number>;
+    selectedFilters: Ref<T> | Ref<UnwrapRef<T>, T | UnwrapRef<T>>;
+    page: Ref<number>;
+    ordering: Ref<string>;
+};
+declare const _default: <T>({ storageKey, initialFilters, initialOrdering }: PaginationPayload<T>) => PaginationReturn<T>;
 export default _default;

package/lib/composables/useElementHeightResize.d.ts

@@ -1,4 +1,4 @@
 import { Ref } from 'vue';
 export declare function useElementHeightResize(toolbarWrapper: Ref<HTMLElement | null>, calculateWrapperHeight: (height: number) => string): {
-    wrapperHeight: Ref<string>;
+    wrapperHeight: Ref<string, string>;
 };

package/lib/composables/useFileDisplayHelpers.d.ts

@@ -0,0 +1,8 @@
+import { ViewCompactFolder } from '../types/files';
+import { FileContentTypeEnum } from '../../types/openapi';
+export default function useFileDisplayHelpers(): {
+    getFolderDescription: (item: Partial<ViewCompactFolder>) => string;
+    renderContentType: (contentType: FileContentTypeEnum) => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+        [key: string]: any;
+    }>;
+};

package/lib/composables/useLocation.d.ts

@@ -18,7 +18,7 @@ export default function useLocation({ app, router, isReady, isRoot, selfRegister
     relations: Record<string, string>;
     unmount: () => Promise<void>;
     update: (newRoutes: UpdateLocationOnUpdate["routes"]) => Promise<void>;
-    isPathRestored: import('vue').Ref<boolean>;
+    isPathRestored: import('vue').Ref<boolean, boolean>;
     isAppMounted: import('vue').ComputedRef<boolean>;
     isAppRestored: import('vue').ComputedRef<boolean>;
     app: string;

package/lib/composables/useLocationManipulation.d.ts

@@ -21,7 +21,7 @@ interface Route {
     query: LocationQuery;
 }
 export default function useLocationManipulation({ routes, relations, app, actionsQueue }: UseLocationManipulation): {
-    isPathRestored: Ref<boolean>;
+    isPathRestored: Ref<boolean, boolean>;
     isAppMounted: import('vue').ComputedRef<boolean>;
     isAppRestored: import('vue').ComputedRef<boolean>;
     recoverRouteFromLocations: (rootApp: string) => Route;

package/lib/composables/useMetadataFilters.d.ts

@@ -1,9 +1,11 @@
+import { MetadataTemplateField, MetadataTemplateOption } from '../../types/openapi';
 export declare function getComponentNameByFilterType(type: string): "CSearchFilter" | "CSelectFilter" | "CDateRangeFilter";
-export declare function getBooleanOptions(): {
-    label: string;
-    value: string;
-}[];
-export default function useMetadataFilters(): {
-    getBooleanOptions: typeof getBooleanOptions;
+export default function useMetadataFilters(t: (input: string) => string): {
+    getBooleanOptions: () => {
+        label: string;
+        value: string;
+    }[];
     getComponentNameByFilterType: typeof getComponentNameByFilterType;
+    getDefaultDateOptions: () => MetadataTemplateOption[];
+    getFilterOptions: (type: MetadataTemplateField["type"], options: MetadataTemplateField["options"]) => MetadataTemplateOption[];
 };

package/lib/composables/useSharedTranslations.d.ts

@@ -0,0 +1,10 @@
+export default function useSharedTranslations(): {
+    typographyPresetTranslations: {
+        h_1: string;
+        h_2: string;
+        h_3: string;
+        big_text: string;
+        normal_text: string;
+        small_text: string;
+    };
+};

package/lib/composables/useThemeVars.d.ts

@@ -26,5 +26,33 @@ declare const _default: () => import('vue').Ref<{
     boxShadow: string;
     boxShadow2: string;
     boxShadow3: string;
+}, import('../main.lib').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 default _default;

package/lib/constants/cdp.const.d.ts

@@ -11,12 +11,16 @@ export declare const CDP_EVENT_TYPE: {
     readonly canvasEntered: "Canvas Entered";
     readonly canvasExited: "Canvas Exited";
     readonly canvasShared: "Canvas Shared";
+    readonly customerSentimentCaptured: "Customer Sentiment Captured";
+    readonly canvasPageEntered: "Canvas Page Entered";
+    readonly canvasPageExited: "Canvas Page Exited";
     readonly canvasComponentEntered: "Canvas Component Entered";
     readonly canvasComponentExited: "Canvas Component Exited";
     readonly canvasFileDownloaded: "Canvas File Downloaded";
     readonly canvasDownloaded: "Canvas Downloaded";
     readonly userFeedbackCaptured: "User Feedback Captured";
     readonly userBugReported: "User Bug Reported";
+    readonly userFileReviewed: "User File Reviewed";
 };
 export declare const CLIENT_TYPE: {
     readonly admin: "admin";
@@ -39,3 +43,8 @@ export declare const EMBED_TYPE: {
     readonly sfdc: "sfdc";
     readonly pwa: "pwa";
 };
+export interface TrackingEvent {
+    event_name: string;
+    payload: any;
+}
+export declare const TRACKING_EVENTS_STORAGE_KEY: "tracking_events";

package/lib/constants/i18n.const.d.ts

@@ -1,5 +1,5 @@
 import { SupportedLocale } from '../types/i18n.types';
-export declare const supportedLocales: ["en", "de", "pl", "tr", "el"];
+export declare const supportedLocales: SupportedLocale[];
 export declare const fallbackLocale: "en";
 export declare const locales: Record<SupportedLocale, {
     locale: any;
@@ -7,6 +7,6 @@ export declare const locales: Record<SupportedLocale, {
 }>;
 export declare const localeNames: Record<SupportedLocale, string>;
 export declare const localeDropdownOptions: {
-    key: "en" | "de" | "pl" | "tr" | "el";
+    key: SupportedLocale;
     name: string;
 }[];

package/lib/constants/pitcherSettings.const.d.ts

@@ -1,3 +1,4 @@
 import { OrganizationSettings } from '../types/organizationSettings.types';
 import { InstanceSettings } from '../types/instanceSettings.types';
 export declare const DEFAULT_PITCHER_SETTINGS: OrganizationSettings & InstanceSettings;
+export declare const PITCHER_SETTINGS_KEY = "pitcher_settings";

package/lib/constants/timers.const.d.ts

@@ -1 +1,2 @@
 export declare const SEARCH_DEBOUNCE_TIME = 850;
+export declare const REQUEST_DEFAULT_CANCEL_TIMEOUT = 30000;

package/lib/directives/tap.d.ts

@@ -0,0 +1,9 @@
+type TapElement = HTMLElement & {
+    _tapDirectiveCleanup?: () => void;
+};
+declare const tapDirective: {
+    name: string;
+    mounted(element: TapElement, binding: any): void;
+    beforeUnmount(element: TapElement): void;
+};
+export default tapDirective;

package/lib/directives/usage-track.directive.d.ts

@@ -0,0 +1,10 @@
+import { DirectiveBinding } from 'vue';
+interface TrackingValue {
+    id: string;
+    payload?: Record<string, any>;
+}
+declare const _default: {
+    mounted(el: HTMLElement, binding: DirectiveBinding<TrackingValue>): void;
+    updated(el: HTMLElement, binding: DirectiveBinding<TrackingValue>): void;
+};
+export default _default;

package/lib/main.lib.d.ts

@@ -62,6 +62,7 @@ export { default as CCanvasDeleteDialogContent } from './components/canvases/CCa
 export { default as CSectionManagement } from './components/sections/CSectionManagement.vue';
 export { default as CTemplateManagement } from './components/canvas-templates/CTemplateManagement.vue';
 export { default as CSavedCanvasesManagement } from './components/savedCanvases/CSavedCanvasesManagement.vue';
+export { default as useShareCanvas } from './components/savedCanvases/CSavedCanvasesManagementShareCanvas.use';
 export { default as CConfigEditor } from './components/CConfigEditor/CConfigEditor.vue';
 export { default as CTableInput } from './components/CTableInput/CTableInput.vue';
 export { default as CTableTag } from './components/CTableTag/CTableTag.vue';
@@ -92,6 +93,7 @@ export { default as CChip } from './components/CChip/CChip.vue';
 export { default as CSettingsEditor } from './components/CSettingsEditor/CSettingsEditor.vue';
 export { default as CanvasBuilderApp } from '@canvas-builder/App.vue';
 export { type CanvasBuilderProps, CanvasBuilderMode } from '@canvas-builder/types/canvas';
+export { type FontAwesomeType } from '@canvas-builder/types/font-awesome.types';
 export { default as Browser } from '@browser/App.vue';
 export { type BrowserSectionType } from '@browser/stores/app';
 export { default as ContentSelector } from '@content-selector/App.vue';
@@ -103,14 +105,18 @@ export { default as useNotesApp } from '@notes/composables/useNotesApp';
 export { default as useTheme } from './composables/useTheme';
 export { default as useThemeVars } from './composables/useThemeVars';
 export { default as useBindValidation } from './composables/useBindValidation';
+export { default as useFileDisplayHelpers } from './composables/useFileDisplayHelpers';
 export { default as useCanvasOverlay } from './composables/useCanvasOverlay';
 export { default as useInfiniteScroll } from './composables/useInfiniteScroll';
 export { default as useWindowEvents } from './composables/useWindowEvents';
 export { default as useConfirmation } from './composables/useConfirmation';
 export { default as useLocation } from './composables/useLocation';
 export { default as useRecentFiles } from './composables/recentFiles.use';
+export { default as usePresentationHistory } from './composables/presentationHistory.use';
 export { default as useToast } from './composables/useToast';
 export { default as useSuggestedTags } from './composables/suggestedTags.use';
+export { default as useOpenFileStack } from './composables/openFileStack.use';
+export { default as useCanvasVisibility } from './apps/canvas-builder/composables/useCanvasVisibility';
 export * from './plugins/vueQuery';
 export * from './apps/canvas-builder/util/canvas.util';
 export * from './apps/canvas-builder/util/tree';
@@ -138,6 +144,7 @@ export * from './util/translations';
 export * from './util/tsHelpers';
 export * from './util/user';
 export * from './util/userAgents';
+export * from './util/usage-tracking.util';
 export * from './sdk/main';
 export * from '../types/openapi';
 export * from './components/CGlobalSearch/CGlobalSearch.types';
@@ -179,8 +186,10 @@ export * from './api/users/users.queries';
 export * from './api/canvases/canvases.queries';
 export * from './api/events/events.helpers';
 export { default as draggableDirective } from './directives/draggable';
+export { default as tapDirective } from './directives/tap';
 export { default as clickOutsideDirective } from './directives/clickOutside';
 export { default as autofocusDirective } from './directives/autofocus';
 export { default as tooltipDirective } from './directives/tooltip';
+export { default as usageTrackDirective } from './directives/usage-track.directive';
 export * from './constants/i18n.const';
 export * from './types/i18n.types';

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

@@ -137,6 +137,10 @@ export declare function createHighLevelApi(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;
@@ -152,6 +156,10 @@ export declare function createHighLevelApi(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>;
@@ -160,6 +168,10 @@ export declare function createHighLevelApi(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;
@@ -219,5 +231,6 @@ export declare function createHighLevelApi(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: LowLevelApi;
 };

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

@@ -28,6 +28,10 @@ export declare function getFile(payload: {
  * adminApi.getFiles()
  */
 export declare function getFiles(payload: Record<string, any>): Promise<PaginatedFileList>;
+export declare function open(payload: {
+    id: File['id'];
+}): Promise<void>;
+export declare function close(): Promise<void>;
 /**
  * Opens a selector that allows you to select (and preselect) from your Pitcher uploaded content.
  *

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

@@ -22,6 +22,10 @@ declare const _default: {
         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('./types.admin').AdminSelectContentRequest): Promise<import('./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>;

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

@@ -1,5 +1,6 @@
 import { PitcherEnv } from '../../../interfaces';
 import { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile } from '@content-selector/stores/app';
+import { Selection as ContentSelectorSelection } from '@content-selector/appTypes';
 import { Canvas } from '../../../../../types/openapi';
 import { CanvasSelection } from '@canvas-selector/appTypes';
 export declare const ADMIN_MESSAGE: "ADMIN_MESSAGE";
@@ -18,6 +19,8 @@ export declare const ADMIN_API_METHOD_TYPES: {
     readonly OPEN_CANVAS_OVERLAY: "admin_open_canvas_overlay";
     readonly GET_ENV: "admin_get_env";
     readonly GET_FILE: "admin_get_file";
+    readonly OPEN: "admin_open_file_overlay";
+    readonly CLOSE: "admin_close_file_overlay";
     readonly GET_FILES: "admin_get_files";
     readonly GET_INSTANCE_METADATA_TEMPLATES: "admin_get_instance_metadata_templates";
     readonly TOAST: "admin_toast";
@@ -89,9 +92,25 @@ export interface AdminToastRequest {
  */
 export type AdminSelectContentRequest = {
     /**
-     * List of selections to be made (optional).
+     * List of selections to hydrate the picker with.
      */
-    selections?: Selection[];
+    selections?: ContentSelectorSelection[];
+    /**
+     * Maximum number of selections allowed (optional).
+     */
+    max_selections?: number;
+    /**
+     * Type of content to allow selection for (optional).
+     * file: Files only
+     * slide: Slides only
+     * content: Files and slides
+     * @default 'content'
+     */
+    content_type?: 'file' | 'slide' | 'content';
+    /**
+     * CSS style to apply to the picker (optional).
+     */
+    style?: Record<string, any>;
 };
 /**
  * Represents a response to a content selection request.
@@ -169,5 +188,7 @@ export type AdminEnv = {
     /**
      * Pitcher environment settings.
      */
+    mode?: PitcherEnv['mode'];
     pitcher: PitcherEnv['pitcher'];
+    state?: PitcherEnv['state'];
 };

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

@@ -1,4 +1,4 @@
-import { CanvasRetrieve, CanvasCreateRequest, PatchedCanvasUpdateRequest, SharedLink, Instance } from '../../../../types/openapi';
+import { CanvasRetrieve, CanvasCreateRequest, PatchedCanvasUpdateRequest, SharedLink, Instance, CanvasRecommendedFiles } from '../../../../types/openapi';
 import { GetCanvasesParams } from '../../../types/canvases';
 import { PaginatedData } from '../../../types/paginatedData';
 /**
@@ -51,3 +51,7 @@ export declare function getCanvas(payload: {
 export declare function shareCanvas(payload: {
     id: CanvasRetrieve['id'];
 }): Promise<SharedLink>;
+export declare function getCanvasRecommendedFiles(payload: {
+    canvas_id: CanvasRetrieve['id'];
+    match?: ('tags' | 'metadata')[];
+}): Promise<CanvasRecommendedFiles>;

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

@@ -35,4 +35,4 @@ export type DsrMessage<Payload = any> = {
         data: Payload;
     };
 };
-export type DsrEnv = Pick<PitcherEnv, 'mode' | 'launch_darkly' | 'client_type'>;
+export type DsrEnv = Pick<PitcherEnv, 'mode' | 'launch_darkly' | 'client_type' | 'state'>;

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

@@ -1,4 +1,4 @@
-import { File, FileRetrieve, PaginatedFileList, FileUpdateRequest } from '../../../../types/openapi';
+import { File, FileRetrieve, PaginatedFileList, FileUpdateRequest, FileRevision } from '../../../../types/openapi';
 import { GetRecentFilesPayload, ListFilesPayload } from '../../payload.types';
 import { AllFileCreateRequest, DeviceFile } from '../../../types/files';
 export declare function getFiles(payload: ListFilesPayload & {
@@ -16,6 +16,10 @@ export declare function getFile(payload: {
     id?: FileRetrieve['id'];
     file_id?: FileRetrieve['id'];
 }): Promise<FileRetrieve>;
+export declare function getFileRevisionData(payload: {
+    file_id: FileRetrieve['id'];
+    revision_id: FileRevision['id'];
+}): Promise<FileRetrieve>;
 export declare function updateFile(payload: FileUpdateRequest & {
     id: File['id'];
 }): Promise<FileRetrieve>;

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

@@ -0,0 +1,5 @@
+import { FileRetrieve, FileRevision } from '../../../../types/openapi';
+export declare function getFileRevisions(payload: {
+    id?: FileRetrieve['id'];
+    file_id?: FileRetrieve['id'];
+}): Promise<FileRevision[]>;

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

@@ -4,6 +4,7 @@ export * from './languages';
 export * from './events';
 export * from './canvas';
 export * from './files';
+export * from './filesRevisions';
 export * from './search';
 export * from './users';
 export * from './pspdfkit';
@@ -17,3 +18,4 @@ export * from './metadataTemplates';
 export * from './sync';
 export * from './feedback';
 export * from './webView';
+export * from './share';

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

@@ -0,0 +1,8 @@
+import { SharePayload, ShareResponse } from '../../payload.types';
+/**
+ * Dispatch iOS sharing dialog.
+ *
+ * @example
+ * api.share({text: "example text", subject: "example subject"})
+ */
+export declare function share(payload: SharePayload): Promise<ShareResponse>;

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

@@ -113,20 +113,20 @@ declare function onAppUpdateData(handler: (data: UiAppUpdateDataPayload) => Prom
  */
 declare function uiBroadcast(payload: UiBroadcastRequest): Promise<void>;
 declare const _default: {
-    promptPia(payload: import('../../../../main.lib').UiPromptPiaRequest): Promise<import('../../../../main.lib').UiPromptPiaResponse>;
-    completePostcall(payload: import('../../../../main.lib').UiCompletePostcallRequest): Promise<void>;
+    promptPia(payload: import('./types.ui').UiPromptPiaRequest): Promise<import('./types.ui').UiPromptPiaResponse>;
+    completePostcall(payload: import('./types.ui').UiCompletePostcallRequest): Promise<void>;
     cancelMeeting(): Promise<void>;
     resumeMeeting(): Promise<void>;
     stopMeeting(): Promise<void>;
     enablePostcallSubmit(): Promise<void>;
     disablePostcallSubmit(): Promise<void>;
-    setPostcallStyle(payload: import('../../../../main.lib').UiSetPostcallStyleRequest): Promise<void>;
-    updateCanvas(payload: import('../../../../main.lib').UiUpdateCanvasRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    setPostcallStyle(payload: import('./types.ui').UiSetPostcallStyleRequest): Promise<void>;
+    updateCanvas(payload: import('./types.ui').UiUpdateCanvasRequest): Promise<import('../../../../main.lib').CanvasRetrieve>;
     appLoaded(): Promise<void>;
-    appResize(payload: import('../../../../main.lib').UiAppResizeRequest): Promise<void>;
+    appResize(payload: import('./types.ui').UiAppResizeRequest): Promise<void>;
     canvasNavigateNextPage(): Promise<void>;
     canvasNavigatePreviousPage(): Promise<void>;
-    canvasNavigatePage(payload: import('../../../../main.lib').UiCanvasNavigatePageRequest): Promise<void>;
+    canvasNavigatePage(payload: import('./types.ui').UiCanvasNavigatePageRequest): Promise<void>;
     openCanvasOverlay(payload: {
         id: import('../../../../main.lib').CanvasRetrieve["id"];
         edit_mode?: boolean;
@@ -134,15 +134,15 @@ declare const _default: {
         component_id?: string;
         section_id?: string;
     }): Promise<void>;
-    selectCanvases(payload?: import('../../../../main.lib').UiSelectCanvasesRequest): Promise<import('../../../../main.lib').UiSelectCanvasesResponse>;
-    captureAppError(payload: import('../../../../main.lib').UiCaptureAppErrorRequest): Promise<void>;
-    updateLocation(payload: import('../../../../main.lib').UpdateLocationPitcherEvent): Promise<any>;
+    selectCanvases(payload?: import('./types.ui').UiSelectCanvasesRequest): Promise<import('./types.ui').UiSelectCanvasesResponse>;
+    captureAppError(payload: import('./types.ui').UiCaptureAppErrorRequest): Promise<void>;
+    updateLocation(payload: import('../../../interfaces').UpdateLocationPitcherEvent): Promise<any>;
     embeddableReady(): Promise<void>;
-    ui_select_content(payload?: import('../../../../main.lib').UiSelectContentRequest): Promise<import('../../../../main.lib').UiSelectContentResponse>;
-    selectContent(payload?: import('../../../../main.lib').UiSelectContentRequest): Promise<import('../../../../main.lib').UiSelectContentResponse>;
-    open(payload: import('../../../../main.lib').UiOpenRequest): Promise<void>;
-    toast(payload: import('../../../../main.lib').UiToastRequest): Promise<void>;
-    preselectSfdcMeetingId(payload: import('../../../../main.lib').UiPreselectSfdcMeetingIdRequest): Promise<import('../../../../main.lib').UiPreselectSfdcMeetingIdResponse>;
+    ui_select_content(payload?: import('./types.ui').UiSelectContentRequest): Promise<import('./types.ui').UiSelectContentResponse>;
+    selectContent(payload?: import('./types.ui').UiSelectContentRequest): Promise<import('./types.ui').UiSelectContentResponse>;
+    open(payload: import('./types.ui').UiOpenRequest): Promise<void>;
+    toast(payload: import('./types.ui').UiToastRequest): Promise<void>;
+    preselectSfdcMeetingId(payload: import('./types.ui').UiPreselectSfdcMeetingIdRequest): Promise<import('./types.ui').UiPreselectSfdcMeetingIdResponse>;
     on: typeof on;
     onMeetingCanceled: typeof onMeetingCanceled;
     onCanvasUpdated: typeof onCanvasUpdated;

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

@@ -6,13 +6,13 @@ import { UiPromptPiaRequest, UiPromptPiaResponse } from './types.ui';
  * // Subscribe to PIA's streamed responses
  * const cleanup = await useUi().on(
  *   UI_MESSAGE_TYPES.UI_PROMPT_PIA_RESPONSE_STREAMED,
- *   async ({ chunk, partial_response }) => {
- *     console.log('PIA response chunk:', chunk);
- *     console.log('PIA partial response:', partial_response);
+ *   async ({ chunk, partial_response, id }) => {
+ *     console.log(`PIA response chunk for stream ${id}: ${chunk}`);
+ *     console.log(`PIA response so far for stream ${id}: ${partial_response}`);
  *   }
  * );
  * // Prompt PIA with a question and ensure cleanup is called afterwards
- * useUi().promptPia({ prompt: "What's my most presented file?" })
+ * useUi().promptPia({ prompt: "What's my most presented file?", id: 'my-prompt-id-to-discern-with-stream-event' })
  *   .finally(cleanup);
  */
 export declare function promptPia(payload: UiPromptPiaRequest): Promise<UiPromptPiaResponse>;