@botonic/nx-plugin 2.30.0 → 2.31.0

package/src/lib/credentials-handler.js

@@ -18,7 +18,7 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var credentials_handler_exports = {};
 __export(credentials_handler_exports, {
-  BotCredentialsHandler: () => BotCredentialsHandler,
+  BotsRegistryHandler: () => BotsRegistryHandler,
   CredentialsHandler: () => CredentialsHandler,
   GlobalCredentialsHandler: () => GlobalCredentialsHandler
 });
@@ -58,13 +58,13 @@ class CredentialsHandler {
 class GlobalCredentialsHandler extends CredentialsHandler {
   /**
    * @param baseDir - Optional directory for credentials (e.g. monorepo_root/.botonic).
-   * When provided, credentials are stored at baseDir/credentials.json (source of truth in monorepo).
+   * When provided, credentials are stored at baseDir/env-credentials.json.
    * When omitted, uses ~/.botonic (user home).
    */
   constructor(baseDir) {
     super({
       homeDir: baseDir ? (0, import_path.resolve)(baseDir) : (0, import_path.join)((0, import_file_system.getHomeDirectory)(), import_constants.BOTONIC_HOME_DIRNAME),
-      filename: import_constants.GLOBAL_CREDS_FILENAME
+      filename: import_constants.ENV_CREDENTIALS_FILENAME
     });
   }
   initialize() {
@@ -79,37 +79,55 @@ class GlobalCredentialsHandler extends CredentialsHandler {
     return this.dumpJSON(obj);
   }
 }
-class BaseBotCredentialsHandler extends CredentialsHandler {
-  constructor(args) {
+class BotsRegistryHandler extends CredentialsHandler {
+  constructor() {
     super({
-      homeDir: args.homeDir,
-      filename: args.filename
+      homeDir: (0, import_path.join)((0, import_file_system.getHomeDirectory)(), import_constants.BOTONIC_HOME_DIRNAME),
+      filename: import_constants.BOTS_REGISTRY_FILENAME
     });
   }
   load() {
-    const json = this.loadJSON();
-    if (!json) return void 0;
-    return json;
+    try {
+      if (!(0, import_file_system.pathExists)(this.pathToCredentials)) return {};
+      const result = (0, import_file_system.readJSON)(this.pathToCredentials);
+      return result && !Array.isArray(result) ? result : {};
+    } catch {
+      console.warn("bots.json could not be loaded");
+      return {};
+    }
   }
-  dump(obj) {
-    return this.dumpJSON(obj);
+  dump(registry) {
+    try {
+      (0, import_file_system.writeJSON)(this.pathToCredentials, registry);
+    } catch {
+      console.warn("bots.json could not be written");
+    }
   }
-}
-class BotCredentialsHandler extends BaseBotCredentialsHandler {
-  /**
-   * @param projectRoot - Directory for app/project .botonic.json (e.g. apps/my-bot).
-   * When omitted, uses process.cwd() (may write to repo root when Nx cwd is workspace root).
-   */
-  constructor(projectRoot) {
-    super({
-      homeDir: projectRoot ? (0, import_path.resolve)(projectRoot) : import_constants.BOTONIC_PROJECT_PATH,
-      filename: import_constants.BOT_CREDENTIALS_FILENAME
-    });
+  upsert(env, entry) {
+    try {
+      const registry = this.load();
+      const list = registry[env] ?? [];
+      const idx = list.findIndex((e) => e.id === entry.id);
+      if (idx !== -1) {
+        list[idx] = entry;
+      } else {
+        list.push(entry);
+      }
+      registry[env] = list;
+      this.dump(registry);
+    } catch {
+      console.warn("bots.json could not be updated");
+    }
+  }
+  findLatestForEnv(env) {
+    const registry = this.load();
+    const list = registry[env] ?? [];
+    return list.length > 0 ? list[list.length - 1] : void 0;
   }
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  BotCredentialsHandler,
+  BotsRegistryHandler,
   CredentialsHandler,
   GlobalCredentialsHandler
 });

package/src/lib/interfaces.d.ts

@@ -24,23 +24,20 @@ export interface EnvironmentCredentials {
 }
 /** Store: one entry per environment so multiple envs can be logged in. */
 export type GlobalCredentialsStore = Record<string, EnvironmentCredentials>;
+export interface ProviderAccountEntry {
+    id: string;
+    provider: string;
+    is_test: boolean;
+    is_active: boolean;
+}
 export interface BotDetail {
     id: string;
     name: string;
-    organization: string;
-    last_update: any;
-    created_at: string;
-    provider_accounts: any[];
-    is_debug: boolean;
-    is_published: boolean;
-    active_users: number;
-}
-export interface BotCredentials {
-    bot: BotDetail | null;
-}
-export interface LocalRuntimeBotCredentials {
-    localRuntimeBot: BotDetail | null;
+    providers?: ProviderAccountEntry[];
+    [key: string]: unknown;
 }
+export type BotRegistryEntry = BotDetail;
+export type BotsRegistry = Record<string, BotRegistryEntry[]>;
 export type JSONPrimitive = string | number | boolean | null;
 export type JSONValue = JSONPrimitive | JSONObject | JSONArray;
 export type JSONObject = {

package/src/lib/util/executor-helpers.d.ts

@@ -1,6 +1,5 @@
 import type { ExecutorContext } from '@nx/devkit';
 import { BotonicAPIService } from '../api-service';
-import type { BotDetail } from '../interfaces';
 export declare function resolveProjectPath(context: ExecutorContext): string;
 export declare function askEmailPassword(): Promise<{
     email: string;
@@ -15,7 +14,7 @@ export declare function handleAuthentication(botonicApiService: BotonicAPIServic
  */
 export declare function logWorkingAsAndEnvironment(botonicApiService: BotonicAPIService): Promise<void>;
 export declare function getAvailableBots(botonicApiService: BotonicAPIService): Promise<any[]>;
-export declare function createNewBotWithName(botonicApiService: BotonicAPIService, botName: string): Promise<void>;
+export declare function createNewBotWithName(botonicApiService: BotonicAPIService, botName: string, isTest?: boolean): Promise<void>;
 export declare function getAppIdFromEnvFile(projectRoot: string, appIdKey: string): string | null;
 /**
  * Reads VITE_HUBTYPE_APP_ID from .env.[configuration] (e.g. .env.dev) or .env.local when configuration is 'local'.
@@ -53,24 +52,14 @@ export declare function resolveHubtypeEnvironment(context: ExecutorContext, opti
 };
 /**
  * Ensures the user is logged in to Hubtype before starting the tunnel flow.
- * Run this before Lambda + cloudflared + deploy_local_runtime so the login prompt happens first.
  */
-export declare function ensureHubtypeLoginBeforeTunnel(context: ExecutorContext, projectRoot: string, options?: PerformDeployLocalRuntimeOptions): Promise<void>;
+export declare function ensureHubtypeLoginBeforeTunnel(context: ExecutorContext, projectRoot: string, options?: DeployDevSessionOptions): Promise<void>;
 /**
- * Ensures a local runtime bot is selected or created and persisted to .botonic.json.
- * Call this after ensureHubtypeLoginBeforeTunnel and before starting the tunnel, so bot detection runs after login but before tunnel setup.
- * Does not log "Working as..." (already logged by ensureHubtypeLoginBeforeTunnel).
+ * Ensures a bot is set: reuses one from bots.json registry, or prompts to select an existing
+ * deployed bot or create a new one. The selected bot must be deployed with botonic_v2 strategy before
+ * dev session registration will succeed — the user is informed of this requirement.
  */
-export declare function ensureLocalRuntimeBotBeforeTunnel(context: ExecutorContext, projectRoot: string, options?: PerformDeployLocalRuntimeOptions): Promise<void>;
-/**
- * Writes the local runtime bot to .botonic.json in the app folder so the created bot is persisted per project.
- */
-export declare function writeLocalRuntimeBotToAppFolder(projectRoot: string, bot: BotDetail): void;
-/**
- * Removes the app folder .botonic.json so the next run will prompt to create/select a new bot (e.g. after 404 when bot was deleted).
- */
-export declare function removeAppBotonicJson(projectRoot: string): void;
-export declare function ensureLocalRuntimeBot(botonicApiService: BotonicAPIService): Promise<void>;
+export declare function ensureBot(botonicApiService: BotonicAPIService): Promise<void>;
 export type ProviderAccountListItem = {
     id: string;
     provider?: string;
@@ -78,26 +67,66 @@ export type ProviderAccountListItem = {
     is_active?: boolean;
 };
 /**
- * APP_ID for local runtime must be the webchat test provider — not WhatsApp
+ * Returns the imp_id of the first active real (non-test) webchat PA on the bot.
+ * Used by serve to auto-write VITE_HUBTYPE_APP_ID so the local widget connects.
+ */
+export declare function getActiveWebchatProviderAppId(results: ProviderAccountListItem[] | undefined): string | undefined;
+/**
+ * APP_ID for the dev session must be the webchat test provider — not WhatsApp
  * or other channels, which may also be test+active on the same bot.
  */
 export declare function getActiveTestWebchatProviderAppId(results: ProviderAccountListItem[] | undefined): string | undefined;
-export interface PerformDeployLocalRuntimeOptions {
+export interface DeployDevSessionOptions {
     email?: string;
     password?: string;
     env?: Record<string, unknown>;
     /** Explicit configuration name (e.g. 'dev') so deploy uses the right environment when Nx does not merge config. */
     configuration?: string;
+    /** E.164 phone number to register for WhatsApp local routing (e.g. +34612345678). */
+    whatsappPhone?: string;
+    /** Bot id pre-selected by selectBotForServe — skips ensureBot lookup so the correct bot is used. */
+    selectedBotId?: string;
 }
-export interface PerformDeployLocalRuntimeResult {
+export interface DeployDevSessionResult {
     botId: string;
+    apiUrl: string;
+    accessToken: string;
+    refreshToken: string;
+    clientId: string;
     targetEnvironment: string;
     environmentVariables: Record<string, unknown>;
+    lambdaFunctionName: string | undefined;
+    teardownWebchat: () => Promise<void>;
 }
 /**
- * Performs deploy_local_runtime with the given endpoint (e.g. tunnel URL).
- * Handles auth, bot creation/selection, and deploy. Returns the bot id and env for later cleanup (e.g. deleteBot on shutdown).
+ * Registers a dev session with the given tunnel endpoint.
+ * Handles auth, bot creation/selection, and registration. Returns the bot id and env.
  * Used by serve-bot (tunnel is always on).
  */
-export declare function performDeployLocalRuntimeWithEndpoint(context: ExecutorContext, projectRoot: string, endpoint: string, options?: PerformDeployLocalRuntimeOptions): Promise<PerformDeployLocalRuntimeResult>;
+export declare function performDeployLocalRuntimeWithEndpoint(context: ExecutorContext, projectRoot: string, endpoint: string, options?: DeployDevSessionOptions): Promise<DeployDevSessionResult>;
+/**
+ * Always prompts the user to select or create a bot for local development.
+ * Pre-selects the previously used bot (from registry). When botName is provided,
+ * skips the prompt entirely. For newly created bots, auto-deploys before returning
+ * so the serve flow can proceed without manual intervention.
+ *
+ * Must be called before tunnel startup so that auto-deploys don't waste tunnel
+ * resources and the selected bot is saved to the registry for
+ * performDeployLocalRuntimeWithEndpoint to load.
+ */
+export declare function selectBotForServe(context: ExecutorContext, projectRoot: string, options?: DeployDevSessionOptions & {
+    botName?: string;
+}): Promise<string | undefined>;
+export declare function isBotDeployedRestartRequired(error: unknown): boolean;
+/**
+ * Returns true if the currently selected bot (last entry in bots.json for the
+ * given env) has an active WhatsApp provider. Used by the serve executor to
+ * decide whether to enable the WhatsApp dev panel.
+ */
+export declare function selectedBotHasActiveWhatsapp(botId: string): boolean;
+/**
+ * Builds the bot and deploys it to Hubtype Cloud. Shared by the deploy executor
+ * and the serve executor's auto-deploy path for newly created bots.
+ */
+export declare function deployBotToHubtype(botonicApiService: BotonicAPIService, projectRoot: string, projectName: string): Promise<void>;
 export {};