@prismicio/editor-fields 0.4.88 → 0.4.90

package/dist/core/service/document.d.ts

@@ -1,6 +1,6 @@
 import { type QueryClient } from "@tanstack/react-query";
 import { z } from "zod";
-import type { AuthStrategy } from "../../EditorConfig";
+import { type AuthStrategy } from "../../EditorConfig";
 export declare const languageSchema: z.ZodEffects<z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
@@ -22,6 +22,34 @@ export declare const languageSchema: z.ZodEffects<z.ZodObject<{
     name: string;
     is_master?: boolean | undefined;
 }>;
+export declare const documentVersionStatusSchema: z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+    status: z.ZodLiteral<"unclassified">;
+}, "strip", z.ZodTypeAny, {
+    status: "unclassified";
+}, {
+    status: "unclassified";
+}>, z.ZodObject<{
+    status: z.ZodLiteral<"published">;
+}, "strip", z.ZodTypeAny, {
+    status: "published";
+}, {
+    status: "published";
+}>, z.ZodObject<{
+    status: z.ZodLiteral<"release">;
+    release_id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    status: "release";
+    release_id: string;
+}, {
+    status: "release";
+    release_id: string;
+}>, z.ZodObject<{
+    status: z.ZodLiteral<"archived">;
+}, "strip", z.ZodTypeAny, {
+    status: "archived";
+}, {
+    status: "archived";
+}>]>;
 declare const documentVersionSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
     status: z.ZodLiteral<"unclassified">;
 }, "strip", z.ZodTypeAny, {
@@ -1079,14 +1107,17 @@ export type DocumentFullTextSearchApi = z.TypeOf<typeof documentsFullTextSearchA
 export type DocumentMeta = z.TypeOf<typeof documentMetaSchema>;
 export type DocumentSearchMeta = z.TypeOf<typeof documentSearchDocumentSchema>;
 export type DocumentVersion = z.TypeOf<typeof documentVersionSchema>;
-export type DocumentStatus = DocumentVersion["status"];
-export interface GetDocumentListArgs {
+export type SimpleDocumentStatus = DocumentVersion["status"];
+type ReleaseId = string;
+export type DocumentStatus = SimpleDocumentStatus | `release:${ReleaseId}`;
+export interface GetDocumentListArgs<Schema extends z.ZodType = typeof getDocumentListSchema> {
     baseUrl: URL;
     authStrategy: AuthStrategy;
     signal?: AbortSignal | null | undefined;
+    schema?: Schema;
     limit?: number;
     cursor?: string;
-    statuses?: string[];
+    statuses?: DocumentStatus[];
     authors?: string[];
     language?: string;
     groupLangIds?: string[];
@@ -1096,7 +1127,7 @@ export interface GetDocumentListArgs {
     term?: string;
     uids?: string[];
 }
-export declare function getDocumentList(args: GetDocumentListArgs): Promise<GetDocumentListSchema>;
+export declare function getDocumentList<Schema extends z.ZodType = typeof getDocumentListSchema>(args: GetDocumentListArgs<Schema>): Promise<z.infer<Schema>>;
 export declare function searchFullTextDocuments(baseUrl: URL, authStrategy: AuthStrategy, queryString: string, options?: Pick<RequestInit, "signal">): Promise<DocumentFullTextSearchApi>;
 export declare function makeSearchFullTextDocumentsQueryString(args: {
     repository: string;
@@ -1107,15 +1138,203 @@ export declare function makeSearchFullTextDocumentsQueryString(args: {
     localeId?: string;
     customTypesIds?: string[];
 }): string;
-type GetDocumentsQueryFilters = "tags" | "language" | "customTypes" | "status" | "term" | "group_lang_id" | "document_id" | "uid" | "authors";
-export type SearchDocumentParams = {
-    [S in GetDocumentsQueryFilters]?: string[];
-};
 export declare function createSearchParams<T extends string>(params: {
     name: T;
     values: (string | undefined)[];
 }[]): [string, string][];
-export declare function getDocumentById(baseUrl: URL, authStrategy: AuthStrategy, id: string): Promise<DocumentMeta>;
+export declare function getDocumentMeta(baseUrl: URL, authStrategy: AuthStrategy, documentId: string): Promise<DocumentMeta>;
+export declare function documentMetaKey(documentId: string): readonly ["documentMeta", string];
+interface DocumentMetaOptionsArgs {
+    baseUrl: URL;
+    authStrategy: AuthStrategy;
+    documentId: string;
+}
+export declare function getDocumentMetaOptions(args: DocumentMetaOptionsArgs): import("@tanstack/react-query/build/legacy/types").UseQueryOptions<{
+    language: {
+        id: string;
+        label: string;
+        isMaster: boolean;
+    };
+    title: string;
+    id: string;
+    custom_type_id: string;
+    group_lang_id: string;
+    versions: (({
+        status: "unclassified";
+    } | {
+        status: "published";
+    } | {
+        status: "release";
+        release_id: string;
+    } | {
+        status: "archived";
+    }) & {
+        tags: string[];
+        version_id: string;
+        last_modified_date: Date;
+        custom_type_label: string;
+        author: {
+            email?: string | undefined;
+            id?: string | undefined;
+            first_name?: string | undefined;
+            last_name?: string | undefined;
+            uploadedAvatar?: string | undefined;
+        };
+        uid?: string | undefined;
+        preview_image?: string | undefined;
+        preview_summary?: string | undefined;
+    })[];
+    ai_abm_thread_id?: string | undefined;
+}, Error, {
+    language: {
+        id: string;
+        label: string;
+        isMaster: boolean;
+    };
+    title: string;
+    id: string;
+    custom_type_id: string;
+    group_lang_id: string;
+    versions: (({
+        status: "unclassified";
+    } | {
+        status: "published";
+    } | {
+        status: "release";
+        release_id: string;
+    } | {
+        status: "archived";
+    }) & {
+        tags: string[];
+        version_id: string;
+        last_modified_date: Date;
+        custom_type_label: string;
+        author: {
+            email?: string | undefined;
+            id?: string | undefined;
+            first_name?: string | undefined;
+            last_name?: string | undefined;
+            uploadedAvatar?: string | undefined;
+        };
+        uid?: string | undefined;
+        preview_image?: string | undefined;
+        preview_summary?: string | undefined;
+    })[];
+    ai_abm_thread_id?: string | undefined;
+}, readonly ["documentMeta", string]> & {
+    initialData?: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").L<{
+        language: {
+            id: string;
+            label: string;
+            isMaster: boolean;
+        };
+        title: string;
+        id: string;
+        custom_type_id: string;
+        group_lang_id: string;
+        versions: (({
+            status: "unclassified";
+        } | {
+            status: "published";
+        } | {
+            status: "release";
+            release_id: string;
+        } | {
+            status: "archived";
+        }) & {
+            tags: string[];
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            author: {
+                email?: string | undefined;
+                id?: string | undefined;
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            uid?: string | undefined;
+            preview_image?: string | undefined;
+            preview_summary?: string | undefined;
+        })[];
+        ai_abm_thread_id?: string | undefined;
+    }> | undefined;
+} & {
+    queryKey: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").E<readonly ["documentMeta", string], {
+        language: {
+            id: string;
+            label: string;
+            isMaster: boolean;
+        };
+        title: string;
+        id: string;
+        custom_type_id: string;
+        group_lang_id: string;
+        versions: (({
+            status: "unclassified";
+        } | {
+            status: "published";
+        } | {
+            status: "release";
+            release_id: string;
+        } | {
+            status: "archived";
+        }) & {
+            tags: string[];
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            author: {
+                email?: string | undefined;
+                id?: string | undefined;
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            uid?: string | undefined;
+            preview_image?: string | undefined;
+            preview_summary?: string | undefined;
+        })[];
+        ai_abm_thread_id?: string | undefined;
+    }>;
+};
+export declare function useEditorDocumentMeta(documentId: string): {
+    language: {
+        id: string;
+        label: string;
+        isMaster: boolean;
+    };
+    title: string;
+    id: string;
+    custom_type_id: string;
+    group_lang_id: string;
+    versions: (({
+        status: "unclassified";
+    } | {
+        status: "published";
+    } | {
+        status: "release";
+        release_id: string;
+    } | {
+        status: "archived";
+    }) & {
+        tags: string[];
+        version_id: string;
+        last_modified_date: Date;
+        custom_type_label: string;
+        author: {
+            email?: string | undefined;
+            id?: string | undefined;
+            first_name?: string | undefined;
+            last_name?: string | undefined;
+            uploadedAvatar?: string | undefined;
+        };
+        uid?: string | undefined;
+        preview_image?: string | undefined;
+        preview_summary?: string | undefined;
+    })[];
+    ai_abm_thread_id?: string | undefined;
+};
 export declare const Document: z.ZodEffects<z.ZodUnknown, {
     [x: string]: import("@prismicio/types-internal/lib/content").GroupContent | {
         type: string;
@@ -7655,58 +7874,847 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
 export declare const documentKeys: {
     all: () => readonly ["documents"];
     lists: () => readonly ["documents", "list"];
-    list: (args: GetDocumentListArgs) => readonly ["documents", "list", GetDocumentListArgs];
-    infiniteLists: () => readonly ["documents", "list:infinite"];
-    infiniteList: (args: GetDocumentListArgs) => readonly ["documents", "list:infinite", GetDocumentListArgs];
-};
-/**
- * Returns updated document or undefined if document should be removed
- */
-type UpdateDocumentFunction = (document: DocumentMeta, page: GetDocumentListSchema) => DocumentMeta | undefined;
-export declare function updateDocumentListData(queryClient: QueryClient, updateFunction: UpdateDocumentFunction): void;
-export declare function invalidateDocumentListData(queryClient: QueryClient): Promise<void>;
-export declare function useDocumentList(args: GetDocumentListArgs): import("@tanstack/react-query/build/legacy/types").UseSuspenseQueryResult<{
-    results: {
-        language: {
-            id: string;
-            label: string;
-            isMaster: boolean;
-        };
-        title: string;
-        id: string;
-        custom_type_id: string;
-        group_lang_id: string;
-        versions: (({
-            status: "unclassified";
-        } | {
-            status: "published";
-        } | {
-            status: "release";
-            release_id: string;
-        } | {
-            status: "archived";
-        }) & {
-            tags: string[];
-            version_id: string;
-            last_modified_date: Date;
-            custom_type_label: string;
-            author: {
-                email?: string | undefined;
-                id?: string | undefined;
-                first_name?: string | undefined;
-                last_name?: string | undefined;
-                uploadedAvatar?: string | undefined;
-            };
-            uid?: string | undefined;
-            preview_image?: string | undefined;
-            preview_summary?: string | undefined;
-        })[];
-        ai_abm_thread_id?: string | undefined;
-    }[];
+    list: (args: GetDocumentListArgs) => readonly ["documents", "list", GetDocumentListArgs<z.ZodObject<{
+        total: z.ZodNumber;
+        cursor: z.ZodOptional<z.ZodString>;
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string, string | null | undefined>;
+            custom_type_id: z.ZodString;
+            group_lang_id: z.ZodString;
+            language: z.ZodEffects<z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodString;
+                is_master: z.ZodDefault<z.ZodBoolean>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                name: string;
+                is_master: boolean;
+            }, {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            }>, {
+                id: string;
+                label: string;
+                isMaster: boolean;
+            }, {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            }>;
+            ai_abm_thread_id: z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
+            versions: z.ZodArray<z.ZodIntersection<z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+                status: z.ZodLiteral<"unclassified">;
+            }, "strip", z.ZodTypeAny, {
+                status: "unclassified";
+            }, {
+                status: "unclassified";
+            }>, z.ZodObject<{
+                status: z.ZodLiteral<"published">;
+            }, "strip", z.ZodTypeAny, {
+                status: "published";
+            }, {
+                status: "published";
+            }>, z.ZodObject<{
+                status: z.ZodLiteral<"release">;
+                release_id: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                status: "release";
+                release_id: string;
+            }, {
+                status: "release";
+                release_id: string;
+            }>, z.ZodObject<{
+                status: z.ZodLiteral<"archived">;
+            }, "strip", z.ZodTypeAny, {
+                status: "archived";
+            }, {
+                status: "archived";
+            }>]>, z.ZodObject<z.objectUtil.extendShape<{
+                version_id: z.ZodString;
+                tags: z.ZodArray<z.ZodString, "many">;
+                preview_image: z.ZodOptional<z.ZodString>;
+                last_modified_date: z.ZodDate;
+                uid: z.ZodOptional<z.ZodString>;
+            }, {
+                custom_type_label: z.ZodString;
+                preview_summary: z.ZodOptional<z.ZodString>;
+                author: z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    first_name: z.ZodOptional<z.ZodString>;
+                    last_name: z.ZodOptional<z.ZodString>;
+                    email: z.ZodOptional<z.ZodString>;
+                    uploadedAvatar: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                }, {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                }>;
+            }>, "strip", z.ZodTypeAny, {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            }, {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            }>>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            language: {
+                id: string;
+                label: string;
+                isMaster: boolean;
+            };
+            title: string;
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            ai_abm_thread_id?: string | undefined;
+        }, {
+            language: {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            };
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            title?: string | null | undefined;
+            ai_abm_thread_id?: string | null | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        results: {
+            language: {
+                id: string;
+                label: string;
+                isMaster: boolean;
+            };
+            title: string;
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            ai_abm_thread_id?: string | undefined;
+        }[];
+        total: number;
+        cursor?: string | undefined;
+    }, {
+        results: {
+            language: {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            };
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            title?: string | null | undefined;
+            ai_abm_thread_id?: string | null | undefined;
+        }[];
+        total: number;
+        cursor?: string | undefined;
+    }>>];
+    infiniteLists: () => readonly ["documents", "list:infinite"];
+    infiniteList: (args: GetDocumentListArgs) => readonly ["documents", "list:infinite", GetDocumentListArgs<z.ZodObject<{
+        total: z.ZodNumber;
+        cursor: z.ZodOptional<z.ZodString>;
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string, string | null | undefined>;
+            custom_type_id: z.ZodString;
+            group_lang_id: z.ZodString;
+            language: z.ZodEffects<z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodString;
+                is_master: z.ZodDefault<z.ZodBoolean>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                name: string;
+                is_master: boolean;
+            }, {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            }>, {
+                id: string;
+                label: string;
+                isMaster: boolean;
+            }, {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            }>;
+            ai_abm_thread_id: z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
+            versions: z.ZodArray<z.ZodIntersection<z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+                status: z.ZodLiteral<"unclassified">;
+            }, "strip", z.ZodTypeAny, {
+                status: "unclassified";
+            }, {
+                status: "unclassified";
+            }>, z.ZodObject<{
+                status: z.ZodLiteral<"published">;
+            }, "strip", z.ZodTypeAny, {
+                status: "published";
+            }, {
+                status: "published";
+            }>, z.ZodObject<{
+                status: z.ZodLiteral<"release">;
+                release_id: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                status: "release";
+                release_id: string;
+            }, {
+                status: "release";
+                release_id: string;
+            }>, z.ZodObject<{
+                status: z.ZodLiteral<"archived">;
+            }, "strip", z.ZodTypeAny, {
+                status: "archived";
+            }, {
+                status: "archived";
+            }>]>, z.ZodObject<z.objectUtil.extendShape<{
+                version_id: z.ZodString;
+                tags: z.ZodArray<z.ZodString, "many">;
+                preview_image: z.ZodOptional<z.ZodString>;
+                last_modified_date: z.ZodDate;
+                uid: z.ZodOptional<z.ZodString>;
+            }, {
+                custom_type_label: z.ZodString;
+                preview_summary: z.ZodOptional<z.ZodString>;
+                author: z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    first_name: z.ZodOptional<z.ZodString>;
+                    last_name: z.ZodOptional<z.ZodString>;
+                    email: z.ZodOptional<z.ZodString>;
+                    uploadedAvatar: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                }, {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                }>;
+            }>, "strip", z.ZodTypeAny, {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            }, {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            }>>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            language: {
+                id: string;
+                label: string;
+                isMaster: boolean;
+            };
+            title: string;
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            ai_abm_thread_id?: string | undefined;
+        }, {
+            language: {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            };
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            title?: string | null | undefined;
+            ai_abm_thread_id?: string | null | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        results: {
+            language: {
+                id: string;
+                label: string;
+                isMaster: boolean;
+            };
+            title: string;
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            ai_abm_thread_id?: string | undefined;
+        }[];
+        total: number;
+        cursor?: string | undefined;
+    }, {
+        results: {
+            language: {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            };
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            title?: string | null | undefined;
+            ai_abm_thread_id?: string | null | undefined;
+        }[];
+        total: number;
+        cursor?: string | undefined;
+    }>>];
+};
+/**
+ * Returns updated document or undefined if document should be removed
+ */
+type UpdateDocumentFunction = (document: DocumentMeta, page: GetDocumentListSchema) => DocumentMeta | undefined;
+interface UpdateDocumentListDataArgs {
+    queryClient: QueryClient;
+    updateFunction: UpdateDocumentFunction;
+    /**
+     * Include or exclude stale queries from the update.
+     *
+     * updateDocumentListData() makes queries fresh. If the queries are already
+     * stale, it's best to keep them untouched and let them refetch instead of
+     * modifying the cache manually.
+     *
+     * Use stale: false to exclude stale queries from the update.
+     */
+    stale?: boolean;
+}
+export declare function updateDocumentListData(args: UpdateDocumentListDataArgs): void;
+/**
+ * @deprecated ⚠️ Don't add new usages of this and try to remove existing usages as much as possible.
+ *
+ * This is not scalable: If you scroll 30 pages of data and call invalidateDocumentListData(),
+ * we will instantly make 30 expensive queries to the core API (or the next time we visit one of the infinite lists).
+ * We should create a toast with an action that will only reload the first page, at your convenience.
+ * For now, only bulk actions make use of this toast approach but we should share and reuse that logic.
+ */
+export declare function invalidateDocumentListData(queryClient: QueryClient): Promise<void>;
+export declare function resetFirstDocumentListPage(queryClient: QueryClient): Promise<void>;
+export declare function getDocumentListOptions(args: GetDocumentListArgs): import("@tanstack/react-query/build/legacy/types").UseQueryOptions<{
+    results: {
+        language: {
+            id: string;
+            label: string;
+            isMaster: boolean;
+        };
+        title: string;
+        id: string;
+        custom_type_id: string;
+        group_lang_id: string;
+        versions: (({
+            status: "unclassified";
+        } | {
+            status: "published";
+        } | {
+            status: "release";
+            release_id: string;
+        } | {
+            status: "archived";
+        }) & {
+            tags: string[];
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            author: {
+                email?: string | undefined;
+                id?: string | undefined;
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            uid?: string | undefined;
+            preview_image?: string | undefined;
+            preview_summary?: string | undefined;
+        })[];
+        ai_abm_thread_id?: string | undefined;
+    }[];
     total: number;
     cursor?: string | undefined;
-}, Error>;
-export declare function getDocumentListOptions(args: GetDocumentListArgs): import("@tanstack/react-query/build/legacy/types").UseQueryOptions<{
+}, Error, {
+    results: {
+        language: {
+            id: string;
+            label: string;
+            isMaster: boolean;
+        };
+        title: string;
+        id: string;
+        custom_type_id: string;
+        group_lang_id: string;
+        versions: (({
+            status: "unclassified";
+        } | {
+            status: "published";
+        } | {
+            status: "release";
+            release_id: string;
+        } | {
+            status: "archived";
+        }) & {
+            tags: string[];
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            author: {
+                email?: string | undefined;
+                id?: string | undefined;
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            uid?: string | undefined;
+            preview_image?: string | undefined;
+            preview_summary?: string | undefined;
+        })[];
+        ai_abm_thread_id?: string | undefined;
+    }[];
+    total: number;
+    cursor?: string | undefined;
+}, readonly ["documents", "list", GetDocumentListArgs<z.ZodObject<{
+    total: z.ZodNumber;
+    cursor: z.ZodOptional<z.ZodString>;
+    results: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string, string | null | undefined>;
+        custom_type_id: z.ZodString;
+        group_lang_id: z.ZodString;
+        language: z.ZodEffects<z.ZodObject<{
+            id: z.ZodString;
+            name: z.ZodString;
+            is_master: z.ZodDefault<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            name: string;
+            is_master: boolean;
+        }, {
+            id: string;
+            name: string;
+            is_master?: boolean | undefined;
+        }>, {
+            id: string;
+            label: string;
+            isMaster: boolean;
+        }, {
+            id: string;
+            name: string;
+            is_master?: boolean | undefined;
+        }>;
+        ai_abm_thread_id: z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
+        versions: z.ZodArray<z.ZodIntersection<z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+            status: z.ZodLiteral<"unclassified">;
+        }, "strip", z.ZodTypeAny, {
+            status: "unclassified";
+        }, {
+            status: "unclassified";
+        }>, z.ZodObject<{
+            status: z.ZodLiteral<"published">;
+        }, "strip", z.ZodTypeAny, {
+            status: "published";
+        }, {
+            status: "published";
+        }>, z.ZodObject<{
+            status: z.ZodLiteral<"release">;
+            release_id: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            status: "release";
+            release_id: string;
+        }, {
+            status: "release";
+            release_id: string;
+        }>, z.ZodObject<{
+            status: z.ZodLiteral<"archived">;
+        }, "strip", z.ZodTypeAny, {
+            status: "archived";
+        }, {
+            status: "archived";
+        }>]>, z.ZodObject<z.objectUtil.extendShape<{
+            version_id: z.ZodString;
+            tags: z.ZodArray<z.ZodString, "many">;
+            preview_image: z.ZodOptional<z.ZodString>;
+            last_modified_date: z.ZodDate;
+            uid: z.ZodOptional<z.ZodString>;
+        }, {
+            custom_type_label: z.ZodString;
+            preview_summary: z.ZodOptional<z.ZodString>;
+            author: z.ZodObject<{
+                id: z.ZodOptional<z.ZodString>;
+                first_name: z.ZodOptional<z.ZodString>;
+                last_name: z.ZodOptional<z.ZodString>;
+                email: z.ZodOptional<z.ZodString>;
+                uploadedAvatar: z.ZodOptional<z.ZodString>;
+            }, "strip", z.ZodTypeAny, {
+                email?: string | undefined;
+                id?: string | undefined;
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            }, {
+                email?: string | undefined;
+                id?: string | undefined;
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            }>;
+        }>, "strip", z.ZodTypeAny, {
+            tags: string[];
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            author: {
+                email?: string | undefined;
+                id?: string | undefined;
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            uid?: string | undefined;
+            preview_image?: string | undefined;
+            preview_summary?: string | undefined;
+        }, {
+            tags: string[];
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            author: {
+                email?: string | undefined;
+                id?: string | undefined;
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            uid?: string | undefined;
+            preview_image?: string | undefined;
+            preview_summary?: string | undefined;
+        }>>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        language: {
+            id: string;
+            label: string;
+            isMaster: boolean;
+        };
+        title: string;
+        id: string;
+        custom_type_id: string;
+        group_lang_id: string;
+        versions: (({
+            status: "unclassified";
+        } | {
+            status: "published";
+        } | {
+            status: "release";
+            release_id: string;
+        } | {
+            status: "archived";
+        }) & {
+            tags: string[];
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            author: {
+                email?: string | undefined;
+                id?: string | undefined;
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            uid?: string | undefined;
+            preview_image?: string | undefined;
+            preview_summary?: string | undefined;
+        })[];
+        ai_abm_thread_id?: string | undefined;
+    }, {
+        language: {
+            id: string;
+            name: string;
+            is_master?: boolean | undefined;
+        };
+        id: string;
+        custom_type_id: string;
+        group_lang_id: string;
+        versions: (({
+            status: "unclassified";
+        } | {
+            status: "published";
+        } | {
+            status: "release";
+            release_id: string;
+        } | {
+            status: "archived";
+        }) & {
+            tags: string[];
+            version_id: string;
+            last_modified_date: Date;
+            custom_type_label: string;
+            author: {
+                email?: string | undefined;
+                id?: string | undefined;
+                first_name?: string | undefined;
+                last_name?: string | undefined;
+                uploadedAvatar?: string | undefined;
+            };
+            uid?: string | undefined;
+            preview_image?: string | undefined;
+            preview_summary?: string | undefined;
+        })[];
+        title?: string | null | undefined;
+        ai_abm_thread_id?: string | null | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
     results: {
         language: {
             id: string;
@@ -7746,14 +8754,13 @@ export declare function getDocumentListOptions(args: GetDocumentListArgs): impor
     }[];
     total: number;
     cursor?: string | undefined;
-}, Error, {
+}, {
     results: {
         language: {
             id: string;
-            label: string;
-            isMaster: boolean;
+            name: string;
+            is_master?: boolean | undefined;
         };
-        title: string;
         id: string;
         custom_type_id: string;
         group_lang_id: string;
@@ -7782,11 +8789,12 @@ export declare function getDocumentListOptions(args: GetDocumentListArgs): impor
             preview_image?: string | undefined;
             preview_summary?: string | undefined;
         })[];
-        ai_abm_thread_id?: string | undefined;
+        title?: string | null | undefined;
+        ai_abm_thread_id?: string | null | undefined;
     }[];
     total: number;
     cursor?: string | undefined;
-}, readonly ["documents", "list", GetDocumentListArgs]> & {
+}>>]> & {
     initialData?: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").L<{
         results: {
             language: {
@@ -7829,7 +8837,276 @@ export declare function getDocumentListOptions(args: GetDocumentListArgs): impor
         cursor?: string | undefined;
     }> | undefined;
 } & {
-    queryKey: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").E<readonly ["documents", "list", GetDocumentListArgs], {
+    queryKey: import("@tanstack/query-core/build/legacy/hydration-DTVzC0E7").E<readonly ["documents", "list", GetDocumentListArgs<z.ZodObject<{
+        total: z.ZodNumber;
+        cursor: z.ZodOptional<z.ZodString>;
+        results: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodEffects<z.ZodOptional<z.ZodNullable<z.ZodString>>, string, string | null | undefined>;
+            custom_type_id: z.ZodString;
+            group_lang_id: z.ZodString;
+            language: z.ZodEffects<z.ZodObject<{
+                id: z.ZodString;
+                name: z.ZodString;
+                is_master: z.ZodDefault<z.ZodBoolean>;
+            }, "strip", z.ZodTypeAny, {
+                id: string;
+                name: string;
+                is_master: boolean;
+            }, {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            }>, {
+                id: string;
+                label: string;
+                isMaster: boolean;
+            }, {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            }>;
+            ai_abm_thread_id: z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
+            versions: z.ZodArray<z.ZodIntersection<z.ZodDiscriminatedUnion<"status", [z.ZodObject<{
+                status: z.ZodLiteral<"unclassified">;
+            }, "strip", z.ZodTypeAny, {
+                status: "unclassified";
+            }, {
+                status: "unclassified";
+            }>, z.ZodObject<{
+                status: z.ZodLiteral<"published">;
+            }, "strip", z.ZodTypeAny, {
+                status: "published";
+            }, {
+                status: "published";
+            }>, z.ZodObject<{
+                status: z.ZodLiteral<"release">;
+                release_id: z.ZodString;
+            }, "strip", z.ZodTypeAny, {
+                status: "release";
+                release_id: string;
+            }, {
+                status: "release";
+                release_id: string;
+            }>, z.ZodObject<{
+                status: z.ZodLiteral<"archived">;
+            }, "strip", z.ZodTypeAny, {
+                status: "archived";
+            }, {
+                status: "archived";
+            }>]>, z.ZodObject<z.objectUtil.extendShape<{
+                version_id: z.ZodString;
+                tags: z.ZodArray<z.ZodString, "many">;
+                preview_image: z.ZodOptional<z.ZodString>;
+                last_modified_date: z.ZodDate;
+                uid: z.ZodOptional<z.ZodString>;
+            }, {
+                custom_type_label: z.ZodString;
+                preview_summary: z.ZodOptional<z.ZodString>;
+                author: z.ZodObject<{
+                    id: z.ZodOptional<z.ZodString>;
+                    first_name: z.ZodOptional<z.ZodString>;
+                    last_name: z.ZodOptional<z.ZodString>;
+                    email: z.ZodOptional<z.ZodString>;
+                    uploadedAvatar: z.ZodOptional<z.ZodString>;
+                }, "strip", z.ZodTypeAny, {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                }, {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                }>;
+            }>, "strip", z.ZodTypeAny, {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            }, {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            }>>, "many">;
+        }, "strip", z.ZodTypeAny, {
+            language: {
+                id: string;
+                label: string;
+                isMaster: boolean;
+            };
+            title: string;
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            ai_abm_thread_id?: string | undefined;
+        }, {
+            language: {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            };
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            title?: string | null | undefined;
+            ai_abm_thread_id?: string | null | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        results: {
+            language: {
+                id: string;
+                label: string;
+                isMaster: boolean;
+            };
+            title: string;
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            ai_abm_thread_id?: string | undefined;
+        }[];
+        total: number;
+        cursor?: string | undefined;
+    }, {
+        results: {
+            language: {
+                id: string;
+                name: string;
+                is_master?: boolean | undefined;
+            };
+            id: string;
+            custom_type_id: string;
+            group_lang_id: string;
+            versions: (({
+                status: "unclassified";
+            } | {
+                status: "published";
+            } | {
+                status: "release";
+                release_id: string;
+            } | {
+                status: "archived";
+            }) & {
+                tags: string[];
+                version_id: string;
+                last_modified_date: Date;
+                custom_type_label: string;
+                author: {
+                    email?: string | undefined;
+                    id?: string | undefined;
+                    first_name?: string | undefined;
+                    last_name?: string | undefined;
+                    uploadedAvatar?: string | undefined;
+                };
+                uid?: string | undefined;
+                preview_image?: string | undefined;
+                preview_summary?: string | undefined;
+            })[];
+            title?: string | null | undefined;
+            ai_abm_thread_id?: string | null | undefined;
+        }[];
+        total: number;
+        cursor?: string | undefined;
+    }>>], {
         results: {
             language: {
                 id: string;