@chatbotkit/sdk 1.28.0 → 1.29.1

package/dist/esm/types/report.d.ts

@@ -3,7 +3,7 @@
  * Generated from report registry schemas.
  */
 
-export type ReportId = 'clr3m5n8k000008jq7h9e5b1a' | 'clr3m5n8k000108jq3c4d7f2b' | 'clr3m5n8k000208jq8e5f6g3c' | 'clr3m5n8k000308jq1h7i8j4d' | 'clr3m5n8k000408jq9i8j9k5e' | 'clr3m5n8k000508jq2j9k0l6f' | 'clr3m5n8k000608jq3k0l1m7g' | 'clr3m5n8k000708jq4l1m2n8h' | 'clr3m5n8k000808jq5m2n3o9i' | 'clr3m5n8k000908jq6n3o4p0j' | 'clr3m5n8k000a08jq7o4p5q1k' | 'clr3m5n8k000b08jq8p5q6r2l' | 'clr3m5n8k000c08jq9q6r7s3m' | 'clr3m5n8k000d08jqar7s8t4n' | 'clr3m5n8k000e08jqbs0t1u5o'
+export type ReportId = 'cm7k3m5n8k000008jq7h9e5b1a' | 'clr3m5n8k000008jq7h9e5b1a' | 'clr3m5n8k000108jq3c4d7f2b' | 'clr3m5n8k000208jq8e5f6g3c' | 'clr3m5n8k000308jq1h7i8j4d' | 'clr3m5n8k000408jq9i8j9k5e' | 'clr3m5n8k000508jq2j9k0l6f' | 'clr3m5n8k000608jq3k0l1m7g' | 'clr3m5n8k000708jq4l1m2n8h' | 'clr3m5n8k000808jq5m2n3o9i' | 'clr3m5n8k000908jq6n3o4p0j' | 'clr3m5n8k000a08jq7o4p5q1k' | 'clr3m5n8k000b08jq8p5q6r2l' | 'clr3m5n8k000c08jq9q6r7s3m' | 'clr3m5n8k000d08jqar7s8t4n' | 'clr3m5n8k000e08jqbs0t1u5o' | 'clr3m5n8k000f08jqcs1u2v6p' | 'clr3m5n8k000g08jqdt1u2v7q' | 'clr3m5n8k000h08jqeu2v3w8r' | 'clr3m5n8k000i08jqfv3w4x9s' | 'clr3m5n8k000j08jqgw4x5y0t' | 'gpv2an25fuhe2k6v6ckv85v8'
 
 export interface ReportMetadata {
   id: string
@@ -14,6 +14,12 @@ export interface ReportMetadata {
 }
 
 export interface ReportRegistry {
+  'cm7k3m5n8k000008jq7h9e5b1a': {
+    name: string
+    description: string
+    input: DatasetRecordsInput
+    output: DatasetRecordsOutput
+  }
   'clr3m5n8k000008jq7h9e5b1a': {
     name: string
     description: string
@@ -104,9 +110,49 @@ export interface ReportRegistry {
     input: BotStatsInput
     output: BotStatsOutput
   }
+  'clr3m5n8k000f08jqcs1u2v6p': {
+    name: string
+    description: string
+    input: AlertsInput
+    output: AlertsOutput
+  }
+  'clr3m5n8k000g08jqdt1u2v7q': {
+    name: string
+    description: string
+    input: BotPerformanceInput
+    output: BotPerformanceOutput
+  }
+  'clr3m5n8k000h08jqeu2v3w8r': {
+    name: string
+    description: string
+    input: BotConversationQualityInput
+    output: BotConversationQualityOutput
+  }
+  'clr3m5n8k000i08jqfv3w4x9s': {
+    name: string
+    description: string
+    input: BotAlertsInput
+    output: BotAlertsOutput
+  }
+  'clr3m5n8k000j08jqgw4x5y0t': {
+    name: string
+    description: string
+    input: BotNegativeFeedbackInput
+    output: BotNegativeFeedbackOutput
+  }
+  'gpv2an25fuhe2k6v6ckv85v8': {
+    name: string
+    description: string
+    input: ComprehensiveAnalyticsInput
+    output: ComprehensiveAnalyticsOutput
+  }
 }
 
 // Input and Output Types for each report
+export type DatasetRecordsInput = {
+  datasetIds: string[]
+}
+
 export type TotalRatingsInput = {
   periodDays?: number
 }
@@ -168,6 +214,40 @@ export type BotStatsInput = {
   periodDays?: number
 }
 
+export type AlertsInput = {
+  periodDays?: number
+}
+
+export type BotPerformanceInput = {
+  botId: string
+  periodDays?: number
+}
+
+export type BotConversationQualityInput = {
+  botId: string
+  periodDays?: number
+}
+
+export type BotAlertsInput = {
+  botId: string
+  periodDays?: number
+}
+
+export type BotNegativeFeedbackInput = {
+  botId: string
+  periodDays?: number
+  limit?: number
+}
+
+export type ComprehensiveAnalyticsInput = {
+  periodDays?: number
+}
+
+export type DatasetRecordsOutput = {
+  totalRecords: number
+  breakdown: { datasetId: string; records: number }[]
+}
+
 export type TotalRatingsOutput = {
   value: number
   change?: number
@@ -260,6 +340,7 @@ export type ComprehensiveOverviewOutput = {
 export type BotStatsOutput = {
   totalConversations: number
   totalMessages: number
+  totalTokens: number
   totalRatings: number
   thumbsUp: number
   thumbsDown: number
@@ -267,8 +348,52 @@ export type BotStatsOutput = {
   period: string
 }
 
+export type AlertsOutput = {
+  alerts: { type: string; severity: string; title: string; message: string; metric?: { current: number; baseline?: number; percentage?: number } }[]
+  summary: { totalAlerts: number; criticalCount: number; warningCount: number; infoCount: number }
+  period: string
+}
+
+export type BotPerformanceOutput = {
+  conversations: { current: number; previous: number; change: number; breakdown: { date: string; total: number }[] }
+  messages: { current: number; previous: number; change: number; breakdown: { date: string; total: number }[] }
+  tokens: { current: number; previous: number; change: number; breakdown: { date: string; total: number }[] }
+  ratings: { thumbsUp: number; thumbsDown: number; total: number; change: number; sentimentSignal: string; breakdown: { date: string; total: number; thumbsUp: number; thumbsDown: number }[] }
+  period: string
+}
+
+export type BotConversationQualityOutput = {
+  avgMessagesPerConversation: { user: number; bot: number; activity: number }
+  conversationDepth: { singleTurn: number; short: number; medium: number; long: number }
+  totalConversations: number
+  abandonmentRate: number
+  avgTokensPerConversation: number
+  avgTokensPerMessage: number
+  topActions: { type: string; name: string; count: number }[]
+  period: string
+}
+
+export type BotAlertsOutput = {
+  alerts: { type: string; severity: string; title: string; message: string; metric?: { current: number; baseline?: number; percentage?: number } }[]
+  summary: { totalAlerts: number; criticalCount: number; warningCount: number; infoCount: number }
+  period: string
+}
+
+export type BotNegativeFeedbackOutput = {
+  items: { id: string; value: number; reason: unknown; conversationId: unknown; messageId: unknown; contactId: unknown; contactName: unknown; createdAt: string }[]
+  total: number
+  thumbsDown: number
+  thumbsUp: number
+  period: string
+}
+
+export type ComprehensiveAnalyticsOutput = {
+  data: { title: string; description: string; value: number; change?: number; period: string; details?: { metric?: { title: string; description: string; value: number; change?: number; period: string }; chart?: { type: string; data: { date: string; total: number; thumbsUp?: number; thumbsDown?: number }[] }; list?: { id: string; icon?: string; name: string; description: string; createdAt?: string; tags?: unknown[] }[] } }[]
+}
+
 // Mapping report IDs to their input/output types
 export type ReportInputTypes = {
+  'cm7k3m5n8k000008jq7h9e5b1a': DatasetRecordsInput
   'clr3m5n8k000008jq7h9e5b1a': TotalRatingsInput
   'clr3m5n8k000108jq3c4d7f2b': ThumbsUpInput
   'clr3m5n8k000208jq8e5f6g3c': ThumbsDownInput
@@ -284,9 +409,16 @@ export type ReportInputTypes = {
   'clr3m5n8k000c08jq9q6r7s3m': AverageActionsPerConversationInput
   'clr3m5n8k000d08jqar7s8t4n': ComprehensiveOverviewInput
   'clr3m5n8k000e08jqbs0t1u5o': BotStatsInput
+  'clr3m5n8k000f08jqcs1u2v6p': AlertsInput
+  'clr3m5n8k000g08jqdt1u2v7q': BotPerformanceInput
+  'clr3m5n8k000h08jqeu2v3w8r': BotConversationQualityInput
+  'clr3m5n8k000i08jqfv3w4x9s': BotAlertsInput
+  'clr3m5n8k000j08jqgw4x5y0t': BotNegativeFeedbackInput
+  'gpv2an25fuhe2k6v6ckv85v8': ComprehensiveAnalyticsInput
 }
 
 export type ReportOutputTypes = {
+  'cm7k3m5n8k000008jq7h9e5b1a': DatasetRecordsOutput
   'clr3m5n8k000008jq7h9e5b1a': TotalRatingsOutput
   'clr3m5n8k000108jq3c4d7f2b': ThumbsUpOutput
   'clr3m5n8k000208jq8e5f6g3c': ThumbsDownOutput
@@ -302,6 +434,12 @@ export type ReportOutputTypes = {
   'clr3m5n8k000c08jq9q6r7s3m': AverageActionsPerConversationOutput
   'clr3m5n8k000d08jqar7s8t4n': ComprehensiveOverviewOutput
   'clr3m5n8k000e08jqbs0t1u5o': BotStatsOutput
+  'clr3m5n8k000f08jqcs1u2v6p': AlertsOutput
+  'clr3m5n8k000g08jqdt1u2v7q': BotPerformanceOutput
+  'clr3m5n8k000h08jqeu2v3w8r': BotConversationQualityOutput
+  'clr3m5n8k000i08jqfv3w4x9s': BotAlertsOutput
+  'clr3m5n8k000j08jqgw4x5y0t': BotNegativeFeedbackOutput
+  'gpv2an25fuhe2k6v6ckv85v8': ComprehensiveAnalyticsOutput
 }
 
 // Helper type to get input type by report ID

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chatbotkit/sdk",
-  "version": "1.28.0",
+  "version": "1.29.1",
   "description": "The fastest way to build advanced AI chat bots",
   "license": "ISC",
   "engines": {
@@ -1228,6 +1228,56 @@
         "default": "./dist/cjs/integration/extract/v1.cjs"
       }
     },
+    "./integration/googlechat": {
+      "import": {
+        "types": "./dist/esm/integration/googlechat/index.d.ts",
+        "default": "./dist/esm/integration/googlechat/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/integration/googlechat/index.d.ts",
+        "default": "./dist/cjs/integration/googlechat/index.cjs"
+      }
+    },
+    "./integration/googlechat/index": {
+      "import": {
+        "types": "./dist/esm/integration/googlechat/index.d.ts",
+        "default": "./dist/esm/integration/googlechat/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/integration/googlechat/index.d.ts",
+        "default": "./dist/cjs/integration/googlechat/index.cjs"
+      }
+    },
+    "./integration/googlechat/index.js": {
+      "import": {
+        "types": "./dist/esm/integration/googlechat/index.d.ts",
+        "default": "./dist/esm/integration/googlechat/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/integration/googlechat/index.d.ts",
+        "default": "./dist/cjs/integration/googlechat/index.cjs"
+      }
+    },
+    "./integration/googlechat/v1": {
+      "import": {
+        "types": "./dist/esm/integration/googlechat/v1.d.ts",
+        "default": "./dist/esm/integration/googlechat/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/integration/googlechat/v1.d.ts",
+        "default": "./dist/cjs/integration/googlechat/v1.cjs"
+      }
+    },
+    "./integration/googlechat/v1.js": {
+      "import": {
+        "types": "./dist/esm/integration/googlechat/v1.d.ts",
+        "default": "./dist/esm/integration/googlechat/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/integration/googlechat/v1.d.ts",
+        "default": "./dist/cjs/integration/googlechat/v1.cjs"
+      }
+    },
     "./integration": {
       "import": {
         "types": "./dist/esm/integration/index.d.ts",
@@ -1608,6 +1658,56 @@
         "default": "./dist/cjs/integration/support/v1.cjs"
       }
     },
+    "./integration/teams": {
+      "import": {
+        "types": "./dist/esm/integration/teams/index.d.ts",
+        "default": "./dist/esm/integration/teams/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/integration/teams/index.d.ts",
+        "default": "./dist/cjs/integration/teams/index.cjs"
+      }
+    },
+    "./integration/teams/index": {
+      "import": {
+        "types": "./dist/esm/integration/teams/index.d.ts",
+        "default": "./dist/esm/integration/teams/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/integration/teams/index.d.ts",
+        "default": "./dist/cjs/integration/teams/index.cjs"
+      }
+    },
+    "./integration/teams/index.js": {
+      "import": {
+        "types": "./dist/esm/integration/teams/index.d.ts",
+        "default": "./dist/esm/integration/teams/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/integration/teams/index.d.ts",
+        "default": "./dist/cjs/integration/teams/index.cjs"
+      }
+    },
+    "./integration/teams/v1": {
+      "import": {
+        "types": "./dist/esm/integration/teams/v1.d.ts",
+        "default": "./dist/esm/integration/teams/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/integration/teams/v1.d.ts",
+        "default": "./dist/cjs/integration/teams/v1.cjs"
+      }
+    },
+    "./integration/teams/v1.js": {
+      "import": {
+        "types": "./dist/esm/integration/teams/v1.d.ts",
+        "default": "./dist/esm/integration/teams/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/integration/teams/v1.d.ts",
+        "default": "./dist/cjs/integration/teams/v1.cjs"
+      }
+    },
     "./integration/telegram": {
       "import": {
         "types": "./dist/esm/integration/telegram/index.d.ts",
@@ -2748,56 +2848,6 @@
         "default": "./dist/cjs/portal/v1.cjs"
       }
     },
-    "./report": {
-      "import": {
-        "types": "./dist/esm/report/index.d.ts",
-        "default": "./dist/esm/report/index.js"
-      },
-      "require": {
-        "types": "./dist/cjs/report/index.d.ts",
-        "default": "./dist/cjs/report/index.cjs"
-      }
-    },
-    "./report/index": {
-      "import": {
-        "types": "./dist/esm/report/index.d.ts",
-        "default": "./dist/esm/report/index.js"
-      },
-      "require": {
-        "types": "./dist/cjs/report/index.d.ts",
-        "default": "./dist/cjs/report/index.cjs"
-      }
-    },
-    "./report/index.js": {
-      "import": {
-        "types": "./dist/esm/report/index.d.ts",
-        "default": "./dist/esm/report/index.js"
-      },
-      "require": {
-        "types": "./dist/cjs/report/index.d.ts",
-        "default": "./dist/cjs/report/index.cjs"
-      }
-    },
-    "./report/v1": {
-      "import": {
-        "types": "./dist/esm/report/v1.d.ts",
-        "default": "./dist/esm/report/v1.js"
-      },
-      "require": {
-        "types": "./dist/cjs/report/v1.d.ts",
-        "default": "./dist/cjs/report/v1.cjs"
-      }
-    },
-    "./report/v1.js": {
-      "import": {
-        "types": "./dist/esm/report/v1.d.ts",
-        "default": "./dist/esm/report/v1.js"
-      },
-      "require": {
-        "types": "./dist/cjs/report/v1.d.ts",
-        "default": "./dist/cjs/report/v1.cjs"
-      }
-    },
     "./secret": {
       "import": {
         "types": "./dist/esm/secret/index.d.ts",
@@ -3098,6 +3148,26 @@
         "default": "./dist/cjs/team/v1.cjs"
       }
     },
+    "./types/ability": {
+      "import": {
+        "types": "./dist/esm/types/ability.d.ts",
+        "default": "./dist/esm/types/ability.js"
+      },
+      "require": {
+        "types": "./dist/cjs/types/ability.d.ts",
+        "default": "./dist/cjs/types/ability.cjs"
+      }
+    },
+    "./types/ability.js": {
+      "import": {
+        "types": "./dist/esm/types/ability.d.ts",
+        "default": "./dist/esm/types/ability.js"
+      },
+      "require": {
+        "types": "./dist/cjs/types/ability.d.ts",
+        "default": "./dist/cjs/types/ability.cjs"
+      }
+    },
     "./types/api/v1": {
       "import": {
         "types": "./dist/esm/types/api/v1.d.ts",
@@ -3243,7 +3313,7 @@
   "types": "./dist/cjs/index.d.ts",
   "dependencies": {
     "tslib": "^2.6.2",
-    "@chatbotkit/fetch": "1.26.3"
+    "@chatbotkit/fetch": "1.29.0"
   },
   "devDependencies": {
     "npm-run-all": "^4.1.5",

package/dist/cjs/report/index.cjs

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReportClient = void 0;
-const client_js_1 = require("../client.cjs");
-const v1_js_1 = require("./v1.cjs");
-class ReportClient extends client_js_1.ChatBotKitClient {
-    constructor(options) {
-        super(options);
-    }
-    generate(reportId, request) {
-        return (0, v1_js_1.generateReport)(this, reportId, request);
-    }
-    generateTyped(reportId, request) {
-        return (0, v1_js_1.generateTypedReport)(this, reportId, request);
-    }
-}
-exports.ReportClient = ReportClient;
-exports.default = ReportClient;

package/dist/cjs/report/index.d.ts

@@ -1,6 +0,0 @@
-export class ReportClient extends ChatBotKitClient {
-    generate(reportId: string, request: import("./v1.js").ReportGenerateRequest): Promise<import("./v1.js").ReportGenerateResponse>;
-    generateTyped<T extends import("./v1.js").ReportId>(reportId: T, request: import("./v1.js").ReportInputTypes[T]): Promise<import("./v1.js").ReportOutputTypes[T]>;
-}
-export default ReportClient;
-import { ChatBotKitClient } from '../client.cjs';

package/dist/cjs/report/v1.cjs

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateReport = generateReport;
-exports.generateTypedReport = generateTypedReport;
-async function generateReport(client, reportId, request) {
-    const url = `/api/v1/report/${reportId}/generate`;
-    const response = await client.clientFetch(url, {
-        record: {
-            ...request,
-        },
-    });
-    return response;
-}
-async function generateTypedReport(client, reportId, request) {
-    const url = `/api/v1/report/${reportId}/generate`;
-    const response = await client.clientFetch(url, {
-        record: {
-            ...request,
-        },
-    });
-    return response;
-}

package/dist/cjs/report/v1.d.ts

@@ -1,9 +0,0 @@
-export function generateReport(client: ChatBotKitClient, reportId: string, request: ReportGenerateRequest): Promise<ReportGenerateResponse>;
-export function generateTypedReport<T extends ReportId>(client: ChatBotKitClient, reportId: T, request: ReportInputTypes[T]): Promise<ReportOutputTypes[T]>;
-export type ChatBotKitClient = import("../client.js").ChatBotKitClient;
-export type ReportGenerateRequestBody = import("../types/api/v1.js").operations["generateReport"]["requestBody"]["content"]["application/json"];
-export type ReportGenerateRequest = ReportGenerateRequestBody;
-export type ReportGenerateResponse = import("../types/api/v1.js").operations["generateReport"]["responses"]["200"]["content"]["application/json"];
-export type ReportId = import("../types/report.js").ReportId;
-export type ReportInputTypes = import("../types/report.js").ReportInputTypes;
-export type ReportOutputTypes = import("../types/report.js").ReportOutputTypes;

package/dist/esm/report/index.d.ts

@@ -1,6 +0,0 @@
-export class ReportClient extends ChatBotKitClient {
-    generate(reportId: string, request: import("./v1.js").ReportGenerateRequest): Promise<import("./v1.js").ReportGenerateResponse>;
-    generateTyped<T extends import("./v1.js").ReportId>(reportId: T, request: import("./v1.js").ReportInputTypes[T]): Promise<import("./v1.js").ReportOutputTypes[T]>;
-}
-export default ReportClient;
-import { ChatBotKitClient } from '../client.js';

package/dist/esm/report/index.js

@@ -1,14 +0,0 @@
-import { ChatBotKitClient } from '../client.js';
-import { generateReport, generateTypedReport } from './v1.js';
-export class ReportClient extends ChatBotKitClient {
-    constructor(options) {
-        super(options);
-    }
-    generate(reportId, request) {
-        return generateReport(this, reportId, request);
-    }
-    generateTyped(reportId, request) {
-        return generateTypedReport(this, reportId, request);
-    }
-}
-export default ReportClient;

package/dist/esm/report/v1.d.ts

@@ -1,9 +0,0 @@
-export function generateReport(client: ChatBotKitClient, reportId: string, request: ReportGenerateRequest): Promise<ReportGenerateResponse>;
-export function generateTypedReport<T extends ReportId>(client: ChatBotKitClient, reportId: T, request: ReportInputTypes[T]): Promise<ReportOutputTypes[T]>;
-export type ChatBotKitClient = import("../client.js").ChatBotKitClient;
-export type ReportGenerateRequestBody = import("../types/api/v1.js").operations["generateReport"]["requestBody"]["content"]["application/json"];
-export type ReportGenerateRequest = ReportGenerateRequestBody;
-export type ReportGenerateResponse = import("../types/api/v1.js").operations["generateReport"]["responses"]["200"]["content"]["application/json"];
-export type ReportId = import("../types/report.js").ReportId;
-export type ReportInputTypes = import("../types/report.js").ReportInputTypes;
-export type ReportOutputTypes = import("../types/report.js").ReportOutputTypes;

package/dist/esm/report/v1.js

@@ -1,18 +0,0 @@
-export async function generateReport(client, reportId, request) {
-    const url = `/api/v1/report/${reportId}/generate`;
-    const response = await client.clientFetch(url, {
-        record: {
-            ...request,
-        },
-    });
-    return response;
-}
-export async function generateTypedReport(client, reportId, request) {
-    const url = `/api/v1/report/${reportId}/generate`;
-    const response = await client.clientFetch(url, {
-        record: {
-            ...request,
-        },
-    });
-    return response;
-}