@pitcher/js-api 1.22.0-alpha.0 → 1.22.0-alpha.1

package/lib/custom-naive-locales/el.d.ts

@@ -0,0 +1,124 @@
+declare const _default: {
+    name: string;
+    global: {
+        undo: string;
+        redo: string;
+        confirm: string;
+        clear: string;
+    };
+    Popconfirm: {
+        positiveText: string;
+        negativeText: string;
+    };
+    Cascader: {
+        placeholder: string;
+        loading: string;
+        loadingRequiredMessage: (label: string) => string;
+    };
+    Time: {
+        dateFormat: string;
+        dateTimeFormat: string;
+    };
+    DatePicker: {
+        yearFormat: string;
+        monthFormat: string;
+        dayFormat: string;
+        yearTypeFormat: string;
+        monthTypeFormat: string;
+        dateFormat: string;
+        dateTimeFormat: string;
+        quarterFormat: string;
+        weekFormat: string;
+        clear: string;
+        now: string;
+        confirm: string;
+        selectTime: string;
+        selectDate: string;
+        datePlaceholder: string;
+        datetimePlaceholder: string;
+        monthPlaceholder: string;
+        yearPlaceholder: string;
+        quarterPlaceholder: string;
+        weekPlaceholder: string;
+        startDatePlaceholder: string;
+        endDatePlaceholder: string;
+        startDatetimePlaceholder: string;
+        endDatetimePlaceholder: string;
+        startMonthPlaceholder: string;
+        endMonthPlaceholder: string;
+        monthBeforeYear: boolean;
+        firstDayOfWeek: 0 | 2 | 1 | 3 | 4 | 5 | 6;
+        today: string;
+    };
+    DataTable: {
+        checkTableAll: string;
+        uncheckTableAll: string;
+        confirm: string;
+        clear: string;
+    };
+    LegacyTransfer: {
+        sourceTitle: string;
+        targetTitle: string;
+    };
+    Transfer: {
+        selectAll: string;
+        unselectAll: string;
+        clearAll: string;
+        total: (num: number) => string;
+        selected: (num: number) => string;
+    };
+    Empty: {
+        description: string;
+    };
+    Select: {
+        placeholder: string;
+    };
+    TimePicker: {
+        placeholder: string;
+        positiveText: string;
+        negativeText: string;
+        now: string;
+        clear: string;
+    };
+    Pagination: {
+        goto: string;
+        selectionSuffix: string;
+    };
+    DynamicTags: {
+        add: string;
+    };
+    Log: {
+        loading: string;
+    };
+    Input: {
+        placeholder: string;
+    };
+    InputNumber: {
+        placeholder: string;
+    };
+    DynamicInput: {
+        create: string;
+    };
+    ThemeEditor: {
+        title: string;
+        clearAllVars: string;
+        clearSearch: string;
+        filterCompName: string;
+        filterVarName: string;
+        import: string;
+        export: string;
+        restore: string;
+    };
+    Image: {
+        tipPrevious: string;
+        tipNext: string;
+        tipCounterclockwise: string;
+        tipClockwise: string;
+        tipZoomOut: string;
+        tipZoomIn: string;
+        tipDownload: string;
+        tipClose: string;
+        tipOriginalSize: string;
+    };
+};
+export default _default;

package/lib/directives/autofocus.d.ts

@@ -0,0 +1,4 @@
+declare const autofocus: {
+    mounted: (el: HTMLElement) => void;
+};
+export default autofocus;

package/lib/directives/clickOutside.d.ts

@@ -0,0 +1,8 @@
+import { ObjectDirective } from 'vue';
+
+interface ClickOutsideElement extends HTMLElement {
+    clickOutsideEvent?: (event: Event) => void;
+    touchStartEvent?: (event: Event) => void;
+}
+declare const ClickOutsideDirective: ObjectDirective<ClickOutsideElement, (event: Event) => void>;
+export default ClickOutsideDirective;

package/lib/directives/draggable.d.ts

@@ -0,0 +1,4 @@
+import { ObjectDirective } from 'vue';
+
+declare const draggable: ObjectDirective;
+export default draggable;

package/lib/directives/tooltip.d.ts

@@ -0,0 +1,4 @@
+import { ObjectDirective } from 'vue';
+
+declare const tooltipDirective: ObjectDirective<HTMLElement, string | undefined>;
+export default tooltipDirective;

package/lib/main.lib.d.ts

@@ -0,0 +1,176 @@
+
+export { NColorPicker as CColorPicker, NConfigProvider as CConfigProvider, NDatePicker as CDatePicker, NGlobalStyle as CGlobalStyle, NGrid as CGrid, NGi as CGi, NGridItem as CGridItem, NForm as CForm, NFormItem as CFormItem, NFormItemCol as CFormItemCol, NFormItemGi as CFormItemGi, NFormItemGridItem as CFormItemGridItem, NFormItemRow as CFormItemRow, NH1 as CH1, NH2 as CH2, NH3 as CH3, NH4 as CH4, NH5 as CH5, NH6 as CH6, NText as CText, NLayout as CLayout, NLayoutContent as CLayoutContent, NLayoutFooter as CLayoutFooter, NLayoutHeader as CLayoutHeader, NLayoutSider as CLayoutSider, NPagination as CPagination, NSkeleton as CSkeleton, NSpace as CSpace, NDialogProvider as CDialogProvider, NMessageProvider as CMessageProvider, NProgress as CProgress, NInputNumber as CInputNumber, } from 'naive-ui';
+export type { DataTableColumns, DataTableColumn, DataTableProps, PaginationInfo, PaginationProps, PaginationRenderLabel, PaginationSizeOption, } from 'naive-ui';
+export type { DropdownMixedOption, DropdownOption } from 'naive-ui/es/dropdown/src/interface';
+export type { SelectMixedOption, SelectBaseOption } from 'naive-ui/lib/select/src/interface';
+export type { SortState as DataTableSortState } from 'naive-ui/lib/data-table/src/interface';
+export { lightThemeOverrides } from '@theme/theme-overrides';
+export * from '@theme/theme.types';
+export { default as canvasUiUnoPreset } from '@theme/canvasUiUnoPreset';
+export { default as CButton } from './components/CButton/CButton.vue';
+export { default as CCard } from './components/CCard/CCard.vue';
+export { default as CCheckbox } from './components/CCheckbox/CCheckbox.vue';
+export { default as CCollapse } from './components/CCollapse/CCollapse.vue';
+export { default as CCollapseItem } from './components/CCollapse/CCollapseItem.vue';
+export { default as CDataTable } from './components/CDataTable/CDataTable.vue';
+export { default as CDivider } from './components/CDivider/CDivider.vue';
+export { default as CDrawer } from './components/CDrawer/CDrawer.vue';
+export { default as CDrawerContent } from './components/CDrawerContent/CDrawerContent.vue';
+export { default as CDropdown } from './components/CDropdown/CDropdown.vue';
+export { default as CErrorFullScreen } from './components/CError/CErrorFullScreen.vue';
+export { default as CIcon, type Props as CIconProps } from './components/CIcon/CIcon.vue';
+export { default as CImage } from './components/CImage/CImage.vue';
+export { default as CInput } from './components/CInput/CInput.vue';
+export { default as CModal } from './components/CModal/CModal.vue';
+export { default as CPopover } from './components/CPopover/CPopover.vue';
+export { default as CSearch } from './components/CSearch/CSearch.vue';
+export { default as CSearchOnClick } from './components/CSearch/CSearchOnClick.vue';
+export { default as CSelect } from './components/CSelect/CSelect.vue';
+export { default as CTag } from './components/CTag/CTag.vue';
+export { default as CThemeEditor } from './components/CThemeEditor/CThemeEditor.vue';
+export { default as CToolbar } from './components/CToolbar/CToolbar.vue';
+export { default as CTooltip } from './components/CTooltip/CTooltip.vue';
+export { default as CAvatar } from './components/CAvatar/CAvatar.vue';
+export { default as CCollapseTransition } from './components/CCollapseTransition/CCollapseTransition.vue';
+export { default as CSpin } from './components/CSpin/CSpin.vue';
+export { default as CEmpty } from './components/CEmpty/CEmpty.vue';
+export { default as CSwitch } from './components/CSwitch/CSwitch.vue';
+export { default as CFeedback } from './components/CFeedback/CFeedback.vue';
+export { default as CConfirmationModal } from './components/CConfirmationModal/CConfirmationModal.vue';
+export { default as CConfirmationHeader } from './components/CConfirmation/CConfirmationHeader.vue';
+export { default as CConfirmationContent } from './components/CConfirmation/CConfirmationContent.vue';
+export { default as CConfirmationAction } from './components/CConfirmation/CConfirmationAction.vue';
+export { default as CCanvasSelector } from './components/CCanvasSelector/CCanvasSelector.vue';
+export { default as CContactSelector } from './components/CContactSelector/CContactSelector.vue';
+export { default as CContactSelectorSelected } from './components/CContactSelector/CContactSelectorSelected.vue';
+export * from './components/CContactSelector/CContactSelector.types';
+export { default as CCreateCanvasModal } from './components/CCreateCanvasModal/CCreateCanvasModal.vue';
+export { default as CCreateTemplateOrSectionModal } from './components/CCreateTemplateOrSectionModal/CCreateTemplateOrSectionModal.vue';
+export { default as CGlobalSearch } from './components/CGlobalSearch/CGlobalSearch.vue';
+export { default as CComponentListItem } from './components/CComponentListItem/CComponentListItem.vue';
+export { default as CSecondaryNav } from './components/CSecondaryNav/CSecondaryNav.vue';
+export { default as CShortcut } from './components/CShortcut/CShortcut.vue';
+export { default as useGlobalSearch } from './components/CGlobalSearch/GlobalSearch.use';
+export { default as CRichTextEditor } from './components/CRichTextEditor/CRichTextEditor.vue';
+export { default as CSingleSelect } from './components/CSingleSelect/CSingleSelect.vue';
+export { default as CUserAvatar } from './components/CUserAvatar/CUserAvatar.vue';
+export { default as CMultiSelect } from './components/CMultiSelect/CMultiSelect.vue';
+export { default as CVirtualTable } from './components/CVirtualTable/CVirtualTable.vue';
+export { default as CToastProvider } from './components/CToastProvider/CToastProvider.vue';
+export { default as CCanvasMetadataFilters } from './components/canvases/CCanvasMetadataFilters.vue';
+export { default as CCanvasDeleteDialogContent } from './components/canvases/CCanvasDeleteDialogContent.vue';
+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 CConfigEditor } from './components/CConfigEditor/CConfigEditor.vue';
+export { default as CTableInput } from './components/CTableInput/CTableInput.vue';
+export { default as CTableTag } from './components/CTableTag/CTableTag.vue';
+export { default as CTableSelect } from './components/CTableSelect/CTableSelect.vue';
+export { default as CTableMore } from './components/CTableMore/CTableMore.vue';
+export { default as CDateRangeFilter } from './components/filters/CDateRangeFilter.vue';
+export { default as CSelectFilter } from './components/filters/CSelectFilter.vue';
+export { default as CTable } from './components/CTable/CTable.vue';
+export { default as CEntitySelector } from './components/CEntitySelector/CEntitySelector.vue';
+export { default as CUsersGroupsAccessManage } from './components/CUsersGroupsAccessManage/CUsersGroupsAccessManage.vue';
+export { default as CFilesAccessManage } from './components/CFilesAccessManage/CFilesAccessManage.vue';
+export { default as CGroupsAccessInfo } from './components/CGroupsAccessInfo/CGroupsAccessInfo.vue';
+export { default as CUsersAccessInfo } from './components/CUsersAccessInfo/CUsersAccessInfo.vue';
+export { default as CFilesAccessInfo } from './components/CFilesAccessInfo/CFilesAccessInfo.vue';
+export { default as CFileViewer } from './components/CFileViewer/CFileViewer.vue';
+export { default as CDetailPageSectionButtons } from './components/CDetailPageSectionButtons/CDetailPageSectionButtons.vue';
+export { default as CFullScreenLoader } from './components/CFullScreenLoader/CFullScreenLoader.vue';
+export { default as CGlobalLoader } from './components/CGlobalLoader/CGlobalLoader.vue';
+export { default as CFilesFolderDeleteDialogContent } from './components/CFilesFolderDeleteDialogContent/CFilesFolderDeleteDialogContent.vue';
+export { default as CCatalogIqSwitcher } from './components/CCatalogIqSwitcher/CCatalogIqSwitcher.vue';
+export { default as CCarousel } from './components/CCarousel/CCarousel.vue';
+export { default as CTags } from './components/CTags/CTags.vue';
+export { default as CMovableWidget } from './components/CMovableWidget/CMovableWidget.vue';
+export { default as CUserMenu } from './components/CUserMenu/CUserMenu.vue';
+export { default as CList } from './components/CList/CList.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';
+export { type BrowserSectionType } from '@browser/stores/app';
+export { default as ContentSelector } from '@content-selector/App.vue';
+export type { SelectedPage as ContentSelectorSelectedPage, SelectedFile as ContentSelectorSelectedFile, SelectedAsset as ContentSelectorSelectedAsset, SelectedExternalLink as ContentSelectorSelectedExternalLink, ContentSelectorSelectedItem, } from '@content-selector/stores/app';
+export { default as NotesApp } from '@notes/NotesApp.vue';
+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 useInfiniteScroll } from './composables/useInfiniteScroll';
+export { default as useWindowEvents } from './composables/useWindowEvents';
+export { default as useDetailsView } from './composables/useDetailsView';
+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 useToast } from './composables/useToast';
+export * from './plugins/vueQuery';
+export * from './util/array';
+export * from './util/object';
+export * from './util/userAgents';
+export * from './util/image';
+export * from './util/casing';
+export * from './util/query';
+export * from './util/reactive';
+export * from './util/date';
+export * from './util/number';
+export * from './util/network';
+export * from './util/tsHelpers';
+export * from './util/color';
+export * from './util/user';
+export * from './util/dom';
+export * from './util/anchor';
+export * from './util/translations';
+export * from './util/message-event';
+export * from './util/font.util';
+export * from './util/timer';
+export * from './components/filters/filter.util';
+export * from './apps/canvas-builder/util/tree';
+export * from './apps/canvas-builder/util/canvas.util';
+export * from './util/navigation.util';
+export * from './util/fullscreen.util';
+export * from './util/location.util';
+export * from './util/dev.util';
+export * from './sdk/main';
+export * from '../types/openapi';
+export * from './components/CGlobalSearch/CGlobalSearch.types';
+export * from './types/dataTable';
+export * from './types/sfdc';
+export * from './types/ts';
+export * from './types/paginatedData';
+export * from './types/users';
+export * from './types/canvases';
+export * from './types/canvasActions';
+export * from './types/favorites';
+export * from './types/files';
+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/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 './components/CConfigEditor/CConfigEditor.types';
+export * from './constants/cdp.const';
+export * from './constants/uploads.const';
+export * from './constants/tables.const';
+export * from './constants/timers.const';
+export * from './constants/url.const';
+export * from './constants/conventions.const';
+export * from './constants/config.const';
+export * from './api/events/events.queries';
+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 clickOutsideDirective } from './directives/clickOutside';
+export { default as autofocusDirective } from './directives/autofocus';
+export { default as tooltipDirective } from './directives/tooltip';
+export * from './constants/i18n.const';
+export * from './types/i18n.types';

package/lib/plugins/vueQuery.d.ts

@@ -0,0 +1,3 @@
+import { VueQueryPluginOptions } from '@tanstack/vue-query';
+
+export declare const vueQueryPluginOptions: VueQueryPluginOptions;

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

@@ -0,0 +1,125 @@
+import { LowLevelApi } from './LowLevelApi';
+import { PitcherEvent, ApiOptions } from '../interfaces';
+import * as modules from '@sdk/api/modules';
+export declare function createHighLevelApi(options?: ApiOptions): {
+    on: (type: string, callback: (payload: PitcherEvent) => void) => void;
+    off: (type: string, callback: (payload: PitcherEvent) => void) => void;
+    enterFullscreen: () => Promise<any>;
+    exitFullscreen: () => Promise<any>;
+    logout: () => Promise<any>;
+    quitInstance: () => Promise<any>;
+    getRequestTypes: () => Promise<any>;
+    broadcast: (event: PitcherEvent) => Promise<any>;
+    subscribe: () => Promise<any>;
+    unsubscribe: () => Promise<any>;
+    open(payload?: import('../payload.types').OpenRequestPayload): Promise<string>;
+    openExternalUrl(payload: import('../payload.types').OpenExternalUrlRequestPayload): Promise<void>;
+    getEnv(): Promise<import('../interfaces').PitcherEnv>;
+    updateMyUser(payload: {
+        language?: import('../../main.lib').LanguageEnum | undefined;
+        dark_mode?: boolean | undefined;
+    }): Promise<import('../../main.lib').User>;
+    getLanguages(): Promise<modules.Language[]>;
+    getEvents(payload: Partial<import('../../main.lib').EventRequest>): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').Event>>;
+    createEvent(payload: import('../../main.lib').EventRequest): Promise<import('../../main.lib').Event>;
+    updateEvent(payload: import('../../main.lib').PatchedEventRequest): Promise<import('../../main.lib').Event>;
+    deleteEvent(payload: Partial<import('../../main.lib').Event>): Promise<void>;
+    getCanvases(payload: import('../../main.lib').GetCanvasesParams & {
+        filters?: Record<string, any> | undefined;
+        fields?: string | undefined;
+    }): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').Canvas>>;
+    createCanvas(payload: Omit<import('../../main.lib').CanvasCreateRequest, "instance_id">): Promise<import('../../main.lib').Canvas>;
+    deleteCanvas(payload: {
+        id: string;
+    }): Promise<import('../../main.lib').Canvas>;
+    updateCanvas(payload: import('../../main.lib').PatchedCanvasUpdateRequest & {
+        id: string;
+        instance_id?: string | undefined;
+        fields?: string | undefined;
+    }): Promise<import('../../main.lib').Canvas>;
+    getCanvas(payload: {
+        id: string;
+        fields?: string | undefined;
+    }): Promise<import('../../main.lib').Canvas>;
+    shareCanvas(payload: {
+        id: string;
+    }): Promise<import('../../main.lib').SharedLink>;
+    getFiles(payload: import('../payload.types').ListFilesPayload): Promise<import('../../main.lib').PaginatedFileList>;
+    getRecentFiles(payload?: import('../payload.types').GetRecentFilesPayload | undefined): Promise<import('../../main.lib').File[]>;
+    downloadFile(payload: {
+        file_id: string;
+    }): Promise<null>;
+    getAppConfig(payload: {
+        app_name: string;
+    }): Promise<Record<string, any>>;
+    getFile(payload: {
+        file_id: string;
+    }): Promise<import('../../main.lib').FileRetrieve>;
+    updateFile(payload: import('../../main.lib').FileUpdateRequest & {
+        id: string;
+    }): Promise<import('../../main.lib').FileRetrieve>;
+    deleteFile(payload: {
+        file_id: string;
+    }): Promise<string>;
+    createFile(payload: Omit<import('../../main.lib').AllFileCreateRequest, "instance_id">): Promise<import('../../main.lib').FileRetrieve>;
+    selectDeviceFile(): Promise<import('../../main.lib').DeviceFile>;
+    search(payload: {
+        query: string;
+        includeExpired?: boolean | undefined;
+    }): Promise<any>;
+    getUsers(payload?: import('../../main.lib').GetUsersParams | undefined): Promise<import('../../main.lib').PaginatedData<import('../../main.lib').User>>;
+    refreshServiceToken(payload: import('../../main.lib').RefreshServiceTokenRequest): Promise<import('../../main.lib').RefreshServiceTokenResponse>;
+    fetchDocumentInfo(payload: {
+        fileId: string;
+    }): Promise<{
+        [key: string]: unknown;
+        pageCount: number;
+    }>;
+    renderPageAsImage(payload: {
+        fileId: string;
+        pageNumber: number;
+        params: {
+            width: number;
+        } | {
+            height: number;
+        };
+    }): Promise<ArrayBuffer>;
+    toast(payload: {
+        type: string;
+        message: string;
+    }): Promise<void>;
+    query(payload: import('../payload.types').QueryPayload): Promise<any>;
+    getFolder(payload?: {
+        id: string;
+    }): Promise<import('../../main.lib').FolderRetrieve>;
+    createFolder(payload: Omit<import('../../main.lib').FolderCreateRequest, "instance_id">): Promise<import('../../main.lib').FolderRetrieve>;
+    updateFolder(payload: import('../../main.lib').FolderUpdateRequest & {
+        id: string;
+    }): Promise<import('../../main.lib').FolderRetrieve>;
+    deleteFolder(payload: {
+        folder_id: string;
+    }): Promise<void>;
+    moveFolderItems(payload: {
+        target_folder_id: string;
+        items: {
+            id: string;
+            type: "file" | "folder";
+        }[];
+    }): Promise<import('../../main.lib').FolderRetrieve>;
+    getFavorites(payload?: import('../../main.lib').GetFavoritesParams | undefined): Promise<import('../../main.lib').PaginatedFavoriteList>;
+    createFavorite(payload: import('../../main.lib').FavoriteCreateRequest): Promise<import('../../main.lib').Favorite>;
+    deleteFavorite(payload: {
+        favorite_id: string;
+    }): Promise<void>;
+    notify(payload: import('../payload.types').NotificationPayload): Promise<void>;
+    track(payload: {
+        event_name: string;
+        payload: any;
+    }): Promise<any>;
+    getInstanceMetadataTemplates(payload?: import('../payload.types').GetInstanceMetadataTemplatesPayload | undefined): Promise<import('../../main.lib').PaginatedMetadataTemplateList>;
+    triggerNonFilesSync(): Promise<void>;
+    submitUserFeedback(payload: import('../payload.types').SubmitUserFeedbackPayload): Promise<any>;
+    close(): Promise<any>;
+    openWebViewAlwaysOnTop(payload: import('../payload.types').OpenWebViewAlwaysOnTop): Promise<void>;
+    API: LowLevelApi;
+};

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

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

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

@@ -0,0 +1,18 @@
+import { ApiEventMap, PitcherAPI, PitcherResponse, ApiOptions } from '../interfaces';
+import { EventEmitter } from '../utils/eventEmitter';
+
+export declare class LowLevelApi extends EventEmitter<ApiEventMap> implements PitcherAPI {
+    constructor(options?: ApiOptions);
+    callbacks: {
+        [k: string]: {
+            callback: (res: PitcherResponse) => void;
+            dispatched_at: number;
+            type: string;
+            payload: object;
+        };
+    };
+    private options;
+    private handleCallbackMessage;
+    private handleEventMessage;
+    request(type: string, body?: object | null): Promise<any>;
+}

package/lib/sdk/api/LowLevelApi.spec.d.ts

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

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

@@ -0,0 +1,69 @@
+import { Canvas, PatchedCanvasUpdateRequest, Instance, CanvasCreateRequest } from '../../../../../types/openapi';
+import { GetCanvasesParams } from '../../../../types/canvases';
+import { PaginatedData } from '../../../../types/paginatedData';
+
+/**
+ * Creates a new canvas.
+ *
+ * ```
+ *  adminApi.createCanvas({
+ *    name: 'my new canvas';
+ *  })
+ * ```
+ */
+export declare function createCanvas(payload: CanvasCreateRequest): Promise<Canvas>;
+/**
+ * Fetches a list of canvases to use in your app.
+ *
+ * ```
+ * // The `filters` object is a reserved payload key to transfer the metadata dict over the wire.
+ * adminApi.getCanvases({
+ *   search: 'my search query',
+ *   ordering: '-created_at',
+ *   filters: {
+ *     metadata__mydaterangefiltername__range: ['2023-12-10', '2023-12-22'],
+ *     metadata__mymultiselectfiltername: ['optionAValue', 'optionCValue'],
+ *   },
+ *  fields: 'id,name,metadata',
+ * })
+ * ```
+ */
+export declare function getCanvases(payload: GetCanvasesParams & {
+    filters?: Record<string, any>;
+    fields?: string;
+}): Promise<PaginatedData<Canvas>>;
+/**
+ * Fetches a canvas by id with the defined fields or all of them.
+ *
+ * ```
+ * // The `filters` object is a reserved payload key to transfer the metadata dict over the wire.
+ * adminApi.getCanvas({
+ *  fields: 'id,name,metadata',
+ * })
+ * ```
+ */
+export declare function getCanvas(payload: {
+    id: Canvas['id'];
+    fields?: string;
+}): Promise<Canvas>;
+/**
+ * Updates a canvas by ID and returns the defined fields or all of them.
+ *
+ * ```
+ * // The fields param is appended to the URL as a query param.
+ * onMounted(() => {
+ *   adminApi.updateCanvas({
+ *     id: '01HH4RCBH631K4JDHWAQB0RPR6',
+ *     fields: 'id,name',
+ *     name: 'To 3!',
+ *   }).then((res) => {
+ *     console.log(res)  // logs: { id: '01HH4RCBH631K4JDHWAQB0RPR6', name: 'To 3!' }
+ *   })
+ * })
+ * ```
+ */
+export declare function updateCanvas(payload: PatchedCanvasUpdateRequest & {
+    id: Canvas['id'];
+    instance_id?: Instance['id'];
+    fields?: string;
+}): Promise<Canvas>;

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

@@ -0,0 +1,10 @@
+import { AdminEnv } from './types.admin';
+
+/**
+ * Fetches the necessary info for the app to know where it is embedded.
+ *
+ * ```
+ * adminApi.getEnv()
+ * ```
+ */
+export declare function getEnv(): Promise<AdminEnv>;

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

@@ -0,0 +1,10 @@
+/**
+ * Fetches the config values for an installed app by its name.
+ *
+ * ```
+ * adminApi.getAppConfig({ app_name: 'my-app' })
+ * ```
+ */
+export declare function getAppConfig(payload: {
+    app_name: string;
+}): Promise<Record<string, any>>;

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

@@ -0,0 +1,6 @@
+import { ADMIN_MESSAGE_TYPES, AdminMessagePayloads } from './types.admin';
+
+export declare function on(type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES], handler: (data: AdminMessagePayloads[typeof type]) => Promise<void>): Promise<() => void>;
+export * from './env.admin';
+export * from './canvas.admin';
+export * from './metadataTemplates.admin';

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

@@ -0,0 +1,11 @@
+import { PaginatedMetadataTemplateList } from '../../../../../types/openapi';
+import { GetInstanceMetadataTemplatesPayload } from '../../../payload.types';
+
+/**
+ * Fetches a list of metadata templates to use in your app. Instance is auto-injected by admin app if in instance scope.
+ *
+ * ```
+ * adminApi.getInstanceMetadataTemplates()
+ * ```
+ **/
+export declare function getInstanceMetadataTemplates(payload?: GetInstanceMetadataTemplatesPayload): Promise<PaginatedMetadataTemplateList>;

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

@@ -0,0 +1,46 @@
+import { PitcherEnv } from '../../../interfaces';
+
+export declare const ADMIN_MESSAGE: "ADMIN_MESSAGE";
+export declare const ADMIN_MESSAGE_TYPES: {
+    readonly ENV_CHANGED: "admin_env_changed";
+};
+export declare const ADMIN_API_TYPES: {
+    readonly ADMIN_REQUEST: "ADMIN_REQUEST";
+    readonly ADMIN_RESPONSE: "ADMIN_RESPONSE";
+};
+export declare const ADMIN_API_METHOD_TYPES: {
+    readonly CREATE_CANVAS: "admin_create_canvas";
+    readonly GET_ENV: "admin_get_env";
+    readonly GET_CANVAS: "admin_get_canvas";
+    readonly GET_CANVASES: "admin_get_canvases";
+    readonly UPDATE_CANVAS: "admin_update_canvas";
+    readonly GET_INSTANCE_METADATA_TEMPLATES: "admin_get_instance_metadata_templates";
+    readonly GET_APP_CONFIG: "admin_get_app_config";
+};
+export type AdminMessagePayloads = {
+    [ADMIN_MESSAGE_TYPES.ENV_CHANGED]: AdminEnv;
+};
+export type AdminRequest<Payload = any> = {
+    id: string;
+    type: (typeof ADMIN_API_TYPES)['ADMIN_REQUEST'];
+    body: {
+        type: (typeof ADMIN_API_METHOD_TYPES)[keyof typeof ADMIN_API_METHOD_TYPES];
+        data: Payload;
+    };
+};
+export type AdminResponse<Response = any> = {
+    id: string;
+    type: (typeof ADMIN_API_TYPES)['ADMIN_RESPONSE'];
+    body: Response;
+};
+export type AdminMessage<Payload = any> = {
+    id: string;
+    type: typeof ADMIN_MESSAGE;
+    body: {
+        type: (typeof ADMIN_MESSAGE_TYPES)[keyof typeof ADMIN_MESSAGE_TYPES];
+        data: Payload;
+    };
+};
+export type AdminEnv = {
+    pitcher: PitcherEnv['pitcher'];
+};