@plexuslabs/simmail 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+## 0.1.0
+
+First release.
+
+- `waitForEmail`, `waitForReply`: wait for the next email to an address, or a person's reply; codes and magic links already pulled out.
+- `extract`: codes and links from any text or HTML.
+- `mailboxes`, `messages`, `message`: what is in the universe's mailboxes.
+- `send` (with `inReplyTo`), `health` (the inspection report).
+- `accounts`, `createAccount`: your app's SMTP/IMAP logins.
+- `personas`, `createPersona`, `pushCase`.
+- `clock`, `advance`, `freeze`, `speed`, `live`.
+- Settings from `SIMMAIL_URL`, `SIMMAIL_API_KEY`, `SIMMAIL_UNIVERSE`; errors as `SimmailError` with the HTTP status.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,80 @@
-# Temporary Holding Version
+# @plexuslabs/simmail
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The official JavaScript client for [simmail](https://www.simmail.dev): a simulated email
+world for testing apps and email agents. Wait for the email your app sends, pull out the
+code or link, and get replies from simulated people, in a few lines of test code.
+
+No dependencies; Node 18 or newer (it uses `fetch`). Full docs: https://www.simmail.dev/docs/
+
+```sh
+npm install --save-dev @plexuslabs/simmail
+```
+
+## Setup
+
+The client reads its settings from the environment (or pass them to `new Simmail({...})`):
+
+| Variable | Meaning |
+| --- | --- |
+| `SIMMAIL_URL` | Your universe's server, such as `https://c1.simmail.dev` (shown on your account page). |
+| `SIMMAIL_API_KEY` | An API key, `smk_…` (Organization → API keys). |
+| `SIMMAIL_UNIVERSE` | Optional: only needed when the key could reach more than one universe. |
+
+Your app sends through simmail's SMTP as usual (the dashboard's *Get started* shows the
+settings); this client is for your tests.
+
+## Wait for an email and use its code (Playwright)
+
+```js
+import { test, expect } from "@playwright/test";
+import { Simmail } from "@plexuslabs/simmail";
+
+const mail = new Simmail();
+
+test("new users can verify their email", async ({ page }) => {
+  const email = `user-${Date.now()}@yourcompany.test`;
+  await page.goto("/signup");
+  await page.fill("#email", email);
+
+  const waiting = mail.waitForEmail({ to: email, subject: "verify", timeout: "20s" });
+  await page.click("text=Create account");
+  const msg = await waiting;
+
+  expect(msg.codes).toHaveLength(1);
+  await page.fill("#code", msg.codes[0]); // or: await page.goto(msg.magic_links[0])
+});
+```
+
+Start the wait before the click: a wait only sees mail that arrives after it starts, unless
+you pass `existing: true`.
+
+## Read what is there
+
+```js
+const inbox = await mail.messages("user@yourcompany.test");          // newest first
+const latest = await mail.message("user@yourcompany.test", "INBOX", inbox[0].uid);
+const report = await mail.health(latest.message_id);                  // spam score, links, compatibility
+```
+
+## A conversation with a simulated person
+
+```js
+const sent = await mail.send({
+  from: "sales@yourcompany.test",
+  to: ["dana@harbor.test"],
+  subject: "Offer",
+  text: "Would you take 165k?",
+});
+const reply = await mail.waitForReply({ from: "dana@harbor.test", inReplyTo: sent.message_id });
+console.log(reply.text);
+
+await mail.advance("2d"); // move the simulated clock: follow-ups and nudges that were due happen
+```
+
+## Errors
+
+A failed call throws `SimmailError` with the HTTP `status` and the server's message.
+
+## License
+
+Apache-2.0

package/index.d.ts

@@ -0,0 +1,112 @@
+/** A message as the wait endpoints return it: with the codes and links pulled out. */
+export interface Email {
+  address: string;
+  folder: string;
+  uid: number;
+  message_id: string;
+  in_reply_to?: string;
+  from: string;
+  from_name?: string;
+  to: string[];
+  subject: string;
+  date: string;
+  text: string;
+  html?: string;
+  links: string[];
+  /** One-time codes found in the text. */
+  codes: string[];
+  /** Links that verify, confirm, reset or sign in. */
+  magic_links: string[];
+  /** Written by a simulated person. */
+  by_persona?: boolean;
+}
+
+/** A message in a mailbox listing (text shortened) or read whole. */
+export interface Message {
+  uid: number;
+  folder: string;
+  flags: string[];
+  time: string;
+  size: number;
+  message_id: string;
+  in_reply_to?: string;
+  references?: string[];
+  from: string;
+  from_name?: string;
+  to?: string[];
+  cc?: string[];
+  subject: string;
+  date: string;
+  text: string;
+  html?: string;
+  headers?: Record<string, string>;
+  attachments?: { filename: string; content_type: string; size?: number }[];
+  format: string;
+}
+
+export interface WaitForEmail {
+  to: string;
+  from?: string;
+  subject?: string;
+  contains?: string;
+  folder?: string;
+  /** Also match messages already there. */
+  existing?: boolean;
+  /** Milliseconds, or a duration like "45s". Default 30s; at most 5m. */
+  timeout?: number | string;
+}
+
+export interface WaitForReply {
+  /** The person's address. */
+  from: string;
+  /** Only a reply to this Message-ID. */
+  inReplyTo?: string;
+  /** Have them write their due reply now instead of on the simulated clock. Default true. */
+  fast?: boolean;
+  timeout?: number | string;
+}
+
+export interface SendEmail {
+  from: string;
+  to: string[];
+  cc?: string[];
+  subject: string;
+  text?: string;
+  html?: string;
+  /** Thread this onto a conversation. */
+  inReplyTo?: string;
+  references?: string[];
+  attachments?: { filename: string; content_type: string; /** base64 */ data: string }[];
+}
+
+export class SimmailError extends Error {
+  status: number;
+}
+
+export class Simmail {
+  /** Defaults: SIMMAIL_URL (such as https://c1.simmail.dev), SIMMAIL_API_KEY, SIMMAIL_UNIVERSE. */
+  constructor(opts?: { baseUrl?: string; apiKey?: string; universe?: string });
+  baseUrl: string;
+  request<T = unknown>(method: string, path: string, body?: unknown, query?: Record<string, unknown>): Promise<T>;
+  me(): Promise<Record<string, unknown>>;
+  waitForEmail(q: WaitForEmail): Promise<Email>;
+  waitForReply(q: WaitForReply): Promise<Email>;
+  extract(x: { text?: string; html?: string }): Promise<{ codes: string[]; links: string[]; magic_links: string[] }>;
+  mailboxes(): Promise<unknown[]>;
+  messages(address: string, opts?: { folder?: string }): Promise<Message[]>;
+  message(address: string, folder: string, uid: number): Promise<Message>;
+  health(messageId: string): Promise<Record<string, unknown>>;
+  send(msg: SendEmail): Promise<{ message_id: string; status: string }>;
+  accounts(): Promise<unknown[]>;
+  createAccount(address: string, password: string): Promise<unknown>;
+  personas(): Promise<unknown[]>;
+  createPersona(p: Record<string, unknown>): Promise<unknown>;
+  pushCase(id: string, kase: Record<string, unknown>): Promise<unknown>;
+  clock(): Promise<unknown>;
+  advance(duration: string): Promise<unknown>;
+  freeze(): Promise<unknown>;
+  speed(factor: number): Promise<unknown>;
+  live(): Promise<unknown>;
+}
+
+export default Simmail;

package/index.js

@@ -0,0 +1,111 @@
+// simmail client: wait for the email your app sends, pull out codes and
+// links, and get replies from simulated people. No dependencies; Node 18+
+// (uses fetch).
+
+export class SimmailError extends Error {
+  constructor(status, message) {
+    super(message);
+    this.name = "SimmailError";
+    this.status = status;
+  }
+}
+
+// A wait's timeout: milliseconds as a number, or a duration such as "45s".
+const ms = v => (typeof v === "number" ? `${v}ms` : v || undefined);
+const seg = s => encodeURIComponent(String(s));
+
+export class Simmail {
+  /**
+   * @param {{baseUrl?: string, apiKey?: string, universe?: string}} opts
+   * Defaults: SIMMAIL_URL, SIMMAIL_API_KEY and SIMMAIL_UNIVERSE from the environment.
+   * baseUrl is the server's address, such as https://c1.simmail.dev (a trailing /api is fine too).
+   */
+  constructor(opts = {}) {
+    const env = (typeof process !== "undefined" && process.env) || {};
+    this.baseUrl = (opts.baseUrl || env.SIMMAIL_URL || "http://127.0.0.1:8025").replace(/\/+$/, "").replace(/\/api$/, "");
+    this.apiKey = opts.apiKey || env.SIMMAIL_API_KEY || "";
+    this.universe = opts.universe || env.SIMMAIL_UNIVERSE || "";
+  }
+
+  async request(method, path, body, query) {
+    const url = new URL(this.baseUrl + path);
+    for (const [k, v] of Object.entries(query || {})) if (v !== undefined && v !== null && v !== "") url.searchParams.set(k, String(v));
+    const headers = { Accept: "application/json" };
+    if (body !== undefined) headers["Content-Type"] = "application/json";
+    if (this.apiKey) headers.Authorization = `Bearer ${this.apiKey}`;
+    if (this.universe) headers["X-Simmail-Universe"] = this.universe;
+    const res = await fetch(url, { method, headers, body: body === undefined ? undefined : JSON.stringify(body) });
+    const text = await res.text();
+    let data;
+    try { data = text ? JSON.parse(text) : null; } catch { data = text; }
+    if (!res.ok) throw new SimmailError(res.status, (data && data.error) || res.statusText);
+    return data;
+  }
+
+  /** Who the key is and which universe it belongs to. */
+  me() { return this.request("GET", "/api/me"); }
+
+  // ---- waiting for mail ----
+
+  /** The next email to an address (optionally from someone, with words in the subject or body). */
+  waitForEmail({ to, from, subject, contains, folder, existing, timeout = 30000 }) {
+    return this.request("GET", "/api/wait", undefined, { to, from, subject, contains, folder, existing, timeout: ms(timeout) });
+  }
+
+  /** The next email a person sends, optionally in reply to a message. fast has them write it now. */
+  waitForReply({ from, inReplyTo, fast = true, timeout = 30000 }) {
+    return this.request("GET", "/api/wait/reply", undefined, { from, in_reply_to: inReplyTo, fast, timeout: ms(timeout) });
+  }
+
+  /** Codes and links from any text or HTML. */
+  extract({ text, html }) { return this.request("POST", "/api/extract", { text, html }); }
+
+  // ---- mailboxes and messages ----
+
+  /** Every mailbox in the universe: your app's logins and the people's addresses. */
+  mailboxes() { return this.request("GET", "/api/mailboxes"); }
+
+  /** A mailbox's messages, newest first (text shortened; message() has all of it). */
+  messages(address, { folder } = {}) {
+    return this.request("GET", `/api/mailboxes/${seg(address)}/messages`, undefined, { folder });
+  }
+
+  /** One whole message. */
+  message(address, folder, uid) {
+    return this.request("GET", `/api/mailboxes/${seg(address)}/messages/${seg(folder)}/${seg(uid)}`);
+  }
+
+  /** The health report of a message your app sent: spam score, links, compatibility. */
+  health(messageId) { return this.request("GET", "/api/inspect", undefined, { message_id: messageId }); }
+
+  /** Send an email as an account or mailbox (as the app would). */
+  send(msg) {
+    const { inReplyTo, ...rest } = msg;
+    return this.request("POST", "/api/send", inReplyTo ? { ...rest, in_reply_to: inReplyTo } : rest);
+  }
+
+  // ---- your app's mail logins ----
+
+  accounts() { return this.request("GET", "/api/accounts"); }
+  /** A login your app sends and reads with over SMTP and IMAP. */
+  createAccount(address, password) { return this.request("POST", "/api/accounts", { address, password }); }
+
+  // ---- people and stories ----
+
+  personas() { return this.request("GET", "/api/personas"); }
+  createPersona(p) { return this.request("POST", "/api/personas", p); }
+  /** Push what your system knows about a matter; the people in it learn the story. */
+  pushCase(id, kase) { return this.request("PUT", `/api/cases/${seg(id)}`, kase); }
+
+  // ---- the simulated clock ----
+
+  clock() { return this.request("GET", "/api/clock"); }
+  /** Move time on, such as "2d"; what was due happens. */
+  advance(duration) { return this.request("POST", "/api/clock/advance", { duration }); }
+  freeze() { return this.request("POST", "/api/clock/freeze", {}); }
+  speed(factor) { return this.request("POST", "/api/clock/speed", { factor }); }
+  /** Back to real time. */
+  live() { return this.request("POST", "/api/clock/live", {}); }
+}
+
+export default Simmail;

package/package.json

@@ -1,6 +1,30 @@
 {
   "name": "@plexuslabs/simmail",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Client for simmail: wait for the email your app sends, pull out codes and links, and get replies from simulated people.",
+  "type": "module",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    }
+  },
+  "files": ["index.js", "index.d.ts", "README.md", "CHANGELOG.md", "LICENSE"],
+  "engines": { "node": ">=18" },
+  "scripts": {
+    "test": "node --test test/*.test.js"
+  },
+  "keywords": ["email", "testing", "smtp", "e2e", "playwright", "simmail", "email-testing", "magic-link", "otp"],
+  "license": "Apache-2.0",
+  "author": "Plexus Labs",
+  "homepage": "https://www.simmail.dev/docs/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PlexusLabsDev/simmail-sdks.git",
+    "directory": "js"
+  },
+  "bugs": { "url": "https://github.com/PlexusLabsDev/simmail-sdks/issues" },
+  "publishConfig": { "access": "public", "provenance": true }
+}