@wix/patterns 1.461.0 → 1.463.0

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

@@ -1,4 +1,4 @@
-import React$1, { FunctionComponent, ReactNode } from 'react';
+import react, { FunctionComponent, ReactNode } from 'react';
 import { Essentials, EssentialsOptions } from '@wix/fe-essentials/core';
 import { ReportProps, LogParams } from '@wix/fe-essentials/bi';
 import { errorHandler } from '@wix/essentials';
@@ -7,7 +7,6 @@ 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;
@@ -73,6 +72,8 @@ type ShowToast = (toastConfig: ToastConfig) => {
     remove: RemoveToast;
 };
 
+type PatternsLayoutType = 'panel' | 'page';
+
 interface HttpClient {
     request<T>(req: HttpRequestOrHttpRequestFactory<T>, overrides?: RequestOverrides): Promise<{
         data: T;
@@ -255,12 +256,21 @@ interface WixPatternsEssentials {
 interface WixPatternsEssentialsOverrides extends Omit<Partial<WixPatternsEssentials>, 'environment'> {
     environment: Partial<WixPatternsEssentials['environment']>;
 }
+type ContextType = 'ACCOUNT' | 'SITE';
+
+interface CairoProviderBaseProps {
+    children?: ReactNode;
+    localCache?: boolean;
+    contextType?: ContextType;
+    layoutType?: PatternsLayoutType;
+    useRelativeSidePanel?: boolean;
+}
 
 interface WixPatternsGizaProviderProps extends CairoProviderBaseProps {
     children?: ReactNode;
     value?: Partial<WixPatternsEssentialsOverrides>;
 }
-declare function WixPatternsGizaProvider(props: WixPatternsGizaProviderProps): React$1.JSX.Element;
+declare function WixPatternsGizaProvider(props: WixPatternsGizaProviderProps): react.JSX.Element;
 
 export { WixPatternsGizaProvider };
 export type { WixPatternsGizaProviderProps };

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

@@ -1,9 +1,20 @@
-import React from 'react';
-import { CairoProviderBaseProps } from '@wix/bex-core/react';
+import react, { ReactNode } from 'react';
+
+type PatternsLayoutType = 'panel' | 'page';
+
+type ContextType = 'ACCOUNT' | 'SITE';
+
+interface CairoProviderBaseProps {
+    children?: ReactNode;
+    localCache?: boolean;
+    contextType?: ContextType;
+    layoutType?: PatternsLayoutType;
+    useRelativeSidePanel?: boolean;
+}
 
 interface WixPatternsProviderProps extends Omit<CairoProviderBaseProps, 'localCache' | 'contextType'> {
 }
 
-declare function WixPatternsProvider(props: WixPatternsProviderProps): React.JSX.Element;
+declare function WixPatternsProvider(props: WixPatternsProviderProps): react.JSX.Element;
 
 export { WixPatternsProvider };

package/dist/dts-bundle/exports/core.d.ts

@@ -1,7 +1,9 @@
 export { CollectionOptimisticActions } from '../components/CollectionOptimisticActions';
 export type { ComputedQuery } from '../types/ComputedQuery';
 export type { CursorQuery } from '../types/CursorQuery';
+export type { DataResultRaw } from '../types/DataResultRaw';
 export type { Filter } from '../types/Filter';
+export type { OffsetQuery } from '../types/OffsetQuery';
 export type { OnSaveParams } from '../types/OnSaveParams';
 export type { RangeItem } from '../types/RangeItem';
 export { arrayFilter } from '../functions/arrayFilter';

package/dist/dts-bundle/exports/index.d.ts

@@ -30,6 +30,7 @@ export type { MultiLevelSorting } from '../types/MultiLevelSorting';
 export { MultiSelectCheckboxFilter } from '../components/MultiSelectCheckboxFilter';
 export { MultiSelectCollectionFilter } from '../components/MultiSelectCollectionFilter';
 export { NumberRangeFilter } from '../components/NumberRangeFilter';
+export type { OffsetQuery } from '../types/OffsetQuery';
 export { OperatorFilterPicker } from '../components/OperatorFilterPicker';
 export { PickerModal } from '../components/PickerModal';
 export { PrimaryActionButton } from '../components/PrimaryActionButton';
@@ -62,7 +63,9 @@ export { operatorFilter } from '../functions/operatorFilter';
 export { stringFilter } from '../functions/stringFilter';
 export { stringsArrayFilter } from '../functions/stringsArrayFilter';
 export { useCreateCollection } from '../hooks/useCreateCollection';
+export { useEntity } from '../hooks/useEntity';
 export { useEntityPage } from '../hooks/useEntityPage';
+export { useEntityPageContext } from '../hooks/useEntityPageContext';
 export { useExportConfig } from '../hooks/useExportConfig';
 export { useFilterCollection } from '../hooks/useFilterCollection';
 export { useGridCollection } from '../hooks/useGridCollection';
@@ -73,3 +76,4 @@ export { useStaticListFilterCollection } from '../hooks/useStaticListFilterColle
 export { useTableCollection } from '../hooks/useTableCollection';
 export { useTableFolders } from '../hooks/useTableFolders';
 export { useTableGridSwitchCollection } from '../hooks/useTableGridSwitchCollection';
+export { withDashboard } from '../functions/withDashboard';

package/dist/dts-bundle/functions/withDashboard.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+
+type PageLocation = {
+    pageId: string;
+    pathname: string;
+    search?: string;
+    hash?: string;
+};
+interface PageProps {
+    location: PageLocation;
+}
+
+declare const withDashboard: (PageComponent: React.ComponentType<PageProps>) => (props: PageProps) => React.JSX.Element;
+
+export { withDashboard };

package/dist/dts-bundle/hooks/useCreateCollection.d.ts

@@ -26,7 +26,11 @@ declare class CollectionState<T = any, F = any> {
     [key: string]: unknown;
 }
 
-type OffsetQuery<F extends FiltersMap = OptionalFiltersMap> = Omit<ComputedQuery<F>, 'cursor'>;
+/**
+ * `OffsetQuery` — cut here because it has its own bundle.
+ * Look `OffsetQuery` up in the bundle index for its full shape.
+ */
+type OffsetQuery<F = any> = Omit<ComputedQuery<F>, 'cursor'>;
 type OffsetQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'>;
 type OffsetFetchDataFn<T, F extends FiltersMap> = (query: OffsetQuery<F>) => Promise<OffsetQueryResult<T>>;
 type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
@@ -36,7 +40,7 @@ type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
  * `CursorQuery` — cut here because it has its own bundle.
  * Look `CursorQuery` up in the bundle index for its full shape.
  */
-type CursorQuery<F = any> = Record<string, unknown>;
+type CursorQuery<F = any> = Omit<ComputedQuery<F>, 'offset'>;
 type CursorFetchDataFn<T, F extends FiltersMap> = (query: CursorQuery<F>) => Promise<CursorQueryResult<T>>;
 type FetchTotalFn = (query: CursorQuery) => Promise<number>;
 type PaginationModeConfig<T, F extends FiltersMap> = {
@@ -70,34 +74,12 @@ interface ComputedQuery<F = any> {
     [key: string]: unknown;
 }
 
-interface DataResultRaw<T> {
-    /**
-     * Array of items returned from the server.
-     * @external
-     */
-    items: T[];
-    /**
-     * Total items available in the server, *after* applying filters. If not provided, offset pagination will not work correctly.
-     * If you are using a cursor and did not include `total` in your query request, you can use the `fetchTotal` function to extract it asynchronously.
-     * @default `items.length`
-     * @external
-     */
-    total?: number | null;
-    /**
-     * Total items available in the server, *before* applying filters.
-     * @external
-     */
-    available?: number;
-    /**
-     * In case of cursor pagination, this will be the value that will be sent in the query on the next page request.
-     * @external
-     */
-    cursor?: string | undefined | null;
-    /**
-     * Indicates whether there are more items available after the current page.
-     * @external
-     */
-    hasNext?: boolean | null;
+/**
+ * `DataResultRaw` — cut here because it has its own bundle.
+ * Look `DataResultRaw` up in the bundle index for its full shape.
+ */
+interface DataResultRaw<T = any> {
+    [key: string]: unknown;
 }
 
 interface ComputedResult {

package/dist/dts-bundle/hooks/useEntity.d.ts

@@ -0,0 +1,13 @@
+import { FieldValues } from 'react-hook-form';
+
+/**
+ * `EntityPageState` — you receive this, you don't construct it.
+ * Produced by `useEntityPage()` (also `useEntityPageContext()`).
+ */
+declare class EntityPageState<T = any, V = any> {
+    [key: string]: unknown;
+}
+
+declare function useEntity<T, V extends FieldValues = FieldValues>(state: EntityPageState<T, V>): T | null;
+
+export { useEntity };