ugcinc 4.25.0 → 4.26.0

package/README.md

@@ -281,6 +281,41 @@ 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.
 
+### Native text stickers
+
+`submitNativeTextStickerRenderJob` submits the native classic text/emoji renderer
+and returns the normal render job ID. Poll with `getRenderJobStatus`; the completed
+`download_url` is a transparent PNG usable as an image layer in UGC compositions.
+Server calls require `UGC_RENDER_URL`.
+
+```ts
+import {submitNativeTextStickerRenderJob, getRenderJobStatus} from 'ugcinc';
+
+const submitted = await submitNativeTextStickerRenderJob({
+  text: 'Hello World 😭🙏', fontSizePt: 28,
+  canvasWidthPt: 360, canvasHeightPt: 120,
+  containerWidthPt: 320, originPt: [20, 18],
+});
+if (submitted.ok && submitted.data) {
+  const status = await getRenderJobStatus(submitted.data.job_id);
+  // Poll until completed/failed; use status.data.download_url when completed.
+}
+```
+
+The versioned `tiktok-classic-ios-47` profile uses centered white text, a black
+outline, TikTokDisplay-Medium and AppleColorEmoji. All dimensions are **native
+points**, with fixed 3× output: the example produces 1080×360 pixels. Fractional
+coordinates are preserved. Sizes are 11–72pt; canvas/container sides are 1–1365pt;
+text is limited to 2048 UTF-16 code units. `containerHeightPt` limits visible
+lines; omitted or zero means unlimited lines clipped by the canvas. Optional
+`viewFontSizePt` reproduces a native editor whose view font differs from its text
+run; normally omit it. Defaults are 28pt, a 600×180pt canvas, 560pt container width
+and origin `[20,18]`.
+
+Unsupported fallback fonts, bidi, styles and empty paragraphs fail explicitly.
+The profile's recorded native PNG fixtures match exactly; this does not promise
+pixel parity after resizing, browser composition or lossy video encoding.
+
 ## Social reference acquisition
 
 Quick reference:

package/dist/index.d.ts

@@ -13,7 +13,7 @@ export { AutomationsClient } from './automations';
 export { MediaClient } from './media';
 export { CommentsClient } from './comments';
 export { BillingClient } from './billing';
-export { submitImageRenderJob, submitVideoRenderJob, getRenderJobStatus, submitDeduplicationJob, submitSceneSplitJob, submitScreenshotAnimationRenderJob, submitRemotionCompositionRenderJob, submitAutoCaptionRenderJob, submitInstagramDmRenderJob, submitIMessageDmRenderJob, } from './render';
+export { submitImageRenderJob, submitVideoRenderJob, getRenderJobStatus, submitDeduplicationJob, submitSceneSplitJob, submitScreenshotAnimationRenderJob, submitRemotionCompositionRenderJob, submitNativeTextStickerRenderJob, nativeTextStickerSchema, submitAutoCaptionRenderJob, submitInstagramDmRenderJob, submitIMessageDmRenderJob, } from './render';
 export { remotionCompositionSchema, remotionCompositionNodeSchema, remotionCompositionPortSchema, REMOTION_COMPOSITION_IMPORTS, parseRemotionPropsJson } from './render/types/remotion-composition';
 export type { RemotionCompositionInput } from './render/types/remotion-composition';
 export type { RemotionCompositionNodeConfig } from './automations/nodes/remotion-composition';
@@ -36,7 +36,7 @@ export type { Org, ApiKey, DeleteApiKeyParams, EditApiKeyParams, IntegrationKey,
 export type { UserMedia, MediaUse, SocialAudio, Media, GetMediaParams, GetSocialAudioParams, UploadMediaParams, UploadMediaResponse, MediaTagUpdate, UpdateMediaTagsParams, MediaTagUpdateResult, UpdateMediaTagsResponse, UpdateMediaTagParams, UpdateMediaNameParams, DeleteMediaParams, DeleteMediaResponse, CreateSocialAudioParams, ImportTextParams, ImportTextResponse, CreateMediaFromUrlParams, GetMediaUseParams, GetMediaUseResponse, FilterMediaParams, FilterMediaResponse, PfpSearchParams, PfpSearchResponse, PfpCandidate, ImageSearchParams, ImageSearchResult, ImageSearchResponse, ImageSearchVideoFormat, } from './media';
 export type { CommentStatus, Comment, CreateCommentParams, CreateCommentResponse, GetCommentsParams, } from './comments';
 export type { BillingInfo, PortalUrlResponse, CancelAccountParams, CancelAccountResponse, ReactivateAccountParams, ReactivateAccountResponse, CancelSubscriptionResponse, RequestReplacementParams, RequestReplacementResponse, RequestRefundParams, RequestRefundResponse, BillingRequestInfo, PortalParams, } from './billing';
-export type { RenderJobResponse, RenderJobStatus, SubmitImageRenderJobParams, SubmitVideoRenderJobParams, SubmitScreenshotAnimationRenderJobParams, SubmitAutoCaptionRenderJobParams, SubmitSceneSplitJobParams, SceneSplitDetectorConfig, SubmitInstagramDmRenderJobParams, SubmitIMessageDmRenderJobParams, IgDmMessage, ImDmMessage, RenderVideoEditorConfig, } from './render';
+export type { RenderJobResponse, RenderJobStatus, SubmitImageRenderJobParams, NativeTextStickerInput, SubmitVideoRenderJobParams, SubmitScreenshotAnimationRenderJobParams, SubmitAutoCaptionRenderJobParams, SubmitSceneSplitJobParams, SceneSplitDetectorConfig, SubmitInstagramDmRenderJobParams, SubmitIMessageDmRenderJobParams, IgDmMessage, ImDmMessage, RenderVideoEditorConfig, } from './render';
 export type { VideoEditorNodeConfig, VideoEditorChannel, VideoEditorSegment, VideoEditorVideoSegment, VideoEditorAudioSegment, VideoEditorImageSegment, VideoEditorTextSegment, VideoEditorImageSequenceSegment, VideoEditorVideoSequenceSegment, TimeValue, TimeMode, SegmentTimelinePosition, DeduplicationLevel, DeduplicationInput, ImageEditorElement, DimensionPresetKey, } from './render/types';
 export type { ImageEditorNodeConfig, ImageComposerNodeConfig, ImageComposerRenderInput } from './automations/nodes/image-composer';
 export { prepareImageComposerInput } from './automations/nodes/image-composer';

package/dist/index.js

@@ -5,9 +5,9 @@
  * Official TypeScript/JavaScript client for the UGC Inc API
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasMissingTriggerError = exports.getPortErrorsForNode = exports.getErrorNodeIds = exports.validateWorkflow = exports.getCapturedNodes = exports.getNodesDownstreamOfSet = exports.getDownstreamNodes = exports.checkCrossContextViolation = exports.getForEachContext = exports.getConnectedSource = exports.cleanupStaleConnections = exports.removeNodeConnections = exports.removeConnection = exports.addConnection = exports.deriveConnections = exports.createNode = exports.getOutputSchema = exports.getNodeByType = exports.getAllNodes = exports.getInputPreviewValue = exports.computeAllNodePortsWithPreviews = exports.computeAllNodePorts = exports.computePortsWithPreviews = exports.computePortsForNode = exports.areTypesCompatible = exports.parseRemotionPropsJson = exports.REMOTION_COMPOSITION_IMPORTS = exports.remotionCompositionPortSchema = exports.remotionCompositionNodeSchema = exports.remotionCompositionSchema = exports.submitIMessageDmRenderJob = exports.submitInstagramDmRenderJob = exports.submitAutoCaptionRenderJob = exports.submitRemotionCompositionRenderJob = exports.submitScreenshotAnimationRenderJob = exports.submitSceneSplitJob = exports.submitDeduplicationJob = exports.getRenderJobStatus = exports.submitVideoRenderJob = exports.submitImageRenderJob = exports.BillingClient = exports.CommentsClient = exports.MediaClient = exports.AutomationsClient = exports.OrganizationClient = exports.StatsClient = exports.PostsClient = exports.TasksClient = exports.AccountsClient = exports.UGCClient = void 0;
-exports.parseOpenAPIOutputPath = exports.parseOpenAPIInputs = exports.mapOpenAPIType = exports.nodeConfigToCaptionStyle = exports.HttpMethods = exports.prepareImageComposerInput = exports.substituteVariables = exports.processTemplate = exports.extractTemplateVariables = exports.PortIdSchema = exports.normalizeToPortId = exports.portIdToTitle = exports.isValidPortId = exports.portId = exports.selectFromPool = exports.getModelDurations = exports.getModelAspectRatios = exports.ALL_VIDEO_MODELS = exports.getAvailableInputModes = exports.hasReferenceVariant = exports.getReferenceModelId = exports.hasFirstLastFrameVariant = exports.getFirstLastFrameModelId = exports.hasImageToVideoVariant = exports.getImageToVideoModelId = exports.isImageToVideoModel = exports.IMAGE_ASPECT_RATIOS = exports.ALL_IMAGE_MODELS = exports.getEditModelId = exports.isEditModel = exports.getCapturedSourceNodeTypes = exports.getFlowControlNodeTypes = exports.getAllNodeDefinitions = exports.getNodeDefinition = exports.isPortType = exports.formatPortType = exports.isAsyncExecutor = exports.internalNodeTypes = exports.nodeDefinitions = exports.extractWorkflowConfig = exports.generateNodeName = exports.shuffleNodePreview = exports.getPreviewValue = exports.removePreviewForConnection = exports.updatePreviewMapForConnection = exports.computePreviewMap = exports.computeAllNodePreviews = exports.resolveNodePreview = exports.getWorkflowOutputSchema = exports.hasMissingTerminalError = void 0;
-exports.mediaAnalysisResultSchema = exports.mediaAnalysisStatusSchema = exports.detectScenesSchema = exports.extractFramesSchema = exports.videoTextResultSchema = exports.imageTextResultSchema = exports.readVideoTextSchema = exports.readImageTextSchema = exports.audioLevelsResultSchema = exports.audioTranscriptResultSchema = exports.measureAudioLevelsSchema = exports.transcribeAudioSchema = exports.binaryMaskSchema = exports.measureLayoutResultSchema = exports.sampleColorsResultSchema = exports.measureLayoutSchema = exports.sampleColorsSchema = exports.matchTextStyleResultSchema = exports.matchTextStyleSchema = exports.prepareVideoComposerInput = exports.formatDateTag = exports.outputFieldsToZod = exports.outputFieldToZod = exports.LLMProviders = exports.applyLogicOperator = exports.IfLogicOperators = exports.resolvePath = exports.indexExpressionToString = exports.indexExpressionToIndexes = exports.resolveUnknownPath = exports.getOutputTypeFromCategory = void 0;
+exports.getErrorNodeIds = exports.validateWorkflow = exports.getCapturedNodes = exports.getNodesDownstreamOfSet = exports.getDownstreamNodes = exports.checkCrossContextViolation = exports.getForEachContext = exports.getConnectedSource = exports.cleanupStaleConnections = exports.removeNodeConnections = exports.removeConnection = exports.addConnection = exports.deriveConnections = exports.createNode = exports.getOutputSchema = exports.getNodeByType = exports.getAllNodes = exports.getInputPreviewValue = exports.computeAllNodePortsWithPreviews = exports.computeAllNodePorts = exports.computePortsWithPreviews = exports.computePortsForNode = exports.areTypesCompatible = exports.parseRemotionPropsJson = exports.REMOTION_COMPOSITION_IMPORTS = exports.remotionCompositionPortSchema = exports.remotionCompositionNodeSchema = exports.remotionCompositionSchema = exports.submitIMessageDmRenderJob = exports.submitInstagramDmRenderJob = exports.submitAutoCaptionRenderJob = exports.nativeTextStickerSchema = exports.submitNativeTextStickerRenderJob = exports.submitRemotionCompositionRenderJob = exports.submitScreenshotAnimationRenderJob = exports.submitSceneSplitJob = exports.submitDeduplicationJob = exports.getRenderJobStatus = exports.submitVideoRenderJob = exports.submitImageRenderJob = exports.BillingClient = exports.CommentsClient = exports.MediaClient = exports.AutomationsClient = exports.OrganizationClient = exports.StatsClient = exports.PostsClient = exports.TasksClient = exports.AccountsClient = exports.UGCClient = void 0;
+exports.mapOpenAPIType = exports.nodeConfigToCaptionStyle = exports.HttpMethods = exports.prepareImageComposerInput = exports.substituteVariables = exports.processTemplate = exports.extractTemplateVariables = exports.PortIdSchema = exports.normalizeToPortId = exports.portIdToTitle = exports.isValidPortId = exports.portId = exports.selectFromPool = exports.getModelDurations = exports.getModelAspectRatios = exports.ALL_VIDEO_MODELS = exports.getAvailableInputModes = exports.hasReferenceVariant = exports.getReferenceModelId = exports.hasFirstLastFrameVariant = exports.getFirstLastFrameModelId = exports.hasImageToVideoVariant = exports.getImageToVideoModelId = exports.isImageToVideoModel = exports.IMAGE_ASPECT_RATIOS = exports.ALL_IMAGE_MODELS = exports.getEditModelId = exports.isEditModel = exports.getCapturedSourceNodeTypes = exports.getFlowControlNodeTypes = exports.getAllNodeDefinitions = exports.getNodeDefinition = exports.isPortType = exports.formatPortType = exports.isAsyncExecutor = exports.internalNodeTypes = exports.nodeDefinitions = exports.extractWorkflowConfig = exports.generateNodeName = exports.shuffleNodePreview = exports.getPreviewValue = exports.removePreviewForConnection = exports.updatePreviewMapForConnection = exports.computePreviewMap = exports.computeAllNodePreviews = exports.resolveNodePreview = exports.getWorkflowOutputSchema = exports.hasMissingTerminalError = exports.hasMissingTriggerError = exports.getPortErrorsForNode = void 0;
+exports.mediaAnalysisResultSchema = exports.mediaAnalysisStatusSchema = exports.detectScenesSchema = exports.extractFramesSchema = exports.videoTextResultSchema = exports.imageTextResultSchema = exports.readVideoTextSchema = exports.readImageTextSchema = exports.audioLevelsResultSchema = exports.audioTranscriptResultSchema = exports.measureAudioLevelsSchema = exports.transcribeAudioSchema = exports.binaryMaskSchema = exports.measureLayoutResultSchema = exports.sampleColorsResultSchema = exports.measureLayoutSchema = exports.sampleColorsSchema = exports.matchTextStyleResultSchema = exports.matchTextStyleSchema = exports.prepareVideoComposerInput = exports.formatDateTag = exports.outputFieldsToZod = exports.outputFieldToZod = exports.LLMProviders = exports.applyLogicOperator = exports.IfLogicOperators = exports.resolvePath = exports.indexExpressionToString = exports.indexExpressionToIndexes = exports.resolveUnknownPath = exports.getOutputTypeFromCategory = exports.parseOpenAPIOutputPath = exports.parseOpenAPIInputs = void 0;
 // =============================================================================
 // Client Exports
 // =============================================================================
@@ -40,6 +40,8 @@ Object.defineProperty(exports, "submitDeduplicationJob", { enumerable: true, get
 Object.defineProperty(exports, "submitSceneSplitJob", { enumerable: true, get: function () { return render_1.submitSceneSplitJob; } });
 Object.defineProperty(exports, "submitScreenshotAnimationRenderJob", { enumerable: true, get: function () { return render_1.submitScreenshotAnimationRenderJob; } });
 Object.defineProperty(exports, "submitRemotionCompositionRenderJob", { enumerable: true, get: function () { return render_1.submitRemotionCompositionRenderJob; } });
+Object.defineProperty(exports, "submitNativeTextStickerRenderJob", { enumerable: true, get: function () { return render_1.submitNativeTextStickerRenderJob; } });
+Object.defineProperty(exports, "nativeTextStickerSchema", { enumerable: true, get: function () { return render_1.nativeTextStickerSchema; } });
 Object.defineProperty(exports, "submitAutoCaptionRenderJob", { enumerable: true, get: function () { return render_1.submitAutoCaptionRenderJob; } });
 Object.defineProperty(exports, "submitInstagramDmRenderJob", { enumerable: true, get: function () { return render_1.submitInstagramDmRenderJob; } });
 Object.defineProperty(exports, "submitIMessageDmRenderJob", { enumerable: true, get: function () { return render_1.submitIMessageDmRenderJob; } });

package/dist/render/types/native-text.d.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+/** Native points, rendered at 3 pixels per point. No coordinate rounding. */
+export declare const nativeTextStickerSchema: z.ZodObject<{
+    profile: z.ZodDefault<z.ZodLiteral<"tiktok-classic-ios-47">>;
+    text: z.ZodEffects<z.ZodString, string, string>;
+    fontSizePt: z.ZodDefault<z.ZodNumber>;
+    canvasWidthPt: z.ZodDefault<z.ZodNumber>;
+    canvasHeightPt: z.ZodDefault<z.ZodNumber>;
+    containerWidthPt: z.ZodDefault<z.ZodNumber>;
+    /** Omit for unlimited lines clipped by the canvas; zero has the same meaning. */
+    containerHeightPt: z.ZodOptional<z.ZodNumber>;
+    originPt: z.ZodDefault<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    /** Normally omitted. Reproduces an editor whose view font differs from the text run font. */
+    viewFontSizePt: z.ZodOptional<z.ZodNumber>;
+}, "strict", z.ZodTypeAny, {
+    text: string;
+    profile: "tiktok-classic-ios-47";
+    fontSizePt: number;
+    canvasWidthPt: number;
+    canvasHeightPt: number;
+    containerWidthPt: number;
+    originPt: [number, number];
+    containerHeightPt?: number | undefined;
+    viewFontSizePt?: number | undefined;
+}, {
+    text: string;
+    profile?: "tiktok-classic-ios-47" | undefined;
+    fontSizePt?: number | undefined;
+    canvasWidthPt?: number | undefined;
+    canvasHeightPt?: number | undefined;
+    containerWidthPt?: number | undefined;
+    containerHeightPt?: number | undefined;
+    originPt?: [number, number] | undefined;
+    viewFontSizePt?: number | undefined;
+}>;
+export type NativeTextStickerInput = z.input<typeof nativeTextStickerSchema>;

package/dist/render/types/native-text.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nativeTextStickerSchema = void 0;
+const zod_1 = require("zod");
+const dimension = zod_1.z.number().finite().min(1).max(1365);
+const fontSize = zod_1.z.number().finite().min(11).max(72);
+/** Native points, rendered at 3 pixels per point. No coordinate rounding. */
+exports.nativeTextStickerSchema = zod_1.z.object({
+    profile: zod_1.z.literal('tiktok-classic-ios-47').default('tiktok-classic-ios-47'),
+    text: zod_1.z.string().min(1).max(2048).refine(text => text.split('\n').every(line => line.replace(/ /g, '').length > 0)
+        && !/[\u0000-\u0009\u000b-\u001f\u007f-\u009f\u2028\u2029\u202a-\u202e\u2066-\u2069]/u.test(text)
+        && !/[\uD800-\uDFFF]/u.test(text), 'Empty paragraphs, control characters and unpaired surrogates are not supported'),
+    fontSizePt: fontSize.default(28),
+    canvasWidthPt: dimension.default(600),
+    canvasHeightPt: dimension.default(180),
+    containerWidthPt: dimension.default(560),
+    /** Omit for unlimited lines clipped by the canvas; zero has the same meaning. */
+    containerHeightPt: zod_1.z.number().finite().min(0).max(1365).optional(),
+    originPt: zod_1.z.tuple([zod_1.z.number().finite().min(0).max(1365), zod_1.z.number().finite().min(0).max(1365)]).default([20, 18]),
+    /** Normally omitted. Reproduces an editor whose view font differs from the text run font. */
+    viewFontSizePt: fontSize.optional(),
+}).strict();

package/dist/render.d.ts

@@ -13,6 +13,25 @@ import type { CaptionWord, CaptionStyle } from './render/types/caption';
 import type { ImageEditorNodeConfig } from './automations/nodes/image-composer';
 import type { CreateDmMessage } from './automations/nodes/create-dm';
 import { type RemotionCompositionInput } from './render/types/remotion-composition';
+import { type NativeTextStickerInput } from './render/types/native-text';
+export { nativeTextStickerSchema, type NativeTextStickerInput } from './render/types/native-text';
+/** Render a native text/emoji sticker directly to a transparent PNG. */
+export declare function submitNativeTextStickerRenderJob(params: NativeTextStickerInput): Promise<{
+    ok: boolean;
+    code: number;
+    message: string;
+    data?: undefined;
+} | {
+    ok: boolean;
+    code: number;
+    message: string;
+    data: {
+        message: string;
+        status: string;
+        job_id: string;
+        output_type: string;
+    };
+}>;
 /** Submit TSX source and props; UGC owns registration and bundling. */
 export declare function submitRemotionCompositionRenderJob(params: RemotionCompositionInput & {
     outputType?: 'video' | 'image';
@@ -208,4 +227,3 @@ export declare function submitInstagramDmRenderJob(params: SubmitInstagramDmRend
  * Renders a fake iMessage conversation image.
  */
 export declare function submitIMessageDmRenderJob(params: SubmitIMessageDmRenderJobParams): Promise<ApiResponse<RenderJobResponse>>;
-export {};

package/dist/render.js

@@ -9,6 +9,8 @@
  * variable set fails fast.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.nativeTextStickerSchema = void 0;
+exports.submitNativeTextStickerRenderJob = submitNativeTextStickerRenderJob;
 exports.submitRemotionCompositionRenderJob = submitRemotionCompositionRenderJob;
 exports.submitImageRenderJob = submitImageRenderJob;
 exports.submitVideoRenderJob = submitVideoRenderJob;
@@ -21,6 +23,9 @@ exports.submitInstagramDmRenderJob = submitInstagramDmRenderJob;
 exports.submitIMessageDmRenderJob = submitIMessageDmRenderJob;
 const zod_1 = require("zod");
 const remotion_composition_1 = require("./render/types/remotion-composition");
+const native_text_1 = require("./render/types/native-text");
+var native_text_2 = require("./render/types/native-text");
+Object.defineProperty(exports, "nativeTextStickerSchema", { enumerable: true, get: function () { return native_text_2.nativeTextStickerSchema; } });
 function renderBaseUrl() {
     const url = process.env.UGC_RENDER_URL?.trim();
     if (!url) {
@@ -29,6 +34,25 @@ function renderBaseUrl() {
     return url.replace(/\/+$/, '');
 }
 const MAX_RETRIES = 3;
+/** Render a native text/emoji sticker directly to a transparent PNG. */
+async function submitNativeTextStickerRenderJob(params) {
+    const parsed = native_text_1.nativeTextStickerSchema.safeParse(params);
+    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: 'native-text', ...parsed.data },
+            output_type: 'image', 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);
+    if (!response.ok || !result.success || result.data.status === 'error') {
+        const error = zod_1.z.object({ error: zod_1.z.string() }).safeParse(data);
+        return { ok: false, code: response.ok ? 400 : response.status,
+            message: error.success ? error.data.error : 'Failed to submit native text sticker' };
+    }
+    return { ok: true, code: 200, message: 'Native text sticker submitted', data: result.data };
+}
 /** Submit TSX source and props; UGC owns registration and bundling. */
 async function submitRemotionCompositionRenderJob(params) {
     const { outputType = 'video', ...composition } = params;

package/package.json

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