@postrun/react 2.0.0 → 2.1.0

package/dist/index.d.cts

@@ -3,7 +3,7 @@ import { ReactNode, CSSProperties } from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient, QueryKey } from '@tanstack/react-query';
 import { PostrunClient, ListProfilesQuery, DiscoverableAccountList, Connection, ConnectionKind, ConnectionStatus, ListMediaQuery, ListPostsQuery, ConnectablePlatform, MediaResource, MediaTarget, MediaKind, Metadata, ComposePostInput, PostValidation, XPostVariant, LinkedInPostVariant } from '@postrun/js';
-export { PostValidation, ValidationIssue } from '@postrun/js';
+export { PostValidation, PostVariant, PostVariantError, ValidationIssue } from '@postrun/js';
 import { TwitterComponents } from 'react-tweet';
 
 /**
@@ -1181,6 +1181,25 @@ declare function usePost(id: string, options?: LiveOptions): _tanstack_react_que
  * variant set from `{ content, channels }` (per the `buildCreatePost` rules), and
  * sends it — the customer never assembles variants or passes a `connection_id`.
  * `connectedChannels` is the set of posting platforms this profile can reach.
+ *
+ * ## Reading the publish outcome (do NOT stop at "it returned")
+ * On `publish: 'now'` the API returns the created post with a rollup `status` and
+ * a per-variant `status` + typed `error`. A 201 does NOT mean every platform
+ * published — one can silently fail while another succeeds. Surface the outcome
+ * via the derived fields, never assume success from a resolved `create`:
+ *
+ * - **`status`** — the rollup (`published | partially_published | failed |
+ *   draft | scheduled`), `undefined` until the first `create` resolves.
+ * - **`isPublished`** — `true` ONLY when `status === 'published'`. This is the
+ *   one "fully published" state; `partially_published` and `failed` are NOT
+ *   success. Branch on this, not on the promise resolving.
+ * - **`failedVariants`** — the variants that failed, each with its typed
+ *   `error` (`{ code, message }`); `[]` when none. Render "X failed: <message>".
+ *
+ * `create` still resolves with the FULL `Post` (read everything if you need to),
+ * and it NEVER throws on a failed/partial publish — a throw would discard the
+ * platforms that DID publish. A transport error (network / 4xx) still surfaces
+ * via `error` (and rejects `create`), exactly as before.
  */
 declare function useCreatePost(profileId: string): {
     create: _tanstack_react_query.UseMutateAsyncFunction<{
@@ -1280,6 +1299,38 @@ declare function useCreatePost(profileId: string): {
         executed: boolean;
     } | undefined;
     reset: () => void;
+    status: "draft" | "scheduled" | "publishing" | "partially_published" | "published" | "failed" | undefined;
+    isPublished: boolean;
+    failedVariants: {
+        id: string;
+        object: "post_variant";
+        connection_id: string | null;
+        platform: "x" | "linkedin" | "facebook_page" | "instagram" | "tiktok";
+        post_type: "text" | "single_image" | "multi_image" | "video" | "reel" | "carousel";
+        body: string | null;
+        status: "draft" | "scheduled" | "publishing" | "published" | "failed";
+        settings: {
+            [key: string]: unknown;
+        };
+        schedule_at: string | null;
+        result: {
+            platform_post_id: string;
+            permalink: string | null;
+            published_at: string;
+        } | null;
+        error: {
+            code: string;
+            message: string;
+        } | null;
+        media: Array<{
+            media_id: string;
+            position: number;
+            crop_box: {
+                [key: string]: unknown;
+            } | null;
+            alt_text_override: string | null;
+        }>;
+    }[];
     isReady: boolean;
     connectedChannels: ("x" | "linkedin" | "facebook_page" | "instagram" | "tiktok")[];
 };
@@ -1300,7 +1351,7 @@ declare function useValidatePost(profileId: string): {
     validate: (input: Omit<ComposePostInput, "profileId">) => Promise<PostValidation>;
     publishable: boolean | undefined;
     issues: {
-        code: "unauthorized" | "forbidden" | "not_found" | "conflict" | "validation_failed" | "rate_limited" | "internal_error" | "idempotency_key_invalid" | "idempotency_key_reused" | "idempotency_request_in_progress" | "account_not_available" | "connection_reauth_required" | "connection_not_pending" | "not_implemented" | "connection_discovery_failed" | "media_processing" | "not_publishable" | "invalid_connection" | "invalid_media" | "profile_scope_invalid" | "media_unprobeable" | "media_too_large" | "media_aspect_ratio_unsupported" | "media_resolution_too_low" | "media_gif_unsupported" | "media_format_recompressed" | "media_resolution_downscaled" | "video_container_unsupported" | "video_codec_unsupported" | "video_audio_codec_unsupported" | "video_too_large" | "video_too_small" | "video_dimensions_unsupported" | "video_dimensions_too_large" | "video_fps_unsupported" | "video_fps_too_low" | "video_aspect_unsupported" | "video_duration_too_short" | "video_duration_exceeds_max" | "video_transform_failed" | "media_fetch_failed" | "document_format_unsupported" | "document_too_large" | "document_too_many_pages" | "media_format_indeterminate" | "media_count_invalid" | "body_too_long" | "content_missing" | "content_conflict" | "content_incomplete" | "content_kind_mismatch" | "media_type_mismatch" | "tag_limit_exceeded" | "reel_field_on_non_reel" | "field_placement_invalid" | "media_not_ready" | "media_failed" | "media_unsupported" | "media_kind_mismatch" | "variant_unparseable" | "publishing_unavailable" | "x_duplicate_content" | "x_not_authorized" | "x_rate_limited" | "x_publish_failed" | "x_media_upload_failed" | "linkedin_duplicate_content" | "linkedin_auth_expired" | "linkedin_permission_denied" | "linkedin_media_processing" | "linkedin_media_upload_failed" | "linkedin_publish_failed" | "instagram_media_processing" | "instagram_container_expired" | "instagram_container_failed" | "instagram_rate_limited" | "instagram_not_authorized" | "instagram_publish_failed" | "facebook_reel_processing" | "facebook_reel_failed" | "facebook_rate_limited" | "facebook_not_authorized" | "facebook_publish_failed" | "tiktok_privacy_not_allowed" | "tiktok_duration_exceeds_max" | "tiktok_media_processing" | "tiktok_not_authorized" | "tiktok_rate_limited" | "tiktok_publish_failed" | "connection_platform_mismatch" | "connection_removed";
+        code: "unauthorized" | "forbidden" | "not_found" | "conflict" | "validation_failed" | "rate_limited" | "internal_error" | "idempotency_key_invalid" | "idempotency_key_reused" | "idempotency_request_in_progress" | "account_not_available" | "connection_reauth_required" | "connection_not_pending" | "not_implemented" | "connection_discovery_failed" | "media_processing" | "not_publishable" | "invalid_connection" | "invalid_media" | "profile_scope_invalid" | "media_unprobeable" | "media_too_large" | "media_aspect_ratio_unsupported" | "media_resolution_too_low" | "media_gif_unsupported" | "media_format_recompressed" | "media_resolution_downscaled" | "video_container_unsupported" | "video_codec_unsupported" | "video_audio_codec_unsupported" | "video_too_large" | "video_too_small" | "video_dimensions_unsupported" | "video_dimensions_too_large" | "video_fps_unsupported" | "video_fps_too_low" | "video_aspect_unsupported" | "video_duration_too_short" | "video_duration_exceeds_max" | "video_transform_failed" | "media_fetch_failed" | "document_format_unsupported" | "document_too_large" | "document_too_many_pages" | "media_format_indeterminate" | "media_count_invalid" | "body_too_long" | "content_missing" | "content_conflict" | "content_incomplete" | "content_kind_mismatch" | "media_type_mismatch" | "tag_limit_exceeded" | "reel_field_on_non_reel" | "field_placement_invalid" | "media_not_ready" | "media_failed" | "media_unsupported" | "media_kind_mismatch" | "variant_unparseable" | "publishing_unavailable" | "x_duplicate_content" | "x_not_authorized" | "x_access_not_permitted" | "x_rate_limited" | "x_publish_failed" | "x_media_upload_failed" | "linkedin_duplicate_content" | "linkedin_auth_expired" | "linkedin_permission_denied" | "linkedin_media_processing" | "linkedin_media_upload_failed" | "linkedin_publish_failed" | "instagram_media_processing" | "instagram_container_expired" | "instagram_container_failed" | "instagram_rate_limited" | "instagram_not_authorized" | "instagram_publish_failed" | "facebook_reel_processing" | "facebook_reel_failed" | "facebook_rate_limited" | "facebook_not_authorized" | "facebook_publish_failed" | "tiktok_privacy_not_allowed" | "tiktok_duration_exceeds_max" | "tiktok_media_processing" | "tiktok_not_authorized" | "tiktok_rate_limited" | "tiktok_publish_failed" | "connection_platform_mismatch" | "connection_removed";
         message: string;
         hint?: string;
         allowed?: Array<string>;

package/dist/index.d.ts

@@ -3,7 +3,7 @@ import { ReactNode, CSSProperties } from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient, QueryKey } from '@tanstack/react-query';
 import { PostrunClient, ListProfilesQuery, DiscoverableAccountList, Connection, ConnectionKind, ConnectionStatus, ListMediaQuery, ListPostsQuery, ConnectablePlatform, MediaResource, MediaTarget, MediaKind, Metadata, ComposePostInput, PostValidation, XPostVariant, LinkedInPostVariant } from '@postrun/js';
-export { PostValidation, ValidationIssue } from '@postrun/js';
+export { PostValidation, PostVariant, PostVariantError, ValidationIssue } from '@postrun/js';
 import { TwitterComponents } from 'react-tweet';
 
 /**
@@ -1181,6 +1181,25 @@ declare function usePost(id: string, options?: LiveOptions): _tanstack_react_que
  * variant set from `{ content, channels }` (per the `buildCreatePost` rules), and
  * sends it — the customer never assembles variants or passes a `connection_id`.
  * `connectedChannels` is the set of posting platforms this profile can reach.
+ *
+ * ## Reading the publish outcome (do NOT stop at "it returned")
+ * On `publish: 'now'` the API returns the created post with a rollup `status` and
+ * a per-variant `status` + typed `error`. A 201 does NOT mean every platform
+ * published — one can silently fail while another succeeds. Surface the outcome
+ * via the derived fields, never assume success from a resolved `create`:
+ *
+ * - **`status`** — the rollup (`published | partially_published | failed |
+ *   draft | scheduled`), `undefined` until the first `create` resolves.
+ * - **`isPublished`** — `true` ONLY when `status === 'published'`. This is the
+ *   one "fully published" state; `partially_published` and `failed` are NOT
+ *   success. Branch on this, not on the promise resolving.
+ * - **`failedVariants`** — the variants that failed, each with its typed
+ *   `error` (`{ code, message }`); `[]` when none. Render "X failed: <message>".
+ *
+ * `create` still resolves with the FULL `Post` (read everything if you need to),
+ * and it NEVER throws on a failed/partial publish — a throw would discard the
+ * platforms that DID publish. A transport error (network / 4xx) still surfaces
+ * via `error` (and rejects `create`), exactly as before.
  */
 declare function useCreatePost(profileId: string): {
     create: _tanstack_react_query.UseMutateAsyncFunction<{
@@ -1280,6 +1299,38 @@ declare function useCreatePost(profileId: string): {
         executed: boolean;
     } | undefined;
     reset: () => void;
+    status: "draft" | "scheduled" | "publishing" | "partially_published" | "published" | "failed" | undefined;
+    isPublished: boolean;
+    failedVariants: {
+        id: string;
+        object: "post_variant";
+        connection_id: string | null;
+        platform: "x" | "linkedin" | "facebook_page" | "instagram" | "tiktok";
+        post_type: "text" | "single_image" | "multi_image" | "video" | "reel" | "carousel";
+        body: string | null;
+        status: "draft" | "scheduled" | "publishing" | "published" | "failed";
+        settings: {
+            [key: string]: unknown;
+        };
+        schedule_at: string | null;
+        result: {
+            platform_post_id: string;
+            permalink: string | null;
+            published_at: string;
+        } | null;
+        error: {
+            code: string;
+            message: string;
+        } | null;
+        media: Array<{
+            media_id: string;
+            position: number;
+            crop_box: {
+                [key: string]: unknown;
+            } | null;
+            alt_text_override: string | null;
+        }>;
+    }[];
     isReady: boolean;
     connectedChannels: ("x" | "linkedin" | "facebook_page" | "instagram" | "tiktok")[];
 };
@@ -1300,7 +1351,7 @@ declare function useValidatePost(profileId: string): {
     validate: (input: Omit<ComposePostInput, "profileId">) => Promise<PostValidation>;
     publishable: boolean | undefined;
     issues: {
-        code: "unauthorized" | "forbidden" | "not_found" | "conflict" | "validation_failed" | "rate_limited" | "internal_error" | "idempotency_key_invalid" | "idempotency_key_reused" | "idempotency_request_in_progress" | "account_not_available" | "connection_reauth_required" | "connection_not_pending" | "not_implemented" | "connection_discovery_failed" | "media_processing" | "not_publishable" | "invalid_connection" | "invalid_media" | "profile_scope_invalid" | "media_unprobeable" | "media_too_large" | "media_aspect_ratio_unsupported" | "media_resolution_too_low" | "media_gif_unsupported" | "media_format_recompressed" | "media_resolution_downscaled" | "video_container_unsupported" | "video_codec_unsupported" | "video_audio_codec_unsupported" | "video_too_large" | "video_too_small" | "video_dimensions_unsupported" | "video_dimensions_too_large" | "video_fps_unsupported" | "video_fps_too_low" | "video_aspect_unsupported" | "video_duration_too_short" | "video_duration_exceeds_max" | "video_transform_failed" | "media_fetch_failed" | "document_format_unsupported" | "document_too_large" | "document_too_many_pages" | "media_format_indeterminate" | "media_count_invalid" | "body_too_long" | "content_missing" | "content_conflict" | "content_incomplete" | "content_kind_mismatch" | "media_type_mismatch" | "tag_limit_exceeded" | "reel_field_on_non_reel" | "field_placement_invalid" | "media_not_ready" | "media_failed" | "media_unsupported" | "media_kind_mismatch" | "variant_unparseable" | "publishing_unavailable" | "x_duplicate_content" | "x_not_authorized" | "x_rate_limited" | "x_publish_failed" | "x_media_upload_failed" | "linkedin_duplicate_content" | "linkedin_auth_expired" | "linkedin_permission_denied" | "linkedin_media_processing" | "linkedin_media_upload_failed" | "linkedin_publish_failed" | "instagram_media_processing" | "instagram_container_expired" | "instagram_container_failed" | "instagram_rate_limited" | "instagram_not_authorized" | "instagram_publish_failed" | "facebook_reel_processing" | "facebook_reel_failed" | "facebook_rate_limited" | "facebook_not_authorized" | "facebook_publish_failed" | "tiktok_privacy_not_allowed" | "tiktok_duration_exceeds_max" | "tiktok_media_processing" | "tiktok_not_authorized" | "tiktok_rate_limited" | "tiktok_publish_failed" | "connection_platform_mismatch" | "connection_removed";
+        code: "unauthorized" | "forbidden" | "not_found" | "conflict" | "validation_failed" | "rate_limited" | "internal_error" | "idempotency_key_invalid" | "idempotency_key_reused" | "idempotency_request_in_progress" | "account_not_available" | "connection_reauth_required" | "connection_not_pending" | "not_implemented" | "connection_discovery_failed" | "media_processing" | "not_publishable" | "invalid_connection" | "invalid_media" | "profile_scope_invalid" | "media_unprobeable" | "media_too_large" | "media_aspect_ratio_unsupported" | "media_resolution_too_low" | "media_gif_unsupported" | "media_format_recompressed" | "media_resolution_downscaled" | "video_container_unsupported" | "video_codec_unsupported" | "video_audio_codec_unsupported" | "video_too_large" | "video_too_small" | "video_dimensions_unsupported" | "video_dimensions_too_large" | "video_fps_unsupported" | "video_fps_too_low" | "video_aspect_unsupported" | "video_duration_too_short" | "video_duration_exceeds_max" | "video_transform_failed" | "media_fetch_failed" | "document_format_unsupported" | "document_too_large" | "document_too_many_pages" | "media_format_indeterminate" | "media_count_invalid" | "body_too_long" | "content_missing" | "content_conflict" | "content_incomplete" | "content_kind_mismatch" | "media_type_mismatch" | "tag_limit_exceeded" | "reel_field_on_non_reel" | "field_placement_invalid" | "media_not_ready" | "media_failed" | "media_unsupported" | "media_kind_mismatch" | "variant_unparseable" | "publishing_unavailable" | "x_duplicate_content" | "x_not_authorized" | "x_access_not_permitted" | "x_rate_limited" | "x_publish_failed" | "x_media_upload_failed" | "linkedin_duplicate_content" | "linkedin_auth_expired" | "linkedin_permission_denied" | "linkedin_media_processing" | "linkedin_media_upload_failed" | "linkedin_publish_failed" | "instagram_media_processing" | "instagram_container_expired" | "instagram_container_failed" | "instagram_rate_limited" | "instagram_not_authorized" | "instagram_publish_failed" | "facebook_reel_processing" | "facebook_reel_failed" | "facebook_rate_limited" | "facebook_not_authorized" | "facebook_publish_failed" | "tiktok_privacy_not_allowed" | "tiktok_duration_exceeds_max" | "tiktok_media_processing" | "tiktok_not_authorized" | "tiktok_rate_limited" | "tiktok_publish_failed" | "connection_platform_mismatch" | "connection_removed";
         message: string;
         hint?: string;
         allowed?: Array<string>;

package/dist/index.js

@@ -1,7 +1,7 @@
 "use client";
 import { createContext, memo, useMemo, useState, useEffect, Fragment as Fragment$1, useRef, createElement, useContext, useCallback } from 'react';
 import { useInfiniteQuery, useQuery, useMutation, QueryClient } from '@tanstack/react-query';
-import { createPostrunClient, profilesList, profilesGet, profilesCreate, profilesUpdate, profilesDelete, connectionsConnect, connectionsListByProfile, connectionsGet, connectionsListAccounts, connectionsSelect, connectionsDelete, mediaGet, mediaList, mediaUpdate, mediaDelete, postsList, postsGet, postsCreate, buildCreatePost, isPostPlatform, postsValidate, postsUpdate, postsDelete, mediaCreate, PostrunError } from '@postrun/js';
+import { createPostrunClient, profilesList, profilesGet, profilesCreate, profilesUpdate, profilesDelete, connectionsConnect, connectionsListByProfile, connectionsGet, connectionsListAccounts, connectionsSelect, connectionsDelete, mediaGet, mediaList, mediaUpdate, mediaDelete, postsList, postsGet, postsCreate, buildCreatePost, isPostPlatform, failedVariants, isPublished, postsValidate, postsUpdate, postsDelete, mediaCreate, PostrunError } from '@postrun/js';
 import Nango, { AuthError } from '@nangohq/frontend';
 import pWaitFor, { TimeoutError } from 'p-wait-for';
 import pLimit from 'p-limit';
@@ -878,12 +878,18 @@ function useCreatePost(profileId) {
     },
     queryClient
   );
+  const post = mutation.data;
   return {
     create: mutation.mutateAsync,
     isPending: mutation.isPending,
     error: mutation.error,
-    data: mutation.data,
+    data: post,
     reset: mutation.reset,
+    // Derived publish outcome (see the JSDoc above) — `undefined`/`false`/`[]`
+    // until the first create resolves; computed from the returned post only.
+    status: post?.status,
+    isPublished: post ? isPublished(post) : false,
+    failedVariants: post ? failedVariants(post) : [],
     // The profile's connections must load before `create` can resolve a channel;
     // gate on this so a call during loading isn't mislabeled "not connected".
     isReady: connections.isSuccess,