apeframework 0.0.0-dev.2 → 0.0.0-dev.20

package/logger/adapters/stdio/StdioLogger.ts

@@ -0,0 +1,89 @@
+import pino from 'pino'
+import pretty from 'pino-pretty'
+import { Level } from '../../Level'
+import { Logger } from '../../Logger'
+import type { Logger as PinoLogger } from 'pino'
+
+class StdioLogger extends Logger {
+  private readonly logger: PinoLogger
+
+  private readonly context: object | undefined
+
+  public constructor(params?: {
+    pretty?: boolean,
+    level?: Level,
+    context?: object,
+  }) {
+    super()
+
+    const stream = params?.pretty
+      ? pretty()
+      : pino.destination(process.stdout.fd)
+
+    this.logger = pino({
+      enabled: params?.level !== Level.OFF,
+      level: params?.level ?? Level.INFO,
+      messageKey: 'message',
+      formatters: {
+        level(label, number) {
+          return {
+            level: label,
+            ...params?.pretty
+              ? {}
+              : { severity: number },
+          }
+        },
+        bindings: () => { return {} },
+      },
+    }, stream)
+
+    this.context = params?.context
+  }
+
+  public trace(message: string, data?: unknown): void {
+    this.logger.trace(this.getPayload(message, data))
+  }
+
+  public debug(message: string, data?: unknown): void {
+    this.logger.debug(this.getPayload(message, data))
+  }
+
+  public info(message: string, data?: unknown): void {
+    this.logger.info(this.getPayload(message, data))
+  }
+
+  public warn(message: string, data?: unknown): void {
+    this.logger.warn(this.getPayload(message, data))
+  }
+
+  public error(message: string, data?: unknown): void {
+    this.logger.error(this.getPayload(message, data))
+  }
+
+  public fatal(message: string, data?: unknown): void {
+    this.logger.fatal(this.getPayload(message, data))
+  }
+
+  public async close(): Promise<void> {
+    return new Promise((resolve, reject) => {
+      this.logger.flush((error) => {
+        if (error) {
+          reject(error)
+        }
+        resolve()
+      })
+    })
+  }
+
+  private getPayload(message: string, data?: unknown): object {
+    return {
+      ...this.context,
+      message,
+      data,
+    }
+  }
+}
+
+export {
+  StdioLogger,
+}

package/mailer/Address.d.ts

@@ -0,0 +1,5 @@
+interface Address {
+    email: string;
+    name?: string;
+}
+export { type Address, };

package/mailer/Address.ts

@@ -0,0 +1,8 @@
+interface Address {
+  email: string,
+  name?: string,
+}
+
+export {
+  type Address,
+}

package/mailer/Attachment.d.ts

@@ -0,0 +1,7 @@
+import type { Readable } from 'stream';
+interface Attachment {
+    fileName: string;
+    contentType?: string;
+    content: Buffer | Readable | string;
+}
+export { type Attachment, };

package/mailer/Attachment.ts

@@ -0,0 +1,11 @@
+import type { Readable } from 'stream'
+
+interface Attachment {
+  fileName: string,
+  contentType?: string,
+  content: Buffer | Readable | string,
+}
+
+export {
+  type Attachment,
+}

package/mailer/Event.d.ts

@@ -0,0 +1,16 @@
+import type { Location } from './Location';
+import type { Method } from './Method';
+interface Event {
+    fileName?: string;
+    method: Method;
+    id?: string;
+    start: Date;
+    end: Date;
+    allDay?: boolean;
+    name: string;
+    description?: string;
+    url?: string;
+    location?: Location;
+    attachments?: string[];
+}
+export { type Event, };

package/mailer/Event.ts

@@ -0,0 +1,20 @@
+import type { Location } from './Location'
+import type { Method } from './Method'
+
+interface Event {
+  fileName?: string,
+  method: Method,
+  id?: string,
+  start: Date,
+  end: Date,
+  allDay?: boolean,
+  name: string,
+  description?: string,
+  url?: string,
+  location?: Location,
+  attachments?: string[],
+}
+
+export {
+  type Event,
+}

package/mailer/List.d.ts

@@ -0,0 +1,7 @@
+interface List {
+    id?: string;
+    help?: string;
+    subscribe?: string;
+    unsubscribe?: string;
+}
+export { type List, };

package/mailer/List.ts

@@ -0,0 +1,10 @@
+interface List {
+  id?: string,
+  help?: string,
+  subscribe?: string,
+  unsubscribe?: string,
+}
+
+export {
+  type List,
+}

package/mailer/Location.d.ts

@@ -0,0 +1,9 @@
+interface Location {
+    name: string;
+    address?: string;
+    geo?: {
+        latitude: number;
+        longitude: number;
+    };
+}
+export { type Location, };

package/mailer/Location.ts

@@ -0,0 +1,12 @@
+interface Location {
+  name: string,
+  address?: string,
+  geo?: {
+    latitude: number,
+    longitude: number,
+  },
+}
+
+export {
+  type Location,
+}

package/mailer/Mail.d.ts

@@ -0,0 +1,19 @@
+import type { Address } from './Address';
+import type { Attachment } from './Attachment';
+import type { Event } from './Event';
+import type { List } from './List';
+interface Mail {
+    from: Address;
+    sender?: Address;
+    replyTo?: Address;
+    to: Address[];
+    cc?: Address[];
+    bcc?: Address[];
+    subject: string;
+    text: string;
+    html?: string;
+    attachments?: Attachment[];
+    event?: Event;
+    list?: List;
+}
+export { type Mail, };

package/mailer/Mail.ts

@@ -0,0 +1,23 @@
+import type { Address } from './Address'
+import type { Attachment } from './Attachment'
+import type { Event } from './Event'
+import type { List } from './List'
+
+interface Mail {
+  from: Address,
+  sender?: Address,
+  replyTo?: Address,
+  to: Address[],
+  cc?: Address[],
+  bcc?: Address[],
+  subject: string,
+  text: string,
+  html?: string,
+  attachments?: Attachment[],
+  event?: Event,
+  list?: List,
+}
+
+export {
+  type Mail,
+}

package/mailer/Mailer.d.ts

@@ -0,0 +1,7 @@
+import type { Mail } from './Mail';
+declare abstract class Mailer {
+    send(mail: Mail): Promise<string>;
+    abstract sendMail(mail: Mail): Promise<string>;
+    abstract close(): Promise<void>;
+}
+export { Mailer, };

package/mailer/Mailer.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Mailer = void 0;
+const validateAddressEmail_1 = require("./validateAddressEmail");
+const validateEventAttachmentUrl_1 = require("./validateEventAttachmentUrl");
+const validateEventGeolocation_1 = require("./validateEventGeolocation");
+const validateEventUrl_1 = require("./validateEventUrl");
+const validateListUrl_1 = require("./validateListUrl");
+class Mailer {
+    async send(mail) {
+        (0, validateAddressEmail_1.validateAddressEmail)(mail.from.email);
+        if (mail.sender) {
+            (0, validateAddressEmail_1.validateAddressEmail)(mail.sender.email);
+        }
+        if (mail.replyTo) {
+            (0, validateAddressEmail_1.validateAddressEmail)(mail.replyTo.email);
+        }
+        mail.to.forEach((address) => {
+            (0, validateAddressEmail_1.validateAddressEmail)(address.email);
+        });
+        if (mail.cc) {
+            mail.cc.forEach((address) => {
+                (0, validateAddressEmail_1.validateAddressEmail)(address.email);
+            });
+        }
+        if (mail.bcc) {
+            mail.bcc.forEach((address) => {
+                (0, validateAddressEmail_1.validateAddressEmail)(address.email);
+            });
+        }
+        if (mail.event?.url) {
+            (0, validateEventUrl_1.validateEventUrl)(mail.event.url);
+        }
+        if (mail.event?.location?.geo) {
+            (0, validateEventGeolocation_1.validateEventGeolocation)(mail.event.location.geo.latitude, mail.event.location.geo.longitude);
+        }
+        if (mail.event?.attachments) {
+            mail.event.attachments.forEach((attachment) => {
+                (0, validateEventAttachmentUrl_1.validateEventAttachmentUrl)(attachment);
+            });
+        }
+        if (mail.list) {
+            Object.entries(mail.list).forEach(([property, url]) => {
+                (0, validateListUrl_1.validateListUrl)(property, url);
+            });
+        }
+        return this.sendMail(mail);
+    }
+}
+exports.Mailer = Mailer;

package/mailer/Mailer.ts

@@ -0,0 +1,69 @@
+import { validateAddressEmail } from './validateAddressEmail'
+import { validateEventAttachmentUrl } from './validateEventAttachmentUrl'
+import { validateEventGeolocation } from './validateEventGeolocation'
+import { validateEventUrl } from './validateEventUrl'
+import { validateListUrl } from './validateListUrl'
+import type { Mail } from './Mail'
+
+abstract class Mailer {
+  public async send(mail: Mail): Promise<string> {
+    validateAddressEmail(mail.from.email)
+
+    if (mail.sender) {
+      validateAddressEmail(mail.sender.email)
+    }
+
+    if (mail.replyTo) {
+      validateAddressEmail(mail.replyTo.email)
+    }
+
+    mail.to.forEach((address) => {
+      validateAddressEmail(address.email)
+    })
+
+    if (mail.cc) {
+      mail.cc.forEach((address) => {
+        validateAddressEmail(address.email)
+      })
+    }
+
+    if (mail.bcc) {
+      mail.bcc.forEach((address) => {
+        validateAddressEmail(address.email)
+      })
+    }
+
+    if (mail.event?.url) {
+      validateEventUrl(mail.event.url)
+    }
+
+    if (mail.event?.location?.geo) {
+      validateEventGeolocation(
+        mail.event.location.geo.latitude,
+        mail.event.location.geo.longitude,
+      )
+    }
+
+    if (mail.event?.attachments) {
+      mail.event.attachments.forEach((attachment) => {
+        validateEventAttachmentUrl(attachment)
+      })
+    }
+
+    if (mail.list) {
+      Object.entries(mail.list).forEach(([property, url]: [string, string]) => {
+        validateListUrl(property, url)
+      })
+    }
+
+    return this.sendMail(mail)
+  }
+
+  public abstract sendMail(mail: Mail): Promise<string>
+
+  public abstract close(): Promise<void>
+}
+
+export {
+  Mailer,
+}

package/mailer/Method.d.ts

@@ -0,0 +1,5 @@
+declare enum Method {
+    PUBLISH = "PUBLISH",
+    CANCEL = "CANCEL"
+}
+export { Method, };

package/mailer/Method.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Method = void 0;
+var Method;
+(function (Method) {
+    Method["PUBLISH"] = "PUBLISH";
+    Method["CANCEL"] = "CANCEL";
+})(Method || (exports.Method = Method = {}));

package/mailer/Method.ts

@@ -0,0 +1,8 @@
+enum Method {
+  PUBLISH = 'PUBLISH',
+  CANCEL = 'CANCEL',
+}
+
+export {
+  Method,
+}

package/mailer/adapters/noop/NoopMailer.d.ts

@@ -0,0 +1,7 @@
+import { Mailer } from '../../Mailer';
+import type { Mail } from '../../Mail';
+declare class NoopMailer extends Mailer {
+    sendMail(mail: Mail): Promise<string>;
+    close(): Promise<void>;
+}
+export { NoopMailer, };

package/mailer/adapters/noop/NoopMailer.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoopMailer = void 0;
+const crypto_1 = require("crypto");
+const Mailer_1 = require("../../Mailer");
+class NoopMailer extends Mailer_1.Mailer {
+    async sendMail(mail) {
+        return `${(0, crypto_1.randomUUID)()}@${mail.from.email.split('@')[1]}`;
+    }
+    async close() { }
+}
+exports.NoopMailer = NoopMailer;

package/mailer/adapters/noop/NoopMailer.ts

@@ -0,0 +1,15 @@
+import { randomUUID } from 'crypto'
+import { Mailer } from '../../Mailer'
+import type { Mail } from '../../Mail'
+
+class NoopMailer extends Mailer {
+  public async sendMail(mail: Mail): Promise<string> {
+    return `${randomUUID()}@${mail.from.email.split('@')[1]}`
+  }
+
+  public async close(): Promise<void> { }
+}
+
+export {
+  NoopMailer,
+}

package/mailer/adapters/smtp/SmtpMailer.d.ts

@@ -0,0 +1,18 @@
+import { Mailer } from '../../Mailer';
+import type { Tls } from '../../../tls/Tls';
+import type { Mail } from '../../Mail';
+declare class SmtpMailer extends Mailer {
+    private readonly transporter;
+    constructor(params: {
+        host: string;
+        port: number;
+        secure?: boolean;
+        tls?: Tls;
+        user?: string;
+        password?: string;
+        maxConnections?: number;
+    });
+    sendMail(mail: Mail): Promise<string>;
+    close(): Promise<void>;
+}
+export { SmtpMailer, };

package/mailer/adapters/smtp/SmtpMailer.js

@@ -0,0 +1,60 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmtpMailer = void 0;
+const nodemailer_1 = __importDefault(require("nodemailer"));
+const getTls_1 = require("../../../tls/getTls");
+const Mailer_1 = require("../../Mailer");
+const getIcalendar_1 = require("../../getIcalendar");
+const getAddress_1 = require("./getAddress");
+const getAddresses_1 = require("./getAddresses");
+const getAttachments_1 = require("./getAttachments");
+class SmtpMailer extends Mailer_1.Mailer {
+    transporter;
+    constructor(params) {
+        super();
+        this.transporter = nodemailer_1.default.createTransport({
+            host: params.host,
+            port: params.port,
+            secure: params.secure ?? false,
+            tls: (0, getTls_1.getTls)(params.tls),
+            auth: params.user || params.password
+                ? {
+                    user: params.user,
+                    pass: params.password,
+                }
+                : undefined,
+            pool: true,
+            maxConnections: params.maxConnections ?? 5,
+        });
+    }
+    async sendMail(mail) {
+        const result = await this.transporter.sendMail({
+            from: (0, getAddress_1.getAddress)(mail.from),
+            sender: (0, getAddress_1.getAddress)(mail.sender),
+            replyTo: (0, getAddress_1.getAddress)(mail.replyTo),
+            to: (0, getAddresses_1.getAddresses)(mail.to),
+            cc: (0, getAddresses_1.getAddresses)(mail.cc),
+            bcc: (0, getAddresses_1.getAddresses)(mail.bcc),
+            subject: mail.subject,
+            text: mail.text,
+            html: mail.html,
+            attachments: (0, getAttachments_1.getAttachments)(mail.attachments),
+            icalEvent: mail.event
+                ? {
+                    filename: mail.event.fileName ?? 'event.ics',
+                    method: mail.event.method,
+                    content: (0, getIcalendar_1.getIcalendar)(mail.event),
+                }
+                : undefined,
+            list: { ...mail.list },
+        });
+        return result.messageId.slice(1, -1);
+    }
+    async close() {
+        this.transporter.close();
+    }
+}
+exports.SmtpMailer = SmtpMailer;

package/mailer/adapters/smtp/SmtpMailer.ts

@@ -0,0 +1,74 @@
+import nodemailer from 'nodemailer'
+import { getTls } from '../../../tls/getTls'
+import { Mailer } from '../../Mailer'
+import { getIcalendar } from '../../getIcalendar'
+import { getAddress } from './getAddress'
+import { getAddresses } from './getAddresses'
+import { getAttachments } from './getAttachments'
+import type { Tls } from '../../../tls/Tls'
+import type { Mail } from '../../Mail'
+import type { Transporter } from 'nodemailer'
+
+class SmtpMailer extends Mailer {
+  private readonly transporter: Transporter
+
+  public constructor(params: {
+    host: string,
+    port: number,
+    secure?: boolean,
+    tls?: Tls,
+    user?: string,
+    password?: string,
+    maxConnections?: number,
+  }) {
+    super()
+
+    this.transporter = nodemailer.createTransport({
+      host: params.host,
+      port: params.port,
+      secure: params.secure ?? false,
+      tls: getTls(params.tls),
+      auth: params.user || params.password
+        ? {
+          user: params.user,
+          pass: params.password,
+        }
+        : undefined,
+      pool: true,
+      maxConnections: params.maxConnections ?? 5,
+    })
+  }
+
+  public async sendMail(mail: Mail): Promise<string> {
+    const result = await this.transporter.sendMail({
+      from: getAddress(mail.from),
+      sender: getAddress(mail.sender),
+      replyTo: getAddress(mail.replyTo),
+      to: getAddresses(mail.to),
+      cc: getAddresses(mail.cc),
+      bcc: getAddresses(mail.bcc),
+      subject: mail.subject,
+      text: mail.text,
+      html: mail.html,
+      attachments: getAttachments(mail.attachments),
+      icalEvent: mail.event
+        ? {
+          filename: mail.event.fileName ?? 'event.ics',
+          method: mail.event.method,
+          content: getIcalendar(mail.event),
+        }
+        : undefined,
+      list: { ...mail.list },
+    })
+
+    return result.messageId.slice(1, -1)
+  }
+
+  public async close(): Promise<void> {
+    this.transporter.close()
+  }
+}
+
+export {
+  SmtpMailer,
+}

package/mailer/adapters/smtp/getAddress.d.ts

@@ -0,0 +1,4 @@
+import type { Address } from '../../Address';
+import type { Address as NodemailerAddress } from 'nodemailer/lib/mailer';
+declare const getAddress: (address?: Address) => NodemailerAddress | undefined;
+export { getAddress, };

package/mailer/adapters/smtp/getAddress.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAddress = void 0;
+const getAddress = (address) => {
+    return address
+        ? {
+            address: address.email,
+            name: address.name ?? '',
+        }
+        : undefined;
+};
+exports.getAddress = getAddress;

package/mailer/adapters/smtp/getAddress.ts

@@ -0,0 +1,15 @@
+import type { Address } from '../../Address'
+import type { Address as NodemailerAddress } from 'nodemailer/lib/mailer'
+
+const getAddress = (address?: Address): NodemailerAddress | undefined => {
+  return address
+    ? {
+      address: address.email,
+      name: address.name ?? '',
+    }
+    : undefined
+}
+
+export {
+  getAddress,
+}

package/mailer/adapters/smtp/getAddresses.d.ts

@@ -0,0 +1,4 @@
+import type { Address } from '../../Address';
+import type { Address as NodemailerAddress } from 'nodemailer/lib/mailer';
+declare const getAddresses: (addresses?: Address[]) => NodemailerAddress[];
+export { getAddresses, };

package/mailer/adapters/smtp/getAddresses.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAddresses = void 0;
+const getAddress_1 = require("./getAddress");
+const getAddresses = (addresses) => {
+    return addresses
+        ? addresses
+            .map(getAddress_1.getAddress)
+            .filter((address) => {
+            return address !== undefined;
+        })
+        : [];
+};
+exports.getAddresses = getAddresses;

package/mailer/adapters/smtp/getAddresses.ts

@@ -0,0 +1,17 @@
+import { getAddress } from './getAddress'
+import type { Address } from '../../Address'
+import type { Address as NodemailerAddress } from 'nodemailer/lib/mailer'
+
+const getAddresses = (addresses?: Address[]): NodemailerAddress[] => {
+  return addresses
+    ? addresses
+      .map(getAddress)
+      .filter((address) => {
+        return address !== undefined
+      })
+    : []
+}
+
+export {
+  getAddresses,
+}