@ecodrix/erix-api 1.2.7 → 1.2.9

package/src/cli.ts

@@ -1,305 +0,0 @@
-import repl from "node:repl";
-import { Command } from "commander";
-import dotenv from "dotenv";
-import pc from "picocolors";
-import { Ecodrix } from "./core";
-
-// Setup environment
-dotenv.config();
-
-// Build-time constants injected by tsup
-declare const process: any;
-const VERSION = process.env.SDK_VERSION || "1.0.2";
-const NAME = process.env.SDK_NAME || "@ecodrix/erix-api";
-const DESCRIPTION = process.env.SDK_DESCRIPTION || "Official ECODrIx SDK CLI";
-
-const program = new Command();
-
-program.name("erix").description(DESCRIPTION).version(VERSION);
-
-/**
- * Helper to initialize the Ecodrix client from environment or flags.
- */
-function getClient(options: any): Ecodrix {
-  const apiKey = options.key || process.env.ECOD_API_KEY;
-  const clientCode = options.client || process.env.ECOD_CLIENT_CODE;
-
-  if (!apiKey) {
-    console.error(pc.red("Error: API Key is missing."));
-    console.log(pc.yellow("Set ECOD_API_KEY environment variable or use --key <key>"));
-    process.exit(1);
-  }
-
-  return new Ecodrix({
-    apiKey,
-    clientCode,
-    baseUrl: options.baseUrl || process.env.ECOD_BASE_URL,
-  });
-}
-
-program
-  .option("-k, --key <key>", "ECODrIx API Key")
-  .option("-c, --client <code...", "Tenant Client Code")
-  .option("--base-url <url>", "API Base URL override");
-
-// --- WHOAMI ---
-program
-  .command("whoami")
-  .description("Verify current authentication and tenant status")
-  .action(async (options, command) => {
-    const globalOptions = command.parent.opts();
-    const ecod = getClient(globalOptions);
-
-    console.log(pc.cyan("Checking connection to ECODrIx Platform..."));
-    try {
-      const me = (await ecod.request("GET", "/api/saas/me/profile")) as any;
-      console.log(pc.green("✔ Authenticated successfully!"));
-      console.log(`${pc.bold("User ID:")} ${me.id}`);
-      console.log(`${pc.bold("Organisation:")} ${me.organisation?.name || "N/A"}`);
-      if (globalOptions.client) {
-        console.log(`${pc.bold("Tenant Code:")} ${pc.magenta(globalOptions.client)}`);
-      }
-    } catch (error: any) {
-      console.error(pc.red("✖ Authentication failed"));
-      console.error(pc.dim(error.message));
-      process.exit(1);
-    }
-  });
-
-// --- WHATSAPP ---
-const whatsapp = program.command("whatsapp").description("WhatsApp Business API operations");
-
-whatsapp
-  .command("send-template")
-  .description("Send a WhatsApp template message")
-  .argument("<phone>", "Recipient phone number")
-  .argument("<template>", "Template name")
-  .option("-v, --vars <json>", "Template variables as JSON string", "[]")
-  .action(async (phone, template, options, command) => {
-    const globalOptions = command.parent.parent.opts();
-    const ecod = getClient(globalOptions);
-
-    try {
-      const vars = JSON.parse(options.vars);
-      console.log(pc.cyan(`Sending template '${template}' to ${phone}...`));
-
-      const result = (await ecod.whatsapp.messages.sendTemplate({
-        to: phone,
-        templateName: template,
-        language: "en_US",
-        variables: vars,
-      })) as any;
-
-      console.log(pc.green("✔ Message sent successfully!"));
-      console.log(pc.dim(`ID: ${result?.id || "N/A"}`));
-    } catch (error: any) {
-      console.error(pc.red("✖ Failed to send message"));
-      console.error(pc.dim(error.message));
-    }
-  });
-
-// --- CRM ---
-const crm = program.command("crm").description("CRM and Lead management");
-
-crm
-  .command("leads")
-  .description("List recent leads")
-  .option("-l, --limit <number>", "Number of leads to fetch", "10")
-  .option("-s, --status <status>", "Filter by lead status")
-  .option("-p, --pipeline <id>", "Filter by pipeline ID")
-  .option("-q, --search <query>", "Search by name or email")
-  .action(async (options, command) => {
-    const globalOptions = command.parent.parent.opts();
-    const ecod = getClient(globalOptions);
-
-    try {
-      const limit = Number.parseInt(options.limit);
-      console.log(pc.cyan(`Fetching last ${limit} leads...`));
-
-      const queryParams: any = { limit };
-      if (options.status) queryParams.status = options.status;
-      if (options.pipeline) queryParams.pipelineId = options.pipeline;
-      if (options.search) queryParams.search = options.search;
-
-      const response: any = await ecod.crm.leads.list(queryParams);
-      const leads = Array.isArray(response.data)
-        ? response.data
-        : Array.isArray(response)
-          ? response
-          : [];
-
-      if (leads.length === 0) {
-        console.log(pc.yellow("No leads found."));
-        return;
-      }
-
-      console.table(
-        leads.map((l: any) => ({
-          ID: l.id || l._id,
-          Name: `${l.firstName} ${l.lastName || ""}`.trim(),
-          Phone: l.phone,
-          Status: l.status,
-          Score: l.score || 0,
-          Created: new Date(l.createdAt).toLocaleDateString(),
-        })),
-      );
-    } catch (error: any) {
-      console.error(pc.red("✖ Failed to fetch leads"));
-      console.error(pc.dim(error.message));
-    }
-  });
-
-crm
-  .command("pipelines")
-  .description("List all CRM pipelines")
-  .action(async (options, command) => {
-    const globalOptions = command.parent.parent.opts();
-    const ecod = getClient(globalOptions);
-
-    try {
-      console.log(pc.cyan("Fetching pipelines..."));
-      const response: any = await ecod.crm.pipelines.list();
-      const pipelines = response.data || response || [];
-
-      if (pipelines.length === 0) {
-        console.log(pc.yellow("No pipelines found."));
-        return;
-      }
-
-      console.table(
-        pipelines.map((p: any) => ({
-          ID: p.id || p._id,
-          Name: p.name,
-          Default: p.isDefault ? "Yes" : "No",
-          Stages: p.stages?.length || 0,
-        })),
-      );
-    } catch (error: any) {
-      console.error(pc.red("✖ Failed to fetch pipelines"));
-      console.error(pc.dim(error.message));
-    }
-  });
-
-// --- ANALYTICS ---
-const analytics = program.command("analytics").description("Business Intelligence Analytics");
-
-analytics
-  .command("overview")
-  .description("Get high-level CRM KPIs")
-  .option("-r, --range <range>", "Date range (e.g., 24h, 7d, 30d, 365d)", "30d")
-  .action(async (options, command) => {
-    const globalOptions = command.parent.parent.opts();
-    const ecod = getClient(globalOptions);
-
-    try {
-      console.log(pc.cyan(`Fetching overview metrics for last ${options.range}...`));
-      const response: any = await ecod.crm.analytics.overview({ range: options.range });
-      const data = response.data || response;
-
-      console.log(`\n${pc.bold("OVERVIEW KPIs:")}`);
-      console.log(`Total Leads:  ${pc.green(data.totalLeads || 0)}`);
-      console.log(`Open Value:   ${pc.yellow(`$${(data.openValue || 0).toLocaleString()}`)}`);
-      console.log(`Won Revenue:  ${pc.green(`$${(data.wonRevenue || 0).toLocaleString()}`)}`);
-      console.log(`Avg Score:    ${pc.blue(data.avgScore?.toFixed(1) || 0)}`);
-      console.log(`Conversion:   ${pc.magenta(`${(data.conversionRate || 0).toFixed(2)}%`)}\n`);
-    } catch (error: any) {
-      console.error(pc.red("✖ Failed to fetch analytics overview"));
-      console.error(pc.dim(error.message));
-    }
-  });
-
-// --- WEBHOOKS ---
-const webhooks = program.command("webhooks").description("Webhook utility tools");
-
-webhooks
-  .command("verify")
-  .description("Verify a cryptographic webhook signature")
-  .argument("<payload>", "The raw request body string")
-  .argument("<signature>", "The 'x-ecodrix-signature' header value")
-  .argument("<secret>", "Your webhook signing secret")
-  .action(async (payload, signature, secret, options, command) => {
-    const globalOptions = command.parent.parent.opts();
-    const ecod = getClient(globalOptions);
-
-    try {
-      await ecod.webhooks.constructEvent(payload, signature, secret);
-      console.log(pc.green("✔ Signature is VALID"));
-    } catch (error: any) {
-      console.error(pc.red("✖ Error during verification"));
-      console.error(pc.dim(error.message));
-    }
-  });
-
-// --- SHELL (REPL) ---
-program
-  .command("shell")
-  .alias("repl")
-  .description("Start an interactive SDK shell")
-  .action(async (options, command) => {
-    const globalOptions = command.parent.opts();
-    const ecod = getClient(globalOptions);
-
-    console.log(pc.magenta(pc.bold("\nWelcome to the Erix Interactive Shell")));
-    console.log(pc.dim(`SDK Version: ${VERSION}`));
-    console.log(pc.dim("The 'ecod' client is pre-initialized and ready.\n"));
-
-    const r = repl.start({
-      prompt: pc.cyan("erix > "),
-      useColors: true,
-    });
-
-    // Load resources into REPL context for immediate access
-    r.context.ecod = ecod;
-    r.context.whatsapp = ecod.whatsapp;
-    r.context.crm = ecod.crm;
-    r.context.meet = ecod.meet;
-    r.context.media = ecod.media;
-
-    r.on("exit", () => {
-      console.log(pc.yellow("\nGoodbye!"));
-      process.exit(0);
-    });
-  });
-
-// --- COMPLETION ---
-program
-  .command("completion")
-  .description("Generate Bash auto-completion script")
-  .action(() => {
-    const script = `
-# Erix Bash Completion
-_erix_completions() {
-    local cur opts
-    COMPREPLY=()
-    cur="\${COMP_WORDS[COMP_CWORD]}"
-    opts="whoami whatsapp crm analytics webhooks shell completion"
-
-    if [[ \${COMP_CWORD} -eq 1 ]] ; then
-        COMPREPLY=( $(compgen -W "\${opts}" -- \${cur}) )
-        return 0
-    fi
-    
-    # Simple sub-command completion
-    case "\${COMP_WORDS[1]}" in
-        whatsapp)
-            COMPREPLY=( $(compgen -W "send-template" -- \${cur}) )
-            ;;
-        crm)
-            COMPREPLY=( $(compgen -W "leads pipelines" -- \${cur}) )
-            ;;
-        analytics)
-            COMPREPLY=( $(compgen -W "overview" -- \${cur}) )
-            ;;
-        webhooks)
-            COMPREPLY=( $(compgen -W "verify" -- \${cur}) )
-            ;;
-    esac
-}
-complete -F _erix_completions erix
-`;
-    console.log(script.trim());
-    console.error(pc.yellow('\n# To enable, run: eval "$(erix completion)"'));
-    console.error(pc.dim("# Or add it to your ~/.bashrc: erix completion >> ~/.bashrc"));
-  });
-
-program.parse();

package/src/core.ts

@@ -1,359 +0,0 @@
-import axios, { type AxiosInstance, type Method } from "axios";
-import axiosRetry from "axios-retry";
-import { type Socket, io } from "socket.io-client";
-import { APIError, AuthenticationError } from "./error";
-import { CRM } from "./resources/crm";
-import { Email } from "./resources/email";
-import { EventsResource } from "./resources/events";
-import { Health } from "./resources/health";
-import { Logs } from "./resources/logs";
-import { Marketing } from "./resources/marketing";
-import { Media } from "./resources/media";
-import { Meetings } from "./resources/meet";
-import { Notifications } from "./resources/notifications";
-import { Queue } from "./resources/queue";
-import { Storage } from "./resources/storage";
-import { Webhooks } from "./resources/webhooks";
-import { WhatsApp } from "./resources/whatsapp";
-
-declare const process: any;
-
-/** @internal The canonical ECODrIx backend URL — not exposed to SDK consumers. */
-const ECOD_API_BASE = "https://api.ecodrix.com";
-
-/**
- * Configuration options for the Ecodrix client.
- *
- * Minimum required: `apiKey` and `clientCode`.
- * The backend URL is managed internally and should not need to be changed.
- */
-export interface EcodrixOptions {
-  /**
-   * Your ECODrIx Platform API key.
-   * Obtain this from the ECODrIx dashboard under Settings → API Keys.
-   * @example "ecod_live_sk_..."
-   */
-  apiKey: string;
-
-  /**
-   * Your tenant ID (Client Code).
-   * This scopes all API requests to your specific organisation.
-   * @example "ERIX_CLNT_JHBJHF"
-   */
-  clientCode?: string;
-
-  /**
-   * @internal Override Socket.io URL for testing/staging.
-   * Not documented — internal use only.
-   */
-  socketUrl?: string;
-
-  /**
-   * @internal Override the backend API URL. Used by the CLI and internal tests only.
-   * Host projects must never set this — the production URL is hardcoded internally.
-   */
-  baseUrl?: string;
-}
-
-/**
- * The primary entry point for the ECODrIx SDK.
- *
- * Initialise once with your credentials and use the namespaced resources
- * to interact with every part of the platform.
- *
- * @example
- * ```typescript
- * import { Ecodrix } from "@ecodrix/erix-api";
- *
- * const ecod = new Ecodrix({
- *   apiKey: process.env.ECOD_API_KEY!,
- *   clientCode: "ERIX_CLNT_JHBJHF",
- * });
- *
- * await ecod.whatsapp.messages.send({ to: "+91...", text: "Hello!" });
- * const lead = await ecod.crm.leads.create({ firstName: "Alice", phone: "+91..." });
- * ```
- */
-export class Ecodrix {
-  /**
-   * @internal Axios HTTP client for making API requests.
-   */
-  private readonly client: AxiosInstance;
-  /**
-   * @internal Socket.io client for real-time events.
-   */
-  private readonly socket: Socket;
-
-  /**
-   * The tenant client code this SDK instance is scoped to.
-   * Useful for components that need to read the clientCode back
-   * from a context-provided SDK instance.
-   */
-  public readonly clientCode: string | undefined;
-
-  /** WhatsApp messaging and conversation management. */
-  public readonly whatsapp: WhatsApp;
-
-  /** CRM resources — Leads and related sub-resources. */
-  public readonly crm: CRM;
-
-  /** Cloudflare R2-backed media storage. */
-  public readonly media: Media;
-
-  /** Google Meet appointment scheduling. */
-  public readonly meet: Meetings;
-
-  /** Automation execution logs and provider webhook callbacks. */
-  public readonly notifications: Notifications;
-
-  /** Outbound email marketing engine and template management. */
-  public readonly email: Email;
-
-  /** Platform-wide execution logs and audit trails. */
-  public readonly logs: Logs;
-
-  /** Lead events and workflow automation triggers. */
-  public readonly events: EventsResource;
-
-  /** Cryptographic webhook signature verification. */
-  public readonly webhooks: Webhooks;
-
-  /** Tenant Cloud Storage mapping. */
-  public readonly storage: Storage;
-
-  /** Email and SMS Marketing Campaigns. */
-  public readonly marketing: Marketing;
-
-  /** Platform and tenant health diagnostics. */
-  public readonly health: Health;
-
-  /** Background job queue management. */
-  public readonly queue: Queue;
-
-  constructor(options: EcodrixOptions) {
-    if (!options.apiKey) {
-      throw new AuthenticationError("API Key is required");
-    }
-
-    this.clientCode = options.clientCode?.toUpperCase();
-
-    // @internal: options.baseUrl is available for CLI/test use only.
-    // Host projects hardcode to prod — they never set baseUrl.
-    const baseUrl = options.baseUrl ?? ECOD_API_BASE;
-    const socketUrl = options.socketUrl || baseUrl;
-
-    const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
-    const runtime = isBrowser
-      ? "browser"
-      : typeof process !== "undefined"
-        ? `node ${process.version}`
-        : "unknown";
-    const os = isBrowser
-      ? globalThis.navigator?.userAgent || "browser"
-      : typeof process !== "undefined"
-        ? process.platform
-        : "unknown";
-
-    this.client = axios.create({
-      baseURL: baseUrl,
-      headers: {
-        "x-api-key": options.apiKey,
-        "x-client-code": options.clientCode?.toUpperCase(),
-        "Content-Type": "application/json",
-        "x-ecodrix-client-agent": JSON.stringify({
-          sdk_version: "1.0.0", // Can be auto-injected during build in future
-          runtime,
-          os,
-        }),
-      },
-    });
-
-    // Make the client completely bulletproof for execution from external projects.
-    // It will automatically handle network blips, 502 Bad Gateways, and 429 Rate Limits.
-    axiosRetry(this.client, {
-      retries: 3,
-      retryDelay: axiosRetry.exponentialDelay,
-      retryCondition: (error) => {
-        return (
-          axiosRetry.isNetworkOrIdempotentRequestError(error) || error.response?.status === 429
-        );
-      },
-      onRetry: (retryCount, error, requestConfig) => {
-        const isDev = typeof process !== "undefined" && process.env?.NODE_ENV === "development";
-        if (isDev) {
-          console.warn(
-            `[ECODrIx SDK] Retrying request (${retryCount}/3): ${requestConfig.method?.toUpperCase()} ${requestConfig.url}. Reason: ${error.message}`,
-          );
-        }
-      },
-    });
-
-    // Initialise resources
-    this.whatsapp = new WhatsApp(this.client);
-    this.crm = new CRM(this.client);
-    this.media = new Media(this.client);
-    this.meet = new Meetings(this.client);
-    this.notifications = new Notifications(this.client);
-    this.email = new Email(this.client);
-    this.logs = new Logs(this.client);
-    this.events = new EventsResource(this.client);
-    this.webhooks = new Webhooks();
-    this.storage = new Storage(this.client);
-    this.marketing = new Marketing(this.client);
-    this.health = new Health(this.client);
-    this.queue = new Queue(this.client);
-
-    // Establish persistent Socket.io connection
-    this.socket = io(socketUrl, {
-      extraHeaders: {
-        "x-api-key": options.apiKey,
-        "x-client-code": options.clientCode?.toUpperCase() || "",
-      },
-    });
-
-    this.setupSocket(options.clientCode);
-
-    // ─── Wappalyzer & Technology Detection ─────────────────────────────────────
-    if (isBrowser) {
-      const footprint = {
-        version: "1.2.2",
-        clientCode: options.clientCode,
-        initializedAt: new Date().toISOString(),
-      };
-      // Standard identifying global
-      (window as any).__ECODRIX_SDK__ = footprint;
-      // Ergonomic access for developers (as attempted by the user)
-      if (!(window as any).ecodrix) {
-        (window as any).ecodrix = this;
-      }
-    }
-  }
-
-  /**
-   * Join a specific real-time room (e.g., a conversation or a lead).
-   *
-   * @param roomId - The unique identifier for the room.
-   */
-  public joinRoom(roomId: string) {
-    this.socket.emit("join-room", roomId);
-  }
-
-  /**
-   * Leave a previously joined real-time room.
-   *
-   * @param roomId - The unique identifier for the room.
-   */
-  public leaveRoom(roomId: string) {
-    this.socket.emit("leave-room", roomId);
-  }
-
-  private setupSocket(clientCode?: string) {
-    this.socket.on("connect", () => {
-      if (clientCode) {
-        // Join the tenant-scoped room to receive only relevant events.
-        this.socket.emit("join-room", clientCode.toUpperCase());
-      }
-    });
-  }
-
-  /**
-   * Subscribe to a real-time event emitted by the ECODrIx platform.
-   *
-   * The SDK maintains a persistent Socket.io connection. Events are
-   * scoped to your `clientCode` — you will only receive events for
-   * your own tenant.
-   *
-   * **Standard events:**
-   * - `new_message` — inbound WhatsApp message (includes conversation and message payload)
-   * - `message_sent` — outbound message successfully sent
-   * - `message_status_update` — WhatsApp message status change (delivered, read, failed)
-   * - `conversation_updated` — metadata change (unread count, last message, status)
-   * - `message_updated` — real-time updates for reactions or media processing
-   * - `notification:new` — new system or CRM notification
-   * - `workflow-run-update` — automation execution progress
-   * - `meet.scheduled` — Google Meet appointment booked
-   *
-   * @param event - The event name to subscribe to.
-   * @param callback - The handler function invoked when the event fires.
-   * @returns `this` for method chaining.
-   *
-   * @example
-   * ```typescript
-   * ecod
-   *   .on("whatsapp.message_received", (msg) => console.log(msg.body))
-   *   .on("automation.failed", (err) => alertTeam(err));
-   * ```
-   */
-  public on(event: string, callback: (...args: any[]) => void): this {
-    this.socket.on(event, callback);
-    return this;
-  }
-
-  /**
-   * Gracefully disconnect the real-time Socket.io connection.
-   * Call this when shutting down your server or when the client is
-   * no longer needed to free up resources.
-   *
-   * @example
-   * ```typescript
-   * process.on("SIGTERM", () => ecod.disconnect());
-   * ```
-   */
-  public disconnect() {
-    this.socket.disconnect();
-  }
-
-  /**
-   * Remove a previously registered event listener.
-   * Always call this in cleanup (e.g. React `useEffect` return) to prevent
-   * memory leaks and duplicate handlers after reconnections.
-   *
-   * @param event - The event name to unsubscribe from.
-   * @param callback - The exact handler reference passed to `.on()`.
-   * @returns `this` for method chaining.
-   */
-  public off(event: string, callback: (...args: any[]) => void): this {
-    this.socket.off(event, callback);
-    return this;
-  }
-
-  /**
-   * Raw Execution Escape-Hatch.
-   * Send an authenticated HTTP request directly to the ECODrIx backend from ANY external project.
-   *
-   * This is extremely powerful giving you full unrestricted access to make calls
-   * against new, experimental, or completely custom backend APIs while still benefitting
-   * from the SDK's built-in authentication and automatic `axios-retry` logic.
-   *
-   * @example
-   * ```typescript
-   * const { data } = await ecod.request("POST", "/api/saas/experimental-feature", { flag: true });
-   * console.log(data);
-   * ```
-   */
-  public async request<T = any>(
-    method: Method,
-    path: string,
-    data?: any,
-    params?: any,
-  ): Promise<T> {
-    try {
-      const response = await this.client.request<T>({
-        method,
-        url: path,
-        data,
-        params,
-      });
-      return response.data;
-    } catch (error: any) {
-      if (error.response) {
-        throw new APIError(
-          error.response.data?.message || error.response.data?.error || "Raw Execution Failed",
-          error.response.status,
-          error.response.data?.code,
-        );
-      }
-      throw new APIError(error.message || "Network Error");
-    }
-  }
-}