@wix/patterns 1.482.0 → 1.484.0

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

@@ -39,6 +39,15 @@ type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
 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 OffsetPaginationModeConfig<T, F extends FiltersMap> = {
+    paginationMode?: 'offset';
+    fetchData: OffsetFetchDataFn<T, F>;
+};
+type CursorPaginationModeConfig<T, F extends FiltersMap> = {
+    paginationMode: 'cursor';
+    fetchTotal?: FetchTotalFn;
+    fetchData: CursorFetchDataFn<T, F>;
+};
 
 /**
  * `Filter` — cut here because it has its own bundle.
@@ -287,16 +296,18 @@ type FiltersConfig<F extends FiltersMap> = F extends OptionalFiltersMap ? {
 } : {
     filters: F;
 };
-type PaginationModeConfig<T, F extends FiltersMap> = {
-    paginationMode?: 'offset';
-    fetchData: OffsetFetchDataFn<T, F>;
-} | {
-    paginationMode: 'cursor';
-    fetchData: CursorFetchDataFn<T, F>;
+type ConfigWithoutPagination<T, F extends FiltersMap> = Omit<CollectionConfig<T, F>, 'itemKey' | 'itemName' | 'filters' | 'paginationMode' | 'fetchData' | 'fetchErrorMessage'> & FiltersConfig<F>;
+type CursorConfig<T, F extends FiltersMap> = ConfigWithoutPagination<T, F> & Omit<CursorPaginationModeConfig<T, F>, 'fetchTotal'>;
+type OffsetConfig<T, F extends FiltersMap> = ConfigWithoutPagination<T, F> & OffsetPaginationModeConfig<T, F>;
+type FilterCollectionConfig<T, F extends FiltersMap> = OffsetConfig<T, F> | CursorConfig<T, F>;
+type FilterCollectionFactory = {
+    <T, F extends FiltersMap = FiltersMap>(filter: Filter<T[]>, config: CursorConfig<T, F>): CollectionState<T, F>;
+    <T, F extends FiltersMap = FiltersMap>(filter: Filter<T[]>, config: OffsetConfig<T, F>): CollectionState<T, F>;
+    <T, F extends FiltersMap = FiltersMap>(filter: Filter<T[]>, config: FilterCollectionConfig<T, F>): CollectionState<T, F>;
 };
-type FilterCollectionConfig<T, F extends FiltersMap> = Omit<CollectionConfig<T, F>, 'itemKey' | 'itemName' | 'filters' | 'paginationMode' | 'fetchData' | 'fetchErrorMessage'> & FiltersConfig<F> & PaginationModeConfig<T, F>;
-type FilterCollectionFactory = <T, F extends FiltersMap = FiltersMap>(filter: Filter<T[]>, config: FilterCollectionConfig<T, F>) => CollectionState<T, F>;
 declare function useCreateFilterCollection(): FilterCollectionFactory;
+declare function useFilterCollection<T, F extends FiltersMap = OptionalFiltersMap>(filter: Filter<T[]>, config: CursorConfig<T, F>): CollectionState<T, F>;
+declare function useFilterCollection<T, F extends FiltersMap = OptionalFiltersMap>(filter: Filter<T[]>, config: OffsetConfig<T, F>): CollectionState<T, F>;
 declare function useFilterCollection<T, F extends FiltersMap = OptionalFiltersMap>(filter: Filter<T[]>, config: FilterCollectionConfig<T, F>): CollectionState<T, F>;
 
 export { useCreateFilterCollection, useFilterCollection };

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

@@ -31,14 +31,22 @@ type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
 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> = {
+type OffsetPaginationModeConfig<T, F extends FiltersMap> = {
     paginationMode?: 'offset';
     fetchData: OffsetFetchDataFn<T, F>;
-} | {
+};
+type CursorPaginationModeConfig<T, F extends FiltersMap> = {
     paginationMode: 'cursor';
     fetchTotal?: FetchTotalFn;
     fetchData: CursorFetchDataFn<T, F>;
 };
+/**
+ * With `strictNullChecks` off, a config typed with this union leaves
+ * `fetchData`'s `query` untyped when `paginationMode` is left out: `undefined`
+ * then matches `'cursor'` as well, so neither branch is picked. Hooks that take
+ * it declare an overload per branch, cursor first, then one for the union.
+ */
+type PaginationModeConfig<T, F extends FiltersMap> = OffsetPaginationModeConfig<T, F> | CursorPaginationModeConfig<T, F>;
 
 /**
  * `Filter` — cut here because it has its own bundle.
@@ -306,6 +314,8 @@ type FiltersConfig<F extends FiltersMap> = F extends OptionalFiltersMap ? {
     filters: F;
 };
 type CollectionConfigConditionals<T, F extends FiltersMap> = FiltersConfig<F> & ItemKeyConfig<T> & ItemNameConfig<T> & PaginationModeConfig<T, F>;
+/** `CollectionConfigWithConditionals` before a pagination branch is added. */
+type CollectionConfigWithoutPagination<T, F extends FiltersMap> = Omit<CollectionConfig<T, F>, 'itemKey' | 'itemName' | 'filters' | 'paginationMode' | 'fetchData'> & FiltersConfig<F> & ItemKeyConfig<T> & ItemNameConfig<T>;
 type CollectionConfigWithConditionals<T, F extends FiltersMap> = Omit<CollectionConfig<T, F>, 'itemKey' | 'itemName' | 'filters' | 'paginationMode' | 'fetchData'> & CollectionConfigConditionals<T, F>;
 
 /**
@@ -316,7 +326,11 @@ declare class GridState<T = any, F = any> {
     [key: string]: unknown;
 }
 
-type GridCollection = <T, F extends FiltersMap = OptionalFiltersMap>(config: CollectionConfigWithConditionals<T, F>) => GridState<T, F>;
+type GridCollection = {
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: CollectionConfigWithoutPagination<T, F> & CursorPaginationModeConfig<T, F>): GridState<T, F>;
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: CollectionConfigWithoutPagination<T, F> & OffsetPaginationModeConfig<T, F>): GridState<T, F>;
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: CollectionConfigWithConditionals<T, F>): GridState<T, F>;
+};
 declare const useGridCollection: GridCollection;
 
 export { useGridCollection };

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

@@ -49,14 +49,22 @@ type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
 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> = {
+type OffsetPaginationModeConfig<T, F extends FiltersMap> = {
     paginationMode?: 'offset';
     fetchData: OffsetFetchDataFn<T, F>;
-} | {
+};
+type CursorPaginationModeConfig<T, F extends FiltersMap> = {
     paginationMode: 'cursor';
     fetchTotal?: FetchTotalFn;
     fetchData: CursorFetchDataFn<T, F>;
 };
+/**
+ * With `strictNullChecks` off, a config typed with this union leaves
+ * `fetchData`'s `query` untyped when `paginationMode` is left out: `undefined`
+ * then matches `'cursor'` as well, so neither branch is picked. Hooks that take
+ * it declare an overload per branch, cursor first, then one for the union.
+ */
+type PaginationModeConfig<T, F extends FiltersMap> = OffsetPaginationModeConfig<T, F> | CursorPaginationModeConfig<T, F>;
 
 interface ItemDisabledResult<R = string> {
     disabled: boolean;

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

@@ -355,14 +355,22 @@ type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
 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> = {
+type OffsetPaginationModeConfig<T, F extends FiltersMap> = {
     paginationMode?: 'offset';
     fetchData: OffsetFetchDataFn<T, F>;
-} | {
+};
+type CursorPaginationModeConfig<T, F extends FiltersMap> = {
     paginationMode: 'cursor';
     fetchTotal?: FetchTotalFn;
     fetchData: CursorFetchDataFn<T, F>;
 };
+/**
+ * With `strictNullChecks` off, a config typed with this union leaves
+ * `fetchData`'s `query` untyped when `paginationMode` is left out: `undefined`
+ * then matches `'cursor'` as well, so neither branch is picked. Hooks that take
+ * it declare an overload per branch, cursor first, then one for the union.
+ */
+type PaginationModeConfig<T, F extends FiltersMap> = OffsetPaginationModeConfig<T, F> | CursorPaginationModeConfig<T, F>;
 
 /**
  * `Filter` — cut here because it has its own bundle.
@@ -685,8 +693,15 @@ interface UsePickerModalParamsOverrides<T, F extends FiltersMap> {
 }
 type UsePickerModalParamsBM<T, F extends FiltersMap> = Omit<UsePickerModalParamsBase<T, F>, 'paginationMode' | 'fetchData' | 'environment' | 'errorMonitor' | 'biLoggerFactory'>;
 type UsePickerModalParams<T, F extends FiltersMap> = UsePickerModalParamsBM<T, F> & UsePickerModalParamsOverrides<T, F> & PaginationModeConfig<T, F>;
-type PikerModalFactory = <T, F extends FiltersMap = OptionalFiltersMap>(config: UsePickerModalParams<T, F>) => PickerModalState<T, F>;
+type ParamsWithoutPagination<T, F extends FiltersMap> = UsePickerModalParamsBM<T, F> & UsePickerModalParamsOverrides<T, F>;
+type PikerModalFactory = {
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: ParamsWithoutPagination<T, F> & CursorPaginationModeConfig<T, F>): PickerModalState<T, F>;
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: ParamsWithoutPagination<T, F> & OffsetPaginationModeConfig<T, F>): PickerModalState<T, F>;
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: UsePickerModalParams<T, F>): PickerModalState<T, F>;
+};
 declare function useCreatePickerModal(): PikerModalFactory;
+declare function usePickerModal<T, F extends FiltersMap = OptionalFiltersMap>(params: ParamsWithoutPagination<T, F> & CursorPaginationModeConfig<T, F>): PickerModalState<T, F>;
+declare function usePickerModal<T, F extends FiltersMap = OptionalFiltersMap>(params: ParamsWithoutPagination<T, F> & OffsetPaginationModeConfig<T, F>): PickerModalState<T, F>;
 declare function usePickerModal<T, F extends FiltersMap = OptionalFiltersMap>(params: UsePickerModalParams<T, F>): PickerModalState<T, F>;
 
 export { useCreatePickerModal, usePickerModal };

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

@@ -39,14 +39,22 @@ type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
 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> = {
+type OffsetPaginationModeConfig<T, F extends FiltersMap> = {
     paginationMode?: 'offset';
     fetchData: OffsetFetchDataFn<T, F>;
-} | {
+};
+type CursorPaginationModeConfig<T, F extends FiltersMap> = {
     paginationMode: 'cursor';
     fetchTotal?: FetchTotalFn;
     fetchData: CursorFetchDataFn<T, F>;
 };
+/**
+ * With `strictNullChecks` off, a config typed with this union leaves
+ * `fetchData`'s `query` untyped when `paginationMode` is left out: `undefined`
+ * then matches `'cursor'` as well, so neither branch is picked. Hooks that take
+ * it declare an overload per branch, cursor first, then one for the union.
+ */
+type PaginationModeConfig<T, F extends FiltersMap> = OffsetPaginationModeConfig<T, F> | CursorPaginationModeConfig<T, F>;
 
 /**
  * `Filter` — cut here because it has its own bundle.
@@ -314,6 +322,8 @@ type FiltersConfig<F extends FiltersMap> = F extends OptionalFiltersMap ? {
     filters: F;
 };
 type CollectionConfigConditionals<T, F extends FiltersMap> = FiltersConfig<F> & ItemKeyConfig<T> & ItemNameConfig<T> & PaginationModeConfig<T, F>;
+/** `CollectionConfigWithConditionals` before a pagination branch is added. */
+type CollectionConfigWithoutPagination<T, F extends FiltersMap> = Omit<CollectionConfig<T, F>, 'itemKey' | 'itemName' | 'filters' | 'paginationMode' | 'fetchData'> & FiltersConfig<F> & ItemKeyConfig<T> & ItemNameConfig<T>;
 type CollectionConfigWithConditionals<T, F extends FiltersMap> = Omit<CollectionConfig<T, F>, 'itemKey' | 'itemName' | 'filters' | 'paginationMode' | 'fetchData'> & CollectionConfigConditionals<T, F>;
 
 /**
@@ -342,7 +352,14 @@ declare class TableState<T = any, F = any> {
 type TableCollectionConfig<T, F extends FiltersMap> = CollectionConfigWithConditionals<T, F> & {
     aiAssistant?: AiAssistant;
 };
-type TableCollection = <T, F extends FiltersMap = OptionalFiltersMap>(config: TableCollectionConfig<T, F>) => TableState<T, F>;
+type TableCollectionBase<T, F extends FiltersMap> = CollectionConfigWithoutPagination<T, F> & {
+    aiAssistant?: AiAssistant;
+};
+type TableCollection = {
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: TableCollectionBase<T, F> & CursorPaginationModeConfig<T, F>): TableState<T, F>;
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: TableCollectionBase<T, F> & OffsetPaginationModeConfig<T, F>): TableState<T, F>;
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: TableCollectionConfig<T, F>): TableState<T, F>;
+};
 declare const useTableCollection: TableCollection;
 
 export { useTableCollection };

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

@@ -31,14 +31,22 @@ type CursorQueryResult<T> = Omit<DataResultRaw<T>, 'cursor'> & {
 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> = {
+type OffsetPaginationModeConfig<T, F extends FiltersMap> = {
     paginationMode?: 'offset';
     fetchData: OffsetFetchDataFn<T, F>;
-} | {
+};
+type CursorPaginationModeConfig<T, F extends FiltersMap> = {
     paginationMode: 'cursor';
     fetchTotal?: FetchTotalFn;
     fetchData: CursorFetchDataFn<T, F>;
 };
+/**
+ * With `strictNullChecks` off, a config typed with this union leaves
+ * `fetchData`'s `query` untyped when `paginationMode` is left out: `undefined`
+ * then matches `'cursor'` as well, so neither branch is picked. Hooks that take
+ * it declare an overload per branch, cursor first, then one for the union.
+ */
+type PaginationModeConfig<T, F extends FiltersMap> = OffsetPaginationModeConfig<T, F> | CursorPaginationModeConfig<T, F>;
 
 /**
  * `Filter` — cut here because it has its own bundle.
@@ -306,17 +314,23 @@ type FiltersConfig<F extends FiltersMap> = F extends OptionalFiltersMap ? {
     filters: F;
 };
 type CollectionConfigConditionals<T, F extends FiltersMap> = FiltersConfig<F> & ItemKeyConfig<T> & ItemNameConfig<T> & PaginationModeConfig<T, F>;
+/** `CollectionConfigWithConditionals` before a pagination branch is added. */
+type CollectionConfigWithoutPagination<T, F extends FiltersMap> = Omit<CollectionConfig<T, F>, 'itemKey' | 'itemName' | 'filters' | 'paginationMode' | 'fetchData'> & FiltersConfig<F> & ItemKeyConfig<T> & ItemNameConfig<T>;
 type CollectionConfigWithConditionals<T, F extends FiltersMap> = Omit<CollectionConfig<T, F>, 'itemKey' | 'itemName' | 'filters' | 'paginationMode' | 'fetchData'> & CollectionConfigConditionals<T, F>;
 
 /**
  * `TableGridSwitchState` — you receive this, you don't construct it.
- * Produced by `useTableGridSwitchCollection()`. Its own API is in `types/TableGridSwitchState.d.ts`.
+ * An internal state object — reached through another state object, never built directly. Its own API is in `types/TableGridSwitchState.d.ts`.
  */
 declare class TableGridSwitchState<T = any, F = any> {
     [key: string]: unknown;
 }
 
-type TableGridSwitchType = <T, F extends FiltersMap = OptionalFiltersMap>(config: CollectionConfigWithConditionals<T, F>) => TableGridSwitchState<T, F>;
+type TableGridSwitchType = {
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: CollectionConfigWithoutPagination<T, F> & CursorPaginationModeConfig<T, F>): TableGridSwitchState<T, F>;
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: CollectionConfigWithoutPagination<T, F> & OffsetPaginationModeConfig<T, F>): TableGridSwitchState<T, F>;
+    <T, F extends FiltersMap = OptionalFiltersMap>(config: CollectionConfigWithConditionals<T, F>): TableGridSwitchState<T, F>;
+};
 declare const useTableGridSwitchCollection: TableGridSwitchType;
 
 export { TableGridSwitchState, useTableGridSwitchCollection };