@payloadcms/ui 3.43.0-canary.7 → 3.43.0-internal.693bd81

package/dist/providers/Folders/index.d.ts

@@ -1,12 +1,8 @@
-import type { ClientCollectionConfig, CollectionSlug, FolderSortKeys } from 'payload';
-import type { FolderBreadcrumb, FolderDocumentItemKey, FolderOrDocument } from 'payload/shared';
+import type { ClientCollectionConfig, CollectionSlug } from 'payload';
+import type { FolderBreadcrumb, FolderOrDocument } from 'payload/shared';
 import React from 'react';
-type FolderQueryParams = {
-    page?: string;
-    relationTo?: CollectionSlug[];
-    search?: string;
-    sort?: string;
-};
+type SortKeys = keyof Pick<FolderOrDocument['value'], '_folderOrDocumentTitle' | 'createdAt' | 'updatedAt'>;
+type SortDirection = 'asc' | 'desc';
 export type FileCardData = {
     filename: string;
     id: number | string;
@@ -15,30 +11,26 @@ export type FileCardData = {
     url: string;
 };
 export type FolderContextValue = {
-    /**
-     * The collection slugs that a view can be filtered by
-     * Used in the browse-by-folder view
-     */
-    activeCollectionFolderSlugs: CollectionSlug[];
-    /**
-     * Folder enabled collection slugs that can be populated within the provider
-     */
-    readonly allCollectionFolderSlugs?: CollectionSlug[];
-    allowCreateCollectionSlugs: CollectionSlug[];
+    addItems: (args: FolderOrDocument[]) => void;
     breadcrumbs?: FolderBreadcrumb[];
     clearSelections: () => void;
     currentFolder?: FolderOrDocument | null;
     documents?: FolderOrDocument[];
+    filterItems: (args: {
+        relationTo?: CollectionSlug[];
+        search?: string;
+    }) => Promise<void>;
     focusedRowIndex: number;
     folderCollectionConfig: ClientCollectionConfig;
     folderCollectionSlug: string;
+    /**
+     * Folder enabled collection slugs that can be populated within the provider
+     */
+    readonly folderCollectionSlugs?: CollectionSlug[];
     folderFieldName: string;
     folderID?: number | string;
-    FolderResultsComponent: React.ReactNode;
-    getFolderRoute: (toFolderID?: number | string) => string;
     getSelectedItems?: () => FolderOrDocument[];
     isDragging: boolean;
-    itemKeysToMove?: Set<FolderDocumentItemKey>;
     lastSelectedIndex: null | number;
     moveToFolder: (args: {
         itemsToMove: FolderOrDocument[];
@@ -48,47 +40,38 @@ export type FolderContextValue = {
         event: React.MouseEvent;
         index: number;
         item: FolderOrDocument;
-    }) => void;
+    }) => Promise<void> | void;
     onItemKeyPress: (args: {
         event: React.KeyboardEvent;
         index: number;
         item: FolderOrDocument;
-    }) => void;
-    refineFolderData: (args: {
-        query?: FolderQueryParams;
-        updateURL: boolean;
+    }) => Promise<void> | void;
+    removeItems: (args: FolderOrDocument[]) => void;
+    renameFolder: (args: {
+        folderID: number | string;
+        newName: string;
     }) => void;
     search: string;
-    readonly selectedItemKeys: Set<FolderDocumentItemKey>;
+    selectedIndexes: Set<number>;
     setBreadcrumbs: React.Dispatch<React.SetStateAction<FolderBreadcrumb[]>>;
     setFocusedRowIndex: React.Dispatch<React.SetStateAction<number>>;
+    setFolderID: (args: {
+        folderID: number | string;
+    }) => Promise<void> | void;
     setIsDragging: React.Dispatch<React.SetStateAction<boolean>>;
-    sort: FolderSortKeys;
+    sortAndUpdateState: (args: {
+        documentsToSort?: FolderOrDocument[];
+        sortDirection?: 'asc' | 'desc';
+        sortOn?: SortKeys;
+        subfoldersToSort?: FolderOrDocument[];
+    }) => void;
+    sortDirection: SortDirection;
+    sortOn: SortKeys;
     subfolders?: FolderOrDocument[];
+    visibleCollectionSlugs: CollectionSlug[];
 };
 export type FolderProviderProps = {
-    /**
-     * The collection slugs that are being viewed
-     */
-    readonly activeCollectionFolderSlugs?: CollectionSlug[];
-    /**
-     * Folder enabled collection slugs that can be populated within the provider
-     */
-    readonly allCollectionFolderSlugs: CollectionSlug[];
-    /**
-     * Array of slugs that can be created in the folder view
-     */
-    readonly allowCreateCollectionSlugs: CollectionSlug[];
     readonly allowMultiSelection?: boolean;
-    /**
-     * The base folder route path
-     *
-     * @example
-     * `/collections/:collectionSlug/:folderCollectionSlug`
-     * or
-     * `/browse-by-folder`
-     */
-    readonly baseFolderPath?: `/${string}`;
     /**
      * Breadcrumbs for the current folder
      */
@@ -97,26 +80,30 @@ export type FolderProviderProps = {
      * Children to render inside the provider
      */
     readonly children: React.ReactNode;
+    /**
+     * Required for collection-folder views
+     */
+    readonly collectionSlug?: CollectionSlug;
     /**
      * All documents in the current folder
      */
     readonly documents: FolderOrDocument[];
     /**
-     * The name of the field that contains the folder relation
+     * The collection slugs that are being viewed
      */
-    readonly folderFieldName: string;
+    readonly filteredCollectionSlugs?: CollectionSlug[];
     /**
-     * The ID of the current folder
+     * Folder enabled collection slugs that can be populated within the provider
      */
-    readonly folderID?: number | string;
+    readonly folderCollectionSlugs: CollectionSlug[];
     /**
-     * The component to render the folder results
+     * The name of the field that contains the folder relation
      */
-    readonly FolderResultsComponent: React.ReactNode;
+    readonly folderFieldName: string;
     /**
-     * Optional function to call when an item is clicked
+     * The ID of the current folder
      */
-    readonly onItemClick?: (itme: FolderOrDocument) => void;
+    readonly folderID?: number | string;
     /**
      * The intial search query
      */
@@ -128,13 +115,13 @@ export type FolderProviderProps = {
      * `name` for descending
      * `-name` for ascending
      */
-    readonly sort?: FolderSortKeys;
+    readonly sort?: `-${SortKeys}` | SortKeys;
     /**
      * All subfolders in the current folder
      */
     readonly subfolders: FolderOrDocument[];
 };
-export declare function FolderProvider({ activeCollectionFolderSlugs: activeCollectionSlugs, allCollectionFolderSlugs, allowCreateCollectionSlugs, allowMultiSelection, baseFolderPath, breadcrumbs: _breadcrumbsFromProps, children, documents, folderFieldName, folderID, FolderResultsComponent: InitialFolderResultsComponent, onItemClick: onItemClickFromProps, search, sort, subfolders, }: FolderProviderProps): React.JSX.Element;
+export declare function FolderProvider({ allowMultiSelection, breadcrumbs: _breadcrumbsFromProps, children, collectionSlug, documents: allDocumentsFromProps, filteredCollectionSlugs, folderCollectionSlugs, folderFieldName, folderID: _folderIDFromProps, search: _searchFromProps, sort, subfolders: subfoldersFromProps, }: FolderProviderProps): React.JSX.Element;
 export declare function useFolder(): FolderContextValue;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/providers/Folders/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/Folders/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AACrF,OAAO,KAAK,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAA;AAK/F,OAAO,KAAK,MAAM,OAAO,CAAA;AAUzB,KAAK,iBAAiB,GAAG;IACvB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,cAAc,EAAE,CAAA;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;OAGG;IACH,2BAA2B,EAAE,cAAc,EAAE,CAAA;IAC7C;;OAEG;IACH,QAAQ,CAAC,wBAAwB,CAAC,EAAE,cAAc,EAAE,CAAA;IACpD,0BAA0B,EAAE,cAAc,EAAE,CAAA;IAC5C,WAAW,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAChC,eAAe,EAAE,MAAM,IAAI,CAAA;IAC3B,aAAa,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;IACvC,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC9B,eAAe,EAAE,MAAM,CAAA;IACvB,sBAAsB,EAAE,sBAAsB,CAAA;IAC9C,oBAAoB,EAAE,MAAM,CAAA;IAC5B,eAAe,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1B,sBAAsB,EAAE,KAAK,CAAC,SAAS,CAAA;IACvC,cAAc,EAAE,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,KAAK,MAAM,CAAA;IACxD,gBAAgB,CAAC,EAAE,MAAM,gBAAgB,EAAE,CAAA;IAC3C,UAAU,EAAE,OAAO,CAAA;IACnB,cAAc,CAAC,EAAE,GAAG,CAAC,qBAAqB,CAAC,CAAA;IAC3C,iBAAiB,EAAE,IAAI,GAAG,MAAM,CAAA;IAChC,YAAY,EAAE,CAAC,IAAI,EAAE;QACnB,WAAW,EAAE,gBAAgB,EAAE,CAAA;QAC/B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAC7B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACnB,WAAW,EAAE,CAAC,IAAI,EAAE;QAAE,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,gBAAgB,CAAA;KAAE,KAAK,IAAI,CAAA;IAC/F,cAAc,EAAE,CAAC,IAAI,EAAE;QACrB,KAAK,EAAE,KAAK,CAAC,aAAa,CAAA;QAC1B,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,gBAAgB,CAAA;KACvB,KAAK,IAAI,CAAA;IACV,gBAAgB,EAAE,CAAC,IAAI,EAAE;QAAE,KAAK,CAAC,EAAE,iBAAiB,CAAC;QAAC,SAAS,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAA;IACnF,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC,qBAAqB,CAAC,CAAA;IACrD,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAA;IACxE,kBAAkB,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAA;IAChE,aAAa,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5D,IAAI,EAAE,cAAc,CAAA;IACpB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAA;CAChC,CAAA;AAkCD,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,QAAQ,CAAC,2BAA2B,CAAC,EAAE,cAAc,EAAE,CAAA;IACvD;;OAEG;IACH,QAAQ,CAAC,wBAAwB,EAAE,cAAc,EAAE,CAAA;IACnD;;OAEG;IACH,QAAQ,CAAC,0BAA0B,EAAE,cAAc,EAAE,CAAA;IACrD,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,IAAI,MAAM,EAAE,CAAA;IACtC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,gBAAgB,EAAE,CAAA;IACzC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAClC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,gBAAgB,EAAE,CAAA;IACtC;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAChC;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACnC;;OAEG;IACH,QAAQ,CAAC,sBAAsB,EAAE,KAAK,CAAC,SAAS,CAAA;IAChD;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAA;IACvD;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,cAAc,CAAA;IAC9B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,gBAAgB,EAAE,CAAA;CACxC,CAAA;AACD,wBAAgB,cAAc,CAAC,EAC7B,2BAA2B,EAAE,qBAAqB,EAClD,wBAA6B,EAC7B,0BAA0B,EAC1B,mBAA0B,EAC1B,cAAc,EACd,WAAW,EAAE,qBAA0B,EACvC,QAAQ,EACR,SAAS,EACT,eAAe,EACf,QAAQ,EACR,sBAAsB,EAAE,6BAA6B,EACrD,WAAW,EAAE,oBAAoB,EACjC,MAAM,EACN,IAA+B,EAC/B,UAAU,GACX,EAAE,mBAAmB,qBA6crB;AAED,wBAAgB,SAAS,IAAI,kBAAkB,CAQ9C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/providers/Folders/index.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,cAAc,EAAY,MAAM,SAAS,CAAA;AAC/E,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAuB,MAAM,gBAAgB,CAAA;AAK7F,OAAO,KAAK,MAAM,OAAO,CAAA;AAQzB,KAAK,QAAQ,GAAG,MAAM,IAAI,CACxB,gBAAgB,CAAC,OAAO,CAAC,EACzB,wBAAwB,GAAG,WAAW,GAAG,WAAW,CACrD,CAAA;AACD,KAAK,aAAa,GAAG,KAAK,GAAG,MAAM,CAAA;AACnC,MAAM,MAAM,YAAY,GAAG;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,EAAE,EAAE,MAAM,GAAG,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,CAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,IAAI,CAAA;IAC5C,WAAW,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAChC,eAAe,EAAE,MAAM,IAAI,CAAA;IAC3B,aAAa,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAA;IACvC,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC9B,WAAW,EAAE,CAAC,IAAI,EAAE;QAAE,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACxF,eAAe,EAAE,MAAM,CAAA;IACvB,sBAAsB,EAAE,sBAAsB,CAAA;IAC9C,oBAAoB,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAAC,EAAE,cAAc,EAAE,CAAA;IACjD,eAAe,EAAE,MAAM,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IAC1B,gBAAgB,CAAC,EAAE,MAAM,gBAAgB,EAAE,CAAA;IAC3C,UAAU,EAAE,OAAO,CAAA;IACnB,iBAAiB,EAAE,IAAI,GAAG,MAAM,CAAA;IAChC,YAAY,EAAE,CAAC,IAAI,EAAE;QACnB,WAAW,EAAE,gBAAgB,EAAE,CAAA;QAC/B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;KAC7B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACnB,WAAW,EAAE,CAAC,IAAI,EAAE;QAClB,KAAK,EAAE,KAAK,CAAC,UAAU,CAAA;QACvB,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,gBAAgB,CAAA;KACvB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAC1B,cAAc,EAAE,CAAC,IAAI,EAAE;QACrB,KAAK,EAAE,KAAK,CAAC,aAAa,CAAA;QAC1B,KAAK,EAAE,MAAM,CAAA;QACb,IAAI,EAAE,gBAAgB,CAAA;KACvB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAC1B,WAAW,EAAE,CAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,IAAI,CAAA;IAC/C,YAAY,EAAE,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAA;IAC5E,MAAM,EAAE,MAAM,CAAA;IACd,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC5B,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAA;IACxE,kBAAkB,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAA;IAChE,WAAW,EAAE,CAAC,IAAI,EAAE;QAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAC1E,aAAa,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAA;IAC5D,kBAAkB,EAAE,CAAC,IAAI,EAAE;QACzB,eAAe,CAAC,EAAE,gBAAgB,EAAE,CAAA;QACpC,aAAa,CAAC,EAAE,KAAK,GAAG,MAAM,CAAA;QAC9B,MAAM,CAAC,EAAE,QAAQ,CAAA;QACjB,gBAAgB,CAAC,EAAE,gBAAgB,EAAE,CAAA;KACtC,KAAK,IAAI,CAAA;IACV,aAAa,EAAE,aAAa,CAAA;IAC5B,MAAM,EAAE,QAAQ,CAAA;IAChB,UAAU,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC/B,sBAAsB,EAAE,cAAc,EAAE,CAAA;CACzC,CAAA;AA8DD,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAA;IACtC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,gBAAgB,EAAE,CAAA;IACzC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAClC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,cAAc,CAAA;IACxC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,gBAAgB,EAAE,CAAA;IACtC;;OAEG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,cAAc,EAAE,CAAA;IACnD;;OAEG;IACH,QAAQ,CAAC,qBAAqB,EAAE,cAAc,EAAE,CAAA;IAChD;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;IAChC;;OAEG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;IACnC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IACxB;;;;;;OAMG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,QAAQ,EAAE,GAAG,QAAQ,CAAA;IACzC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,gBAAgB,EAAE,CAAA;CACxC,CAAA;AACD,wBAAgB,cAAc,CAAC,EAC7B,mBAA0B,EAC1B,WAAW,EAAE,qBAA0B,EACvC,QAAQ,EACR,cAAc,EACd,SAAS,EAAE,qBAA0B,EACrC,uBAAuB,EACvB,qBAA0B,EAC1B,eAAe,EACf,QAAQ,EAAE,kBAA8B,EACxC,MAAM,EAAE,gBAAgB,EACxB,IAAI,EACJ,UAAU,EAAE,mBAAwB,GACrC,EAAE,mBAAmB,qBAm7BrB;AAED,wBAAgB,SAAS,IAAI,kBAAkB,CAQ9C"}