@aviaryhq/cloudglue-js 0.2.4 → 0.2.5

package/dist/src/client.d.ts

@@ -1,6 +1,6 @@
-import { FilesApi, CollectionsApi, ChatApi, TranscribeApi, ExtractApi, SearchApi, DescribeApi } from "../generated";
+import { FilesApi, CollectionsApi, ChatApi, TranscribeApi, ExtractApi, SearchApi, DescribeApi, SegmentsApi } from "../generated";
 import { FilterOperator } from "./types";
-import type { File, SegmentationConfig, UpdateFileParams } from "./types";
+import type { File, NarrativeConfig, SegmentationConfig, ShotConfig, UpdateFileParams } from "./types";
 import { SegmentationsApi } from "../generated/Segmentations";
 import { ThumbnailsConfig } from "../generated/common";
 export declare class CloudGlueError extends Error {
@@ -308,17 +308,14 @@ declare class EnhancedFilesApi {
                 hop_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
             }, import("zod").ZodTypeAny, "passthrough">>>;
             shot_detector_config: import("zod").ZodOptional<import("zod").ZodObject<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
@@ -338,17 +335,14 @@ declare class EnhancedFilesApi {
                 hop_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
             }, import("zod").ZodTypeAny, "passthrough">>>;
             shot_detector_config: import("zod").ZodOptional<import("zod").ZodObject<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
@@ -368,17 +362,14 @@ declare class EnhancedFilesApi {
                 hop_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
             }, import("zod").ZodTypeAny, "passthrough">>>;
             shot_detector_config: import("zod").ZodOptional<import("zod").ZodObject<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
@@ -2485,17 +2476,14 @@ declare class EnhancedSegmentationsApi {
                 hop_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
             }, import("zod").ZodTypeAny, "passthrough">>>;
             shot_detector_config: import("zod").ZodOptional<import("zod").ZodObject<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
@@ -2515,17 +2503,14 @@ declare class EnhancedSegmentationsApi {
                 hop_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
             }, import("zod").ZodTypeAny, "passthrough">>>;
             shot_detector_config: import("zod").ZodOptional<import("zod").ZodObject<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
@@ -2545,17 +2530,14 @@ declare class EnhancedSegmentationsApi {
                 hop_seconds: import("zod").ZodOptional<import("zod").ZodNumber>;
             }, import("zod").ZodTypeAny, "passthrough">>>;
             shot_detector_config: import("zod").ZodOptional<import("zod").ZodObject<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
             }, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{
-                threshold: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 min_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 max_seconds: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodNumber>>;
                 detector: import("zod").ZodEnum<["adaptive", "content"]>;
@@ -2922,6 +2904,123 @@ declare class EnhancedDescribeApi {
         error?: string | undefined;
     }>;
 }
+declare class EnhancedSegmentsApi {
+    private readonly api;
+    constructor(api: typeof SegmentsApi);
+    listSegmentJobs(data: {
+        criteria: "shot" | "narrative";
+        url?: string;
+        status?: "pending" | "processing" | "completed" | "failed";
+        limit?: number;
+        offset?: number;
+        created_before?: string;
+        created_after?: string;
+        order?: "created_at";
+        sort?: "asc" | "desc";
+    }): Promise<{
+        object: "list";
+        data: Array<{
+            job_id: string;
+            file_id: string;
+            object: "segments";
+            status: "pending" | "processing" | "completed" | "failed";
+            criteria: "shot" | "narrative";
+            created_at: number;
+            shot_config?: Partial<{
+                detector: "content" | "adaptive";
+                max_duration_seconds: number;
+                min_duration_seconds: number;
+            }> | undefined;
+            narrative_config?: Partial<{
+                prompt: string;
+            }> | undefined;
+            total_segments?: number | undefined;
+            segments?: Array<{
+                start_time: number;
+                end_time: number;
+                description?: string | undefined;
+                thumbnail_url?: string | undefined;
+            }> | undefined;
+        }>;
+        total: number;
+        limit: number;
+        offset: number;
+    }>;
+    getSegmentJob(jobId: string): Promise<{
+        job_id: string;
+        file_id: string;
+        object: "segments";
+        status: "pending" | "processing" | "completed" | "failed";
+        criteria: "shot" | "narrative";
+        created_at: number;
+        shot_config?: Partial<{
+            detector: "content" | "adaptive";
+            max_duration_seconds: number;
+            min_duration_seconds: number;
+        }> | undefined;
+        narrative_config?: Partial<{
+            prompt: string;
+        }> | undefined;
+        total_segments?: number | undefined;
+        segments?: Array<{
+            start_time: number;
+            end_time: number;
+            description?: string | undefined;
+            thumbnail_url?: string | undefined;
+        }> | undefined;
+    }>;
+    createSegmentJob(params: {
+        url: string;
+        criteria: "shot" | "narrative";
+        shot_config?: ShotConfig;
+        narrative_config?: NarrativeConfig;
+    }): Promise<{
+        job_id: string;
+        file_id: string;
+        object: "segments";
+        status: "pending" | "processing" | "completed" | "failed";
+        criteria: "shot" | "narrative";
+        created_at: number;
+        shot_config?: Partial<{
+            detector: "content" | "adaptive";
+            max_duration_seconds: number;
+            min_duration_seconds: number;
+        }> | undefined;
+        narrative_config?: Partial<{
+            prompt: string;
+        }> | undefined;
+        total_segments?: number | undefined;
+        segments?: Array<{
+            start_time: number;
+            end_time: number;
+            description?: string | undefined;
+            thumbnail_url?: string | undefined;
+        }> | undefined;
+    }>;
+    waitForReady(jobId: string, options?: WaitForReadyOptions): Promise<{
+        job_id: string;
+        file_id: string;
+        object: "segments";
+        status: "pending" | "processing" | "completed" | "failed";
+        criteria: "shot" | "narrative";
+        created_at: number;
+        shot_config?: Partial<{
+            detector: "content" | "adaptive";
+            max_duration_seconds: number;
+            min_duration_seconds: number;
+        }> | undefined;
+        narrative_config?: Partial<{
+            prompt: string;
+        }> | undefined;
+        total_segments?: number | undefined;
+        segments?: Array<{
+            start_time: number;
+            end_time: number;
+            description?: string | undefined;
+            thumbnail_url?: string | undefined;
+        }> | undefined;
+    }>;
+}
 /**
  * Main CloudGlue client class that provides access to all API functionality
  * through enhanced, user-friendly interfaces
@@ -2970,6 +3069,7 @@ export declare class CloudGlue {
      * Provides methods for getting detailed descriptions of video content
      */
     readonly describe: EnhancedDescribeApi;
+    readonly segments: EnhancedSegmentsApi;
     constructor(config?: CloudGlueConfig);
 }
 export {};

package/dist/src/client.js

@@ -9,6 +9,7 @@ const Extract_1 = require("../generated/Extract");
 const Segmentations_1 = require("../generated/Segmentations");
 const Search_1 = require("../generated/Search");
 const Describe_1 = require("../generated/Describe");
+const Segments_1 = require("../generated/Segments");
 class CloudGlueError extends Error {
     constructor(message, statusCode, data, headers, responseData) {
         super(message);
@@ -426,6 +427,38 @@ class EnhancedDescribeApi {
         throw new CloudGlueError(`Timeout waiting for description job ${jobId} to process after ${maxAttempts} attempts`);
     }
 }
+class EnhancedSegmentsApi {
+    constructor(api) {
+        this.api = api;
+    }
+    async listSegmentJobs(data) {
+        return this.api.listSegments({ queries: data });
+    }
+    async getSegmentJob(jobId) {
+        return this.api.getSegments({ params: { job_id: jobId } });
+    }
+    async createSegmentJob(params) {
+        return this.api.createSegments(params);
+    }
+    async waitForReady(jobId, options = {}) {
+        const { pollingInterval = 5000, maxAttempts = 36, } = options;
+        let attempts = 0;
+        while (attempts < maxAttempts) {
+            const job = await this.getSegmentJob(jobId);
+            // If we've reached a terminal state, return the job
+            if (["completed", "failed", "not_applicable"].includes(job.status)) {
+                if (job.status === "failed") {
+                    throw new CloudGlueError(`Segment job failed: ${jobId}`);
+                }
+                return job;
+            }
+            // Wait for the polling interval before trying again
+            await new Promise((resolve) => setTimeout(resolve, pollingInterval));
+            attempts++;
+        }
+        throw new CloudGlueError(`Timeout waiting for segment job ${jobId} to process after ${maxAttempts} attempts`);
+    }
+}
 /**
  * Main CloudGlue client class that provides access to all API functionality
  * through enhanced, user-friendly interfaces
@@ -442,7 +475,7 @@ class CloudGlue {
             headers: {
                 Authorization: `Bearer ${this.apiKey}`,
                 'x-sdk-client': 'cloudglue-js',
-                'x-sdk-version': '0.2.4',
+                'x-sdk-version': '0.2.5',
             },
             baseURL: this.baseUrl,
             timeout: this.timeout,
@@ -462,8 +495,9 @@ class CloudGlue {
         const segmentationsApi = (0, Segmentations_1.createApiClient)(this.baseUrl, sharedConfig);
         const searchApi = (0, Search_1.createApiClient)(this.baseUrl, sharedConfig);
         const describeApi = (0, Describe_1.createApiClient)(this.baseUrl, sharedConfig);
+        const segmentsApi = (0, Segments_1.createApiClient)(this.baseUrl, sharedConfig);
         // Configure base URL and axios config for all clients
-        [filesApi, collectionsApi, chatApi, transcribeApi, extractApi, segmentationsApi, searchApi, describeApi].forEach((client) => {
+        [filesApi, collectionsApi, chatApi, transcribeApi, extractApi, segmentationsApi, searchApi, describeApi, segmentsApi].forEach((client) => {
             Object.assign(client.axios.defaults, axiosConfig);
             client.axios.interceptors.response.use((response) => {
                 return response;
@@ -487,6 +521,7 @@ class CloudGlue {
         this.segmentations = new EnhancedSegmentationsApi(segmentationsApi);
         this.search = new EnhancedSearchApi(searchApi);
         this.describe = new EnhancedDescribeApi(describeApi);
+        this.segments = new EnhancedSegmentsApi(segmentsApi);
     }
 }
 exports.CloudGlue = CloudGlue;

package/dist/src/types.d.ts

@@ -5,6 +5,7 @@ import { schemas as transcribeSchemas } from '../generated/Transcribe';
 import { schemas as extractSchemas } from '../generated/Extract';
 import { schemas as searchSchemas } from '../generated/Search';
 import { schemas as describeSchemas } from '../generated/Describe';
+import { schemas as segmentsSchemas } from '../generated/Segments';
 import { SegmentationUniformConfig as SegmentationUniformConfigType, SegmentationShotDetectorConfig as SegmentationShotDetectorConfigType, SegmentationConfig as SegmentationConfigType } from '../generated/common';
 /**
  * Represents a video file in the Cloudglue system
@@ -159,3 +160,5 @@ export type CollectionMediaDescription = z.infer<typeof collectionsSchemas.Media
  * Represents a list of media descriptions for files in a collection
  */
 export type CollectionMediaDescriptionsList = z.infer<typeof collectionsSchemas.CollectionMediaDescriptionsList>;
+export type NarrativeConfig = z.infer<typeof segmentsSchemas.NarrativeConfig>;
+export type ShotConfig = z.infer<typeof segmentsSchemas.ShotConfig>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aviaryhq/cloudglue-js",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Cloudglue API client for Node.js",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -12,7 +12,8 @@
     "generate": "node generate.js",
     "build": "tsc && node scripts/build.js",
     "watch": "tsc --watch",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "publish": "npm run build && npm publish"
   },
   "repository": {
     "type": "git",