mg-beehiiv-members: Add tiers as labels

Author: PaulAdamDavis

packages/mg-beehiiv-members/package.json

@@ -36,6 +36,7 @@
   "dependencies": {
     "@tryghost/debug": "0.1.35",
     "@tryghost/errors": "1.3.8",
-    "@tryghost/mg-fs-utils": "0.12.14"
+    "@tryghost/mg-fs-utils": "0.12.14",
+    "@tryghost/string": "0.2.17"
   }
 }

packages/mg-beehiiv-members/src/lib/process.ts

@@ -1,4 +1,5 @@
 import fsUtils from '@tryghost/mg-fs-utils';
+import {slugify} from '@tryghost/string';
 
 type memberObject = {
     email: string;
@@ -47,7 +48,6 @@ const processCsv = async ({csvPath}: {csvPath: string}) => {
         };
 
         // First Name,Last Name
-
         if (member['First Name'] || member['Last Name']) {
             const firstName = member?.['First Name']?.trim() || '';
             const lastName = member?.['Last Name']?.trim() || '';
@@ -71,17 +71,13 @@ const processCsv = async ({csvPath}: {csvPath: string}) => {
             newMember.stripe_customer_id = 'auto';
         }
 
-        if (member['Free Tier'] === 'Yes') {
-            newMember.labels.push(`beehiiv-tier-free`);
-        }
-
-        if (member['Premium Tier'] === 'Yes') {
-            newMember.labels.push(`beehiiv-premium-free`);
-        }
-
-        if (member.tier) {
-            newMember.labels.push(`beehiiv-tier-${member.tier}`);
-        }
+        const tierKeys = Object.keys(member).filter(key => key.endsWith('Tier'));
+        tierKeys.forEach((key: string) => {
+            if (member[key] === 'Yes') {
+                const slugifiedTier = slugify(key);
+                newMember.labels.push(`beehiiv-tier-${slugifiedTier}`);
+            }
+        });
 
         if (member.stripe_customer_id) {
             allMembers.paid.push(newMember);

packages/mg-beehiiv-members/src/test/fixtures/members.csv

@@ -1,10 +1,10 @@
-email,First Name,Last Name,status,tier,created_at,stripe_customer_id,Free Tier,Premium Tier,unsubscribed_at,Subscription Date (Substack)
-lorem@example.com, Lorem Name  ,,active,free,2023-03-24 10:23:10 UTC,,Yes,No,,
-ipsum@example.com,  Ipsum  , Name ,active,premium,2023-03-24 10:36:47 UTC,,No,Yes,,
-dolor@example.com, , Dolor Name   ,inactive,free,2023-03-24 10:36:48 UTC,,Yes,No,,
-simet@example.com,,,inactive,premium,2023-03-24 10:37:04 UTC,,No,Yes,,
-amett@example.com,,,pending,free,2023-04-11 14:02:46 UTC,,Yes,No,,
-elit@example.com,,,active,premium,2023-04-11 14:02:46 UTC,cus_1234,No,Yes,,
-nullfirst@example.com,, Last Only ,active,free,2023-04-11 14:02:47 UTC,,Yes,No,,
-unsublit@example.com,,,active,premium,2023-04-11 14:02:46 UTC,cus_1234,No,Yes,2024-03-13 11:33:53 UTC,
-fromsubstack@example.com,,,active,free,2023-04-11 14:02:46 UTC,,Yes,No,,2022-03-12 11:43:23 UTC
+email,First Name,Last Name,status,tier,created_at,stripe_customer_id,Free Tier,Bronze Tier,Silver Tier,Gold Tier,unsubscribed_at,Subscription Date (Substack)
+lorem@example.com, Lorem Name  ,,active,free,2023-03-24 10:23:10 UTC,,Yes,No,No,No,,
+ipsum@example.com,  Ipsum  , Name ,active,premium,2023-03-24 10:36:47 UTC,,No,No,Yes,No,,
+dolor@example.com, , Dolor Name   ,inactive,free,2023-03-24 10:36:48 UTC,,Yes,No,No,No,,
+simet@example.com,,,inactive,premium,2023-03-24 10:37:04 UTC,,No,No,No,No,,
+amett@example.com,,,pending,free,2023-04-11 14:02:46 UTC,,Yes,No,No,No,,
+elit@example.com,,,active,premium,2023-04-11 14:02:46 UTC,cus_1234,No,Yes,No,No,,
+nullfirst@example.com,, Last Only ,active,free,2023-04-11 14:02:47 UTC,,No,No,No,Yes,,
+unsublit@example.com,,,active,premium,2023-04-11 14:02:46 UTC,cus_1234,No,Yes,No,No,2024-03-13 11:33:53 UTC,
+fromsubstack@example.com,,,active,free,2023-04-11 14:02:46 UTC,,Yes,No,No,No,,2022-03-12 11:43:23 UTC

packages/mg-beehiiv-members/src/test/process.test.ts

@@ -19,6 +19,34 @@ describe('beehiiv Members', () => {
         assert.equal(processed.paid[0].stripe_customer_id, 'cus_1234');
     });
 
+    it('Sets tiers as labels', async () => {
+        const processed = await processCsv({csvPath: join(fixturesPath, 'members.csv')});
+
+        // Free tier
+        assert.equal(processed.free[0].email, 'lorem@example.com');
+        assert.equal(processed.free[0].labels.length, 2);
+        assert.equal(processed.free[0].labels[0], 'beehiiv-status-active');
+        assert.equal(processed.free[0].labels[1], 'beehiiv-tier-free-tier');
+
+        // Bronze tier
+        assert.equal(processed.paid[0].email, 'elit@example.com');
+        assert.equal(processed.paid[0].labels.length, 2);
+        assert.equal(processed.paid[0].labels[0], 'beehiiv-status-active');
+        assert.equal(processed.paid[0].labels[1], 'beehiiv-tier-bronze-tier');
+
+        // Silver tier
+        assert.equal(processed.free[1].email, 'ipsum@example.com');
+        assert.equal(processed.free[1].labels.length, 2);
+        assert.equal(processed.free[1].labels[0], 'beehiiv-status-active');
+        assert.equal(processed.free[1].labels[1], 'beehiiv-tier-silver-tier');
+
+        // Gold tier
+        assert.equal(processed.free[3].email, 'nullfirst@example.com');
+        assert.equal(processed.free[3].labels.length, 2);
+        assert.equal(processed.free[3].labels[0], 'beehiiv-status-active');
+        assert.equal(processed.free[3].labels[1], 'beehiiv-tier-gold-tier');
+    });
+
     it('Uses names is present', async () => {
         const processed = await processCsv({csvPath: join(fixturesPath, 'members.csv')});
 

packages/mg-beehiiv-members/src/types.d.ts

@@ -1 +1,2 @@
+declare module '@tryghost/string';
 declare module '@tryghost/mg-fs-utils';