@strapi/content-manager 0.0.0-experimental.d594270d189417b9207db1acd922f30792487dfe → 0.0.0-experimental.d5e2ac04fc211c528d0d69acd705f180e404f04a

package/dist/admin/src/features/DocumentContext.d.ts

@@ -1,53 +0,0 @@
-import * as React from 'react';
-import { type UseDocument } from '../hooks/useDocument';
-interface DocumentMeta {
-    /**
-     * The equivalent of the ":id" url param value
-     * i.e. gus5a67jcboa3o2zjnz39mb1
-     */
-    documentId: string;
-    /**
-     * The equivalent of the url ":slug" param value
-     * i.e. api::articles.article
-     */
-    model: string;
-    /**
-     * The equivalent of the url ":collectionType" param value
-     * i.e. collection-types or single-types
-     */
-    collectionType: string;
-    /**
-     * Query params object
-     * i.e. { locale: 'fr' }
-     */
-    params?: Record<string, string | string[] | null>;
-}
-interface DocumentContextValue {
-    rootDocumentMeta: DocumentMeta;
-    document: ReturnType<UseDocument>;
-    meta: DocumentMeta;
-    changeDocument: (newRelation: DocumentMeta) => void;
-    documentHistory: DocumentMeta[];
-    setDocumentHistory: React.Dispatch<React.SetStateAction<DocumentMeta[]>>;
-    onPreview?: () => void;
-}
-declare const useDocumentContext: <Selected>(consumerName: string, selector: (value: DocumentContextValue) => Selected) => Selected;
-/**
- * TODO: Document in contributor docs, Add unit test
- *
- * This context provider and its associated hook are used to access a document at its root level
- * and expose a function to change the current document being viewed to one of the root level docuemnt's relations.
- *
- * The useDocumentContext hook exposes:
- * - meta: information about the currentDocument,
- * - document: the actual document,
- * - changeDocument: a function to change the current document to one of its relations.
- * - rootDocumentMeta: information about the root level document (current page)
- */
-declare const DocumentContextProvider: ({ children, initialDocument, onPreview, }: {
-    children: React.ReactNode | React.ReactNode[];
-    initialDocument: DocumentMeta;
-    onPreview?: () => void;
-}) => import("react/jsx-runtime").JSX.Element;
-export { useDocumentContext, DocumentContextProvider };
-export type { DocumentMeta };