@prismicio/editor-fields 0.4.49-alpha.feat-onboarding-guide.4 → 0.4.49-alpha.feat-onboarding-guide.5

package/dist/EditorConfig.d.ts

@@ -13,6 +13,9 @@ type MediaLibrary = {
     mediaLibrary: true;
     assetsApiBaseUrl: URL;
     repository: string;
+    coreApiBaseUrl: URL;
+    userServiceBaseUrl: URL;
+    mediaLibraryUploadersEnabled: boolean;
 };
 type UIDField = {
     uidField?: never;

package/dist/SectionEditor.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="react" />
 import { type Document } from "@prismicio/types-internal/lib/content";
 import type { StaticSection } from "@prismicio/types-internal/lib/customtypes";
-import type { Selection } from "./Selection";
+import type { SliceSelection } from "./SliceSelection";
 interface Props {
     id: string;
     readOnly: boolean;
-    selection?: Selection;
+    selection?: SliceSelection;
     section: StaticSection;
     content: Document;
     onContentChange: (content: Document) => void;

package/dist/SliceSelection.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="react" />
+export interface SliceSelection {
+    /**
+     * The keys of the slices that are currently selected.
+     */
+    ids: string[];
+    isSelected: (id: string) => boolean;
+    /**
+     * Update the current selection.
+     * @param args.requestedFrom Which Area of the app is requesting the change.
+     * This is useful to know how/whether to scroll to the matching selection in the other area.
+     */
+    update: (args: SliceSelectionUpdateArgs) => void;
+}
+export interface SliceSelectionUpdateArgs {
+    id: string;
+    requestedFrom: "all" | SliceSelectionArea;
+    shiftKey?: boolean;
+    metaKey?: boolean;
+    ids?: string[];
+}
+export type SliceSelectionArea = "sliceTable" | "sliceFieldSet";
+export declare function getSliceSelectionDOMId(area: SliceSelectionArea, id: string): string;
+export declare const SliceSelectionContext: import("react").Context<SliceSelection>;
+export declare function useSliceSelection(): SliceSelection;

package/dist/core/EditorErrorBoundary.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { type ErrorBoundaryProps } from "@prismicio/editor-ui";
+type EditorErrorBoundaryProps = Omit<ErrorBoundaryProps, "onReset">;
+export declare function EditorErrorBoundary(props: EditorErrorBoundaryProps): JSX.Element;
+export {};

package/dist/core/MediaLibrary/components/MediaLibraryContext.d.ts

@@ -32,6 +32,7 @@ interface MediaLibraryContextValue {
      * Possible to change using an `assetType` prop in MediaLibrary
      */
     initialAssetType: MediaAssetType;
+    uploaderId?: string;
     tagIds: string[];
     onFilterChange: (filters: Partial<MediaLibraryFilters>) => void;
     isSearchingMedia: boolean;

package/dist/core/MediaLibrary/components/{MediaLibraryAssetCount.d.ts → Toolbar/AssetCount.d.ts}

@@ -2,5 +2,5 @@
 interface Props {
     count: number;
 }
-export declare function MediaLibraryAssetCount(props: Props): JSX.Element;
+export declare function AssetCount(props: Props): JSX.Element;
 export {};

package/dist/core/MediaLibrary/components/Toolbar/Toolbar.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function Toolbar(): JSX.Element;

package/dist/core/MediaLibrary/components/Toolbar/filters/AssetTypeFilter.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function AssetTypeFilter(): JSX.Element;

package/dist/core/MediaLibrary/components/Toolbar/filters/TagsFilter.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function TagsFilter(): JSX.Element;

package/dist/core/MediaLibrary/components/Toolbar/filters/UploaderFilter.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare function UploaderFilter(): JSX.Element;

package/dist/core/MediaLibrary/components/Toolbar/filters/index.d.ts

@@ -0,0 +1,3 @@
+export { AssetTypeFilter } from "./AssetTypeFilter";
+export { TagsFilter } from "./TagsFilter";
+export { UploaderFilter } from "./UploaderFilter";

package/dist/core/MediaLibrary/components/Toolbar/index.d.ts

@@ -0,0 +1 @@
+export { Toolbar } from "./Toolbar";

package/dist/core/MediaLibrary/hooks/mediaLibraryData.d.ts

@@ -11,6 +11,7 @@ export declare const mediaAssetType: z.ZodObject<{
     last_modified: z.ZodNumber;
     url: z.ZodString;
     alt: z.ZodOptional<z.ZodString>;
+    uploader_id: z.ZodOptional<z.ZodString>;
     size: z.ZodNumber;
     notes: z.ZodOptional<z.ZodString>;
     credits: z.ZodOptional<z.ZodString>;
@@ -71,6 +72,7 @@ export declare const mediaAssetType: z.ZodObject<{
     width?: number | undefined;
     height?: number | undefined;
     alt?: string | undefined;
+    uploader_id?: string | undefined;
     notes?: string | undefined;
     credits?: string | undefined;
     search_highlight?: {
@@ -98,6 +100,7 @@ export declare const mediaAssetType: z.ZodObject<{
     width?: number | undefined;
     height?: number | undefined;
     alt?: string | undefined;
+    uploader_id?: string | undefined;
     notes?: string | undefined;
     credits?: string | undefined;
     search_highlight?: {
@@ -123,6 +126,7 @@ export declare const mediaSearchResponse: z.ZodObject<{
         last_modified: z.ZodNumber;
         url: z.ZodString;
         alt: z.ZodOptional<z.ZodString>;
+        uploader_id: z.ZodOptional<z.ZodString>;
         size: z.ZodNumber;
         notes: z.ZodOptional<z.ZodString>;
         credits: z.ZodOptional<z.ZodString>;
@@ -183,6 +187,7 @@ export declare const mediaSearchResponse: z.ZodObject<{
         width?: number | undefined;
         height?: number | undefined;
         alt?: string | undefined;
+        uploader_id?: string | undefined;
         notes?: string | undefined;
         credits?: string | undefined;
         search_highlight?: {
@@ -210,6 +215,7 @@ export declare const mediaSearchResponse: z.ZodObject<{
         width?: number | undefined;
         height?: number | undefined;
         alt?: string | undefined;
+        uploader_id?: string | undefined;
         notes?: string | undefined;
         credits?: string | undefined;
         search_highlight?: {
@@ -240,6 +246,7 @@ export declare const mediaSearchResponse: z.ZodObject<{
         width?: number | undefined;
         height?: number | undefined;
         alt?: string | undefined;
+        uploader_id?: string | undefined;
         notes?: string | undefined;
         credits?: string | undefined;
         search_highlight?: {
@@ -271,6 +278,7 @@ export declare const mediaSearchResponse: z.ZodObject<{
         width?: number | undefined;
         height?: number | undefined;
         alt?: string | undefined;
+        uploader_id?: string | undefined;
         notes?: string | undefined;
         credits?: string | undefined;
         search_highlight?: {
@@ -291,12 +299,13 @@ export interface ExternalImage {
     alt?: string;
 }
 export type MediaAssetOrExternalImage = MediaAsset | ExternalImage;
-export declare function searchMedia(baseUrl: URL | undefined, repository: string, authStrategy: AuthStrategy, assetType: MediaAssetType, keyword: string, tags: string, page: number, cursor?: string): Promise<{
+export declare function searchMedia(baseUrl: URL | undefined, repository: string, authStrategy: AuthStrategy, keyword: string, assetType: MediaAssetType, uploaderId: string | undefined, tags: string, page: number, cursor?: string): Promise<{
     time: string;
-    assetType: MediaAssetType;
     keyword: string;
-    page: number;
+    assetType: MediaAssetType;
+    uploaderId: string | undefined;
     tags: string;
+    page: number;
     total: number;
     items: {
         tags: {
@@ -317,6 +326,7 @@ export declare function searchMedia(baseUrl: URL | undefined, repository: string
         width?: number | undefined;
         height?: number | undefined;
         alt?: string | undefined;
+        uploader_id?: string | undefined;
         notes?: string | undefined;
         credits?: string | undefined;
         search_highlight?: {
@@ -335,12 +345,14 @@ interface UseMediaLibrarySearchArgs {
 export interface MediaLibraryFilters {
     keyword: string;
     assetType: MediaAssetType;
+    uploaderId?: string;
     tagIds: string[];
 }
 export declare const defaultMediaLibraryFilters: MediaLibraryFilters;
 export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
     keyword: string;
     assetType: MediaAssetType;
+    uploaderId: string | undefined;
     tagIds: string[];
     setFilters: (filters: Partial<MediaLibraryFilters>) => void;
     resetFilters: () => void;
@@ -363,6 +375,7 @@ export declare function useMediaSearch(args: UseMediaLibrarySearchArgs): {
         width?: number | undefined;
         height?: number | undefined;
         alt?: string | undefined;
+        uploader_id?: string | undefined;
         notes?: string | undefined;
         credits?: string | undefined;
         search_highlight?: {
@@ -393,7 +406,7 @@ declare function updateMedia(newFiles: {
 declare function deleteMedia(mediaIds: string[]): void;
 declare function deleteSearchData(args: MediaLibraryFilters): void;
 type MediaPage = Awaited<ReturnType<typeof searchMedia>>;
-export declare function getMedia(allPages: MediaPage[], assetType: MediaAssetType, keyword: string, tags: string): {
+export declare function getMedia(allPages: MediaPage[], keyword: string, assetType: MediaAssetType, uploaderId: string | undefined, tags: string): {
     tags: {
         id: string;
         name: string;
@@ -412,6 +425,7 @@ export declare function getMedia(allPages: MediaPage[], assetType: MediaAssetTyp
     width?: number | undefined;
     height?: number | undefined;
     alt?: string | undefined;
+    uploader_id?: string | undefined;
     notes?: string | undefined;
     credits?: string | undefined;
     search_highlight?: {
@@ -432,6 +446,7 @@ interface RevalidateFirstPageArgs {
     config: EditorConfig;
     keyword?: string;
     assetType?: MediaAssetType;
+    uploaderId?: string;
     tagIds?: string[];
 }
 /**
@@ -453,8 +468,9 @@ export interface SearchMediaArgs {
     assetsApiBaseUrl: URL | undefined;
     repository: string;
     authStrategy: AuthStrategy;
-    assetType: MediaAssetType;
     keyword: string;
+    assetType: MediaAssetType;
+    uploaderId?: string;
     tagIds: string[];
     page: number;
     cursor?: string;

package/dist/core/MediaLibrary/hooks/uploadersData.d.ts

@@ -0,0 +1,30 @@
+import { z } from "zod";
+export declare function useUploaders(): {
+    uploaders: {
+        id: string;
+        name: string;
+        firstName: string;
+        lastName: string;
+        email: string;
+        uploadedAvatar: string | undefined;
+    }[];
+    uploadersById: Map<string, {
+        id: string;
+        name: string;
+        firstName: string;
+        lastName: string;
+        email: string;
+        uploadedAvatar: string | undefined;
+    }>;
+};
+export declare const uploaderSchema: z.ZodObject<{
+    id: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+}, {
+    id: string;
+}>;
+export type Uploader = z.TypeOf<typeof uploaderSchema>;
+type UpdateUploadersFunction = (currentItems: Uploader[]) => Uploader[] | undefined;
+export declare function updateUploadersCache(updateFunction: UpdateUploadersFunction): void;
+export {};

package/dist/core/MediaLibrary/hooks/useMediaLibraryCacheInvalidation.d.ts

@@ -6,6 +6,7 @@ interface UseMediaLibraryCacheInvalidationArgs {
     config: EditorConfig;
     keyword: string;
     assetType: MediaAssetType;
+    uploaderId?: string;
     tagIds: string[];
 }
 export declare function useMediaLibraryCacheInvalidation(args: UseMediaLibraryCacheInvalidationArgs): {

package/dist/core/MediaLibrary/hooks/useSelectedMedia.d.ts

@@ -17,6 +17,7 @@ export declare function useSelectedMedia(): {
     width?: number | undefined;
     height?: number | undefined;
     alt?: string | undefined;
+    uploader_id?: string | undefined;
     notes?: string | undefined;
     credits?: string | undefined;
     search_highlight?: {

package/dist/core/OnboardingGuide/OnboardingGuide.d.ts

@@ -1,6 +1,8 @@
 /// <reference types="react" />
-import type { OnboardingCardVariant, OnboardingFramework, OnboardingState, OnboardingStepId, OnboardingTrackFn } from "./types";
+import { type EditorConfig } from "../../EditorConfig";
+import type { OnboardingCardVariant, OnboardingTrackingFn } from "./types";
 interface OnboardingGuideProps {
+    config: EditorConfig;
     /**
      * Whether the whole guide (including 'Get started' button) should be visible
      *
@@ -13,41 +15,10 @@ interface OnboardingGuideProps {
      * @default "default"
      */
     variant?: OnboardingCardVariant;
-    /**
-     * The framework the user is using
-     *
-     * Used to display a link to the appropriate tutorial
-     * @default "other"
-     */
-    framework?: OnboardingFramework;
-    /**
-     * Function to track onboarding events
-     *
-     *  - onboarding:step-completed,
-     *  - onboarding:step-opened,
-     *  - onboarding:guide-completed
-     * */
-    track: OnboardingTrackFn;
-    /**
-     * Fetches the current onboarding state
-     *
-     * @returns {OnboardingState}
-     */
-    fetchState: () => Promise<OnboardingState>;
-    /**
-     * Updates the onboarding steps progress state
-     *
-     * @param {OnboardingStepId[]} stepId
-     */
-    toggleStep: (stepId: OnboardingStepId) => Promise<OnboardingStepId[]>;
-    /**
-     * Updates the onboarding guide state to completed
-     *
-     * @returns {boolean}
-     */
-    resolveGuide: () => Promise<{
-        isResolved: boolean;
-    }>;
+    /** Link to the video tutorials */
+    tutorialLink?: string;
+    /** Function to track onboarding events */
+    trackingFn: OnboardingTrackingFn;
 }
 export declare function OnboardingGuide(props: OnboardingGuideProps): JSX.Element;
 export {};

package/dist/core/OnboardingGuide/components/OnboardingCard.d.ts

@@ -1,5 +1,8 @@
 /// <reference types="react" />
+import type { OnboardingCardVariant } from "../types";
 interface OnboardingCardProps {
+    variant: OnboardingCardVariant;
+    tutorialLink?: string;
     onClose?: () => void;
 }
 export declare function OnboardingCard(props: OnboardingCardProps): JSX.Element;

package/dist/core/OnboardingGuide/components/OnboardingProvider.d.ts

@@ -1,26 +1,20 @@
 import { type ReactNode } from "react";
-import { type OnboardingCardVariant, type OnboardingFramework, type OnboardingState, type OnboardingStep, type OnboardingStepId, type OnboardingTrackFn } from "../types";
-interface OnboardingProviderProps {
-    children: ReactNode;
-    variant: OnboardingCardVariant;
-    framework: OnboardingFramework;
-    onComplete?: () => void;
-    track: OnboardingTrackFn;
-    fetchState: () => Promise<OnboardingState>;
-    toggleStep: (stepId: OnboardingStepId) => Promise<OnboardingStepId[]>;
-}
-export declare function OnboardingProvider(props: OnboardingProviderProps): JSX.Element;
+import { type OnboardingCardVariant, type OnboardingStep, type OnboardingStepId, type OnboardingTrackingFn } from "../types";
 interface OnboardingContext {
     steps: OnboardingStep[];
-    completedStepsCount: number;
-    variant: OnboardingCardVariant;
-    tutorialLink?: string;
-    isResolved?: boolean;
+    completedStepCount: number;
     toggleStepComplete: (step: OnboardingStep) => void;
     getStepIndex: (step: OnboardingStepId) => number;
     isStepComplete: (step: OnboardingStep) => boolean;
-    track: OnboardingTrackFn;
+    trackingFn: OnboardingTrackingFn;
 }
 declare const OnboardingContext: import("react").Context<OnboardingContext | undefined>;
+interface OnboardingProviderProps {
+    children: ReactNode;
+    variant: OnboardingCardVariant;
+    onComplete?: () => void;
+    trackingFn: OnboardingTrackingFn;
+}
+export declare function OnboardingProvider(props: OnboardingProviderProps): JSX.Element;
 export declare const useOnboardingContext: () => OnboardingContext;
 export {};

package/dist/core/OnboardingGuide/content.d.ts

@@ -1,4 +1,3 @@
-import type { OnboardingFramework, OnboardingStep } from "./types";
+import type { OnboardingStep } from "./types";
 export declare const onboardingSteps: OnboardingStep[];
 export declare const onboardingExperimentSteps: OnboardingStep[];
-export declare const tutorialLinks: Record<OnboardingFramework, string>;

package/dist/core/OnboardingGuide/index.d.ts

@@ -1,2 +1 @@
 export { OnboardingGuide } from "./OnboardingGuide";
-export type { OnboardingState, OnboardingStepId } from "./types";

package/dist/core/OnboardingGuide/types.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { z } from "zod";
-declare const onboardingStepStatusesSchema: z.ZodObject<{
-    createProject: z.ZodBoolean;
+export declare const onboardingStepStatusesSchema: z.ZodObject<{
+    createProject: z.ZodLiteral<true>;
     createPageType: z.ZodBoolean;
     codePage: z.ZodBoolean;
     createSlice: z.ZodBoolean;
@@ -9,7 +9,7 @@ declare const onboardingStepStatusesSchema: z.ZodObject<{
     createContent: z.ZodBoolean;
     renderPage: z.ZodBoolean;
 }, "strip", z.ZodTypeAny, {
-    createProject: boolean;
+    createProject: true;
     createPageType: boolean;
     codePage: boolean;
     createSlice: boolean;
@@ -17,7 +17,7 @@ declare const onboardingStepStatusesSchema: z.ZodObject<{
     createContent: boolean;
     renderPage: boolean;
 }, {
-    createProject: boolean;
+    createProject: true;
     createPageType: boolean;
     codePage: boolean;
     createSlice: boolean;
@@ -25,7 +25,7 @@ declare const onboardingStepStatusesSchema: z.ZodObject<{
     createContent: boolean;
     renderPage: boolean;
 }>;
-type OnboardingStepStatuses = z.infer<typeof onboardingStepStatusesSchema>;
+export type OnboardingStepStatuses = z.infer<typeof onboardingStepStatusesSchema>;
 export type OnboardingStepId = keyof OnboardingStepStatuses;
 export interface OnboardingStep {
     id: OnboardingStepId;
@@ -35,22 +35,5 @@ export interface OnboardingStep {
     videoUrl?: string;
     defaultCompleted?: boolean;
 }
-export type OnboardingState = {
-    completedSteps: OnboardingStepId[];
-    isResolved: boolean;
-};
 export type OnboardingCardVariant = "default" | "light" | "dark";
-export type OnboardingFramework = "next" | "nuxt" | "sveltekit" | "other";
-export type OnboardingTrackEvent = {
-    event: "onboarding:step-completed";
-    stepId: OnboardingStepId;
-    stepTitle: string;
-} | {
-    event: "onboarding:step-opened";
-    stepId: OnboardingStepId;
-    stepTitle: string;
-} | {
-    event: "onboarding:completed";
-};
-export type OnboardingTrackFn = (args: OnboardingTrackEvent) => void;
-export {};
+export type OnboardingTrackingFn = (args: Record<string, string>) => void;

package/dist/core/SelectionManager/SelectionManagerTypes.d.ts

@@ -57,21 +57,22 @@ export type SelectionManager = {
      * Gets the current selection state. This is used when performing any action with the selection.
      * @returns The selection state object.
      */
-    getSelectionState: () => {
-        selectedIds: ID[];
-        excludedIds: ID[];
-        isAllSelected: boolean;
-        selectedCount: number;
-    };
+    getSelectionState: () => SelectionState;
     /**
      * Count of selected items.
      */
     selectedCount: number;
     totalItemCount: number;
     isSelectAllEnabled: boolean;
-    state: CoreSelectionState;
+    state: SelectionManagerState;
 };
-export interface CoreSelectionState {
+interface SelectionState {
+    selectedIds: ID[];
+    excludedIds: ID[];
+    isAllSelected: boolean;
+    selectedCount: number;
+}
+export interface SelectionManagerState {
     /**
      * Set of selected IDs.
      */
@@ -86,8 +87,10 @@ export interface CoreSelectionState {
     isAllSelected: boolean;
 }
 export interface SelectionManagerProviderProps extends PropsWithChildren {
+    initialState?: Partial<SelectionManagerState>;
     initialTotalItemCount?: number;
     isSelectAllEnabled?: boolean;
 }
-export type UseSelectionManager = Omit<SelectionManager, "registerListener" | "setTotalItemCount" | "totalItemCount" | "state"> & Pick<CoreSelectionState, "isAllSelected">;
-export type SelectionStateListener = (state: ReturnType<SelectionManager["getSelectionState"]>) => void;
+export type UseSelectionManager = Omit<SelectionManager, "setTotalItemCount" | "totalItemCount" | "state"> & Pick<SelectionManagerState, "isAllSelected">;
+export type SelectionStateListener = (state: SelectionState) => void;
+export {};

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

@@ -1,3 +1,4 @@
+import type { QueryClient } from "@tanstack/react-query";
 import { z } from "zod";
 import type { AuthStrategy } from "../../EditorConfig";
 export declare const languageOkType: z.ZodObject<{
@@ -248,7 +249,7 @@ export declare const documentMetaOkType: z.ZodObject<{
     })[];
     title?: string | null | undefined;
 }>;
-declare const documentsSearchAPISchemaOkType: z.ZodObject<{
+declare const getDocumentListSchema: z.ZodObject<{
     total: z.ZodNumber;
     cursor: z.ZodOptional<z.ZodString>;
     results: z.ZodArray<z.ZodObject<{
@@ -519,12 +520,28 @@ declare const documentsFullTextSearchAPISchemaOkType: z.ZodObject<{
     }, z.ZodTypeAny, "passthrough">[];
 }>;
 export type Language = z.TypeOf<typeof languageOkType>;
-export type GetsDocumentApi = z.TypeOf<typeof documentsSearchAPISchemaOkType>;
+export type GetDocumentListSchema = z.TypeOf<typeof getDocumentListSchema>;
 export type DocumentFullTextSearchApi = z.TypeOf<typeof documentsFullTextSearchAPISchemaOkType>;
 export type DocumentMeta = z.TypeOf<typeof documentMetaOkType>;
 export type DocumentVersion = z.TypeOf<typeof documentVersionOkType>;
 export type DocumentStatus = DocumentVersion["status"];
-export declare function getDocuments(baseUrl: URL, authStrategy: AuthStrategy, queryString: string, limit?: number, cursor?: string): Promise<GetsDocumentApi>;
+export declare function getDocuments(baseUrl: URL, authStrategy: AuthStrategy, queryString: string, limit?: number, cursor?: string): Promise<GetDocumentListSchema>;
+export interface GetDocumentListArgs {
+    baseUrl: URL;
+    authStrategy: AuthStrategy;
+    signal?: AbortSignal | null | undefined;
+    limit?: number;
+    cursor?: string;
+    status?: string[];
+    authors?: string[];
+    language?: string;
+    group_lang_id?: string;
+    document_id?: string[];
+    customTypes?: string[];
+    tags?: string[];
+    term?: string;
+}
+export declare function getDocumentList(args: GetDocumentListArgs): Promise<GetDocumentListSchema>;
 export declare function searchFullTextDocuments(baseUrl: URL, authStrategy: AuthStrategy, queryString: string, options?: Pick<RequestInit, "signal">): Promise<DocumentFullTextSearchApi>;
 export declare function makeSearchFullTextDocumentsQueryString(args: {
     repository: string;
@@ -539,10 +556,9 @@ export type SearchDocumentParams = {
 };
 export declare function createSearchParams<T extends string>(params: {
     name: T;
-    values: string[];
+    values: (string | undefined)[];
 }[]): [string, string][];
 export declare function getDocumentByDocumentId(baseUrl: URL, authStrategy: AuthStrategy, id: string): Promise<DocumentMeta>;
-export declare function getDocumentsById(baseUrl: URL, authStrategy: AuthStrategy, ids: string[]): Promise<GetsDocumentApi>;
 export declare const documentSchema: z.ZodEffects<z.ZodType<unknown, z.ZodTypeDef, unknown>, {
     [x: string]: import("@prismicio/types-internal/lib/content").GroupContent | {
         type: string;
@@ -2650,7 +2666,9 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
                         } & {
                             date?: string | null | undefined;
                         }) | ({
-                            id: string;
+                            id: string; /**
+                             * Returns updated document or undefined if document should be removed
+                             */
                             url: string;
                             name: string;
                             kind: string;
@@ -4035,4 +4053,17 @@ export declare const sliceItemContentSchema: z.ZodEffects<z.ZodUnknown, {
         __TYPE__: "SeparatorContent";
     };
 }, unknown>;
+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 {};

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

@@ -1,3 +1,4 @@
 export * from "./customType";
 export * from "./document";
 export * from "./repository";
+export * from "./user";