payload 1.3.1 → 1.3.3

package/dist/admin/components/views/collections/List/index.js

@@ -1,119 +1,119 @@
-import React, { useEffect, useState, useCallback } from 'react';
-import { useHistory } from 'react-router-dom';
-import queryString from 'qs';
-import { useTranslation } from 'react-i18next';
-import { useConfig } from '../../../utilities/Config';
-import { useAuth } from '../../../utilities/Auth';
-import usePayloadAPI from '../../../../hooks/usePayloadAPI';
-import DefaultList from './Default';
-import RenderCustomComponent from '../../../utilities/RenderCustomComponent';
-import { useStepNav } from '../../../elements/StepNav';
-import formatFields from './formatFields';
-import buildColumns from './buildColumns';
-import { usePreferences } from '../../../utilities/Preferences';
-import { useSearchParams } from '../../../utilities/SearchParams';
-import getInitialColumns from './getInitialColumns';
-const ListView = (props) => {
-    var _a, _b;
-    const { collection, collection: { slug, labels: { plural, }, admin: { useAsTitle, defaultColumns, pagination: { defaultLimit, }, components: { views: { List: CustomList, } = {}, } = {}, }, }, } = props;
-    const { serverURL, routes: { api, admin } } = useConfig();
-    const preferenceKey = `${collection.slug}-list`;
-    const { permissions } = useAuth();
-    const { setStepNav } = useStepNav();
-    const { getPreference, setPreference } = usePreferences();
-    const { page, sort, limit, where } = useSearchParams();
-    const history = useHistory();
-    const { t } = useTranslation('general');
-    const [fetchURL, setFetchURL] = useState('');
-    const [fields] = useState(() => formatFields(collection, t));
-    const [tableColumns, setTableColumns] = useState(() => {
-        const initialColumns = getInitialColumns(fields, useAsTitle, defaultColumns);
-        return buildColumns(collection, initialColumns, t);
-    });
-    const collectionPermissions = (_a = permissions === null || permissions === void 0 ? void 0 : permissions.collections) === null || _a === void 0 ? void 0 : _a[slug];
-    const hasCreatePermission = (_b = collectionPermissions === null || collectionPermissions === void 0 ? void 0 : collectionPermissions.create) === null || _b === void 0 ? void 0 : _b.permission;
-    const newDocumentURL = `${admin}/collections/${slug}/create`;
-    const [{ data }, { setParams: setFetchParams }] = usePayloadAPI(fetchURL, { initialParams: { page: 1 } });
-    const activeColumnNames = tableColumns.map(({ accessor }) => accessor);
-    const stringifiedActiveColumns = JSON.stringify(activeColumnNames);
-    useEffect(() => {
-        setStepNav([
-            {
-                label: plural,
-            },
-        ]);
-    }, [setStepNav, plural]);
-    // /////////////////////////////////////
-    // Set up Payload REST API query params
-    // /////////////////////////////////////
-    useEffect(() => {
-        const params = {
-            depth: 0,
-            draft: 'true',
-            page: undefined,
-            sort: undefined,
-            where: undefined,
-            limit,
-        };
-        if (page)
-            params.page = page;
-        if (sort)
-            params.sort = sort;
-        if (where)
-            params.where = where;
-        // Performance enhancement
-        // Setting the Fetch URL this way
-        // prevents a double-fetch
-        setFetchURL(`${serverURL}${api}/${slug}`);
-        setFetchParams(params);
-    }, [setFetchParams, page, sort, where, collection, getPreference, limit, serverURL, api, slug]);
-    // /////////////////////////////////////
-    // Fetch preferences on first load
-    // /////////////////////////////////////
-    useEffect(() => {
-        (async () => {
-            const currentPreferences = await getPreference(preferenceKey);
-            if (currentPreferences === null || currentPreferences === void 0 ? void 0 : currentPreferences.columns) {
-                setTableColumns(buildColumns(collection, currentPreferences === null || currentPreferences === void 0 ? void 0 : currentPreferences.columns, t));
-            }
-            const params = queryString.parse(history.location.search, { ignoreQueryPrefix: true, depth: 0 });
-            const search = {
-                ...params,
-                sort: (params === null || params === void 0 ? void 0 : params.sort) || (currentPreferences === null || currentPreferences === void 0 ? void 0 : currentPreferences.sort),
-                limit: (params === null || params === void 0 ? void 0 : params.limit) || (currentPreferences === null || currentPreferences === void 0 ? void 0 : currentPreferences.limit),
-            };
-            const newSearchQuery = queryString.stringify(search, { addQueryPrefix: true });
-            if (newSearchQuery.length > 1) {
-                history.replace({
-                    search: newSearchQuery,
-                });
-            }
-        })();
-    }, [collection, getPreference, preferenceKey, history, t]);
-    // /////////////////////////////////////
-    // When any preference-enabled values are updated,
-    // Set preferences
-    // /////////////////////////////////////
-    useEffect(() => {
-        const newPreferences = {
-            limit,
-            sort,
-            columns: JSON.parse(stringifiedActiveColumns),
-        };
-        setPreference(preferenceKey, newPreferences);
-    }, [sort, limit, stringifiedActiveColumns, preferenceKey, setPreference]);
-    const setActiveColumns = useCallback((columns) => {
-        setTableColumns(buildColumns(collection, columns, t));
-    }, [collection, t]);
-    return (React.createElement(RenderCustomComponent, { DefaultComponent: DefaultList, CustomComponent: CustomList, componentProps: {
-            collection: { ...collection, fields },
-            newDocumentURL,
-            hasCreatePermission,
-            data,
-            tableColumns,
-            columnNames: activeColumnNames,
-            setColumns: setActiveColumns,
-            limit: limit || defaultLimit,
-        } }));
-};
-export default ListView;
+import React, { useEffect, useState, useCallback } from 'react';
+import { useHistory } from 'react-router-dom';
+import queryString from 'qs';
+import { useTranslation } from 'react-i18next';
+import { useConfig } from '../../../utilities/Config';
+import { useAuth } from '../../../utilities/Auth';
+import usePayloadAPI from '../../../../hooks/usePayloadAPI';
+import DefaultList from './Default';
+import RenderCustomComponent from '../../../utilities/RenderCustomComponent';
+import { useStepNav } from '../../../elements/StepNav';
+import formatFields from './formatFields';
+import buildColumns from './buildColumns';
+import { usePreferences } from '../../../utilities/Preferences';
+import { useSearchParams } from '../../../utilities/SearchParams';
+import getInitialColumns from './getInitialColumns';
+const ListView = (props) => {
+    var _a, _b;
+    const { collection, collection: { slug, labels: { plural, }, admin: { useAsTitle, defaultColumns, pagination: { defaultLimit, }, components: { views: { List: CustomList, } = {}, } = {}, }, }, } = props;
+    const { serverURL, routes: { api, admin } } = useConfig();
+    const preferenceKey = `${collection.slug}-list`;
+    const { permissions } = useAuth();
+    const { setStepNav } = useStepNav();
+    const { getPreference, setPreference } = usePreferences();
+    const { page, sort, limit, where } = useSearchParams();
+    const history = useHistory();
+    const { t } = useTranslation('general');
+    const [fetchURL, setFetchURL] = useState('');
+    const [fields] = useState(() => formatFields(collection, t));
+    const [tableColumns, setTableColumns] = useState(() => {
+        const initialColumns = getInitialColumns(fields, useAsTitle, defaultColumns);
+        return buildColumns(collection, initialColumns, t);
+    });
+    const collectionPermissions = (_a = permissions === null || permissions === void 0 ? void 0 : permissions.collections) === null || _a === void 0 ? void 0 : _a[slug];
+    const hasCreatePermission = (_b = collectionPermissions === null || collectionPermissions === void 0 ? void 0 : collectionPermissions.create) === null || _b === void 0 ? void 0 : _b.permission;
+    const newDocumentURL = `${admin}/collections/${slug}/create`;
+    const [{ data }, { setParams: setFetchParams }] = usePayloadAPI(fetchURL, { initialParams: { page: 1 } });
+    const activeColumnNames = tableColumns.map(({ accessor }) => accessor);
+    const stringifiedActiveColumns = JSON.stringify(activeColumnNames);
+    useEffect(() => {
+        setStepNav([
+            {
+                label: plural,
+            },
+        ]);
+    }, [setStepNav, plural]);
+    // /////////////////////////////////////
+    // Set up Payload REST API query params
+    // /////////////////////////////////////
+    useEffect(() => {
+        const params = {
+            depth: 0,
+            draft: 'true',
+            page: undefined,
+            sort: undefined,
+            where: undefined,
+            limit,
+        };
+        if (page)
+            params.page = page;
+        if (sort)
+            params.sort = sort;
+        if (where)
+            params.where = where;
+        // Performance enhancement
+        // Setting the Fetch URL this way
+        // prevents a double-fetch
+        setFetchURL(`${serverURL}${api}/${slug}`);
+        setFetchParams(params);
+    }, [setFetchParams, page, sort, where, collection, getPreference, limit, serverURL, api, slug]);
+    // /////////////////////////////////////
+    // Fetch preferences on first load
+    // /////////////////////////////////////
+    useEffect(() => {
+        (async () => {
+            const currentPreferences = await getPreference(preferenceKey);
+            if (currentPreferences === null || currentPreferences === void 0 ? void 0 : currentPreferences.columns) {
+                setTableColumns(buildColumns(collection, currentPreferences === null || currentPreferences === void 0 ? void 0 : currentPreferences.columns, t));
+            }
+            const params = queryString.parse(history.location.search, { ignoreQueryPrefix: true, depth: 0 });
+            const search = {
+                ...params,
+                sort: (params === null || params === void 0 ? void 0 : params.sort) || (currentPreferences === null || currentPreferences === void 0 ? void 0 : currentPreferences.sort),
+                limit: (params === null || params === void 0 ? void 0 : params.limit) || (currentPreferences === null || currentPreferences === void 0 ? void 0 : currentPreferences.limit),
+            };
+            const newSearchQuery = queryString.stringify(search, { addQueryPrefix: true });
+            if (newSearchQuery.length > 1) {
+                history.replace({
+                    search: newSearchQuery,
+                });
+            }
+        })();
+    }, [collection, getPreference, preferenceKey, history, t]);
+    // /////////////////////////////////////
+    // When any preference-enabled values are updated,
+    // Set preferences
+    // /////////////////////////////////////
+    useEffect(() => {
+        const newPreferences = {
+            limit,
+            sort,
+            columns: JSON.parse(stringifiedActiveColumns),
+        };
+        setPreference(preferenceKey, newPreferences);
+    }, [sort, limit, stringifiedActiveColumns, preferenceKey, setPreference]);
+    const setActiveColumns = useCallback((columns) => {
+        setTableColumns(buildColumns(collection, columns, t));
+    }, [collection, t]);
+    return (React.createElement(RenderCustomComponent, { DefaultComponent: DefaultList, CustomComponent: CustomList, componentProps: {
+            collection: { ...collection, fields },
+            newDocumentURL,
+            hasCreatePermission,
+            data,
+            tableColumns,
+            columnNames: activeColumnNames,
+            setColumns: setActiveColumns,
+            limit: limit || defaultLimit,
+        } }));
+};
+export default ListView;

package/dist/admin/components/views/collections/List/types.d.ts

@@ -1,24 +1,24 @@
-import { SanitizedCollectionConfig } from '../../../../../collections/config/types';
-import { PaginatedDocs } from '../../../../../mongoose/types';
-import { Column } from '../../../elements/Table/types';
-export type Props = {
-    collection: SanitizedCollectionConfig;
-    data: PaginatedDocs<any>;
-    newDocumentURL: string;
-    setListControls: (controls: unknown) => void;
-    setSort: (sort: string) => void;
-    tableColumns: Column[];
-    columnNames: string[];
-    setColumns: (columns: string[]) => void;
-    hasCreatePermission: boolean;
-    setLimit: (limit: number) => void;
-    limit: number;
-};
-export type ListIndexProps = {
-    collection: SanitizedCollectionConfig;
-};
-export type ListPreferences = {
-    columns: string[];
-    limit: number;
-    sort: number;
-};
+import { SanitizedCollectionConfig } from '../../../../../collections/config/types';
+import { PaginatedDocs } from '../../../../../mongoose/types';
+import { Column } from '../../../elements/Table/types';
+export type Props = {
+    collection: SanitizedCollectionConfig;
+    data: PaginatedDocs<any>;
+    newDocumentURL: string;
+    setListControls: (controls: unknown) => void;
+    setSort: (sort: string) => void;
+    tableColumns: Column[];
+    columnNames: string[];
+    setColumns: (columns: string[]) => void;
+    hasCreatePermission: boolean;
+    setLimit: (limit: number) => void;
+    limit: number;
+};
+export type ListIndexProps = {
+    collection: SanitizedCollectionConfig;
+};
+export type ListPreferences = {
+    columns: string[];
+    limit: number;
+    sort: number;
+};

package/dist/admin/components/views/collections/List/types.js

@@ -1 +1 @@
-export {};
+export {};

package/dist/admin/hooks/useDebounce.d.ts

@@ -1 +1 @@
-export default function useDebounce<T = unknown>(value: T, delay: number): T;
+export default function useDebounce<T = unknown>(value: T, delay: number): T;

package/dist/admin/hooks/useDebounce.js

@@ -1,15 +1,15 @@
-import { useState, useEffect } from 'react';
-// Our hook
-export default function useDebounce(value, delay) {
-    // State and setters for debounced value
-    const [debouncedValue, setDebouncedValue] = useState(value);
-    useEffect(() => {
-        const handler = setTimeout(() => {
-            setDebouncedValue(value);
-        }, delay);
-        return () => {
-            clearTimeout(handler);
-        };
-    }, [value, delay]);
-    return debouncedValue;
-}
+import { useState, useEffect } from 'react';
+// Our hook
+export default function useDebounce(value, delay) {
+    // State and setters for debounced value
+    const [debouncedValue, setDebouncedValue] = useState(value);
+    useEffect(() => {
+        const handler = setTimeout(() => {
+            setDebouncedValue(value);
+        }, delay);
+        return () => {
+            clearTimeout(handler);
+        };
+    }, [value, delay]);
+    return debouncedValue;
+}

package/dist/admin/hooks/useDebouncedCallback.d.ts

@@ -1,7 +1,7 @@
-/**
- * Returns a memoized function that will only call the passed function when it hasn't been called for the wait period
- * @param func The function to be called
- * @param wait Wait period after function hasn't been called for
- * @returns A memoized function that is debounced
- */
-export declare const useDebouncedCallback: (func: any, wait: any) => (...args: any[]) => void;
+/**
+ * Returns a memoized function that will only call the passed function when it hasn't been called for the wait period
+ * @param func The function to be called
+ * @param wait Wait period after function hasn't been called for
+ * @returns A memoized function that is debounced
+ */
+export declare const useDebouncedCallback: (func: any, wait: any) => (...args: any[]) => void;

package/dist/admin/hooks/useDebouncedCallback.js

@@ -1,20 +1,20 @@
-import { useRef, useCallback } from 'react';
-/**
- * Returns a memoized function that will only call the passed function when it hasn't been called for the wait period
- * @param func The function to be called
- * @param wait Wait period after function hasn't been called for
- * @returns A memoized function that is debounced
- */
-export const useDebouncedCallback = (func, wait) => {
-    // Use a ref to store the timeout between renders
-    // and prevent changes to it from causing re-renders
-    const timeout = useRef();
-    return useCallback((...args) => {
-        const later = () => {
-            clearTimeout(timeout.current);
-            func(...args);
-        };
-        clearTimeout(timeout.current);
-        timeout.current = setTimeout(later, wait);
-    }, [func, wait]);
-};
+import { useRef, useCallback } from 'react';
+/**
+ * Returns a memoized function that will only call the passed function when it hasn't been called for the wait period
+ * @param func The function to be called
+ * @param wait Wait period after function hasn't been called for
+ * @returns A memoized function that is debounced
+ */
+export const useDebouncedCallback = (func, wait) => {
+    // Use a ref to store the timeout between renders
+    // and prevent changes to it from causing re-renders
+    const timeout = useRef();
+    return useCallback((...args) => {
+        const later = () => {
+            clearTimeout(timeout.current);
+            func(...args);
+        };
+        clearTimeout(timeout.current);
+        timeout.current = setTimeout(later, wait);
+    }, [func, wait]);
+};

package/dist/admin/hooks/useIntersect.d.ts

@@ -1,11 +1,11 @@
-/// <reference types="react" />
-type Intersect = [
-    setNode: React.Dispatch<Element>,
-    entry: IntersectionObserverEntry
-];
-declare const useIntersect: ({ root, rootMargin, threshold, }?: {
-    root?: any;
-    rootMargin?: string;
-    threshold?: number;
-}) => Intersect;
-export default useIntersect;
+/// <reference types="react" />
+type Intersect = [
+    setNode: React.Dispatch<Element>,
+    entry: IntersectionObserverEntry
+];
+declare const useIntersect: ({ root, rootMargin, threshold, }?: {
+    root?: any;
+    rootMargin?: string;
+    threshold?: number;
+}) => Intersect;
+export default useIntersect;

package/dist/admin/hooks/useIntersect.js

@@ -1,20 +1,20 @@
-/* eslint-disable no-shadow */
-import { useEffect, useRef, useState } from 'react';
-const useIntersect = ({ root = null, rootMargin = '0px', threshold = 0, } = {}) => {
-    const [entry, updateEntry] = useState();
-    const [node, setNode] = useState(null);
-    const observer = useRef(new window.IntersectionObserver(([ent]) => updateEntry(ent), {
-        root,
-        rootMargin,
-        threshold,
-    }));
-    useEffect(() => {
-        const { current: currentObserver } = observer;
-        currentObserver.disconnect();
-        if (node)
-            currentObserver.observe(node);
-        return () => currentObserver.disconnect();
-    }, [node]);
-    return [setNode, entry];
-};
-export default useIntersect;
+/* eslint-disable no-shadow */
+import { useEffect, useRef, useState } from 'react';
+const useIntersect = ({ root = null, rootMargin = '0px', threshold = 0, } = {}) => {
+    const [entry, updateEntry] = useState();
+    const [node, setNode] = useState(null);
+    const observer = useRef(new window.IntersectionObserver(([ent]) => updateEntry(ent), {
+        root,
+        rootMargin,
+        threshold,
+    }));
+    useEffect(() => {
+        const { current: currentObserver } = observer;
+        currentObserver.disconnect();
+        if (node)
+            currentObserver.observe(node);
+        return () => currentObserver.disconnect();
+    }, [node]);
+    return [setNode, entry];
+};
+export default useIntersect;

package/dist/admin/hooks/useMountEffect.d.ts

@@ -1,2 +1,2 @@
-declare const useMountEffect: (func: () => void) => void;
-export default useMountEffect;
+declare const useMountEffect: (func: () => void) => void;
+export default useMountEffect;

package/dist/admin/hooks/useMountEffect.js

@@ -1,3 +1,3 @@
-import { useEffect } from 'react';
-const useMountEffect = (func) => useEffect(func, []);
-export default useMountEffect;
+import { useEffect } from 'react';
+const useMountEffect = (func) => useEffect(func, []);
+export default useMountEffect;

package/dist/admin/hooks/usePayloadAPI.d.ts

@@ -1,18 +1,18 @@
-/// <reference types="react" />
-type Result = [
-    {
-        isLoading: boolean;
-        isError: boolean;
-        data: any;
-    },
-    {
-        setParams: React.Dispatch<unknown>;
-    }
-];
-type Options = {
-    initialParams?: unknown;
-    initialData?: any;
-};
-type UsePayloadAPI = (url: string, options?: Options) => Result;
-declare const usePayloadAPI: UsePayloadAPI;
-export default usePayloadAPI;
+/// <reference types="react" />
+type Result = [
+    {
+        isLoading: boolean;
+        isError: boolean;
+        data: any;
+    },
+    {
+        setParams: React.Dispatch<unknown>;
+    }
+];
+type Options = {
+    initialParams?: unknown;
+    initialData?: any;
+};
+type UsePayloadAPI = (url: string, options?: Options) => Result;
+declare const usePayloadAPI: UsePayloadAPI;
+export default usePayloadAPI;

package/dist/admin/hooks/usePayloadAPI.js

@@ -1,52 +1,52 @@
-import { useState, useEffect } from 'react';
-import queryString from 'qs';
-import { useTranslation } from 'react-i18next';
-import { useLocale } from '../components/utilities/Locale';
-import { requests } from '../api';
-const usePayloadAPI = (url, options = {}) => {
-    const { initialParams = {}, initialData = {}, } = options;
-    const { i18n } = useTranslation();
-    const [data, setData] = useState(initialData);
-    const [params, setParams] = useState(initialParams);
-    const [isLoading, setIsLoading] = useState(true);
-    const [isError, setIsError] = useState(false);
-    const locale = useLocale();
-    const search = queryString.stringify({
-        locale,
-        ...(typeof params === 'object' ? params : {}),
-    }, {
-        addQueryPrefix: true,
-    });
-    useEffect(() => {
-        const fetchData = async () => {
-            setIsError(false);
-            setIsLoading(true);
-            try {
-                const response = await requests.get(`${url}${search}`, {
-                    headers: {
-                        'Accept-Language': i18n.language,
-                    },
-                });
-                if (response.status > 201) {
-                    setIsError(true);
-                }
-                const json = await response.json();
-                setData(json);
-                setIsLoading(false);
-            }
-            catch (error) {
-                setIsError(true);
-                setIsLoading(false);
-            }
-        };
-        if (url) {
-            fetchData();
-        }
-        else {
-            setIsError(false);
-            setIsLoading(false);
-        }
-    }, [url, locale, search, i18n.language]);
-    return [{ data, isLoading, isError }, { setParams }];
-};
-export default usePayloadAPI;
+import { useState, useEffect } from 'react';
+import queryString from 'qs';
+import { useTranslation } from 'react-i18next';
+import { useLocale } from '../components/utilities/Locale';
+import { requests } from '../api';
+const usePayloadAPI = (url, options = {}) => {
+    const { initialParams = {}, initialData = {}, } = options;
+    const { i18n } = useTranslation();
+    const [data, setData] = useState(initialData);
+    const [params, setParams] = useState(initialParams);
+    const [isLoading, setIsLoading] = useState(true);
+    const [isError, setIsError] = useState(false);
+    const locale = useLocale();
+    const search = queryString.stringify({
+        locale,
+        ...(typeof params === 'object' ? params : {}),
+    }, {
+        addQueryPrefix: true,
+    });
+    useEffect(() => {
+        const fetchData = async () => {
+            setIsError(false);
+            setIsLoading(true);
+            try {
+                const response = await requests.get(`${url}${search}`, {
+                    headers: {
+                        'Accept-Language': i18n.language,
+                    },
+                });
+                if (response.status > 201) {
+                    setIsError(true);
+                }
+                const json = await response.json();
+                setData(json);
+                setIsLoading(false);
+            }
+            catch (error) {
+                setIsError(true);
+                setIsLoading(false);
+            }
+        };
+        if (url) {
+            fetchData();
+        }
+        else {
+            setIsError(false);
+            setIsLoading(false);
+        }
+    }, [url, locale, search, i18n.language]);
+    return [{ data, isLoading, isError }, { setParams }];
+};
+export default usePayloadAPI;

package/dist/admin/hooks/useThrottledEffect.d.ts

@@ -1,4 +1,4 @@
-/// <reference types="react" />
-type useThrottledEffect = (callback: React.EffectCallback, delay: number, deps: React.DependencyList) => void;
-declare const useThrottledEffect: useThrottledEffect;
-export default useThrottledEffect;
+/// <reference types="react" />
+type useThrottledEffect = (callback: React.EffectCallback, delay: number, deps: React.DependencyList) => void;
+declare const useThrottledEffect: useThrottledEffect;
+export default useThrottledEffect;