@aviaryhq/cloudglue-js 0.1.9 → 0.2.0

package/dist/src/client.js

@@ -8,6 +8,7 @@ const Transcribe_1 = require("../generated/Transcribe");
 const Extract_1 = require("../generated/Extract");
 const Segmentations_1 = require("../generated/Segmentations");
 const Search_1 = require("../generated/Search");
+const Describe_1 = require("../generated/Describe");
 class CloudGlueError extends Error {
     constructor(message, statusCode, data, headers, responseData) {
         super(message);
@@ -186,6 +187,18 @@ class EnhancedCollectionsApi {
             queries: params,
         });
     }
+    async getMediaDescriptions(collectionId, fileId, response_format) {
+        return this.api.getMediaDescriptions({
+            params: { collection_id: collectionId, file_id: fileId },
+            queries: { response_format },
+        });
+    }
+    async listMediaDescriptions(collectionId, params = {}) {
+        return this.api.listCollectionMediaDescriptions({
+            params: { collection_id: collectionId },
+            queries: params,
+        });
+    }
     /**
      * Waits for a video in a collection to be ready by polling the getVideo endpoint until
      * the video reaches a terminal state (completed, failed, or not_applicable) or until maxAttempts is reached.
@@ -356,6 +369,53 @@ class EnhancedSearchApi {
         return this.api.searchContent(params);
     }
 }
+class EnhancedDescribeApi {
+    constructor(api) {
+        this.api = api;
+    }
+    async createDescribe(url, options = {}) {
+        return this.api.createDescribe({
+            url,
+            ...options,
+        });
+    }
+    async getDescribe(jobId, options = {}) {
+        return this.api.getDescribe({
+            params: { job_id: jobId },
+            queries: { response_format: options.response_format },
+        });
+    }
+    async listDescribes(params = {}) {
+        return this.api.listDescribes({ queries: params });
+    }
+    /**
+     * Waits for a description job to be ready by polling the getDescribe endpoint until
+     * the job reaches a terminal state (completed, failed, or not_applicable) or until maxAttempts is reached.
+     *
+     * @param jobId - The ID of the description job to wait for
+     * @param options - Optional configuration for polling behavior and response format
+     * @returns The final description job object
+     * @throws {CloudGlueError} If the job fails to process or maxAttempts is reached
+     */
+    async waitForReady(jobId, options = {}) {
+        const { pollingInterval = 5000, maxAttempts = 36, response_format, } = options;
+        let attempts = 0;
+        while (attempts < maxAttempts) {
+            const job = await this.getDescribe(jobId, { response_format });
+            // 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(`Description 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 description job ${jobId} to process after ${maxAttempts} attempts`);
+    }
+}
 /**
  * Main CloudGlue client class that provides access to all API functionality
  * through enhanced, user-friendly interfaces
@@ -372,7 +432,7 @@ class CloudGlue {
             headers: {
                 Authorization: `Bearer ${this.apiKey}`,
                 'x-sdk-client': 'cloudglue-js',
-                'x-sdk-version': '0.1.9',
+                'x-sdk-version': '0.2.0',
             },
             baseURL: this.baseUrl,
             timeout: this.timeout,
@@ -391,8 +451,9 @@ class CloudGlue {
         const extractApi = (0, Extract_1.createApiClient)(this.baseUrl, sharedConfig);
         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);
         // Configure base URL and axios config for all clients
-        [filesApi, collectionsApi, chatApi, transcribeApi, extractApi, segmentationsApi, searchApi].forEach((client) => {
+        [filesApi, collectionsApi, chatApi, transcribeApi, extractApi, segmentationsApi, searchApi, describeApi].forEach((client) => {
             Object.assign(client.axios.defaults, axiosConfig);
             client.axios.interceptors.response.use((response) => {
                 return response;
@@ -415,6 +476,7 @@ class CloudGlue {
         this.extract = new EnhancedExtractApi(extractApi);
         this.segmentations = new EnhancedSegmentationsApi(segmentationsApi);
         this.search = new EnhancedSearchApi(searchApi);
+        this.describe = new EnhancedDescribeApi(describeApi);
     }
 }
 exports.CloudGlue = CloudGlue;

package/dist/src/types.d.ts

@@ -4,6 +4,7 @@ import { schemas as chatSchemas } from '../generated/Chat';
 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 { SegmentationUniformConfig as SegmentationUniformConfigType, SegmentationShotDetectorConfig as SegmentationShotDetectorConfigType, SegmentationConfig as SegmentationConfigType } from '../generated/common';
 /**
  * Represents a video file in the Cloudglue system
@@ -127,3 +128,20 @@ export type SearchFilterCriteria = z.infer<typeof searchSchemas.SearchFilterCrit
  * Represents search filter options for metadata, video info, and file properties
  */
 export type SearchFilter = z.infer<typeof searchSchemas.SearchFilter>;
+/**
+ * Represents the result of a video description request
+ * Contains detailed information about the video content including speech, text, and visual descriptions
+ */
+export type Describe = z.infer<typeof describeSchemas.Describe>;
+/**
+ * Represents a list of description jobs
+ */
+export type DescribeList = z.infer<typeof describeSchemas.DescribeList>;
+/**
+ * Represents media description data for a video in a collection
+ */
+export type CollectionMediaDescription = z.infer<typeof collectionsSchemas.MediaDescription>;
+/**
+ * Represents a list of media descriptions for files in a collection
+ */
+export type CollectionMediaDescriptionsList = z.infer<typeof collectionsSchemas.CollectionMediaDescriptionsList>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aviaryhq/cloudglue-js",
-  "version": "0.1.9",
+  "version": "0.2.0",
   "description": "Cloudglue API client for Node.js",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",