npm - relay-companion - Versions diffs - 0.1.2 → 0.1.4 - Mend

relay-companion 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/bin/relay.js CHANGED Viewed

@@ -13,6 +13,7 @@ import { runMcpServer } from "../src/mcp.js";
 import { runSetupInstall, runUninstall } from "../src/install.js";
 import { openRelay, openTask } from "../src/materializer.js";
 import { resetCompanionStateForAccount } from "../src/notifications.js";
+import { finishSetupOpenRelay, normalizeSetupHost, setupOpenRelayToken, setupOpenStatus } from "../src/setup-open.js";
 function parseFlags(argv) {
   const flags = {};
@@ -83,6 +84,24 @@ async function cmdSetup(flags) {
   await cmdPair(flags, { promptForDefaults: Boolean(flags.interactive) });
   console.log("");
   applyInstall();
+  const token = setupOpenRelayToken(flags);
+  if (token) {
+    console.log("");
+    const host = normalizeSetupHost(flags.host || flags.in);
+    const result = await finishSetupOpenRelay({
+      token,
+      host,
+      log: (m) => process.stderr.write(`[relay] ${m}\n`),
+    });
+    const openStatus = setupOpenStatus(result.opened, openUrl);
+    if (openStatus.opened) {
+      console.log(`Opened relay ${result.relayId} in ${host === "codex" ? "Codex" : "Claude Code"}.`);
+    } else if (openStatus.url) {
+      console.log(`Relay ${result.relayId} is ready. Open this URL: ${openStatus.url}`);
+    } else {
+      console.log(`Relay ${result.relayId} is staged in the Relay pill.`);
+    }
+  }
 }
 /** Install the tools + daemon on a device that is already paired. */
@@ -251,6 +270,7 @@ async function main() {
           "",
           "Usage:",
           "  relay setup [--code CODE] [--name NAME]               Pair this machine and add Relay to Claude Code + Codex",
+          "  relay setup --code CODE --open-relay TOKEN --host codex|claude",
           "  relay setup --interactive                             Prompt for API URL and device name during setup",
           "  relay install                                         Add Relay to your agents (device already paired)",
           "  relay uninstall                                       Remove Relay from your agents and stop the daemon",

package/overlay/inbox.html CHANGED Viewed

@@ -14,6 +14,7 @@
     --ink:#1f1a17; --ink-2:#2c2824;
     --muted:#7c736b; --muted-2:#9a928a; --muted-3:#b7b1a6;
     --accent:#305566; --accent-soft:rgba(48,85,102,.10);
+    --brand-anthropic:#D9704E;
     --hair:rgba(31,26,23,.07);     /* between relay/task items */
     --hair-2:rgba(31,26,23,.06);   /* between contact rows */
     --serif:'Newsreader',Georgia,serif;
@@ -62,8 +63,10 @@
     padding:0 18px; cursor:pointer;
   }
   .mark { display:block; }
-  .mark rect { fill:var(--ink); transition:fill .25s var(--settle); }
-  .card.has-unread .sq0 { fill:var(--accent); }
+  .mark rect { transition:fill .25s var(--settle); }
+  .mark rect:nth-child(1) { fill:var(--brand-anthropic); }
+  .mark rect:nth-child(2) { fill:var(--ink); }
+  .mark rect:nth-child(3) { fill:url(#relayCodexGradient); }
   .word { font-family:var(--serif); font-size:19px; font-weight:500; letter-spacing:-.01em; color:var(--ink); line-height:1; }
   .spacer { flex:1 1 auto; }
   .minimize-hint {
@@ -276,7 +279,6 @@
     height:100%; display:flex; flex-direction:column; align-items:center; justify-content:center;
     gap:11px; padding:34px 28px; text-align:center;
   }
-  .empty .mark rect { fill:var(--muted-3); }
   .empty .t1 { font-family:var(--serif); font-size:16px; color:#4f4740; }
   .empty .t2 { font-size:12.5px; color:var(--muted-2); max-width:210px; line-height:1.45; }
   .gone { display:none !important; }
@@ -387,10 +389,22 @@
 </style>
 </head>
 <body>
+  <svg width="0" height="0" viewBox="0 0 0 0" aria-hidden="true" focusable="false">
+    <defs>
+      <linearGradient id="relayCodexGradient" x1="0%" y1="0%" x2="100%" y2="100%">
+        <stop offset="0%" stop-color="#C1C1FA"/>
+        <stop offset="16%" stop-color="#C0B1F9"/>
+        <stop offset="38%" stop-color="#7790F7"/>
+        <stop offset="58%" stop-color="#5F74F6"/>
+        <stop offset="82%" stop-color="#342CF5"/>
+        <stop offset="100%" stop-color="#3229F5"/>
+      </linearGradient>
+    </defs>
+  </svg>
   <div class="card" id="card">
     <div class="lockup" id="lockup">
       <svg class="mark" width="17" height="17" viewBox="0 0 16 16" aria-hidden="true">
-        <rect class="sq0" x="0" y="6" width="4" height="4"/>
+        <rect x="0" y="6" width="4" height="4"/>
         <rect x="6" y="6" width="4" height="4"/>
         <rect x="12" y="6" width="4" height="4"/>
       </svg>

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "relay-companion",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Relay companion: connects local coding agents to Relay tasks, approvals, and connector tools.",
   "type": "module",
   "bin": {

package/src/client.js CHANGED Viewed

@@ -74,6 +74,10 @@ export class RelayClient {
     return this.#req("GET", `/v1/open/${encodeURIComponent(token)}/packet`, undefined, { auth: false });
   }
+  bindOpenRelay(token) {
+    return this.#req("POST", `/v1/open/${encodeURIComponent(token)}/bind`, {});
+  }
   createFileUpload(payload) {
     return this.#req("POST", "/v1/files", payload);
   }
@@ -182,12 +186,21 @@ export class RelayClient {
     return this.#req("GET", "/v1/contacts");
   }
-  upsertContact({ name, email, emails }) {
-    return this.#req("POST", "/v1/contacts", { name, email, emails });
+  upsertContact({ name, firstName, surname, lastName, email, emails, notes, idempotencyKey }) {
+    return this.#req("POST", "/v1/contacts", { name, firstName, surname, lastName, email, emails, notes, idempotencyKey });
   }
-  updateContact(contactId, { name, email, emails } = {}) {
-    return this.#req("PATCH", `/v1/contacts/${encodeURIComponent(contactId)}`, { name, email, emails });
+  updateContact(contactId, { name, firstName, surname, lastName, email, emails, notes, idempotencyKey } = {}) {
+    return this.#req("PATCH", `/v1/contacts/${encodeURIComponent(contactId)}`, {
+      name,
+      firstName,
+      surname,
+      lastName,
+      email,
+      emails,
+      notes,
+      idempotencyKey,
+    });
   }
   importContacts(contacts, source = "imported") {

package/src/mcp.js CHANGED Viewed

@@ -29,7 +29,22 @@ export const TOOLS = [
           type: "array",
           items: { type: "string", enum: ["codex", "claude_code", "claude_desktop", "claude_cowork"] },
         },
-        attachments: { type: "array", items: { type: "object" } },
+        attachments: {
+          type: "array",
+          description:
+            "Optional files to send with the relay. Each item must include id, name, contentType, bytes, and optionally sha256. If the recipient may not be on Relay and will receive email fallback, include contentBase64 with the exact file bytes so Relay can attach the files directly to the email; otherwise the API will reject the send instead of emailing a broken partial relay.",
+          items: {
+            type: "object",
+            properties: {
+              id: { type: "string" },
+              name: { type: "string" },
+              contentType: { type: "string" },
+              bytes: { type: "number" },
+              sha256: { type: "string" },
+              contentBase64: { type: "string" },
+            },
+          },
+        },
         idempotencyKey: { type: "string" },
       },
       required: ["recipient", "title", "bodyMarkdown", "idempotencyKey"],
@@ -45,6 +60,25 @@ export const TOOLS = [
       required: ["query"],
     },
   },
+  {
+    name: "relay_contact_update",
+    description:
+      "Correct a Relay contact in this human's contact book. Use this after relay_send auto-creates an email-only contact, or when the human asks you to fix a saved contact. Prefer firstName and surname over a single name string. If you are not sure of the person's first name and surname, ask the human for clarification before editing the contact.",
+    inputSchema: {
+      type: "object",
+      properties: {
+        contactId: { type: "string", description: "The contactId returned by relay_contacts_search or relay_send.contact.contactId." },
+        firstName: { type: "string" },
+        surname: { type: "string" },
+        name: { type: "string", description: "Fallback display name; prefer firstName + surname when possible." },
+        email: { type: "string" },
+        emails: { type: "array", items: { type: "string" } },
+        notes: { type: "string" },
+        idempotencyKey: { type: "string" },
+      },
+      required: ["contactId", "idempotencyKey"],
+    },
+  },
   {
     name: "relay_inbox_list",
     description:
@@ -318,11 +352,26 @@ function text(obj) {
   return { content: [{ type: "text", text: typeof obj === "string" ? obj : JSON.stringify(obj, null, 2) }] };
 }
+function relaySendResultForAgent(result) {
+  if (!result?.contact?.autoCreated) return result;
+  return {
+    ...result,
+    agentInstruction:
+      result.agentInstruction ||
+      [
+        `Relay auto-added ${result.contact.email} to this human's contact book because there was no saved contact for this recipient.`,
+        "You are responsible for correcting the contact's firstName and surname with relay_contact_update if you know them from reliable context.",
+        "If you are not sure of the person's first name and surname, ask the human for clarification before editing the contact.",
+      ].join(" "),
+    nextRecommendedTool: "relay_contact_update",
+  };
+}
 export async function handleCall(client, name, args) {
   switch (name) {
     case "relay_send":
       return text(
-        await client.sendRelay({
+        relaySendResultForAgent(await client.sendRelay({
           recipient: args.recipient,
           kind: args.kind || "message",
           title: args.title,
@@ -332,10 +381,22 @@ export async function handleCall(client, name, args) {
           targetSurfaces: args.targetSurfaces || [],
           attachments: args.attachments || [],
           idempotencyKey: args.idempotencyKey,
-        }),
+        })),
       );
     case "relay_contacts_search":
       return text(await client.searchContacts(args.query));
+    case "relay_contact_update":
+      return text(
+        await client.updateContact(args.contactId, {
+          firstName: args.firstName,
+          surname: args.surname,
+          name: args.name,
+          email: args.email,
+          emails: args.emails,
+          notes: args.notes,
+          idempotencyKey: args.idempotencyKey,
+        }),
+      );
     case "relay_inbox_list":
       return text(await client.inbox());
     case "relay_acknowledge":

package/src/notifications.js CHANGED Viewed

@@ -453,7 +453,10 @@ export function defaultStageRelayCompanionItem(notification) {
   return stageRelayCompanionItem(notification);
 }
-export function stagePlainRelayItem({ item, packet, attachmentUrls = {} }, { statePath = companionStatePath() } = {}) {
+export function stagePlainRelayItem(
+  { item, packet, attachmentUrls = {} },
+  { statePath = companionStatePath(), forceUnread = false } = {},
+) {
   if (!item?.relayId) throw new Error("stagePlainRelayItem requires an inbox item with relayId");
   const state = readCompanionState(statePath);
   state.packets ||= {};
@@ -474,7 +477,8 @@ export function stagePlainRelayItem({ item, packet, attachmentUrls = {} }, { sta
     },
   };
   const contentPath = writeNotificationPacketContent({ id: item.relayId }, content, statePath);
-  const readState = existing.state === "read" || item.state === "read" ? "read" : "unread";
+  const preserveSetupUnread = existing.setupImportedUnread === true && existing.state === "unread";
+  const readState = forceUnread || preserveSetupUnread ? "unread" : existing.state === "read" || item.state === "read" ? "read" : "unread";
   const row = {
     ...existing,
     id: item.relayId,
@@ -504,6 +508,7 @@ export function stagePlainRelayItem({ item, packet, attachmentUrls = {} }, { sta
     attachmentUrls,
     materializationDeferredReason: "relay_pill",
     materializedSurfaces: existing.materializedSurfaces || { codex: false, claudeCode: false, claudeCowork: false },
+    setupImportedUnread: forceUnread || preserveSetupUnread || undefined,
   };
   state.packets[item.relayId] = row;
   writeCompanionState(statePath, state);

package/src/setup-open.js ADDED Viewed

@@ -0,0 +1,83 @@
+import { RelayClient } from "./client.js";
+import { openRelay } from "./materializer.js";
+import { stagePlainRelayItem } from "./notifications.js";
+export function normalizeSetupHost(host) {
+  const clean = String(host || "").trim().toLowerCase();
+  return clean === "codex" ? "codex" : "claude";
+}
+export function setupOpenRelayToken(flags = {}) {
+  return String(flags["open-relay"] || flags.openRelay || flags.relay || "").trim() || null;
+}
+export function setupOpenStatus(opened, openUrlFn = () => false) {
+  if (!opened) return { opened: false, fallbackAttempted: false, url: null };
+  if (opened.openedInHost || opened.skipExternalOpen) {
+    return { opened: true, fallbackAttempted: false, url: opened.url || null };
+  }
+  if (!opened.url) return { opened: false, fallbackAttempted: false, url: null };
+  return { opened: Boolean(openUrlFn(opened.url)), fallbackAttempted: true, url: opened.url };
+}
+function inboxItemFromOpenRelay(relay) {
+  return {
+    relayId: relay.relayId,
+    state: "delivered",
+    createdAt: relay.createdAt,
+    updatedAt: relay.createdAt,
+    kind: relay.kind,
+    title: relay.title,
+    displayTitle: relay.title,
+    sender: relay.sender,
+    preview: relay.preview,
+    hasAttachments: Boolean(relay.attachments?.length),
+  };
+}
+export async function stageCurrentInbox({ client = new RelayClient(), stage = stagePlainRelayItem, forceUnread = false, log = () => {} } = {}) {
+  const inbox = await client.inbox();
+  const staged = [];
+  for (const item of inbox.items || []) {
+    try {
+      const fetched = await client.fetchRelay(item.relayId);
+      stage({ item, packet: fetched.packet, attachmentUrls: fetched.attachmentUrls || {} }, { forceUnread });
+      staged.push(item.relayId);
+    } catch (error) {
+      log(`could not stage relay ${item.relayId}: ${error instanceof Error ? error.message : String(error)}`);
+    }
+  }
+  return staged;
+}
+export async function finishSetupOpenRelay({
+  token,
+  host = "claude",
+  client = new RelayClient(),
+  stage = stagePlainRelayItem,
+  openRelayFn = openRelay,
+  log = () => {},
+} = {}) {
+  const cleanToken = String(token || "").trim();
+  if (!cleanToken) return null;
+  const bound = await client.bindOpenRelay(cleanToken);
+  const relay = bound?.relay;
+  if (!relay?.relayId) {
+    throw new Error("Relay setup paired this device, but the relay link could not be attached to the account.");
+  }
+  const stagedIds = await stageCurrentInbox({ client, stage, forceUnread: true, log });
+  if (!stagedIds.includes(relay.relayId)) {
+    const fetched = await client.fetchRelay(relay.relayId);
+    stage({
+      item: inboxItemFromOpenRelay(relay),
+      packet: fetched.packet,
+      attachmentUrls: fetched.attachmentUrls || {},
+    }, { forceUnread: true });
+  }
+  const result = await openRelayFn({ id: relay.relayId, host: normalizeSetupHost(host), log });
+  return { relayId: relay.relayId, staged: true, opened: result };
+}