@botonic/nx-plugin 2.29.0 → 2.31.0

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,40 +52,81 @@ 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>;
+export declare function ensureBot(botonicApiService: BotonicAPIService): Promise<void>;
+export type ProviderAccountListItem = {
+    id: string;
+    provider?: string;
+    is_test?: boolean;
+    is_active?: boolean;
+};
 /**
- * Writes the local runtime bot to .botonic.json in the app folder so the created bot is persisted per project.
+ * 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 writeLocalRuntimeBotToAppFolder(projectRoot: string, bot: BotDetail): void;
+export declare function getActiveWebchatProviderAppId(results: ProviderAccountListItem[] | undefined): string | undefined;
 /**
- * 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).
+ * 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 removeAppBotonicJson(projectRoot: string): void;
-export declare function ensureLocalRuntimeBot(botonicApiService: BotonicAPIService): Promise<void>;
-export interface PerformDeployLocalRuntimeOptions {
+export declare function getActiveTestWebchatProviderAppId(results: ProviderAccountListItem[] | undefined): string | undefined;
+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 {};