@develit-services/notification 0.0.2 → 0.0.4

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

@@ -1,25 +0,0 @@
-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

@@ -1,140 +0,0 @@
-import { useResult } from '@develit-io/backend-sdk'
-// TODO: Tests fail when imported as from '@services/notification/@types'`
-import {
-  type EMAttachment,
-  type EMContact,
-  type EMEmail,
-  type IContact,
-  type IEmail,
-  IEmailConnector,
-} from '@services/notification/@types/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

@@ -1,27 +0,0 @@
-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

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

package/@types/email/index.ts

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

package/@types/index.ts

@@ -1,9 +0,0 @@
-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

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

package/@types/io/sendEmail.ts

@@ -1,18 +0,0 @@
-import { iEmailSchema } from '@services/notification/@types'
-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

@@ -1,19 +0,0 @@
-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

@@ -1,20 +0,0 @@
-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

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

package/@types/pushNotification/index.ts

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

package/@types/queue.ts

@@ -1,24 +0,0 @@
-import type {
-  IEmail,
-  IPushNotification,
-  ISlack,
-  ISms,
-} from '@services/notification/@types'
-
-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

@@ -1,30 +0,0 @@
-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

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

package/@types/slack/index.ts

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

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

@@ -1,27 +0,0 @@
-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

@@ -1,22 +0,0 @@
-import type { InternalError } from '@develit-io/backend-sdk'
-import type { ISms } from '@services/notification/@types'
-
-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

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

package/@types/sms/index.ts

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

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

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

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

@@ -1,36 +0,0 @@
-// TODO: Tests fail when imported as from '@services/notification/@types'`
-import {
-  type InternalError,
-  createInternalError,
-} from '@develit-io/backend-sdk'
-import { type ISms, ISmsConnector } from '@services/notification/@types/sms'
-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/CHANGELOG.md

@@ -1,28 +0,0 @@
-# Changelog
-
-
-## v0.0.2
-
-
-### 🚀 Enhancements
-
-- **notification:** Init codebase + notification service ([3fa7306](https://github.com/develit-io/develit-services/commit/3fa7306))
-
-### 📦 Build
-
-- **notification:** Setup package build ([79fb543](https://github.com/develit-io/develit-services/commit/79fb543))
-
-### ❤️ Contributors
-
-- Klein Petr ([@kleinpetr](https://github.com/kleinpetr))
-
-## v0.0.1
-
-
-### 🚀 Enhancements
-
-- **notification:** Init codebase + notification service ([3fa7306](https://github.com/develit-io/develit-services/commit/3fa7306))
-
-### ❤️ Contributors
-
-- Klein Petr ([@kleinpetr](https://github.com/kleinpetr))

package/build.config.ts

@@ -1,28 +0,0 @@
-import { defineBuildConfig } from 'unbuild'
-
-export default defineBuildConfig({
-  entries: ['./src'],
-  outDir: 'dist',
-  declaration: true,
-  rollup: {
-    emitCJS: true,
-  },
-  externals: [
-    'cloudflare:workers',
-    '@cloudflare/workers-types',
-    '@develit-io/backend-sdk',
-    '@cloudflare/vitest-pool-workers',
-    'cloudflare',
-    'drizzle-kit',
-    'drizzle-orm',
-    'drizzle-seed',
-    'wrangler',
-    'zod',
-    '@types/node',
-    'cloudflare:workers',
-    '@std/text',
-    '@develit-services/notification/@types',
-    '@develit-services/notification/src/database/drizzle',
-    '@develit-services/notification/src/utils',
-  ],
-})

package/drizzle.config.ts

@@ -1,3 +0,0 @@
-import { getDrizzleD1Config } from '@develit-io/backend-sdk'
-
-export default getDrizzleD1Config()

package/src/database/drizzle.ts

@@ -1,6 +0,0 @@
-import * as schema from './schema'
-
-export * from 'drizzle-orm'
-export { alias } from 'drizzle-orm/sqlite-core'
-
-export const tables = schema

package/src/database/migrations/0000_funny_beast.sql

@@ -1,12 +0,0 @@
-CREATE TABLE `audit_log` (
-	`id` text PRIMARY KEY NOT NULL,
-	`created_at` integer DEFAULT (unixepoch('subsec') * 1000),
-	`updated_at` integer DEFAULT (unixepoch('subsec') * 1000),
-	`deleted_at` integer DEFAULT null,
-	`event` text NOT NULL,
-	`ip` text,
-	`user_agent` text,
-	`description` text,
-	`initiator_service` text NOT NULL,
-	`initiator_user_id` text
-);

package/src/database/migrations/meta/0000_snapshot.json

@@ -1,101 +0,0 @@
-{
-  "version": "6",
-  "dialect": "sqlite",
-  "id": "a975fc44-2981-453f-abe4-53763432eb34",
-  "prevId": "00000000-0000-0000-0000-000000000000",
-  "tables": {
-    "audit_log": {
-      "name": "audit_log",
-      "columns": {
-        "id": {
-          "name": "id",
-          "type": "text",
-          "primaryKey": true,
-          "notNull": true,
-          "autoincrement": false
-        },
-        "created_at": {
-          "name": "created_at",
-          "type": "integer",
-          "primaryKey": false,
-          "notNull": false,
-          "autoincrement": false,
-          "default": "(unixepoch('subsec') * 1000)"
-        },
-        "updated_at": {
-          "name": "updated_at",
-          "type": "integer",
-          "primaryKey": false,
-          "notNull": false,
-          "autoincrement": false,
-          "default": "(unixepoch('subsec') * 1000)"
-        },
-        "deleted_at": {
-          "name": "deleted_at",
-          "type": "integer",
-          "primaryKey": false,
-          "notNull": false,
-          "autoincrement": false,
-          "default": "null"
-        },
-        "event": {
-          "name": "event",
-          "type": "text",
-          "primaryKey": false,
-          "notNull": true,
-          "autoincrement": false
-        },
-        "ip": {
-          "name": "ip",
-          "type": "text",
-          "primaryKey": false,
-          "notNull": false,
-          "autoincrement": false
-        },
-        "user_agent": {
-          "name": "user_agent",
-          "type": "text",
-          "primaryKey": false,
-          "notNull": false,
-          "autoincrement": false
-        },
-        "description": {
-          "name": "description",
-          "type": "text",
-          "primaryKey": false,
-          "notNull": false,
-          "autoincrement": false
-        },
-        "initiator_service": {
-          "name": "initiator_service",
-          "type": "text",
-          "primaryKey": false,
-          "notNull": true,
-          "autoincrement": false
-        },
-        "initiator_user_id": {
-          "name": "initiator_user_id",
-          "type": "text",
-          "primaryKey": false,
-          "notNull": false,
-          "autoincrement": false
-        }
-      },
-      "indexes": {},
-      "foreignKeys": {},
-      "compositePrimaryKeys": {},
-      "uniqueConstraints": {},
-      "checkConstraints": {}
-    }
-  },
-  "views": {},
-  "enums": {},
-  "_meta": {
-    "schemas": {},
-    "tables": {},
-    "columns": {}
-  },
-  "internal": {
-    "indexes": {}
-  }
-}

package/src/database/migrations/meta/_journal.json

@@ -1,13 +0,0 @@
-{
-  "version": "7",
-  "dialect": "sqlite",
-  "entries": [
-    {
-      "idx": 0,
-      "version": "6",
-      "when": 1757619388118,
-      "tag": "0000_funny_beast",
-      "breakpoints": true
-    }
-  ]
-}

package/src/database/schema/audit-log.schema.ts

@@ -1,13 +0,0 @@
-import { base } from '@develit-io/backend-sdk'
-import type { AuditLogEventType } from '@services/notification/@types'
-import { sqliteTable, text } from 'drizzle-orm/sqlite-core'
-
-export const auditLog = sqliteTable('audit_log', {
-  ...base,
-  event: text('event').$type<AuditLogEventType>().notNull(),
-  ip: text('ip'),
-  userAgent: text('user_agent'),
-  description: text('description'),
-  initiatorService: text('initiator_service').notNull(),
-  initiatorUserId: text('initiator_user_id'),
-})

package/src/database/schema/index.ts

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