@carlgo11/simpleimfparser 0.0.1-a → 0.0.2

package/dist/types/Email.js

@@ -1,55 +0,0 @@
-export 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}`;
-    }
-}
-function camelize(str) {
-    return str.replace(/(\w)(\w*)/g, function (g0, g1, g2) { return g1.toUpperCase() + g2.toLowerCase(); });
-}

package/dist/types/Envelope.js

@@ -1 +0,0 @@
-export {};

package/dist/types/Sender.js

@@ -1 +0,0 @@
-export {};

package/dist/utils/streamToString.js

@@ -1,13 +0,0 @@
-/**
- * Converts a Readable Stream to a string.
- * @param stream - Input stream
- * @returns Promise resolving to the string content
- */
-export default 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/src/index.ts

@@ -1,14 +0,0 @@
-import { Readable } from 'node:stream';
-import { Email } from './types/Email.js';
-import parseEnvelope from './parsers/parseEnvelope.js';
-import parseMessage from './parsers/parseMessage.js';
-
-export default async function parseEmail(
-  rawData: string | Readable,
-  envelope: object,
-): Promise<Email> {
-  const parsedEnvelope = await parseEnvelope(envelope);
-  const { headers, body } = await parseMessage(rawData);
-
-  return new Email(parsedEnvelope, headers, body);
-}

package/src/parsers/parseHeaders.ts

@@ -1,65 +0,0 @@
-/**
- * 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: string): Record<string, string | string[]> {
-  const headers: Record<string, string | string[]> = {};
-  const lines = rawHeaders.split(/\r\n|\n/);
-
-  let currentKey: string | null = null;
-  let currentValue: string = '';
-
-  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] as string[])[(headers[currentKey] as string[]).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] as string[]).push(currentValue);
-          } else {
-            headers[currentKey] = [headers[currentKey] as string, 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] as string[]).push(currentValue);
-      } else {
-        headers[currentKey] = [headers[currentKey] as string, currentValue];
-      }
-    } else {
-      headers[currentKey] = currentValue;
-    }
-  }
-
-  return headers;
-}

package/src/parsers/parseMessage.ts

@@ -1,32 +0,0 @@
-import { Readable } from 'node:stream';
-import parseHeaders from './parseHeaders.js';
-import streamToString from '../utils/streamToString.js';
-
-/**
- * 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: string | Readable): Promise<{ headers: Record<string, string | string[]>, body: string }> {
-  let rawEmail: string;
-
-  if (typeof rawData === 'string') {
-    rawEmail = rawData;
-  } else if (rawData instanceof Readable) {
-    rawEmail = await streamToString(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: parseHeaders(rawHeaders),
-    body,
-  };
-}

package/src/types/Attachment.ts

@@ -1,6 +0,0 @@
-export default interface Attachment {
-  filename: string;
-  contentType: string;
-  size: number;
-  content: Buffer;
-}

package/src/types/Email.ts

@@ -1,77 +0,0 @@
-import Envelope from './Envelope.js';
-
-export class Email {
-  envelope: Envelope;
-  headers: Record<string, string | string[]>;
-  body: string;
-  attachments?: Attachment[];
-
-  constructor(
-    envelope: Envelope,
-    headers: Record<string, string | string[]>,
-    body: string,
-    attachments?: Attachment[],
-  ) {
-    this.envelope = envelope;
-    this.headers = headers;
-    this.body = body;
-    this.attachments = attachments || [];
-  }
-
-  /**
-   * Get a header value (case-insensitive).
-   */
-  getHeader(name: string): string | string[] | undefined {
-    return this.headers[name.toLowerCase()];
-  }
-
-  /**
-   * Add or update a header.
-   */
-  addHeader(name: string, value: string): void {
-    const key = name.toLowerCase();
-    if (this.headers[key]) {
-      if (Array.isArray(this.headers[key])) {
-        (this.headers[key] as string[]).push(value);
-      } else {
-        this.headers[key] = [this.headers[key] as string, value];
-      }
-    } else {
-      this.headers[key] = value;
-    }
-  }
-
-  /**
-   * Remove a header.
-   */
-  removeHeader(name: string): void {
-    delete this.headers[name.toLowerCase()];
-  }
-
-  /**
-   * Get the email body (prefers text, fallback to HTML).
-   */
-  getBody(): string {
-    return this.body || '';
-  }
-
-  toString(): string {
-    let _headers = ''
-    Object.entries(this.headers).forEach(([k, v]) => _headers += `${camelize(k)}: ${v}\r\n`)
-
-
-    return `${_headers}\r\n\r\n${this.body}`;
-  }
-}
-
-function camelize(str: string):string {
-  return str.replace(/(\w)(\w*)/g,
-    function(g0,g1,g2){return g1.toUpperCase() + g2.toLowerCase();});
-}
-
-export interface Attachment {
-  filename: string;
-  contentType: string;
-  size: number;
-  content: Buffer;
-}

package/src/types/Envelope.ts

@@ -1,9 +0,0 @@
-import Sender from './Sender.js';
-
-export default interface Envelope {
-  id: string;
-  from: string;
-  to: string[];
-  receivedTime: Date;
-  sender: Sender;
-}

package/src/types/Sender.ts

@@ -1,10 +0,0 @@
-export default interface Sender {
-  ip: string;
-  rDNS?: string;
-  helo?: string;
-  tls: boolean;
-  authenticated?: {
-    method: string;
-    username?: string;
-  };
-}

package/src/utils/streamToString.ts

@@ -1,15 +0,0 @@
-import { Readable } from 'node:stream';
-
-/**
- * Converts a Readable Stream to a string.
- * @param stream - Input stream
- * @returns Promise resolving to the string content
- */
-export default async function streamToString(stream: Readable): Promise<string> {
-  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.ts

@@ -1,40 +0,0 @@
-import { describe, it } from 'node:test';
-import { faker } from '@faker-js/faker';
-import assert from 'node:assert';
-import parseEmail from '../src';
-import { Readable } from 'node:stream';
-
-describe('simpleIMFParser', () => {
-  it('Should parse valid message (string)', async () => {
-    const headers: Record<string, string> = {
-      'Subject': faker.lorem.sentence(),
-      'MESSAGE-ID': `${faker.string.uuid()}@${faker.internet.domainName()}`,
-      'from': `"${faker.person.fullName()}" <${faker.internet.email()}>`,
-      'To': `${faker.person.fullName()} <${faker.internet.email()}>`,
-    };
-    const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
-    const body = faker.lorem.paragraphs(5, '\r\n');
-
-    const full_email = `${headersString}\r\n\r\n${body}`;
-    const email = await parseEmail(full_email, {});
-    assert.ok(email.toString());
-  });
-
-   it('Should parse valid message (stream)', async () => {
-    const headers: Record<string, string> = {
-      'from': `"${faker.person.fullName()}" <${faker.internet.email()}>`,
-      'To': `${faker.person.fullName()} <${faker.internet.email({allowSpecialCharacters: true})}>`,
-      'Subject': faker.lorem.sentence(),
-      'MESSAGE-ID': `${faker.string.uuid()}@${faker.internet.domainName()}`,
-    };
-    const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
-    const body = faker.lorem.paragraphs(5, '\r\n');
-
-    const full_email = `${headersString}\r\n\r\n${body}`;
-
-    const email = await parseEmail(Readable.from(full_email), {});
-    assert.ok(email.toString());
-  });
-
-
-});

package/test/parsers/parseHeaders.test.ts

@@ -1,32 +0,0 @@
-import test, { describe, it } from 'node:test';
-import { faker } from '@faker-js/faker';
-import assert from 'node:assert';
-import parseMessage from '../../src/parsers/parseMessage';
-import parseHeaders from '../../src/parsers/parseHeaders';
-
-
-
-describe('Parse Headers', () => {
-  it('Various case header names', () => {
-    const headers: Record<string, string> = {
-      'subject': faker.lorem.sentence(),
-      'MESSAGE-ID': `${faker.string.uuid()}@${faker.internet.domainName()}`,
-      'FroM': `${faker.person.fullName()} <${faker.internet.email()}>`,
-      'to': `${faker.person.fullName()} <${faker.internet.email()}>`,
-    };
-    const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
-    assert.ok(parseHeaders(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));
-  });*/
-
-  it('Missing : separator.', async () => {
-    await assert.rejects(async () => parseHeaders(`Subject ${faker.lorem.sentence()}`));
-  });
-});

package/test/parsers/parseMessage.test.ts

@@ -1,34 +0,0 @@
-import { describe, it } from 'node:test';
-import { faker } from '@faker-js/faker';
-import assert from 'node:assert';
-import parseMessage from '../../src/parsers/parseMessage';
-
-describe('Parse Message', () => {
-  it('Should parse valid message', async () => {
-    const headers: Record<string, string> = {
-      'Subject': faker.lorem.sentence(),
-      'Message-ID': `${faker.string.uuid()}@${faker.internet.domainName()}`,
-      'From': `"${faker.person.fullName()}" <${faker.internet.email()}>`,
-      'To': `${faker.person.fullName()} <${faker.internet.email()}>`,
-    };
-    const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
-    const body = faker.lorem.paragraphs(5).replace('\n', '\r\n');
-
-    const full_email = `${headersString}\r\n\r\n${body}`;
-    assert.ok(await parseMessage(full_email));
-  });
-
-  it('Should reject invalid message divider', async () => {
-    const headers: Record<string, string> = {
-      'Subject': faker.lorem.sentence(),
-      'Message-ID': `${faker.string.uuid()}@${faker.internet.domainName()}`,
-      'From': `${faker.person.fullName()} <${faker.internet.email()}>`,
-      'To': `${faker.person.fullName()} <${faker.internet.email()}>`,
-    };
-    const headersString = Object.entries(headers).map(([key, value]) => `${key}: ${value}`).join('\r\n');
-    const body = faker.lorem.paragraphs(5).replace('\n', '\r\n');
-
-    const full_email = `${headersString}\r\n${body}`;
-    await assert.rejects(() => parseMessage(full_email));
-  });
-});

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2024",
-    "module": "nodenext",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "skipLibCheck": true,
-    "outDir": "./dist"
-  },
-  "include": [
-    "./src/**/*",
-    "./src/*"
-  ]
-}