@splendidlabz/third-party 1.1.1 → 1.3.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @splendidlabz/third-party
 
+## 1.3.0
+
+### Minor Changes
+
+- Many changes! Woo
+
+### Patch Changes
+
+- 5114274: Sendy: Include prettyName option
+- Updated dependencies [2c149fc]
+- Updated dependencies
+  - @splendidlabz/utils@1.7.0
+
+## 1.2.0
+
+### Minor Changes
+
+- Many many upgrades which I didn't document properly 😅. The details are in Github history, but too many details to talk about now.
+
+### Patch Changes
+
+- Updated dependencies
+  - @splendidlabz/utils@1.6.0
+
 ## 1.1.1
 
 ### Patch Changes

package/{buttondown.js → lib/buttondown.js}

@@ -52,7 +52,6 @@ export async function createSubscriber(
 
   if (response) return response.body
   if (error) {
-    console.log(error)
     // Button down throws this error if the email is invalid. Though this only occurs after using fake emails for many times. Shouldn't be a problem to ignore.
     if (error.code === 'email_invalid') return
     return reject(error)

package/lib/logger.js

@@ -0,0 +1,49 @@
+import pino from 'pino'
+
+// Potentially can put into logtail for production
+// Potentially can use pino-http for logging requests
+
+const isDev = import.meta.env.DEV
+
+export function createLogger({ verbose = false, level = 'info' } = {}) {
+  return pino({
+    level,
+    transport: isDev
+      ? {
+          target: 'pino-pretty', // Nice formatting for dev
+          options: { colorize: true },
+        }
+      : undefined, // Raw JSON for production
+    hooks: {
+      logMethod(inputArgs, method, level) {
+        if (!verbose) return method.apply(this, inputArgs)
+        if (inputArgs.length >= 2) {
+          const arg1 = inputArgs.shift()
+          const arg2 = inputArgs.shift()
+          return method.apply(this, [arg2, arg1, ...inputArgs])
+        }
+        return method.apply(this, inputArgs)
+      },
+    },
+  })
+}
+
+// For fast usage, but will be verbose by default
+export const logger = pino({
+  transport: isDev
+    ? {
+        target: 'pino-pretty', // Nice formatting for dev
+        options: { colorize: true },
+      }
+    : undefined, // Raw JSON for production
+  hooks: {
+    logMethod(inputArgs, method, level) {
+      if (inputArgs.length >= 2) {
+        const arg1 = inputArgs.shift()
+        const arg2 = inputArgs.shift()
+        return method.apply(this, [arg2, arg1, ...inputArgs])
+      }
+      return method.apply(this, inputArgs)
+    },
+  },
+})

package/lib/logger.md

@@ -0,0 +1,45 @@
+# Logger
+
+## Installation
+
+```
+npm install @splendidlabz/third-party
+```
+
+## Basic Usage
+
+Import `logger` from the package to log messages. This will be verbose by default.
+
+```js
+import { logger } from '@splendidlabz/third-party/logger'
+logger.info('Message', { data: 'data' })
+```
+
+## Advanced Usage
+
+You can create a logger with a custom verbosity and log level.
+
+```js
+import { createLogger } from '@splendidlabz/third-party/logger'
+
+export const logger = createLogger({
+  level: 'info',
+  verbose: false,
+})
+```
+
+## Log Levels
+
+Pino default log levels are:
+
+| Level  | Value    |
+| ------ | -------- |
+| trace  | 10       |
+| debug  | 20       |
+| info   | 30       |
+| warn   | 40       |
+| error  | 50       |
+| fatal  | 60       |
+| silent | Infinity |
+
+Default log level is `info`

package/{postmark.js → lib/postmark.js}

@@ -1,13 +1,12 @@
 import postmark from 'postmark'
 
-const POSTMARK_KEY = process.env.POSTMARK_KEY
 const DEFAULT_OPTIONS = {
   MessageStream: 'outbound', // outbound | broadcast
 }
 
-const client = new postmark.ServerClient(POSTMARK_KEY)
-
-export default function Postmark(options) {
+export default function Postmark(API_KEY, options) {
+  const POSTMARK_KEY = API_KEY || process.env.POSTMARK_KEY
+  const client = new postmark.ServerClient(POSTMARK_KEY)
   const baseOpts = Object.assign({}, DEFAULT_OPTIONS, options)
 
   return {

package/lib/sendy.js

@@ -0,0 +1,215 @@
+import { omitEmpty } from '@splendidlabz/utils'
+import zlFetch, { toQueryString } from 'zl-fetch'
+
+/**
+ * Creates a Sendy API client instance
+ * @param {string} baseURL - The base URL of your Sendy installation (e.g., 'https://your-domain.com/sendy')
+ * @param {Object} config - Configuration object
+ * @param {string} config.apiKey - Your Sendy API key (available in Settings)
+ * @return {Object} Sendy client with available methods
+ * @property {Function} subscribe - Subscribe a user to a mailing list
+ */
+export function createSendy({
+  baseURL,
+  listId,
+  brandId,
+  apiKey,
+  getReferrer = null,
+  getIpAddress = null,
+  prettyName = true,
+} = {}) {
+  const api_key = apiKey
+  const list = listId
+  const brand = brandId
+
+  return {
+    async subscriberStatus({ email, listId }) {
+      const response = await zlFetch.post(
+        `${baseURL}/api/subscribers/subscription-status.php`,
+        {
+          body: toQueryString({
+            boolean: true,
+            api_key,
+            list_id: listId || list,
+            email,
+          }),
+        },
+      )
+
+      const successMessages = [
+        'Subscribed',
+        'Unsubscribed',
+        'Unconfirmed',
+        'Bounced',
+        'Soft bounced',
+        'Complained',
+      ]
+
+      if (successMessages.includes(response.body)) return response.body
+      else throw new Error(response.body)
+    },
+
+    async subscriberCount({ listId } = {}) {
+      const response = await zlFetch.post(
+        `${baseURL}/api/subscribers/subscribers-count.php`,
+        {
+          body: toQueryString({
+            boolean: true,
+            api_key,
+            list_id: listId || list,
+          }),
+        },
+      )
+
+      const result = response.body
+      const count = Number(result)
+      if (isNaN(count)) throw new Error(result)
+      return count
+    },
+
+    async subscribe({
+      context,
+      email,
+      name,
+      listId,
+      gdpr = false,
+      silent = false,
+      ...rest
+    }) {
+      const ip = getIpAddress && context && getIpAddress(context)
+      const referrer = getReferrer && context && getReferrer(context)
+
+      // Potentially add country and city based on ip address...
+      // Via ipapi.co - Free for 30,000 requests per month
+
+      if (name && prettyName) {
+        name = name
+          .toLowerCase()
+          .split(' ')
+          .map(word => word.charAt(0).toUpperCase() + word.slice(1))
+          .join(' ')
+      }
+
+      const body = omitEmpty({
+        boolean: true,
+        api_key,
+        list: listId || list,
+        email,
+        ipaddress: ip,
+        referrer,
+        gdpr,
+        silent,
+        ...rest,
+      })
+
+      const response = await zlFetch.post(`${baseURL}/subscribe`, {
+        body: toQueryString(body),
+      })
+
+      const result = response.body
+      if (result === '1') return true
+
+      // Details will be updated when users are subscribed. So this strictly doesn't count as an error. Better to use subscriberStatus to check for status.
+      if (result === 'Already subscribed.') return true
+      else throw new Error(result)
+    },
+
+    async unsubscribe({ email, listId, ...rest }) {
+      const response = await zlFetch.post(`${baseURL}/unsubscribe`, {
+        body: toQueryString({
+          boolean: true,
+          api_key,
+          email,
+          list: listId || list,
+          ...rest,
+        }),
+      })
+
+      const result = response.body
+      if (result === '1') return true
+      else throw new Error(result)
+    },
+
+    async delete({ email, listId }) {
+      const response = await zlFetch.post(
+        `${baseURL}/api/subscribers/delete.php`,
+        {
+          body: toQueryString({
+            boolean: true,
+            api_key,
+            email,
+            list_id: listId || list,
+          }),
+        },
+      )
+
+      const result = response.body
+      if (result === '1') return true
+      // No harm in returning true for this
+      if (result === 'Subscriber does not exist') return true
+      else throw new Error(result)
+    },
+
+    async createCampaign({
+      listIds = [],
+      excludeListIds = [],
+      segmentIds = [],
+      excludeSegmentIds = [],
+      brandId = brand,
+
+      send = false,
+      subject,
+      fromName,
+      fromEmail,
+      replyTo,
+      plainText,
+      htmlText,
+
+      queryString = '',
+      trackOpens = 1,
+      trackClicks = 1,
+      scheduleDateTime,
+      scheduleTimezone,
+    }) {
+      const send_campaign = send ? 1 : 0
+      const response = await zlFetch.post(
+        `${baseURL}/api/campaigns/create.php`,
+        {
+          body: toQueryString(
+            omitEmpty({
+              boolean: true,
+              api_key,
+              brand_id: brandId,
+              list_ids: listIds.join(','),
+              segment_ids: segmentIds.join(','),
+              exclude_list_ids: excludeListIds.join(','),
+              exclude_segment_ids: excludeSegmentIds.join(','),
+              send_campaign,
+              from_name: fromName,
+              from_email: fromEmail,
+              reply_to: replyTo || fromEmail,
+              subject,
+              plain_text: plainText,
+              html_text: htmlText,
+              query_string: queryString,
+              track_opens: trackOpens,
+              track_clicks: trackClicks,
+              schedule_date_time: scheduleDateTime,
+              schedule_timezone: scheduleTimezone,
+            }),
+          ),
+        },
+      )
+
+      const successMessages = [
+        'Campaign created',
+        'Campaign created and now sending',
+        'Campaign scheduled',
+      ]
+
+      const result = response.body
+      if (successMessages.includes(result)) return result
+      else throw new Error(result)
+    },
+  }
+}

package/package.json

@@ -1,16 +1,13 @@
 {
   "name": "@splendidlabz/third-party",
   "prettier": "@splendidlabz/prettier-config",
-  "version": "1.1.1",
+  "version": "1.3.0",
   "description": "",
   "type": "module",
   "main": "index.js",
   "sideEffects": false,
   "exports": {
-    "./google": "./google.js",
-    "./postmark": "./postmark.js",
-    "./buttondown": "./buttondown.js",
-    "./stripe": "./stripe.js"
+    "./*": "./lib/*.js"
   },
   "scripts": {
     "lint": "eslint . --fix",
@@ -19,15 +16,17 @@
   },
   "author": "Zell Liew <zellwk@gmail.com>",
   "dependencies": {
-    "@splendidlabz/utils": "1.5.1",
+    "@splendidlabz/utils": "1.7.0",
     "googleapis": "^148.0.0",
     "http-errors": "^2.0.0",
+    "pino": "^9.7.0",
+    "pino-pretty": "^13.0.0",
     "postmark": "^4.0.5",
     "vitest": "^3.1.4",
     "zl-fetch": "^6.0.6"
   },
   "devDependencies": {
-    "@splendidlabz/eslint-config": "2.0.0",
-    "@splendidlabz/prettier-config": "1.1.0"
+    "@splendidlabz/eslint-config": "2.1.0",
+    "@splendidlabz/prettier-config": "1.2.0"
   }
 }