ugcinc 2.3.0 → 2.4.0

package/dist/client.d.ts

@@ -3,6 +3,7 @@ import { TasksClient } from './tasks';
 import { PostsClient } from './posts';
 import { StatsClient } from './stats';
 import { OrganizationClient } from './org';
+import { RenderClient } from './render';
 import type { ClientConfig } from './base';
 /**
  * Main UGC Inc API Client
@@ -50,5 +51,9 @@ export declare class UGCClient {
      * Client for organization operations
      */
     org: OrganizationClient;
+    /**
+     * Client for video rendering operations
+     */
+    render: RenderClient;
     constructor(config: ClientConfig);
 }

package/dist/client.js

@@ -6,6 +6,7 @@ const tasks_1 = require("./tasks");
 const posts_1 = require("./posts");
 const stats_1 = require("./stats");
 const org_1 = require("./org");
+const render_1 = require("./render");
 /**
  * Main UGC Inc API Client
  *
@@ -38,6 +39,7 @@ class UGCClient {
         this.posts = new posts_1.PostsClient(config);
         this.stats = new stats_1.StatsClient(config);
         this.org = new org_1.OrganizationClient(config);
+        this.render = new render_1.RenderClient(config);
     }
 }
 exports.UGCClient = UGCClient;

package/dist/index.d.ts

@@ -9,5 +9,6 @@ export { TasksClient } from './tasks';
 export { PostsClient } from './posts';
 export { StatsClient } from './stats';
 export { OrganizationClient } from './org';
+export { RenderClient } from './render';
 export type { ClientConfig, } from './base';
-export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStat, ApiKey, GetAccountsParams, GetAccountStatsParams, GetAccountStatusParams, UpdateAccountInfoParams, UpdateAccountSocialParams, GetTasksParams, GetPostsParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, RefreshStatsParams, RefreshStatsResponse, RefreshStatsError, } from './types';
+export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStat, ApiKey, EditorConfig, VideoEditorConfig, ImageEditorConfig, EditorChannel, EditorSegment, VideoSegment, AudioSegment, ImageSegment, TextSegment, StaticSegment, RenderJobSubmit, RenderVideoRequest, RenderImageRequest, RenderJobResponse, RenderJobStatus, GetAccountsParams, GetAccountStatsParams, GetAccountStatusParams, UpdateAccountInfoParams, UpdateAccountSocialParams, GetTasksParams, GetPostsParams, CreateSlideshowParams, GetPostStatsParams, GetPostStatusParams, CreateVideoParams, RefreshStatsParams, RefreshStatsResponse, RefreshStatsError, } from './types';

package/dist/index.js

@@ -5,7 +5,7 @@
  * Official TypeScript/JavaScript client for the UGC Inc API
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrganizationClient = exports.StatsClient = exports.PostsClient = exports.TasksClient = exports.AccountsClient = exports.UGCClient = void 0;
+exports.RenderClient = exports.OrganizationClient = exports.StatsClient = exports.PostsClient = exports.TasksClient = exports.AccountsClient = exports.UGCClient = void 0;
 var client_1 = require("./client");
 Object.defineProperty(exports, "UGCClient", { enumerable: true, get: function () { return client_1.UGCClient; } });
 var accounts_1 = require("./accounts");
@@ -18,3 +18,5 @@ var stats_1 = require("./stats");
 Object.defineProperty(exports, "StatsClient", { enumerable: true, get: function () { return stats_1.StatsClient; } });
 var org_1 = require("./org");
 Object.defineProperty(exports, "OrganizationClient", { enumerable: true, get: function () { return org_1.OrganizationClient; } });
+var render_1 = require("./render");
+Object.defineProperty(exports, "RenderClient", { enumerable: true, get: function () { return render_1.RenderClient; } });

package/dist/render.d.ts

@@ -0,0 +1,76 @@
+import { BaseClient } from './base';
+import type { ApiResponse, RenderJobSubmit, RenderVideoRequest, RenderImageRequest, RenderJobResponse, RenderJobStatus } from './types';
+/**
+ * Client for video rendering operations
+ */
+export declare class RenderClient extends BaseClient {
+    /**
+     * Submit a video render job
+     * @param params - Video render parameters
+     * @returns Job ID and initial status
+     * @example
+     * ```typescript
+     * const videoJob = await client.render.submitVideo({
+     *   editor: myVideoEditorConfig,  // Can include video/audio/text/image segments
+     * });
+     * ```
+     */
+    submitVideo(params: Omit<RenderVideoRequest, 'output_type'>): Promise<ApiResponse<RenderJobResponse>>;
+    /**
+     * Submit an image render job (static image with text and images only)
+     * @param params - Image render parameters
+     * @returns Job ID and initial status
+     * @example
+     * ```typescript
+     * const imageJob = await client.render.submitImage({
+     *   editor: myImageEditorConfig,  // Can only include text/image segments
+     *   image_format: 'png'
+     * });
+     * ```
+     */
+    submitImage(params: Omit<RenderImageRequest, 'output_type'>): Promise<ApiResponse<RenderJobResponse>>;
+    /**
+     * Submit a render job (generic - use submitVideo or submitImage for type safety)
+     * @param params - Render job parameters
+     * @returns Job ID and initial status
+     * @example
+     * ```typescript
+     * // Less type-safe, prefer submitVideo() or submitImage()
+     * const job = await client.render.submit({
+     *   use_example: true,
+     *   output_type: 'video'
+     * });
+     *
+     * // Poll status separately
+     * const status = await client.render.getStatus(job.data.job_id);
+     * ```
+     */
+    submit(params: RenderJobSubmit): Promise<ApiResponse<RenderJobResponse>>;
+    /**
+     * Get the status of a render job
+     * @param jobId - The job ID returned from submit()
+     * @returns Current job status with progress, stats, and download URL when completed
+     * @example
+     * ```typescript
+     * const status = await client.render.getStatus(jobId);
+     * if (status.data.status === 'completed') {
+     *   console.log('Output type:', status.data.output_type);  // 'video' or 'image'
+     *   console.log('Download URL:', status.data.download_url);
+     *   // Use the download_url to get the file (video or image)
+     * }
+     * ```
+     */
+    getStatus(jobId: string): Promise<ApiResponse<RenderJobStatus>>;
+    /**
+     * Get the download URL for a completed render job
+     * @param jobId - The job ID
+     * @returns Download URL that can be used to fetch the file (video or image)
+     * @example
+     * ```typescript
+     * const url = client.render.getDownloadUrl(jobId);
+     * // Use this URL in an <a> tag or to download the file
+     * window.location.href = url;
+     * ```
+     */
+    getDownloadUrl(jobId: string): string;
+}

package/dist/render.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RenderClient = void 0;
+const base_1 = require("./base");
+/**
+ * Client for video rendering operations
+ */
+class RenderClient extends base_1.BaseClient {
+    /**
+     * Submit a video render job
+     * @param params - Video render parameters
+     * @returns Job ID and initial status
+     * @example
+     * ```typescript
+     * const videoJob = await client.render.submitVideo({
+     *   editor: myVideoEditorConfig,  // Can include video/audio/text/image segments
+     * });
+     * ```
+     */
+    async submitVideo(params) {
+        return this.post('/render/submit', { ...params, output_type: 'video' });
+    }
+    /**
+     * Submit an image render job (static image with text and images only)
+     * @param params - Image render parameters
+     * @returns Job ID and initial status
+     * @example
+     * ```typescript
+     * const imageJob = await client.render.submitImage({
+     *   editor: myImageEditorConfig,  // Can only include text/image segments
+     *   image_format: 'png'
+     * });
+     * ```
+     */
+    async submitImage(params) {
+        return this.post('/render/submit', { ...params, output_type: 'image' });
+    }
+    /**
+     * Submit a render job (generic - use submitVideo or submitImage for type safety)
+     * @param params - Render job parameters
+     * @returns Job ID and initial status
+     * @example
+     * ```typescript
+     * // Less type-safe, prefer submitVideo() or submitImage()
+     * const job = await client.render.submit({
+     *   use_example: true,
+     *   output_type: 'video'
+     * });
+     *
+     * // Poll status separately
+     * const status = await client.render.getStatus(job.data.job_id);
+     * ```
+     */
+    async submit(params) {
+        return this.post('/render/submit', params);
+    }
+    /**
+     * Get the status of a render job
+     * @param jobId - The job ID returned from submit()
+     * @returns Current job status with progress, stats, and download URL when completed
+     * @example
+     * ```typescript
+     * const status = await client.render.getStatus(jobId);
+     * if (status.data.status === 'completed') {
+     *   console.log('Output type:', status.data.output_type);  // 'video' or 'image'
+     *   console.log('Download URL:', status.data.download_url);
+     *   // Use the download_url to get the file (video or image)
+     * }
+     * ```
+     */
+    async getStatus(jobId) {
+        return this.get(`/render/status?job_id=${jobId}`);
+    }
+    /**
+     * Get the download URL for a completed render job
+     * @param jobId - The job ID
+     * @returns Download URL that can be used to fetch the file (video or image)
+     * @example
+     * ```typescript
+     * const url = client.render.getDownloadUrl(jobId);
+     * // Use this URL in an <a> tag or to download the file
+     * window.location.href = url;
+     * ```
+     */
+    getDownloadUrl(jobId) {
+        return `https://api.ugc.inc/render/download?job_id=${jobId}`;
+    }
+}
+exports.RenderClient = RenderClient;

package/dist/types.d.ts

@@ -234,3 +234,140 @@ export interface EditApiKeyParams {
     apiKeyId: string;
     name: string;
 }
+/**
+ * Render types
+ */
+interface BaseEditorConfig {
+    width: number;
+    height: number;
+    fps: number;
+    duration: number;
+}
+export interface VideoEditorConfig extends BaseEditorConfig {
+    channels: Array<{
+        id: string;
+        segments: EditorSegment[];
+    }>;
+}
+export interface ImageEditorConfig extends BaseEditorConfig {
+    channels: Array<{
+        id: string;
+        segments: StaticSegment[];
+    }>;
+}
+export interface EditorConfig extends BaseEditorConfig {
+    channels: Array<{
+        id: string;
+        segments: EditorSegment[];
+    }>;
+}
+export interface EditorChannel {
+    id: string;
+    segments: EditorSegment[];
+}
+interface BaseSegmentProps {
+    id: string;
+    source: string;
+    order: number;
+    offset: {
+        type: 'absolute' | 'relative';
+        value: number;
+    };
+    startTrim?: number;
+    endTrim?: number;
+    duration?: {
+        type: 'absolute' | 'relative';
+        value: number;
+    };
+    xOffset?: number;
+    yOffset?: number;
+    width?: number;
+    height?: number;
+    zIndex?: number;
+    scale?: number;
+    rotation?: number;
+    opacity?: number;
+}
+export interface VideoSegment extends BaseSegmentProps {
+    type: 'video';
+    fit?: 'cover' | 'contain' | 'fill';
+    speed?: number;
+    volume?: number;
+}
+export interface AudioSegment extends Omit<BaseSegmentProps, 'xOffset' | 'yOffset' | 'width' | 'height' | 'zIndex' | 'scale' | 'rotation' | 'opacity'> {
+    type: 'audio';
+    volume?: number;
+}
+export interface ImageSegment extends BaseSegmentProps {
+    type: 'image';
+    fit?: 'cover' | 'contain' | 'fill';
+    loop?: boolean;
+}
+export interface TextSegment extends Omit<BaseSegmentProps, 'source'> {
+    type: 'text';
+    source: '';
+    text?: string;
+    alignment?: 'left' | 'center' | 'right';
+    verticalAlign?: 'top' | 'middle' | 'bottom';
+    direction?: 'ltr' | 'rtl';
+    padding?: number;
+    fontType?: string;
+    fontSize?: number;
+    fontWeight?: string;
+    lineHeight?: number;
+    letterSpacing?: number;
+    textWrap?: string;
+    wordBreak?: string;
+    color?: string;
+    backgroundColor?: string;
+    strokeColor?: string;
+    strokeWidth?: number;
+}
+export type EditorSegment = VideoSegment | AudioSegment | ImageSegment | TextSegment;
+export type StaticSegment = ImageSegment | TextSegment;
+export interface RenderVideoRequest {
+    editor?: VideoEditorConfig;
+    use_example?: boolean;
+    output_type: 'video';
+}
+export interface RenderImageRequest {
+    editor?: ImageEditorConfig;
+    use_example?: boolean;
+    output_type: 'image';
+    image_format?: 'png' | 'jpeg';
+}
+export interface RenderJobSubmit {
+    editor?: EditorConfig;
+    use_example?: boolean;
+    output_type?: 'video' | 'image';
+    image_format?: 'png' | 'jpeg';
+}
+export interface RenderJobResponse {
+    job_id: string;
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+    output_type: 'video' | 'image';
+    message: string;
+}
+export interface RenderJobStatus {
+    job_id: string;
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+    output_type: 'video' | 'image';
+    progress: number;
+    message: string;
+    created_at: number;
+    updated_at: number;
+    download_url?: string;
+    video_url?: string;
+    size_bytes?: number;
+    duration_ms?: number;
+    stats?: {
+        preload_ms: number;
+        audio_ms: number;
+        render_ms: number;
+        encode_ms: number;
+        total_ms: number;
+    };
+    completed_at?: number;
+    error?: string;
+}
+export {};

package/package.json

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