relaybraid 0.2.0

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "relaybraid",
+  "version": "0.2.0",
+  "description": "Relaybraid SDK for Node.js: run app actions from code.",
+  "type": "module",
+  "exports": "./src/index.mjs",
+  "files": [
+    "src"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "license": "MIT",
+  "homepage": "https://relaybraid.com/docs/sdk",
+  "keywords": [
+    "automation",
+    "slack",
+    "integrations",
+    "sdk"
+  ]
+}

package/src/index.mjs

@@ -0,0 +1,147 @@
+import { existsSync } from "node:fs";
+import { appendFile, mkdir, readFile, writeFile } from "node:fs/promises";
+import { join } from "node:path";
+
+const VERSION = "0.2.0";
+const DEFAULT_ORIGIN = process.env.RELAYBRAID_ORIGIN || "https://relaybraid.com";
+const CLIENT = `relaybraid-sdk/${VERSION} node/${process.versions.node} ${process.platform}`;
+
+// The name of the coding agent running this process, when one is, read from AI_AGENT or the
+// agent's own marker variable and sent as X-Relaybraid-Agent. Nothing else about the environment
+// is sent. What the SDK sends and why: https://relaybraid.com/docs/telemetry
+function agentName() {
+  if (process.env.AI_AGENT) return process.env.AI_AGENT;
+  if (process.env.CLAUDECODE) return "claude-code";
+  if (process.env.CURSOR_AGENT) return "cursor";
+  if (process.env.CODEX_CI) return "codex";
+  return null;
+}
+
+async function readJson(path) {
+  if (!existsSync(path)) return null;
+  try {
+    return JSON.parse(await readFile(path, "utf8"));
+  } catch {
+    return null;
+  }
+}
+
+// The key the CLI saved, and the install id `init` minted for this project.
+async function readProject(cwd) {
+  const credentials = await readJson(join(cwd, ".relaybraid", "credentials.json"));
+  const config = await readJson(join(cwd, ".relaybraid", "config.json"));
+  return { apiKey: credentials?.api_key ?? null, installId: credentials?.install_id ?? config?.install_id ?? null };
+}
+
+async function saveCredentials(cwd, apiKey, installId) {
+  const dir = join(cwd, ".relaybraid");
+  await mkdir(dir, { recursive: true });
+  await writeFile(join(dir, "credentials.json"), `${JSON.stringify({ api_key: apiKey, install_id: installId ?? null }, null, 2)}\n`, { mode: 0o600 });
+  const ignore = join(cwd, ".gitignore");
+  const current = existsSync(ignore) ? await readFile(ignore, "utf8") : "";
+  if (!current.includes(".relaybraid/credentials.json")) await appendFile(ignore, `${current.endsWith("\n") || current === "" ? "" : "\n"}.relaybraid/credentials.json\n`);
+}
+
+export class RelaybraidError extends Error {
+  constructor(message, { status, code }) {
+    super(message);
+    this.name = "RelaybraidError";
+    this.status = status;
+    this.code = code;
+  }
+}
+
+export class Relaybraid {
+  #apiKey;
+  #clientId;
+  #clientSecret;
+  #setup;
+  #origin;
+  #cwd;
+  #installId;
+  claimUrl = null;
+
+  // `setup` is the code shown in the docs you installed from; it links this project to that guide.
+  // `clientId` and `clientSecret` authenticate unattended code; otherwise the SDK reads the key the
+  // CLI saved, or RELAYBRAID_API_KEY.
+  constructor({ apiKey, clientId, clientSecret, setup, origin, cwd } = {}) {
+    this.#apiKey = apiKey ?? process.env.RELAYBRAID_API_KEY ?? null;
+    this.#clientId = clientId ?? process.env.RELAYBRAID_CLIENT_ID ?? null;
+    this.#clientSecret = clientSecret ?? process.env.RELAYBRAID_CLIENT_SECRET ?? null;
+    this.#setup = setup ?? null;
+    this.#origin = origin ?? DEFAULT_ORIGIN;
+    this.#cwd = cwd ?? process.cwd();
+    this.#installId = null;
+  }
+
+  // Creates a trial workspace (100 free action runs), saves its key in .relaybraid/credentials.json
+  // and exposes `claimUrl`, the link the account owner uses to keep the workspace.
+  static async trial({ setup, agent, intent, origin, cwd } = {}) {
+    const client = new Relaybraid({ setup, origin, cwd });
+    const existing = await readProject(client.#cwd);
+    if (existing.apiKey) {
+      client.#apiKey = existing.apiKey;
+      client.#installId = existing.installId;
+      return client;
+    }
+    const created = await client.#request("POST", "/api/sdk/trial", { setup: setup ?? null, agent: agent ?? agentName(), intent: intent ?? null }, { auth: false });
+    client.#apiKey = created.trial_key;
+    client.#installId = created.install_id ?? null;
+    client.claimUrl = created.claim_url;
+    await saveCredentials(client.#cwd, created.trial_key, created.install_id ?? null);
+    return client;
+  }
+
+  async #exchangeClientCredentials() {
+    const form = new URLSearchParams({ grant_type: "client_credentials", client_id: this.#clientId, client_secret: this.#clientSecret });
+    const response = await fetch(`${this.#origin}/oauth/token`, { method: "POST", headers: { "user-agent": CLIENT, "x-relaybraid-client": CLIENT, "content-type": "application/x-www-form-urlencoded" }, body: form.toString() });
+    const data = await response.json().catch(() => null);
+    if (!response.ok || !data?.access_token) throw new RelaybraidError(data?.error_description ?? "Client credentials were not accepted.", { status: response.status, code: data?.error ?? "invalid_client" });
+    return data.access_token;
+  }
+
+  async #request(method, path, body, { auth = true } = {}) {
+    const headers = { "user-agent": CLIENT, "x-relaybraid-client": CLIENT, accept: "application/json" };
+    const agent = agentName();
+    if (agent) headers["x-relaybraid-agent"] = agent;
+    if (this.#setup) headers["x-relaybraid-setup"] = this.#setup;
+    if (body !== undefined) headers["content-type"] = "application/json";
+    if (auth) {
+      if (!this.#apiKey && this.#clientId && this.#clientSecret) this.#apiKey = await this.#exchangeClientCredentials();
+      if (!this.#apiKey) {
+        const project = await readProject(this.#cwd);
+        this.#apiKey = project.apiKey;
+        this.#installId ??= project.installId;
+      }
+      if (!this.#apiKey) {
+        throw new RelaybraidError("No API key. Run the Relaybraid CLI's `login`, call Relaybraid.trial(), pass clientId and clientSecret, or set RELAYBRAID_API_KEY.", { status: 0, code: "no_api_key" });
+      }
+      headers.authorization = `Bearer ${this.#apiKey}`;
+    }
+    if (this.#installId) headers["x-relaybraid-install"] = this.#installId;
+    const response = await fetch(`${this.#origin}${path}`, { method, headers, body: body === undefined ? undefined : JSON.stringify(body) });
+    const text = await response.text();
+    let data = null;
+    try {
+      data = JSON.parse(text);
+    } catch {
+      data = null;
+    }
+    if (!response.ok) {
+      throw new RelaybraidError(data?.error?.message ?? `${method} ${path} failed with ${response.status}`, { status: response.status, code: data?.error?.code ?? "http_error" });
+    }
+    return data;
+  }
+
+  run(action, input = {}) {
+    return this.#request("POST", "/api/v1/actions/run", { action, input });
+  }
+
+  apps() {
+    return this.#request("GET", "/api/v1/apps");
+  }
+
+  me() {
+    return this.#request("GET", "/api/v1/me");
+  }
+}