cheshirecat-typescript-client 1.6.1 → 1.7.0

package/dist/endpoints/conversation.d.ts

@@ -1,7 +1,5 @@
 import { AbstractEndpoint } from "./abstract";
-import { ConversationHistoryDeleteOutput, ConversationHistoryOutput } from "../models/api/conversations";
-import { Role } from "../types";
-import { Why } from "../models/dtos";
+import { ConversationDeleteOutput, ConversationHistoryOutput, ConversationNameChangeOutput, ConversationsResponse } from "../models/api/conversations";
 export declare class ConversationEndpoint extends AbstractEndpoint {
     protected prefix: string;
     /**
@@ -15,36 +13,33 @@ export declare class ConversationEndpoint extends AbstractEndpoint {
      */
     getConversationHistory(agentId: string, userId: string, chatId: string): Promise<ConversationHistoryOutput>;
     /**
-     * This endpoint returns all conversation histories for a given agent and user.
+     * This endpoint returns all conversation attributes for a given agent and user.
      *
      * @param agentId The agent ID.
-     * @param userId The user ID to filter the conversation histories by.
+     * @param userId The user ID to filter the conversation attributes by.
      *
-     * @returns An object with keys as chat IDs and values as ConversationHistoryOutput.
+     * @returns An array of conversation attributes.
      */
-    getConversationHistories(agentId: string, userId: string): Promise<object>;
+    getConversations(agentId: string, userId: string): Promise<ConversationsResponse[]>;
     /**
-     * This endpoint deletes the conversation history.
+     * This endpoint deletes the conversation.
      *
      * @param agentId The agent ID.
-     * @param userId The user ID to filter the conversation history by.
-     * @param chatId The chat ID to filter the conversation history by.
+     * @param userId The user ID to filter the conversation by.
+     * @param chatId The chat ID to filter the conversation by.
      *
      * @returns The output of the deletion operation.
      */
-    deleteConversationHistory(agentId: string, userId: string, chatId: string): Promise<ConversationHistoryDeleteOutput>;
+    deleteConversation(agentId: string, userId: string, chatId: string): Promise<ConversationDeleteOutput>;
     /**
-     * This endpoint creates a new element in the conversation history.
+     * This endpoint changes the name of the conversation.
      *
-     * @param who The speaker of the conversation history.
-     * @param text The text of the conversation history.
+     * @param name The new name of the conversation.
      * @param agentId The agent ID.
      * @param userId The user ID to add the conversation history to.
      * @param chatId The chat ID to add the conversation history to.
-     * @param image The image of the conversation history.
-     * @param why The reason for the conversation history.
      *
-     * @returns The conversation history.
+     * @returns The output of the change operation.
      */
-    postConversationHistory(who: Role, text: string, agentId: string, userId: string, chatId: string, image?: string | null, why?: Why | null): Promise<ConversationHistoryOutput>;
+    postConversationName(name: string, agentId: string, userId: string, chatId: string): Promise<ConversationNameChangeOutput>;
 }

package/dist/endpoints/conversation.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConversationEndpoint = void 0;
 const abstract_1 = require("./abstract");
+const conversations_1 = require("../models/api/conversations");
 class ConversationEndpoint extends abstract_1.AbstractEndpoint {
     prefix = "/conversation";
     /**
@@ -17,56 +18,50 @@ class ConversationEndpoint extends abstract_1.AbstractEndpoint {
         return this.get(this.formatUrl(chatId), agentId, userId);
     }
     /**
-     * This endpoint returns all conversation histories for a given agent and user.
+     * This endpoint returns all conversation attributes for a given agent and user.
      *
      * @param agentId The agent ID.
-     * @param userId The user ID to filter the conversation histories by.
+     * @param userId The user ID to filter the conversation attributes by.
      *
-     * @returns An object with keys as chat IDs and values as ConversationHistoryOutput.
+     * @returns An array of conversation attributes.
      */
-    async getConversationHistories(agentId, userId) {
+    async getConversations(agentId, userId) {
         const response = await this.getHttpClient(agentId, userId).get(this.prefix);
         if (response.status !== 200) {
             throw new Error(`Failed to fetch data from ${this.prefix}: ${response.statusText}`);
         }
-        const result = {};
-        for (const [key, item] of response.data) {
-            result[key] = this.deserialize(JSON.stringify(item));
-        }
-        return result;
+        return response.data.map((item) => {
+            const conversation = new conversations_1.ConversationsResponse();
+            conversation.chat_id = item.chat_id;
+            conversation.name = item.name;
+            conversation.num_messages = item.num_messages;
+            return conversation;
+        });
     }
     /**
-     * This endpoint deletes the conversation history.
+     * This endpoint deletes the conversation.
      *
      * @param agentId The agent ID.
-     * @param userId The user ID to filter the conversation history by.
-     * @param chatId The chat ID to filter the conversation history by.
+     * @param userId The user ID to filter the conversation by.
+     * @param chatId The chat ID to filter the conversation by.
      *
      * @returns The output of the deletion operation.
      */
-    async deleteConversationHistory(agentId, userId, chatId) {
+    async deleteConversation(agentId, userId, chatId) {
         return this.delete(this.formatUrl(chatId), agentId, userId);
     }
     /**
-     * This endpoint creates a new element in the conversation history.
+     * This endpoint changes the name of the conversation.
      *
-     * @param who The speaker of the conversation history.
-     * @param text The text of the conversation history.
+     * @param name The new name of the conversation.
      * @param agentId The agent ID.
      * @param userId The user ID to add the conversation history to.
      * @param chatId The chat ID to add the conversation history to.
-     * @param image The image of the conversation history.
-     * @param why The reason for the conversation history.
      *
-     * @returns The conversation history.
+     * @returns The output of the change operation.
      */
-    async postConversationHistory(who, text, agentId, userId, chatId, image, why) {
-        const payload = {
-            who: who,
-            text,
-            ...(image && { image }),
-            ...(why && { why: why.toArray() }),
-        };
+    async postConversationName(name, agentId, userId, chatId) {
+        const payload = { name };
         return this.post(this.formatUrl(chatId), agentId, payload, userId);
     }
 }

package/dist/endpoints/conversation.js.map

@@ -1 +1 @@
-{"version":3,"file":"conversation.js","sourceRoot":"","sources":["../../src/endpoints/conversation.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAQ5C,MAAa,oBAAqB,SAAQ,2BAAgB;IAC5C,MAAM,GAAG,eAAe,CAAC;IAEnC;;;;;;;;OAQG;IACH,KAAK,CAAC,sBAAsB,CACxB,OAAe,EACf,MAAc,EACd,MAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAA4B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,wBAAwB,CAAC,OAAe,EAAE,MAAc;QAC1D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5E,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACxF,CAAC;QAED,MAAM,MAAM,GAA8C,EAAE,CAAC;QAC7D,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,CAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;QACnF,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,yBAAyB,CAC3B,OAAe,EACf,MAAc,EACd,MAAc;QAEd,OAAO,IAAI,CAAC,MAAM,CACd,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EACtB,OAAO,EACP,MAAM,CACT,CAAC;IACN,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,uBAAuB,CACzB,GAAS,EACT,IAAY,EACZ,OAAe,EACf,MAAc,EACd,MAAc,EACd,KAAqB,EACrB,GAAgB;QAEhB,MAAM,OAAO,GAAG;YACZ,GAAG,EAAE,GAAG;YACR,IAAI;YACJ,GAAG,CAAC,KAAK,IAAI,EAAC,KAAK,EAAC,CAAC;YACrB,GAAG,CAAC,GAAG,IAAI,EAAC,GAAG,EAAE,GAAG,CAAC,OAAO,EAAE,EAAC,CAAC;SACnC,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAA4B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAClG,CAAC;CACJ;AA9FD,oDA8FC"}
+{"version":3,"file":"conversation.js","sourceRoot":"","sources":["../../src/endpoints/conversation.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAC5C,+DAKqC;AAIrC,MAAa,oBAAqB,SAAQ,2BAAgB;IAC5C,MAAM,GAAG,eAAe,CAAC;IAEnC;;;;;;;;OAQG;IACH,KAAK,CAAC,sBAAsB,CACxB,OAAe,EACf,MAAc,EACd,MAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAA4B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAe,EAAE,MAAc;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5E,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACxF,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAS,EAAE,EAAE;YACnC,MAAM,YAAY,GAAG,IAAI,qCAAqB,EAAE,CAAC;YACjD,YAAY,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YACpC,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;YAC9B,YAAY,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;YAC9C,OAAO,YAAY,CAAC;QACxB,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,kBAAkB,CACpB,OAAe,EACf,MAAc,EACd,MAAc;QAEd,OAAO,IAAI,CAAC,MAAM,CACd,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EACtB,OAAO,EACP,MAAM,CACT,CAAC;IACN,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,oBAAoB,CACtB,IAAY,EACZ,OAAe,EACf,MAAc,EACd,MAAc;QAEd,MAAM,OAAO,GAAG,EAAC,IAAI,EAAC,CAAC;QAEvB,OAAO,IAAI,CAAC,IAAI,CAA+B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACrG,CAAC;CACJ;AApFD,oDAoFC"}

package/dist/models/api/conversations.d.ts

@@ -1,8 +1,16 @@
-import { ConversationHistoryItem } from "./nested/memories";
-export interface ConversationHistoryDeleteOutput {
+import { ConversationMessage } from "./nested/memories";
+export interface ConversationDeleteOutput {
     deleted: boolean;
 }
 export declare class ConversationHistoryOutput {
-    history: ConversationHistoryItem[];
+    history: ConversationMessage[];
     toArray(): Record<string, unknown>;
 }
+export declare class ConversationsResponse {
+    chat_id: string;
+    name: string;
+    num_messages: number;
+}
+export declare class ConversationNameChangeOutput {
+    changed: boolean;
+}

package/dist/models/api/conversations.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationHistoryOutput = void 0;
+exports.ConversationNameChangeOutput = exports.ConversationsResponse = exports.ConversationHistoryOutput = void 0;
 class ConversationHistoryOutput {
     history;
     toArray() {
@@ -9,4 +9,14 @@ class ConversationHistoryOutput {
     }
 }
 exports.ConversationHistoryOutput = ConversationHistoryOutput;
+class ConversationsResponse {
+    chat_id;
+    name;
+    num_messages;
+}
+exports.ConversationsResponse = ConversationsResponse;
+class ConversationNameChangeOutput {
+    changed;
+}
+exports.ConversationNameChangeOutput = ConversationNameChangeOutput;
 //# sourceMappingURL=conversations.js.map

package/dist/models/api/conversations.js.map

@@ -1 +1 @@
-{"version":3,"file":"conversations.js","sourceRoot":"","sources":["../../../src/models/api/conversations.ts"],"names":[],"mappings":";;;AAMA,MAAa,yBAAyB;IAClC,OAAO,CAA4B;IAE5B,OAAO;QACV,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACnD,OAAO,EAAE,OAAO,EAAE,CAAC;IACvB,CAAC;CACJ;AAPD,8DAOC"}
+{"version":3,"file":"conversations.js","sourceRoot":"","sources":["../../../src/models/api/conversations.ts"],"names":[],"mappings":";;;AAMA,MAAa,yBAAyB;IAClC,OAAO,CAAwB;IAExB,OAAO;QACV,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACnD,OAAO,EAAE,OAAO,EAAE,CAAC;IACvB,CAAC;CACJ;AAPD,8DAOC;AAED,MAAa,qBAAqB;IAC9B,OAAO,CAAS;IAChB,IAAI,CAAS;IACb,YAAY,CAAS;CACxB;AAJD,sDAIC;AAED,MAAa,4BAA4B;IACrC,OAAO,CAAU;CACpB;AAFD,oEAEC"}

package/dist/models/api/nested/memories.d.ts

@@ -7,7 +7,7 @@ export declare class ConversationHistoryItemContent extends MessageBase {
     why?: Why | null;
     toArray(): object;
 }
-export declare class ConversationHistoryItem {
+export declare class ConversationMessage {
     who: string;
     when: number;
     content: ConversationHistoryItemContent;

package/dist/models/api/nested/memories.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationHistoryItem = exports.ConversationHistoryItemContent = void 0;
+exports.ConversationMessage = exports.ConversationHistoryItemContent = void 0;
 const dtos_1 = require("../../dtos");
 class ConversationHistoryItemContent extends dtos_1.MessageBase {
     why = null;
@@ -19,7 +19,7 @@ class ConversationHistoryItemContent extends dtos_1.MessageBase {
     }
 }
 exports.ConversationHistoryItemContent = ConversationHistoryItemContent;
-class ConversationHistoryItem {
+class ConversationMessage {
     who;
     when;
     content;
@@ -31,5 +31,5 @@ class ConversationHistoryItem {
         };
     }
 }
-exports.ConversationHistoryItem = ConversationHistoryItem;
+exports.ConversationMessage = ConversationMessage;
 //# sourceMappingURL=memories.js.map

package/dist/models/api/nested/memories.js.map

@@ -1 +1 @@
-{"version":3,"file":"memories.js","sourceRoot":"","sources":["../../../../src/models/api/nested/memories.ts"],"names":[],"mappings":";;;AAAA,qCAA4C;AAO5C,MAAa,8BAA+B,SAAQ,kBAAW;IAC3D,GAAG,GAAgB,IAAI,CAAC;IAEjB,OAAO;QACV,IAAI,IAAI,GAAW;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,EAAE,CAAC;YACpB,IAAI,GAAG;gBACH,GAAG,IAAI;gBACP,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE;aAC3B,CAAC;QACN,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAlBD,wEAkBC;AAED,MAAa,uBAAuB;IAChC,GAAG,CAAS;IACZ,IAAI,CAAS;IACb,OAAO,CAAiC;IAEjC,OAAO;QACV,OAAO;YACH,KAAK,EAAE,IAAI,CAAC,GAAG;YACf,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACjC,MAAM,EAAE,IAAI,CAAC,IAAI;SACpB,CAAC;IACN,CAAC;CACJ;AAZD,0DAYC"}
+{"version":3,"file":"memories.js","sourceRoot":"","sources":["../../../../src/models/api/nested/memories.ts"],"names":[],"mappings":";;;AAAA,qCAA4C;AAO5C,MAAa,8BAA+B,SAAQ,kBAAW;IAC3D,GAAG,GAAgB,IAAI,CAAC;IAEjB,OAAO;QACV,IAAI,IAAI,GAAW;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;SACpB,CAAC;QAEF,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,EAAE,CAAC;YACpB,IAAI,GAAG;gBACH,GAAG,IAAI;gBACP,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,OAAO,EAAE;aAC3B,CAAC;QACN,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAlBD,wEAkBC;AAED,MAAa,mBAAmB;IAC5B,GAAG,CAAS;IACZ,IAAI,CAAS;IACb,OAAO,CAAiC;IAEjC,OAAO;QACV,OAAO;YACH,KAAK,EAAE,IAAI,CAAC,GAAG;YACf,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACjC,MAAM,EAAE,IAAI,CAAC,IAAI;SACpB,CAAC;IACN,CAAC;CACJ;AAZD,kDAYC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cheshirecat-typescript-client",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "engines": {
     "node": "22.x"
   },