@botonic/nx-plugin 2.23.0

package/src/generators/bot-app/schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "BotApp",
+  "title": "Create a Botonic bot application",
+  "description": "Create a Botonic bot application with webchat, webviews, and lambda support.",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "The name of the bot application.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the bot application?",
+      "pattern": "^[a-zA-Z].*$"
+    },
+    "directory": {
+      "type": "string",
+      "description": "The directory of the new application.",
+      "alias": "dir"
+    },
+    "packageManager": {
+      "type": "string",
+      "description": "The package manager to use.",
+      "enum": ["npm", "pnpm"],
+      "default": "pnpm"
+    },
+    "botonicVersion": {
+      "type": "string",
+      "description": "Botonic packages version. Leave empty to use the same version as the installed @botonic/nx-plugin."
+    }
+  },
+  "required": ["name"]
+}

package/src/generators/bot-app-migrations/migrate-fix-css-code-split/generator.d.ts

@@ -0,0 +1,5 @@
+import type { Tree } from '@nx/devkit';
+export interface MigrateFixCssCodeSplitSchema {
+    project: string;
+}
+export default function migrateFixCssCodeSplitGenerator(tree: Tree, options: MigrateFixCssCodeSplitSchema): Promise<void>;

package/src/generators/bot-app-migrations/migrate-fix-css-code-split/generator.js

@@ -0,0 +1,92 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var generator_exports = {};
+__export(generator_exports, {
+  default: () => migrateFixCssCodeSplitGenerator
+});
+module.exports = __toCommonJS(generator_exports);
+var import_devkit = require("@nx/devkit");
+var import_migration_utils = require("../../../migrations/utils/migration-utils");
+const MODULE_DIR = __dirname;
+const WEBCHAT_CONFIG = "vite/webchat.config.ts";
+const WEBVIEWS_CONFIG = "vite/webviews.config.ts";
+function addCssCodeSplit(content) {
+  if (content.includes("cssCodeSplit")) {
+    return content;
+  }
+  return content.replace(
+    /(reportCompressedSize:\s*true,)\s*\n(\s+)(commonjsOptions)/,
+    "$1\n$2cssCodeSplit: false,\n$2$3"
+  );
+}
+function processConfigFile(content, filePath) {
+  if (content.includes("cssCodeSplit")) {
+    return { transformed: false, newContent: content };
+  }
+  if (!content.includes("reportCompressedSize:")) {
+    return { transformed: false, newContent: content };
+  }
+  const newContent = addCssCodeSplit(content);
+  if (newContent === content) {
+    return { transformed: false, newContent: content };
+  }
+  return {
+    transformed: true,
+    newContent,
+    logMessage: `${filePath} updated with cssCodeSplit: false`
+  };
+}
+async function migrateFixCssCodeSplitGenerator(tree, options) {
+  const projectPath = options.project.startsWith("apps/") ? options.project : `apps/${options.project}`;
+  const targetVersion = (0, import_migration_utils.getPluginVersion)(MODULE_DIR);
+  import_devkit.logger.info(
+    `\u{1F504} Adding cssCodeSplit: false to ${options.project} vite configs...`
+  );
+  const fileProcessor = (0, import_migration_utils.createFileProcessor)([
+    {
+      filePath: (p) => `${p}/${WEBCHAT_CONFIG}`,
+      shouldProcess: (t, filePath) => {
+        if (!t.exists(filePath)) return false;
+        const content = t.read(filePath, "utf-8");
+        return !!content && !content.includes("cssCodeSplit");
+      },
+      processFile: (_t, filePath, content) => processConfigFile(content, filePath)
+    },
+    {
+      filePath: (p) => `${p}/${WEBVIEWS_CONFIG}`,
+      shouldProcess: (t, filePath) => {
+        if (!t.exists(filePath)) return false;
+        const content = t.read(filePath, "utf-8");
+        return !!content && !content.includes("cssCodeSplit");
+      },
+      processFile: (_t, filePath, content) => processConfigFile(content, filePath)
+    }
+  ]);
+  const result = await fileProcessor(tree, projectPath, targetVersion);
+  if (result.transformed) {
+    (0, import_migration_utils.updateBotonicDependencies)(tree, targetVersion, projectPath);
+    import_devkit.logger.info(
+      `\u2705 ${options.project} vite configs updated with cssCodeSplit: false`
+    );
+    import_devkit.logger.info(`   See migrate-fix-css-code-split.md for verification steps`);
+  } else {
+    import_devkit.logger.info(`\u2139\uFE0F  ${options.project} already up to date \u2013 skipping`);
+  }
+  await (0, import_devkit.formatFiles)(tree);
+}

package/src/generators/bot-app-migrations/migrate-fix-css-code-split/schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "MigrateFixCssCodeSplit",
+  "title": "Add cssCodeSplit: false to vite configs",
+  "description": "Adds cssCodeSplit: false to vite webchat and webviews configs to prevent split CSS missing from index.html",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The bot project to migrate",
+      "$default": { "$source": "argv", "index": 0 }
+    }
+  },
+  "required": ["project"]
+}

package/src/generators/bot-app-migrations/migrate-pnpm-compat/generator.d.ts

@@ -0,0 +1,5 @@
+import type { Tree } from '@nx/devkit';
+export interface MigratePnpmCompatSchema {
+    project: string;
+}
+export default function migratePnpmCompatGenerator(tree: Tree, options: MigratePnpmCompatSchema): Promise<void>;

package/src/generators/bot-app-migrations/migrate-pnpm-compat/generator.js

@@ -0,0 +1,97 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var generator_exports = {};
+__export(generator_exports, {
+  default: () => migratePnpmCompatGenerator
+});
+module.exports = __toCommonJS(generator_exports);
+var import_devkit = require("@nx/devkit");
+var import_migration_utils = require("../../../migrations/utils/migration-utils");
+const MODULE_DIR = __dirname;
+const ESLINTRC_FILE = ".eslintrc.json";
+const README_FILE = "README.md";
+function addNodeModulesIgnore(content) {
+  if (content.includes("**/node_modules/**")) {
+    return { transformed: false, newContent: content };
+  }
+  try {
+    const json = JSON.parse(content);
+    const patterns = json.ignorePatterns || [];
+    const insertIdx = patterns.indexOf("!**/*");
+    patterns.splice(insertIdx + 1, 0, "**/node_modules/**");
+    json.ignorePatterns = patterns;
+    return {
+      transformed: true,
+      newContent: JSON.stringify(json, null, 2),
+      logMessage: `${ESLINTRC_FILE} updated with **/node_modules/** ignorePattern`
+    };
+  } catch {
+    return { transformed: false, newContent: content };
+  }
+}
+function migrateReadmeNpmToPnpm(content) {
+  if (!/(?<![p])npm run\b/.test(content) && !/(?<![p])npm install\b/.test(content)) {
+    return { transformed: false, newContent: content };
+  }
+  let result = content;
+  result = result.replace(/\bnpm run\b/g, "pnpm run");
+  result = result.replace(/\bnpm install\b/g, "pnpm install");
+  if (result === content) {
+    return { transformed: false, newContent: content };
+  }
+  return {
+    transformed: true,
+    newContent: result,
+    logMessage: `${README_FILE} updated npm references to pnpm`
+  };
+}
+async function migratePnpmCompatGenerator(tree, options) {
+  const projectPath = options.project.startsWith("apps/") ? options.project : `apps/${options.project}`;
+  const targetVersion = (0, import_migration_utils.getPluginVersion)(MODULE_DIR);
+  import_devkit.logger.info(`\u{1F504} Migrating ${options.project} for pnpm compatibility...`);
+  const fileProcessor = (0, import_migration_utils.createFileProcessor)([
+    {
+      filePath: (p) => `${p}/${ESLINTRC_FILE}`,
+      shouldProcess: (t, filePath) => {
+        if (!t.exists(filePath)) return false;
+        const content = t.read(filePath, "utf-8");
+        return !!content && !content.includes("**/node_modules/**");
+      },
+      processFile: (_t, _filePath, content) => addNodeModulesIgnore(content)
+    },
+    {
+      filePath: (p) => `${p}/${README_FILE}`,
+      shouldProcess: (t, filePath) => {
+        if (!t.exists(filePath)) return false;
+        const content = t.read(filePath, "utf-8");
+        return !!content && (/(?<![p])npm run\b/.test(content) || /(?<![p])npm install\b/.test(content));
+      },
+      processFile: (_t, _filePath, content) => migrateReadmeNpmToPnpm(content)
+    }
+  ]);
+  const result = await fileProcessor(tree, projectPath, targetVersion);
+  if (result.transformed) {
+    (0, import_migration_utils.updateBotonicDependencies)(tree, targetVersion, projectPath);
+    import_devkit.logger.info(`\u2705 ${options.project} updated for pnpm compatibility`);
+    import_devkit.logger.info(`   See migrate-pnpm-compat.md for verification steps`);
+  } else {
+    import_devkit.logger.info(`\u2139\uFE0F  ${options.project} already up to date \u2013 skipping`);
+  }
+  await (0, import_devkit.formatFiles)(tree);
+}

package/src/generators/bot-app-migrations/migrate-pnpm-compat/schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "MigratePnpmCompat",
+  "title": "Migrate bot app for pnpm compatibility",
+  "description": "Add **/node_modules/** to eslint ignorePatterns and update README npm references to pnpm",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The bot project to migrate",
+      "$default": { "$source": "argv", "index": 0 }
+    }
+  },
+  "required": ["project"]
+}

package/src/generators/bot-app-migrations/migrate-webchat-trigger/generator.d.ts

@@ -0,0 +1,5 @@
+import type { Tree } from '@nx/devkit';
+export interface MigrateWebchatTriggerSchema {
+    project: string;
+}
+export default function migrateWebchatTriggerGenerator(tree: Tree, options: MigrateWebchatTriggerSchema): Promise<void>;

package/src/generators/bot-app-migrations/migrate-webchat-trigger/generator.js

@@ -0,0 +1,165 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var generator_exports = {};
+__export(generator_exports, {
+  default: () => migrateWebchatTriggerGenerator
+});
+module.exports = __toCommonJS(generator_exports);
+var import_devkit = require("@nx/devkit");
+var import_migration_utils = require("../../../migrations/utils/migration-utils");
+const MODULE_DIR = __dirname;
+const WEBCHAT_FILE = "src/client/webchat/index.tsx";
+const REMOVED_SYMBOLS = /* @__PURE__ */ new Set([
+  "WebchatTrigger",
+  "WebchatProvider",
+  "WebchatContainer",
+  "WebchatHeader",
+  "WebchatInput",
+  "WebchatMessages",
+  "useWebchatContext"
+]);
+function rewriteImports(content) {
+  const triggerImports = "import type { WebchatTriggerProps } from '@botonic/webchat-react/trigger'\nimport { WebchatTrigger } from '@botonic/webchat-react/trigger'";
+  const mainImportRegex = /import\s*\{([^}]*)\}\s*from\s*['"]@botonic\/webchat-react['"]\s*;?\s*\n?/g;
+  return content.replace(mainImportRegex, (_, inner) => {
+    const symbols = inner.split(",").map(
+      (s) => s.trim().replace(/\s+as\s+\w+$/, "").split(":")[0].trim()
+    ).filter((s) => s && !REMOVED_SYMBOLS.has(s));
+    if (symbols.length === 0) {
+      return triggerImports + "\n";
+    }
+    return `import { ${symbols.join(", ")} } from '@botonic/webchat-react'
+${triggerImports}
+`;
+  });
+}
+function removeWebchatAppComponent(content) {
+  const webchatAppRegex = /function\s+WebchatApp\s*\([\s\S]*?\)\s*\{[\s\S]*?\}(?=\s*\n\s*(?:function|const)\s+(?:App|renderWebchat)\b)/m;
+  return content.replace(webchatAppRegex, "");
+}
+function replaceWebchatProviderWithTrigger(content) {
+  const hasCoverComponents = /COVER_COMPONENTS/.test(content);
+  const coverRegistryLine = hasCoverComponents ? "        coverRegistry: COVER_COMPONENTS,\n" : "";
+  const webchatTriggerBlock = `<WebchatTrigger
+      appId={webchatConfig.appId}
+      position='bottom-right'
+      onReady={handleReady}
+      webchatConfig={{
+        avatarConfig,
+        customMessages,
+${coverRegistryLine}        title: options.title || 'Demo Bot',
+        placeholder: options.placeholder || 'Message...',
+      }}
+    />`;
+  const providerRegex = /<WebchatProvider\s[^>]*>[\s\S]*?<\/WebchatProvider>/g;
+  let result = content;
+  const match = result.match(providerRegex);
+  if (match) {
+    for (const m of match) {
+      result = result.replace(m, webchatTriggerBlock);
+    }
+  }
+  return result;
+}
+function addHandleReady(content) {
+  if (content.includes("handleReady")) {
+    return content;
+  }
+  const handleReadySnippet = `  // Handle webchat ready \u2013 full control over when/how to open
+  const handleReady = React.useCallback<
+    NonNullable<WebchatTriggerProps['onReady']>
+  >(controller => {
+    controller.open()
+  }, [])
+
+  `;
+  const returnWithProvider = content.match(
+    /(\s+)(return\s*\(\s*\n\s*)<WebchatProvider/
+  );
+  if (returnWithProvider) {
+    return content.replace(
+      returnWithProvider[0],
+      returnWithProvider[1] + handleReadySnippet + returnWithProvider[2] + "<WebchatProvider"
+    );
+  }
+  const appReturnRegex = /(function App\s*\([\s\S]*?\)\s*\{[\s\S]*?)(return \()/m;
+  return content.replace(appReturnRegex, `$1${handleReadySnippet}$2`);
+}
+function updateWindowBotonicType(content) {
+  if (content.includes("ready: Promise<void>")) {
+    return content;
+  }
+  const readySnippet = `
+      // Ready state
+      ready: Promise<void>
+      isReady: () => boolean`;
+  return content.replace(
+    /(render:\s*\([\s\S]*?\)\s*=>\s*void)(\s*\n)/,
+    `$1${readySnippet}$2`
+  );
+}
+function processWebchatFile(content) {
+  if (!content.includes("WebchatTrigger") || content.includes("from '@botonic/webchat-react/trigger'")) {
+    return { transformed: false, newContent: content };
+  }
+  if (!content.includes("WebchatProvider")) {
+    return { transformed: false, newContent: content };
+  }
+  let result = content;
+  result = rewriteImports(result);
+  result = removeWebchatAppComponent(result);
+  result = addHandleReady(result);
+  result = replaceWebchatProviderWithTrigger(result);
+  result = updateWindowBotonicType(result);
+  if (result === content) {
+    return { transformed: false, newContent: content };
+  }
+  return {
+    transformed: true,
+    newContent: result,
+    logMessage: `${WEBCHAT_FILE} migrated to lazy-loading WebchatTrigger`
+  };
+}
+async function migrateWebchatTriggerGenerator(tree, options) {
+  const projectPath = options.project.startsWith("apps/") ? options.project : `apps/${options.project}`;
+  const targetVersion = (0, import_migration_utils.getPluginVersion)(MODULE_DIR);
+  import_devkit.logger.info(
+    `\u{1F504} Migrating ${options.project} to lazy-loading WebchatTrigger...`
+  );
+  const fileProcessor = (0, import_migration_utils.createFileProcessor)([
+    {
+      filePath: (p) => `${p}/${WEBCHAT_FILE}`,
+      shouldProcess: (t, filePath) => {
+        if (!t.exists(filePath)) return false;
+        const content = t.read(filePath, "utf-8");
+        return !!content && content.includes("WebchatTrigger") && !content.includes("from '@botonic/webchat-react/trigger'") && content.includes("WebchatProvider");
+      },
+      processFile: (_t, _filePath, content) => processWebchatFile(content)
+    }
+  ]);
+  const result = await fileProcessor(tree, projectPath, targetVersion);
+  if (result.transformed) {
+    (0, import_migration_utils.updateBotonicDependencies)(tree, targetVersion, projectPath);
+    import_devkit.logger.info(`\u2705 ${options.project} migrated to lazy-loading WebchatTrigger`);
+    import_devkit.logger.info(`   See migrate-webchat-trigger.md for verification steps`);
+  } else {
+    import_devkit.logger.info(`\u2139\uFE0F  ${options.project} already up to date \u2013 skipping`);
+  }
+  await (0, import_devkit.formatFiles)(tree);
+}

package/src/generators/bot-app-migrations/migrate-webchat-trigger/schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "http://json-schema.org/schema",
+  "$id": "MigrateWebchatTrigger",
+  "title": "Migrate WebchatTrigger to lazy-loading entry point",
+  "description": "Migrates a bot app to use @botonic/webchat-react/trigger lazy-loading entry point",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The bot project to migrate",
+      "$default": { "$source": "argv", "index": 0 }
+    }
+  },
+  "required": ["project"]
+}

package/src/generators/custom-message/files/__name__-output.ts.template

@@ -0,0 +1,21 @@
+import { BotContext } from '@botonic/core'
+import { MessageType } from '@botonic/shared'
+
+import { CUSTOM_MESSAGE_TYPES } from '../../../shared/constants'
+
+export async function <%= propertyName %>Output({ sendMessage }: BotContext) {
+  await sendMessage({
+    type: MessageType.Custom,
+    data: {
+      name: CUSTOM_MESSAGE_TYPES.<%= constantName %>,
+      props: {
+        // Add your custom props here
+        // Example: title: 'Hello from <%= className %>!'
+      },
+    },
+  })
+  return {
+    status: 200,
+    response: 'OK',
+  }
+}

package/src/generators/custom-message/files/__name__.spec.tsx.template

@@ -0,0 +1,27 @@
+import { render, screen } from '@testing-library/react'
+import React from 'react'
+
+import { <%= className %> } from './<%= fileName %>'
+
+describe('<%= className %>', () => {
+  it('should render successfully', () => {
+    render(<<%= className %> />)
+    expect(screen.getByText('<%= className %> Component')).toBeInTheDocument()
+  })
+
+  it('should render children when provided', () => {
+    const childText = 'Test child content'
+    render(<<%= className %>>{childText}</<%= className %>>)
+    expect(screen.getByText(childText)).toBeInTheDocument()
+  })
+
+  it('should apply custom props', () => {
+    const customProps = {
+      // Add test for your custom props here
+      // Example: title: 'Custom Title'
+    }
+    render(<<%= className %> {...customProps} />)
+    // Add assertions for your custom props
+    expect(screen.getByText('<%= className %> Component')).toBeInTheDocument()
+  })
+})

package/src/generators/custom-message/files/__name__.tsx.template

@@ -0,0 +1,18 @@
+import { Message } from '@botonic/webchat-react'
+import React from 'react'
+
+export interface <%= className %>Props {
+  // Add your custom props here
+  children?: React.ReactNode
+}
+
+export const <%= className %>: React.FC<<%= className %>Props> = (props: any) => {
+  return (
+    <Message>
+      <div>
+        <p><%= className %> — customize this component</p>
+        {props.children}
+      </div>
+    </Message>
+  )
+}

package/src/generators/custom-message/generator.d.ts

@@ -0,0 +1,4 @@
+import { Tree } from '@nx/devkit';
+import type { CustomMessageGeneratorSchema } from './schema';
+export default function (tree: Tree, options: CustomMessageGeneratorSchema): Promise<void>;
+export { CustomMessageGeneratorSchema };