@chatbotkit/cli 1.18.3 → 1.20.0

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

@@ -7,7 +7,7 @@ export function getSolutionFileNameAndPath(name: string): {
 };
 export function replaceEnvVars(value: any): any;
 export function getArrayBackedObject<T>(array: T[]): {
-    [key: string]: T;
+    [key: string]: T | undefined;
 };
 export const BasicResourceConfigSchema: z.ZodObject<{
     type: z.ZodString;
@@ -36,6 +36,7 @@ export const BotResourceConfigSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+} & {
     type: z.ZodLiteral<"bot">;
     properties: z.ZodObject<{
         model: z.ZodOptional<z.ZodString>;
@@ -60,11 +61,11 @@ export const BotResourceConfigSchema: z.ZodObject<{
         privacy?: boolean;
     }>;
 }, "strip", z.ZodTypeAny, {
+    type?: "bot";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "bot";
     properties?: {
         model?: string;
         backstory?: string;
@@ -74,11 +75,11 @@ export const BotResourceConfigSchema: z.ZodObject<{
         privacy?: boolean;
     };
 }, {
+    type?: "bot";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "bot";
     properties?: {
         model?: string;
         backstory?: string;
@@ -93,21 +94,22 @@ export const DatasetResourceConfigSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+} & {
     type: z.ZodLiteral<"dataset">;
     properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 }, "strip", z.ZodTypeAny, {
+    type?: "dataset";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "dataset";
     properties?: {};
 }, {
+    type?: "dataset";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "dataset";
     properties?: {};
 }>;
 export const SkillsetResourceConfigSchema: z.ZodObject<{
@@ -115,21 +117,22 @@ export const SkillsetResourceConfigSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+} & {
     type: z.ZodLiteral<"skillset">;
     properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 }, "strip", z.ZodTypeAny, {
+    type?: "skillset";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "skillset";
     properties?: {};
 }, {
+    type?: "skillset";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "skillset";
     properties?: {};
 }>;
 export const WidgetIntegrationResourceConfigSchema: z.ZodObject<{
@@ -137,21 +140,22 @@ export const WidgetIntegrationResourceConfigSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+} & {
     type: z.ZodLiteral<"widgetIntegration">;
     properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 }, "strip", z.ZodTypeAny, {
+    type?: "widgetIntegration";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "widgetIntegration";
     properties?: {};
 }, {
+    type?: "widgetIntegration";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "widgetIntegration";
     properties?: {};
 }>;
 export const SitemapIntegrationResourceConfigSchema: z.ZodObject<{
@@ -159,36 +163,37 @@ export const SitemapIntegrationResourceConfigSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+} & {
     type: z.ZodLiteral<"sitemapIntegration">;
     properties: z.ZodObject<{
         url: z.ZodString;
         datasetId: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        url?: string;
         datasetId?: string;
-    }, {
         url?: string;
+    }, {
         datasetId?: string;
+        url?: string;
     }>;
 }, "strip", z.ZodTypeAny, {
+    type?: "sitemapIntegration";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "sitemapIntegration";
     properties?: {
-        url?: string;
         datasetId?: string;
+        url?: string;
     };
 }, {
+    type?: "sitemapIntegration";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "sitemapIntegration";
     properties?: {
-        url?: string;
         datasetId?: string;
+        url?: string;
     };
 }>;
 export const ResourceConfigSchema: z.ZodUnion<[z.ZodObject<{
@@ -196,6 +201,7 @@ export const ResourceConfigSchema: z.ZodUnion<[z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+} & {
     type: z.ZodLiteral<"bot">;
     properties: z.ZodObject<{
         model: z.ZodOptional<z.ZodString>;
@@ -220,11 +226,11 @@ export const ResourceConfigSchema: z.ZodUnion<[z.ZodObject<{
         privacy?: boolean;
     }>;
 }, "strip", z.ZodTypeAny, {
+    type?: "bot";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "bot";
     properties?: {
         model?: string;
         backstory?: string;
@@ -234,11 +240,11 @@ export const ResourceConfigSchema: z.ZodUnion<[z.ZodObject<{
         privacy?: boolean;
     };
 }, {
+    type?: "bot";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "bot";
     properties?: {
         model?: string;
         backstory?: string;
@@ -252,99 +258,103 @@ export const ResourceConfigSchema: z.ZodUnion<[z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+} & {
     type: z.ZodLiteral<"dataset">;
     properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 }, "strip", z.ZodTypeAny, {
+    type?: "dataset";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "dataset";
     properties?: {};
 }, {
+    type?: "dataset";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "dataset";
     properties?: {};
 }>, z.ZodObject<{
     slug: z.ZodOptional<z.ZodString>;
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+} & {
     type: z.ZodLiteral<"skillset">;
     properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 }, "strip", z.ZodTypeAny, {
+    type?: "skillset";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "skillset";
     properties?: {};
 }, {
+    type?: "skillset";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "skillset";
     properties?: {};
 }>, z.ZodObject<{
     slug: z.ZodOptional<z.ZodString>;
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+} & {
     type: z.ZodLiteral<"widgetIntegration">;
     properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
 }, "strip", z.ZodTypeAny, {
+    type?: "widgetIntegration";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "widgetIntegration";
     properties?: {};
 }, {
+    type?: "widgetIntegration";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "widgetIntegration";
     properties?: {};
 }>, z.ZodObject<{
     slug: z.ZodOptional<z.ZodString>;
     id: z.ZodOptional<z.ZodString>;
     name: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
+} & {
     type: z.ZodLiteral<"sitemapIntegration">;
     properties: z.ZodObject<{
         url: z.ZodString;
         datasetId: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        url?: string;
         datasetId?: string;
-    }, {
         url?: string;
+    }, {
         datasetId?: string;
+        url?: string;
     }>;
 }, "strip", z.ZodTypeAny, {
+    type?: "sitemapIntegration";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "sitemapIntegration";
     properties?: {
-        url?: string;
         datasetId?: string;
+        url?: string;
     };
 }, {
+    type?: "sitemapIntegration";
     slug?: string;
     id?: string;
     name?: string;
     description?: string;
-    type?: "sitemapIntegration";
     properties?: {
-        url?: string;
         datasetId?: string;
+        url?: string;
     };
 }>]>;
 export const SolutionConfigSchema: z.ZodObject<{
@@ -354,6 +364,7 @@ export const SolutionConfigSchema: z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
         name: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
+    } & {
         type: z.ZodLiteral<"bot">;
         properties: z.ZodObject<{
             model: z.ZodOptional<z.ZodString>;
@@ -378,11 +389,11 @@ export const SolutionConfigSchema: z.ZodObject<{
             privacy?: boolean;
         }>;
     }, "strip", z.ZodTypeAny, {
+        type?: "bot";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "bot";
         properties?: {
             model?: string;
             backstory?: string;
@@ -392,11 +403,11 @@ export const SolutionConfigSchema: z.ZodObject<{
             privacy?: boolean;
         };
     }, {
+        type?: "bot";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "bot";
         properties?: {
             model?: string;
             backstory?: string;
@@ -410,109 +421,113 @@ export const SolutionConfigSchema: z.ZodObject<{
         id: z.ZodOptional<z.ZodString>;
         name: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
+    } & {
         type: z.ZodLiteral<"dataset">;
         properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
     }, "strip", z.ZodTypeAny, {
+        type?: "dataset";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "dataset";
         properties?: {};
     }, {
+        type?: "dataset";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "dataset";
         properties?: {};
     }>, z.ZodObject<{
         slug: z.ZodOptional<z.ZodString>;
         id: z.ZodOptional<z.ZodString>;
         name: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
+    } & {
         type: z.ZodLiteral<"skillset">;
         properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
     }, "strip", z.ZodTypeAny, {
+        type?: "skillset";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "skillset";
         properties?: {};
     }, {
+        type?: "skillset";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "skillset";
         properties?: {};
     }>, z.ZodObject<{
         slug: z.ZodOptional<z.ZodString>;
         id: z.ZodOptional<z.ZodString>;
         name: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
+    } & {
         type: z.ZodLiteral<"widgetIntegration">;
         properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
     }, "strip", z.ZodTypeAny, {
+        type?: "widgetIntegration";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "widgetIntegration";
         properties?: {};
     }, {
+        type?: "widgetIntegration";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "widgetIntegration";
         properties?: {};
     }>, z.ZodObject<{
         slug: z.ZodOptional<z.ZodString>;
         id: z.ZodOptional<z.ZodString>;
         name: z.ZodString;
         description: z.ZodOptional<z.ZodString>;
+    } & {
         type: z.ZodLiteral<"sitemapIntegration">;
         properties: z.ZodObject<{
             url: z.ZodString;
             datasetId: z.ZodString;
         }, "strip", z.ZodTypeAny, {
-            url?: string;
             datasetId?: string;
-        }, {
             url?: string;
+        }, {
             datasetId?: string;
+            url?: string;
         }>;
     }, "strip", z.ZodTypeAny, {
+        type?: "sitemapIntegration";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "sitemapIntegration";
         properties?: {
-            url?: string;
             datasetId?: string;
+            url?: string;
         };
     }, {
+        type?: "sitemapIntegration";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "sitemapIntegration";
         properties?: {
-            url?: string;
             datasetId?: string;
+            url?: string;
         };
     }>]>, "many">;
 }, "strip", z.ZodTypeAny, {
     version?: 1;
     resources?: ({
+        type?: "bot";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "bot";
         properties?: {
             model?: string;
             backstory?: string;
@@ -522,45 +537,45 @@ export const SolutionConfigSchema: z.ZodObject<{
             privacy?: boolean;
         };
     } | {
+        type?: "dataset";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "dataset";
         properties?: {};
     } | {
+        type?: "skillset";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "skillset";
         properties?: {};
     } | {
+        type?: "widgetIntegration";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "widgetIntegration";
         properties?: {};
     } | {
+        type?: "sitemapIntegration";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "sitemapIntegration";
         properties?: {
-            url?: string;
             datasetId?: string;
+            url?: string;
         };
     })[];
 }, {
     version?: 1;
     resources?: ({
+        type?: "bot";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "bot";
         properties?: {
             model?: string;
             backstory?: string;
@@ -570,46 +585,46 @@ export const SolutionConfigSchema: z.ZodObject<{
             privacy?: boolean;
         };
     } | {
+        type?: "dataset";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "dataset";
         properties?: {};
     } | {
+        type?: "skillset";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "skillset";
         properties?: {};
     } | {
+        type?: "widgetIntegration";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "widgetIntegration";
         properties?: {};
     } | {
+        type?: "sitemapIntegration";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "sitemapIntegration";
         properties?: {
-            url?: string;
             datasetId?: string;
+            url?: string;
         };
     })[];
 }>;
 export class Resource {
     constructor(config: ResourceConfig);
     config: {
+        type?: "bot";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "bot";
         properties?: {
             model?: string;
             backstory?: string;
@@ -619,43 +634,43 @@ export class Resource {
             privacy?: boolean;
         };
     } | {
+        type?: "dataset";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "dataset";
         properties?: {};
     } | {
+        type?: "skillset";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "skillset";
         properties?: {};
     } | {
+        type?: "widgetIntegration";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "widgetIntegration";
         properties?: {};
     } | {
+        type?: "sitemapIntegration";
         slug?: string;
         id?: string;
         name?: string;
         description?: string;
-        type?: "sitemapIntegration";
         properties?: {
-            url?: string;
             datasetId?: string;
+            url?: string;
         };
     };
     get type(): string;
     get slug(): string;
-    get id(): string;
+    get id(): string | undefined;
     get name(): string;
-    get description(): string;
-    get baseClient(): ChatBotKit;
+    get description(): string | undefined;
+    get baseClient(): import("@chatbotkit/sdk").ChatBotKit;
     get client(): {
         create: (properties: Record<string, any>) => Promise<{
             id: string;
@@ -686,11 +701,11 @@ export class Solution {
     config: {
         version?: 1;
         resources?: ({
+            type?: "bot";
             slug?: string;
             id?: string;
             name?: string;
             description?: string;
-            type?: "bot";
             properties?: {
                 model?: string;
                 backstory?: string;
@@ -700,59 +715,59 @@ export class Solution {
                 privacy?: boolean;
             };
         } | {
+            type?: "dataset";
             slug?: string;
             id?: string;
             name?: string;
             description?: string;
-            type?: "dataset";
             properties?: {};
         } | {
+            type?: "skillset";
             slug?: string;
             id?: string;
             name?: string;
             description?: string;
-            type?: "skillset";
             properties?: {};
         } | {
+            type?: "widgetIntegration";
             slug?: string;
             id?: string;
             name?: string;
             description?: string;
-            type?: "widgetIntegration";
             properties?: {};
         } | {
+            type?: "sitemapIntegration";
             slug?: string;
             id?: string;
             name?: string;
             description?: string;
-            type?: "sitemapIntegration";
             properties?: {
-                url?: string;
                 datasetId?: string;
+                url?: string;
             };
         })[];
     };
-    get baseClient(): ChatBotKit;
+    get baseClient(): import("@chatbotkit/sdk").ChatBotKit;
     get resources(): (BotResource | DatasetResource | SkillsetResource | WidgetIntegrationResource | SitemapIntegrationResource)[];
     get bots(): BotResource[];
     get bot(): {
-        [key: string]: BotResource;
+        [key: string]: BotResource | undefined;
     };
     get datasets(): DatasetResource[];
     get dataset(): {
-        [key: string]: DatasetResource;
+        [key: string]: DatasetResource | undefined;
     };
     get skillsets(): SkillsetResource[];
     get skillset(): {
-        [key: string]: SkillsetResource;
+        [key: string]: SkillsetResource | undefined;
     };
     get widgetIntegrations(): WidgetIntegrationResource[];
     get widgetIntegration(): {
-        [key: string]: WidgetIntegrationResource;
+        [key: string]: WidgetIntegrationResource | undefined;
     };
     get sitemapIntegrations(): SitemapIntegrationResource[];
     get sitemapIntegration(): {
-        [key: string]: SitemapIntegrationResource;
+        [key: string]: SitemapIntegrationResource | undefined;
     };
     sync(): Promise<void>;
 }
@@ -761,55 +776,7 @@ export namespace Solution {
     export function create(name: string): Promise<void>;
     function _delete(name: string): Promise<void>;
     export { _delete as delete };
-    export function load(config: string | {
-        version?: 1;
-        resources?: ({
-            slug?: string;
-            id?: string;
-            name?: string;
-            description?: string;
-            type?: "bot";
-            properties?: {
-                model?: string;
-                backstory?: string;
-                datasetId?: string;
-                skillsetId?: string;
-                moderation?: boolean;
-                privacy?: boolean;
-            };
-        } | {
-            slug?: string;
-            id?: string;
-            name?: string;
-            description?: string;
-            type?: "dataset";
-            properties?: {};
-        } | {
-            slug?: string;
-            id?: string;
-            name?: string;
-            description?: string;
-            type?: "skillset";
-            properties?: {};
-        } | {
-            slug?: string;
-            id?: string;
-            name?: string;
-            description?: string;
-            type?: "widgetIntegration";
-            properties?: {};
-        } | {
-            slug?: string;
-            id?: string;
-            name?: string;
-            description?: string;
-            type?: "sitemapIntegration";
-            properties?: {
-                url?: string;
-                datasetId?: string;
-            };
-        })[];
-    }): Promise<Solution>;
+    export function load(config: string | SolutionConfig): Promise<Solution>;
     export function save(name: string, solution: Solution): Promise<void>;
 }
 export class ArrayBackedObject<T> {
@@ -819,4 +786,3 @@ export class ArrayBackedObject<T> {
 export type SolutionConfig = z.infer<typeof SolutionConfigSchema>;
 export type ResourceConfig = z.infer<typeof ResourceConfigSchema>;
 import { z } from 'zod';
-import ChatBotKit from '@chatbotkit/sdk';