postal-mime 2.0.2 → 2.1.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [2.1.1](https://github.com/postalsys/postal-mime/compare/v2.1.0...v2.1.1) (2024-02-26)
+
+
+### Bug Fixes
+
+* **types:** Updated types for PostalMime ([bc90f6d](https://github.com/postalsys/postal-mime/commit/bc90f6d5b7d3e2475cece77bb094caf421dead97))
+
+## [2.1.0](https://github.com/postalsys/postal-mime/compare/v2.0.2...v2.1.0) (2024-02-22)
+
+
+### Features
+
+* **workers:** Support Cloudflare Email Workers out of the box ([4904708](https://github.com/postalsys/postal-mime/commit/49047089bf779931dacb4a7b31816b48d1b00840))
+
+
+### Bug Fixes
+
+* **module:** add types to module exports ([#23](https://github.com/postalsys/postal-mime/issues/23)) ([1ee4a42](https://github.com/postalsys/postal-mime/commit/1ee4a427643d71f6a4bda0db0ebe0b5b280e52ae))
+
 ## [2.0.2](https://github.com/postalsys/postal-mime/compare/v2.0.1...v2.0.2) (2023-12-08)
 
 

package/README.md

@@ -67,6 +67,25 @@ Content-Type: text/html; charset=utf-8
 console.log(util.inspect(email, false, 22, true));
 ```
 
+#### Cloudflare [Email Workers](https://developers.cloudflare.com/email-routing/email-workers/)
+
+Pretty much the same as in Node.js. Use `message.raw` as the raw message for parsing.
+
+```js
+import PostalMime from 'postal-mime';
+
+export default {
+    async email(message, env, ctx) {
+        const parser = new PostalMime();
+        const email = await parser.parse(message.raw);
+
+        console.log('Subject: ', email.subject);
+        console.log('HTML: ', email.html);
+        console.log('Text: ', email.text);
+    }
+};
+```
+
 #### parser.parse()
 
 ```js

package/package.json

@@ -1,10 +1,11 @@
 {
     "name": "postal-mime",
-    "version": "2.0.2",
+    "version": "2.1.1",
     "description": "Email parser for browser environments",
     "main": "./src/postal-mime.js",
     "exports": {
-        "import": "./src/postal-mime.js"
+        "import": "./src/postal-mime.js",
+        "types": "./postal-mime.d.ts"
     },
     "type": "module",
     "types": "postal-mime.d.ts",
@@ -26,10 +27,11 @@
     "author": "Andris Reinman",
     "license": "MIT-0",
     "devDependencies": {
+        "@types/node": "20.11.20",
         "cross-blob": "3.0.2",
-        "eslint": "8.55.0",
+        "cross-env": "7.0.3",
+        "eslint": "8.57.0",
         "eslint-cli": "1.1.1",
-        "iframe-resizer": "4.3.9",
-        "cross-env": "7.0.3"
+        "iframe-resizer": "4.3.9"
     }
 }

package/postal-mime.d.ts

@@ -1,4 +1,4 @@
-export type RawEmail = string | ArrayBuffer | Blob | Buffer;
+export type RawEmail = string | ArrayBuffer | Uint8Array | Blob | Buffer | ReadableStream;
 
 export type Header = Record<string, string>;
 
@@ -13,7 +13,7 @@ export type Attachment = {
 	disposition: "attachment" | "inline" | null;
 	related?: boolean;
 	contentId?: string;
-	content: ArrayBuffer;
+	content: Uint8Array;
 };
 
 export type Email = {

package/src/postal-mime.js

@@ -287,31 +287,61 @@ export default class PostalMime {
         this.textContent = textContent;
     }
 
+    async resolveStream(stream) {
+        let chunkLen = 0;
+        let chunks = [];
+        const reader = stream.getReader();
+
+        while (true) {
+            const { done, value } = await reader.read();
+            if (done) {
+                break;
+            }
+            chunks.push(value);
+            chunkLen += value.length;
+        }
+
+        const result = new Uint8Array(chunkLen);
+        let chunkPointer = 0;
+        for (let chunk of chunks) {
+            result.set(chunk, chunkPointer);
+            chunkPointer += chunk.length;
+        }
+
+        return result;
+    }
+
     async parse(buf) {
         if (this.started) {
             throw new Error('Can not reuse parser, create a new PostalMime object');
         }
         this.started = true;
 
-        // should it thrown on empty value instead?
+        // Check if the input is a readable stream and resolve it into an ArrayBuffer
+        if (buf && typeof buf.getReader === 'function') {
+            buf = await this.resolveStream(buf);
+        }
+
+        // Should it throw for an empty value instead of defaulting to an empty ArrayBuffer?
         buf = buf || ArrayBuffer(0);
 
+        // Cast string input to Uint8Array
         if (typeof buf === 'string') {
-            // cast string input to ArrayBuffer
             buf = textEncoder.encode(buf);
         }
 
+        // Cast Blob to ArrayBuffer
         if (buf instanceof Blob || Object.prototype.toString.call(buf) === '[object Blob]') {
-            // can't process blob directly, cast to ArrayBuffer
             buf = await blobToArrayBuffer(buf);
         }
 
+        // Cast Node.js Buffer object or Uint8Array into ArrayBuffer
         if (buf.buffer instanceof ArrayBuffer) {
-            // Node.js Buffer object or Uint8Array
             buf = new Uint8Array(buf).buffer;
         }
 
         this.buf = buf;
+
         this.av = new Uint8Array(buf);
         this.readPos = 0;