@chronicle.app/email-core 0.4.0 → 0.5.0

package/README.md

@@ -10,7 +10,7 @@ What Chronicle's mail sources share: reading an mbox, parsing an email, identify
   - for bulk mail (one with `List-Unsubscribe`, `List-Id`, or `Precedence: bulk`), without its footer: from the first unsubscribe or "you're receiving this" line in its second half;
   - with tracking parameters (`utm_*`, `fbclid`, …) taken off links and the padding characters newsletters fill their inbox preview with removed, by `tidyText` from `@chronicle.app/etl`. In bulk mail, click-tracking redirects (URLs over 200 characters) lose their URL but keep their words; a person's mail keeps long links, like a meeting's join link.
 - `identityOf(message)` is its Message-ID, or else its sender, date, and subject; null when it has neither, and a source skips it.
-- `messageAction(message, options)` is the sending of it: a `MessageAction` by the sender on a `Message`, with its recipients and the message it replies to, and a source's thread and labels when it has them. The sender is written in full as the action's `agent`, and as the message's `author` by key alone. A display name the mail gives an address, other than the address itself, is its `alternateName`: what that message called it, not its own name. With `account`, the message is `inAccount` it.
+- `messageAction(message, options)` is the sending of it: a `MessageAction` by the sender whose `result` is the `Message`, keyed by it, with its recipients and the message it replies to, and a source's thread and labels when it has them. The sender is written in full as the action's `agent`, and as the message's `author` by key alone. A display name the mail gives an address, other than the address itself, is its `alternateName`: what that message called it, not its own name. With `account`, the message is `inAccount` it.
 - `emailAccount(address)` is the account at an address, an Agent keyed by it in the `email` namespace: what a message is `inAccount`, whatever service holds it.
 
 Identifiers the email protocol defines are keyed in its namespace (`source: 'email'`): a message by its Message-ID without the angle brackets around it (as JMAP and `mid:` URIs write it), so the same email read by any mail source is one node. A person is their lowercased address in the `email` namespace (`source: 'email'`), the identity other plugins already link an address to, so every mail source, a calendar, and those links meet on one node.

package/dist/build.d.ts

@@ -35,11 +35,10 @@ export interface MessageNodeOptions {
     account?: Agent;
 }
 /**
- * The sending of a message: a `MessageAction` by its sender, whose object is
+ * The sending of a message: a `MessageAction` by its sender, whose result is
  * the `Message`, with its recipients, the message it replies to, and its
  * thread and labels when the source has them. The sending happened once, so
- * the action is keyed by the Message-ID wherever the message is read, as the
- * message is.
+ * the action is keyed by the message it made, wherever the message is read.
  */
 export declare function messageAction(mail: MailMessage, options?: MessageNodeOptions): MessageAction;
 /**

package/dist/build.js

@@ -6,7 +6,9 @@
 const MESSAGE_KEY = ['@type', 'source', 'sourceId'];
 /** Without a Message-ID: who sent it, when, and under what subject. */
 const KEYLESS_MESSAGE_KEY = ['@type', 'source', 'action.timestamp', 'action.agent.handle', 'name'];
-const KEYLESS_ACTION_KEY = ['@type', 'source', 'timestamp', 'agent.handle', 'object.name'];
+const KEYLESS_ACTION_KEY = ['@type', 'source', 'timestamp', 'agent.handle', 'result.name'];
+/** Sending makes the message, so the action is keyed by the message it made. */
+const ACTION_KEY = ['@type', 'source', 'result.sourceId'];
 /** Identifiers defined by the email protocol (RFC 5322) live in its namespace. */
 const EMAIL = 'email';
 /**
@@ -42,11 +44,10 @@ export function identityOf(mail) {
     return [mail.from.address.toLowerCase(), mail.date, mail.subject].join(COMPOSITE_DELIMITER);
 }
 /**
- * The sending of a message: a `MessageAction` by its sender, whose object is
+ * The sending of a message: a `MessageAction` by its sender, whose result is
  * the `Message`, with its recipients, the message it replies to, and its
  * thread and labels when the source has them. The sending happened once, so
- * the action is keyed by the Message-ID wherever the message is read, as the
- * message is.
+ * the action is keyed by the message it made, wherever the message is read.
  */
 export function messageAction(mail, options = {}) {
     const me = new Set((options.me ?? []).map(address => address.toLowerCase()));
@@ -87,12 +88,11 @@ export function messageAction(mail, options = {}) {
     };
     return {
         '@type': 'MessageAction',
-        ...(messageId
-            ? { '@key': MESSAGE_KEY, source: EMAIL, sourceId: messageId }
-            : { '@key': KEYLESS_ACTION_KEY, source: EMAIL }),
+        '@key': messageId ? ACTION_KEY : KEYLESS_ACTION_KEY,
+        source: EMAIL,
         timestamp: new Date(sentAt),
         agent: sender,
-        object: message,
+        result: message,
     };
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chronicle.app/email-core",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
@@ -23,9 +23,9 @@
   "type": "module",
   "description": "Email parsing, mbox reading, and message nodes shared by Chronicle mail sources",
   "devDependencies": {
-    "@chronicle.app/etl": "0.4.0",
-    "@chronicle.app/schema": "0.4.0",
-    "@chronicle.app/tsconfig": "0.4.0",
+    "@chronicle.app/etl": "0.5.0",
+    "@chronicle.app/schema": "0.5.0",
+    "@chronicle.app/tsconfig": "0.5.0",
     "@types/node": "^22.10.1",
     "typescript": "^5.7.2"
   },