equoter 0.1.0

package/LICENSE

@@ -0,0 +1,24 @@
+MIT License
+
+Copyright (c) 2026 Wicher Heldring
+
+Based on quotequail (https://github.com/closeio/quotequail)
+Copyright (c) 2015 Elastic Inc. (Close.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,157 @@
+# equoter
+
+> **Note:** This codebase was mostly written by AI (Claude), with human direction and review.
+>
+> There is an additional private test set based on real emails (not included in this repo for privacy reasons).
+
+A TypeScript library that identifies and separates quoted text in email messages. Detects replies, forwards, and quoted blocks across multiple email clients and languages.
+
+TypeScript port of [quotequail](https://github.com/closeio/quotequail), with additional improvements inspired by [Mailgun's Talon](https://github.com/mailgun/talon).
+
+## Features
+
+- **Plain text & HTML** — works with both `text/plain` and `text/html` email bodies
+- **Client-specific detection** — fast-path selectors for Gmail (`div.gmail_quote`), Outlook (`#divRplyFwdMsg`, border styles), Outlook Web App (`#OLK_SRC_BODY_SECTION`), Zimbra (`hr[data-marker]`), and more
+- **Two-phase HTML detection** — tries client-specific CSS selectors first, falls back to line-based pattern matching
+- **Multi-language** — English, Dutch, German, French, Spanish, Russian, Swedish, Portuguese
+- **Email clients** — Gmail, Apple Mail, Outlook (2003–2013, Web, iOS), Thunderbird, Mail.ru, Zimbra, Sparrow
+- **Lightweight** — single runtime dependency ([linkedom](https://github.com/WebReflection/linkedom))
+
+## Install
+
+```bash
+pnpm add equoter
+# or
+npm install equoter
+```
+
+## Usage
+
+### `quote(text, options?)`
+
+Split a plain text email body into quoted and unquoted parts.
+
+```ts
+import { quote } from "equoter";
+
+const result = quote(`Hello world.
+
+On 2012-10-16 at 17:02, Someone <someone@example.com> wrote:
+
+> Some quoted text`);
+
+// [
+//   [true, "Hello world.\n\nOn 2012-10-16 at 17:02, Someone <someone@example.com> wrote:"],
+//   [false, "\n> Some quoted text"]
+// ]
+```
+
+Each tuple is `[shouldExpand, text]` — `true` means original content, `false` means quoted.
+
+**Options:**
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `limit` | `1000` | Auto-quote everything after this many lines if no pattern is found |
+| `quoteIntroLine` | `false` | Include the "On ... wrote:" line in the quoted portion |
+
+### `quoteHtml(html, options?)`
+
+Same as `quote()` but for HTML email bodies. Uses a two-phase approach:
+
+1. **Phase 1** — Try client-specific CSS selectors (Gmail, Outlook, Zimbra, etc.) for fast, reliable detection
+2. **Phase 2** — Fall back to line-based pattern matching
+
+```ts
+import { quoteHtml } from "equoter";
+
+const result = quoteHtml(`<div>Reply text</div>
+<blockquote>On Jan 1, Someone wrote:<br>Original message</blockquote>`);
+```
+
+Accepts the same options as `quote()`. Returns `[shouldExpand, htmlFragment][]`.
+
+### `unwrap(text)`
+
+Decompose a plain text email into structured parts.
+
+```ts
+import { unwrap } from "equoter";
+
+const result = unwrap(`Hello
+
+---------- Forwarded message ----------
+From: Someone <someone@example.com>
+Date: Fri, Apr 26, 2013 at 8:13 PM
+Subject: Weekend classes
+To: recipient@example.com
+
+Learn something new`);
+
+// {
+//   type: "forward",
+//   text_top: "Hello",
+//   from: "Someone <someone@example.com>",
+//   date: "Fri, Apr 26, 2013 at 8:13 PM",
+//   subject: "Weekend classes",
+//   to: "recipient@example.com",
+//   text: "Learn something new"
+// }
+```
+
+Returns `null` if no forwarded/replied/quoted structure is detected.
+
+**Return fields:**
+
+| Field | Description |
+|-------|-------------|
+| `type` | `"reply"`, `"forward"`, or `"quote"` |
+| `text_top` / `text_bottom` | Text before/after the quoted content |
+| `text` | The unwrapped message body |
+| `from`, `to`, `cc`, `bcc`, `subject`, `date`, `reply-to` | Parsed headers (when present) |
+
+### `unwrapHtml(html)`
+
+Same as `unwrap()` but for HTML email bodies. Returns `html_top`, `html_bottom`, and `html` instead of their `text_` equivalents.
+
+```ts
+import { unwrapHtml } from "equoter";
+
+const result = unwrapHtml(htmlEmailString);
+
+// {
+//   type: "forward",
+//   html_top: "<div>Some intro text</div>",
+//   from: "Someone <someone@example.com>",
+//   subject: "The subject",
+//   html: "<div>The forwarded content</div>"
+// }
+```
+
+## Supported reply patterns
+
+| Language | Pattern |
+|----------|---------|
+| English | `On [date], [name] wrote:` |
+| Dutch | `Op [date] schreef [name]:` / `[name] schreef op [date]:` / `Op [date] heeft [name] het volgende geschreven:` |
+| German | `Am [date] schrieb [name]:` |
+| French | `Le [date] a écrit :` |
+| Spanish | `El [date] escribió:` |
+| Russian | `[name] написал(а):` |
+| Swedish | `Den [date] skrev [name]:` |
+| Portuguese | `Em [date] escreveu:` |
+
+## Differences from quotequail
+
+- Function names use camelCase: `quote_html` -> `quoteHtml`, `unwrap_html` -> `unwrapHtml`
+- Options are passed as an object: `quote(text, { limit: 500, quoteIntroLine: true })`
+- Uses [linkedom](https://github.com/WebReflection/linkedom) for HTML parsing instead of lxml
+- Two-phase HTML detection with client-specific CSS selectors (inspired by Talon)
+- Additional Dutch reply patterns (`schreef op`, `heeft ... het volgende geschreven:`)
+- Outlook `#divRplyFwdMsg`, Outlook Web App, Zimbra, and Windows Mail detection
+
+## License
+
+MIT — see [LICENSE](LICENSE).
+
+Based on [quotequail](https://github.com/closeio/quotequail) by Elastic Inc. (Close.io), also MIT licensed.

package/dist/enums.d.ts

@@ -0,0 +1,5 @@
+export declare enum Position {
+    Begin = "begin",
+    End = "end"
+}
+//# sourceMappingURL=enums.d.ts.map

package/dist/enums.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../src/enums.ts"],"names":[],"mappings":"AAAA,oBAAY,QAAQ;IAClB,KAAK,UAAU;IACf,GAAG,QAAQ;CACZ"}

package/dist/html.d.ts

@@ -0,0 +1,45 @@
+import { Position } from "./enums.js";
+export type ElementRef = [Element, Position];
+/**
+ * Trim a slice tuple so it starts/ends at non-empty lines.
+ */
+export declare function trimSlice(lines: string[], sliceTuple: [number | null, number | null] | null): [number, number] | null;
+/**
+ * Remove the outermost blockquote indentation by replacing it with a div.
+ */
+export declare function unindentTree(element: Element): void;
+/**
+ * Get line info arrays from an element.
+ */
+export declare function getLineInfo(tree: Element, maxLines?: number | null): [ElementRef[], ElementRef[], string[]];
+/**
+ * Parse an HTML string into a DOM tree and return the root element.
+ */
+export declare function getHtmlTree(html: string): Element;
+/**
+ * Render an element tree back to HTML, stripping the wrapper div.
+ */
+export declare function renderHtmlTree(tree: Element): string;
+/**
+ * Slice the HTML tree at the given range.
+ */
+export declare function sliceTree(tree: Element, startRefs: (ElementRef | null)[], endRefs: (ElementRef | null)[], sliceTuple: [number | null, number | null] | null, htmlCopy?: string): Element;
+/**
+ * Try to find quoted content using client-specific HTML selectors.
+ * Returns the element that starts the quoted section, or null if none found.
+ *
+ * Tries all heuristics and returns whichever match appears earliest
+ * in the document. This handles cases where e.g. Outlook wraps a Gmail
+ * thread — the Outlook separator comes first in the document even though
+ * the Gmail class is also present deeper in.
+ *
+ * Heuristics:
+ * - Outlook Web App: #OLK_SRC_BODY_SECTION
+ * - Outlook desktop/mobile: #divRplyFwdMsg
+ * - Outlook border styles: div with known forward CSS
+ * - Zimbra: hr[data-marker="__DIVIDER__"]
+ * - Gmail: div.gmail_quote or div.x_gmail_quote
+ * - Last non-nested blockquote (not .gmail_quote)
+ */
+export declare function findClientSpecificQuote(tree: Element): Element | null;
+//# sourceMappingURL=html.d.ts.map

package/dist/html.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.d.ts","sourceRoot":"","sources":["../src/html.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AA0H7C;;GAEG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,MAAM,EAAE,EACf,UAAU,EAAE,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,GAChD,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAiBzB;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAsBnD;AAiND;;GAEG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,OAAO,EACb,QAAQ,GAAE,MAAM,GAAG,IAAW,GAC7B,CAAC,UAAU,EAAE,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,CAAC,CAexC;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAGjD;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAGpD;AAED;;GAEG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,OAAO,EACb,SAAS,EAAE,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,EAChC,OAAO,EAAE,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,EAC9B,UAAU,EAAE,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,IAAI,EACjD,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAsET;AAkCD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,IAAI,CA8CrE"}