ugcinc 2.16.1 → 2.17.0

package/dist/base.d.ts

@@ -6,9 +6,10 @@ export interface ClientConfig {
 export declare class BaseClient {
     protected apiKey: string;
     protected orgId?: string;
-    private readonly baseUrl;
+    protected readonly baseUrl = "https://api.ugc.inc";
     constructor(config: ClientConfig);
     protected request<T>(endpoint: string, options?: RequestInit): Promise<ApiResponse<T>>;
     protected post<T>(endpoint: string, body?: unknown): Promise<ApiResponse<T>>;
     protected get<T>(endpoint: string): Promise<ApiResponse<T>>;
+    protected postFormData<T>(endpoint: string, formData: FormData): Promise<ApiResponse<T>>;
 }

package/dist/base.js

@@ -67,5 +67,52 @@ class BaseClient {
             method: 'GET',
         });
     }
+    async postFormData(endpoint, formData) {
+        let url = `${this.baseUrl}${endpoint}`;
+        // If orgId is provided, treat apiKey as admin key and add orgId as query param
+        if (this.orgId) {
+            const separator = endpoint.includes('?') ? '&' : '?';
+            url = `${url}${separator}orgId=${encodeURIComponent(this.orgId)}`;
+        }
+        const headers = {};
+        // Use admin key header if orgId is provided, otherwise use Bearer token
+        if (this.orgId) {
+            headers['x-api-key'] = this.apiKey;
+        }
+        else {
+            headers['Authorization'] = `Bearer ${this.apiKey}`;
+        }
+        try {
+            const response = await fetch(url, {
+                method: 'POST',
+                headers,
+                body: formData,
+            });
+            const rawData = await response.json();
+            const isSuccess = response.ok && rawData.code >= 200 && rawData.code < 300;
+            if (isSuccess && rawData.data !== undefined) {
+                return {
+                    ok: true,
+                    code: rawData.code,
+                    message: rawData.message ?? 'Success',
+                    data: rawData.data,
+                };
+            }
+            else {
+                return {
+                    ok: false,
+                    code: rawData.code,
+                    message: rawData.message ?? 'Request failed',
+                };
+            }
+        }
+        catch (error) {
+            return {
+                ok: false,
+                code: 500,
+                message: error instanceof Error ? error.message : 'Unknown error occurred',
+            };
+        }
+    }
 }
 exports.BaseClient = BaseClient;

package/dist/client.d.ts

@@ -5,6 +5,7 @@ import { StatsClient } from './stats';
 import { OrganizationClient } from './org';
 import { RenderClient } from './render';
 import { AutomationsClient } from './automations';
+import { MediaClient } from './media';
 import type { ClientConfig } from './base';
 /**
  * Main UGC Inc API Client
@@ -60,5 +61,9 @@ export declare class UGCClient {
      * Client for automation workflow operations
      */
     automations: AutomationsClient;
+    /**
+     * Client for media operations
+     */
+    media: MediaClient;
     constructor(config: ClientConfig);
 }

package/dist/client.js

@@ -8,6 +8,7 @@ const stats_1 = require("./stats");
 const org_1 = require("./org");
 const render_1 = require("./render");
 const automations_1 = require("./automations");
+const media_1 = require("./media");
 /**
  * Main UGC Inc API Client
  *
@@ -42,6 +43,7 @@ class UGCClient {
         this.org = new org_1.OrganizationClient(config);
         this.render = new render_1.RenderClient(config);
         this.automations = new automations_1.AutomationsClient(config);
+        this.media = new media_1.MediaClient(config);
     }
 }
 exports.UGCClient = UGCClient;

package/dist/index.d.ts

@@ -11,5 +11,6 @@ export { StatsClient } from './stats';
 export { OrganizationClient } from './org';
 export { RenderClient } from './render';
 export { AutomationsClient, getAllNodes, getNodeByType } from './automations';
+export { MediaClient } from './media';
 export type { ClientConfig, } from './base';
-export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStat, ApiKey, EditorConfig, VideoEditorConfig, ImageEditorConfig, EditorChannel, TimeValue, BaseSegmentProps, VisualSegmentProps, 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, MediaType, NodePort, NodeControlConfig, NodeTypeEnum, WorkflowNodeDefinition, WorkflowDefinition, CanvasState, AutomationTemplate, AutomationRun, NodeRun, OutputSchemaProperty, SelectionMode, ExhaustionBehavior, SelectionConfig, SelectionState, OutputMode, } from './types';
+export type { SuccessResponse, ErrorResponse, ApiResponse, Account, AccountStat, AccountTask, EditProfileInfo, Task, TaskType, Post, PostType, PostStat, ApiKey, EditorConfig, VideoEditorConfig, ImageEditorConfig, EditorChannel, TimeValue, BaseSegmentProps, VisualSegmentProps, 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, MediaType, NodePort, NodeControlConfig, NodeTypeEnum, WorkflowNodeDefinition, WorkflowDefinition, CanvasState, AutomationTemplate, AutomationRun, NodeRun, OutputSchemaProperty, SelectionMode, ExhaustionBehavior, SelectionConfig, SelectionState, OutputMode, UserMedia, SocialAudio, Media, GetMediaParams, UploadMediaParams, UploadMediaResponse, UpdateMediaTagParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, } 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.getNodeByType = exports.getAllNodes = exports.AutomationsClient = exports.RenderClient = exports.OrganizationClient = exports.StatsClient = exports.PostsClient = exports.TasksClient = exports.AccountsClient = exports.UGCClient = void 0;
+exports.MediaClient = exports.getNodeByType = exports.getAllNodes = exports.AutomationsClient = 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");
@@ -24,3 +24,5 @@ var automations_1 = require("./automations");
 Object.defineProperty(exports, "AutomationsClient", { enumerable: true, get: function () { return automations_1.AutomationsClient; } });
 Object.defineProperty(exports, "getAllNodes", { enumerable: true, get: function () { return automations_1.getAllNodes; } });
 Object.defineProperty(exports, "getNodeByType", { enumerable: true, get: function () { return automations_1.getNodeByType; } });
+var media_1 = require("./media");
+Object.defineProperty(exports, "MediaClient", { enumerable: true, get: function () { return media_1.MediaClient; } });

package/dist/media.d.ts

@@ -0,0 +1,34 @@
+import { BaseClient } from './base';
+import type { Media, UserMedia, SocialAudio, GetMediaParams, UploadMediaResponse, UpdateMediaTagParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, ApiResponse } from './types';
+/**
+ * Client for managing media files
+ */
+export declare class MediaClient extends BaseClient {
+    /**
+     * Get all media for the organization
+     * Returns both user_media and social_audio combined
+     */
+    getMedia(params?: GetMediaParams): Promise<ApiResponse<Media[]>>;
+    /**
+     * Upload media files
+     * Supports uploading multiple files at once
+     * Files are uploaded to Vercel Blob storage
+     */
+    upload(files: File[], tag?: string): Promise<ApiResponse<UploadMediaResponse>>;
+    /**
+     * Update the tag on a media item
+     * Works for both user_media and social_audio
+     */
+    updateTag(params: UpdateMediaTagParams): Promise<ApiResponse<UserMedia | SocialAudio>>;
+    /**
+     * Delete one or more media items
+     * Supports both single id and bulk ids
+     * Also deletes the files from blob storage
+     */
+    delete(params: DeleteMediaParams): Promise<ApiResponse<DeleteMediaResponse>>;
+    /**
+     * Create a social audio from a TikTok URL
+     * Extracts audio and cover image from TikTok video or music URL
+     */
+    createSocialAudio(params: CreateSocialAudioParams): Promise<ApiResponse<SocialAudio>>;
+}

package/dist/media.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaClient = void 0;
+const base_1 = require("./base");
+/**
+ * Client for managing media files
+ */
+class MediaClient extends base_1.BaseClient {
+    /**
+     * Get all media for the organization
+     * Returns both user_media and social_audio combined
+     */
+    async getMedia(params) {
+        return this.post('/media', params ?? {});
+    }
+    /**
+     * Upload media files
+     * Supports uploading multiple files at once
+     * Files are uploaded to Vercel Blob storage
+     */
+    async upload(files, tag) {
+        const formData = new FormData();
+        for (const file of files) {
+            formData.append('file', file);
+        }
+        if (tag) {
+            formData.append('tag', tag);
+        }
+        return this.postFormData('/media/create/upload', formData);
+    }
+    /**
+     * Update the tag on a media item
+     * Works for both user_media and social_audio
+     */
+    async updateTag(params) {
+        return this.post('/media/update-tag', params);
+    }
+    /**
+     * Delete one or more media items
+     * Supports both single id and bulk ids
+     * Also deletes the files from blob storage
+     */
+    async delete(params) {
+        return this.post('/media/delete', params);
+    }
+    /**
+     * Create a social audio from a TikTok URL
+     * Extracts audio and cover image from TikTok video or music URL
+     */
+    async createSocialAudio(params) {
+        return this.post('/media/social-audio', params);
+    }
+}
+exports.MediaClient = MediaClient;

package/dist/types.d.ts

@@ -639,4 +639,67 @@ export interface NodeRun {
     created_at: string;
     completed_at: string | null;
 }
+/**
+ * Media types
+ */
+export interface UserMedia {
+    id: string;
+    org_id: string;
+    name: string | null;
+    tag: string | null;
+    type: 'video' | 'image' | 'audio' | null;
+    url: string;
+    created_at: string;
+    media_type: 'user_media';
+}
+export interface SocialAudio {
+    id: string;
+    org_id: string;
+    name: string | null;
+    tag: string | null;
+    social_post_link: string | null;
+    social_audio_link: string | null;
+    platform_type: 'tiktok' | null;
+    preview_url: string | null;
+    audio_url: string | null;
+    created_at: string;
+    media_type: 'social_audio';
+    type: 'social_audio';
+}
+export type Media = UserMedia | SocialAudio;
+export interface GetMediaParams {
+    tag?: string;
+}
+export interface UploadMediaParams {
+    files: File[];
+    tag?: string;
+}
+export interface UploadMediaResponse {
+    data: UserMedia[];
+    failed?: Array<{
+        name: string;
+        error: string;
+    }>;
+    message: string;
+}
+export interface UpdateMediaTagParams {
+    id: string;
+    tag: string;
+}
+export interface DeleteMediaParams {
+    id?: string;
+    ids?: string[];
+}
+export interface DeleteMediaResponse {
+    deleted: string[];
+    failed?: Array<{
+        id: string;
+        message: string;
+    }>;
+    message: string;
+}
+export interface CreateSocialAudioParams {
+    url: string;
+    tag?: string;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ugcinc",
-  "version": "2.16.1",
+  "version": "2.17.0",
   "description": "TypeScript/JavaScript client for the UGC Inc API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,9 +24,6 @@
     "@types/node": "^20.0.0",
     "typescript": "^5.0.0"
   },
-  "dependencies": {
-    "ugcinc": "^1.7.0"
-  },
   "files": [
     "dist",
     "README.md"