@buildocsdev/sdk 1.1.0

package/dist/index.d.ts

@@ -0,0 +1,1068 @@
+import * as React$1 from 'react';
+import React__default, { ReactNode } from 'react';
+import { FieldValues } from 'react-hook-form';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { CancelTokenSource } from 'axios';
+
+type TAutoSave = {
+    pluginCode: string;
+    formCode: string;
+    guid: string;
+    projectGuid?: string;
+    pGuid?: string;
+    fieldName: string;
+    value: string;
+    tabId?: string;
+    widgetEvent: string;
+    widgetValue: string;
+    formData: Record<string, any> | {};
+};
+type TFormEvent = {
+    tabIndex?: number;
+    widgetName: string;
+    widgetValue?: string | [] | null;
+    widgetEvent?: string | null;
+    widgetContext?: string | null;
+    feCommand?: {} | null;
+    skipFormDataItem?: boolean;
+    autoSave?: TAutoSave;
+};
+type TWidgetContext = {
+    referer: string;
+    parentWidgetId: string | null;
+};
+type TRowItemResult = {
+    item: any;
+    component: any;
+    index: string;
+    path: [];
+    hasChildren: boolean;
+};
+type TSegmentItemResult = {
+    item: any;
+    index: number;
+};
+type WidgetItemResult = {
+    item: any;
+    index: number;
+    path: [];
+    count: number;
+};
+type THotReloadContext = {
+    maxAttempts: number;
+    pluginCode: string;
+    formCode: string;
+    guid?: string | null;
+};
+type TBuildPlugin = {
+    guid?: string | undefined;
+    maxattempts?: string | undefined;
+    plugincode: string | undefined;
+    referer?: string | undefined;
+    url?: string | undefined;
+    open?: boolean;
+    modalCloseCallBack?: Function;
+    redraw?: boolean | null;
+};
+type TCommandCollection = {
+    AfterRecordSave?: {
+        guid: string;
+    };
+    BuildPlugin?: TBuildPlugin;
+    CloseDisplayComponent?: {
+        componentName: string;
+        options?: object;
+    };
+    DisplayButtonLoader?: boolean;
+    DisplayComponent?: {
+        componentName: string;
+        options?: object;
+    };
+    DisplayErrorPage?: null;
+    ReplaceContextRecordGuid?: {
+        guid: string;
+    };
+    Cancel?: null;
+    CloseForm?: null;
+    FetchUserMenu?: {
+        projectGuid?: string | null;
+    };
+    FormValidationData?: Record<string, string>;
+    Messages?: [];
+    MoveToTab?: {
+        widgetName: string;
+    };
+    MoveToPreviousTab?: null;
+    OpenModal?: TModalWindow;
+    PreviewDocument?: TPreviewDocument;
+    Redirect?: {
+        context?: {
+            referer: string;
+            widgetName: string;
+            parentWidgetId: string;
+        } | null;
+        url: string;
+    };
+    RedrawScreen?: boolean;
+    RedrawFolders?: TFolderId;
+    SetActivePageData?: {
+        [key: string]: {
+            pageIndex: number;
+            pageSize: number;
+        };
+    };
+    UpdateFieldAllowedValues?: object;
+    UpdateFormData?: object;
+    UpdateFormDataItem?: {
+        name: string;
+        value: object;
+    };
+    UpdateWidgetsState?: TWidgetsState;
+    HotReloadEnabled?: THotReloadContext;
+    Login?: FieldValues;
+    Logout?: null;
+};
+type TFolderId = {
+    folderId: string | null;
+    isRoot?: string;
+    captions: [];
+};
+type TMessage = {
+    code: string;
+    text: string;
+};
+type TDeleteRecordPrompt = {
+    delete: {
+        buttonAgree: string;
+        buttonDisagree: string;
+        dialogTitle: string;
+        dialogContent: string;
+        showDialog: boolean;
+        callBackFunc: any;
+    };
+};
+type TParent = {
+    widgetName: string;
+    params: TOriginatorParams;
+};
+type TOriginator = {
+    params: TOriginatorParams;
+};
+type TOriginatorParams = {
+    pluginCode: string;
+    formCode: string;
+    guid?: string;
+};
+type TModalWindow = {
+    component?: React.ReactElement;
+    folderData?: TFolderData;
+    prefillData?: object;
+    id?: string | null;
+    parentId?: string | null;
+    pluginCode?: string;
+    formCode?: string;
+    guid?: string | null;
+    pGuid?: string | null | undefined;
+    onCloseModal?: Function | null;
+    originator?: TOriginator;
+    parent?: TParent;
+    isFormEditorMode?: boolean;
+    windowMode?: "fullWindow" | "halfWindow" | string | null;
+};
+type TMethodProvider = {
+    eventDispatcher: (args: TFormEvent) => Function;
+    findRowItem: (tabId: string, panelId: string, id: string) => TRowItemResult;
+    findSegmentItem: (tabId: string, panelId: string, rowId: string, segmentId: string) => TSegmentItemResult;
+    findWidgetItem: (widgetId: string) => WidgetItemResult;
+    getActiveTabIndex: (parentTabId: string, tabId: string) => number | null;
+    setActiveTabIndex: (parentTabId: string, tabId: string, panelIndex: number) => void;
+    setRedrawComponent: () => void;
+    execCommands: (command: TCommandCollection) => void;
+};
+type TPreviewDocument = {
+    context: {
+        pluginCode: string;
+        formCode: string;
+        guid?: string;
+        pGuid?: string;
+    } | null;
+    fileId: string;
+    data: string;
+    type: string;
+    fieldName: string;
+};
+type TWidgetsState = {
+    visibility: {
+        [key: string]: boolean;
+    };
+    readonly: {
+        [key: string]: boolean;
+    };
+};
+type TFieldValues = Record<string, any>;
+type TFolderData = {
+    id: string;
+    captions: string[];
+    label?: string;
+    addedFolderId?: string;
+    isRoot?: string;
+};
+type TRedrawFolders = {
+    folderId?: string;
+};
+type TContextType = {
+    activeWidgetId?: string;
+    command: TCommandCollection;
+    containerSetup?: any;
+    displayButtonLoader?: boolean;
+    doValidateForm: boolean;
+    enableEventHandlers: boolean;
+    fieldAllowedValues: any;
+    formData: Record<string, any>;
+    widgetRelatedData: string[];
+    widgetsState: TWidgetsState;
+    formDimension: {
+        width: number;
+        height: number;
+    };
+    formValidationData?: object;
+    isModal: boolean;
+    hasParentForm: boolean;
+    formLayout: string | null;
+    requiredFields?: Record<string, string>;
+    params: {
+        id: string | null;
+        parentId: string | null;
+        guid: string;
+        pGuid: string;
+        formCode: string;
+        pluginCode: string;
+        modal: boolean;
+        modalCloseFn: Function;
+        modalCloseAndOpenFn?: Function;
+        originator?: TOriginator;
+        parent?: TParent;
+        hasParentForm: boolean;
+        folderData: TFolderData;
+        prefillData?: object;
+    };
+    redrawComponent: boolean;
+    redrawFoldersComponent: boolean;
+    tabIndex?: number;
+};
+type TDataTableMeta = {
+    rowsPerPage: number;
+    pageIndex: number;
+    serverPaginationEnabled: boolean;
+    nextToken?: string;
+    paginationDirection?: "first" | "next" | "previous" | "last";
+    previousToken?: string;
+    rowCount: number;
+    qId?: string;
+    lastRequestLimit?: number;
+};
+
+interface IFormRequest {
+    pluginCode: string;
+    formCode: string;
+    guid?: string | null | undefined;
+    originator?: TOriginator;
+    pGuid?: string;
+    folderData?: TFolderData;
+}
+
+type TDynProps = {
+    modalCloseFn: () => void;
+    modalCloseAndOpenFn?: (formData: IFormRequest) => void;
+    params?: any;
+    options?: any;
+    formData?: object;
+    execCommands: (command: TCommandCollection) => void;
+};
+interface DynamicComponentProps {
+    componentName: string;
+    options?: object;
+    params?: TDynProps;
+    fallback?: React__default.ReactNode;
+}
+declare const DynamicComponent: React__default.FC<DynamicComponentProps>;
+
+/**
+ * Initialize dayjs with required plugins for buildocsformviewer
+ * Call this function in your parent project before using form components with date fields
+ *
+ * @example
+ * // In your parent project's index.tsx or App.tsx:
+ * import { initializeDayjs } from '@alexrussdev/buildocsformviewer/utils/dayjsConfig';
+ * import 'dayjs/locale/en';
+ * import 'dayjs/locale/de';
+ * import 'dayjs/locale/fr';
+ * // ... import other locales you need
+ *
+ * initializeDayjs();
+ */
+declare const initializeDayjs: () => void;
+/**
+ * Check if dayjs has been initialized
+ */
+declare const isDayjsInitialized: () => boolean;
+
+/**
+ * Dynamically loads a dayjs locale on demand
+ * @param locale - The locale code (e.g., 'en', 'de', 'fr')
+ * @returns Promise that resolves when locale is loaded
+ */
+declare const loadLocale: (locale: string) => Promise<boolean>;
+/**
+ * Check if a locale has been loaded
+ * @param locale - The locale code to check
+ */
+declare const isLocaleLoaded: (locale: string) => boolean;
+/**
+ * Preload multiple locales at once
+ * @param locales - Array of locale codes to preload
+ * @example
+ * preloadLocales(['de', 'fr', 'es']);
+ */
+declare const preloadLocales: (locales: string[]) => Promise<void>;
+/**
+ * Get list of all loaded locales
+ */
+declare const getLoadedLocales: () => string[];
+
+interface LanguageOption {
+    code: string;
+    label: string;
+    flag?: string;
+}
+interface LanguageSwitcherProps {
+    /** Custom list of available languages (defaults to all supported) */
+    languages?: LanguageOption[];
+    /** Show flags next to language names */
+    showFlags?: boolean;
+    /** Label for the select input */
+    label?: string;
+    /** Variant of the select input */
+    variant?: 'outlined' | 'filled' | 'standard';
+    /** Size of the select input */
+    size?: 'small' | 'medium';
+}
+/**
+ * Language switcher component for testing different locales
+ * Changes both i18next language and preloads dayjs locales
+ */
+declare const LanguageSwitcher: React__default.FC<LanguageSwitcherProps>;
+
+interface UploadArgs {
+    content: FormData;
+    onUploadProgress?: (e: ProgressEvent) => void;
+    cancelTokenSource?: CancelTokenSource;
+    headers?: Record<string, string>;
+}
+interface DataTableMeta {
+    serverPaginationEnabled: boolean;
+    rowsPerPage: number;
+    pageIndex: number;
+    nextToken?: string;
+    previousToken?: string;
+    paginationDirection?: string;
+    rowCount?: number;
+    qId?: string;
+    lastRequestLimit?: number;
+    oppositeDirection?: boolean;
+}
+type RunEventArgs = {
+    DataTableMeta?: DataTableMeta;
+    pluginCode: string;
+    formCode: string;
+    guid?: string;
+    projectGuid?: string;
+    pGuid?: string;
+    formData?: Record<string, any>;
+    widgetContext?: string | null | undefined;
+    widgetEvent: string | undefined;
+    widgetName?: string | null;
+    widgetValue?: string | null;
+    widgetsState?: TWidgetsState;
+};
+type TLoadForm = {
+    pluginCode: string;
+    formCode: string;
+    guid?: string;
+    originator?: {};
+    parent?: {};
+    isFormEditor?: boolean;
+    eventWidgetName?: string;
+    projectGuid?: string;
+    pGuid?: string;
+    previewMode?: any;
+    widgetContext?: string;
+};
+type TPingArgs = {
+    cmd: string;
+};
+interface FileEventArgs {
+    pluginCode: string;
+    formCode: string;
+    guid?: string;
+    projectGuid?: string;
+    pGuid?: string;
+    fieldName: string;
+    fileId: string;
+}
+interface FileMetaEventArgs extends FileEventArgs {
+    context: {
+        action: string;
+    };
+}
+interface DeleteFileEventArgs extends FileEventArgs {
+}
+interface DownloadFileEventArgs extends FileEventArgs {
+}
+interface GetLinkedFileMetaEventArgs extends FileMetaEventArgs {
+}
+interface ChunkRequestArgs extends DownloadFileEventArgs {
+    range: string;
+}
+interface ChunkPayload$1 {
+    payload: ArrayBuffer;
+    contentRange?: string;
+    etag?: string;
+    lastModified?: string;
+    headers: Record<string, string>;
+}
+type MenuItemType = {
+    title: string;
+    link?: string;
+    icon?: string;
+    subMenus?: MenuItemType[];
+};
+type TProjectItem = {
+    guid: string;
+    title: string;
+    desc?: string;
+    dashboardLink?: string;
+    settingsLink?: string;
+    icon?: string;
+};
+type TProjectMeta = {
+    pluginCode: string;
+    formCode: string;
+};
+type TProjectRights = {
+    adminRights: boolean;
+};
+type TUserMenuRequest = {
+    ProjectGuid: string | null;
+    pGuid?: string | null;
+};
+interface IUserMenu {
+    loadingUserMenu: boolean;
+    userMenuData: {
+        mainMenu: MenuItemType[];
+        loginMenu: MenuItemType[];
+        projectMenu: MenuItemType[];
+    };
+    userProjectData: {
+        meta: TProjectMeta;
+        data: TProjectItem[];
+        rights: TProjectRights;
+        prjEntryCode?: string;
+    };
+    redirectOnLoginUrl?: string;
+    error?: string | null | undefined;
+}
+interface IUser {
+    email: string;
+    fullName: string;
+    token: string;
+    roles?: string[];
+    userEnv?: IUserEnv[] | null;
+    currentCulture: string;
+}
+interface IUserEnv {
+    TenantUrl: string;
+    EnvUrl: string;
+}
+interface HostBridge {
+    apiConfig?: {
+        token?: string;
+        baseURL: string;
+        iframeMode?: boolean;
+        lang?: string;
+    };
+    appSettings?: {
+        MAX_DOWNLOAD_NOCHUNK_FILESIZE: number;
+        SCREEN_WIDTH_TABLET: number;
+        TOASTER_AUTOCLOSE: number;
+    };
+    viewPort: {
+        isMobileDevice: boolean;
+        width: number;
+        height: number;
+    };
+    runFormEvent: (args: RunEventArgs) => Promise<any>;
+    runFormUploadFiles: (args: UploadArgs) => Promise<any>;
+    runFormDeleteFileEvent: (args: DeleteFileEventArgs) => Promise<any>;
+    runFormDownloadFileEvent: (args: DownloadFileEventArgs) => Promise<Blob>;
+    runFormGetLinkedFileEvent: (args: GetLinkedFileMetaEventArgs) => Promise<any>;
+    runFormGetLinkedFileMetaEvent: (args: GetLinkedFileMetaEventArgs) => Promise<any>;
+    runFormGetLinkedFileByChunks: (args: ChunkRequestArgs) => Promise<ChunkPayload$1>;
+    runFormGetPresignedUrl: (args: FileMetaEventArgs) => Promise<any>;
+    runFormGetMdaUrn?: (args: FileMetaEventArgs) => Promise<any>;
+    runServerPingEvent?: (args: TPingArgs) => Promise<any>;
+    runLoadFormEvent: (args: TLoadForm) => Promise<any>;
+    fetchUserMenu?: (args: TUserMenuRequest) => Promise<IUserMenu>;
+    signInUser?: (args: TFieldValues) => Promise<IUser>;
+    signOut?: () => void;
+    loadForm?: (args: any) => Promise<any>;
+    saveForm?: (args: any) => Promise<any>;
+    loadFields?: (args: any) => Promise<any>;
+    buildPlugin?: (args: any) => Promise<any>;
+    ping?: (args: any) => Promise<any>;
+}
+declare function HostBridgeProvider({ value, children }: Readonly<{
+    value: HostBridge;
+    children: React__default.ReactNode;
+}>): react_jsx_runtime.JSX.Element;
+declare function useHostBridgeProvider(): HostBridge;
+
+interface UserDialogProps {
+    buttonAgree: string;
+    buttonDisagree: string;
+    dialogTitle: string;
+    dialogContent: string;
+    handleDialogClose: (result: boolean) => void;
+    showDialog: boolean;
+}
+type UserDialogComponent = React__default.ComponentType<UserDialogProps>;
+interface UiComponents {
+    UserDialog: UserDialogComponent;
+}
+declare function UiComponentsProvider({ value, children }: {
+    value: UiComponents;
+    children: React__default.ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useUiComponents(): UiComponents;
+
+declare const HostUserDialog: React__default.NamedExoticComponent<UserDialogProps>;
+
+interface ToastMessageProps {
+    msg: string;
+    toastID?: string | number;
+    clearQueue?: boolean;
+    hideProgressBar?: boolean;
+}
+type ToastFn = (p: ToastMessageProps) => void;
+interface ToastApi {
+    warn: ToastFn;
+    success: ToastFn;
+    info: ToastFn;
+    error: ToastFn;
+    dismissAll?: () => void;
+}
+declare const ToastFnsProvider: React$1.Provider<ToastApi>;
+declare function useToast(): ToastApi;
+declare function useWarningMessage(): ToastFn;
+declare function useSuccessMessage(): ToastFn;
+declare function useInfoMessage(): ToastFn;
+declare function useErrorMessage(): ToastFn;
+
+declare function ErrorMessage({ toastID, msg, clearQueue, hideProgressBar, }: ToastMessageProps): void;
+declare function InfoMessage({ toastID, msg, clearQueue, hideProgressBar, }: ToastMessageProps): void;
+declare function SuccessMessage({ toastID, msg, clearQueue, hideProgressBar, }: ToastMessageProps): void;
+declare function WarningMessage({ toastID, msg, clearQueue, hideProgressBar, }: ToastMessageProps): void;
+declare const ToastNotification: React__default.FC;
+
+interface FormParams {
+    pluginCode: string;
+    formCode: string;
+    guid?: string;
+    pGuid?: string;
+    [k: string]: any;
+}
+interface FormLayoutProps {
+    children: React__default.ReactNode;
+    formlayout: string | null;
+    params: FormParams;
+    onFolderSelected: Function;
+    onFolderAdded: Function;
+    redrawComponent: boolean;
+    eventDispatcher?: (event: any) => void;
+    formData: object;
+    execCommands: (command: TCommandCollection) => void;
+}
+type FormLayoutComponent = React__default.ComponentType<FormLayoutProps>;
+declare const FormLayoutProviderBridge: React__default.Provider<FormLayoutComponent>;
+declare function useFormLayoutComponent(): FormLayoutComponent;
+
+/** A dynamically imported module that exposes a default React component */
+type LoadedModule = {
+    default: React__default.ComponentType<any>;
+};
+/** Loader function that resolves a component module by name */
+type ComponentLoader = (name: string) => Promise<LoadedModule>;
+/** Optional map of known components to importers (host/package/remote) */
+type Registry = Record<string, () => Promise<LoadedModule>>;
+declare const DynamicComponentLoaderProvider: React__default.Provider<ComponentLoader>;
+declare function useComponentLoader(): ComponentLoader;
+type CreateLoaderOptions = {
+    /** Time-to-live for cache entries in ms (default: Infinity = never expire) */
+    ttl?: number;
+    /** Called when a load fails (centralized logging) */
+    onError?: (name: string, error: unknown) => void;
+};
+/**
+ * Factory: create a cached loader from a registry and optional fallback importer.
+ * - registry[name] wins; fallback is used only if not in registry.
+ * - fallback receives the name (handy for templated paths).
+ */
+declare function createCachedComponentLoader(registry: Registry, fallback?: (name: string) => Promise<LoadedModule>, opts?: CreateLoaderOptions): ComponentLoader & {
+    preload: (name: string) => Promise<LoadedModule | undefined>;
+    warm: (names: string[]) => Promise<undefined>;
+    evict: (name: string) => undefined;
+    clear: () => undefined;
+};
+
+interface ApiConfig {
+    token?: string;
+    /** Separate token for form events, file uploads, and other consumer-facing operations.
+     *  When set, event/file methods use this token while form-definition loading uses `token`.
+     *  Falls back to `token` if not provided. */
+    eventToken?: string;
+    lang?: string;
+    baseURL?: string;
+    iframeMode?: boolean;
+}
+declare function useApiConfig(): ApiConfig;
+interface ApiConfigProviderProps {
+    readonly token?: string;
+    readonly eventToken?: string;
+    readonly lang?: string;
+    readonly baseURL?: string;
+    readonly iframeMode?: boolean;
+    readonly children: React__default.ReactNode;
+}
+declare function ApiConfigProvider({ token, eventToken, lang, baseURL, iframeMode, children }: ApiConfigProviderProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Generic persistent state store for widgets.
+ * Allows any widget to store and retrieve state by widget name.
+ * State persists across component remounts as long as the provider stays mounted.
+ */
+type WidgetState = Record<string, any>;
+interface PersistentStateContextValue {
+    getState: <T = any>(widgetName: string, key: string, defaultValue?: T) => T;
+    setState: <T = any>(widgetName: string, key: string, value: T) => void;
+    resetState: (widgetName: string) => void;
+    getWidgetState: <T extends WidgetState = WidgetState>(widgetName: string) => T | undefined;
+    setWidgetState: <T extends WidgetState = WidgetState>(widgetName: string, state: T) => void;
+    pagination: {
+        getPageIndex: (widgetName: string) => number;
+        getPageSize: (widgetName: string, defaultSize?: number) => number;
+        setPageIndex: (widgetName: string, index: number) => void;
+        setPageSize: (widgetName: string, size: number) => void;
+        getLastEvaluatedKey: (widgetName: string, pageIndex: number) => string | null;
+        setLastEvaluatedKey: (widgetName: string, pageIndex: number, key: string | null) => void;
+        reset: (widgetName: string, initialPageSize?: number) => void;
+    };
+}
+declare function PersistentStateProvider({ children }: {
+    children: React__default.ReactNode;
+}): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access the persistent state store.
+ * Must be used within a PersistentStateProvider.
+ */
+declare function usePersistentState(): PersistentStateContextValue;
+/**
+ * Hook to get/set state for a specific widget.
+ * Convenience wrapper around usePersistentState for a single widget.
+ */
+declare function useWidgetPersistentState<T extends WidgetState = WidgetState>(widgetName: string): {
+    get: <V = any>(key: string, defaultValue?: V | undefined) => V;
+    set: <V_1 = any>(key: string, value: V_1) => void;
+    reset: () => void;
+    getAll: () => T | undefined;
+    setAll: (state: T) => void;
+};
+/**
+ * Hook specifically for datatable pagination state.
+ * Convenience wrapper for pagination operations.
+ */
+declare function useDatatablePagination(widgetName: string, defaultPageSize?: number): {
+    pageIndex: number;
+    pageSize: number;
+    setPageIndex: (index: number) => void;
+    setPageSize: (size: number) => void;
+    getLastEvaluatedKey: (pageIndex: number) => string | null;
+    setLastEvaluatedKey: (pageIndex: number, key: string | null) => void;
+    reset: (initialPageSize?: number) => void;
+};
+
+interface FormThemeProviderProps {
+    readonly children: React__default.ReactNode;
+    readonly enabled?: boolean;
+}
+declare function FormThemeProvider({ children, enabled, }: FormThemeProviderProps): react_jsx_runtime.JSX.Element;
+
+type IModalState = {
+    pluginCode: string;
+    formCode: string;
+    guid: string | null;
+};
+type ICurrentModalContext = [IModalState, React__default.Dispatch<React__default.SetStateAction<IModalState>>];
+declare const ModalContext: React__default.Context<ICurrentModalContext>;
+declare const ModalProvider: ({ children }: {
+    children: React__default.ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+
+declare const ViewportProvider: ({ children }: {
+    children: React__default.ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+declare const useViewport: () => {
+    width: number;
+    height: number;
+    isMobileDevice: boolean;
+};
+
+interface ThemeConfig {
+    palette: {
+        primary: {
+            main: string;
+            dark: string;
+            light: string;
+        };
+        secondary: {
+            main: string;
+            dark: string;
+        };
+        background: {
+            default: string;
+            paper: string;
+        };
+        text: {
+            primary: string;
+            secondary: string;
+        };
+    };
+    customColors: {
+        elBgClass: string;
+        elBorderClass: string;
+        elTextClass: string;
+        disabledElBgClass: string;
+        disabledElBorderClass: string;
+        disabledElTextClass: string;
+    };
+    typography: {
+        fontFamily: string;
+    };
+}
+declare const fetchProjectTheme: (baseURL: string, token: string) => Promise<ThemeConfig | null>;
+declare const applyThemeToDom: (theme: ThemeConfig) => void;
+declare const removeThemeFromDom: () => void;
+
+interface ChunkPayload {
+    payload: ArrayBuffer;
+    contentRange?: string;
+    etag?: string;
+    lastModified?: string;
+    headers: Record<string, string>;
+}
+type TFile = {
+    pluginCode: string;
+    formCode: string;
+    guid?: string;
+    projectGuid?: string;
+    fieldName: string;
+    fileId: string;
+};
+type TGetLinkedFileMetaEvent = TFile & {
+    context: {
+        action: string;
+    };
+};
+type TGetFileByChunks = TFile & {
+    range: string;
+};
+type TGetPresignedUrlEvent = TFile & {
+    context: {
+        action: string;
+    };
+};
+declare function useBuildocsApi(customApiUrl?: string, tokenOverride?: string, langOverride?: string): {
+    fetchFormDefinitionWithMeta: (formId: string, data?: object) => Promise<{
+        type: string;
+        payload: any;
+        meta: {
+            requestStatus: string;
+        };
+        error?: undefined;
+    } | {
+        type: string;
+        payload: undefined;
+        error: any;
+        meta: {
+            requestStatus: string;
+        };
+    }>;
+    fetchFormDefinitionApi: (formId: string, data?: object) => Promise<any>;
+    uploadFiles: (params: {
+        content: FormData;
+        onUploadProgress?: Function;
+        cancelTokenSource?: CancelTokenSource;
+    }, customPath?: string) => Promise<{
+        type: string;
+        payload: any;
+        meta: {
+            requestStatus: string;
+        };
+        error?: undefined;
+    } | {
+        type: string;
+        payload: undefined;
+        error: any;
+        meta: {
+            requestStatus: string;
+        };
+    }>;
+    deleteFile: (payload: TFile, customPath?: string) => Promise<{
+        type: string;
+        payload: any;
+        meta: {
+            requestStatus: string;
+        };
+        error?: undefined;
+    } | {
+        type: string;
+        payload: undefined;
+        error: any;
+        meta: {
+            requestStatus: string;
+        };
+    }>;
+    getLinkedFile: (payload: TGetLinkedFileMetaEvent, customPath?: string) => Promise<{
+        type: string;
+        payload: any;
+        meta: {
+            requestStatus: string;
+        };
+        error?: undefined;
+    } | {
+        type: string;
+        payload: undefined;
+        error: any;
+        meta: {
+            requestStatus: string;
+        };
+    }>;
+    getLinkedFileByChunks: (payload: TGetFileByChunks, customPath?: string) => Promise<ChunkPayload>;
+    getPresignedUrl: (payload: TGetPresignedUrlEvent, customPath?: string) => Promise<{
+        type: string;
+        payload: any;
+        meta: {
+            requestStatus: string;
+        };
+        error?: undefined;
+    } | {
+        type: string;
+        payload: undefined;
+        error: any;
+        meta: {
+            requestStatus: string;
+        };
+    }>;
+    downloadFile: (payload: TFile, customPath?: string) => Promise<any>;
+    getLinkedFileMetaEvent: (payload: TGetLinkedFileMetaEvent, customPath?: string) => Promise<{
+        type: string;
+        payload: any;
+        meta: {
+            requestStatus: string;
+        };
+        error?: undefined;
+    } | {
+        type: string;
+        payload: undefined;
+        error: any;
+        meta: {
+            requestStatus: string;
+        };
+    }>;
+    checkFormAccess: (formId: string) => Promise<any>;
+    registerFormSubmitEvent: (formId: string) => Promise<any>;
+    submitForm: (formId: string, data: Record<string, any>, customPath?: string) => Promise<{
+        type: string;
+        payload: any;
+        meta: {
+            requestStatus: string;
+        };
+        error?: undefined;
+    } | {
+        type: string;
+        payload: undefined;
+        error: any;
+        meta: {
+            requestStatus: string;
+        };
+    }>;
+    runEvent: (payload: RunEventArgs, customPath?: string) => Promise<{
+        type: string;
+        payload: any;
+        meta: {
+            requestStatus: string;
+        };
+        error?: undefined;
+    } | {
+        type: string;
+        payload: undefined;
+        error: any;
+        meta: {
+            requestStatus: string;
+        };
+    }>;
+    createCancelToken: () => CancelTokenSource;
+};
+
+declare function useSubscriptionPlan(): string | null;
+
+interface BuildocsProviderProps {
+    readonly children: React__default.ReactNode;
+    readonly apiKey: string;
+    readonly themeEnabled?: boolean;
+}
+declare function BuildocsProvider({ children, apiKey, themeEnabled, }: BuildocsProviderProps): react_jsx_runtime.JSX.Element;
+
+interface BuildocsHostProviderProps {
+    readonly children: React__default.ReactNode;
+    readonly hostBridge: HostBridge;
+}
+declare function BuildocsHostProvider({ children, hostBridge, }: BuildocsHostProviderProps): react_jsx_runtime.JSX.Element;
+
+interface BuildocsExtendedEditorContextType {
+    isBuildocsExtendedEditor: boolean;
+}
+interface BuildocsExtendedEditorProviderProps {
+    children: ReactNode;
+    isBuildocsExtendedEditor?: boolean;
+}
+declare const BuildocsExtendedEditorProvider: React__default.FC<BuildocsExtendedEditorProviderProps>;
+declare const useBuildocsExtendedEditor: () => BuildocsExtendedEditorContextType;
+
+interface IFormEditor {
+    formDefinition: {} | null;
+}
+
+declare const PluginWaitForm: React$1.NamedExoticComponent<TBuildPlugin>;
+
+declare class FormCommon {
+    static debounce<T extends (...args: any[]) => void>(fn: T, wait?: number): T & {
+        cancel: () => void;
+        flush: () => void;
+    };
+    static getDefaultTabIndex: (formData: any) => number;
+    static getComponentByStrictType: (stricttype: string) => React$1.NamedExoticComponent<any> | undefined;
+    static getItemDefaultName: (component: any, nodeData: any) => string;
+    static getTypeAsString: (component: any) => string | undefined;
+    static getItemCount: (component: any, nodeData: any, ElCounter: any) => any;
+    /**
+     * Returns container data (recursion)
+     * @param nodeData
+     * @param widgetId
+     * @param path
+     * @returns {{path: *[], data}|{path: *[], data: *}|{path: *[], data: *}|*|{path: *[], data: [], index: *}|{path: *[], data: [], index: *}|{path: *[], data: [], index}}
+     * @private
+     */
+    static getTabContainerChildrens: (nodeData: any, widgetId: any, path?: any) => any;
+    static mapComponents: (data: []) => void;
+    /**
+     * Returns the widget item (recursion)
+     * @param nodeData
+     * @param widgetId
+     * @returns {*|{item: *, index: *}|{item: *, index: *}|{item, index}}
+     * @private
+     */
+    static findWidgetByIdRecursive: (nodeData: any, widgetId: any, path?: any) => WidgetItemResult | undefined;
+    static findPanelItem: (tabId: string, panelId: string, data: any) => {
+        item: any;
+        index: any;
+    };
+    static findRowItem: (tabId: string | null, panelId: string | null, id: string, data: any) => TRowItemResult;
+    static findTableCellItem: (tabId: string, panelId: string, rowId: string, segmentId: string, data: any) => {
+        item: any;
+        index: any;
+    };
+    static findSegmentItem: (tabId: string, panelId: string, rowId: string, segmentId: string, data: any) => {
+        item: any;
+        index: any;
+    };
+    static GetParentTabId(nodeData: any, tabId: string, tabIndex?: {
+        [key: string]: number;
+    }): {
+        tabId: string;
+        index: number;
+    } | null;
+    static getTabWidgetByFieldName(fieldName: string, nodeData: any, tabIndex?: {
+        [key: string]: number;
+    }): {
+        tabId: any;
+        index: number;
+    } | null;
+    /**
+     * Returns the correct container widget (recursion)
+     * @param nodeData
+     * @param tabId
+     * @returns {{path: *[], item, index}|*|{path: [], item: *, index: *}|{path: [], item: *, index: *}|null}
+     * @private
+     */
+    static getTabContainer: (nodeData: any, tabId: string, path?: any) => any;
+    /**
+     * Returns an element update path for immutable (nested position in form widgets data object)
+     * @param pos
+     * @param path
+     * @param experssion
+     * @returns {{}}
+     * @private
+     */
+    static getNodeUpdatePath: (path: any, experssion: any) => {};
+    static getActiveTabIndex: (data: any, tabId: string) => number | null;
+    static getActiveTabPanelId: (data: any, tabId: string) => any;
+    static isChildrenTab: (formData: any, targetId: string, tabId: string) => boolean;
+    static getAllTabIdInChain: (formData: any, result?: any) => any;
+    static getUrlParameter: (parameterName: string) => string | null;
+    static hasParentForm2: () => boolean;
+    static hasParentForm: () => boolean;
+    static extractProjectGuid: (url: string) => string | null;
+}
+
+declare const ModalWindow: React__default.NamedExoticComponent<TModalWindow>;
+
+declare class FormEvents {
+    static readonly onChange = "onChange";
+    static readonly onClick = "onClick";
+    static readonly onCancel = "onCancel";
+    static readonly onDelete = "onDelete";
+    static readonly onPrint = "onPrint";
+    static readonly onSave = "onSave";
+    static readonly onRefresh = "onRefresh";
+    static readonly onTableDataLoad = "onTableLoadData";
+    static readonly onTableEditDataLoad = "onTableEditLoadData";
+    static readonly onTableCreateRecordEvent = "onTableCreateRecordEvent";
+    static readonly onFolderCreateRecordEvent = "onFolderCreateRecordEvent";
+    static readonly onFolderEditRecordEvent = "onFolderEditRecordEvent";
+    static readonly onFolderShareRecordEvent = "onFolderShareRecordEvent";
+    static readonly onTableSelectRowEvent = "onTableSelectRowEvent";
+    static readonly onTableRunActionEvent = "onTableRunActionEvent";
+    static readonly onTableRunBatchActionEvent = "onTableRunBatchActionEvent";
+    static readonly onTableEditRunActionEvent = "onTableEditRunActionEvent";
+    static readonly onFoldersDataLoad = "onFoldersLoadData";
+    static readonly onFileUploadEvent = "onFileUpload";
+    static readonly onFileUploadCreateDocumentEvent = "onFileUploadCreateDocument";
+    static readonly onStartSignProcess = "onStartSignProcess";
+    static readonly onFinishSignProcess = "onFinishSignProcess";
+    static readonly onLoadNewRecordTemplates = "onLoadNewRecordTemplates";
+    static readonly onDirectRunFormEvent = "onDirectRunFormEvent";
+    static readonly onGetCustomResponse = "onGetCustomResponse";
+    static getFormButtonEvent(type: string): string | null;
+}
+
+export { type ApiConfig, ApiConfigProvider, BuildocsExtendedEditorProvider, BuildocsHostProvider, type BuildocsHostProviderProps, BuildocsProvider, type BuildocsProviderProps, type ChunkPayload$1 as ChunkPayload, type ChunkRequestArgs, type ComponentLoader, type DataTableMeta, type DeleteFileEventArgs, type DownloadFileEventArgs, DynamicComponent, DynamicComponentLoaderProvider, type FileMetaEventArgs, FormCommon, FormEvents, FormLayoutProviderBridge, FormThemeProvider, type FormThemeProviderProps, type GetLinkedFileMetaEventArgs, type HostBridge, HostBridgeProvider, type ICurrentModalContext, type IFormEditor, type IFormRequest, type IModalState, type IUser, type IUserEnv, type IUserMenu, LanguageSwitcher, type LoadedModule, ModalContext, ModalProvider, ModalWindow, PersistentStateProvider, PluginWaitForm, type RunEventArgs, type TAutoSave, type TBuildPlugin, type TCommandCollection, type TContextType, type TDataTableMeta, type TDeleteRecordPrompt, type TFieldValues, type TFolderData, type TFolderId, type TFormEvent, type THotReloadContext, type TLoadForm, type TMessage, type TMethodProvider, type TModalWindow, type TOriginator, type TOriginatorParams, type TParent, type TPingArgs, type TPreviewDocument, type TProjectItem, type TProjectMeta, type TProjectRights, type TRedrawFolders, type TRowItemResult, type TSegmentItemResult, type TUserMenuRequest, type TWidgetContext, type TWidgetsState, type ThemeConfig, type ToastApi, ErrorMessage as ToastErrorMessage, ToastFnsProvider, InfoMessage as ToastInfoMessage, type ToastMessageProps, ToastNotification as ToastNotificationAdapter, SuccessMessage as ToastSuccessMessage, WarningMessage as ToastWarningMessage, UiComponentsProvider, type UploadArgs, HostUserDialog as UserDialogAdapter, type UserDialogProps, ViewportProvider, type WidgetItemResult, applyThemeToDom, createCachedComponentLoader, fetchProjectTheme, getLoadedLocales, initializeDayjs, isDayjsInitialized, isLocaleLoaded, loadLocale, preloadLocales, removeThemeFromDom, useApiConfig, useBuildocsApi, useBuildocsExtendedEditor, useComponentLoader, useDatatablePagination, useErrorMessage, useFormLayoutComponent, useHostBridgeProvider, useInfoMessage, usePersistentState, useSubscriptionPlan, useSuccessMessage, useToast, useUiComponents, useViewport, useWarningMessage, useWidgetPersistentState };