@select-org/select-post-builder 1.1.57 → 1.2.5

package/dist/index.d.ts

@@ -85,6 +85,16 @@ declare type BaseProps = {
     disableNavigationWarning?: boolean;
     /** Tiptap JSONContent to pre-populate the editor with (takes precedence over localStorage draft) */
     initialContent?: JSONContent;
+    /**
+     * Deferred media (uid → File/Blob/remote URL) to re-attach and upload once the
+     * editor is mounted with `initialContent` — used by a host restoring an
+     * unauthenticated composer after the auth round-trip. Resume runs per editor
+     * instance (not via one-shot `onReady`), so it lands on whichever instance is
+     * finally rendered even across the mount-time useEditor re-create. Nodes whose
+     * uid is absent from the map are dropped (bytes unrecoverable). Omit for all
+     * normal composing — it is then a no-op.
+     */
+    resumeDeferredMedia?: Map<string, File | Blob | string>;
     /**
      * Initial tab to land on when the editor first mounts. Applied on first mount
      * only — subsequent prop changes are ignored. Same semantics as `initialContent`.
@@ -95,6 +105,13 @@ declare type BaseProps = {
     hideSubmitButton?: boolean;
     /** Fires when the user switches between editor tabs (Media, Blog, Poll) */
     onEditorTabChange?: (tab: EditorTypes) => void;
+    /**
+     * Optional override for the editor's empty-state placeholder text. When
+     * provided, replaces the default "What's on your mind, {name}" prompt so a
+     * host can show context-aware copy (e.g. "Send a private comment..." vs
+     * "Send a group comment..."). Omit to keep the default.
+     */
+    placeholder?: string;
 };
 
 declare type CreatePostCallbackPayload = {
@@ -105,16 +122,20 @@ declare type CreatePostCallbackPayload = {
     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).
+     * Per-item upload state for media the host may need to persist. Populated
+     * when `allowSendWhileUploading` is on OR `unauthenticatedMode` is on, for
+     * items with blob: URLs at submit time. Each entry always carries `blob`
+     * (the source File for host persistence). For in-flight uploads
+     * (allowSendWhileUploading), `promise` resolves to the final hosted item and
+     * `abort` cancels the underlying axios request. For deferred blobs
+     * (unauthenticatedMode) both `promise` and `abort` are undefined — the bytes
+     * were never uploaded; the host persists the blob and replays it after auth
+     * via `resumeDeferredUploads`.
      */
     pendingUploads?: Map<string, {
         blob: File | Blob;
-        promise: Promise<PostCreationMediaItem | PollPostMediaOptionItem>;
-        abort: () => void;
+        promise?: Promise<PostCreationMediaItem | PollPostMediaOptionItem>;
+        abort?: () => void;
     }>;
 };
 
@@ -226,6 +247,20 @@ export declare interface PostBuilderConfig {
      * are unaffected.
      */
     allowSendWhileUploading?: boolean;
+    /**
+     * When true the host has no authenticated session. The editor:
+     * - defers media uploads (nodes keep local previews; no filestore calls),
+     * - surfaces those deferred blobs via `pendingUploads` at submit regardless
+     *   of `allowSendWhileUploading`, so the host can persist and resume them
+     *   after auth,
+     * - suppresses URL resolution (no link previews / iframe resolve — the
+     *   /v1/url/resolve endpoint requires a JWT),
+     * - hides the voice, quick-GIF and media-search toolbar affordances.
+     * The flag is fixed at editor creation and baked into the extensions;
+     * changing it after mount requires remounting the editor to take effect.
+     * Defaults to false; existing consumers are unaffected.
+     */
+    unauthenticatedMode?: boolean;
 }
 
 export declare interface PostBuilderControls {
@@ -243,6 +278,12 @@ export declare interface PostBuilderControls {
     } | null;
     /** Clear editor content and localStorage draft */
     clearEditor: () => void;
+    /**
+     * Re-enqueue uploads for nodes attached while unauthenticated (deferred: true).
+     * Map key = node uid; value = raw File/Blob (file-kind) or remote URL string (url-kind).
+     * Nodes with no map entry are deleted (bytes unrecoverable).
+     */
+    resumeDeferredUploads: (media: Map<string, File | Blob | string>) => void;
 }
 
 export declare const PostBuilderEditor: FC<PostBuilderEditorProps>;
@@ -322,7 +363,7 @@ declare interface PostBuilderI18nKeys {
     uploadsInProgressKey: string;
 }
 
-export declare const PostBuilderProvider: ({ children, apiBaseURL, authToken, toI18N, i18nKeys, logEvent, allowSendWhileUploading, }: PostBuilderConfig) => JSX_2.Element;
+export declare const PostBuilderProvider: ({ children, apiBaseURL, authToken, toI18N, i18nKeys, logEvent, allowSendWhileUploading, unauthenticatedMode, }: PostBuilderConfig) => JSX_2.Element;
 
 declare type PostCreationData = {
     body: string;
@@ -507,6 +548,32 @@ 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;
+            }) => ReturnType;
+            /**
+             * Re-enqueue uploads for media nodes attached while unauthenticated
+             * (`attrs.deferred === true`). Map key = node uid; value = the raw
+             * File/Blob for file-kind nodes, which the host persists from
+             * `pendingUploads` across the auth redirect. URL-kind deferred nodes are
+             * NOT surfaced via `pendingUploads` (getPendingUpload requires a blob) —
+             * their remote URL rides in the doc JSON on `attrs.src`, so the host
+             * supplies that string here from the persisted node. Nodes with no entry
+             * in the map are deleted (bytes unrecoverable — the host toasts separately).
+             */
+            resumeDeferredUploads: (media: Map<string, File | Blob | string>) => ReturnType;
+        };
+    }
+}
+
+
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         linkPreview: {
@@ -540,18 +607,3 @@ 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;
-            }) => ReturnType;
-        };
-    }
-}