@portabletext/plugin-sdk-value 7.2.1 → 7.2.3

package/dist/index.d.ts

@@ -1,142 +1,76 @@
-import {DocumentHandle} from '@sanity/sdk-react'
-import type {EditorSelection} from '@portabletext/editor'
-import {JSX} from 'react'
-import {Patch} from '@portabletext/editor'
-import {PortableTextBlock} from '@portabletext/editor'
-import {PortableTextEditableProps} from '@portabletext/editor'
-import {PropsWithChildren} from 'react'
-import type {RangeDecoration} from '@portabletext/editor'
-import {ReactElement} from 'react'
-import {usePresenceForDocument} from '@sanity/sdk-react'
-
+import { DocumentHandle, usePresenceForDocument } from "@sanity/sdk-react";
+import { PropsWithChildren, ReactElement } from "react";
+import { EditorSelection, Patch, PortableTextBlock, PortableTextEditableProps, RangeDecoration } from "@portabletext/editor";
+import "@portabletext/patches";
+import "@sanity/diff-patch";
 /**
  * `@sanity/sdk-react` exports the presence hooks and their option types but not
  * the presence data types, so these are derived from what it does export.
  */
-declare type DocumentPresence = ReturnType<
-  typeof usePresenceForDocument
->['presence'][number]
-
+type DocumentPresence = ReturnType<typeof usePresenceForDocument>['presence'][number];
 /**
  * Draws one remote participant's caret. This package has no opinion about how a
  * caret looks, so it is the caller's to provide.
  *
  * @public
  */
-export declare type RenderCursorFunction = (
-  cursor: SDKRemoteCursor,
-) => (props: PropsWithChildren) => ReactElement
-
+type RenderCursorFunction = (cursor: SDKRemoteCursor) => (props: PropsWithChildren) => ReactElement;
 /**
- * A `PortableTextEditable` wired to a Sanity document: the field's value syncs
- * both ways, the local user's caret is reported, and other people's carets are
- * drawn.
- *
- * Place it inside `EditorProvider` in place of `PortableTextEditable`. Every
- * other prop is forwarded untouched, and `rangeDecorations` you pass are kept
- * and merged with the presence carets rather than replaced.
- *
- * Nothing else is needed: this replaces a separate `SDKValuePlugin`.
- *
- * @example
- * ```tsx
- * <EditorProvider initialConfig={{schemaDefinition}}>
- *   <SDKPortableTextEditable
- *     {...documentHandle}
- *     path="content"
- *     renderCursor={({user}) => (props) => (
- *       <Caret user={user}>{props.children}</Caret>
- *     )}
- *   />
- * </EditorProvider>
- * ```
+ * A remote participant's caret, together with who they are.
  *
- * @public
- */
-export declare function SDKPortableTextEditable(
-  props: SDKPortableTextEditableProps,
-): JSX.Element
-
-/**
- * Props for {@link SDKPortableTextEditable}.
+ * Declared in full rather than extending the internal cursor type, so nothing in
+ * the public API refers to a type consumers cannot import.
  *
  * @public
  */
-export declare interface SDKPortableTextEditableProps
-  extends
-    DocumentHandle,
-    Omit<PortableTextEditableProps, keyof DocumentHandle> {
+interface SDKRemoteCursor {
   /**
-   * The document path of the Portable Text field, for example `content`.
+   * Identifies one editing session rather than one person. The same user in two
+   * tabs reports two sessions and therefore draws two carets.
    */
-  path: string
+  sessionId: string;
   /**
-   * Draws one remote participant's caret. Omit it for the built-in caret, which
-   * needs no styling of your own. Pass `null` to draw no carets at all while
-   * still reporting the local user's presence.
+   * Where the participant last reported their selection.
    */
-  renderCursor?: RenderCursorFunction | null
+  selection: EditorSelection;
+  user: DocumentPresence['user'];
 }
-
-/**
- * Reports the local user's caret in a Portable Text field, so other people in
- * the same document can see where they are.
- *
- * Place it inside `EditorProvider`. Prefer `SDKPortableTextEditable`, which
- * reports and draws in one component; reach for this when you render
- * `PortableTextEditable` yourself.
- *
- * Which document is reported follows the handle's perspective, or the ambient
- * one from `ResourceProvider`. Pass the plain document id and let the
- * perspective select the draft, the published document, or a release version.
- *
- * @public
- */
-export declare function SDKPresencePlugin(props: SDKPresencePluginProps): null
-
 /**
  * Props for {@link SDKPresencePlugin}.
  *
  * @public
  */
-export declare interface SDKPresencePluginProps extends DocumentHandle {
+interface SDKPresencePluginProps extends DocumentHandle {
   /**
    * The document path of the Portable Text field, for example `content`. The
    * same form `SDKValuePlugin` takes.
    */
-  path: string
+  path: string;
 }
-
 /**
- * A remote participant's caret, together with who they are.
- *
- * Declared in full rather than extending the internal cursor type, so nothing in
- * the public API refers to a type consumers cannot import.
+ * Options for {@link useSDKPresenceCursors}.
  *
  * @public
  */
-export declare interface SDKRemoteCursor {
-  /**
-   * Identifies one editing session rather than one person. The same user in two
-   * tabs reports two sessions and therefore draws two carets.
-   */
-  sessionId: string
-  /**
-   * Where the participant last reported their selection.
-   */
-  selection: EditorSelection
-  user: DocumentPresence['user']
+interface UseSDKPresenceCursorsOptions extends DocumentHandle {
+  path: string;
+  renderCursor: RenderCursorFunction;
 }
-
 /**
+ * Reports the local user's caret in a Portable Text field, so other people in
+ * the same document can see where they are.
+ *
+ * Place it inside `EditorProvider`. Prefer `SDKPortableTextEditable`, which
+ * reports and draws in one component; reach for this when you render
+ * `PortableTextEditable` yourself.
+ *
+ * Which document is reported follows the handle's perspective, or the ambient
+ * one from `ResourceProvider`. Pass the plain document id and let the
+ * perspective select the draft, the published document, or a release version.
+ *
  * @public
  */
-export declare function SDKValuePlugin(props: SDKValuePluginProps): JSX.Element
-
-declare interface SDKValuePluginProps extends DocumentHandle {
-  path: string
-}
-
+declare function SDKPresencePlugin(props: SDKPresencePluginProps): null;
 /**
  * Other people's carets in a Portable Text field, as range decorations.
  *
@@ -151,27 +85,21 @@ declare interface SDKValuePluginProps extends DocumentHandle {
  *
  * @public
  */
-export declare function useSDKPresenceCursors(
-  options: UseSDKPresenceCursorsOptions,
-): RangeDecoration[]
-
+declare function useSDKPresenceCursors(options: UseSDKPresenceCursorsOptions): RangeDecoration[];
+interface SDKValuePluginProps extends DocumentHandle {
+  path: string;
+}
 /**
- * Options for {@link useSDKPresenceCursors}.
- *
  * @public
  */
-export declare interface UseSDKPresenceCursorsOptions extends DocumentHandle {
-  path: string
-  renderCursor: RenderCursorFunction
-}
-
+declare function SDKValuePlugin(props: SDKValuePluginProps): import("react").JSX.Element;
 /**
  * @internal
  */
-declare type ValueSyncConfig = {
-  getRemoteValue: () => PortableTextBlock[] | null | undefined
-  pushValue: (value: PortableTextBlock[]) => void
-  onRemoteValueChange: (callback: () => void) => () => void
+type ValueSyncConfig = {
+  getRemoteValue: () => PortableTextBlock[] | null | undefined;
+  pushValue: (value: PortableTextBlock[]) => void;
+  onRemoteValueChange: (callback: () => void) => () => void;
   /**
    * Optional patch channel. When provided, operational patches from other
    * clients are applied directly to the editor (in every state) instead of
@@ -179,17 +107,14 @@ declare type ValueSyncConfig = {
    * through `pushPatches`. The whole-value sync remains as a fallback for
    * anything the patch channel cannot express.
    */
-  onRemotePatches?: (
-    callback: (patches: Patch[]) => void,
-  ) => (() => void) | undefined
+  onRemotePatches?: (callback: (patches: Patch[]) => void) => (() => void) | undefined;
   /**
    * Pushes the editor's own operational patches to the remote store. May
    * throw when a patch cannot be converted, in which case the plugin falls
    * back to pushing the whole value.
    */
-  pushPatches?: (patches: Patch[]) => void
-}
-
+  pushPatches?: (patches: Patch[]) => void;
+};
 /**
  * NOTE: You are probably looking for SDKValuePlugin instead of this.
  * This is a lower-level plugin that only handles syncing the value
@@ -200,6 +125,50 @@ declare type ValueSyncConfig = {
  *
  * @internal
  */
-export declare function ValueSyncPlugin(props: ValueSyncConfig): null
-
-export {}
+declare function ValueSyncPlugin(props: ValueSyncConfig): null;
+/**
+ * Props for {@link SDKPortableTextEditable}.
+ *
+ * @public
+ */
+interface SDKPortableTextEditableProps extends DocumentHandle, Omit<PortableTextEditableProps, keyof DocumentHandle> {
+  /**
+   * The document path of the Portable Text field, for example `content`.
+   */
+  path: string;
+  /**
+   * Draws one remote participant's caret. Omit it for the built-in caret, which
+   * needs no styling of your own. Pass `null` to draw no carets at all while
+   * still reporting the local user's presence.
+   */
+  renderCursor?: RenderCursorFunction | null;
+}
+/**
+ * A `PortableTextEditable` wired to a Sanity document: the field's value syncs
+ * both ways, the local user's caret is reported, and other people's carets are
+ * drawn.
+ *
+ * Place it inside `EditorProvider` in place of `PortableTextEditable`. Every
+ * other prop is forwarded untouched, and `rangeDecorations` you pass are kept
+ * and merged with the presence carets rather than replaced.
+ *
+ * Nothing else is needed: this replaces a separate `SDKValuePlugin`.
+ *
+ * @example
+ * ```tsx
+ * <EditorProvider initialConfig={{schemaDefinition}}>
+ *   <SDKPortableTextEditable
+ *     {...documentHandle}
+ *     path="content"
+ *     renderCursor={({user}) => (props) => (
+ *       <Caret user={user}>{props.children}</Caret>
+ *     )}
+ *   />
+ * </EditorProvider>
+ * ```
+ *
+ * @public
+ */
+declare function SDKPortableTextEditable(props: SDKPortableTextEditableProps): import("react").JSX.Element;
+export { type RenderCursorFunction, SDKPortableTextEditable, type SDKPortableTextEditableProps, SDKPresencePlugin, type SDKPresencePluginProps, type SDKRemoteCursor, SDKValuePlugin, type UseSDKPresenceCursorsOptions, ValueSyncPlugin, useSDKPresenceCursors };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/plugin.sdk-presence.tsx","../src/plugin.sdk-value.tsx","../src/sdk-editable.tsx"],"mappings":";;;;;;;;;KAeK,mBAAmB,kBACf;;;;;;;KASG,wBACV,QAAQ,qBACJ,OAAO,sBAAsB;;;;;;;;;UAUlB;;;;;EAKf;;;;EAIA,WAAW;EACX,MAAM;;;;;;;UAQS,+BAA+B;;;;;EAK9C;;;;;;;UAQe,qCAAqC;EACpD;EACA,cAAc;;;;;;;;;;;;;;;;iBAiBA,kBAAkB,OAAO;;;;;;;;;;;;;;;iBAwBzB,sBACd,SAAS,+BACR;UC48BO,4BAA4B;EACpC;;;;;iBAqCc,eAAe,OAAO,sCAAmB,IAAA;;;;KAiFpD;EACH,sBAAsB;EACtB,YAAY,OAAO;EACnB,sBAAsB;;;;;;;;EAQtB,mBACE,WAAW,SAAS;;;;;;EAOtB,eAAe,SAAS;;;;;;;;;;;;iBAaV,gBAAgB,OAAO;;;;;;UChsCtB,qCAEb,gBAGA,KAAK,iCAAiC;;;;EAIxC;;;;;;EAMA,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA6CD,wBAAwB,OAAO,+CAA4B,IAAA"}