@chatbotkit/cli 1.5.0

package/README.md

@@ -0,0 +1,31 @@
+[![Follow on Twitter](https://img.shields.io/twitter/follow/chatbotkit.svg?logo=twitter)](https://twitter.com/chatbotkit)
+[![ChatBotKit](https://img.shields.io/badge/credits-ChatBotKit-blue.svg)](https://chatbotkit.com)
+[![NPM](https://img.shields.io/npm/v/@chatbotkit/cli.svg)](https://www.npmjs.com/package/@chatbotkit/cli)
+
+# ChatBotKit CLI
+
+The ChatBotKit CLI is a command-line interface for the ChatBotKit SDK. It provides a set of commands to help you manage your ChatBotKit projects.
+
+## Getting Started
+
+To begin using the ChatBotKit CLI, follow these steps:
+
+1. **Installation**: Add the SDK to your project using npm:
+
+   ```bash
+   npm install --global @chatbotkit/cli
+   ```
+
+2. **Usage**: Get help on the available commands:
+
+   ```bash
+   cbk --help
+   ```
+
+## Documentation
+
+For comprehensive information about the ChatBotKit CLI SDK, including detailed documentation on its functionalities, helper methods, and configuration options, please visit our [type documentation page](https://chatbotkit.github.io/node-sdk/modules/_chatbotkit_cli.html).
+
+## Contributing
+
+If you find a bug or would like to contribute to the ChatBotKit SDK, please open an issue or submit a pull request on the [official GitHub repository](https://github.com/chatbotkit/node-sdk).

package/bin/cbk.js

@@ -0,0 +1,4 @@
+import cbk from '../src/index.js'
+import { printError } from '../src/output.js'
+
+cbk().catch(printError)

package/dist/cjs/command/api/conversation/index.cjs

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = exports.conversationDelete = exports.conversationFetch = exports.conversationList = void 0;
+const tslib_1 = require("tslib");
+const commander_1 = require("commander");
+const index_js_1 = require("@chatbotkit/sdk/conversation/index.js");
+const index_js_2 = tslib_1.__importDefault(require("./message/index.cjs"));
+const output_js_1 = require("../../../output.cjs");
+const env_js_1 = require("../../../env.cjs");
+const client = new index_js_1.ConversationClient({
+    secret: (0, env_js_1.getSECRET)(),
+    runAsUserId: (0, env_js_1.getRUNAS_USERID)(),
+});
+exports.conversationList = new commander_1.Command()
+    .name('list')
+    .description('List conversations')
+    .option('-s, --stream', 'Stream conversations')
+    .action(async (str, options) => {
+    const { stream } = options;
+    if (stream) {
+        for await (const conversation of client.list().stream()) {
+            (0, output_js_1.print)(conversation);
+        }
+    }
+    else {
+        const { items } = await client.list();
+        for (const conversation of items) {
+            (0, output_js_1.print)(conversation);
+        }
+    }
+});
+exports.conversationFetch = new commander_1.Command()
+    .name('fetch')
+    .description('Fetch conversation')
+    .argument('<conversationId>', 'Conversation ID')
+    .action(async (conversationId) => {
+    const conversation = await client.fetch(conversationId);
+    (0, output_js_1.print)(conversation);
+});
+exports.conversationDelete = new commander_1.Command()
+    .name('delete')
+    .description('Delete conversation')
+    .argument('<conversationId>', 'Conversation ID')
+    .action(async (conversationId) => {
+    await client.delete(conversationId);
+});
+exports.command = new commander_1.Command()
+    .name('conversation')
+    .description('Conversation tools for ChatBotKit')
+    .addCommand(exports.conversationList)
+    .addCommand(exports.conversationFetch)
+    .addCommand(exports.conversationDelete)
+    .addCommand(index_js_2.default);
+exports.default = exports.command;

package/dist/cjs/command/api/conversation/index.d.ts

@@ -0,0 +1,6 @@
+export const conversationList: Command;
+export const conversationFetch: Command;
+export const conversationDelete: Command;
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/cjs/command/api/conversation/message/index.cjs

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = exports.messageDelete = exports.messageFetch = exports.messageList = void 0;
+const commander_1 = require("commander");
+const index_js_1 = require("@chatbotkit/sdk/conversation/message/index.js");
+const output_js_1 = require("../../../../output.cjs");
+const env_js_1 = require("../../../../env.cjs");
+const client = new index_js_1.ConversationMessageClient({
+    secret: (0, env_js_1.getSECRET)(),
+    runAsUserId: (0, env_js_1.getRUNAS_USERID)(),
+});
+exports.messageList = new commander_1.Command()
+    .name('list')
+    .description('List messages')
+    .option('-s, --stream', 'Stream messages')
+    .argument('<conversationId>', 'Conversation ID')
+    .action(async (conversationId, options) => {
+    const { stream } = options;
+    if (stream) {
+        for await (const message of client.list(conversationId).stream()) {
+            (0, output_js_1.print)(message);
+        }
+    }
+    else {
+        const { items } = await client.list(conversationId);
+        for (const message of items) {
+            (0, output_js_1.print)(message);
+        }
+    }
+});
+exports.messageFetch = new commander_1.Command()
+    .name('fetch')
+    .description('Fetch message')
+    .argument('<conversationId>', 'Conversation ID')
+    .argument('<messageId>', 'Message ID')
+    .action(async (conversationId, messageId) => {
+    const message = await client.fetch(conversationId, messageId);
+    (0, output_js_1.print)(message);
+});
+exports.messageDelete = new commander_1.Command()
+    .name('delete')
+    .description('Delete message')
+    .argument('<conversationId>', 'Conversation ID')
+    .argument('<messageId>', 'Message ID')
+    .action(async (conversationId, messageId) => {
+    await client.delete(conversationId, messageId);
+});
+exports.command = new commander_1.Command()
+    .name('message')
+    .description('Message tools for ChatBotKit')
+    .addCommand(exports.messageList)
+    .addCommand(exports.messageFetch)
+    .addCommand(exports.messageDelete);
+exports.default = exports.command;

package/dist/cjs/command/api/conversation/message/index.d.ts

@@ -0,0 +1,6 @@
+export const messageList: Command;
+export const messageFetch: Command;
+export const messageDelete: Command;
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/cjs/command/api/dataset/index.cjs

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = exports.datasetDelete = exports.datasetFetch = exports.datasetList = void 0;
+const commander_1 = require("commander");
+const index_js_1 = require("@chatbotkit/sdk/dataset/index.js");
+const output_js_1 = require("../../../output.cjs");
+const env_js_1 = require("../../../env.cjs");
+const client = new index_js_1.DatasetClient({
+    secret: (0, env_js_1.getSECRET)(),
+    runAsUserId: (0, env_js_1.getRUNAS_USERID)(),
+});
+exports.datasetList = new commander_1.Command()
+    .name('list')
+    .description('List datasets')
+    .option('-s, --stream', 'Stream datasets')
+    .action(async (str, options) => {
+    const { stream } = options;
+    if (stream) {
+        for await (const dataset of client.list().stream()) {
+            (0, output_js_1.print)(dataset);
+        }
+    }
+    else {
+        const { items } = await client.list();
+        for (const dataset of items) {
+            (0, output_js_1.print)(dataset);
+        }
+    }
+});
+exports.datasetFetch = new commander_1.Command()
+    .name('fetch')
+    .description('Fetch dataset')
+    .argument('<datasetId>', 'Dataset ID')
+    .action(async (datasetId) => {
+    const dataset = await client.fetch(datasetId);
+    (0, output_js_1.print)(dataset);
+});
+exports.datasetDelete = new commander_1.Command()
+    .name('delete')
+    .description('Delete dataset')
+    .argument('<datasetId>', 'Dataset ID')
+    .action(async (datasetId) => {
+    await client.delete(datasetId);
+});
+exports.command = new commander_1.Command()
+    .name('dataset')
+    .description('Dataset tools for ChatBotKit')
+    .addCommand(exports.datasetList)
+    .addCommand(exports.datasetFetch)
+    .addCommand(exports.datasetDelete);
+exports.default = exports.command;

package/dist/cjs/command/api/dataset/index.d.ts

@@ -0,0 +1,6 @@
+export const datasetList: Command;
+export const datasetFetch: Command;
+export const datasetDelete: Command;
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/cjs/command/api/index.cjs

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
+const tslib_1 = require("tslib");
+const commander_1 = require("commander");
+const index_js_1 = tslib_1.__importDefault(require("./partner/index.cjs"));
+const index_js_2 = tslib_1.__importDefault(require("./dataset/index.cjs"));
+const index_js_3 = tslib_1.__importDefault(require("./skillset/index.cjs"));
+const index_js_4 = tslib_1.__importDefault(require("./conversation/index.cjs"));
+const output_js_1 = require("../../output.cjs");
+exports.command = new commander_1.Command()
+    .name('api')
+    .description('API tools for ChatBotKit')
+    .addCommand(index_js_2.default)
+    .addCommand(index_js_3.default)
+    .addCommand(index_js_4.default)
+    .addCommand(index_js_1.default);
+exports.command
+    .addOption(new commander_1.Option('-o, --output <format>', 'Output format').choices([
+    'yaml',
+    'json',
+    'jsonl',
+]))
+    .on('option:output', (value) => {
+    output_js_1.config.output = value;
+});
+exports.default = exports.command;

package/dist/cjs/command/api/index.d.ts

@@ -0,0 +1,3 @@
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/cjs/command/api/partner/index.cjs

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
+const tslib_1 = require("tslib");
+const commander_1 = require("commander");
+const index_js_1 = tslib_1.__importDefault(require("./user/index.cjs"));
+exports.command = new commander_1.Command()
+    .name('partner')
+    .description('Partner tools for ChatBotKit')
+    .addCommand(index_js_1.default);
+exports.default = exports.command;

package/dist/cjs/command/api/partner/index.d.ts

@@ -0,0 +1,3 @@
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/cjs/command/api/partner/user/index.cjs

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = exports.userDelete = exports.userFetch = exports.userList = void 0;
+const commander_1 = require("commander");
+const index_js_1 = require("@chatbotkit/sdk/partner/user/index.js");
+const output_js_1 = require("../../../../output.cjs");
+const env_js_1 = require("../../../../env.cjs");
+const client = new index_js_1.PartnerUserClient({
+    secret: (0, env_js_1.getSECRET)(),
+    runAsUserId: (0, env_js_1.getRUNAS_USERID)(),
+});
+exports.userList = new commander_1.Command()
+    .name('list')
+    .description('List users')
+    .option('-s, --stream', 'Stream users')
+    .action(async (_arg, options) => {
+    const { stream } = options;
+    if (stream) {
+        for await (const user of client.list().stream()) {
+            (0, output_js_1.print)(user);
+        }
+    }
+    else {
+        const { items } = await client.list();
+        for (const user of items) {
+            (0, output_js_1.print)(user);
+        }
+    }
+});
+exports.userFetch = new commander_1.Command()
+    .name('fetch')
+    .description('Fetch user')
+    .argument('User ID')
+    .action(async (userId) => {
+    const user = await client.fetch(userId);
+    (0, output_js_1.print)(user);
+});
+exports.userDelete = new commander_1.Command()
+    .name('delete')
+    .description('Delete user')
+    .argument('<userId>', 'User ID')
+    .action(async (userId) => {
+    await client.delete(userId);
+});
+exports.command = new commander_1.Command()
+    .name('user')
+    .description('User tools for ChatBotKit')
+    .addCommand(exports.userList)
+    .addCommand(exports.userFetch)
+    .addCommand(exports.userDelete);
+exports.default = exports.command;

package/dist/cjs/command/api/partner/user/index.d.ts

@@ -0,0 +1,6 @@
+export const userList: Command;
+export const userFetch: Command;
+export const userDelete: Command;
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/cjs/command/api/skillset/index.cjs

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = exports.skillsetDelete = exports.skillsetFetch = exports.skillsetList = void 0;
+const commander_1 = require("commander");
+const index_js_1 = require("@chatbotkit/sdk/skillset/index.js");
+const output_js_1 = require("../../../output.cjs");
+const env_js_1 = require("../../../env.cjs");
+const client = new index_js_1.SkillsetClient({
+    secret: (0, env_js_1.getSECRET)(),
+    runAsUserId: (0, env_js_1.getRUNAS_USERID)(),
+});
+exports.skillsetList = new commander_1.Command()
+    .name('list')
+    .description('List skillsets')
+    .option('-s, --stream', 'Stream skillsets')
+    .action(async (str, options) => {
+    const { stream } = options;
+    if (stream) {
+        for await (const skillset of client.list().stream()) {
+            (0, output_js_1.print)(skillset);
+        }
+    }
+    else {
+        const { items } = await client.list();
+        for (const skillset of items) {
+            (0, output_js_1.print)(skillset);
+        }
+    }
+});
+exports.skillsetFetch = new commander_1.Command()
+    .name('fetch')
+    .description('Fetch skillset')
+    .argument('<skillsetId>', 'Skillset ID')
+    .action(async (skillsetId) => {
+    const skillset = await client.fetch(skillsetId);
+    (0, output_js_1.print)(skillset);
+});
+exports.skillsetDelete = new commander_1.Command()
+    .name('delete')
+    .description('Delete skillset')
+    .argument('<skillsetId>', 'Skillset ID')
+    .action(async (skillsetId) => {
+    await client.delete(skillsetId);
+});
+exports.command = new commander_1.Command()
+    .name('skillset')
+    .description('Skillset tools for ChatBotKit')
+    .addCommand(exports.skillsetList)
+    .addCommand(exports.skillsetFetch)
+    .addCommand(exports.skillsetDelete);
+exports.default = exports.command;

package/dist/cjs/command/api/skillset/index.d.ts

@@ -0,0 +1,6 @@
+export const skillsetList: Command;
+export const skillsetFetch: Command;
+export const skillsetDelete: Command;
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/cjs/command/chat/index.cjs

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
+const tslib_1 = require("tslib");
+const promises_1 = tslib_1.__importDefault(require("readline/promises"));
+const commander_1 = require("commander");
+const index_js_1 = require("@chatbotkit/sdk/conversation/index.js");
+const env_js_1 = require("../../env.cjs");
+const client = new index_js_1.ConversationClient({
+    secret: (0, env_js_1.getSECRET)(),
+    runAsUserId: (0, env_js_1.getRUNAS_USERID)(),
+});
+exports.command = new commander_1.Command()
+    .name('chat')
+    .description('Start a chat session')
+    .addOption(new commander_1.Option('-m, --model <model>', 'Model name').default('gpt-4'))
+    .action(async (_arg, options) => {
+    const rl = promises_1.default.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+    });
+    const messages = [];
+    for (;;) {
+        const user = await rl.question('user: ');
+        messages.push({ type: 'user', text: user });
+        process.stdout.write('bot: ');
+        for await (const { type, data } of client
+            .complete(null, { model: options.model, messages })
+            .stream()) {
+            if (type === 'token') {
+                process.stdout.write(data.token);
+            }
+            else if (type === 'result') {
+                messages.push({ type: 'bot', text: data.text });
+            }
+        }
+        process.stdout.write('\n');
+    }
+});
+exports.default = exports.command;

package/dist/cjs/command/chat/index.d.ts

@@ -0,0 +1,3 @@
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/cjs/env.cjs

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRUNAS_USERID = exports.getSECRET = void 0;
+function getSECRET() {
+    if (!process.env.CHATBOTKIT_API_SECRET) {
+        throw new Error('CHATBOTKIT_API_SECRET is not set');
+    }
+    return process.env.CHATBOTKIT_API_SECRET;
+}
+exports.getSECRET = getSECRET;
+function getRUNAS_USERID() {
+    return process.env.CHATBOTKIT_API_RUNAS_USERID;
+}
+exports.getRUNAS_USERID = getRUNAS_USERID;

package/dist/cjs/env.d.ts

@@ -0,0 +1,2 @@
+export function getSECRET(): string;
+export function getRUNAS_USERID(): string | undefined;

package/dist/cjs/index.cjs

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const commander_1 = require("commander");
+const index_js_1 = tslib_1.__importDefault(require("./command/api/index.cjs"));
+const index_js_2 = tslib_1.__importDefault(require("./command/chat/index.cjs"));
+async function cbk() {
+    const program = new commander_1.Command();
+    program.name('cbk').description('Command line tools for ChatBotKit');
+    program.addCommand(index_js_1.default);
+    program.addCommand(index_js_2.default);
+    program.parse();
+}
+exports.default = cbk;

package/dist/cjs/index.d.ts

@@ -0,0 +1 @@
+export default function cbk(): Promise<void>;

package/dist/cjs/output.cjs

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printError = exports.print = exports.config = void 0;
+const tslib_1 = require("tslib");
+const util_1 = tslib_1.__importDefault(require("util"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+exports.config = {
+    output: 'yaml',
+};
+function print(input) {
+    switch (true) {
+        case exports.config.output === 'yaml': {
+            console.log(js_yaml_1.default.dump(input, { noRefs: true }));
+            console.log('# ---');
+            break;
+        }
+        case exports.config.output === 'json': {
+            console.log(util_1.default.inspect(input, { depth: Infinity, colors: true }));
+            break;
+        }
+        case exports.config.output === 'jsonl': {
+            console.log(JSON.stringify(input));
+            break;
+        }
+        default: {
+            throw new Error(`Unknown output format: ${exports.config.output}`);
+        }
+    }
+}
+exports.print = print;
+function printError(error) {
+    console.error(error);
+}
+exports.printError = printError;

package/dist/cjs/output.d.ts

@@ -0,0 +1,5 @@
+export function print(input: any): void;
+export function printError(error: any): void;
+export namespace config {
+    let output: 'yaml' | 'json' | 'jsonl';
+}

package/dist/esm/command/api/conversation/index.d.ts

@@ -0,0 +1,6 @@
+export const conversationList: Command;
+export const conversationFetch: Command;
+export const conversationDelete: Command;
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/esm/command/api/conversation/index.js

@@ -0,0 +1,50 @@
+import { Command } from 'commander';
+import { ConversationClient } from '@chatbotkit/sdk/conversation/index.js';
+import message from './message/index.js';
+import { print } from '../../../output.js';
+import { getSECRET, getRUNAS_USERID } from '../../../env.js';
+const client = new ConversationClient({
+    secret: getSECRET(),
+    runAsUserId: getRUNAS_USERID(),
+});
+export const conversationList = new Command()
+    .name('list')
+    .description('List conversations')
+    .option('-s, --stream', 'Stream conversations')
+    .action(async (str, options) => {
+    const { stream } = options;
+    if (stream) {
+        for await (const conversation of client.list().stream()) {
+            print(conversation);
+        }
+    }
+    else {
+        const { items } = await client.list();
+        for (const conversation of items) {
+            print(conversation);
+        }
+    }
+});
+export const conversationFetch = new Command()
+    .name('fetch')
+    .description('Fetch conversation')
+    .argument('<conversationId>', 'Conversation ID')
+    .action(async (conversationId) => {
+    const conversation = await client.fetch(conversationId);
+    print(conversation);
+});
+export const conversationDelete = new Command()
+    .name('delete')
+    .description('Delete conversation')
+    .argument('<conversationId>', 'Conversation ID')
+    .action(async (conversationId) => {
+    await client.delete(conversationId);
+});
+export const command = new Command()
+    .name('conversation')
+    .description('Conversation tools for ChatBotKit')
+    .addCommand(conversationList)
+    .addCommand(conversationFetch)
+    .addCommand(conversationDelete)
+    .addCommand(message);
+export default command;

package/dist/esm/command/api/conversation/message/index.d.ts

@@ -0,0 +1,6 @@
+export const messageList: Command;
+export const messageFetch: Command;
+export const messageDelete: Command;
+export const command: Command;
+export default command;
+import { Command } from 'commander';

package/dist/esm/command/api/conversation/message/index.js

@@ -0,0 +1,51 @@
+import { Command } from 'commander';
+import { ConversationMessageClient } from '@chatbotkit/sdk/conversation/message/index.js';
+import { print } from '../../../../output.js';
+import { getSECRET, getRUNAS_USERID } from '../../../../env.js';
+const client = new ConversationMessageClient({
+    secret: getSECRET(),
+    runAsUserId: getRUNAS_USERID(),
+});
+export const messageList = new Command()
+    .name('list')
+    .description('List messages')
+    .option('-s, --stream', 'Stream messages')
+    .argument('<conversationId>', 'Conversation ID')
+    .action(async (conversationId, options) => {
+    const { stream } = options;
+    if (stream) {
+        for await (const message of client.list(conversationId).stream()) {
+            print(message);
+        }
+    }
+    else {
+        const { items } = await client.list(conversationId);
+        for (const message of items) {
+            print(message);
+        }
+    }
+});
+export const messageFetch = new Command()
+    .name('fetch')
+    .description('Fetch message')
+    .argument('<conversationId>', 'Conversation ID')
+    .argument('<messageId>', 'Message ID')
+    .action(async (conversationId, messageId) => {
+    const message = await client.fetch(conversationId, messageId);
+    print(message);
+});
+export const messageDelete = new Command()
+    .name('delete')
+    .description('Delete message')
+    .argument('<conversationId>', 'Conversation ID')
+    .argument('<messageId>', 'Message ID')
+    .action(async (conversationId, messageId) => {
+    await client.delete(conversationId, messageId);
+});
+export const command = new Command()
+    .name('message')
+    .description('Message tools for ChatBotKit')
+    .addCommand(messageList)
+    .addCommand(messageFetch)
+    .addCommand(messageDelete);
+export default command;

package/dist/esm/command/api/dataset/index.d.ts

@@ -0,0 +1,6 @@
+export const datasetList: Command;
+export const datasetFetch: Command;
+export const datasetDelete: Command;
+export const command: Command;
+export default command;
+import { Command } from 'commander';