@botpress/cli 0.0.9 → 0.0.10

package/templates/echo-bot/src/index.ts

@@ -0,0 +1,44 @@
+import type { Client } from '@botpress/client'
+import { Bot, messages } from '@botpress/sdk'
+import type { z } from 'zod'
+// import * as botpress from '.botpress' /** uncomment to get generated code */
+
+type DefaultMessages = typeof messages.defaults
+type DefaultMessageType = keyof DefaultMessages
+type DefaultMessagePayload<T extends DefaultMessageType> = z.infer<DefaultMessages[T]['schema']>
+
+type CreateMessageProps = Parameters<Client['createMessage']>[0]
+type CreateMessageBody<T extends DefaultMessageType> = Omit<CreateMessageProps, 'type' | 'payload'> & {
+  type: T
+  payload: DefaultMessagePayload<T>
+}
+
+const logger = console
+
+const bot = new Bot({
+  integrations: [],
+  configuration: {
+    schema: {},
+  },
+  states: {},
+  events: {},
+  recurringEvents: {},
+})
+
+bot.message('', async ({ message, client, ctx }) => {
+  logger.info('Received message', message)
+
+  await client.createMessage({
+    conversationId: message.conversationId,
+    userId: ctx.botId,
+    tags: {},
+    type: 'text',
+    payload: {
+      text: `You said: ${message.payload.text}`,
+    },
+  } satisfies CreateMessageBody<'text'>)
+
+  logger.info('text message sent')
+})
+
+export default bot

package/templates/echo-bot/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "@tsconfig/node18-strictest/tsconfig.json",
+  "compilerOptions": {
+    "target": "es2017",
+    "baseUrl": ".",
+    "outDir": "dist",
+    "checkJs": false,
+    "incremental": true,
+    "exactOptionalPropertyTypes": false,
+    "resolveJsonModule": true,
+    "noPropertyAccessFromIndexSignature": false,
+    "noUnusedLocals": false
+  },
+  "include": [".botpress/**/*", "src/**/*", "./*.ts", "./*.json"]
+}

package/templates/empty-integration/.botpress/implementation/actions/index.ts

@@ -0,0 +1,7 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+
+export type Actions = {
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/audio.ts

@@ -0,0 +1,10 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Audio {
+  audioUrl: string;
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/card.ts

@@ -0,0 +1,17 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Card {
+  title: string;
+  subtitle?: string;
+  imageUrl?: string;
+  actions: {
+    action: "postback" | "url" | "say";
+    label: string;
+    value: string;
+  }[];
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/carousel.ts

@@ -0,0 +1,19 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Carousel {
+  items: {
+    title: string;
+    subtitle?: string;
+    imageUrl?: string;
+    actions: {
+      action: "postback" | "url" | "say";
+      label: string;
+      value: string;
+    }[];
+  }[];
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/choice.ts

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Choice {
+  text: string;
+  options: {
+    label: string;
+    value: string;
+  }[];
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/dropdown.ts

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Dropdown {
+  text: string;
+  options: {
+    label: string;
+    value: string;
+  }[];
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/file.ts

@@ -0,0 +1,11 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface File {
+  fileUrl: string;
+  title?: string;
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/image.ts

@@ -0,0 +1,10 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Image {
+  imageUrl: string;
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/index.ts

@@ -0,0 +1,40 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import type * as text from "./text";
+export * as text from "./text";
+import type * as markdown from "./markdown";
+export * as markdown from "./markdown";
+import type * as image from "./image";
+export * as image from "./image";
+import type * as audio from "./audio";
+export * as audio from "./audio";
+import type * as video from "./video";
+export * as video from "./video";
+import type * as file from "./file";
+export * as file from "./file";
+import type * as location from "./location";
+export * as location from "./location";
+import type * as carousel from "./carousel";
+export * as carousel from "./carousel";
+import type * as card from "./card";
+export * as card from "./card";
+import type * as dropdown from "./dropdown";
+export * as dropdown from "./dropdown";
+import type * as choice from "./choice";
+export * as choice from "./choice";
+
+export type ChannelChannel = {
+  text: text.Text;
+  markdown: markdown.Markdown;
+  image: image.Image;
+  audio: audio.Audio;
+  video: video.Video;
+  file: file.File;
+  location: location.Location;
+  carousel: carousel.Carousel;
+  card: card.Card;
+  dropdown: dropdown.Dropdown;
+  choice: choice.Choice;
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/location.ts

@@ -0,0 +1,11 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Location {
+  latitude: number;
+  longitude: number;
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/markdown.ts

@@ -0,0 +1,10 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Markdown {
+  markdown: string;
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/text.ts

@@ -0,0 +1,10 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Text {
+  text: string;
+}

package/templates/empty-integration/.botpress/implementation/channels/channel/video.ts

@@ -0,0 +1,10 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Video {
+  videoUrl: string;
+}

package/templates/empty-integration/.botpress/implementation/channels/index.ts

@@ -0,0 +1,10 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import type * as channel from "./channel/index";
+export * as channel from "./channel/index";
+
+export type Channels = {
+  channel: channel.ChannelChannel;
+}

package/templates/empty-integration/.botpress/implementation/configuration.ts

@@ -0,0 +1,10 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+
+export interface Configuration {
+  [k: string]: unknown;
+}

package/templates/empty-integration/.botpress/implementation/events/index.ts

@@ -0,0 +1,7 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+
+export type Events = {
+}

package/templates/empty-integration/.botpress/implementation/index.ts

@@ -0,0 +1,17 @@
+/* tslint:disable */
+// This file is generated
+// Do not edit this file
+
+import { Integration } from "@botpress/sdk";
+
+import type * as configuration from "./configuration";
+import type * as actions from "./actions/index";
+import type * as channels from "./channels/index";
+import type * as events from "./events/index";
+export * as configuration from "./configuration";
+export * as actions from "./actions/index";
+export * as channels from "./channels/index";
+export * as events from "./events/index";
+
+export class IntegrationEmpty
+      extends Integration<configuration.Configuration, actions.Actions, channels.Channels, events.Events> {}

package/templates/empty-integration/.botpress/index.ts

@@ -0,0 +1 @@
+export * from './implementation'

package/templates/empty-integration/.botpress/project.cache.json

@@ -0,0 +1 @@
+{}

package/templates/empty-integration/integration.definition.ts

@@ -0,0 +1,13 @@
+import { IntegrationDefinition, messages } from '@botpress/sdk'
+import { version } from './package.json'
+
+export default new IntegrationDefinition({
+  name: 'empty',
+  version,
+  public: true,
+  channels: {
+    channel: {
+      messages: { ...messages.defaults },
+    },
+  },
+})

package/templates/empty-integration/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@botpresshub/empty-integration",
+  "version": "0.1.0",
+  "description": "Integration with no content",
+  "scripts": {
+    "type-check": "tsc --noEmit"
+  },
+  "keywords": [],
+  "private": true,
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@botpress/client": "0.0.10",
+    "@botpress/sdk": "0.0.8",
+    "zod": "^3.20.6"
+  },
+  "devDependencies": {
+    "@types/node": "^18.11.17",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.4"
+  }
+}

package/templates/empty-integration/readme.md

@@ -0,0 +1,5 @@
+# Empty Integration
+
+## Description
+
+Integration with no content.

package/templates/empty-integration/src/index.ts

@@ -0,0 +1,58 @@
+import * as botpress from '.botpress'
+
+const logger = console
+logger.info('starting integration')
+
+class NotImplementedError extends Error {
+  constructor() {
+    super('Not implemented')
+  }
+}
+
+export default new botpress.IntegrationEmpty({
+  register: async () => {},
+  unregister: async () => {},
+  actions: {},
+  channels: {
+    channel: {
+      messages: {
+        text: async () => {
+          throw new NotImplementedError()
+        },
+        image: async () => {
+          throw new NotImplementedError()
+        },
+        markdown: async () => {
+          throw new NotImplementedError()
+        },
+        audio: async () => {
+          throw new NotImplementedError()
+        },
+        video: async () => {
+          throw new NotImplementedError()
+        },
+        file: async () => {
+          throw new NotImplementedError()
+        },
+        location: async () => {
+          throw new NotImplementedError()
+        },
+        carousel: async () => {
+          throw new NotImplementedError()
+        },
+        card: async () => {
+          throw new NotImplementedError()
+        },
+        choice: async () => {
+          throw new NotImplementedError()
+        },
+        dropdown: async () => {
+          throw new NotImplementedError()
+        },
+      },
+    },
+  },
+  handler: async () => {
+    throw new NotImplementedError()
+  },
+})

package/templates/empty-integration/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "extends": "@tsconfig/node18-strictest/tsconfig.json",
+  "compilerOptions": {
+    "target": "es2017",
+    "baseUrl": ".",
+    "outDir": "dist",
+    "checkJs": false,
+    "incremental": true,
+    "exactOptionalPropertyTypes": false,
+    "resolveJsonModule": true,
+    "noPropertyAccessFromIndexSignature": false,
+    "noUnusedLocals": false
+  },
+  "include": [".botpress/**/*", "src/**/*", "./*.ts", "./*.json"]
+}

package/.ignore.me.github/index.ts

@@ -1,38 +0,0 @@
-import fs from 'fs'
-import pathlib from 'path'
-import { Octokit } from 'octokit'
-import { Logger } from '../src/logger'
-import { GithubFetcher } from '../src/github-fetch'
-
-const maybeExit = (exit: boolean) => {
-  if (exit) {
-    process.exit(0)
-  }
-}
-
-const SSH_URI = 'ssh://github.com/botpress/openbook-cli.git'
-const GIT_SSH_URI = 'git@github.com:botpress/openbook-cli.git'
-const HTTPS_URI = 'https://github.com/botpress/openbook-cli.git'
-const HTTPS_GITHUB_URI = 'https://github.com/botpress/skynet/tree/master'
-
-const githubAuth = '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'
-
-const main = async () => {
-  const logger = new Logger({ verbose: true })
-  const parsedUri = new GithubFetcher(logger)._parseUri(HTTPS_GITHUB_URI)
-
-  const octokit = new Octokit({ auth: githubAuth })
-
-  const { data: content } = await octokit.rest.repos.getContent({ ...parsedUri })
-
-  logger.json(content)
-  // const {
-  //   data: { content: blob },
-  // } = await octokit.rest.git.getBlob({
-  //   ...parsedUri,
-  //   file_sha: content,
-  // })
-
-  maybeExit(true)
-}
-void main()

package/dist/github-download.js

@@ -1,159 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var github_download_exports = {};
-__export(github_download_exports, {
-  GithubDownloader: () => GithubDownloader
-});
-module.exports = __toCommonJS(github_download_exports);
-var import_fs = __toESM(require("fs"));
-var import_git_url_parse = __toESM(require("git-url-parse"));
-var import_octokit = require("octokit");
-var import_path = __toESM(require("path"));
-const GITHUB_HOST = "github.com";
-const DEFAULT_REF = "HEAD";
-const GIT_URI = /^(?:git|ssh|https?|git@[-\w.]+):(\/\/)?(.*?)(\.git)(\/?|\#[-\d\w._]+?)$/;
-const GITHUB_TREE_URI = /^^https:\/\/(.*?)(\.com)\/.*$/;
-class GithubDownloader {
-  constructor(_logger) {
-    this._logger = _logger;
-  }
-  async listFiles(props) {
-    const parsedUri = this._parseUri(props.srcUri);
-    const { path: _, ...repoUri } = parsedUri;
-    const octo = new import_octokit.Octokit({ auth: props.githubAuth });
-    const files = await this._listFiles({
-      octo,
-      srcUri: parsedUri,
-      recursive: props.recursive
-    });
-    return files.map((f) => ({
-      uri: this._formatUri({ ...repoUri, path: f.path }),
-      name: f.name,
-      type: f.type
-    }));
-  }
-  async downloadFiles(props) {
-    const { destDir, srcUri } = props;
-    const dirExists = import_fs.default.existsSync(destDir);
-    if (dirExists) {
-      throw new Error(`Directory ${destDir} already exists`);
-    }
-    const parsedUri = this._parseUri(srcUri);
-    const octo = new import_octokit.Octokit({ auth: props.githubAuth });
-    await this._downloadFiles({
-      octo,
-      srcUri: parsedUri,
-      destDir,
-      allowedExtensions: props.allowedExtensions
-    });
-  }
-  async _downloadFiles(props) {
-    const { octo, srcUri, destDir, allowedExtensions } = props;
-    const files = await this._listFiles(props);
-    this._logger.debug(`Downloading ${files.length} files from ${srcUri.path} to ${destDir}`);
-    await import_fs.default.promises.mkdir(destDir);
-    for (const file of files) {
-      if (file.type === "dir") {
-        const subDir = import_path.default.join(destDir, file.name);
-        await this._downloadFiles({
-          octo,
-          srcUri: { ...srcUri, path: [srcUri.path, file.name].join("/") },
-          destDir: subDir
-        });
-        continue;
-      }
-      const fileExt = import_path.default.extname(file.name);
-      if (allowedExtensions && !allowedExtensions.includes(fileExt)) {
-        this._logger.debug(`Skipping file ${file.name} because it is not an allowed file type`);
-        continue;
-      }
-      const { data: blob } = await octo.rest.git.getBlob({
-        ...srcUri,
-        file_sha: file.sha
-      });
-      const filePath = import_path.default.join(destDir, file.name);
-      const content = Buffer.from(blob.content, "base64");
-      await import_fs.default.promises.writeFile(filePath, content);
-    }
-  }
-  async _listFiles(props) {
-    const { octo, srcUri, recursive } = props;
-    const { data } = await octo.rest.repos.getContent({
-      ...srcUri
-    });
-    let allFiles;
-    if (!Array.isArray(data)) {
-      allFiles = [data];
-    } else {
-      allFiles = data;
-    }
-    let supportedFiles = allFiles.filter((f) => f.type === "dir" || f.type === "file");
-    if (!recursive) {
-      return supportedFiles;
-    }
-    for (const dir of allFiles.filter((f) => f.type === "dir")) {
-      const subFiles = await this._listFiles({
-        ...props,
-        srcUri: {
-          ...srcUri,
-          path: [srcUri.path, dir.name].join("/")
-        }
-      });
-      supportedFiles = [...supportedFiles, ...subFiles];
-    }
-    return supportedFiles;
-  }
-  _formatUri(uri) {
-    if (uri.protocol === "ssh") {
-      return `git@${GITHUB_HOST}:${uri.owner}/${uri.repo}.git`;
-    }
-    return `https://${GITHUB_HOST}/${uri.owner}/${uri.repo}/tree/${uri.ref}/${uri.path}`;
-  }
-  _parseUri(uri) {
-    const isGit = this._isGitUri(uri);
-    if (!isGit) {
-      throw new Error("URI is not a valid git repository URI");
-    }
-    const parsed = (0, import_git_url_parse.default)(uri);
-    if (parsed.resource !== GITHUB_HOST) {
-      throw new Error(`Unsupported git host: ${parsed.resource}`);
-    }
-    if (parsed.protocol !== "ssh" && parsed.protocol !== "https") {
-      throw new Error(`Unsupported git protocol: ${parsed.protocol}}`);
-    }
-    return {
-      protocol: parsed.protocol,
-      owner: parsed.owner,
-      repo: parsed.name,
-      ref: parsed.ref ? parsed.ref : DEFAULT_REF,
-      path: parsed.filepath
-    };
-  }
-  _isGitUri = (uri) => GITHUB_TREE_URI.test(uri) || GIT_URI.test(uri);
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  GithubDownloader
-});