ugcinc 4.24.0 → 4.26.0

package/dist/media-analysis.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mediaAnalysisResultSchema = exports.measureLayoutResultSchema = exports.sampleColorsResultSchema = exports.measureLayoutSchema = exports.sampleColorsSchema = exports.binaryMaskSchema = exports.audioTranscriptResultSchema = exports.audioLevelsResultSchema = exports.measureAudioLevelsSchema = exports.transcribeAudioSchema = exports.videoTextResultSchema = exports.imageTextResultSchema = exports.textLineSchema = exports.textRegionSchema = exports.readVideoTextSchema = exports.readImageTextSchema = exports.scenesResultSchema = exports.framesResultSchema = exports.analysisSourceSchema = exports.mediaAnalysisStatusSchema = exports.extractFramesSchema = exports.detectScenesSchema = void 0;
+exports.mediaAnalysisResultSchema = exports.matchTextStyleResultSchema = exports.matchTextStyleSchema = exports.measureLayoutResultSchema = exports.sampleColorsResultSchema = exports.measureLayoutSchema = exports.sampleColorsSchema = exports.binaryMaskSchema = exports.audioTranscriptResultSchema = exports.audioLevelsResultSchema = exports.measureAudioLevelsSchema = exports.transcribeAudioSchema = exports.videoTextResultSchema = exports.imageTextResultSchema = exports.textLineSchema = exports.textRegionSchema = exports.readVideoTextSchema = exports.readImageTextSchema = exports.scenesResultSchema = exports.framesResultSchema = exports.analysisSourceSchema = exports.mediaAnalysisStatusSchema = exports.extractFramesSchema = exports.detectScenesSchema = void 0;
 const zod_1 = require("zod");
 const videoUrl = zod_1.z.string().url().max(8192).refine(value => {
     const url = new URL(value);
@@ -106,4 +106,14 @@ exports.measureLayoutResultSchema = zod_1.z.object({ version: zod_1.z.literal(1)
     elements: zod_1.z.array(zod_1.z.object({ id: zod_1.z.string(), geometry: zod_1.z.enum(['box', 'mask']), box: boxSchema.nullable(), normalizedBox: boxSchema.nullable(), boxArea: time, visibleArea: time.nullable(), visibleFractionOfCanvas: time.nullable(), boxCenter: pointSchema.nullable(), visibleCentroid: pointSchema.nullable(), margins: edges.nullable() })),
     pairs: zod_1.z.array(zod_1.z.object({ a: zod_1.z.string(), b: zod_1.z.string(), boxIntersectionArea: time, boxIoU: time.nullable(), visibleIntersectionArea: time.nullable(), visibleIoU: time.nullable(), axisGaps: zod_1.z.object({ x: finiteNumber, y: finiteNumber }).nullable(), alignmentDeltas: edges.extend({ centerX: finiteNumber, centerY: finiteNumber }).nullable() })),
     warnings: zod_1.z.array(zod_1.z.string()), previewUrl: zod_1.z.string().url(), manifestUrl: zod_1.z.string().url() });
-exports.mediaAnalysisResultSchema = zod_1.z.discriminatedUnion('operation', [exports.framesResultSchema, exports.scenesResultSchema, exports.imageTextResultSchema, exports.videoTextResultSchema, exports.audioTranscriptResultSchema, exports.audioLevelsResultSchema, exports.sampleColorsResultSchema, exports.measureLayoutResultSchema]);
+exports.matchTextStyleSchema = zod_1.z.object({ url: videoUrl,
+    box: zod_1.z.object({ x: zod_1.z.number().int().min(0).max(4096), y: zod_1.z.number().int().min(0).max(4096), width: zod_1.z.number().int().min(16).max(1536), height: zod_1.z.number().int().min(16).max(512) }).strict().refine(b => b.x + b.width <= 4096 && b.y + b.height <= 4096, 'Region exceeds image limit'),
+    text: zod_1.z.string().min(1).max(160).refine(t => t.trim().length > 0 && t.split('\n').length <= 4 && /^[\x20-\x7e\n]+$/.test(t), 'Use printable Latin ASCII text, at most four lines').optional(),
+}).strict();
+const matchedTextElement = zod_1.z.object({ id: zod_1.z.string(), type: zod_1.z.literal('text'), x: finiteNumber, y: finiteNumber, width: finiteNumber, height: finiteNumber, zIndex: zod_1.z.number(), textIsVariable: zod_1.z.literal(false), text: zod_1.z.string(), font: zod_1.z.enum(['arial', 'tiktok', 'apple']), fontSize: finiteNumber,
+    fontWeight: zod_1.z.union([zod_1.z.literal(400), zod_1.z.literal(500), zod_1.z.literal(600), zod_1.z.literal(700), zod_1.z.literal(800), zod_1.z.literal(900)]), color: zod_1.z.string(), strokeColor: zod_1.z.string(), outlineWidth: finiteNumber, lineHeight: finiteNumber, letterSpacing: finiteNumber, textAlign: zod_1.z.enum(['left', 'center', 'right']), verticalAlign: zod_1.z.literal('top'), autoWidth: zod_1.z.literal(false), paddingTop: finiteNumber, paddingRight: finiteNumber, paddingBottom: finiteNumber, paddingLeft: finiteNumber });
+exports.matchTextStyleResultSchema = zod_1.z.object({ version: zod_1.z.literal(1), operation: zod_1.z.literal('match_text_style'), source: visualSource, box: boxSchema, surface: zod_1.z.literal('image-editor-element'), status: zod_1.z.enum(['fitted', 'unavailable']), reason: zod_1.z.string().nullable(), text: zod_1.z.string().nullable(), textSource: zod_1.z.enum(['supplied', 'ocr']),
+    renderer: zod_1.z.object({ name: zod_1.z.literal('UGC-ImageEditorComposition'), ugcVersion: zod_1.z.string(), fonts: zod_1.z.array(zod_1.z.string()), fontHashes: zod_1.z.record(zod_1.z.string()), maxRenders: zod_1.z.number() }),
+    candidates: zod_1.z.array(zod_1.z.object({ element: matchedTextElement, previewConfig: zod_1.z.object({ width: zod_1.z.number(), height: zod_1.z.number(), aspectRatio: zod_1.z.string(), dimensionPreset: zod_1.z.literal('custom'), elements: zod_1.z.array(matchedTextElement), backgroundType: zod_1.z.literal('color'), backgroundColor: zod_1.z.string() }), maskIoU: zod_1.z.number().min(0).max(1), foregroundMae: zod_1.z.number().min(0).max(1), fontIdentity: zod_1.z.literal('unverified'), quality: zod_1.z.enum(['close', 'approximate']) })).max(3),
+    renders: zod_1.z.number().int().nonnegative(), backgroundColor: zod_1.z.string(), warnings: zod_1.z.array(zod_1.z.string()), previewUrl: zod_1.z.string().url(), manifestUrl: zod_1.z.string().url() });
+exports.mediaAnalysisResultSchema = zod_1.z.discriminatedUnion('operation', [exports.framesResultSchema, exports.scenesResultSchema, exports.imageTextResultSchema, exports.videoTextResultSchema, exports.audioTranscriptResultSchema, exports.audioLevelsResultSchema, exports.sampleColorsResultSchema, exports.measureLayoutResultSchema, exports.matchTextStyleResultSchema]);

package/dist/media.d.ts

@@ -1,5 +1,5 @@
 import { BaseClient } from './base';
-import type { SampleColorsParams, MeasureLayoutParams, TranscribeAudioParams, MeasureAudioLevelsParams, ExtractFramesParams, DetectScenesParams, ReadImageTextParams, ReadVideoTextParams, MediaAnalysisJob } from './media-analysis';
+import type { MatchTextStyleParams, SampleColorsParams, MeasureLayoutParams, TranscribeAudioParams, MeasureAudioLevelsParams, ExtractFramesParams, DetectScenesParams, ReadImageTextParams, ReadVideoTextParams, MediaAnalysisJob } from './media-analysis';
 import type { ListProfilePostsParams, ListProfilePostsResult, DownloadSocialPostParams, DownloadSocialPostResult } from './social-acquisition';
 import type { ApiResponse } from './types';
 export interface UserMedia {
@@ -200,7 +200,8 @@ export interface OwnedUploadResponse {
  * Client for managing media files
  */
 export declare class MediaClient extends BaseClient {
-    /** Transcribe locally with explicit estimated segment/word timing. */
+    /** Fit supported image-editor text settings using local render-and-compare. */
+    matchTextStyle(params: MatchTextStyleParams): Promise<ApiResponse<MediaAnalysisJob>>;
     sampleColors(params: SampleColorsParams): Promise<ApiResponse<MediaAnalysisJob>>;
     measureLayout(params: MeasureLayoutParams): Promise<ApiResponse<MediaAnalysisJob>>;
     transcribeAudio(params: TranscribeAudioParams): Promise<ApiResponse<MediaAnalysisJob>>;

package/dist/media.js

@@ -6,7 +6,10 @@ const base_1 = require("./base");
  * Client for managing media files
  */
 class MediaClient extends base_1.BaseClient {
-    /** Transcribe locally with explicit estimated segment/word timing. */
+    /** Fit supported image-editor text settings using local render-and-compare. */
+    async matchTextStyle(params) {
+        return this.waitForAnalysis(await this.post('/media/analysis/match-text-style', params));
+    }
     async sampleColors(params) {
         return this.waitForAnalysis(await this.post('/media/analysis/sample-colors', params));
     }

package/dist/render/compositions/IMessageDmComposition/types.d.ts

@@ -401,8 +401,8 @@ export declare const iMessageDmPropsSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     width?: number | undefined;
     height?: number | undefined;
-    time?: string | undefined;
     backgroundColor?: string | undefined;
+    time?: string | undefined;
     lightMode?: boolean | undefined;
     username?: string | undefined;
     profilePicUrl?: string | undefined;
@@ -584,8 +584,8 @@ export declare const iMessageDmPropsSchema: z.ZodObject<{
 }, {
     width?: number | undefined;
     height?: number | undefined;
-    time?: string | undefined;
     backgroundColor?: string | undefined;
+    time?: string | undefined;
     lightMode?: boolean | undefined;
     username?: string | undefined;
     profilePicUrl?: string | undefined;

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/dist/tools/media.js

@@ -4,6 +4,7 @@ exports.mediaTools = void 0;
 const media_analysis_1 = require("../media-analysis");
 const zod_1 = require("zod");
 exports.mediaTools = [
+    { name: 'match_text_style', description: 'Fit a reference text crop to actual UGC image-editor text settings using local render-and-compare. Provide HTTPS image URL and integer display-pixel box with a small plain-background margin; optionally exact text with line breaks (otherwise local English OCR). Up to 160 printable ASCII characters/four lines; crop 16–1536 by 16–512. Returns three supported candidates, renderable preview configs, foreground residuals and a comparison image. Fonts are approximations, not identified originals. No shadow/gradient/perspective/mixed-style support; unsuitable references explicitly unavailable. Use get_media_analysis if pending.', schema: media_analysis_1.matchTextStyleSchema, execute: async (client, params) => client.media.matchTextStyle(params) },
     { name: 'sample_colors', description: 'Sample observed sRGB colors from an image URL: optional integer point, half-open source-pixel box, or full-size row-major binary RLE mask. Counts alternate background/foreground starting with background (not COCO order). Default whole image, maxColors 8 (1–32). Returns RGBA point and alpha-weighted palette, method, omitted proportion, source hash and preview. Does not recover original authoring colors. Use get_media_analysis if pending.', schema: media_analysis_1.sampleColorsSchema, execute: async (client, params) => client.media.sampleColors(params) },
     { name: 'measure_layout', description: 'Measure supplied element boxes or binary masks against an image URL. Returns margins, centers, spacing, alignment deltas and overlap. Coordinates are display-oriented source pixels. Masks match source dimensions, row-major counts alternate background/foreground starting with background (not COCO). Up to 32 uniquely identified elements. Visible area/intersection requires masks; boxes do not imply visible ink. Does not detect elements. Use get_media_analysis if pending.', schema: media_analysis_1.measureLayoutSchema, execute: async (client, params) => client.media.measureLayout(params) },
     { name: 'transcribe_audio', description: 'Transcribe audio/video using an owned local speech model. Returns text, source-relative milliseconds, estimated segment/word timings, model details and an audio preview. No forced alignment or speaker separation. Optional range <=120 seconds and channel 0/1; default averages channels. If pending, use get_media_analysis.', schema: media_analysis_1.transcribeAudioSchema, execute: async (client, params) => client.media.transcribeAudio(params) },

package/dist/types.d.ts

@@ -20,4 +20,4 @@ export interface ErrorResponse {
 export type ApiResponse<T> = SuccessResponse<T> | ErrorResponse;
 export type { PublicPostFailureCode, PublicPostRecovery, PublicPostNextAction, PublicPostFailure } from './post-failure';
 export type { ListProfilePostsParams, ListProfilePostsResult, DownloadSocialPostParams, DownloadSocialPostResult, SocialReferencePost, SocialReferenceAsset } from './social-acquisition';
-export type { SampleColorsParams, MeasureLayoutParams, SampleColorsResult, MeasureLayoutResult, TranscribeAudioParams, MeasureAudioLevelsParams, AudioTranscriptResult, AudioLevelsResult, ReadImageTextParams, ReadVideoTextParams, ImageTextResult, VideoTextResult, ExtractFramesParams, DetectScenesParams, FramesResult, ScenesResult, MediaAnalysisResult, MediaAnalysisJob } from "./media-analysis";
+export type { MatchTextStyleParams, MatchTextStyleResult, SampleColorsParams, MeasureLayoutParams, SampleColorsResult, MeasureLayoutResult, TranscribeAudioParams, MeasureAudioLevelsParams, AudioTranscriptResult, AudioLevelsResult, ReadImageTextParams, ReadVideoTextParams, ImageTextResult, VideoTextResult, ExtractFramesParams, DetectScenesParams, FramesResult, ScenesResult, MediaAnalysisResult, MediaAnalysisJob } from "./media-analysis";

package/package.json

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