@aviaryhq/cloudglue-js 0.0.9

package/dist/src/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;

package/dist/src/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Main CloudGlue client class and configuration types
+ */
+export { CloudGlue, type CloudGlueConfig, type CloudGlueError } from './client';
+/**
+ * Generated API clients for advanced usage
+ * These provide direct access to the underlying API endpoints
+ */
+export { FilesApi, CollectionsApi, ChatApi, DescribeApi, ExtractApi } from '../generated';
+/**
+ * Common type definitions used throughout the SDK
+ */
+export type { File, Collection, CollectionFile, CollectionFileList, ChatMessage, ChatCompletionResponse, Describe, Extract, DescriptionSegment, CollectionVideoDescription, EntitySegment, CollectionVideoEntities, NewCollectionParams, } from './types';

package/dist/src/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractApi = exports.DescribeApi = exports.ChatApi = exports.CollectionsApi = exports.FilesApi = exports.CloudGlue = void 0;
+/**
+ * Main CloudGlue client class and configuration types
+ */
+var client_1 = require("./client");
+Object.defineProperty(exports, "CloudGlue", { enumerable: true, get: function () { return client_1.CloudGlue; } });
+/**
+ * Generated API clients for advanced usage
+ * These provide direct access to the underlying API endpoints
+ */
+var generated_1 = require("../generated");
+Object.defineProperty(exports, "FilesApi", { enumerable: true, get: function () { return generated_1.FilesApi; } });
+Object.defineProperty(exports, "CollectionsApi", { enumerable: true, get: function () { return generated_1.CollectionsApi; } });
+Object.defineProperty(exports, "ChatApi", { enumerable: true, get: function () { return generated_1.ChatApi; } });
+Object.defineProperty(exports, "DescribeApi", { enumerable: true, get: function () { return generated_1.DescribeApi; } });
+Object.defineProperty(exports, "ExtractApi", { enumerable: true, get: function () { return generated_1.ExtractApi; } });

package/dist/src/types.d.ts

@@ -0,0 +1,70 @@
+import type { z } from 'zod';
+import { schemas as collectionsSchemas } from '../generated/Collections';
+import { schemas as chatSchemas } from '../generated/Chat';
+import { schemas as describeSchemas } from '../generated/Describe';
+import { schemas as extractSchemas } from '../generated/Extract';
+/**
+ * Represents a video file in the CloudGlue system
+ * Contains metadata about the file including its status, size, and video information
+ */
+export type { File } from '../generated/common';
+/**
+ * Parameters for creating a new collection
+ */
+export type NewCollectionParams = z.infer<typeof collectionsSchemas.NewCollection>;
+/**
+ * Represents a collection of videos
+ * Contains metadata about the collection and its configuration
+ */
+export type Collection = z.infer<typeof collectionsSchemas.Collection>;
+/**
+ * Represents a video file within a collection
+ * Contains metadata about the file and its processing status within the collection
+ */
+export type CollectionFile = z.infer<typeof collectionsSchemas.CollectionFile>;
+/**
+ * Represents a paginated list of files within a collection
+ */
+export type CollectionFileList = z.infer<typeof collectionsSchemas.CollectionFileList>;
+/**
+ * Represents a segment of video description containing speech, text, and visual information
+ * This is inferred from the FileDescription schema's segment_docs array type
+ */
+export type DescriptionSegment = NonNullable<z.infer<typeof collectionsSchemas.FileDescription>['segment_docs']>[number];
+/**
+ * Represents the full description response for a video in a collection
+ */
+export type CollectionVideoDescription = z.infer<typeof collectionsSchemas.FileDescription>;
+/**
+ * Represents a segment of video with extracted entities
+ * This is inferred from the FileEntities schema's segment_entities array type
+ */
+export type EntitySegment = NonNullable<z.infer<typeof collectionsSchemas.FileEntities>['segment_entities']>[number];
+/**
+ * Represents the full entities response for a video in a collection
+ */
+export type CollectionVideoEntities = z.infer<typeof collectionsSchemas.FileEntities>;
+/**
+ * Represents a message in a chat conversation
+ * Used for interacting with videos through natural language
+ */
+export type ChatMessage = {
+    role: "system" | "user" | "assistant";
+    content: string;
+    name?: string;
+};
+/**
+ * Represents the response from a chat completion request
+ * Contains the model's response and any relevant citations from videos
+ */
+export type ChatCompletionResponse = z.infer<typeof chatSchemas.ChatCompletionResponse>;
+/**
+ * Represents the result of a video description request
+ * Contains detailed information about the video content
+ */
+export type Describe = z.infer<typeof describeSchemas.Describe>;
+/**
+ * Represents the result of a video information extraction request
+ * Contains structured data extracted from the video
+ */
+export type Extract = z.infer<typeof extractSchemas.Extract>;

package/dist/src/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.d.ts

@@ -0,0 +1,70 @@
+import type { z } from 'zod';
+import { schemas as collectionsSchemas } from '../generated/Collections';
+import { schemas as chatSchemas } from '../generated/Chat';
+import { schemas as describeSchemas } from '../generated/Describe';
+import { schemas as extractSchemas } from '../generated/Extract';
+/**
+ * Represents a video file in the CloudGlue system
+ * Contains metadata about the file including its status, size, and video information
+ */
+export type { File } from '../generated/common';
+/**
+ * Parameters for creating a new collection
+ */
+export type NewCollectionParams = z.infer<typeof collectionsSchemas.NewCollection>;
+/**
+ * Represents a collection of videos
+ * Contains metadata about the collection and its configuration
+ */
+export type Collection = z.infer<typeof collectionsSchemas.Collection>;
+/**
+ * Represents a video file within a collection
+ * Contains metadata about the file and its processing status within the collection
+ */
+export type CollectionFile = z.infer<typeof collectionsSchemas.CollectionFile>;
+/**
+ * Represents a paginated list of files within a collection
+ */
+export type CollectionFileList = z.infer<typeof collectionsSchemas.CollectionFileList>;
+/**
+ * Represents a segment of video description containing speech, text, and visual information
+ * This is inferred from the FileDescription schema's segment_docs array type
+ */
+export type DescriptionSegment = NonNullable<z.infer<typeof collectionsSchemas.FileDescription>['segment_docs']>[number];
+/**
+ * Represents the full description response for a video in a collection
+ */
+export type CollectionVideoDescription = z.infer<typeof collectionsSchemas.FileDescription>;
+/**
+ * Represents a segment of video with extracted entities
+ * This is inferred from the FileEntities schema's segment_entities array type
+ */
+export type EntitySegment = NonNullable<z.infer<typeof collectionsSchemas.FileEntities>['segment_entities']>[number];
+/**
+ * Represents the full entities response for a video in a collection
+ */
+export type CollectionVideoEntities = z.infer<typeof collectionsSchemas.FileEntities>;
+/**
+ * Represents a message in a chat conversation
+ * Used for interacting with videos through natural language
+ */
+export type ChatMessage = {
+    role: "system" | "user" | "assistant";
+    content: string;
+    name?: string;
+};
+/**
+ * Represents the response from a chat completion request
+ * Contains the model's response and any relevant citations from videos
+ */
+export type ChatCompletionResponse = z.infer<typeof chatSchemas.ChatCompletionResponse>;
+/**
+ * Represents the result of a video description request
+ * Contains detailed information about the video content
+ */
+export type Describe = z.infer<typeof describeSchemas.Describe>;
+/**
+ * Represents the result of a video information extraction request
+ * Contains structured data extracted from the video
+ */
+export type Extract = z.infer<typeof extractSchemas.Extract>;

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@aviaryhq/cloudglue-js",
+  "version": "0.0.9",
+  "description": "CloudGlue API client for Node.js",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "generate": "openapi-zod-client spec/spec/openapi.json --group-strategy=tag-file -o generated --export-schemas=true --export-types=true --base-url=https://api.cloudglue.dev/v1 --strict-objects && sed -i '' 's/z.instanceof(File)/z.instanceof(globalThis.File)/' generated/Files.ts",
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "prepare": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/aviaryhq/cloudglue-js.git"
+  },
+  "keywords": [
+    "cloudglue",
+    "api",
+    "sdk"
+  ],
+  "author": "Aviary Inc.",
+  "license": "Elastic-2.0",
+  "bugs": {
+    "url": "https://github.com/aviaryhq/cloudglue-js/issues"
+  },
+  "homepage": "https://github.com/aviaryhq/cloudglue-js#readme",
+  "dependencies": {
+    "@zodios/core": "^10.0.0",
+    "axios": "^1.6.7",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "openapi-zod-client": "^1.18.3",
+    "rimraf": "^5.0.0",
+    "typescript": "^5.3.3"
+  },
+  "peerDependencies": {
+    "@zodios/core": "^10.0.0"
+  }
+}