@wix/patterns 1.456.0 → 1.458.0

package/dist/dts-bundle/components/TabsFilter.d.ts

@@ -0,0 +1,119 @@
+import React, { ReactElement } from 'react';
+import { CounterBadgeProps, TabsProps, DropdownProps } from '@wix/design-system';
+
+/**
+ * `CollectionOptimisticActions` — you receive this, you don't construct it.
+ * Produced by `useOptimisticActions()` (also `createNestedOptimisticActions()`, `useCreateNestedOptimisticActions()`, `useCreateOptimisticActions()`). Look `CollectionOptimisticActions` up in the bundle index for its own API.
+ */
+declare class CollectionOptimisticActions<T, F> {
+}
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T> {
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+
+interface UseFilterValueTotalStateParams<V, T, F extends FiltersMap> {
+    /**
+     * The filter value (passed at first argument to `counterBadge(value)`)
+     */
+    readonly value: V | null | undefined;
+    /**
+     * [`OptimisticActions`](./?path=/story/features-actions-updates--collectionoptimisticactions) instance to wire the total to
+     */
+    readonly optimisticActions?: CollectionOptimisticActions<T, F>;
+    /**
+     * When set to `true` the total value will not change after table search
+     */
+    readonly ignoreSearch?: boolean;
+}
+
+interface TabTotalParensProps<V, T, F extends FiltersMap> extends UseFilterValueTotalStateParams<V, T, F> {
+}
+
+interface TabCounterBadgeProps<V, T, F extends FiltersMap> extends UseFilterValueTotalStateParams<V, T, F>, Omit<Partial<CounterBadgeProps>, 'skin'> {
+    /**
+     * Badge skin. Pass a function to pick the skin from the total, for example to
+     * keep a tab neutral while its total is `0`.
+     * @external
+     */
+    readonly skin?: CounterBadgeProps['skin'] | ((total: number) => CounterBadgeProps['skin']);
+}
+
+/** Type alias for TabTotalCounterBadge component element */
+type TabTotalCounterBadge<V> = ReactElement<TabCounterBadgeProps<V, unknown, any>>;
+/** Type alias for TabTotalParens component element */
+type TabTotalParens<V> = ReactElement<TabTotalParensProps<V, unknown, any>>;
+interface TabsFilterProps<V> {
+    /**
+     * List of tabs.
+     * @external
+     */
+    data: V[];
+    /**
+     * Defines the selected filter.
+     * <br><br>
+     * Must be an [arrayFilter](./?path=/story/features-filter-factories--arrayfilter) object.
+     * @external
+     */
+    filter: Filter<V[]>;
+    /**
+     * Display name of the tab that indicates that all items are included.
+     * <br>
+     * Changes the value of `filter` to an empty array.
+     * @external
+     */
+    all?: string | null | false;
+    /**
+     * Renders a counter badge next to the tabs' texts.
+     * <br><br>
+     * See different examples of this implementation in the [Overview](./?path=/story/features-filter-components--tabsfilter) tab.
+     * @external
+     */
+    counterBadge?: (value: V | null | undefined) => TabTotalCounterBadge<V> | TabTotalParens<V> | null | undefined;
+    /**
+     * Returns whether a tab should be disabled.
+     * <br><br>
+     * Disabled tabs are non-interactive and rendered in a visually muted state.
+     * <br><br>
+     * `total` is the tab's counter total, so a tab can be disabled while its
+     * counter is `0`. It is `undefined` until the total first resolves, and stays
+     * `undefined` when `counterBadge` is not used.
+     * <br><br>
+     * Called on every render, so it must be cheap and pure. It re-runs as totals
+     * resolve, so the result may depend on them.
+     * <br>
+     * Requires `@wix/design-system` version >= 1.310.0
+     * @external
+     */
+    disabled?: (value: V, total: number | undefined) => boolean;
+    onChange?: (value: V | null | undefined) => unknown;
+    /**
+     * Tabs layout type.
+     * <br><br>
+     * If this prop is omitted, the width depends on the label width. The total width of all the tabs cannot exceed 80% of the toolbar.
+     * <br><br>
+     * Supported values:<br>
+     * - `uniformFull`: Tabs are spread out uniformly.
+     * @external
+     */
+    type?: Extract<TabsProps['type'], 'uniformFull'>;
+    placeAllTabLast?: boolean;
+    /**
+     * Custom popover props for the mobile dropdown menu. On mobile devices, tabs are displayed as a dropdown menu.
+     * @external
+     */
+    mobilePopoverProps?: DropdownProps['popoverProps'];
+}
+declare function _TabsFilter<V>(props: TabsFilterProps<V>): React.JSX.Element;
+declare const TabsFilter: typeof _TabsFilter & {
+    displayName: string;
+};
+
+export { TabsFilter };
+export type { TabsFilterProps };

package/dist/dts-bundle/components/WidgetsFormProvider.d.ts

@@ -0,0 +1,15 @@
+import React, { ReactNode } from 'react';
+
+/**
+ * `WidgetsFormState` — you receive this, you don't construct it.
+ * Produced by `useWidgetsFormContext()` (also `useWidgetForm()`).
+ */
+declare class WidgetsFormState {
+}
+
+declare function WidgetsFormProvider({ children, state, }: {
+    children: ReactNode;
+    state?: WidgetsFormState;
+}): React.JSX.Element;
+
+export { WidgetsFormProvider };

package/dist/dts-bundle/components/WixPatternsBMProvider.d.ts

@@ -0,0 +1,265 @@
+import React$1, { FunctionComponent } from 'react';
+import { Essentials, EssentialsOptions } from '@wix/fe-essentials/core';
+import { ReportProps, LogParams } from '@wix/fe-essentials/bi';
+import { errorHandler } from '@wix/essentials';
+import { useTranslation, Trans } from '@wix/fe-essentials/react';
+import { History } from 'history';
+import { QueryCache } from 'react-query/core';
+import { HttpRequestOrHttpRequestFactory, RequestOverrides } from '@wix/fe-essentials/http-client';
+import { SDK } from '@wix/dashboard';
+import { CairoProviderBaseProps } from '@wix/bex-core/react';
+
+interface Environment {
+    readonly language: string;
+    readonly artifactId: string;
+    readonly componentId?: string;
+    readonly componentName?: string;
+    readonly uiLibVersion?: string;
+    readonly providerType?: 'bm' | 'giza' | 'essentials';
+    readonly msid?: string;
+}
+interface EnvironmentBi {
+    readonly artifactId?: string;
+    readonly componentId?: string;
+}
+
+type MonitorLogger = Pick<Essentials['fedopsLogger'], 'interactionStarted' | 'interactionEnded' | 'reportErrorThrownOncePerFlow'>;
+
+interface ErrorMonitor {
+    captureException(exception: unknown): string;
+}
+
+interface OnlineManager {
+    isOnline: () => boolean;
+    subscribe: (listener?: () => unknown) => () => void;
+}
+
+interface Experiments {
+    enabled(key: string): boolean;
+    ready(): Promise<any>;
+    get(key: string): any;
+}
+
+type ToastType = 'STANDARD' | 'PREMIUM' | 'SUCCESS' | 'WARNING' | 'ERROR';
+type ToastTimeout = 'NONE' | 'NORMAL';
+type ToastPriority = 'LOW' | 'NORMAL' | 'HIGH';
+type ToastActionUiType = 'BUTTON' | 'LINK';
+type ToastAction = {
+    text: string;
+    onClick?: Function;
+    removeToastOnClick?: boolean;
+    uiType?: ToastActionUiType;
+    navigationTarget?: {
+        url: string;
+        openInNewTab?: boolean;
+    };
+};
+type ErrorToastDetails = {
+    requestId: string;
+};
+type ToastConfig = {
+    message: string;
+    biName?: string;
+    timeout?: ToastTimeout;
+    priority?: ToastPriority;
+    type?: ToastType;
+    onCloseClick?: () => unknown;
+    onToastSeen?: () => unknown;
+    action?: ToastAction;
+    details?: ErrorToastDetails;
+};
+type RemoveToast = () => void;
+type ShowToast = (toastConfig: ToastConfig) => {
+    remove: RemoveToast;
+};
+
+interface HttpClient {
+    request<T>(req: HttpRequestOrHttpRequestFactory<T>, overrides?: RequestOverrides): Promise<{
+        data: T;
+        status: number;
+        statusText: string;
+        headers: Record<string, string | undefined>;
+    }>;
+}
+
+interface DataCapsule {
+    setItem<T>(key: string, value: T, options?: Record<string, any>): Promise<void>;
+    removeItem(key: string, options?: Record<string, any>): Promise<void>;
+    getItem<T>(key: string): Promise<T>;
+}
+
+type OnSidePanelOpen = (listener: () => void) => {
+    remove(): void;
+};
+type CloseSidePanel = () => unknown;
+interface BiLogger {
+    report(reportProps: ReportProps): Promise<any>;
+}
+interface CairoBILoggerFactory {
+    updateDefaults(params: LogParams): this;
+    logger(): BiLogger;
+}
+type PageLocation = {
+    pageId: string;
+    pathname: string;
+    search?: string;
+    hash?: string;
+};
+type OnNavigationPause = () => {
+    resume(): void;
+};
+type OnNavigationCallback = (pause: OnNavigationPause) => void;
+type OnNavigation = (callback: OnNavigationCallback) => {
+    remove(): void;
+};
+type NavigateToObject = {
+    pageId: string;
+    relativeUrl?: string;
+    appState?: string;
+    referrer?: string;
+    /**
+     * How the target page should be presented. `overlay` opens it as a layer on
+     * top of the current page (e.g. the dashboard overlay). Hosts that don't
+     * support layered navigation ignore this and navigate in place.
+     */
+    displayMode?: 'auto' | 'main' | 'overlay';
+    /** Whether the navigation should push a new history entry or replace the current one. */
+    history?: 'push' | 'replace';
+};
+type NavigateToFunc = (to: NavigateToObject) => void;
+type BeforeUnloadResponse = {
+    remove: () => void;
+};
+type OnBeforeUnload = (callback: (event: Event) => void) => BeforeUnloadResponse;
+/** The layered-navigation state of the current page relative to the host. */
+type LayerState = 'background' | 'foreground';
+/**
+ * Subscribe to layer-state transitions of the current page. Fires `background`
+ * when another layer (e.g. an overlay) is opened on top of the current page and
+ * `foreground` when it returns to the top. Hosts without layered navigation
+ * leave this undefined.
+ */
+type OnLayerStateChange = (callback: (newState: LayerState) => void) => {
+    remove: () => void;
+};
+interface HostContainerExtension {
+    appId?: string;
+    componentId: string;
+    title?: string;
+    menuItem?: {
+        IconComponent?: FunctionComponent;
+        IconSmallComponent?: FunctionComponent;
+        structuredAction: (params?: Record<string, any>) => unknown;
+    };
+    Component?: React.ComponentType;
+    Extension?: React.ComponentType;
+}
+type GetExtensions = () => HostContainerExtension[] | Promise<HostContainerExtension[]>;
+interface HostContainer {
+    getExtensions: GetExtensions;
+}
+type GetHostContainer = (hostContainerId: string) => HostContainer;
+type OpenMediaManager = SDK['openMediaManager'];
+type CreateEssentials = (options: EssentialsOptions) => {
+    i18n: Essentials['i18n'];
+    dataCapsule: Essentials['dataCapsule'];
+    biLoggerFactory?: () => CairoBILoggerFactory;
+    errorMonitor: ErrorMonitor;
+    fedopsLogger?: MonitorLogger;
+    experiments?: Experiments;
+};
+type CreateComponentSettings = (container: {
+    httpClient: HttpClient;
+    queryCache: QueryCache;
+    environment: Environment;
+    createEssentials: CreateEssentials;
+}) => (options: {
+    namespace: string;
+}) => DataCapsule;
+interface PatternsErrorHandler {
+    withErrorHandler: errorHandler.ErrorHandler['withErrorHandler'];
+    getResolvedError?: errorHandler.ErrorHandler['getResolvedError'];
+    showError?: errorHandler.ErrorHandler['showError'];
+    reportRetryAttempt?: errorHandler.ErrorHandler['reportRetryAttempt'];
+}
+interface WixPatternsEssentials {
+    httpClient: HttpClient;
+    /** A `ErrorMonitor` instance `@wix/fe-essentials/error-monitor` */
+    errorMonitor: ErrorMonitor;
+    /** A `Experiments` instance `@wix/fe-essentials/experiments` */
+    experiments: Experiments;
+    errorHandler?: PatternsErrorHandler;
+    biLogger?: BiLogger | null;
+    /**
+     * A function that returns the shape `{ i18n }` - should be compatible with `{createEssentials} from '@wix/fe-essentials'` */
+    createEssentials: CreateEssentials;
+    /** A `DataCapsule` to store component-level settings such as `Views` */
+    createComponentSettings?: CreateComponentSettings;
+    /** The user's environment
+     * - `language` - preferable language for the user
+     * - `artifactId` - App level identifier, usually the artifact ID
+     * - `componentId` - Component/page level identifier (Optional)
+     * - `componentName` - Readable component/page name (Optional)
+     */
+    environment: Pick<Environment, 'language'> & Partial<Omit<Environment, 'language'>> & {
+        uiLibVersion?: string;
+        msid?: string;
+    };
+    environmentBI: EnvironmentBi;
+    /** `useTranslation` hook from `react-i18next` or `@wix/fe-essentials/react` */
+    useTranslation: typeof useTranslation;
+    /** `Trans` component from `react-i18next` or `@wix/fe-essentials/react */
+    Trans: typeof Trans;
+    user: {
+        id?: string;
+        permissions: string[];
+    };
+    /** `useExperiments` hook from `@wix/yoshi-flow-bm` or `@wix/fe-essentials/react` */
+    useExperiments: () => {
+        ready: boolean;
+        experiments: {
+            enabled: (key: string) => boolean;
+        };
+    };
+    usePageLocation?: () => PageLocation | undefined;
+    /** A function that shows a global toast. For BM usage, it should be `showToast` from `business-manager-api` */
+    showToast?: ShowToast;
+    /** A function to perform a navigation to a given pageId */
+    navigateTo?: NavigateToFunc;
+    useAppLoaded?: () => void;
+    onSidePanelOpen?: OnSidePanelOpen;
+    closeSidePanel?: CloseSidePanel;
+    /** Custom [history](https://github.com/remix-run/history/tree/v5.3.0/packages/history) instance to sync custom consumer navigations with Cairo navigations */
+    history?: History;
+    /** An optional query cache instance for controlling the cache from other modules */
+    queryCache?: QueryCache;
+    /** A function that interrupts a navigation to another app inside wix platforms */
+    onNavigation?: OnNavigation;
+    getHostContainer?: GetHostContainer;
+    onlineManager?: OnlineManager;
+    /**
+     * Deals with dirty state by setting up a listener that triggers a confirmation dialog when a user attempts to leave a page. The event listener is removed upon component unmount.
+     * @param callback - called on navigation with an event object. Use event.preventDefault() within the callback to display the dialog.
+     * @returns { remove: () => void } - object that includes a remove method. You can use this method to remove the listener whenever necessary.
+     */
+    onBeforeUnload?: OnBeforeUnload;
+    /**
+     * Subscribe to layer-state transitions of the current page (e.g. to refresh
+     * data when an overlay opened on top of it is closed). Provided by hosts that
+     * support layered navigation; left undefined otherwise.
+     */
+    onLayerStateChange?: OnLayerStateChange;
+    /** Opens the Wix Media Manager. Provided by the Dashboard SDK via context. */
+    openMediaManager?: OpenMediaManager;
+}
+interface WixPatternsEssentialsOverrides extends Omit<Partial<WixPatternsEssentials>, 'environment'> {
+    environment: Partial<WixPatternsEssentials['environment']>;
+}
+
+interface WixPatternsBMProviderProps extends Omit<CairoProviderBaseProps, 'contextType'> {
+    overrides?: Partial<WixPatternsEssentialsOverrides>;
+}
+declare function WixPatternsBMProvider(props: WixPatternsBMProviderProps): React$1.JSX.Element;
+
+export { WixPatternsBMProvider };
+export type { WixPatternsBMProviderProps };

package/dist/dts-bundle/components/WixPatternsBaseProvider.d.ts

@@ -0,0 +1,274 @@
+import React$1, { FunctionComponent, ReactNode } from 'react';
+import { CairoProviderBaseProps } from '@wix/bex-core/react';
+import { Essentials, EssentialsOptions } from '@wix/fe-essentials/core';
+import { ReportProps, LogParams } from '@wix/fe-essentials/bi';
+import { errorHandler } from '@wix/essentials';
+import { useTranslation, Trans } from '@wix/fe-essentials/react';
+import { History } from 'history';
+import { QueryCache } from 'react-query/core';
+import { HttpRequestOrHttpRequestFactory, RequestOverrides } from '@wix/fe-essentials/http-client';
+import { SDK } from '@wix/dashboard';
+
+interface Environment {
+    readonly language: string;
+    readonly artifactId: string;
+    readonly componentId?: string;
+    readonly componentName?: string;
+    readonly uiLibVersion?: string;
+    readonly providerType?: 'bm' | 'giza' | 'essentials';
+    readonly msid?: string;
+}
+interface EnvironmentBi {
+    readonly artifactId?: string;
+    readonly componentId?: string;
+}
+
+type MonitorLogger = Pick<Essentials['fedopsLogger'], 'interactionStarted' | 'interactionEnded' | 'reportErrorThrownOncePerFlow'>;
+
+interface ErrorMonitor {
+    captureException(exception: unknown): string;
+}
+
+interface OnlineManager {
+    isOnline: () => boolean;
+    subscribe: (listener?: () => unknown) => () => void;
+}
+
+interface Experiments {
+    enabled(key: string): boolean;
+    ready(): Promise<any>;
+    get(key: string): any;
+}
+
+type ToastType = 'STANDARD' | 'PREMIUM' | 'SUCCESS' | 'WARNING' | 'ERROR';
+type ToastTimeout = 'NONE' | 'NORMAL';
+type ToastPriority = 'LOW' | 'NORMAL' | 'HIGH';
+type ToastActionUiType = 'BUTTON' | 'LINK';
+type ToastAction = {
+    text: string;
+    onClick?: Function;
+    removeToastOnClick?: boolean;
+    uiType?: ToastActionUiType;
+    navigationTarget?: {
+        url: string;
+        openInNewTab?: boolean;
+    };
+};
+type ErrorToastDetails = {
+    requestId: string;
+};
+type ToastConfig = {
+    message: string;
+    biName?: string;
+    timeout?: ToastTimeout;
+    priority?: ToastPriority;
+    type?: ToastType;
+    onCloseClick?: () => unknown;
+    onToastSeen?: () => unknown;
+    action?: ToastAction;
+    details?: ErrorToastDetails;
+};
+type RemoveToast = () => void;
+type ShowToast = (toastConfig: ToastConfig) => {
+    remove: RemoveToast;
+};
+
+interface HttpClient {
+    request<T>(req: HttpRequestOrHttpRequestFactory<T>, overrides?: RequestOverrides): Promise<{
+        data: T;
+        status: number;
+        statusText: string;
+        headers: Record<string, string | undefined>;
+    }>;
+}
+
+interface DataCapsule {
+    setItem<T>(key: string, value: T, options?: Record<string, any>): Promise<void>;
+    removeItem(key: string, options?: Record<string, any>): Promise<void>;
+    getItem<T>(key: string): Promise<T>;
+}
+
+type OnSidePanelOpen = (listener: () => void) => {
+    remove(): void;
+};
+type CloseSidePanel = () => unknown;
+interface BiLogger {
+    report(reportProps: ReportProps): Promise<any>;
+}
+interface CairoBILoggerFactory {
+    updateDefaults(params: LogParams): this;
+    logger(): BiLogger;
+}
+type PageLocation = {
+    pageId: string;
+    pathname: string;
+    search?: string;
+    hash?: string;
+};
+type OnNavigationPause = () => {
+    resume(): void;
+};
+type OnNavigationCallback = (pause: OnNavigationPause) => void;
+type OnNavigation = (callback: OnNavigationCallback) => {
+    remove(): void;
+};
+type NavigateToObject = {
+    pageId: string;
+    relativeUrl?: string;
+    appState?: string;
+    referrer?: string;
+    /**
+     * How the target page should be presented. `overlay` opens it as a layer on
+     * top of the current page (e.g. the dashboard overlay). Hosts that don't
+     * support layered navigation ignore this and navigate in place.
+     */
+    displayMode?: 'auto' | 'main' | 'overlay';
+    /** Whether the navigation should push a new history entry or replace the current one. */
+    history?: 'push' | 'replace';
+};
+type NavigateToFunc = (to: NavigateToObject) => void;
+type BeforeUnloadResponse = {
+    remove: () => void;
+};
+type OnBeforeUnload = (callback: (event: Event) => void) => BeforeUnloadResponse;
+/** The layered-navigation state of the current page relative to the host. */
+type LayerState = 'background' | 'foreground';
+/**
+ * Subscribe to layer-state transitions of the current page. Fires `background`
+ * when another layer (e.g. an overlay) is opened on top of the current page and
+ * `foreground` when it returns to the top. Hosts without layered navigation
+ * leave this undefined.
+ */
+type OnLayerStateChange = (callback: (newState: LayerState) => void) => {
+    remove: () => void;
+};
+interface HostContainerExtension {
+    appId?: string;
+    componentId: string;
+    title?: string;
+    menuItem?: {
+        IconComponent?: FunctionComponent;
+        IconSmallComponent?: FunctionComponent;
+        structuredAction: (params?: Record<string, any>) => unknown;
+    };
+    Component?: React.ComponentType;
+    Extension?: React.ComponentType;
+}
+type GetExtensions = () => HostContainerExtension[] | Promise<HostContainerExtension[]>;
+interface HostContainer {
+    getExtensions: GetExtensions;
+}
+type GetHostContainer = (hostContainerId: string) => HostContainer;
+type OpenMediaManager = SDK['openMediaManager'];
+type CreateEssentials = (options: EssentialsOptions) => {
+    i18n: Essentials['i18n'];
+    dataCapsule: Essentials['dataCapsule'];
+    biLoggerFactory?: () => CairoBILoggerFactory;
+    errorMonitor: ErrorMonitor;
+    fedopsLogger?: MonitorLogger;
+    experiments?: Experiments;
+};
+type CreateComponentSettings = (container: {
+    httpClient: HttpClient;
+    queryCache: QueryCache;
+    environment: Environment;
+    createEssentials: CreateEssentials;
+}) => (options: {
+    namespace: string;
+}) => DataCapsule;
+interface PatternsErrorHandler {
+    withErrorHandler: errorHandler.ErrorHandler['withErrorHandler'];
+    getResolvedError?: errorHandler.ErrorHandler['getResolvedError'];
+    showError?: errorHandler.ErrorHandler['showError'];
+    reportRetryAttempt?: errorHandler.ErrorHandler['reportRetryAttempt'];
+}
+interface WixPatternsEssentials {
+    httpClient: HttpClient;
+    /** A `ErrorMonitor` instance `@wix/fe-essentials/error-monitor` */
+    errorMonitor: ErrorMonitor;
+    /** A `Experiments` instance `@wix/fe-essentials/experiments` */
+    experiments: Experiments;
+    errorHandler?: PatternsErrorHandler;
+    biLogger?: BiLogger | null;
+    /**
+     * A function that returns the shape `{ i18n }` - should be compatible with `{createEssentials} from '@wix/fe-essentials'` */
+    createEssentials: CreateEssentials;
+    /** A `DataCapsule` to store component-level settings such as `Views` */
+    createComponentSettings?: CreateComponentSettings;
+    /** The user's environment
+     * - `language` - preferable language for the user
+     * - `artifactId` - App level identifier, usually the artifact ID
+     * - `componentId` - Component/page level identifier (Optional)
+     * - `componentName` - Readable component/page name (Optional)
+     */
+    environment: Pick<Environment, 'language'> & Partial<Omit<Environment, 'language'>> & {
+        uiLibVersion?: string;
+        msid?: string;
+    };
+    environmentBI: EnvironmentBi;
+    /** `useTranslation` hook from `react-i18next` or `@wix/fe-essentials/react` */
+    useTranslation: typeof useTranslation;
+    /** `Trans` component from `react-i18next` or `@wix/fe-essentials/react */
+    Trans: typeof Trans;
+    user: {
+        id?: string;
+        permissions: string[];
+    };
+    /** `useExperiments` hook from `@wix/yoshi-flow-bm` or `@wix/fe-essentials/react` */
+    useExperiments: () => {
+        ready: boolean;
+        experiments: {
+            enabled: (key: string) => boolean;
+        };
+    };
+    usePageLocation?: () => PageLocation | undefined;
+    /** A function that shows a global toast. For BM usage, it should be `showToast` from `business-manager-api` */
+    showToast?: ShowToast;
+    /** A function to perform a navigation to a given pageId */
+    navigateTo?: NavigateToFunc;
+    useAppLoaded?: () => void;
+    onSidePanelOpen?: OnSidePanelOpen;
+    closeSidePanel?: CloseSidePanel;
+    /** Custom [history](https://github.com/remix-run/history/tree/v5.3.0/packages/history) instance to sync custom consumer navigations with Cairo navigations */
+    history?: History;
+    /** An optional query cache instance for controlling the cache from other modules */
+    queryCache?: QueryCache;
+    /** A function that interrupts a navigation to another app inside wix platforms */
+    onNavigation?: OnNavigation;
+    getHostContainer?: GetHostContainer;
+    onlineManager?: OnlineManager;
+    /**
+     * Deals with dirty state by setting up a listener that triggers a confirmation dialog when a user attempts to leave a page. The event listener is removed upon component unmount.
+     * @param callback - called on navigation with an event object. Use event.preventDefault() within the callback to display the dialog.
+     * @returns { remove: () => void } - object that includes a remove method. You can use this method to remove the listener whenever necessary.
+     */
+    onBeforeUnload?: OnBeforeUnload;
+    /**
+     * Subscribe to layer-state transitions of the current page (e.g. to refresh
+     * data when an overlay opened on top of it is closed). Provided by hosts that
+     * support layered navigation; left undefined otherwise.
+     */
+    onLayerStateChange?: OnLayerStateChange;
+    /** Opens the Wix Media Manager. Provided by the Dashboard SDK via context. */
+    openMediaManager?: OpenMediaManager;
+}
+
+type WixPatternsMinimalEssentials = Omit<WixPatternsEssentials, 'useExperiments' | 'experiments' | 'Trans' | 'user'> & {
+    useExperiments?: WixPatternsEssentials['useExperiments'];
+    experiments?: WixPatternsEssentials['experiments'];
+    Trans?: WixPatternsEssentials['Trans'];
+    user?: WixPatternsEssentials['user'];
+};
+
+interface WixPatternsBaseProviderProps extends CairoProviderBaseProps {
+    /**
+     * Minimal essentials that are required for wix-patterns to work (i.e i18n,bi,experiments)
+     */
+    value: WixPatternsMinimalEssentials;
+    children?: ReactNode;
+    localCache?: boolean;
+}
+declare function WixPatternsBaseProvider({ value: valueProp, children, ...rest }: WixPatternsBaseProviderProps): React$1.JSX.Element;
+
+export { WixPatternsBaseProvider };
+export type { WixPatternsBaseProviderProps };