@splendidlabz/third-party 0.1.0 → 1.1.0-beta.0

package/CHANGELOG.md

@@ -0,0 +1,18 @@
+# @splendidlabz/third-party
+
+## 1.1.0-beta.0
+
+### Minor Changes
+
+- Ready for next release
+
+### Patch Changes
+
+- Updated dependencies
+  - @splendidlabz/utils@1.5.0-beta.5
+
+## 1.0.0
+
+### Major Changes
+
+- Added a couple of improvements

package/buttondown.js

@@ -1,13 +1,15 @@
-import { omitEmpty } from '@splendidlabz/utils'
+import { omitEmpty, uniqueArray } from '@splendidlabz/utils'
+import 'dotenv/config'
 import { createZlFetch, reject } from 'zl-fetch'
 
-const token = import.meta.env.BUTTONDOWN_KEY
+const token = process.env.BUTTONDOWN_KEY
 
 const BASE_URL = 'https://api.buttondown.email/v1'
 const buttonDown = createZlFetch(BASE_URL, {
   headers: {
     Accept: 'application/json',
     Authorization: `Token ${token}`,
+    'X-API-Version': '2025-06-01',
   },
   returnError: true,
   debug: true,
@@ -19,31 +21,40 @@ export async function getSubscriber(email) {
   else return null
 }
 
-const DEFAULT_SUBSCRIBER_OPTIONS = {
-  notes: '',
-  metadata: {},
-  tags: [],
-  referrer_url: '',
-  utm_campagin: '',
-  utm_medium: '',
-  utm_source: '',
-  referring_subscriber_id: '',
-  subscriber_type: 'regular',
-}
+// const DEFAULT_SUBSCRIBER_OPTIONS = {
+//   // type: 'regular', // subscribes immediately, no double-opt-in
+//   metadata: {},
+//   tags: [],
+//   // referrer_url: '',
+//   // utm_campagin: '',
+//   // utm_medium: '',
+//   // utm_source: '',
+//   // referring_subscriber_id: '',
+//   // notes: '',
+// }
 
 // Creates a subscriber
-// Notes:
-//  - Button down throws an error if the email is invalid. Though this only occurs after using fake emails for many times. Shouldn't be a problem to ignore.
-export async function createSubscriber(email, props = {}) {
-  const data = omitEmpty({ ...DEFAULT_SUBSCRIBER_OPTIONS, ...props })
-  if (props.double_opt_in === true) data.subscriber_type = 'unactivated'
+// Button down docs: https://docs.buttondown.com/api-subscribers-create
+export async function createSubscriber(
+  email,
+  props = {},
+  { double_opt_in = false } = {},
+) {
+  const data = omitEmpty(props)
+  if (double_opt_in) data.type = 'regular'
+
   const { response, error } = await buttonDown.post('/subscribers', {
-    body: { email, ...data },
+    body: {
+      email_address: email,
+      ...data,
+    },
   })
 
   if (response) return response.body
   if (error) {
-    if (error.code === 'email_invalid') return // Swallow this 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)
   }
 }
@@ -53,26 +64,29 @@ export async function createSubscriber(email, props = {}) {
 // Notes:
 //  - Buttondown throws an error if subscriber doesn't exist.
 //  - It's not possible to change a user's email with this API.
-export async function updateSubscriber(email, props = {}, options = {}) {
+export async function updateSubscriber(
+  email,
+  props = {},
+  { overwrite = false } = {},
+) {
   const {
     metadata: incomingMetadata = {},
     tags: incomingTags = [],
     ...rest
   } = props
-  const { mergeTags = true, mergeMetadata = true } = options
 
   const sub = await getSubscriber(email)
   if (!sub) return reject({ status: 400, message: 'Subscriber not found' })
 
-  // Determine whether to merge or overwrite tags and metadata
-  const { tags, metadata } = sub
-  const newTags = mergeTags
-    ? Array.from(new Set(tags, incomingTags))
-    : incomingTags
-  const newMetadata = mergeMetadata
-    ? Object.assign(metadata, incomingMetadata)
-    : incomingMetadata
+  let newTags = []
+  if (overwrite) newTags = incomingTags
+  else newTags = uniqueArray([...sub.tags, ...incomingTags])
 
+  let newMetadata = {}
+  if (overwrite) newMetadata = incomingMetadata
+  else newMetadata = Object.assign(sub.metadata, incomingMetadata)
+
+  // Omit empty values so they won't hit button down. So the original values won't be overwritten.
   const data = omitEmpty({
     ...rest,
     tags: newTags,
@@ -93,9 +107,38 @@ export async function upsertSubscriber(email, props = {}) {
   else return createSubscriber(email, props)
 }
 
+// To unsubscribe -> Set subscriber type to unsubscribed
+export async function unsubscribe(email) {
+  return updateSubscriber(email, { type: 'unsubscribed' })
+}
+
 export async function removeTagsFromSubscriber(email, tags = []) {
   const sub = await getSubscriber(email)
   if (!sub) return reject({ status: 400, message: 'Subscriber not found' })
   const newTags = sub.tags.filter(tag => !tags.includes(tag))
-  return updateSubscriber(email, { tags: newTags }, { mergeTags: false })
+  return updateSubscriber(email, { tags: newTags }, { overwrite: true })
+}
+
+export async function deleteSubscriber(email) {
+  // Cannot use zlFetch here because we'll get a JSON error in handling the response. Default to using fetch for now, unless maybe we go fix zlFetch. But not now.
+  await fetch(`${BASE_URL}/subscribers/${email}`, {
+    method: 'DELETE',
+    headers: {
+      Authorization: `Token ${token}`,
+    },
+  })
+}
+
+// This doesn't work yet, but gonna focus on building other things first.
+export async function deleteTags(tags) {
+  return Promise.all(
+    tags.map(tag =>
+      fetch(`${BASE_URL}/tags/${tag}`, {
+        method: 'DELETE',
+        headers: {
+          Authorization: `Token ${token}`,
+        },
+      }),
+    ),
+  )
 }

package/buttondown.spec.js

@@ -0,0 +1,123 @@
+import 'dotenv/config'
+import { test as base, describe, expect } from 'vitest'
+import {
+  createSubscriber,
+  deleteSubscriber,
+  deleteTags,
+  getSubscriber,
+  removeTagsFromSubscriber,
+  updateSubscriber,
+} from './buttondown.js'
+
+// Test email that we'll use for all tests
+if (!import.meta.env.BUTTONDOWN_KEY)
+  throw new Error('BUTTONDOWN_KEY environment variable is required')
+
+const DEFAULT_DATA = {
+  tags: ['test', 'test2'],
+  metadata: { first_name: 'Name' },
+}
+
+// Create test with custom fixtures
+const test = base.extend({
+  // eslint-disable-next-line no-empty-pattern
+  email: async ({}, use) => {
+    const email = `test-user-${Date.now()}@example.com`
+    await use(email)
+    // Cleanup after test
+    await deleteSubscriber(email)
+    await deleteTags([...DEFAULT_DATA.tags, 'test3'])
+  },
+})
+
+describe('Create Subscriber', () => {
+  test('Creates a new subscriber', async ({ email }) => {
+    const result = await createSubscriber(email, DEFAULT_DATA)
+
+    expect(result.email_address).toBe(email)
+    expect(result.metadata.first_name).toBe(DEFAULT_DATA.metadata.first_name)
+    expect(result.tags).toContain(DEFAULT_DATA.tags[0])
+    expect(result.tags).toContain(DEFAULT_DATA.tags[1])
+    expect(result.type).toBe('unactivated')
+  })
+
+  test('Bypasses double-opt-in', async ({ email }) => {
+    const result = await createSubscriber(email, DEFAULT_DATA, {
+      double_opt_in: true,
+    })
+    expect(result.type).toBe('regular')
+  })
+})
+
+describe('Get Subscriber', () => {
+  test('Gets a subscriber', async ({ email }) => {
+    await createSubscriber(email, DEFAULT_DATA)
+    const result = await getSubscriber(email)
+    expect(result.email_address).toBe(email)
+    expect(result.metadata.first_name).toBe(DEFAULT_DATA.metadata.first_name)
+    expect(result.tags).toContain(DEFAULT_DATA.tags[0])
+    expect(result.tags).toContain(DEFAULT_DATA.tags[1])
+  })
+
+  test('Null if no subscriber', async () => {
+    const result = await getSubscriber('nonexistent@example.com')
+    expect(result).toBeNull()
+  })
+})
+
+describe('Update Subscriber', () => {
+  test('updates subscriber tags and metadata', async ({ email }) => {
+    await createSubscriber(email, DEFAULT_DATA)
+
+    const result = await updateSubscriber(email, {
+      tags: ['test3'],
+      metadata: { last_name: 'Last' },
+    })
+
+    expect(result.tags).toContain('test')
+    expect(result.tags).toContain('test2')
+    expect(result.tags).toContain('test3')
+    expect(result.metadata.last_name).toBe('Last')
+    expect(result.metadata.first_name).toBe(DEFAULT_DATA.metadata.first_name)
+  })
+
+  test('Overwrites tags', async ({ email }) => {
+    await createSubscriber(email, DEFAULT_DATA)
+    const result = await updateSubscriber(
+      email,
+      { tags: ['test3'] },
+      { overwrite: true },
+    )
+
+    expect(result.tags).toContain('test3')
+    expect(result.tags).not.toContain('test')
+    expect(result.tags).not.toContain('test2')
+    expect(result.metadata.first_name).toBe(DEFAULT_DATA.metadata.first_name)
+  })
+
+  test('Overwrites metadata', async ({ email }) => {
+    await createSubscriber(email, DEFAULT_DATA)
+    const result = await updateSubscriber(
+      email,
+      { metadata: { last_name: 'Last' } },
+      { overwrite: true },
+    )
+
+    expect(result.tags).toContain('test')
+    expect(result.tags).toContain('test2')
+    expect(result.metadata.first_name).not.toBe(
+      DEFAULT_DATA.metadata.first_name,
+    )
+    expect(result.metadata.last_name).toBe('Last')
+  })
+})
+
+describe('Remove Tags from Subscriber', () => {
+  test('Retains other tags', async ({ email }) => {
+    await createSubscriber(email, DEFAULT_DATA)
+    const result = await removeTagsFromSubscriber(email, ['test2'])
+
+    expect(result.tags).toContain('test')
+    expect(result.tags).not.toContain('test2')
+  })
+})

package/eslint.config.js

@@ -0,0 +1,2 @@
+import config from '@splendidlabz/eslint-config'
+export default config

package/package.json

@@ -1,23 +1,33 @@
 {
   "name": "@splendidlabz/third-party",
   "prettier": "@splendidlabz/prettier-config",
-  "version": "0.1.0",
+  "version": "1.1.0-beta.0",
   "description": "",
   "type": "module",
   "main": "index.js",
   "sideEffects": false,
+  "exports": {
+    "./google": "./google.js",
+    "./postmark": "./postmark.js",
+    "./buttondown": "./buttondown.js",
+    "./stripe": "./stripe.js"
+  },
   "scripts": {
-    "lint": "eslint . --fix"
+    "lint": "eslint . --fix",
+    "test": "vitest",
+    "test:watch": "vitest --watch"
   },
   "author": "Zell Liew <zellwk@gmail.com>",
   "dependencies": {
-    "googleapis": "^140.0.1",
+    "@splendidlabz/utils": "1.5.0-beta.5",
+    "googleapis": "^148.0.0",
     "http-errors": "^2.0.0",
-    "postmark": "^4.0.4",
+    "postmark": "^4.0.5",
+    "vitest": "^3.1.4",
     "zl-fetch": "^6.0.6"
   },
   "devDependencies": {
-    "@splendidlabz/eslint-config": "*",
-    "@splendidlabz/prettier-config": "*"
+    "@splendidlabz/eslint-config": "2.0.0-alpha.1",
+    "@splendidlabz/prettier-config": "1.1.0-beta.2"
   }
 }

package/postmark.js

@@ -1,20 +1,22 @@
 import postmark from 'postmark'
 
-const POSTMARK_KEY = import.meta.env.POSTMARK_KEY
+const POSTMARK_KEY = process.env.POSTMARK_KEY
 const DEFAULT_OPTIONS = {
   MessageStream: 'outbound', // outbound | broadcast
 }
 
 const client = new postmark.ServerClient(POSTMARK_KEY)
 
-// Allow for default options
 export default function Postmark(options) {
   const baseOpts = Object.assign({}, DEFAULT_OPTIONS, options)
 
   return {
-    // Sends email with Postmark
-    sendEmail(newOptions) {
-      const opts = Object.assign({}, baseOpts, newOptions)
+    constructEmailAddress(name, email) {
+      return `${name} <${email}>`
+    },
+
+    sendEmail(options) {
+      const opts = Object.assign({}, baseOpts, options)
       const { from, to, replyTo, subject, html, text, ...rest } = opts
 
       return client.sendEmail({
@@ -29,19 +31,3 @@ export default function Postmark(options) {
     },
   }
 }
-
-// Allow for direct usage
-export async function sendEmail(newOptions) {
-  const opts = Object.assign({}, DEFAULT_OPTIONS, newOptions)
-  const { from, to, replyTo, subject, html, text, ...rest } = opts
-
-  return client.sendEmail({
-    From: from,
-    To: to,
-    ReplyTo: replyTo,
-    Subject: subject,
-    HTMLBody: html,
-    TextBody: text,
-    ...rest,
-  })
-}

package/stripe.js

@@ -49,14 +49,14 @@ export async function verifyStripeWebhookEvent({
  * @param {string} props.customer - Customer ID
  * @param {string} props.return_url - Return URL to be directed to
  * @param {FlowType} [props.flow_type] - Flow type. Defaults to null.
- * @param {string} [props.subscriptionId] - Subscription ID to be updated or cancelled.
+ * @param {string} [props.subscription_id] - Subscription ID to be updated or cancelled.
  * @returns {Promise<Object>} The created billing portal session.
  * @example
  * const session = await createBillingPortalSession(stripe, {
  *   customer: 'cus_123456789',
  *   return_url: 'https://example.com/return',
  *   flow_type: 'subscription_update',
- *   subscriptionId: 'sub_123456789'
+ *   subscription_id: 'sub_123456789'
  * });
  */
 export async function createBillingPortalSession(stripe, props = {}) {
@@ -64,7 +64,7 @@ export async function createBillingPortalSession(stripe, props = {}) {
     customer,
     return_url,
     flow_type = null,
-    subscriptionId = null,
+    subscription_id = null,
   } = props
 
   const bpData = {
@@ -80,8 +80,8 @@ export async function createBillingPortalSession(stripe, props = {}) {
     flow_type === 'subscription_update' ||
     flow_type === 'subscription_cancel'
   ) {
-    if (!subscriptionId) throw new Error('Subscription ID is required')
-    bpData.flow_data[flow_type] = { subscription: subscriptionId }
+    if (!subscription_id) throw new Error('Subscription ID is required')
+    bpData.flow_data[flow_type] = { subscription: subscription_id }
   }
 
   return stripe.billingPortal.sessions.create(omitEmpty(bpData))

package/vitest.config.js

@@ -0,0 +1,23 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    // Increase timeout for API tests
+    testTimeout: 10000,
+
+    // Better error output
+    onConsoleLog(log, type) {
+      console.log(`[${type}] ${log}`)
+      return false
+    },
+
+    // Show test progress
+    progress: true,
+
+    // Better diff output
+    diffLimit: 1000,
+
+    // Show test location in output
+    location: true,
+  },
+})

package/.eslintrc.cjs

@@ -1,3 +0,0 @@
-module.exports = {
-  extends: ['@splendidlabz/eslint-config'],
-}