@chatbotkit/cli 1.8.0 → 1.9.0

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

@@ -0,0 +1,815 @@
+export function getSolutionFolderPath(): string;
+export function getSolutionFileName(name: string): string;
+export function getSolutionFilePath(name: string): string;
+export function getSolutionFileNameAndPath(name: string): {
+    fileName: string;
+    filePath: string;
+};
+export function getArrayBackedObject<T>(array: T[]): {
+    [key: string]: T;
+};
+export const BasicResourceConfigSchema: z.ZodObject<{
+    type: z.ZodString;
+    slug: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    properties: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    type?: string;
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    properties?: Record<string, unknown>;
+}, {
+    type?: string;
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    properties?: Record<string, unknown>;
+}>;
+export const BotResourceConfigSchema: z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"bot">;
+    properties: z.ZodObject<{
+        model: z.ZodOptional<z.ZodString>;
+        backstory: z.ZodOptional<z.ZodString>;
+        datasetId: z.ZodOptional<z.ZodString>;
+        skillsetId: z.ZodOptional<z.ZodString>;
+        moderation: z.ZodOptional<z.ZodBoolean>;
+        privacy: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        model?: string;
+        backstory?: string;
+        datasetId?: string;
+        skillsetId?: string;
+        moderation?: boolean;
+        privacy?: boolean;
+    }, {
+        model?: string;
+        backstory?: string;
+        datasetId?: string;
+        skillsetId?: string;
+        moderation?: boolean;
+        privacy?: boolean;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    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?: "bot";
+    properties?: {
+        model?: string;
+        backstory?: string;
+        datasetId?: string;
+        skillsetId?: string;
+        moderation?: boolean;
+        privacy?: boolean;
+    };
+}>;
+export const DatasetResourceConfigSchema: z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"dataset">;
+    properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "dataset";
+    properties?: {};
+}, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "dataset";
+    properties?: {};
+}>;
+export const SkillsetResourceConfigSchema: z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"skillset">;
+    properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "skillset";
+    properties?: {};
+}, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "skillset";
+    properties?: {};
+}>;
+export const WidgetIntegrationResourceConfigSchema: z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"widgetIntegration">;
+    properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "widgetIntegration";
+    properties?: {};
+}, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "widgetIntegration";
+    properties?: {};
+}>;
+export const SitemapIntegrationResourceConfigSchema: z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    id: 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;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "sitemapIntegration";
+    properties?: {
+        url?: string;
+        datasetId?: string;
+    };
+}, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "sitemapIntegration";
+    properties?: {
+        url?: string;
+        datasetId?: string;
+    };
+}>;
+export const ResourceConfigSchema: z.ZodUnion<[z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"bot">;
+    properties: z.ZodObject<{
+        model: z.ZodOptional<z.ZodString>;
+        backstory: z.ZodOptional<z.ZodString>;
+        datasetId: z.ZodOptional<z.ZodString>;
+        skillsetId: z.ZodOptional<z.ZodString>;
+        moderation: z.ZodOptional<z.ZodBoolean>;
+        privacy: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        model?: string;
+        backstory?: string;
+        datasetId?: string;
+        skillsetId?: string;
+        moderation?: boolean;
+        privacy?: boolean;
+    }, {
+        model?: string;
+        backstory?: string;
+        datasetId?: string;
+        skillsetId?: string;
+        moderation?: boolean;
+        privacy?: boolean;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    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?: "bot";
+    properties?: {
+        model?: string;
+        backstory?: string;
+        datasetId?: string;
+        skillsetId?: string;
+        moderation?: boolean;
+        privacy?: boolean;
+    };
+}>, z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"dataset">;
+    properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "dataset";
+    properties?: {};
+}, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "dataset";
+    properties?: {};
+}>, z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"skillset">;
+    properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "skillset";
+    properties?: {};
+}, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "skillset";
+    properties?: {};
+}>, z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    type: z.ZodLiteral<"widgetIntegration">;
+    properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+}, "strip", z.ZodTypeAny, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "widgetIntegration";
+    properties?: {};
+}, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "widgetIntegration";
+    properties?: {};
+}>, z.ZodObject<{
+    slug: z.ZodOptional<z.ZodString>;
+    id: 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;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "sitemapIntegration";
+    properties?: {
+        url?: string;
+        datasetId?: string;
+    };
+}, {
+    slug?: string;
+    id?: string;
+    name?: string;
+    description?: string;
+    type?: "sitemapIntegration";
+    properties?: {
+        url?: string;
+        datasetId?: string;
+    };
+}>]>;
+export const SolutionConfigSchema: z.ZodObject<{
+    version: z.ZodLiteral<1>;
+    resources: z.ZodArray<z.ZodUnion<[z.ZodObject<{
+        slug: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"bot">;
+        properties: z.ZodObject<{
+            model: z.ZodOptional<z.ZodString>;
+            backstory: z.ZodOptional<z.ZodString>;
+            datasetId: z.ZodOptional<z.ZodString>;
+            skillsetId: z.ZodOptional<z.ZodString>;
+            moderation: z.ZodOptional<z.ZodBoolean>;
+            privacy: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            model?: string;
+            backstory?: string;
+            datasetId?: string;
+            skillsetId?: string;
+            moderation?: boolean;
+            privacy?: boolean;
+        }, {
+            model?: string;
+            backstory?: string;
+            datasetId?: string;
+            skillsetId?: string;
+            moderation?: boolean;
+            privacy?: boolean;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        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?: "bot";
+        properties?: {
+            model?: string;
+            backstory?: string;
+            datasetId?: string;
+            skillsetId?: string;
+            moderation?: boolean;
+            privacy?: boolean;
+        };
+    }>, z.ZodObject<{
+        slug: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"dataset">;
+        properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    }, "strip", z.ZodTypeAny, {
+        slug?: string;
+        id?: string;
+        name?: string;
+        description?: string;
+        type?: "dataset";
+        properties?: {};
+    }, {
+        slug?: string;
+        id?: string;
+        name?: string;
+        description?: string;
+        type?: "dataset";
+        properties?: {};
+    }>, z.ZodObject<{
+        slug: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"skillset">;
+        properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    }, "strip", z.ZodTypeAny, {
+        slug?: string;
+        id?: string;
+        name?: string;
+        description?: string;
+        type?: "skillset";
+        properties?: {};
+    }, {
+        slug?: string;
+        id?: string;
+        name?: string;
+        description?: string;
+        type?: "skillset";
+        properties?: {};
+    }>, z.ZodObject<{
+        slug: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        type: z.ZodLiteral<"widgetIntegration">;
+        properties: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+    }, "strip", z.ZodTypeAny, {
+        slug?: string;
+        id?: string;
+        name?: string;
+        description?: string;
+        type?: "widgetIntegration";
+        properties?: {};
+    }, {
+        slug?: string;
+        id?: string;
+        name?: string;
+        description?: string;
+        type?: "widgetIntegration";
+        properties?: {};
+    }>, z.ZodObject<{
+        slug: z.ZodOptional<z.ZodString>;
+        id: 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;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        slug?: string;
+        id?: string;
+        name?: string;
+        description?: string;
+        type?: "sitemapIntegration";
+        properties?: {
+            url?: string;
+            datasetId?: string;
+        };
+    }, {
+        slug?: string;
+        id?: string;
+        name?: string;
+        description?: string;
+        type?: "sitemapIntegration";
+        properties?: {
+            url?: string;
+            datasetId?: string;
+        };
+    }>]>, "many">;
+}, "strip", z.ZodTypeAny, {
+    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;
+        };
+    })[];
+}, {
+    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;
+        };
+    })[];
+}>;
+export class Resource {
+    constructor(config: ResourceConfig);
+    config: {
+        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;
+        };
+    };
+    get type(): string;
+    get slug(): string;
+    get id(): string;
+    get name(): string;
+    get description(): string;
+    get baseClient(): ChatBotKit;
+    get client(): {
+        update: (id: string, properties: Record<string, unknown>) => void;
+    };
+    sync(): Promise<void>;
+}
+export class BotResource extends Resource {
+    override get client(): import("@chatbotkit/sdk").BotClient;
+}
+export class DatasetResource extends Resource {
+    override get client(): import("@chatbotkit/sdk").DatasetClient;
+}
+export class SkillsetResource extends Resource {
+    override get client(): import("@chatbotkit/sdk").SkillsetClient;
+}
+export class WidgetIntegrationResource extends Resource {
+    override get client(): any;
+}
+export class SitemapIntegrationResource extends Resource {
+    override get client(): any;
+}
+export class Solution {
+    constructor(config: SolutionConfig);
+    config: {
+        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;
+            };
+        })[];
+    };
+    get baseClient(): ChatBotKit;
+    get resources(): (BotResource | DatasetResource | SkillsetResource | WidgetIntegrationResource | SitemapIntegrationResource)[];
+    get bots(): BotResource[];
+    get bot(): {
+        [key: string]: BotResource;
+    };
+    get datasets(): DatasetResource[];
+    get dataset(): {
+        [key: string]: DatasetResource;
+    };
+    get skillsets(): SkillsetResource[];
+    get skillset(): {
+        [key: string]: SkillsetResource;
+    };
+    get widgetIntegrations(): WidgetIntegrationResource[];
+    get widgetIntegration(): {
+        [key: string]: WidgetIntegrationResource;
+    };
+    get sitemapIntegrations(): SitemapIntegrationResource[];
+    get sitemapIntegration(): {
+        [key: string]: SitemapIntegrationResource;
+    };
+    sync(): Promise<void>;
+}
+export namespace Solution {
+    export function list(): Promise<string[]>;
+    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 class ArrayBackedObject<T> {
+    constructor(array: T[]);
+    array: T[];
+}
+export type SolutionConfig = z.infer<typeof SolutionConfigSchema>;
+export type ResourceConfig = z.infer<typeof ResourceConfigSchema>;
+import { z } from 'zod';
+import ChatBotKit from '@chatbotkit/sdk';