@pitcher/js-api 1.21.0-beta.12 → 1.21.0-beta.14

package/lib/composables/useCanvasOverlay.d.ts

@@ -0,0 +1,20 @@
+interface CanvasOverlay {
+    id: string;
+    fullscreen?: boolean;
+    edit_mode?: boolean;
+    component_id?: string;
+    section_id?: string;
+}
+declare const _default: () => {
+    isCanvasOverlayOpen: import('vue').ComputedRef<boolean>;
+    initialCanvas: import('vue').ComputedRef<{
+        id: string;
+        fullscreen?: boolean;
+        edit_mode?: boolean;
+        component_id?: string;
+        section_id?: string;
+    } | undefined>;
+    openCanvasOverlay: ({ id, fullscreen, edit_mode, component_id, section_id }: CanvasOverlay) => void;
+    closeCanvasOverlay: () => void;
+};
+export default _default;

package/lib/main.lib.d.ts

@@ -88,6 +88,8 @@ export { default as CMovableWidget } from './components/CMovableWidget/CMovableW
 export { default as CUserMenu } from './components/CUserMenu/CUserMenu.vue';
 export { default as CList } from './components/CList/CList.vue';
 export { default as CKnockNotificationsAppWrapper } from './components/CKnockNotificationsAppWrapper/CKnockNotificationsAppWrapper.vue';
+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 { default as Browser } from '@browser/App.vue';
@@ -99,6 +101,7 @@ 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 useCanvasOverlay } from './composables/useCanvasOverlay';
 export { default as useInfiniteScroll } from './composables/useInfiniteScroll';
 export { default as useWindowEvents } from './composables/useWindowEvents';
 export { default as useDetailsView } from './composables/useDetailsView';
@@ -158,6 +161,7 @@ export * from './types/call';
 export * from './types/launchDarkly.types';
 export * from './types/toast';
 export * from './types/instanceSettings.types';
+export * from './types/organizationSettings.types';
 export * from './components/CConfigEditor/CConfigEditor.types';
 export * from './constants/cdp.const';
 export * from './constants/uploads.const';

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

@@ -56,7 +56,8 @@ export declare function createHighLevelApi(options?: ApiOptions): {
         app_name: string;
     }): Promise<Record<string, any>>;
     getFile(payload: {
-        file_id: import('../../main.lib').FileRetrieve["id"];
+        id?: import('../../main.lib').FileRetrieve["id"];
+        file_id?: import('../../main.lib').FileRetrieve["id"];
     }): Promise<import('../../main.lib').FileRetrieve>;
     updateFile(payload: import('../../main.lib').FileUpdateRequest & {
         id: import('../../main.lib').File["id"];

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

@@ -67,3 +67,23 @@ export declare function updateCanvas(payload: PatchedCanvasUpdateRequest & {
     instance_id?: Instance['id'];
     fields?: string;
 }): Promise<CanvasRetrieve>;
+/**
+ * Opens a modal to view a canvas by ID.
+ *
+ * ```
+ * onMounted(() => {
+ *   adminApi.openCanvasOverlay({
+ *     id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *     edit_mode: false,
+ *     fullscreen: true,
+ *   })
+ * })
+ * ```
+ */
+export declare function openCanvasOverlay(payload: {
+    id: CanvasRetrieve['id'];
+    edit_mode?: boolean;
+    fullscreen?: boolean;
+    component_id?: string;
+    section_id?: string;
+}): Promise<void>;

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

@@ -26,6 +26,13 @@ declare const _default: {
         instance_id?: import('../../../../main.lib').Instance["id"];
         fields?: string;
     }): Promise<import('../../../../main.lib').CanvasRetrieve>;
+    openCanvasOverlay(payload: {
+        id: import('../../../../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
     getEnv(): Promise<import('./types.admin').AdminEnv>;
     on: typeof on;
     toast: typeof toast;

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

@@ -14,13 +14,14 @@ export declare const ADMIN_API_METHOD_TYPES: {
     readonly GET_APP_CONFIG: "admin_get_app_config";
     readonly GET_CANVAS: "admin_get_canvas";
     readonly GET_CANVASES: "admin_get_canvases";
+    readonly OPEN_CANVAS_OVERLAY: "admin_open_canvas_overlay";
     readonly GET_ENV: "admin_get_env";
     readonly GET_FILE: "admin_get_file";
     readonly GET_FILES: "admin_get_files";
-    readonly SELECT_CONTENT: "admin_select_content";
     readonly GET_INSTANCE_METADATA_TEMPLATES: "admin_get_instance_metadata_templates";
     readonly TOAST: "admin_toast";
     readonly UPDATE_CANVAS: "admin_update_canvas";
+    readonly SELECT_CONTENT: "admin_select_content";
 };
 export type AdminMessagePayloads = {
     [ADMIN_MESSAGE_TYPES.ENV_CHANGED]: AdminEnv;

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

@@ -14,7 +14,8 @@ export declare function getAppConfig(payload: {
     app_name: string;
 }): Promise<Record<string, any>>;
 export declare function getFile(payload: {
-    file_id: FileRetrieve['id'];
+    id?: FileRetrieve['id'];
+    file_id?: FileRetrieve['id'];
 }): Promise<FileRetrieve>;
 export declare function updateFile(payload: FileUpdateRequest & {
     id: File['id'];

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

@@ -7,3 +7,23 @@ 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>;
+/**
+ * Opens a modal to view a canvas by ID.
+ *
+ * ```
+ * onMounted(() => {
+ *   uiApi.openCanvasOverlay({
+ *     id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *     edit_mode: false,
+ *     fullscreen: true,
+ *   })
+ * })
+ * ```
+ */
+export declare function openCanvasOverlay(payload: {
+    id: CanvasRetrieve['id'];
+    edit_mode?: boolean;
+    fullscreen?: boolean;
+    component_id?: string;
+    section_id?: string;
+}): Promise<void>;

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

@@ -18,6 +18,13 @@ declare const _default: {
     canvas_navigate_next_page(): Promise<void>;
     canvas_navigate_previous_page(): Promise<void>;
     canvas_navigate_page(payload: import('../../../../main.lib').UiCanvasNavigatePageReuqest): Promise<void>;
+    openCanvasOverlay(payload: {
+        id: import('../../../../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
     capture_app_error(payload: import('../../../../main.lib').UiCaptureAppErrorRequest): Promise<void>;
     update_location(payload: import('../../../../main.lib').UpdateLocationPitcherEvent): Promise<any>;
     embeddable_ready(): Promise<void>;

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

@@ -14,6 +14,7 @@ export declare const UI_API_METHOD_TYPES: {
     readonly UI_TOAST: "ui_toast";
     readonly UI_CAPTURE_APP_ERROR: "ui_capture_app_error";
     readonly UI_UPDATE_CANVAS: "ui_update_canvas";
+    readonly UI_OPEN_CANVAS_OVERLAY: "ui_open_canvas_overlay";
     readonly UI_UPDATE_LOCATION: "ui_update_location";
     readonly UI_PRESELECT_SFDC_MEETING_ID: "ui_preselect_sfdc_meeting_id";
     readonly UI_SET_POSTCALL_STYLE: "ui_set_postcall_style";

package/lib/sdk/main.d.ts

@@ -19,6 +19,13 @@ export declare function useUi(): {
     canvas_navigate_next_page(): Promise<void>;
     canvas_navigate_previous_page(): Promise<void>;
     canvas_navigate_page(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageReuqest): Promise<void>;
+    openCanvasOverlay(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
     capture_app_error(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
     update_location(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
     embeddable_ready(): Promise<void>;
@@ -59,6 +66,13 @@ export declare function useAdmin(): {
         instance_id?: import('../main.lib').Instance["id"];
         fields?: string;
     }): Promise<import('../main.lib').CanvasRetrieve>;
+    openCanvasOverlay(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
     getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
     on: (type: typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES[keyof typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES], handler: (data: import('./api/modules/admin/types.admin').AdminMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
     toast: (payload: import('./api/modules/admin/types.admin').AdminToastRequest) => Promise<void>;
@@ -125,7 +139,8 @@ export declare function useApi(options?: ApiOptions): {
         app_name: string;
     }): Promise<Record<string, any>>;
     getFile(payload: {
-        file_id: import('../main.lib').FileRetrieve["id"];
+        id?: import('../main.lib').FileRetrieve["id"];
+        file_id?: import('../main.lib').FileRetrieve["id"];
     }): Promise<import('../main.lib').FileRetrieve>;
     updateFile(payload: import('../main.lib').FileUpdateRequest & {
         id: import('../main.lib').File["id"];
@@ -219,6 +234,13 @@ export declare function useApi(options?: ApiOptions): {
         instance_id?: import('../main.lib').Instance["id"];
         fields?: string;
     }): Promise<import('../main.lib').CanvasRetrieve>;
+    openCanvasOverlay(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
     getEnv(): Promise<import('./api/modules/admin/types.admin').AdminEnv>;
     on: (type: typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES[keyof typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES], handler: (data: import('./api/modules/admin/types.admin').AdminMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
     toast: (payload: import('./api/modules/admin/types.admin').AdminToastRequest) => Promise<void>;
@@ -238,6 +260,13 @@ export declare function useApi(options?: ApiOptions): {
         canvas_navigate_next_page(): Promise<void>;
         canvas_navigate_previous_page(): Promise<void>;
         canvas_navigate_page(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageReuqest): Promise<void>;
+        openCanvasOverlay(payload: {
+            id: import('../main.lib').CanvasRetrieve["id"];
+            edit_mode?: boolean;
+            fullscreen?: boolean;
+            component_id?: string;
+            section_id?: string;
+        }): Promise<void>;
         capture_app_error(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
         update_location(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
         embeddable_ready(): Promise<void>;
@@ -309,7 +338,8 @@ export declare function useApi(options?: ApiOptions): {
             app_name: string;
         }): Promise<Record<string, any>>;
         getFile(payload: {
-            file_id: import('../main.lib').FileRetrieve["id"];
+            id?: import('../main.lib').FileRetrieve["id"];
+            file_id?: import('../main.lib').FileRetrieve["id"];
         }): Promise<import('../main.lib').FileRetrieve>;
         updateFile(payload: import('../main.lib').FileUpdateRequest & {
             id: import('../main.lib').File["id"];
@@ -390,6 +420,13 @@ export declare function useApi(options?: ApiOptions): {
     canvas_navigate_next_page(): Promise<void>;
     canvas_navigate_previous_page(): Promise<void>;
     canvas_navigate_page(payload: import('./api/modules/ui/types.ui').UiCanvasNavigatePageReuqest): Promise<void>;
+    openCanvasOverlay(payload: {
+        id: import('../main.lib').CanvasRetrieve["id"];
+        edit_mode?: boolean;
+        fullscreen?: boolean;
+        component_id?: string;
+        section_id?: string;
+    }): Promise<void>;
     capture_app_error(payload: import('./api/modules/ui/types.ui').UiCaptureAppErrorRequest): Promise<void>;
     update_location(payload: import('./interfaces').UpdateLocationPitcherEvent): Promise<any>;
     embeddable_ready(): Promise<void>;
@@ -457,7 +494,8 @@ export declare function useApi(options?: ApiOptions): {
         app_name: string;
     }): Promise<Record<string, any>>;
     getFile(payload: {
-        file_id: import('../main.lib').FileRetrieve["id"];
+        id?: import('../main.lib').FileRetrieve["id"];
+        file_id?: import('../main.lib').FileRetrieve["id"];
     }): Promise<import('../main.lib').FileRetrieve>;
     updateFile(payload: import('../main.lib').FileUpdateRequest & {
         id: import('../main.lib').File["id"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.21.0-beta.12",
+  "version": "1.21.0-beta.14",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",

package/lib/apps/canvas-builder/util/tsUtils.d.ts

@@ -1,3 +0,0 @@
-export type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
-    [Property in Key]-?: Type[Property];
-};

package/lib/types/templateActions.d.ts

@@ -1,10 +0,0 @@
-export declare enum TemplateActions {
-    Copy = "duplicate",
-    Share = "share",
-    CreateTemplate = "createTemplate",
-    Delete = "delete",
-    Revisions = "revisions",
-    Insights = "insights",
-    Edit = "edit",
-    Preview = "preview"
-}

package/lib/util/gesture.util.d.ts

@@ -1,6 +0,0 @@
-export declare function setupPinchGesture({ target, onPinchIn, onPinchOut, touches, }: {
-    target: HTMLElement | Window;
-    onPinchIn: () => void;
-    onPinchOut: () => void;
-    touches?: number;
-}): () => void;