@develit-services/notification 0.0.12 → 0.0.14

package/@types/consts/audit-log.consts.ts

@@ -0,0 +1,7 @@
+export const AUDIT_LOG_EVENT_TYPES = [
+  'EMAIL',
+  'SMS',
+  'PUSH_NOTIFICATION',
+  'SLACK',
+] as const
+export type AuditLogEventType = (typeof AUDIT_LOG_EVENT_TYPES)[number]

package/@types/consts/index.ts

@@ -0,0 +1 @@
+export * from './audit-log.consts'

package/@types/database/audit-log.types.ts

@@ -0,0 +1,7 @@
+import type { tables } from '@services/notification/src/database/drizzle'
+import type { InferInsertModel, InferSelectModel } from 'drizzle-orm'
+
+export interface AuditLogSelectType
+  extends InferSelectModel<typeof tables.auditLog> {}
+export interface AuditLogInsertType
+  extends InferInsertModel<typeof tables.auditLog> {}

package/@types/database/index.ts

@@ -0,0 +1 @@
+export * from './audit-log.types'

package/@types/email/IEmail.connector.ts

@@ -0,0 +1,21 @@
+import type { IContact, IEmail } from '../../@types'
+
+export abstract class IEmailConnector {
+  static providerName: string
+
+  public API_KEY: string
+  public SMTP_HOST: string
+  public SENDER: IContact
+
+  protected constructor({
+    API_KEY,
+    SMTP_HOST,
+    SENDER,
+  }: { API_KEY: string; SMTP_HOST: string; SENDER: IContact }) {
+    this.API_KEY = API_KEY
+    this.SMTP_HOST = SMTP_HOST
+    this.SENDER = SENDER
+  }
+
+  abstract sendEmail(email: IEmail): Promise<Response | null>
+}

package/@types/email/IEmail.types.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod'
+
+export const iContactSchema = z.union([
+  z.string(),
+  z.object({
+    email: z.string(),
+    name: z.union([z.string(), z.undefined()]),
+  }),
+])
+
+export const iEmailSchema = z.object({
+  to: z.union([iContactSchema, z.array(iContactSchema)]),
+  replyTo: z.union([iContactSchema, z.array(iContactSchema)]).optional(),
+  cc: z.union([iContactSchema, z.array(iContactSchema)]).optional(),
+  bcc: z.union([iContactSchema, z.array(iContactSchema)]).optional(),
+  from: iContactSchema.optional(),
+  subject: z.string(),
+  text: z.string().optional(),
+  html: z.string().optional(),
+  templateId: z.number().optional(),
+  templateVariables: z.record(z.string(), z.string()).optional(),
+})
+
+export type IContact = z.infer<typeof iContactSchema>
+export type IEmail = z.infer<typeof iEmailSchema>

package/@types/email/ecomail/ecomail.connector.ts

@@ -0,0 +1,139 @@
+import { useResult } from '@develit-io/backend-sdk'
+import {
+  type EMAttachment,
+  type EMContact,
+  type EMEmail,
+  type IContact,
+  type IEmail,
+  IEmailConnector,
+} from '../../email'
+
+export class EcomailConnector extends IEmailConnector {
+  static providerName = 'ecomail'
+
+  constructor({
+    API_KEY,
+    SMTP_HOST,
+    SENDER,
+  }: { API_KEY: string; SMTP_HOST: string; SENDER: IContact }) {
+    super({ API_KEY, SMTP_HOST, SENDER })
+  }
+
+  async sendEmail(email: IEmail): Promise<Response | null> {
+    // This is needed only for ecomail connector because when template variables includes word 'localhost' it does not send email
+    if (email.templateVariables) {
+      for (const [key, value] of Object.entries(email.templateVariables)) {
+        if (
+          typeof value === 'string' &&
+          String(value).includes('localhost') &&
+          key in email.templateVariables
+        ) {
+          email.templateVariables[key as keyof typeof email.templateVariables] =
+            String(value).replace('localhost', 'origin')
+        }
+      }
+    }
+
+    const emEmail: EMEmail = this.convertEmail(email)
+    const uri = emEmail.message.template_id
+      ? 'https://api2.ecomailapp.cz/transactional/send-template'
+      : 'https://api2.ecomailapp.cz/transactional/send-message'
+
+    const [data, error] = await useResult(
+      fetch(uri, {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+          key: this.API_KEY,
+        },
+        body: JSON.stringify(emEmail),
+      }),
+    )
+    if (error) throw error
+
+    return data
+  }
+
+  protected convertEmail(email: IEmail): EMEmail {
+    const toContacts: EMContact[] = this.convertContacts(email.to)
+    const ccContacts: EMContact[] = email.cc
+      ? this.convertContacts(email.cc)
+      : []
+    const bccContacts: EMContact[] = email.bcc
+      ? this.convertContacts(email.bcc)
+      : []
+
+    const replyTo: EMContact | undefined = email.replyTo
+      ? this.convertContacts(email.replyTo)[0]
+      : undefined
+
+    const from: EMContact = this.convertContact(email.from || this.SENDER)
+    const subject: string = email.subject
+
+    const textAttachments: EMAttachment[] = email.text
+      ? [{ name: 'plain', type: 'text/plain', content: email.text }]
+      : []
+
+    const htmlAttachments: EMAttachment[] = email.html
+      ? [{ type: 'text/html', content: email.html, name: 'email_body.html' }]
+      : []
+
+    const attachments: EMAttachment[] = [...textAttachments, ...htmlAttachments]
+
+    const contacts: EMContact[] = toContacts.flatMap((to) => {
+      const entries: EMContact[] = []
+      if (ccContacts.length > 0) {
+        ccContacts.forEach((cc) => {
+          entries.push({ email: cc?.email, name: cc?.name, cc: cc?.email })
+        })
+      }
+      if (bccContacts.length > 0) {
+        bccContacts.forEach((bcc) => {
+          entries.push({ email: bcc?.email, name: bcc?.name, bcc: bcc?.email })
+        })
+      }
+      return entries.length > 0 ? entries : [to]
+    })
+
+    return {
+      message: {
+        from_email: from?.email,
+        from_name: from.name || '',
+        subject,
+        attachments,
+        to: contacts,
+        text: email.text,
+        html: email.html,
+        reply_to: replyTo?.email,
+        template_id: email.templateId,
+        global_merge_vars: email.templateVariables
+          ? Object.keys(email.templateVariables).map((key) => ({
+              name: key,
+              content:
+                email.templateVariables![
+                  key as keyof typeof email.templateVariables
+                ],
+            }))
+          : null,
+      },
+    }
+  }
+
+  protected convertContacts(contacts: IContact | IContact[]): EMContact[] {
+    if (!contacts) {
+      return []
+    }
+    const contactArray: IContact[] = Array.isArray(contacts)
+      ? contacts
+      : [contacts]
+    return contactArray.map(this.convertContact)
+  }
+
+  protected convertContact(contact: IContact): EMContact {
+    if (typeof contact === 'string') {
+      return { email: contact, name: undefined }
+    }
+
+    return { email: contact?.email, name: contact?.name }
+  }
+}

package/@types/email/ecomail/ecomail.types.ts

@@ -0,0 +1,27 @@
+export interface EMContact {
+  email: string
+  name?: string
+  cc?: string
+  bcc?: string
+}
+
+export interface EMAttachment {
+  type: string
+  name: string
+  content: string
+}
+
+export interface EMEmail {
+  message: {
+    template_id?: number
+    subject: string
+    from_name: string
+    from_email: string
+    reply_to?: string
+    to: EMContact[]
+    attachments: EMAttachment[]
+    text?: string
+    html?: string
+    global_merge_vars: object | null
+  }
+}

package/@types/email/ecomail/index.ts

@@ -0,0 +1,2 @@
+export * from './ecomail.connector'
+export * from './ecomail.types'

package/@types/email/index.ts

@@ -0,0 +1,3 @@
+export * from './IEmail.types'
+export * from './IEmail.connector'
+export * from './ecomail'

package/@types/index.ts

@@ -0,0 +1,9 @@
+export * from './email'
+export * from './io'
+export * from './pushNotification'
+export * from './queue'
+export * from './sms'
+export * from './slack'
+export * from './database'
+export * from './consts'
+export * from './service'

package/@types/io/index.ts

@@ -0,0 +1,3 @@
+export * from './sendEmail'
+export * from './sendSlack'
+export * from './sendSms'

package/@types/io/sendEmail.ts

@@ -0,0 +1,18 @@
+import { iEmailSchema } from '../'
+import z from 'zod'
+
+export const sendEmailInputSchema = z.object({
+  email: iEmailSchema,
+  metadata: z.object({
+    userAgent: z.string().optional(),
+    ip: z.ipv4().or(z.ipv6()).optional(),
+    initiator: z.object({
+      service: z.string(),
+      userId: z.string().optional(),
+    }),
+  }),
+})
+
+export interface SendEmailInput extends z.infer<typeof sendEmailInputSchema> {}
+
+export interface SendEmailOutput {}

package/@types/io/sendSlack.ts

@@ -0,0 +1,19 @@
+import { z } from 'zod/v4'
+
+export const sendSlackInputSchema = z.object({
+  slack: z.object({
+    message: z.string(),
+  }),
+  metadata: z.object({
+    userAgent: z.string().optional(),
+    ip: z.ipv4().or(z.ipv6()).optional(),
+    initiator: z.object({
+      service: z.string(),
+      userId: z.string().optional(),
+    }),
+  }),
+})
+
+export interface SendSlackInput extends z.infer<typeof sendSlackInputSchema> {}
+
+export interface SendSlackOutput {}

package/@types/io/sendSms.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod'
+
+export const sendSmsInputSchema = z.object({
+  sms: z.object({
+    message: z.string(),
+    to: z.string(),
+  }),
+  metadata: z.object({
+    userAgent: z.string().optional(),
+    ip: z.ipv4().or(z.ipv6()).optional(),
+    initiator: z.object({
+      service: z.string(),
+      userId: z.string().optional(),
+    }),
+  }),
+})
+
+export interface SendSmsInput extends z.infer<typeof sendSmsInputSchema> {}
+
+export interface SendSmsOutput {}

package/@types/pushNotification/IPushNotification.ts

@@ -0,0 +1 @@
+export interface IPushNotification {}

package/@types/pushNotification/index.ts

@@ -0,0 +1 @@
+export * from './IPushNotification'

package/@types/queue.ts

@@ -0,0 +1,19 @@
+import type { IEmail, IPushNotification, ISlack, ISms } from './'
+
+export interface NotificationQueueMessage {
+  type: 'email' | 'sms' | 'pushNotification' | 'slack'
+  metadata: {
+    userAgent?: string
+    ip?: string
+    initiator: {
+      service: string
+      userId?: string
+    }
+  }
+  payload: {
+    email?: IEmail
+    sms?: ISms
+    pushNotification?: IPushNotification
+    slack?: ISlack
+  }
+}

package/@types/service.ts

@@ -0,0 +1,30 @@
+export interface NotificationServiceEnvironmentConfig {
+  queue?: {
+    max_batch_size?: number
+    max_batch_timeout?: number
+  }
+  d1: {
+    id: string
+  }
+  vars: {
+    EMAIL_PROVIDER: 'ecomail'
+    EMAIL_SENDER: { name: string; email: string }
+    EMAIL_SMTP_HOST: string
+    EMAIL_API_KEY: string
+    SMS_PROVIDER: 'twilio'
+    SMS_ACCOUNT_ID: string
+    SMS_AUTH_TOKEN: string
+    SMS_SERVICE_ID: string | number
+    SLACK_WEBHOOKS: [string]
+  }
+}
+
+export interface NotificationServiceWranglerConfig {
+  name: string
+  envs: {
+    local: NotificationServiceEnvironmentConfig
+    [key: string]: NotificationServiceEnvironmentConfig
+  }
+}
+
+export interface NotificationServiceEnv extends NotificationEnv {}

package/@types/slack/ISlack.types.ts

@@ -0,0 +1,3 @@
+export interface ISlack {
+  message: string
+}

package/@types/slack/index.ts

@@ -0,0 +1 @@
+export * from './ISlack.types'

package/@types/slack/slack.connector.ts

@@ -0,0 +1,27 @@
+export class SlackConnector {
+  private webhooks: string[]
+
+  constructor(webhooks: string[]) {
+    this.webhooks = webhooks
+  }
+
+  async sendNotificationToAllSlack(message: string) {
+    const controller = new AbortController()
+    const timeoutId = setTimeout(() => controller.abort(), 3000)
+
+    for (const webhook of this.webhooks) {
+      let response = await fetch(webhook, {
+        method: 'POST',
+        body: JSON.stringify({ text: message }),
+        headers: { 'Content-Type': 'application/json' },
+        signal: controller.signal,
+      })
+
+      clearTimeout(timeoutId)
+
+      if (!response.ok) {
+        throw new Error('Failed sending Slack notification to ' + message)
+      }
+    }
+  }
+}

package/@types/sms/ISms.connector.ts

@@ -0,0 +1,22 @@
+import type { InternalError } from '@develit-io/backend-sdk'
+import type { ISms } from '../'
+
+export abstract class ISmsConnector {
+  static providerName: string
+
+  public ACCOUNT_ID: string
+  public AUTH_TOKEN: string
+  public SERVICE_ID: string
+
+  protected constructor({
+    ACCOUNT_ID,
+    AUTH_TOKEN,
+    SERVICE_ID,
+  }: { ACCOUNT_ID: string; AUTH_TOKEN: string; SERVICE_ID: string }) {
+    this.ACCOUNT_ID = ACCOUNT_ID
+    this.AUTH_TOKEN = AUTH_TOKEN
+    this.SERVICE_ID = SERVICE_ID
+  }
+
+  abstract sendSms(sms: ISms): Promise<InternalError | void>
+}

package/@types/sms/ISms.types.ts

@@ -0,0 +1,4 @@
+export interface ISms {
+  message: string
+  to: string
+}

package/@types/sms/index.ts

@@ -0,0 +1,3 @@
+export * from './ISms.types'
+export * from './ISms.connector'
+export * from './twilio'

package/@types/sms/twilio/index.ts

@@ -0,0 +1 @@
+export * from './twilio.connector'

package/@types/sms/twilio/twilio.connector.ts

@@ -0,0 +1,35 @@
+import {
+  type InternalError,
+  createInternalError,
+} from '@develit-io/backend-sdk'
+import { type ISms, ISmsConnector } from '../'
+import twilio from 'twilio'
+
+export class TwilioConnector extends ISmsConnector {
+  static providerName = 'twilio'
+
+  readonly twilioClient: twilio.Twilio
+
+  constructor({
+    ACCOUNT_ID,
+    AUTH_TOKEN,
+    SERVICE_ID,
+  }: { ACCOUNT_ID: string; AUTH_TOKEN: string; SERVICE_ID: string }) {
+    super({ ACCOUNT_ID, AUTH_TOKEN, SERVICE_ID })
+    this.twilioClient = twilio(ACCOUNT_ID, AUTH_TOKEN)
+  }
+
+  async sendSms(sms: ISms): Promise<InternalError | void> {
+    const message = await this.twilioClient.messages.create({
+      body: sms.message,
+      messagingServiceSid: this.SERVICE_ID,
+      to: sms.to,
+    })
+
+    if (message.errorMessage)
+      return createInternalError(null, {
+        message: message.errorMessage,
+        status: message.errorCode,
+      })
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@develit-services/notification",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "author": "Develit.io s.r.o.",
   "type": "module",
   "exports": {
@@ -15,13 +15,13 @@
       "require": "./dist/export/worker.cjs"
     },
     "./db-schema": {
-      "types": "./src/database/schema/index.d.ts",
       "import": "./src/database/schema/index.ts"
     },
     "./package.json": "./package.json"
   },
   "files": [
     "./dist",
+    "./@types",
     "./src/database/schema"
   ],
   "scripts": {