@pitcher/js-api 1.21.0-beta.3 → 1.21.0-beta.5

package/lib/apps/canvas-builder/composables/useRecommendations.d.ts

@@ -3,7 +3,7 @@ import { PitcherInfo } from '../../../types/app';
 import { ContentGridProps, CanvasBuilderProps } from '@canvas-builder/types/canvas';
 import { RecommendedContent } from '@canvas-builder/types/recommendations.types';
 import { Canvas } from '../../../../types/openapi';
-import { InstanceSettings } from '../../../types/instanceSettings';
+import { InstanceSettings } from '../../../types/instanceSettings.types';
 
 declare function autofillCanvasContentGridsWithAi(filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>): Promise<void>;
 declare function autofillSectionContentGridsWithAi(filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>): Promise<void>;
@@ -17,6 +17,7 @@ declare function autofillCanvasContentGridsWithMatchingProperties(options: {
     filesFetcher: NonNullable<CanvasBuilderProps['listFiles']>;
     http: AxiosInstance;
     pitcherInfo: PitcherInfo;
+    instanceSettings?: InstanceSettings;
 }): Promise<void>;
 declare function cleanup(): void;
 export default function useRecommendations(): {

package/lib/composables/useWindowEvents.d.ts

@@ -10,7 +10,7 @@ export type InactiveEventPayload = {
 export default function (track: (eventName: string, payload: any) => void, pitcherApi?: ReturnType<typeof usePitcherApi>): {
     registerInactiveEvent: ({ id, payload, enterEvent, exitEvent, type, }: {
         id: string;
-        payload: InactiveEventPayload;
+        payload: InactiveEventPayload | (() => InactiveEventPayload);
         enterEvent: (typeof CDP_EVENT_TYPE)[keyof typeof CDP_EVENT_TYPE];
         exitEvent: (typeof CDP_EVENT_TYPE)[keyof typeof CDP_EVENT_TYPE];
         type?: EventType;

package/lib/main.lib.d.ts

@@ -149,13 +149,14 @@ export * from './types/vueVirtualScroller';
 export * from './components/CUsersGroupsAccessManage/CUsersGroupsAccessManage.types';
 export * from './types/translations';
 export * from './types/organization.types';
+export * from './types/instance.types';
 export * from './types/iframes';
 export * from './apps/canvas-builder/types/canvas';
 export type * from './composables/useWindowEvents';
 export * from './types/call';
 export * from './types/launchDarkly.types';
 export * from './types/toast';
-export * from './types/instanceSettings';
+export * from './types/instanceSettings.types';
 export * from './components/CConfigEditor/CConfigEditor.types';
 export * from './constants/cdp.const';
 export * from './constants/uploads.const';

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

@@ -0,0 +1,4 @@
+import { PitcherEnv } from '../interfaces';
+
+export declare const setEnv: (e: PitcherEnv) => void;
+export declare const onlineRestApiHandlers: Record<string, any>;

package/lib/sdk/interfaces.d.ts

@@ -1,6 +1,7 @@
 import { Emitter } from './utils/eventEmitter';
-import { Favorite, File, Instance, User, Canvas } from '../../types/openapi';
+import { Favorite, File, User, Canvas } from '../../types/openapi';
 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';
@@ -22,17 +23,19 @@ export interface PitcherMessage {
         body?: Record<string, any>;
     };
 }
+type FetchMode = 'postmessage' | 'prefer-online';
 export interface ApiOptions {
     errorLogger?: (p: any) => string | void;
     logLevel?: 'off' | 'info' | 'debug';
     casing?: 'camel' | 'snake';
+    fetchMode?: FetchMode;
 }
 export interface PitcherEnv {
     mode: 'WEB' | 'IOS' | 'WINDOWS' | 'ANDROID';
     pitcher: {
         token_claims: Record<string, any>;
         organization: PitcherOrg;
-        instance: Instance;
+        instance: PitcherInstance;
         user: User;
         access_token: string;
         id_token: string;

package/lib/sdk/main.d.ts

@@ -54,7 +54,7 @@ export declare function useDsr(): {
 } & Record<string, typeof dsr.on | typeof dsr.getEnv | typeof dsr.embeddable_ready>;
 export type JsApiLocation = 'ui' | 'admin' | 'dsr' | 'impact';
 export declare function getAvailableApis(): JsApiLocation[];
-export declare function useApi(): {
+export declare function useApi(options?: ApiOptions): {
     on: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
     off: (type: string, callback: (payload: import('./interfaces').PitcherEvent) => void) => void;
     enterFullscreen: () => Promise<any>;

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/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}

@@ -12,10 +12,12 @@ export type CanvasComponentAvailability = {
     [component in CanvasComponentTypes]: boolean;
 };
 export type InstanceSettings = {
+    impact_show_only_saved_canvases_in_canvas_manager?: boolean;
     canvas?: {
         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;
     };
 };

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

@@ -1,6 +1,6 @@
 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' | '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' | 'prefer_online_handlers';
 type LaunchDarklyObjectFlags = {
     canvas_table_pagination: CanvasTablePagination;
     canvas_manager_table_columns: CanvasManagerTableColumns;

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/package.json

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