quickblox 2.21.5-alpha.2 → 2.21.5-alpha.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "quickblox",
   "description": "QuickBlox JavaScript SDK",
-  "version": "2.21.5-alpha.2",
+  "version": "2.21.5-alpha.3",
   "homepage": "https://quickblox.com/developers/Javascript",
   "main": "src/qbMain.js",
   "types": "quickblox.d.ts",

package/quickblox.d.ts

@@ -485,6 +485,37 @@ export interface AIAnswerResponse {
 
 export declare type AIChatHistory = AIChatMessage[] | null | undefined;
 
+// AI Gateway types
+export interface AIGatewayTextContent {
+    type: 'text';
+    text: string;
+}
+
+export interface AIGatewayImageContent {
+    type: 'image_url';
+    image_url: {
+        url: string;
+    };
+}
+
+export type AIGatewayContentItem = AIGatewayTextContent | AIGatewayImageContent;
+
+export type AIGatewayRole = 'user' | 'assistant' | 'developer';
+
+export interface AIGatewayMessage {
+    role: AIGatewayRole;
+    content: AIGatewayContentItem[];
+}
+
+export interface AIGatewayOptions {
+    apiKey?: string;
+}
+
+// AI Summarize response
+export interface AISummarizeResponse {
+    summary: string;
+}
+
 interface QBAIModule{
     //QB.ai.answerAssist
     answerAssist(smartChatAssistantId: string,
@@ -497,6 +528,21 @@ interface QBAIModule{
                  languageCode: string,
                  callback: QBCallback<AIAnswerResponse>): void
 
+    //QB.ai.gateway
+    gateway(smartChatAssistantId: string,
+            messages: AIGatewayMessage[],
+            callback: QBCallback<AIAnswerResponse>): void
+
+    gateway(smartChatAssistantId: string,
+            messages: AIGatewayMessage[],
+            options: AIGatewayOptions,
+            callback: QBCallback<AIAnswerResponse>): void
+
+    //QB.ai.summarize
+    summarize(smartChatAssistantId: string,
+              dialogId: string,
+              callback: QBCallback<AISummarizeResponse>): void
+
 }
 
 interface QBChatModule {

package/quickblox.js

@@ -50160,6 +50160,210 @@ AIProxy.prototype = {
         this.service.ajax(attrAjax, callback);
     },
 
+    /**
+     * AI Gateway - multimodal AI endpoint supporting text and images in OpenAI-compatible format
+     * ({@link https://docs.quickblox.com/reference/ai-extensions-ai-gateway read more}).
+     * @memberof QB.ai
+     * @param {String} smartChatAssistantId - Smart Chat Assistant id.
+     * @param {Object[]} messages - Array of message objects. Each message has:
+     *   - role: 'user' | 'assistant' | 'developer'
+     *   - content: Array of content items (text or image_url)
+     * @param {Object} [options] - Optional configuration.
+     * @param {String} [options.apiKey] - API key for authorization (alternative to session token).
+     * @param {gatewayCallback} callback - The callback function.
+     * @example
+     *  var messages = [
+     *      {
+     *          role: 'user',
+     *          content: [
+     *              { type: 'text', text: 'What is in this image?' },
+     *              { type: 'image_url', image_url: { url: 'https://example.com/image.jpg' } }
+     *          ]
+     *      }
+     *  ];
+     *  QB.ai.gateway(smartChatAssistantId, messages, function(err, res) {
+     *      console.log(res.answer);
+     *  });
+     *  // With API key:
+     *  QB.ai.gateway(smartChatAssistantId, messages, { apiKey: 'your_api_key' }, callback);
+     */
+    gateway: function(smartChatAssistantId, messages, optionsOrCallback, callback) {
+        /**
+         * Callback for QB.ai.gateway().
+         * @param {Object} error - The error object.
+         * @param {Object} response - The server response object.
+         * @param {String} [response.answer] - AI generated response.
+         * @callback gatewayCallback
+         */
+
+        // Handle optional options parameter
+        var options, cb;
+        if (typeof optionsOrCallback === 'function') {
+            cb = optionsOrCallback;
+            options = {};
+        } else {
+            options = optionsOrCallback || {};
+            cb = callback;
+        }
+
+        // Validate callback
+        if (!cb || typeof cb !== 'function') {
+            throw new Error('Callback function is required and must be a function');
+        }
+
+        // Validate smartChatAssistantId
+        if (!smartChatAssistantId || typeof smartChatAssistantId !== 'string') {
+            throw new Error('smartChatAssistantId is required and must be a string');
+        }
+
+        // Validate messages
+        this._validateGatewayMessages(messages);
+
+        // Build request data
+        var data = {
+            smart_chat_assistant_id: smartChatAssistantId,
+            messages: messages
+        };
+
+        // Build ajax options
+        var attrAjax = {
+            'type': 'POST',
+            'url': Utils.formatUrl(AI_API_URL + '/ai_gateway'),
+            'data': data,
+            'contentType': 'application/json; charset=utf-8',
+            'isNeedStringify': true
+        };
+
+        // Add API key header if provided
+        if (options.apiKey) {
+            attrAjax.headers = {
+                'Authorization': 'ApiKey ' + options.apiKey
+            };
+        }
+
+        this.service.ajax(attrAjax, cb);
+    },
+
+    /**
+     * Validate gateway messages array
+     * @private
+     * @param {Object[]} messages - Array of message objects to validate.
+     * @throws {Error} If messages array is invalid.
+     */
+    _validateGatewayMessages: function(messages) {
+        var validRoles = ['user', 'assistant', 'developer'];
+        var validContentTypes = ['text', 'image_url'];
+
+        if (!messages || !Array.isArray(messages)) {
+            throw new Error('messages is required and must be an array');
+        }
+
+        if (messages.length === 0) {
+            throw new Error('messages array cannot be empty');
+        }
+
+        for (var i = 0; i < messages.length; i++) {
+            var msg = messages[i];
+
+            // Check message is object
+            if (typeof msg !== 'object' || msg === null || Array.isArray(msg)) {
+                throw new Error('Each message must be an object');
+            }
+
+            // Check role
+            if (!msg.role || validRoles.indexOf(msg.role) === -1) {
+                throw new Error('Each message must have a valid role (user, assistant, or developer)');
+            }
+
+            // Check content
+            if (!msg.content || !Array.isArray(msg.content)) {
+                throw new Error('Each message must have a content array');
+            }
+
+            if (msg.content.length === 0) {
+                throw new Error('Message content array cannot be empty');
+            }
+
+            // Validate each content item
+            for (var j = 0; j < msg.content.length; j++) {
+                var item = msg.content[j];
+
+                if (typeof item !== 'object' || item === null) {
+                    throw new Error('Each content item must be an object');
+                }
+
+                if (!item.type || validContentTypes.indexOf(item.type) === -1) {
+                    throw new Error('Each content item must have a valid type (text or image_url)');
+                }
+
+                if (item.type === 'text') {
+                    if (typeof item.text !== 'string') {
+                        throw new Error('Text content item must have a text string');
+                    }
+                } else if (item.type === 'image_url') {
+                    if (!item.image_url || typeof item.image_url.url !== 'string') {
+                        throw new Error('Image content item must have image_url.url string');
+                    }
+                }
+            }
+        }
+
+        return true;
+    },
+
+    /**
+     * AI Summarize - generates a summary of dialog messages (up to 1000 most recent)
+     * ({@link https://docs.quickblox.com/reference/ai-extensions-ai-summarize read more}).
+     * @memberof QB.ai
+     * @param {String} smartChatAssistantId - Smart Chat Assistant id.
+     * @param {String} dialogId - Dialog id to summarize.
+     * @param {summarizeCallback} callback - The callback function.
+     * @example
+     *  QB.ai.summarize(smartChatAssistantId, dialogId, function(err, res) {
+     *      console.log(res.summary);
+     *  });
+     */
+    summarize: function(smartChatAssistantId, dialogId, callback) {
+        /**
+         * Callback for QB.ai.summarize().
+         * @param {Object} error - The error object.
+         * @param {Object} response - The server response object.
+         * @param {String} [response.summary] - Generated summary of the dialog.
+         * @callback summarizeCallback
+         */
+
+        // Validate callback
+        if (!callback || typeof callback !== 'function') {
+            throw new Error('Callback function is required and must be a function');
+        }
+
+        // Validate smartChatAssistantId
+        if (!smartChatAssistantId || typeof smartChatAssistantId !== 'string') {
+            throw new Error('smartChatAssistantId is required and must be a string');
+        }
+
+        // Validate dialogId
+        if (!dialogId || typeof dialogId !== 'string') {
+            throw new Error('dialogId is required and must be a string');
+        }
+
+        // Build request data
+        var data = {
+            smart_chat_assistant_id: smartChatAssistantId,
+            dialog_id: dialogId
+        };
+
+        // Build ajax options
+        var attrAjax = {
+            'type': 'POST',
+            'url': Utils.formatUrl(AI_API_URL + '/ai_summarize'),
+            'data': data,
+            'contentType': 'application/json; charset=utf-8',
+            'isNeedStringify': true
+        };
+
+        this.service.ajax(attrAjax, callback);
+    },
 
 };
 
@@ -55133,7 +55337,7 @@ module.exports = StreamManagement;
 
 var config = {
   version: '2.21.5',
-  buildNumber: '1172',
+  buildNumber: '1173',
   creds: {
     'appId': 0,
     'authKey': '',
@@ -55826,6 +56030,13 @@ ServiceProxy.prototype = {
             }
         }
 
+        // Support custom headers (e.g., for Authorization: ApiKey)
+        if (params.headers) {
+            Object.keys(params.headers).forEach(function(key) {
+                qbRequest.headers[key] = params.headers[key];
+            });
+        }
+
         if (config.timeout) {
             qbRequest.timeout = config.timeout;
         }