ugcinc 3.18.0 → 3.20.0

package/dist/automations.d.ts

@@ -1,4 +1,4 @@
-import type { NodeControlConfig, NodeCategory, MediaType, NodePort, NodeTypeEnum, WorkflowDefinition, AutomationTemplate, AutomationRun, ExecutorNode, ExecutionEdge, ApiResponse, AutomationExport, AutomationRunExport } from './types';
+import type { NodeControlConfig, NodeCategory, MediaType, NodePort, NodeTypeEnum, WorkflowDefinition, AutomationTemplate, AutomationRun, ExecutorNode, ExecutionEdge, ApiResponse, AutomationExport, AutomationRunExport, PropertySchema } from './types';
 import { BaseClient } from './base';
 export declare class AutomationsClient extends BaseClient {
     /**
@@ -135,4 +135,14 @@ export declare function getAllNodes(): NodeControlConfig[];
  * Get a specific node by type
  */
 export declare function getNodeByType(type: string): NodeControlConfig | undefined;
-export type { NodeControlConfig, NodeCategory, MediaType, NodePort, NodeTypeEnum };
+/**
+ * Get the schema of array items for a node's output port.
+ * Returns null if schema is unknown or the output is not an array.
+ *
+ * @param nodeType - The type of the node (e.g., 'transcript', 'text-generation')
+ * @param nodeConfig - The node's configuration object
+ * @param outputPortId - The ID of the output port to get schema for
+ * @returns The schema of array items, or null if unknown
+ */
+export declare function getOutputSchema(nodeType: string, nodeConfig: Record<string, unknown> | undefined, outputPortId: string): Record<string, PropertySchema> | null;
+export type { NodeControlConfig, NodeCategory, MediaType, NodePort, NodeTypeEnum, PropertySchema };

package/dist/automations.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AutomationsClient = void 0;
 exports.getAllNodes = getAllNodes;
 exports.getNodeByType = getNodeByType;
+exports.getOutputSchema = getOutputSchema;
 const base_1 = require("./base");
 class AutomationsClient extends base_1.BaseClient {
     /**
@@ -488,19 +489,8 @@ function getAllNodes() {
                     required: true,
                 },
             ],
-            // Base outputs - additional outputs are dynamic based on forEachConfig.outputProperties
-            outputs: [
-                {
-                    id: "item",
-                    type: "object",
-                    required: true,
-                },
-                {
-                    id: "index",
-                    type: "text",
-                    required: false,
-                },
-            ],
+            // Dynamic outputs based on forEachConfig (exposeItem, exposeIndex, outputProperties, inputPorts)
+            outputs: [],
         },
         // === Transcript ===
         {
@@ -526,6 +516,11 @@ function getAllNodes() {
                     id: "segments",
                     type: "object",
                     required: true,
+                    itemSchema: {
+                        text: { type: 'string' },
+                        start: { type: 'number' },
+                        end: { type: 'number' },
+                    },
                 },
             ],
         },
@@ -559,3 +554,71 @@ function getAllNodes() {
 function getNodeByType(type) {
     return getAllNodes().find(node => node.type === type);
 }
+/**
+ * Convert LLM output field type to PropertySchema type
+ */
+function llmTypeToSchemaType(type) {
+    if (type === 'string')
+        return 'string';
+    if (type === 'number')
+        return 'number';
+    if (type === 'boolean')
+        return 'boolean';
+    return 'object';
+}
+/**
+ * Convert LLM objectSchema to PropertySchema record
+ */
+function llmObjectSchemaToPropertySchema(fields) {
+    const result = {};
+    for (const field of fields) {
+        if (field.type === 'array' && field.items === 'object' && field.objectSchema) {
+            // Nested array of objects
+            result[field.name] = {
+                type: 'object',
+                itemSchema: llmObjectSchemaToPropertySchema(field.objectSchema),
+            };
+        }
+        else if (field.type === 'array' && field.items) {
+            // Array of primitives
+            result[field.name] = {
+                type: 'object', // Arrays are represented as 'object' type
+            };
+        }
+        else {
+            result[field.name] = {
+                type: llmTypeToSchemaType(field.type),
+            };
+        }
+    }
+    return result;
+}
+/**
+ * Get the schema of array items for a node's output port.
+ * Returns null if schema is unknown or the output is not an array.
+ *
+ * @param nodeType - The type of the node (e.g., 'transcript', 'text-generation')
+ * @param nodeConfig - The node's configuration object
+ * @param outputPortId - The ID of the output port to get schema for
+ * @returns The schema of array items, or null if unknown
+ */
+function getOutputSchema(nodeType, nodeConfig, outputPortId) {
+    // First check static node definitions
+    const nodeDefinition = getNodeByType(nodeType);
+    const outputPort = nodeDefinition?.outputs.find(o => o.id === outputPortId);
+    if (outputPort?.itemSchema) {
+        return outputPort.itemSchema;
+    }
+    // For text-generation (LLM) nodes, derive from outputFields config
+    if (nodeType === 'text-generation' && nodeConfig) {
+        const llmConfig = nodeConfig.llm;
+        const outputFields = llmConfig?.outputFields;
+        if (outputFields) {
+            const field = outputFields.find(f => f.name === outputPortId);
+            if (field?.type === 'array' && field.items === 'object' && field.objectSchema) {
+                return llmObjectSchemaToPropertySchema(field.objectSchema);
+            }
+        }
+    }
+    return null;
+}

package/dist/index.d.ts

@@ -10,7 +10,8 @@ export { PostsClient } from './posts';
 export { StatsClient } from './stats';
 export { OrganizationClient } from './org';
 export { RenderClient } from './render';
-export { AutomationsClient, getAllNodes, getNodeByType } from './automations';
+export { AutomationsClient, getAllNodes, getNodeByType, getOutputSchema } from './automations';
+export type { PropertySchema } from './automations';
 export { portId, isValidPortId, portIdToTitle, normalizeToPortId, PortIdSchema } from './port-id';
 export type { PortId } from './port-id';
 export { MediaClient } from './media';

package/dist/index.js

@@ -5,7 +5,7 @@
  * Official TypeScript/JavaScript client for the UGC Inc API
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommentsClient = exports.MediaClient = exports.PortIdSchema = exports.normalizeToPortId = exports.portIdToTitle = exports.isValidPortId = exports.portId = exports.getNodeByType = exports.getAllNodes = exports.AutomationsClient = exports.RenderClient = exports.OrganizationClient = exports.StatsClient = exports.PostsClient = exports.TasksClient = exports.AccountsClient = exports.UGCClient = void 0;
+exports.CommentsClient = exports.MediaClient = exports.PortIdSchema = exports.normalizeToPortId = exports.portIdToTitle = exports.isValidPortId = exports.portId = exports.getOutputSchema = 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,6 +24,7 @@ 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; } });
+Object.defineProperty(exports, "getOutputSchema", { enumerable: true, get: function () { return automations_1.getOutputSchema; } });
 var port_id_1 = require("./port-id");
 Object.defineProperty(exports, "portId", { enumerable: true, get: function () { return port_id_1.portId; } });
 Object.defineProperty(exports, "isValidPortId", { enumerable: true, get: function () { return port_id_1.isValidPortId; } });

package/dist/types.d.ts

@@ -788,10 +788,19 @@ export interface NodeOutputValues {
     _values: unknown[];
     _outputMode: OutputMode;
 }
+/**
+ * Schema definition for a property within an array item
+ */
+export interface PropertySchema {
+    type: 'string' | 'number' | 'boolean' | 'object';
+    itemSchema?: Record<string, PropertySchema>;
+}
 export interface NodePort {
     id: string;
     type: PortType | PortType[];
     required: boolean;
+    /** Schema of array items (when this port outputs an array) */
+    itemSchema?: Record<string, PropertySchema>;
 }
 /**
  * Functional category for automation nodes
@@ -1211,6 +1220,10 @@ export interface ForEachNodeConfig {
     outputProperties?: ForEachOutputProperty[];
     /** Input ports for single-value passthrough (Mode 2) */
     inputPorts?: ForEachInputPort[];
+    /** Whether to expose the full item object as an output (default: false) */
+    exposeItem?: boolean;
+    /** Whether to expose the iteration index as an output (default: false) */
+    exposeIndex?: boolean;
 }
 /**
  * Supported platforms for video import

package/package.json

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