@chatbotkit/sdk 1.23.0 → 1.24.0

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'
+export type ReportId = 'clr3m5n8k000008jq7h9e5b1a' | 'clr3m5n8k000108jq3c4d7f2b' | 'clr3m5n8k000208jq8e5f6g3c' | 'clr3m5n8k000308jq1h7i8j4d' | 'clr3m5n8k000408jq9i8j9k5e' | 'clr3m5n8k000508jq2j9k0l6f' | 'clr3m5n8k000608jq3k0l1m7g' | 'clr3m5n8k000708jq4l1m2n8h' | 'clr3m5n8k000808jq5m2n3o9i' | 'clr3m5n8k000908jq6n3o4p0j' | 'clr3m5n8k000a08jq7o4p5q1k' | 'clr3m5n8k000b08jq8p5q6r2l' | 'clr3m5n8k000c08jq9q6r7s3m' | 'clr3m5n8k000d08jqar7s8t4n'
 
 export interface ReportMetadata {
   id: string
@@ -92,6 +92,12 @@ export interface ReportRegistry {
     input: AverageActionsPerConversationInput
     output: AverageActionsPerConversationOutput
   }
+  'clr3m5n8k000d08jqar7s8t4n': {
+    name: string
+    description: string
+    input: ComprehensiveOverviewInput
+    output: ComprehensiveOverviewOutput
+  }
 }
 
 // Input and Output Types for each report
@@ -147,6 +153,10 @@ export type AverageActionsPerConversationInput = {
   periodDays?: number
 }
 
+export type ComprehensiveOverviewInput = {
+  periodDays?: number
+}
+
 export type TotalRatingsOutput = {
   value: number
   change?: number
@@ -232,6 +242,10 @@ export type AverageActionsPerConversationOutput = {
   period: string
 }
 
+export type ComprehensiveOverviewOutput = {
+  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 = {
   'clr3m5n8k000008jq7h9e5b1a': TotalRatingsInput
@@ -247,6 +261,7 @@ export type ReportInputTypes = {
   'clr3m5n8k000a08jq7o4p5q1k': AverageUserMessagesPerConversationInput
   'clr3m5n8k000b08jq8p5q6r2l': AverageBotMessagesPerConversationInput
   'clr3m5n8k000c08jq9q6r7s3m': AverageActionsPerConversationInput
+  'clr3m5n8k000d08jqar7s8t4n': ComprehensiveOverviewInput
 }
 
 export type ReportOutputTypes = {
@@ -263,6 +278,7 @@ export type ReportOutputTypes = {
   'clr3m5n8k000a08jq7o4p5q1k': AverageUserMessagesPerConversationOutput
   'clr3m5n8k000b08jq8p5q6r2l': AverageBotMessagesPerConversationOutput
   'clr3m5n8k000c08jq9q6r7s3m': AverageActionsPerConversationOutput
+  'clr3m5n8k000d08jqar7s8t4n': ComprehensiveOverviewOutput
 }
 
 // Helper type to get input type by report ID

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chatbotkit/sdk",
-  "version": "1.23.0",
+  "version": "1.24.0",
   "description": "The fastest way to build advanced AI chat bots",
   "license": "ISC",
   "engines": {
@@ -2298,6 +2298,56 @@
         "default": "./dist/cjs/platform/content/tutorial/v1.cjs"
       }
     },
+    "./platform/doc": {
+      "import": {
+        "types": "./dist/esm/platform/doc/index.d.ts",
+        "default": "./dist/esm/platform/doc/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/doc/index.d.ts",
+        "default": "./dist/cjs/platform/doc/index.cjs"
+      }
+    },
+    "./platform/doc/index": {
+      "import": {
+        "types": "./dist/esm/platform/doc/index.d.ts",
+        "default": "./dist/esm/platform/doc/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/doc/index.d.ts",
+        "default": "./dist/cjs/platform/doc/index.cjs"
+      }
+    },
+    "./platform/doc/index.js": {
+      "import": {
+        "types": "./dist/esm/platform/doc/index.d.ts",
+        "default": "./dist/esm/platform/doc/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/doc/index.d.ts",
+        "default": "./dist/cjs/platform/doc/index.cjs"
+      }
+    },
+    "./platform/doc/v1": {
+      "import": {
+        "types": "./dist/esm/platform/doc/v1.d.ts",
+        "default": "./dist/esm/platform/doc/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/doc/v1.d.ts",
+        "default": "./dist/cjs/platform/doc/v1.cjs"
+      }
+    },
+    "./platform/doc/v1.js": {
+      "import": {
+        "types": "./dist/esm/platform/doc/v1.d.ts",
+        "default": "./dist/esm/platform/doc/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/doc/v1.d.ts",
+        "default": "./dist/cjs/platform/doc/v1.cjs"
+      }
+    },
     "./platform/example": {
       "import": {
         "types": "./dist/esm/platform/example/index.d.ts",
@@ -2378,6 +2428,56 @@
         "default": "./dist/cjs/platform/index.cjs"
       }
     },
+    "./platform/manual": {
+      "import": {
+        "types": "./dist/esm/platform/manual/index.d.ts",
+        "default": "./dist/esm/platform/manual/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/manual/index.d.ts",
+        "default": "./dist/cjs/platform/manual/index.cjs"
+      }
+    },
+    "./platform/manual/index": {
+      "import": {
+        "types": "./dist/esm/platform/manual/index.d.ts",
+        "default": "./dist/esm/platform/manual/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/manual/index.d.ts",
+        "default": "./dist/cjs/platform/manual/index.cjs"
+      }
+    },
+    "./platform/manual/index.js": {
+      "import": {
+        "types": "./dist/esm/platform/manual/index.d.ts",
+        "default": "./dist/esm/platform/manual/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/manual/index.d.ts",
+        "default": "./dist/cjs/platform/manual/index.cjs"
+      }
+    },
+    "./platform/manual/v1": {
+      "import": {
+        "types": "./dist/esm/platform/manual/v1.d.ts",
+        "default": "./dist/esm/platform/manual/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/manual/v1.d.ts",
+        "default": "./dist/cjs/platform/manual/v1.cjs"
+      }
+    },
+    "./platform/manual/v1.js": {
+      "import": {
+        "types": "./dist/esm/platform/manual/v1.d.ts",
+        "default": "./dist/esm/platform/manual/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/manual/v1.d.ts",
+        "default": "./dist/cjs/platform/manual/v1.cjs"
+      }
+    },
     "./platform/model": {
       "import": {
         "types": "./dist/esm/platform/model/index.d.ts",
@@ -2528,6 +2628,56 @@
         "default": "./dist/cjs/platform/secret/v1.cjs"
       }
     },
+    "./platform/tutorial": {
+      "import": {
+        "types": "./dist/esm/platform/tutorial/index.d.ts",
+        "default": "./dist/esm/platform/tutorial/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/tutorial/index.d.ts",
+        "default": "./dist/cjs/platform/tutorial/index.cjs"
+      }
+    },
+    "./platform/tutorial/index": {
+      "import": {
+        "types": "./dist/esm/platform/tutorial/index.d.ts",
+        "default": "./dist/esm/platform/tutorial/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/tutorial/index.d.ts",
+        "default": "./dist/cjs/platform/tutorial/index.cjs"
+      }
+    },
+    "./platform/tutorial/index.js": {
+      "import": {
+        "types": "./dist/esm/platform/tutorial/index.d.ts",
+        "default": "./dist/esm/platform/tutorial/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/tutorial/index.d.ts",
+        "default": "./dist/cjs/platform/tutorial/index.cjs"
+      }
+    },
+    "./platform/tutorial/v1": {
+      "import": {
+        "types": "./dist/esm/platform/tutorial/v1.d.ts",
+        "default": "./dist/esm/platform/tutorial/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/tutorial/v1.d.ts",
+        "default": "./dist/cjs/platform/tutorial/v1.cjs"
+      }
+    },
+    "./platform/tutorial/v1.js": {
+      "import": {
+        "types": "./dist/esm/platform/tutorial/v1.d.ts",
+        "default": "./dist/esm/platform/tutorial/v1.js"
+      },
+      "require": {
+        "types": "./dist/cjs/platform/tutorial/v1.d.ts",
+        "default": "./dist/cjs/platform/tutorial/v1.cjs"
+      }
+    },
     "./platform/v1": {
       "import": {
         "types": "./dist/esm/platform/v1.d.ts",