@wix/patterns 1.457.0 → 1.459.0

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

@@ -0,0 +1,62 @@
+import { ExportQueryV2, MethodMetadata, ArrayFieldDelimiter, QueryFieldNumber, MethodSpec, CreateExportAsyncJobRequest } from '@wix/bex-utils/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/types';
+
+interface ExportPublicState<T, F extends FiltersMap> {
+    platformizedQuery: ExportQueryV2;
+    wixPatternsQuery: ComputedQueryFull<F>;
+    selectedItems?: string[];
+    isSelectAll: boolean;
+    uncheckedValues?: T[];
+}
+type CustomTotalFn<T, F extends FiltersMap> = (params: ExportPublicState<T, F> & {
+    collectionTotalPromise: number | null | Promise<number | null | undefined>;
+}) => number | null | undefined | Promise<number | null | undefined>;
+type TransformQuery<T, F extends FiltersMap> = (params: ExportPublicState<T, F>) => ExportQueryV2 | Promise<ExportQueryV2>;
+type SaveAsFn<T, F extends FiltersMap> = (params: ExportPublicState<T, F>) => string;
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T = any> {
+    [key: string]: unknown;
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+type OptionalFiltersMap = {
+    [key: string]: undefined;
+};
+
+type FiltersKey<F extends FiltersMap> = Partial<{
+    [P in keyof F]: string[] | undefined | null;
+}>;
+/**
+ * `ComputedQuery` — cut here because it has its own bundle.
+ * Look `ComputedQuery` up in the bundle index for its full shape.
+ */
+interface ComputedQuery<F = any> {
+    [key: string]: unknown;
+}
+interface ComputedQueryFull<F extends FiltersMap = OptionalFiltersMap> extends ComputedQuery<F> {
+    filtersKey: FiltersKey<F>;
+    nonPersistentFiltersKey: FiltersKey<F>;
+}
+
+interface UseExportConfigParams<T, F extends FiltersMap> {
+    transformPlatformizedQuery?: TransformQuery<T, F>;
+    differentQueryEndpointThanCollection?: boolean;
+    customTotal?: CustomTotalFn<T, F>;
+    methodMetadata: MethodMetadata;
+    arrayFieldDelimiter?: keyof typeof ArrayFieldDelimiter;
+    methodSpec?: {
+        requestQueryFieldNumber?: keyof typeof QueryFieldNumber;
+        responsePagingMetadataFieldName?: MethodSpec['responsePagingMetadataFieldName'];
+        responseRepeatedFieldName?: MethodSpec['responseRepeatedFieldName'];
+    };
+    fields: CreateExportAsyncJobRequest['fields'];
+    saveAs?: SaveAsFn<T, F>;
+}
+declare function useExportConfig<T, F extends FiltersMap>(params: UseExportConfigParams<T, F>): UseExportConfigParams<T, F>;
+
+export { useExportConfig };
+export type { UseExportConfigParams };

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

@@ -0,0 +1,43 @@
+import { CollectionConfig, OffsetFetchDataFn, CursorFetchDataFn } from '@wix/bex-core/react';
+
+/**
+ * `CollectionState` — you receive this, you don't construct it.
+ * Produced by `useFilterCollection()` (also `useStaticListFilterCollection()`, `useCollection()`, `createCollection()`).
+ */
+declare class CollectionState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T = any> {
+    [key: string]: unknown;
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+type OptionalFiltersMap = {
+    [key: string]: undefined;
+};
+
+type FiltersConfig<F extends FiltersMap> = F extends OptionalFiltersMap ? {
+    filters?: {};
+} : {
+    filters: F;
+};
+type PaginationModeConfig<T, F extends FiltersMap> = {
+    paginationMode?: 'offset';
+    fetchData: OffsetFetchDataFn<T, F>;
+} | {
+    paginationMode: 'cursor';
+    fetchData: CursorFetchDataFn<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: FilterCollectionConfig<T, F>): CollectionState<T, F>;
+
+export { useCreateFilterCollection, useFilterCollection };
+export type { FilterCollectionConfig, FilterCollectionFactory };

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

@@ -0,0 +1,34 @@
+import { FieldValues, UseFormProps, UseFormReturn } from './types';
+
+/**
+ * Custom hook to manage the entire form.
+ *
+ * @remarks
+ * [API](https://react-hook-form.com/docs/useform) • [Demo](https://codesandbox.io/s/react-hook-form-get-started-ts-5ksmm) • [Video](https://www.youtube.com/watch?v=RkXv4AXXC_4)
+ *
+ * @param props - form configuration and validation parameters.
+ *
+ * @returns methods - individual functions to manage the form state. {@link UseFormReturn}
+ *
+ * @example
+ * ```tsx
+ * function App() {
+ *   const { register, handleSubmit, watch, formState: { errors } } = useForm();
+ *   const onSubmit = data => console.log(data);
+ *
+ *   console.log(watch("example"));
+ *
+ *   return (
+ *     <form onSubmit={handleSubmit(onSubmit)}>
+ *       <input defaultValue="test" {...register("example")} />
+ *       <input {...register("exampleRequired", { required: true })} />
+ *       {errors.exampleRequired && <span>This field is required</span>}
+ *       <button>Submit</button>
+ *     </form>
+ *   );
+ * }
+ * ```
+ */
+declare function useForm<TFieldValues extends FieldValues = FieldValues, TContext = any, TTransformedValues = TFieldValues>(props?: UseFormProps<TFieldValues, TContext, TTransformedValues>): UseFormReturn<TFieldValues, TContext, TTransformedValues>;
+
+export { useForm };

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

@@ -0,0 +1,29 @@
+import { CollectionConfigWithConditionals } from '@wix/bex-core/react';
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T = any> {
+    [key: string]: unknown;
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+type OptionalFiltersMap = {
+    [key: string]: undefined;
+};
+
+/**
+ * `GridState` — you receive this, you don't construct it.
+ * Produced by `useGridCollection()` (also `useAmbassadorGrid()`, `useVirtualGridStateContext()`). Look `GridState` up in the bundle index for its own API.
+ */
+declare class GridState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+type GridCollection = <T, F extends FiltersMap = OptionalFiltersMap>(config: CollectionConfigWithConditionals<T, F>) => GridState<T, F>;
+declare const useGridCollection: GridCollection;
+
+export { useGridCollection };
+export type { GridCollection };

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

@@ -0,0 +1,42 @@
+/**
+ * `CollectionState` — you receive this, you don't construct it.
+ * Produced by `useFilterCollection()` (also `useStaticListFilterCollection()`, `useCollection()`, `createCollection()`).
+ */
+declare class CollectionState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T = any> {
+    [key: string]: unknown;
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+
+interface CollectionFoldersBaseConfig<T1, F1 extends FiltersMap, T2, F2 extends FiltersMap> {
+    /** A [collection state](./?path=/story/common-hooks--usecollection) that fetches items */
+    items: CollectionState<T1, F1>;
+    /** A [collection state](./?path=/story/common-hooks--usecollection) that fetches folders */
+    folders: CollectionState<T2, F2>;
+}
+
+/**
+ * `GridFoldersState` — you receive this, you don't construct it.
+ * Produced by `useGridFolders()`. Look `GridFoldersState` up in the bundle index for its own API.
+ */
+declare class GridFoldersState<T1 = any, F1 = any, T2 = any, F2 = any> {
+    [key: string]: unknown;
+}
+
+interface GridFoldersConfig<T1, F1 extends FiltersMap, T2, F2 extends FiltersMap> extends CollectionFoldersBaseConfig<T1, F1, T2, F2> {
+}
+type GridFoldersFactory = <T1, F1 extends FiltersMap, T2, F2 extends FiltersMap>(config: GridFoldersConfig<T1, F1, T2, F2>) => GridFoldersState<T1, F1, T2, F2>;
+declare function useCreateGridFolders(): GridFoldersFactory;
+declare function useGridFolders<T1, F1 extends FiltersMap, T2, F2 extends FiltersMap>(config: GridFoldersConfig<T1, F1, T2, F2>): GridFoldersState<T1, F1, T2, F2>;
+
+export { useCreateGridFolders, useGridFolders };
+export type { GridFoldersConfig, GridFoldersFactory };

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

@@ -0,0 +1,103 @@
+import { IterateeShorthand } from 'lodash';
+
+/**
+ * `Filter` — cut here because it has its own bundle.
+ * Look `Filter` up in the bundle index for its full shape.
+ */
+interface Filter<T = any> {
+    [key: string]: unknown;
+}
+type FiltersMap = {
+    [key: string]: Filter<any> | undefined;
+};
+
+/**
+ * `ComputedQuery` — cut here because it has its own bundle.
+ * Look `ComputedQuery` up in the bundle index for its full shape.
+ */
+interface ComputedQuery<F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `QueryState` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class QueryState<F = any> {
+    [key: string]: unknown;
+}
+
+type Iterator<T> = (value: T, index: number) => unknown;
+interface Order<T> {
+    fieldName: Iterator<T> | IterateeShorthand<T>;
+    order: 'asc' | 'desc';
+}
+
+/**
+ * `CollectionOptimisticSequenceExecutor` — you receive this, you don't construct it.
+ * An internal state object — reached through another state object, never built directly.
+ */
+declare class CollectionOptimisticSequenceExecutor {
+    [key: string]: unknown;
+}
+
+interface CollectionOptimisticActionsBaseParams<T, F extends FiltersMap> {
+    /**
+     * A function that simulates the filtering in the server.
+     * The function should return another function that accepts an item, and return a boolean that indicates whether the item passes the query filters or not.
+     * @param computedQuery - The computed query object.
+     * @external
+     */
+    readonly predicate?: (computedQuery: ComputedQuery<F>) => (item: T) => boolean;
+    /**
+     * A function that simulates the ordering of the items in the server.<br>
+     * The function should return a list of rules in the form of `{fieldName: string; order: 'asc' | 'desc';}` to order the items by
+     * @param computedQuery - The computed query object.
+     * @external
+     */
+    readonly orderBy?: (computedQuery: ComputedQuery<F>) => Order<T>[];
+    /**
+     * A function to retrieve the creation date of an item.
+     * @param item - The item.
+     * @external
+     */
+    readonly createdAt?: (item: T) => Date;
+    /**
+     * Time to wait before batching multiple `updateMany` calls into a single server call.
+     * @default 0
+     * @external
+     */
+    readonly batchWait?: number;
+    /**
+     * Indicates whether to refresh the current page without invalidating the cache.
+     * @external
+     */
+    readonly noInvalidate?: boolean;
+    /**
+     * Adds a namespace to the cache key.
+     * @external
+     */
+    readonly cacheNamespace?: string;
+    readonly sequences?: Map<string, CollectionOptimisticSequenceExecutor>;
+    readonly query?: QueryState<F>;
+}
+/**
+ * `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 = any, F = any> {
+    [key: string]: unknown;
+}
+
+/**
+ * `CollectionState` — you receive this, you don't construct it.
+ * Produced by `useFilterCollection()` (also `useStaticListFilterCollection()`, `useCollection()`, `createCollection()`).
+ */
+declare class CollectionState<T = any, F = any> {
+    [key: string]: unknown;
+}
+
+declare function useCreateOptimisticActions(): <T, F extends FiltersMap>(collection: CollectionState<T, F>, params?: Partial<CollectionOptimisticActionsBaseParams<T, F>>) => CollectionOptimisticActions<T, F>;
+declare function useOptimisticActions<T, F extends FiltersMap>(collection: CollectionState<T, F>, params?: Partial<CollectionOptimisticActionsBaseParams<T, F>>): CollectionOptimisticActions<T, F>;
+
+export { useCreateOptimisticActions, useOptimisticActions };

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

@@ -0,0 +1,21 @@
+/**
+ * `WixPatternsRouterState` — you receive this, you don't construct it.
+ * Produced by `useWixPatternsRouter()`.
+ */
+declare class WixPatternsRouterState {
+    [key: string]: unknown;
+}
+
+declare const useWixPatternsRouter: () => WixPatternsRouterState | null;
+
+declare const usePatternsNavigate: <T>() => {
+    navigateToEntityPage: ({ path, entity }: {
+        path: string;
+        entity: T;
+    }) => void;
+    navigateToCollectionPage: ({ path }: {
+        path: string;
+    }) => void;
+};
+
+export { usePatternsNavigate, useWixPatternsRouter };