@aviaryhq/cloudglue-js 0.0.9

package/LICENSE.md

@@ -0,0 +1,44 @@
+Elastic License 2.0 (ELv2)
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below.
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The *licensor* is the entity offering these terms, and the *software* is the software the licensor makes available under these terms, including any portion of it.
+
+*you* refers to the individual or entity agreeing to these terms.
+
+*your company* is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. *control* means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+*your licenses* are all the licenses granted to you for the software under these terms.
+
+*use* means anything you do with the software requiring one of your licenses.
+
+*trademark* means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,105 @@
+# CloudGlue JavaScript SDK
+
+Official JavaScript SDK for the CloudGlue API.
+
+## 📖 Resources
+
+- [CloudGlue API Docs](https://docs.cloudglue.dev)
+- [Terms of Service](https://cloudglue.dev/terms)
+- [Privacy Policy](https://cloudglue.dev/privacy)
+- [Pricing](https://cloudglue.dev/pricing)
+
+> By using this SDK, you agree to the [CloudGlue Terms of Service](https://cloudglue.dev/terms) and acknowledge our [Privacy Policy](https://cloudglue.dev/privacy).
+
+## Installation
+
+```bash
+npm install @aviaryhq/cloudglue-js
+```
+
+## Quick Start
+
+```typescript
+import { CloudGlue } from '@aviaryhq/cloudglue-js';
+
+// Initialize the client
+const client = new CloudGlue({
+  apiKey: process.env.CLOUDGLUE_API_KEY
+});
+
+// List your video files
+const response = await client.files.listFiles({ limit: 10 });
+
+// Chat with a collection
+const chatResponse = await client.chat.createCompletion({
+  model: 'nimbus-001',
+  messages: [
+    { role: 'user', content: 'What are the key points discussed in these videos?' }
+  ],
+  // Assumes collection already exists, otherwise create one first then reference here by collection id 
+  collections: ['your_collection_id'],
+  include_citations: true,
+  force_search: true
+});
+```
+
+## Configuration
+
+The `CloudGlue` client accepts the following configuration options:
+
+```typescript
+interface CloudGlueConfig {
+  apiKey?: string;      // Your API key (can also use CLOUDGLUE_API_KEY env var)
+  baseUrl?: string;     // Optional custom base URL
+}
+```
+
+## Development
+
+### Prerequisites
+- Node.js 16+
+- npm or yarn
+- Git (for spec submodule)
+
+### Setup
+
+1. Clone the repository:
+```bash
+git clone https://github.com/aviaryhq/cloudglue-js.git
+cd cloudglue-js
+```
+
+2. Initialize the spec submodule:
+```bash
+make submodule-init
+```
+
+3. Install dependencies:
+```bash
+npm install
+```
+
+4. Generate API clients:
+```bash
+npm run generate
+```
+
+### Available Commands
+
+- `make submodule-init`: Initialize the OpenAPI spec submodule
+- `make submodule-update`: Update the OpenAPI spec submodule
+- `npm run generate`: Generate API clients from the spec
+- `npm run build`: Build the package
+- `npm run clean`: Clean build artifacts
+- `npm run prepare`: Build the package (used by npm)
+- `npm run watch`: Watch for changes and rebuild automatically (development)
+
+### Building
+
+```bash
+npm run build
+```
+
+This will:
+1. Clean the previous build
+2. Compile TypeScript files

package/dist/client.d.ts

@@ -0,0 +1,156 @@
+import { FilesApi, CollectionsApi, ChatApi, DescribeApi, ExtractApi } from '../generated';
+export declare class CloudGlueError extends Error {
+    readonly statusCode?: number | undefined;
+    readonly data?: string | undefined;
+    readonly headers?: Record<string, any> | undefined;
+    constructor(message: string, statusCode?: number | undefined, data?: string | undefined, headers?: Record<string, any> | undefined);
+}
+/**
+ * Configuration options for initializing the CloudGlue client
+ */
+export interface CloudGlueConfig {
+    apiKey?: string;
+    baseUrl?: string;
+}
+interface ListFilesParams {
+    status?: 'pending' | 'processing' | 'ready' | 'completed' | 'failed' | 'not_applicable';
+    limit?: number;
+    offset?: number;
+    order?: 'created_at' | 'filename';
+    sort?: 'asc' | 'desc';
+}
+interface UploadFileParams {
+    file: globalThis.File;
+    metadata?: Record<string, any>;
+}
+interface ListCollectionParams {
+    limit?: number;
+    offset?: number;
+    order?: 'name' | 'created_at';
+    sort?: 'asc' | 'desc';
+}
+interface CreateCollectionParams {
+    name: string;
+    description?: string;
+    describe_config?: {
+        enable_speech?: boolean;
+        enable_scene_text?: boolean;
+        enable_visual_scene_description?: boolean;
+    };
+    extract_config?: {
+        prompt?: string;
+        schema?: Record<string, any>;
+    };
+}
+interface ListCollectionVideosParams {
+    limit?: number;
+    offset?: number;
+    status?: 'pending' | 'processing' | 'ready' | 'completed' | 'failed' | 'not_applicable';
+    order?: 'added_at' | 'filename';
+    sort?: 'asc' | 'desc';
+}
+interface ChatCompletionParams {
+    model?: string;
+    messages: Array<{
+        role: 'system' | 'user' | 'assistant';
+        content: string;
+        name?: string;
+    }>;
+    collections: string[];
+    filter?: {
+        metadata?: Array<{
+            path: string;
+            operator: 'NotEqual' | 'Equal' | 'LessThan' | 'GreaterThan' | 'In' | 'ContainsAny' | 'ContainsAll';
+            valueText?: string;
+            valueTextArray?: string[];
+        }>;
+    };
+    force_search?: boolean;
+    result_format?: 'text' | 'markdown' | 'json';
+    include_citations?: boolean;
+    temperature?: number;
+    top_p?: number;
+    max_tokens?: number;
+}
+declare class EnhancedFilesApi {
+    private readonly api;
+    constructor(api: typeof FilesApi);
+    listFiles(params?: ListFilesParams): Promise<any>;
+    uploadFile(params: UploadFileParams): Promise<any>;
+    getFile(fileId: string): Promise<any>;
+    deleteFile(fileId: string): Promise<any>;
+}
+declare class EnhancedCollectionsApi {
+    private readonly api;
+    constructor(api: typeof CollectionsApi);
+    listCollections(params?: ListCollectionParams): Promise<any>;
+    createCollection(params: CreateCollectionParams): Promise<any>;
+    getCollection(collectionId: string): Promise<any>;
+    deleteCollection(collectionId: string): Promise<any>;
+    addVideo(collectionId: string, fileId: string): Promise<any>;
+    listVideos(collectionId: string, params?: ListCollectionVideosParams): Promise<any>;
+    getVideo(collectionId: string, fileId: string): Promise<any>;
+    deleteVideo(collectionId: string, fileId: string): Promise<any>;
+    getEntities(collectionId: string, fileId: string, limit?: number, offset?: number): Promise<any>;
+    getDescription(collectionId: string, fileId: string, limit?: number, offset?: number): Promise<any>;
+    addYouTubeVideo(collectionId: string, url: string, metadata?: Record<string, any>): Promise<any>;
+}
+declare class EnhancedChatApi {
+    private readonly api;
+    constructor(api: typeof ChatApi);
+    createCompletion(params: ChatCompletionParams): Promise<any>;
+}
+declare class EnhancedDescribeApi {
+    private readonly api;
+    constructor(api: typeof DescribeApi);
+    createDescribe(url: string, options?: {
+        enable_speech?: boolean;
+        enable_scene_text?: boolean;
+        enable_visual_scene_description?: boolean;
+    }): Promise<any>;
+    getDescribe(jobId: string): Promise<any>;
+}
+declare class EnhancedExtractApi {
+    private readonly api;
+    constructor(api: typeof ExtractApi);
+    createExtract(url: string, options?: {
+        prompt?: string;
+        schema?: Record<string, any>;
+    }): Promise<any>;
+    getExtract(jobId: string): Promise<any>;
+}
+/**
+ * Main CloudGlue client class that provides access to all API functionality
+ * through enhanced, user-friendly interfaces
+ */
+export declare class CloudGlue {
+    private readonly baseUrl;
+    private readonly apiKey;
+    /**
+     * Files API for managing video files
+     * Provides methods for uploading, listing, and managing video files
+     */
+    readonly files: EnhancedFilesApi;
+    /**
+     * Collections API for organizing videos into collections
+     * Provides methods for creating and managing collections of videos
+     */
+    readonly collections: EnhancedCollectionsApi;
+    /**
+     * Chat API for interacting with videos through natural language
+     * Provides methods for querying and getting responses about video content
+     */
+    readonly chat: EnhancedChatApi;
+    /**
+     * Describe API for generating rich descriptions of videos
+     * Provides methods for getting detailed descriptions of video content
+     */
+    readonly describe: EnhancedDescribeApi;
+    /**
+     * Extract API for extracting structured data from videos
+     * Provides methods for extracting specific information from video content
+     */
+    readonly extract: EnhancedExtractApi;
+    constructor(config?: CloudGlueConfig);
+}
+export {};

package/dist/client.js

@@ -0,0 +1,189 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudGlue = exports.CloudGlueError = void 0;
+const generated_1 = require("../generated");
+class CloudGlueError extends Error {
+    constructor(message, statusCode, data, headers) {
+        super(message);
+        this.statusCode = statusCode;
+        this.data = data;
+        this.headers = headers;
+    }
+}
+exports.CloudGlueError = CloudGlueError;
+// Enhanced API client classes
+class EnhancedFilesApi {
+    constructor(api) {
+        this.api = api;
+    }
+    async listFiles(params = {}) {
+        return this.api.listFiles({ queries: params });
+    }
+    async uploadFile(params) {
+        // File uploads require special handling for multipart/form-data that the generated Zodios client doesn't handle automatically.
+        // We need to:
+        // 1. Create a FormData object and append the file with the correct field name
+        // 2. JSON stringify the metadata if present
+        // 3. Set the correct Content-Type header
+        // This is why we use axios directly instead of the generated client method.
+        const formData = new FormData();
+        formData.append('file', params.file);
+        // Add metadata if provided
+        if (params.metadata) {
+            formData.append('metadata', JSON.stringify(params.metadata));
+        }
+        // Use axios directly to bypass Zodios validation
+        return this.api.axios({
+            method: 'post',
+            url: '/files',
+            data: formData,
+            headers: {
+                'Content-Type': 'multipart/form-data'
+            }
+        });
+    }
+    async getFile(fileId) {
+        return this.api.getFile({ params: { file_id: fileId } });
+    }
+    async deleteFile(fileId) {
+        return this.api.deleteFile({ params: { file_id: fileId } }, { params: { file_id: fileId } });
+    }
+}
+class EnhancedCollectionsApi {
+    constructor(api) {
+        this.api = api;
+    }
+    async listCollections(params = {}) {
+        return this.api.listCollections({ queries: params });
+    }
+    async createCollection(params) {
+        return this.api.createCollection(params);
+    }
+    async getCollection(collectionId) {
+        return this.api.getCollection({ params: { collection_id: collectionId } });
+    }
+    async deleteCollection(collectionId) {
+        return this.api.deleteCollection({ params: { collection_id: collectionId } }, { params: { collection_id: collectionId } });
+    }
+    async addVideo(collectionId, fileId) {
+        return this.api.addVideo({ file_id: fileId }, { params: { collection_id: collectionId } });
+    }
+    async listVideos(collectionId, params = {}) {
+        return this.api.listVideos({
+            params: { collection_id: collectionId },
+            queries: params
+        });
+    }
+    async getVideo(collectionId, fileId) {
+        return this.api.getVideo({
+            params: { collection_id: collectionId, file_id: fileId }
+        });
+    }
+    async deleteVideo(collectionId, fileId) {
+        return this.api.deleteVideo({
+            params: { collection_id: collectionId, file_id: fileId }
+        }, { params: { collection_id: collectionId, file_id: fileId } });
+    }
+    async getEntities(collectionId, fileId, limit, offset) {
+        return this.api.getEntities({
+            params: { collection_id: collectionId, file_id: fileId },
+            queries: { limit, offset }
+        });
+    }
+    async getDescription(collectionId, fileId, limit, offset) {
+        return this.api.getDescription({
+            params: { collection_id: collectionId, file_id: fileId },
+            queries: { limit, offset }
+        });
+    }
+    async addYouTubeVideo(collectionId, url, metadata) {
+        return this.api.addYouTubeVideo({ url, metadata }, { params: { collection_id: collectionId } });
+    }
+}
+class EnhancedChatApi {
+    constructor(api) {
+        this.api = api;
+    }
+    async createCompletion(params) {
+        return this.api.createCompletion({
+            model: params.model || 'nimbus-001',
+            ...params
+        });
+    }
+}
+class EnhancedDescribeApi {
+    constructor(api) {
+        this.api = api;
+    }
+    async createDescribe(url, options = {}) {
+        return this.api.createDescribe({
+            url,
+            ...options
+        });
+    }
+    async getDescribe(jobId) {
+        return this.api.getDescribe({ params: { job_id: jobId } });
+    }
+}
+class EnhancedExtractApi {
+    constructor(api) {
+        this.api = api;
+    }
+    async createExtract(url, options) {
+        return this.api.createExtract({
+            url,
+            ...options
+        });
+    }
+    async getExtract(jobId) {
+        return this.api.getExtract({ params: { job_id: jobId } });
+    }
+}
+/**
+ * Main CloudGlue client class that provides access to all API functionality
+ * through enhanced, user-friendly interfaces
+ */
+class CloudGlue {
+    constructor(config = {}) {
+        this.apiKey = config.apiKey || process.env.CLOUDGLUE_API_KEY || '';
+        this.baseUrl = config.baseUrl || 'https://api.cloudglue.dev/v1';
+        if (!this.apiKey) {
+            throw new Error('API key is required. Please provide an API key via constructor or CLOUDGLUE_API_KEY environment variable.');
+        }
+        const axiosConfig = {
+            headers: {
+                Authorization: `Bearer ${this.apiKey}`
+            }
+        };
+        // Initialize all API clients with the configured base URL and auth
+        const filesApi = generated_1.FilesApi;
+        const collectionsApi = generated_1.CollectionsApi;
+        const chatApi = generated_1.ChatApi;
+        const describeApi = generated_1.DescribeApi;
+        const extractApi = generated_1.ExtractApi;
+        // Configure base URL and axios config for all clients
+        [filesApi, collectionsApi, chatApi, describeApi, extractApi].forEach(client => {
+            client.axios.defaults.baseURL = this.baseUrl;
+            client.axios.interceptors.response.use((response) => {
+                return response;
+            }, (error) => {
+                if (error.response) {
+                    // The request was made and the server responded with a status code
+                    // that falls out of the range of 2xx
+                    const data = error.response.data;
+                    return Promise.reject(new CloudGlueError(data.error, error.response.status, error.config.data, error.response.headers));
+                }
+                // Something happened in setting up the request that triggered an Error
+                return Promise.reject(new CloudGlueError(error.message, error.statusCode ?? 500, error.data, error.headers));
+            });
+            Object.assign(client.axios.defaults, axiosConfig);
+        });
+        // Create enhanced API clients
+        this.files = new EnhancedFilesApi(filesApi);
+        this.collections = new EnhancedCollectionsApi(collectionsApi);
+        this.chat = new EnhancedChatApi(chatApi);
+        this.describe = new EnhancedDescribeApi(describeApi);
+        this.extract = new EnhancedExtractApi(extractApi);
+    }
+}
+exports.CloudGlue = CloudGlue;