@carlgo11/simpleimfparser 0.0.1-a → 0.0.1

package/dist/index.js

@@ -1,8 +1,14 @@
-import { Email } from './types/Email.js';
-import parseEnvelope from './parsers/parseEnvelope.js';
-import parseMessage from './parsers/parseMessage.js';
-export default async function parseEmail(rawData, envelope) {
-    const parsedEnvelope = await parseEnvelope(envelope);
-    const { headers, body } = await parseMessage(rawData);
-    return new Email(parsedEnvelope, headers, body);
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseEmail;
+const Email_1 = require("./types/Email");
+const parseEnvelope_1 = __importDefault(require("./parsers/parseEnvelope"));
+const parseMessage_1 = __importDefault(require("./parsers/parseMessage"));
+async function parseEmail(rawData, envelope) {
+    const parsedEnvelope = await (0, parseEnvelope_1.default)(envelope);
+    const { headers, body } = await (0, parseMessage_1.default)(rawData);
+    return new Email_1.Email(parsedEnvelope, headers, body);
 }

package/dist/parsers/parseEnvelope.js

@@ -1,9 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseEnvelope;
 /**
  * Parses envelope metadata from the SMTP transaction.
  * @param envelope - Envelope data object
  * @returns Parsed Envelope object
  */
-export default async function parseEnvelope(envelope) {
+async function parseEnvelope(envelope) {
     // TODO: Implement envelope parsing logic
     return envelope;
 }

package/dist/parsers/parseHeaders.js

@@ -1,9 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseHeaders;
 /**
  * Parses headers from a raw IMF header string.
  * @param rawHeaders - The raw headers as a string
  * @returns A dictionary of headers (handling duplicates)
  */
-export default function parseHeaders(rawHeaders) {
+function parseHeaders(rawHeaders) {
     const headers = {};
     const lines = rawHeaders.split(/\r\n|\n/);
     let currentKey = null;

package/dist/parsers/parseMessage.js

@@ -1,18 +1,24 @@
-import { Readable } from 'node:stream';
-import parseHeaders from './parseHeaders.js';
-import streamToString from '../utils/streamToString.js';
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseMessage;
+const node_stream_1 = require("node:stream");
+const parseHeaders_1 = __importDefault(require("./parseHeaders"));
+const streamToString_1 = __importDefault(require("../utils/streamToString"));
 /**
  * Parses the raw email message (headers + body).
  * @param rawData - Raw IMF email (string or stream)
  * @returns Parsed email components
  */
-export default async function parseMessage(rawData) {
+async function parseMessage(rawData) {
     let rawEmail;
     if (typeof rawData === 'string') {
         rawEmail = rawData;
     }
-    else if (rawData instanceof Readable) {
-        rawEmail = await streamToString(rawData);
+    else if (rawData instanceof node_stream_1.Readable) {
+        rawEmail = await (0, streamToString_1.default)(rawData);
     }
     else {
         throw new TypeError('Invalid rawData type. Expected a string or a Readable stream.');
@@ -24,7 +30,7 @@ export default async function parseMessage(rawData) {
         throw new Error('Header and Body must be separated by \\r\\n\\r\\n');
     }
     return {
-        headers: parseHeaders(rawHeaders),
+        headers: (0, parseHeaders_1.default)(rawHeaders),
         body,
     };
 }

package/dist/types/Attachment.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/Email.js

@@ -1,4 +1,7 @@
-export class Email {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Email = void 0;
+class Email {
     envelope;
     headers;
     body;
@@ -50,6 +53,7 @@ export class Email {
         return `${_headers}\r\n\r\n${this.body}`;
     }
 }
+exports.Email = Email;
 function camelize(str) {
     return str.replace(/(\w)(\w*)/g, function (g0, g1, g2) { return g1.toUpperCase() + g2.toLowerCase(); });
 }

package/dist/types/Envelope.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/Sender.js

@@ -1 +1,2 @@
-export {};
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/streamToString.js

@@ -1,9 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = streamToString;
 /**
  * Converts a Readable Stream to a string.
  * @param stream - Input stream
  * @returns Promise resolving to the string content
  */
-export default async function streamToString(stream) {
+async function streamToString(stream) {
     return new Promise((resolve, reject) => {
         let data = '';
         stream.on('data', chunk => (data += chunk));

package/package.json

@@ -3,7 +3,7 @@
   "main": "dist/index.js",
   "name": "@carlgo11/simpleimfparser",
   "description": "Simple IMF parser",
-  "version": "0.0.1a",
+  "version": "0.0.1",
   "license": "GPL-3.0",
   "author": "Carlgo11",
   "repository": {
@@ -20,11 +20,9 @@
     "build": "npx tsc"
   },
   "private": false,
-  "dependencies": {
-    "@types/node": "^22.10.7"
-  },
   "devDependencies": {
     "@faker-js/faker": "^9.4.0",
+    "@types/node": "^22.10.7",
     "ts-node": "^10.9.2",
     "tsx": "^4.19.2",
     "typescript": "^5.7.3"

package/src/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseEmail;
+const Email_1 = require("./types/Email");
+const parseEnvelope_1 = __importDefault(require("./parsers/parseEnvelope"));
+const parseMessage_1 = __importDefault(require("./parsers/parseMessage"));
+async function parseEmail(rawData, envelope) {
+    const parsedEnvelope = await (0, parseEnvelope_1.default)(envelope);
+    const { headers, body } = await (0, parseMessage_1.default)(rawData);
+    return new Email_1.Email(parsedEnvelope, headers, body);
+}

package/src/index.ts

@@ -1,7 +1,7 @@
 import { Readable } from 'node:stream';
-import { Email } from './types/Email.js';
-import parseEnvelope from './parsers/parseEnvelope.js';
-import parseMessage from './parsers/parseMessage.js';
+import { Email } from './types/Email';
+import parseEnvelope from './parsers/parseEnvelope';
+import parseMessage from './parsers/parseMessage';
 
 export default async function parseEmail(
   rawData: string | Readable,

package/src/parsers/parseEnvelope.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseEnvelope;
+/**
+ * Parses envelope metadata from the SMTP transaction.
+ * @param envelope - Envelope data object
+ * @returns Parsed Envelope object
+ */
+async function parseEnvelope(envelope) {
+    // TODO: Implement envelope parsing logic
+    return envelope;
+}

package/src/parsers/parseEnvelope.ts

@@ -1,4 +1,4 @@
-import Envelope from '../types/Envelope.js';
+import Envelope from '../types/Envelope';
 
 /**
  * Parses envelope metadata from the SMTP transaction.

package/src/parsers/parseHeaders.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseHeaders;
+/**
+ * Parses headers from a raw IMF header string.
+ * @param rawHeaders - The raw headers as a string
+ * @returns A dictionary of headers (handling duplicates)
+ */
+function parseHeaders(rawHeaders) {
+    const headers = {};
+    const lines = rawHeaders.split(/\r\n|\n/);
+    let currentKey = null;
+    let currentValue = '';
+    for (const line of lines) {
+        if (line.startsWith(' ') || line.startsWith('\t')) {
+            // Handle folded headers (continuation lines)
+            if (currentKey) {
+                if (Array.isArray(headers[currentKey])) {
+                    headers[currentKey][headers[currentKey].length - 1] += ' ' + line.trim();
+                }
+                else {
+                    headers[currentKey] += ' ' + line.trim();
+                }
+            }
+            else {
+                throw new Error('Header folding found without a preceding header field.');
+            }
+        }
+        else {
+            // Store previous header before starting a new one
+            if (currentKey) {
+                if (headers[currentKey]) {
+                    if (Array.isArray(headers[currentKey])) {
+                        headers[currentKey].push(currentValue);
+                    }
+                    else {
+                        headers[currentKey] = [headers[currentKey], currentValue];
+                    }
+                }
+                else {
+                    headers[currentKey] = currentValue;
+                }
+            }
+            // Extract new header key-value pair
+            const match = line.match(/^([!#$%&'*+\-.0-9A-Z^_`a-z|~]+):\s*(.*)$/);
+            if (!match) {
+                throw new Error(`Invalid header format: "${line}"`);
+            }
+            currentKey = match[1].toLowerCase(); // Convert key to lowercase
+            currentValue = match[2];
+        }
+    }
+    // Store the last header
+    if (currentKey) {
+        if (headers[currentKey]) {
+            if (Array.isArray(headers[currentKey])) {
+                headers[currentKey].push(currentValue);
+            }
+            else {
+                headers[currentKey] = [headers[currentKey], currentValue];
+            }
+        }
+        else {
+            headers[currentKey] = currentValue;
+        }
+    }
+    return headers;
+}

package/src/parsers/parseMessage.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = parseMessage;
+const node_stream_1 = require("node:stream");
+const parseHeaders_1 = __importDefault(require("./parseHeaders"));
+const streamToString_1 = __importDefault(require("../utils/streamToString"));
+/**
+ * Parses the raw email message (headers + body).
+ * @param rawData - Raw IMF email (string or stream)
+ * @returns Parsed email components
+ */
+async function parseMessage(rawData) {
+    let rawEmail;
+    if (typeof rawData === 'string') {
+        rawEmail = rawData;
+    }
+    else if (rawData instanceof node_stream_1.Readable) {
+        rawEmail = await (0, streamToString_1.default)(rawData);
+    }
+    else {
+        throw new TypeError('Invalid rawData type. Expected a string or a Readable stream.');
+    }
+    const headerBoundary = rawEmail.indexOf('\r\n\r\n');
+    const rawHeaders = rawEmail.slice(0, headerBoundary);
+    const body = rawEmail.slice(headerBoundary + 4);
+    if (body.length === 0) {
+        throw new Error('Header and Body must be separated by \\r\\n\\r\\n');
+    }
+    return {
+        headers: (0, parseHeaders_1.default)(rawHeaders),
+        body,
+    };
+}

package/src/parsers/parseMessage.ts

@@ -1,6 +1,6 @@
 import { Readable } from 'node:stream';
-import parseHeaders from './parseHeaders.js';
-import streamToString from '../utils/streamToString.js';
+import parseHeaders from './parseHeaders';
+import streamToString from '../utils/streamToString';
 
 /**
  * Parses the raw email message (headers + body).

package/src/types/Attachment.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/Email.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Email = void 0;
+class Email {
+    envelope;
+    headers;
+    body;
+    attachments;
+    constructor(envelope, headers, body, attachments) {
+        this.envelope = envelope;
+        this.headers = headers;
+        this.body = body;
+        this.attachments = attachments || [];
+    }
+    /**
+     * Get a header value (case-insensitive).
+     */
+    getHeader(name) {
+        return this.headers[name.toLowerCase()];
+    }
+    /**
+     * Add or update a header.
+     */
+    addHeader(name, value) {
+        const key = name.toLowerCase();
+        if (this.headers[key]) {
+            if (Array.isArray(this.headers[key])) {
+                this.headers[key].push(value);
+            }
+            else {
+                this.headers[key] = [this.headers[key], value];
+            }
+        }
+        else {
+            this.headers[key] = value;
+        }
+    }
+    /**
+     * Remove a header.
+     */
+    removeHeader(name) {
+        delete this.headers[name.toLowerCase()];
+    }
+    /**
+     * Get the email body (prefers text, fallback to HTML).
+     */
+    getBody() {
+        return this.body || '';
+    }
+    toString() {
+        let _headers = '';
+        Object.entries(this.headers).forEach(([k, v]) => _headers += `${camelize(k)}: ${v}\r\n`);
+        return `${_headers}\r\n\r\n${this.body}`;
+    }
+}
+exports.Email = Email;
+function camelize(str) {
+    return str.replace(/(\w)(\w*)/g, function (g0, g1, g2) { return g1.toUpperCase() + g2.toLowerCase(); });
+}

package/src/types/Email.ts

@@ -1,4 +1,4 @@
-import Envelope from './Envelope.js';
+import Envelope from './Envelope';
 
 export class Email {
   envelope: Envelope;

package/src/types/Envelope.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/Envelope.ts

@@ -1,4 +1,4 @@
-import Sender from './Sender.js';
+import Sender from './Sender';
 
 export default interface Envelope {
   id: string;

package/src/types/Sender.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/utils/streamToString.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = streamToString;
+/**
+ * Converts a Readable Stream to a string.
+ * @param stream - Input stream
+ * @returns Promise resolving to the string content
+ */
+async function streamToString(stream) {
+    return new Promise((resolve, reject) => {
+        let data = '';
+        stream.on('data', chunk => (data += chunk));
+        stream.on('end', () => resolve(data));
+        stream.on('error', reject);
+    });
+}

package/test/index.test.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const faker_1 = require("@faker-js/faker");
+const node_assert_1 = __importDefault(require("node:assert"));
+const src_1 = __importDefault(require("../src"));
+const node_stream_1 = require("node:stream");
+(0, node_test_1.describe)('simpleIMFParser', () => {
+    (0, node_test_1.it)('Should parse valid message (string)', async () => {
+        const headers = {
+            'Subject': faker_1.faker.lorem.sentence(),
+            'MESSAGE-ID': `${faker_1.faker.string.uuid()}@${faker_1.faker.internet.domainName()}`,
+            'from': `"${faker_1.faker.person.fullName()}" <${faker_1.faker.internet.email()}>`,
+            'To': `${faker_1.faker.person.fullName()} <${faker_1.faker.internet.email()}>`,
+        };
+        const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
+        const body = faker_1.faker.lorem.paragraphs(5, '\r\n');
+        const full_email = `${headersString}\r\n\r\n${body}`;
+        const email = await (0, src_1.default)(full_email, {});
+        node_assert_1.default.ok(email.toString());
+    });
+    (0, node_test_1.it)('Should parse valid message (stream)', async () => {
+        const headers = {
+            'from': `"${faker_1.faker.person.fullName()}" <${faker_1.faker.internet.email()}>`,
+            'To': `${faker_1.faker.person.fullName()} <${faker_1.faker.internet.email({ allowSpecialCharacters: true })}>`,
+            'Subject': faker_1.faker.lorem.sentence(),
+            'MESSAGE-ID': `${faker_1.faker.string.uuid()}@${faker_1.faker.internet.domainName()}`,
+        };
+        const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
+        const body = faker_1.faker.lorem.paragraphs(5, '\r\n');
+        const full_email = `${headersString}\r\n\r\n${body}`;
+        const email = await (0, src_1.default)(node_stream_1.Readable.from(full_email), {});
+        node_assert_1.default.ok(email.toString());
+    });
+});

package/test/parsers/parseHeaders.test.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const faker_1 = require("@faker-js/faker");
+const node_assert_1 = __importDefault(require("node:assert"));
+const parseHeaders_1 = __importDefault(require("../../src/parsers/parseHeaders"));
+(0, node_test_1.describe)('Parse Headers', () => {
+    (0, node_test_1.it)('Various case header names', () => {
+        const headers = {
+            'subject': faker_1.faker.lorem.sentence(),
+            'MESSAGE-ID': `${faker_1.faker.string.uuid()}@${faker_1.faker.internet.domainName()}`,
+            'FroM': `${faker_1.faker.person.fullName()} <${faker_1.faker.internet.email()}>`,
+            'to': `${faker_1.faker.person.fullName()} <${faker_1.faker.internet.email()}>`,
+        };
+        const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
+        node_assert_1.default.ok((0, parseHeaders_1.default)(headersString));
+    });
+    /*
+      it('Extra text after email address', async () => {
+        const headers: Record<string, string> = {
+          'To': `${faker.person.fullName()} <${faker.internet.email()}> ${faker.lorem.sentence()}`,
+        };
+        const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
+        await assert.rejects(async () => parseHeaders(headersString));
+      });*/
+    (0, node_test_1.it)('Missing : separator.', async () => {
+        await node_assert_1.default.rejects(async () => (0, parseHeaders_1.default)(`Subject ${faker_1.faker.lorem.sentence()}`));
+    });
+});

package/test/parsers/parseMessage.test.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_test_1 = require("node:test");
+const faker_1 = require("@faker-js/faker");
+const node_assert_1 = __importDefault(require("node:assert"));
+const parseMessage_1 = __importDefault(require("../../src/parsers/parseMessage"));
+(0, node_test_1.describe)('Parse Message', () => {
+    (0, node_test_1.it)('Should parse valid message', async () => {
+        const headers = {
+            'Subject': faker_1.faker.lorem.sentence(),
+            'Message-ID': `${faker_1.faker.string.uuid()}@${faker_1.faker.internet.domainName()}`,
+            'From': `"${faker_1.faker.person.fullName()}" <${faker_1.faker.internet.email()}>`,
+            'To': `${faker_1.faker.person.fullName()} <${faker_1.faker.internet.email()}>`,
+        };
+        const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
+        const body = faker_1.faker.lorem.paragraphs(5).replace('\n', '\r\n');
+        const full_email = `${headersString}\r\n\r\n${body}`;
+        node_assert_1.default.ok(await (0, parseMessage_1.default)(full_email));
+    });
+    (0, node_test_1.it)('Should reject invalid message divider', async () => {
+        const headers = {
+            'Subject': faker_1.faker.lorem.sentence(),
+            'Message-ID': `${faker_1.faker.string.uuid()}@${faker_1.faker.internet.domainName()}`,
+            'From': `${faker_1.faker.person.fullName()} <${faker_1.faker.internet.email()}>`,
+            'To': `${faker_1.faker.person.fullName()} <${faker_1.faker.internet.email()}>`,
+        };
+        const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
+        const body = faker_1.faker.lorem.paragraphs(5).replace('\n', '\r\n');
+        const full_email = `${headersString}\r\n${body}`;
+        await node_assert_1.default.rejects(() => (0, parseMessage_1.default)(full_email));
+    });
+});

package/tsconfig.json

@@ -1,12 +1,13 @@
 {
   "compilerOptions": {
-    "target": "ES2024",
-    "module": "nodenext",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "outDir": "./dist"
+    "target": "ES2024",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    "skipLibCheck": true,                                 /* Skip type checking all .d.ts files. */
+    "outDir": "./dist",
+
   },
   "include": [
     "./src/**/*",

package/README.md

@@ -1,59 +0,0 @@
-# Simple IMF Parser
-
-A TypeScript library for parsing Internet Message Format (IMF) emails, extracting headers, envelope details, and message bodies while providing useful utilities for email manipulation.
-
-## Features
-- Parses raw IMF emails from **string** or **stream** input
-- Supports **header parsing** (including multi-line folding)
-- Provides a structured **Email class** with helper functions:
-  - `getHeader(name)` – Retrieve a header
-  - `addHeader(name, value)` – Add a new header
-  - `removeHeader(name)` – Remove a header
-  - `getBody()` – Get the email body
-- Handles **multiple headers** with the same name (e.g., `Received` headers)
-- Supports **UTF-8 names & addresses** (RFC 6532)
-
-## Installation
-```sh
-npm install @carlgo11/simpleimfparser
-```
-
-## Usage
-
-### Parsing an Email
-```ts
-import parseEmail from '@carlgo11/simpleimfparser';
-import fs from 'fs';
-
-(async () => {
-  const rawData = fs.readFileSync('test-email.eml', 'utf-8');
-  const envelope = {
-    from: 'alice@example.com',
-    to: ['bob@example.com'],
-    senderIP: '192.168.1.1'
-  };
-
-  const email = await parseEmail(rawData, envelope);
-  
-  console.log('Subject:', email.getHeader('subject'));
-  console.log('Body:', email.getBody());
-})();
-```
-
-### Working with Headers
-```ts
-email.addHeader('X-Custom-Header', 'Hello World');
-email.removeHeader('Received');
-console.log(email.getHeader('from'));
-```
-
-### Extracting Envelope Details
-```ts
-console.log(email.envelope.senderIP); // 192.168.1.1
-console.log(email.envelope.to); // ['bob@example.com']
-```
-
-### Recompiling Email Object to IMF Format
-```ts
-email.toString();
-```