ugcinc 4.18.0 → 4.19.1

package/README.md

@@ -43,7 +43,7 @@ if (res.ok) {
 
 - `client.accounts`: list, create, update, troubleshoot, quarantine/release, and manage account lifecycle
 - `client.posts`: create video/slideshow posts, update them, retry failures, and preview schedule conflicts
-- `client.media`: upload media, create media records, search profile-picture candidates, search images and videos by keyword (`media.imageSearch`, cursor-paged), manage tags/names, and work with social audio
+- `client.media`: upload media, create media records, manage tags/names, and work with social audio
 - `client.stats`: fetch account/post analytics, daily aggregates, top performers, and refresh stats
 - `client.org`: manage organizations, API keys, and integration keys
 - `client.billing`: inspect subscription state and handle account deactivation, replacements, and refunds
@@ -74,20 +74,6 @@ if (posts.ok) {
 }
 ```
 
-## Posting failure quick reference
-
-`posts.getStatus()` returns `failure`; both `getPosts()` and `getPostsPage()` include it on each post. It is `null` when there is no current posting issue. A successful lookup still returns HTTP 200 even if the post failed.
-
-```typescript
-const result = await client.posts.getStatus({ postId: "post_123" });
-if (result.ok && result.data.failure) {
-  const { code, message, recovery, next_action } = result.data.failure;
-  console.log(code, message, recovery, next_action);
-}
-```
-
-See the posting failure reference below for recovery states and messages.
-
 ## Pagination
 
 `accounts.getAccounts()` and `posts.getPosts()` support keyset pagination via `limit`/`cursor`.
@@ -107,28 +93,6 @@ do {
 } while (cursor);
 ```
 
-For interactive tables, `posts.getPostsPage()` keeps filtering and sorting on the server and
-returns page-scoped latest stats plus `totalCount`, organization-wide `postTags`,
-`anyHasTitle`, and `matchingAccountIds`. It supports caption/title/account search; platform,
-post type, status, account, account-tag, post-tag, social-audio, and phone-type filters; and
-sorting by account, status, title, caption, tag, audio presence, scheduled time, or engagement:
-
-```typescript
-const page = await client.posts.getPostsPage({
-  search: "launch",
-  statuses: ["complete"],
-  postTags: ["fall-campaign"],
-  sortBy: "views",
-  sortDirection: "desc",
-  limit: 200,
-});
-
-if (page.ok) {
-  console.log(page.data.posts, page.data.stats, page.data.totalCount);
-  const next = page.data.nextCursor;
-}
-```
-
 ## Caption Overlays
 
 Video posts can carry text overlays to display on the video. Pass `captionOverlays` to
@@ -180,28 +144,6 @@ await client.posts.createVideo({
 await client.posts.updatePost({ postId: "post_123", post_tag: "campaign-august" });
 ```
 
-When a post fails, its category is appended to the tag as `fail reason: <fail_category>` (for
-example `campaign-july fail reason: device_error`), so a post list shows why without a status call
-per post. The suffix is removed again when the post is retried.
-
-## Backup Audio
-
-A post can carry a second sound. If the platform refuses the primary sound at posting time, the
-backup becomes the post's `social_audio_id`, the post is re-attempted once, ` switched to backup
-audio` is appended to its `tag`, and `backup_audio_used_at` is set. With no backup left the post
-fails as `audio_unavailable` and is not retried. Set it with `backupSocialAudioId` on
-`posts.createVideo()`, `posts.createSlideshow()`, `posts.createDraft()`, and `posts.updatePost()`
-(`null` clears it on update).
-
-```typescript
-await client.posts.createSlideshow({
-  accountId: "acc_123",
-  imageUrls: ["https://example.com/img1.jpg"],
-  socialAudioId: "audio_primary",
-  backupSocialAudioId: "audio_fallback",
-});
-```
-
 ## Useful Exports
 
 - `UGCClient` for API access
@@ -220,33 +162,6 @@ For the full endpoint reference, all method signatures, data structures, and wor
 
 MIT
 
-## Posting failure reference
-
-The same `failure` object is returned by status and list responses. It contains a stable `code`, a fixed `message`, a `recovery` state, and `next_action`.
-
-| Recovery | Meaning |
-|---|---|
-| `retry_pending` | The existing post is waiting for another attempt; no execution time is guaranteed. |
-| `waiting` | The existing post is paused until a publishing issue is resolved. |
-| `verifying_publication` | Publication is being checked before another attempt is allowed. |
-| `stopped` | No automatic recovery is indicated. Follow `next_action`. |
-
-`next_action` is `wait`, `change_audio`, `change_audio_or_contact_support`, or `contact_support`. When it is `wait`, do not submit another copy. Account and publishing operations are handled by the service; these messages never ask customers to manage them.
-
-| Code | Message |
-|---|---|
-| `AUDIO_UNAVAILABLE` | The selected sound is unavailable. Choose another sound and retry. |
-| `BACKUP_AUDIO_RETRY_PENDING` | The selected sound was unavailable. Your post is waiting to be retried with its backup sound. |
-| `AUDIO_RETRY_PENDING` | The selected sound could not be loaded. Your post is waiting to be retried. |
-| `AUDIO_PREPARATION_FAILED` | The selected sound could not be prepared for this post. Choose another sound or contact support before retrying. |
-| `PUBLISHING_RETRY_PENDING` | Publishing was temporarily interrupted. Your post is waiting to be retried. No action is needed. |
-| `PUBLISHING_BLOCKED` | A publishing issue prevented this post from proceeding. Contact support for help with this post. |
-| `POST_PROCESSING_FAILED` | A processing error prevented this posting attempt from completing. Contact support before retrying. |
-| `PUBLICATION_CHECK_IN_PROGRESS` | We’re checking whether your post published. Please wait before submitting it again to avoid a duplicate. |
-| `PUBLICATION_UNCONFIRMED` | We couldn’t confirm whether your post published. Contact support before submitting it again to avoid a duplicate. |
-| `POST_RETRY_PENDING` | The previous posting attempt did not complete. Your post is waiting to be retried. No action is needed. |
-| `POST_FAILED` | The posting attempt failed, but we couldn’t determine the cause. Contact support before submitting it again. |
-
 ### Render a supplied Remotion composition
 
 `remotion-composition` accepts a TSX module whose default export is a React
@@ -280,3 +195,12 @@ status/logs to inspect failures and the returned video for preview.
 
 Server integrations can also call `submitRemotionCompositionRenderJob` and
 `getRenderJobStatus` with the configured render-worker origin.
+
+### Remotion composition PNG output
+
+The `remotion-composition` workflow node accepts `outputType: "image"` to render
+the first composition frame as a PNG. Its output port becomes `image`; video
+remains the default for existing workflows. Pass sound assets separately for
+photo posts because PNG files contain no audio. The public render helper
+`submitRemotionCompositionRenderJob({...composition, outputType: "image"})`
+supports the same option.

package/dist/automations/nodes/index.d.ts

@@ -336,6 +336,7 @@ export declare const nodeDefinitions: {
         source: string;
         outputMode: "per-input" | "single";
         selectionMode: null;
+        outputType: "video" | "image";
         inputs: {
             type: "number" | "boolean" | "object" | "video" | "audio" | "image" | "text";
             id: string;

package/dist/automations/nodes/remotion-composition.d.ts

@@ -7,6 +7,7 @@ declare const defaults: {
     source: string;
     outputMode: "per-input" | "single";
     selectionMode: null;
+    outputType: "video" | "image";
     inputs: {
         type: "number" | "boolean" | "object" | "video" | "audio" | "image" | "text";
         id: string;
@@ -23,6 +24,7 @@ declare const _default: import("./types").NodeDefinition<"remotion-composition",
     source: string;
     outputMode: "per-input" | "single";
     selectionMode: null;
+    outputType: "video" | "image";
     inputs: {
         type: "number" | "boolean" | "object" | "video" | "audio" | "image" | "text";
         id: string;

package/dist/automations/nodes/remotion-composition.js

@@ -14,12 +14,12 @@ export default function Video({title}: {title: string}) {
 });
 const definition = (0, types_1.defineNode)({
     nodeId: 'remotion-composition', label: 'Remotion Composition',
-    description: 'Render a React/TSX composition with UGC components',
-    guide: 'Supply a TSX module with a default-exported React component. UGC registers and bundles it. Import react, remotion or ugcinc/render (including its utils/types subpaths). Configure dimensions, fps, frame count and default inputProps. Add typed input ports whose IDs match component props; connected values override defaults. Media props retain their {url} shape. Source is browser code: no local files, npm installs, require or dynamic imports. Output is a rendered video; use Save to Media or Pass Through. Run preview uses the same renderer as the final output.',
+    description: 'Render a React/TSX composition as a video or PNG',
+    guide: 'Supply a TSX module with a default-exported React component. UGC registers and bundles it. Import react, remotion or ugcinc/render (including its utils/types subpaths). Configure dimensions, fps, frame count and default inputProps. Add typed input ports whose IDs match component props; connected values override defaults. Media props retain their {url} shape. Source is browser code: no local files, npm installs, require or dynamic imports. Set outputType to video (default) or image (first-frame PNG); use Save to Media or Pass Through. Image output does not embed audio. Run preview uses the same renderer as the final output.',
     type: 'generator', category: 'Generation', outputModes: ['per-input', 'single'], selectionModes: null,
     defaults,
     computePorts: ({ config }) => ({ inputs: config.inputs,
-        outputs: [{ id: 'output', type: 'video', isArray: false, required: true }] }),
+        outputs: [{ id: 'output', type: config.outputType === 'image' ? 'image' : 'video', isArray: false, required: true }] }),
     generatePreview: (_config, _ctx, cached) => (0, types_1.preview)({ output: cached?.output ?? null }),
     validate: config => {
         const result = remotion_composition_1.remotionCompositionNodeSchema.safeParse(config);

package/dist/render/types/remotion-composition.d.ts

@@ -47,6 +47,7 @@ export declare const remotionCompositionNodeSchema: z.ZodObject<{
     durationInFrames: z.ZodNumber;
     inputProps: z.ZodRecord<z.ZodString, z.ZodUnknown>;
 } & {
+    outputType: z.ZodDefault<z.ZodEnum<["video", "image"]>>;
     inputs: z.ZodEffects<z.ZodArray<z.ZodObject<{
         id: z.ZodEffects<z.ZodString, string, string>;
         type: z.ZodEnum<["text", "number", "boolean", "image", "video", "audio", "object"]>;
@@ -79,6 +80,7 @@ export declare const remotionCompositionNodeSchema: z.ZodObject<{
     source: string;
     outputMode: "per-input" | "single";
     selectionMode: null;
+    outputType: "video" | "image";
     inputs: {
         type: "number" | "boolean" | "object" | "video" | "audio" | "image" | "text";
         id: string;
@@ -105,6 +107,7 @@ export declare const remotionCompositionNodeSchema: z.ZodObject<{
     fps: number;
     durationInFrames: number;
     inputProps: Record<string, unknown>;
+    outputType?: "video" | "image" | undefined;
 }>;
 export declare const REMOTION_COMPOSITION_IMPORTS: string[];
 export declare function parseRemotionPropsJson({ text }: {

package/dist/render/types/remotion-composition.js

@@ -19,6 +19,7 @@ exports.remotionCompositionPortSchema = zod_1.z.object({
     required: zod_1.z.boolean(),
 }).strict();
 exports.remotionCompositionNodeSchema = exports.remotionCompositionSchema.extend({
+    outputType: zod_1.z.enum(['video', 'image']).default('video'),
     inputs: zod_1.z.array(exports.remotionCompositionPortSchema).max(64).refine(ports => new Set(ports.map(port => port.id)).size === ports.length, 'Prop names must be unique'),
     outputMode: zod_1.z.enum(['single', 'per-input']),
     selectionMode: zod_1.z.null(),

package/dist/render.d.ts

@@ -14,7 +14,9 @@ import type { ImageEditorNodeConfig } from './automations/nodes/image-composer';
 import type { CreateDmMessage } from './automations/nodes/create-dm';
 import { type RemotionCompositionInput } from './render/types/remotion-composition';
 /** Submit TSX source and props; UGC owns registration and bundling. */
-export declare function submitRemotionCompositionRenderJob(params: RemotionCompositionInput): Promise<ApiResponse<RenderJobResponse>>;
+export declare function submitRemotionCompositionRenderJob(params: RemotionCompositionInput & {
+    outputType?: 'video' | 'image';
+}): Promise<ApiResponse<RenderJobResponse>>;
 export interface RenderJobResponse {
     job_id: string;
     status: string;

package/dist/render.js

@@ -31,13 +31,16 @@ function renderBaseUrl() {
 const MAX_RETRIES = 3;
 /** Submit TSX source and props; UGC owns registration and bundling. */
 async function submitRemotionCompositionRenderJob(params) {
-    const parsed = remotion_composition_1.remotionCompositionSchema.safeParse(params);
+    const { outputType = 'video', ...composition } = params;
+    if (outputType !== 'video' && outputType !== 'image')
+        return { ok: false, code: 400, message: 'Output type must be video or image' };
+    const parsed = remotion_composition_1.remotionCompositionSchema.safeParse(composition);
     if (!parsed.success)
         return { ok: false, code: 400, message: parsed.error.message };
     const response = await renderFetch('/submit-job', {
         method: 'POST', headers: { 'Content-Type': 'application/json' },
         body: JSON.stringify({ config: { _compositionType: 'remotion-composition', ...parsed.data },
-            output_type: 'video', video_codec: 'h264' }),
+            output_type: outputType, video_codec: 'h264', image_format: 'png' }),
     });
     const data = await response.json();
     const result = zod_1.z.object({ job_id: zod_1.z.string(), status: zod_1.z.string(), output_type: zod_1.z.string(), message: zod_1.z.string() }).safeParse(data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ugcinc",
-  "version": "4.18.0",
+  "version": "4.19.1",
   "description": "TypeScript/JavaScript client for the UGC Inc API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",