@elizaos/plugin-elizacloud 2.0.0-beta.1 → 2.0.3-beta.3

package/registry-entry.json

@@ -0,0 +1,208 @@
+{
+  "id": "elizacloud",
+  "name": "Elizacloud",
+  "description": "elizaOS plugin to connect with elizaOS Cloud services",
+  "npmName": "@elizaos/plugin-elizacloud",
+  "version": "2.0.0-beta.0",
+  "source": "bundled",
+  "tags": ["elizacloud"],
+  "config": {
+    "ELIZAOS_CLOUD_API_KEY": {
+      "type": "secret",
+      "required": true,
+      "sensitive": true,
+      "label": "Cloud Api Key",
+      "help": "API key used to authenticate requests to ElizaOS Cloud API (format: eliza_xxxxx). Get it from https://www.elizacloud.ai/dashboard/api-keys",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_BASE_URL": {
+      "type": "url",
+      "required": false,
+      "sensitive": false,
+      "default": "https://www.elizacloud.ai/api/v1",
+      "label": "Cloud Base Url",
+      "help": "Base URL for all ElizaOS Cloud API requests.",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_SMALL_MODEL": {
+      "type": "string",
+      "required": false,
+      "sensitive": false,
+      "default": "openai/gpt-oss-120b:nitro",
+      "label": "Cloud Small Model",
+      "help": "Small/fast model for quick tasks (overrides SMALL_MODEL). Default: openai/gpt-oss-120b:nitro",
+      "placeholder": "openai/gpt-oss-120b:nitro",
+      "advanced": false
+    },
+    "SMALL_MODEL": {
+      "type": "string",
+      "required": false,
+      "sensitive": false,
+      "default": "openai/gpt-oss-120b:nitro",
+      "label": "Model",
+      "help": "Fallback identifier for the small language model if ELIZAOS_CLOUD_SMALL_MODEL is not set.",
+      "placeholder": "openai/gpt-oss-120b:nitro",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_LARGE_MODEL": {
+      "type": "string",
+      "required": false,
+      "sensitive": false,
+      "default": "openai/gpt-oss-120b:nitro",
+      "label": "Cloud Large Model",
+      "help": "Large/powerful model for complex tasks (overrides LARGE_MODEL). Default: openai/gpt-oss-120b:nitro",
+      "placeholder": "openai/gpt-oss-120b:nitro",
+      "advanced": false
+    },
+    "LARGE_MODEL": {
+      "type": "string",
+      "required": false,
+      "sensitive": false,
+      "default": "openai/gpt-oss-120b:nitro",
+      "label": "Model",
+      "help": "Fallback identifier for the large language model if ELIZAOS_CLOUD_LARGE_MODEL is not set.",
+      "placeholder": "openai/gpt-oss-120b:nitro",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_EMBEDDING_MODEL": {
+      "type": "string",
+      "required": false,
+      "sensitive": false,
+      "default": "text-embedding-3-small",
+      "label": "Cloud Embedding Model",
+      "help": "Identifier of the model to use for generating text embeddings.",
+      "placeholder": "e.g., text-embedding-3-small",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_EMBEDDING_URL": {
+      "type": "url",
+      "required": false,
+      "sensitive": false,
+      "label": "Cloud Embedding Url",
+      "help": "Custom base URL for the ElizaOS Cloud embeddings endpoint.",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_EMBEDDING_API_KEY": {
+      "type": "secret",
+      "required": false,
+      "sensitive": true,
+      "label": "Cloud Embedding Api Key",
+      "help": "Custom API key for the ElizaOS Cloud embeddings endpoint.",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_EMBEDDING_DIMENSIONS": {
+      "type": "number",
+      "required": false,
+      "sensitive": false,
+      "default": "1536",
+      "label": "Cloud Embedding Dimensions",
+      "help": "Number of dimensions for the returned embedding vectors.",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_IMAGE_DESCRIPTION_MODEL": {
+      "type": "string",
+      "required": false,
+      "sensitive": false,
+      "default": "gpt-5-mini",
+      "label": "Cloud Image Description Model",
+      "help": "Identifier of the model used for describing images.",
+      "placeholder": "e.g., gpt-4o, claude-sonnet-4-20250514",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_IMAGE_DESCRIPTION_MAX_TOKENS": {
+      "type": "secret",
+      "required": false,
+      "sensitive": true,
+      "default": "8192",
+      "label": "Cloud Image Description Max Tokens",
+      "help": "Maximum number of tokens allowed in the image-description model response.",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_TTS_MODEL": {
+      "type": "string",
+      "required": false,
+      "sensitive": false,
+      "default": "gpt-5-mini-tts",
+      "label": "Cloud Tts Model",
+      "help": "Identifier of the model used for text-to-speech generation.",
+      "placeholder": "e.g., tts-1, eleven_multilingual_v2",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_TTS_VOICE": {
+      "type": "string",
+      "required": false,
+      "sensitive": false,
+      "default": "nova",
+      "label": "Cloud Tts Voice",
+      "help": "Voice profile to use for text-to-speech output.",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_TTS_INSTRUCTIONS": {
+      "type": "textarea",
+      "required": false,
+      "sensitive": false,
+      "label": "Cloud Tts Instructions",
+      "help": "Optional instructions to control the style or behavior of the text-to-speech request.",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_EXPERIMENTAL_TELEMETRY": {
+      "type": "boolean",
+      "required": false,
+      "sensitive": false,
+      "default": "False",
+      "label": "Cloud Experimental Telemetry",
+      "help": "Enable experimental telemetry features for enhanced debugging and usage analytics.",
+      "advanced": true
+    },
+    "ELIZAOS_CLOUD_BROWSER_BASE_URL": {
+      "type": "url",
+      "required": false,
+      "sensitive": false,
+      "label": "Cloud Browser Base Url",
+      "help": "Browser-only proxy endpoint base URL for ElizaOS Cloud requests (no secrets in the client).",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_BROWSER_EMBEDDING_URL": {
+      "type": "url",
+      "required": false,
+      "sensitive": false,
+      "label": "Cloud Browser Embedding Url",
+      "help": "Browser-only proxy endpoint base URL for ElizaOS Cloud embeddings.",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_ENABLED": {
+      "type": "boolean",
+      "required": false,
+      "sensitive": false,
+      "default": "False",
+      "label": "Cloud Enabled",
+      "help": "Enable ElizaCloud container provisioning, device auth, bridge, and backup services. When false, only inference model handlers are active.",
+      "advanced": false
+    },
+    "ELIZAOS_CLOUD_APP_VERSION": {
+      "type": "string",
+      "required": false,
+      "sensitive": false,
+      "default": "2.0.0-beta.0",
+      "label": "Cloud App Version",
+      "help": "Application version sent during device authentication.",
+      "advanced": false
+    }
+  },
+  "render": {
+    "visible": true,
+    "pinTo": [],
+    "style": "card",
+    "icon": "Cloud",
+    "group": "feature-other",
+    "groupOrder": 12,
+    "actions": ["enable", "configure"]
+  },
+  "resources": {
+    "homepage": "https://github.com/eliza-ai/eliza/tree/develop/packages/plugin-elizacloud#readme",
+    "repository": "https://github.com/eliza-ai/eliza"
+  },
+  "dependsOn": [],
+  "kind": "plugin",
+  "subtype": "other"
+}

package/src/cloud/auth-service-types.ts

@@ -0,0 +1,24 @@
+import type { Service } from "@elizaos/core";
+
+export interface CloudAuthApiKeyService {
+  isAuthenticated: () => boolean;
+  getApiKey?: () => string | undefined;
+}
+
+export function isCloudAuthApiKeyService(
+  value: Service | null | undefined,
+): value is Service & CloudAuthApiKeyService {
+  return (
+    value !== null &&
+    value !== undefined &&
+    typeof (value as Partial<CloudAuthApiKeyService>).isAuthenticated ===
+      "function"
+  );
+}
+
+export function normalizeCloudApiKey(value: string | null | undefined): string | null {
+  if (typeof value !== "string") return null;
+  const trimmed = value.trim();
+  if (!trimmed || trimmed.toUpperCase() === "[REDACTED]") return null;
+  return trimmed;
+}

package/src/cloud/base-url.ts

@@ -1,62 +1,6 @@
-const DEFAULT_CLOUD_SITE_URL = "https://www.elizacloud.ai";
-
-const LEGACY_CLOUD_HOST_ALIASES = new Set([
-  "elizacloud.ai",
-  "www.elizacloud.ai",
-]);
-
-function isLoopbackHost(hostname: string): boolean {
-  const normalized = hostname.toLowerCase();
-  return (
-    normalized === "localhost" ||
-    normalized === "::1" ||
-    normalized === "0:0:0:0:0:0:0:1" ||
-    normalized.startsWith("127.")
-  );
-}
-
-function trimApiPath(pathname: string): string {
-  const normalized = pathname.trim().replace(/\/+$/, "");
-  if (!normalized) return "";
-  if (normalized === "/api/v1") return "";
-  if (normalized.endsWith("/api/v1")) {
-    return normalized.slice(0, -"/api/v1".length);
-  }
-  return normalized;
-}
-
-export function normalizeCloudSiteUrl(rawUrl?: string): string {
-  // Allow cloud-provisioned containers to override the base URL via env var
-  const envOverride = process.env.ELIZAOS_CLOUD_BASE_URL?.trim();
-  const candidate = envOverride || rawUrl?.trim() || DEFAULT_CLOUD_SITE_URL;
-
-  try {
-    const parsed = new URL(candidate);
-    const pathname = trimApiPath(parsed.pathname);
-    const host = parsed.hostname.toLowerCase();
-    const preserveLocalOrigin = isLoopbackHost(host);
-
-    parsed.hash = "";
-    parsed.search = "";
-    if (!preserveLocalOrigin) {
-      parsed.protocol = "https:";
-      parsed.port = "";
-    }
-    parsed.pathname = pathname;
-
-    if (LEGACY_CLOUD_HOST_ALIASES.has(host)) {
-      parsed.hostname = "www.elizacloud.ai";
-      parsed.pathname = "";
-    }
-
-    return parsed.toString().replace(/\/{1,1024}$/, "");
-  } catch {
-    const safeCandidate =
-      candidate.length > 8192 ? candidate.slice(0, 8192) : candidate;
-    return safeCandidate.replace(/\/{1,1024}$/, "");
-  }
-}
-
-export function resolveCloudApiBaseUrl(rawUrl?: string): string {
-  return `${normalizeCloudSiteUrl(rawUrl)}/api/v1`;
-}
+/**
+ * Cloud site/API URL normalizer. The implementation moved to
+ * `@elizaos/shared/elizacloud/base-url` so host-layer packages can normalize
+ * URLs without reverse-importing this plugin.
+ */
+export { normalizeCloudSiteUrl, resolveCloudApiBaseUrl } from "@elizaos/shared";

package/src/cloud/clack-observer.ts

@@ -0,0 +1,189 @@
+/**
+ * `@clack/prompts`-backed implementation of `CloudSetupObserver`.
+ *
+ * Used by the CLI first-time-setup flow. Wraps a lazily-loaded clack module
+ * (so packaged desktop builds that never run interactive setup don't
+ * pay the dep cost) and renders every observer event as a spinner update,
+ * `log.info` / `log.warn`, or `confirm` / `select` prompt.
+ *
+ * @module cloud/clack-observer
+ */
+import { logger } from "@elizaos/core";
+import type {
+  CloudSetupObserver,
+  ConfirmPrompt,
+  ProvisionSuccessInfo,
+  SelectChoicePrompt,
+} from "./setup-observer.js";
+
+/** Lazy-loaded @clack/prompts module type. */
+type ClackModule = typeof import("@clack/prompts");
+
+interface ClackSpinner {
+  start(message?: string): void;
+  stop(message?: string): void;
+  message(message?: string): void;
+}
+
+/**
+ * Observer that drives a clack CLI session. One instance per setup run
+ * — internal spinner state is reused across the auth + provisioning phases
+ * so we don't stack overlapping spinners.
+ */
+export class ClackObserver implements CloudSetupObserver {
+  private spinner: ClackSpinner | null = null;
+
+  constructor(private readonly clack: ClackModule) {}
+
+  // ── Spinner helpers ──────────────────────────────────────────────────
+  private ensureSpinner(): ClackSpinner {
+    if (!this.spinner) {
+      this.spinner = this.clack.spinner();
+    }
+    return this.spinner;
+  }
+
+  private stopSpinner(message: string): void {
+    if (this.spinner) {
+      this.spinner.stop(message);
+      this.spinner = null;
+    } else {
+      // No active spinner — render the line as a log.info so the
+      // message isn't lost.
+      this.clack.log.info(message);
+    }
+  }
+
+  // ── Availability ─────────────────────────────────────────────────────
+  onAvailabilityChecked(result: { ok: boolean; reason?: string }): void {
+    if (!result.ok && result.reason) {
+      this.clack.log.warn(result.reason);
+    }
+  }
+
+  // ── Auth ─────────────────────────────────────────────────────────────
+  onAuthStart(loginUrl: string): void {
+    const spinner = this.ensureSpinner();
+    spinner.start("Connecting to Eliza Cloud...");
+    // The auth flow's first callback fires when we have the login URL.
+    spinner.stop("Opening your browser to log in...");
+    this.spinner = null;
+    this.clack.log.info(`If the browser didn't open, visit:\n  ${loginUrl}`);
+    const polling = this.ensureSpinner();
+    polling.start("Waiting for login in browser...");
+  }
+
+  onAuthBrowserOpenFailed(loginUrl: string, error: Error): void {
+    // Previously swallowed at debug-level. Now visible: the user may have
+    // missed the URL printed by onAuthStart, so re-emit it here with the
+    // explicit "couldn't open browser" framing.
+    this.clack.log.warn(
+      `Could not open browser automatically (${error.message}). Visit this URL to continue:\n  ${loginUrl}`,
+    );
+  }
+
+  onAuthPollStatus(status: string): void {
+    if (status === "pending") {
+      this.ensureSpinner().message("Waiting for login in browser...");
+    }
+  }
+
+  onAuthSuccess(): void {
+    this.stopSpinner("✓ Logged in to Eliza Cloud!");
+  }
+
+  onAuthFailure(message: string): void {
+    this.stopSpinner(message);
+  }
+
+  // ── Provisioning ─────────────────────────────────────────────────────
+  onProvisionStart(_agentName: string): void {
+    const spinner = this.ensureSpinner();
+    spinner.start("Creating your cloud agent...");
+  }
+
+  onProvisionStatus(status: string): void {
+    const spinner = this.ensureSpinner();
+    switch (status) {
+      case "created":
+        spinner.message("Agent created! Provisioning cloud environment...");
+        break;
+      case "queued":
+        spinner.message("Queued — waiting for available slot...");
+        break;
+      case "provisioning":
+        spinner.message("Provisioning cloud environment...");
+        break;
+      default:
+        spinner.message(`Status: ${status}...`);
+    }
+  }
+
+  onProvisionTimeout(_agentId: string, lastStatus: string): void {
+    this.stopSpinner(
+      `Provisioning timed out (last status: ${lastStatus}). The agent may still be starting up.`,
+    );
+  }
+
+  onProvisionFailure(reason: string): void {
+    this.stopSpinner(reason);
+  }
+
+  onProvisionSuccess(result: ProvisionSuccessInfo): void {
+    this.stopSpinner(`☁️  Cloud agent "${result.agentId}" is running!`);
+  }
+
+  // ── Generic ──────────────────────────────────────────────────────────
+  onNotice(message: string): void {
+    this.clack.log.warn(message);
+  }
+
+  onFatalError(error: Error, context: string): void {
+    logger.error(`[cloud-setup] ${context}: ${error.message}`);
+    this.clack.log.error(`${context}: ${error.message}`);
+  }
+
+  // ── Prompts ──────────────────────────────────────────────────────────
+  async confirm(prompt: ConfirmPrompt): Promise<boolean | null> {
+    const args: {
+      message: string;
+      initialValue?: boolean;
+      active?: string;
+      inactive?: string;
+    } = { message: prompt.message };
+
+    if (prompt.defaultValue !== undefined) args.initialValue = prompt.defaultValue;
+    if (prompt.activeLabel !== undefined) args.active = prompt.activeLabel;
+    if (prompt.inactiveLabel !== undefined) args.inactive = prompt.inactiveLabel;
+
+    const result = await this.clack.confirm(args);
+    if (this.clack.isCancel(result)) return null;
+    return result;
+  }
+
+  async selectChoice<T extends string>(
+    prompt: SelectChoicePrompt<T>,
+  ): Promise<T | null> {
+    // Clack's `Option<Value>` is a conditional type that for `Value extends
+    // Primitive` makes `label` optional. TS can't narrow the conditional
+    // for an unresolved generic `T extends string`, so we describe the
+    // option shape via Parameters of clack's `select` and let inference
+    // pick it up. No `as unknown as` escape — the parameter type IS the
+    // right type, we just have to address it positionally.
+    type SelectOpts = Parameters<typeof this.clack.select<T>>[0];
+    const options = prompt.options.map((option) => {
+      const out = {
+        label: option.label,
+        value: option.value,
+        ...(option.hint !== undefined ? { hint: option.hint } : {}),
+      };
+      return out;
+    }) as SelectOpts["options"];
+    const result = await this.clack.select<T>({
+      message: prompt.message,
+      options,
+    });
+    if (this.clack.isCancel(result)) return null;
+    return result;
+  }
+}