@pitcher/js-api 1.22.0-alpha.2 → 1.22.0-alpha.4

package/lib/apps/browser/stores/app.d.ts

@@ -57,9 +57,7 @@ export default function (): {
     setCurrentState(stateName: AppCurrentState, itemId?: string | undefined): void;
     clearFilters(): void;
     clearInlineEditingItem(): void;
-    setIsDataFetchedAtLeastOnce(value: boolean): void;
     appName: Ref<"" | AppName>;
-    isDataFetchedAtLeastOnce: Ref<boolean>;
     currentState: Ref<AppCurrentState>;
     selectedItemIds: Ref<string[]>;
     selectedSection: Ref<BrowserSectionType>;

package/lib/composables/useToast.d.ts

@@ -1,10 +1,10 @@
 import { MessageApiInjection } from 'naive-ui/es/message/src/MessageProvider';
-import { UiToastPayload } from '../sdk/api/modules/ui/types.ui';
+import { UiToastRequest } from '../sdk/api/modules/ui/types.ui';
 
 export default function useToast(): {
     initMessageProvider: () => void;
     getMessageProvider: () => MessageApiInjection | null;
-    toast: ((data: UiToastPayload) => void) & {
+    toast: ((data: UiToastRequest) => void) & {
         info: (message: string) => import('naive-ui').MessageReactive | undefined;
         error: (message: string) => import('naive-ui').MessageReactive | undefined;
         warning: (message: string) => import('naive-ui').MessageReactive | undefined;

package/lib/main.lib.d.ts

@@ -148,7 +148,7 @@ export * from './types/app';
 export * from './types/vueVirtualScroller';
 export * from './components/CUsersGroupsAccessManage/CUsersGroupsAccessManage.types';
 export * from './types/translations';
-export * from './types/organization';
+export * from './types/organization.types';
 export * from './types/iframes';
 export * from './apps/canvas-builder/types/canvas';
 export type * from './composables/useWindowEvents';

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

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

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

@@ -1,8 +1,10 @@
-import { UI_MESSAGE_TYPES, UiMessagePayloads } from './types.ui';
+import { UiBroadcastRequest, UI_MESSAGE_TYPES, UiMessagePayloads } from './types.ui';
 
 export declare function on(type: (typeof UI_MESSAGE_TYPES)[keyof typeof UI_MESSAGE_TYPES], handler: (data: UiMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
+export declare function ui_broadcast(payload: UiBroadcastRequest): Promise<void>;
 export * from './content.ui';
 export * from './loading.ui';
 export * from './location.ui';
 export * from './app-errors.ui';
 export * from './canvas.ui';
+export * from './post-call.ui';

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

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

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

@@ -6,6 +6,7 @@ import { OpenRequestPayload } from '../../../payload.types';
 
 export declare const UI_MESSAGE: "UI_MESSAGE";
 export declare const UI_API_METHOD_TYPES: {
+    readonly UI_BROADCAST: "ui_broadcast";
     readonly UI_SELECT_CONTENT: "ui_select_content";
     readonly UI_OPEN: "ui_open";
     readonly UI_EMBEDDABLE_READY: "ui_embeddable_ready";
@@ -14,12 +15,14 @@ export declare const UI_API_METHOD_TYPES: {
     readonly UI_UPDATE_CANVAS: "ui_update_canvas";
     readonly UI_UPDATE_LOCATION: "ui_update_location";
     readonly UI_PRESELECT_SFDC_MEETING_ID: "ui_preselect_sfdc_meeting_id";
+    readonly UI_COMPLETE_POSTCALL: "ui_complete_postcall";
 };
 export declare const UI_MESSAGE_TYPES: {
-    readonly UI_CONTENT_SELECTED: "ui_content_selected";
+    readonly UI_MEETING_CANCELED: "ui_meeting_canceled";
 };
-export type SelectContentRequest = Record<string, never>;
-export type SelectContentResponse = {
+export type UiBroadcastRequest = Record<string, any>;
+export type UiSelectContentRequest = Record<string, never>;
+export type UiSelectContentResponse = {
     user_action: 'cancelled' | 'selected';
     content?: (ContentSelectorSelectedFile | ContentSelectorSelectedPage)[];
 };
@@ -28,7 +31,10 @@ export type UiUpdateCanvasRequest = Mutable<Canvas> & {
     fields?: string;
 };
 export type UiOpenRequest = OpenRequestPayload;
-export interface UiToastPayload {
+export type UiCompletePostcallRequest = {
+    was_successfully_submitted?: boolean;
+};
+export interface UiToastRequest {
     type: 'info' | 'error' | 'warning' | 'success' | 'loading';
     message: string;
     duration?: number;
@@ -36,12 +42,16 @@ export interface UiToastPayload {
     keepAliveOnHover?: boolean;
     showIcon?: boolean;
 }
-export type UiMessagePayloads = {
-    [UI_MESSAGE_TYPES.UI_CONTENT_SELECTED]: Required<SelectContentResponse['content']>;
-};
-export interface UiPreselectSfdcMeetingIdPayload {
+export interface UiPreselectSfdcMeetingIdRequest {
     eventId: string;
 }
 export interface UiPreselectSfdcMeetingIdResponse {
     event: SfEvent | null;
 }
+export type UiMessagePayloads = {
+    [UI_MESSAGE_TYPES.UI_MEETING_CANCELED]: UiMeetingCanceledPayload;
+};
+export type UiMeetingCanceledPayload = {
+    accountId?: string;
+    eventId?: string;
+};

package/lib/sdk/interfaces.d.ts

@@ -1,6 +1,6 @@
 import { Emitter } from './utils/eventEmitter';
-import { Favorite, File, Instance, User, Organization, Canvas } from '../../types/openapi';
-import { OrganizationMetadata } from '../types/organization';
+import { Favorite, File, Instance, User, Canvas } from '../../types/openapi';
+import { PitcherOrg } from '../types/organization.types';
 import { PaginatedData } from '../types/paginatedData';
 import { LaunchDarklyEnv } from '../types/launchDarkly.types';
 import { CLIENT_TYPE } from '../constants/cdp.const';
@@ -31,9 +31,7 @@ export interface PitcherEnv {
     mode: 'WEB' | 'IOS' | 'WINDOWS' | 'ANDROID';
     pitcher: {
         token_claims: Record<string, any>;
-        organization: Omit<Organization, 'metadata'> & {
-            metadata: OrganizationMetadata;
-        };
+        organization: PitcherOrg;
         instance: Instance;
         user: User;
         access_token: string;

package/lib/sdk/main.d.ts

@@ -13,6 +13,7 @@ export declare let highLevelApi: ReturnType<typeof createHighLevelApi>;
 export declare function usePitcherApi(options?: ApiOptions): ReturnType<typeof createHighLevelApi>;
 export declare function useUi(): {
     on: typeof ui.on;
+    ui_broadcast: typeof ui.ui_broadcast;
     ui_select_content: typeof ui.ui_select_content;
     select_content: typeof ui.select_content;
     open: typeof ui.open;
@@ -22,7 +23,8 @@ export declare function useUi(): {
     update_location: typeof ui.update_location;
     capture_app_error: typeof ui.capture_app_error;
     update_canvas: typeof ui.update_canvas;
-} & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error>;
+    complete_postcall: typeof ui.complete_postcall;
+} & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_broadcast | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error | typeof ui.complete_postcall>;
 export declare function useAdmin(): {
     on: typeof admin.on;
     getEnv: typeof admin.getEnv;
@@ -175,6 +177,7 @@ export declare function useApi(): {
 } & Record<string, typeof dsr.on | typeof dsr.getEnv | typeof dsr.embeddable_ready>) | {
     ui: {
         on: typeof ui.on;
+        ui_broadcast: typeof ui.ui_broadcast;
         ui_select_content: typeof ui.ui_select_content;
         select_content: typeof ui.select_content;
         open: typeof ui.open;
@@ -184,7 +187,8 @@ export declare function useApi(): {
         update_location: typeof ui.update_location;
         capture_app_error: typeof ui.capture_app_error;
         update_canvas: typeof ui.update_canvas;
-    } & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error>;
+        complete_postcall: typeof ui.complete_postcall;
+    } & Record<string, typeof ui.on | typeof ui.open | typeof ui.ui_broadcast | typeof ui.ui_select_content | typeof ui.toast | typeof ui.update_location | typeof ui.update_canvas | typeof ui.select_content | typeof ui.preselect_sfdc_meeting_id | typeof ui.embeddable_ready | typeof ui.capture_app_error | typeof ui.complete_postcall>;
     impact: {
         on: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
         off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
@@ -308,6 +312,7 @@ export declare function useApi(): {
         API: import('./api/LowLevelApi').LowLevelApi;
     };
     on: typeof ui.on;
+    ui_broadcast: typeof ui.ui_broadcast;
     ui_select_content: typeof ui.ui_select_content;
     select_content: typeof ui.select_content;
     open: typeof ui.open;
@@ -317,6 +322,7 @@ export declare function useApi(): {
     update_location: typeof ui.update_location;
     capture_app_error: typeof ui.capture_app_error;
     update_canvas: typeof ui.update_canvas;
+    complete_postcall: typeof ui.complete_postcall;
     off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
     enterFullscreen: () => Promise<any>;
     exitFullscreen: () => Promise<any>;

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

@@ -0,0 +1,14 @@
+import { Organization, OrganizationUpdate, OrganizationUpdateRequest } from '../../types/openapi';
+import { OrganizationMetadata } from './organizationMetadata.types';
+import { OrganizationSettings } from './organizationSettings.types';
+
+export interface PitcherOrg extends Omit<Organization, 'metadata' | 'settings'> {
+    readonly metadata: OrganizationMetadata;
+    readonly settings: OrganizationSettings;
+}
+export interface OrganizationUpdateExtended extends Omit<OrganizationUpdate, 'settings'> {
+    settings?: OrganizationSettings | null;
+}
+export interface OrganizationUpdateRequestExtended extends Omit<OrganizationUpdateRequest, 'settings'> {
+    settings?: OrganizationSettings | null;
+}

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

@@ -0,0 +1,3 @@
+export type OrganizationSettings = {
+    impact_show_only_saved_canvases_in_canvas_manager?: boolean;
+};

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.22.0-alpha.2",
+  "version": "1.22.0-alpha.4",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",
+  "types": "js-api.esm.d.ts",
   "sideEffects": false,
   "peerDependencies": {
     "lodash-es": "4"