@wix/patterns 1.456.0 → 1.458.0

package/dist/dts-bundle/types/ControllerProps.d.ts

@@ -0,0 +1,62 @@
+import React from 'react';
+import { RegisterOptions } from './validator';
+import { FieldError, FieldValues, FieldPath, Noop, FieldPathValue, RefCallBack, UseFormStateReturn, Control } from './';
+
+type ControllerFieldState = {
+    invalid: boolean;
+    isTouched: boolean;
+    isDirty: boolean;
+    isValidating: boolean;
+    error?: FieldError;
+};
+type ControllerRenderProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
+    onChange: (...event: any[]) => void;
+    onBlur: Noop;
+    value: FieldPathValue<TFieldValues, TName>;
+    disabled?: boolean;
+    name: TName;
+    ref: RefCallBack;
+};
+type UseControllerProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>, TTransformedValues = TFieldValues> = {
+    name: TName;
+    rules?: Omit<RegisterOptions<TFieldValues, TName>, 'valueAsNumber' | 'valueAsDate' | 'setValueAs' | 'disabled'>;
+    shouldUnregister?: boolean;
+    defaultValue?: FieldPathValue<TFieldValues, TName>;
+    control?: Control<TFieldValues, any, TTransformedValues>;
+    disabled?: boolean;
+};
+type UseControllerReturn<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = {
+    field: ControllerRenderProps<TFieldValues, TName>;
+    formState: UseFormStateReturn<TFieldValues>;
+    fieldState: ControllerFieldState;
+};
+/**
+ * Render function to provide the control for the field.
+ *
+ * @returns all the event handlers, and relevant field and form state.
+ *
+ * @example
+ * ```tsx
+ * const { field, fieldState, formState } = useController();
+ *
+ * <Controller
+ *   render={({ field, formState, fieldState }) => ({
+ *     <input
+ *       onChange={field.onChange}
+ *       onBlur={field.onBlur}
+ *       name={field.name}
+ *       ref={field.ref} // optional for focus management
+ *     />
+ *   })}
+ * />
+ * ```
+ */
+type ControllerProps<TFieldValues extends FieldValues = FieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>, TTransformedValues = TFieldValues> = {
+    render: ({ field, fieldState, formState, }: {
+        field: ControllerRenderProps<TFieldValues, TName>;
+        fieldState: ControllerFieldState;
+        formState: UseFormStateReturn<TFieldValues>;
+    }) => React.ReactElement;
+} & UseControllerProps<TFieldValues, TName, TTransformedValues>;
+
+export type { ControllerFieldState, ControllerProps, ControllerRenderProps, UseControllerProps, UseControllerReturn };

package/dist/dts-bundle/types/CursorQuery.d.ts

@@ -0,0 +1,69 @@
+/**
+ * `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;
+};
+type OptionalFiltersMap = {
+    [key: string]: undefined;
+};
+
+/**
+ * `ComputedQuery` — cut here because it has its own bundle.
+ * Look `ComputedQuery` up in the bundle index for its full shape.
+ */
+interface ComputedQuery<F> {
+}
+
+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;
+}
+
+type OffsetQuery<F extends FiltersMap = OptionalFiltersMap> = 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'> & {
+    cursor: string | undefined | null;
+};
+type CursorQuery<F extends FiltersMap = OptionalFiltersMap> = 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> = {
+    paginationMode?: 'offset';
+    fetchData: OffsetFetchDataFn<T, F>;
+} | {
+    paginationMode: 'cursor';
+    fetchTotal?: FetchTotalFn;
+    fetchData: CursorFetchDataFn<T, F>;
+};
+
+export type { CursorFetchDataFn, CursorQuery, CursorQueryResult, FetchTotalFn, OffsetFetchDataFn, OffsetQuery, OffsetQueryResult, PaginationModeConfig };