@select-org/select-post-builder 1.1.46 → 1.1.48

package/dist/index.d.ts

@@ -4,6 +4,21 @@ import { JSONContent as JSONContent_2 } from '@tiptap/core';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 import { ReactNode } from 'react';
 
+/**
+ * Walks the editor JSON and updates the media node whose `attrs.uid === itemKey`
+ * with the hosted URL + payload from a resolved upload result. Returns a new
+ * doc; never mutates the input. If no matching node is found, returns the input.
+ */
+export declare function applyResolvedMediaItem(jsonBody: JSONContent_2 | undefined, itemKey: string, resolvedItem: ResolvedMediaItem): JSONContent_2 | undefined;
+
+/**
+ * Walks a serialized htmlBody string, finds the `[data-media][data-uid=itemKey]`
+ * wrapper and rewrites it to point at the hosted URL + payload from a resolved
+ * upload result. Mirrors `applyResolvedMediaItem` for the JSON form. If no
+ * matching node is found, returns the input unchanged.
+ */
+export declare function applyResolvedMediaItemToHtml(html: string | undefined, itemKey: string, resolvedItem: ResolvedMediaItem_2): string | undefined;
+
 declare type AppUserPayload = {
     background: string;
     username: string;
@@ -39,16 +54,21 @@ declare type BaseProps = {
     hideGroupSelector?: boolean;
     isSubmitting?: boolean;
     clearOnSuccess?: boolean;
-    onCreatePost: (params: {
-        payload: Partial<PostCreationData>;
-        html: string;
-        json: JSONContent;
-        text: string;
-    }) => void;
+    onCreatePost: (params: CreatePostCallbackPayload) => void;
     onVoiceComment?: (params: {
         voiceUrl: string;
         voiceTime: number;
     }) => void;
+    /**
+     * Optional voice handoff for hosts that want to upload voice in their
+     * own pipeline. When provided AND `allowSendWhileUploading` is on, the
+     * comments-toolbar emits the recorded Blob via this callback instead of
+     * uploading sync via Filestore.uploadVoiceV2.
+     */
+    onVoiceRecord?: (params: {
+        blob: Blob;
+        voiceTime: number;
+    }) => void;
     onGroupSelect?: (groupId: string) => void;
     onDirtyStateChange?: (isDirty: boolean) => void;
     onReady?: (controls: PostBuilderControls) => void;
@@ -61,6 +81,27 @@ declare type BaseProps = {
     onEditorTabChange?: (tab: EditorTypes) => void;
 };
 
+declare type CreatePostCallbackPayload = {
+    payload: Partial<PostCreationData> & {
+        error?: string;
+    };
+    html: string;
+    json: JSONContent;
+    text: string;
+    /**
+     * Per-item upload state for in-flight media. Only populated when
+     * `allowSendWhileUploading` is on AND there are items with blob: URLs at
+     * submit time. Each entry: blob (the source File for host persistence),
+     * promise (resolves to the final hosted item), abort (cancel the underlying
+     * axios request).
+     */
+    pendingUploads?: Map<string, {
+        blob: File | Blob;
+        promise: Promise<PostCreationMediaItem | PollPostMediaOptionItem>;
+        abort: () => void;
+    }>;
+};
+
 export declare enum EditorPlacement {
     Feed = "Feed",
     Modal = "Modal",
@@ -144,6 +185,14 @@ export declare interface PostBuilderConfig {
     toI18N: (key: string) => string;
     i18nKeys?: Partial<PostBuilderI18nKeys>;
     logEvent: (name: string, properties: Record<string, unknown>) => void;
+    /**
+     * When true, allows Send to fire while media uploads are still in flight.
+     * The host must provide an `onCreatePost` handler that consumes the new
+     * `pendingUploads` field on the payload, and an `onVoiceRecord` prop on
+     * the editor for the voice handoff. Defaults to false; existing consumers
+     * are unaffected.
+     */
+    allowSendWhileUploading?: boolean;
 }
 
 export declare interface PostBuilderControls {
@@ -236,7 +285,7 @@ declare interface PostBuilderI18nKeys {
     uploadsInProgressKey: string;
 }
 
-export declare const PostBuilderProvider: ({ children, apiBaseURL, authToken, toI18N, i18nKeys, logEvent, }: PostBuilderConfig) => JSX_2.Element;
+export declare const PostBuilderProvider: ({ children, apiBaseURL, authToken, toI18N, i18nKeys, logEvent, allowSendWhileUploading, }: PostBuilderConfig) => JSX_2.Element;
 
 declare type PostCreationData = {
     body: string;
@@ -287,11 +336,31 @@ export declare type PublishEventDetails = {
     failureReason?: string;
 };
 
+declare type ResolvedMediaItem = PostCreationMediaItem | PollPostMediaOptionItem;
+
+declare type ResolvedMediaItem_2 = PostCreationMediaItem | PollPostMediaOptionItem;
+
 declare enum SpecialType {
     POST = 0,
     FEATURED_POST = 1
 }
 
+/**
+ * Walks a serialized htmlBody string and removes media wrappers whose upload
+ * did not complete (data-src missing or blob:-prefixed). Empty
+ * `[data-media-group]` wrappers left behind are also removed. Mirrors
+ * `stripPendingMediaFromJsonBody` for the JSON form.
+ */
+export declare function stripPendingMediaFromHtml(html: string | undefined): string | undefined;
+
+/**
+ * Walks the editor JSON and removes media nodes whose upload did not complete
+ * (uploading: true OR src starts with 'blob:'). Also removes empty mediaGroup
+ * wrappers left behind. Used by failure / boot-GC paths to keep stripped drafts
+ * consistent with the items[] array.
+ */
+export declare function stripPendingMediaFromJsonBody(jsonBody: JSONContent_2 | undefined): JSONContent_2 | undefined;
+
 declare type WithModalProps = BaseProps & {
     openModal: boolean;
     onModalOpenChange: (open: boolean) => void;
@@ -346,14 +415,13 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        iframe: {
-            /**
-             * Insert an iframe node into the document
-             */
-            setIframe: (options: {
-                src: string;
-                width?: string;
-                height?: string;
+        smartMediaUpload: {
+            insertMediaWithUpload: (params: {
+                source: File | Blob | string;
+                type: MediaNodeTypes;
+                mediaType?: MediaItemType;
+                caption?: string;
+                searchFrom?: ImageSearchFrom;
             }) => ReturnType;
         };
     }
@@ -362,13 +430,14 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        smartMediaUpload: {
-            insertMediaWithUpload: (params: {
-                source: File | Blob | string;
-                type: MediaNodeTypes;
-                mediaType?: MediaItemType;
-                caption?: string;
-                searchFrom?: ImageSearchFrom;
+        iframe: {
+            /**
+             * Insert an iframe node into the document
+             */
+            setIframe: (options: {
+                src: string;
+                width?: string;
+                height?: string;
             }) => ReturnType;
         };
     }
@@ -377,27 +446,28 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        customLink: {
+        linkPreview: {
             /**
-             * Insert a new link mark with preview
+             * Insert a new link preview node
              */
-            insertLink: (attrs: LinkMarkAttrs) => ReturnType;
+            setLinkPreview: (attributes: LinkPreviewAttributes) => ReturnType;
             /**
-             * Update an existing link mark with its preview
+             * Update an existing link preview node
              */
-            updateLink: (uid: string, attrs: Partial<Omit<LinkMarkAttrs, 'uid'>>) => ReturnType;
+            updateLinkPreview: (attributes: LinkPreviewAttributes) => ReturnType;
             /**
              * Update media node attributes by uid
              */
-            updateLinkByUid: (uid: string, attrs: Partial<LinkMarkAttrs>) => ReturnType;
+            updateLinkPreviewByUid: (uid: string, attrs: Partial<LinkPreviewAttributes>) => ReturnType;
             /**
              * Delete link preview node by uid
              */
-            deleteLinkByUid: (uid: string) => ReturnType;
+            deleteLinkPreviewByUid: (uid: string) => ReturnType;
             /**
-             * Re-run unfurl resolution for existing links after content rehydration.
+             * Insert a link preview node directly after the top-level block containing
+             * the link mark with the given uid. Skips nested content (depth > 1).
              */
-            rehydrateLinkPreviews: () => ReturnType;
+            insertLinkPreviewAfterLink: (uid: string, attrs: LinkPreviewAttributes) => ReturnType;
         };
     }
 }
@@ -405,28 +475,27 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        linkPreview: {
+        customLink: {
             /**
-             * Insert a new link preview node
+             * Insert a new link mark with preview
              */
-            setLinkPreview: (attributes: LinkPreviewAttributes) => ReturnType;
+            insertLink: (attrs: LinkMarkAttrs) => ReturnType;
             /**
-             * Update an existing link preview node
+             * Update an existing link mark with its preview
              */
-            updateLinkPreview: (attributes: LinkPreviewAttributes) => ReturnType;
+            updateLink: (uid: string, attrs: Partial<Omit<LinkMarkAttrs, 'uid'>>) => ReturnType;
             /**
              * Update media node attributes by uid
              */
-            updateLinkPreviewByUid: (uid: string, attrs: Partial<LinkPreviewAttributes>) => ReturnType;
+            updateLinkByUid: (uid: string, attrs: Partial<LinkMarkAttrs>) => ReturnType;
             /**
              * Delete link preview node by uid
              */
-            deleteLinkPreviewByUid: (uid: string) => ReturnType;
+            deleteLinkByUid: (uid: string) => ReturnType;
             /**
-             * Insert a link preview node directly after the top-level block containing
-             * the link mark with the given uid. Skips nested content (depth > 1).
+             * Re-run unfurl resolution for existing links after content rehydration.
              */
-            insertLinkPreviewAfterLink: (uid: string, attrs: LinkPreviewAttributes) => ReturnType;
+            rehydrateLinkPreviews: () => ReturnType;
         };
     }
 }