waha-shared 1.0.528 → 1.0.530

package/dist/types/dripSequence.js

@@ -12,6 +12,6 @@ exports.DRIP_LANGUAGES = ['eng', 'ara', 'swe'];
 exports.DripLanguageId = zod_1.default.enum(exports.DRIP_LANGUAGES);
 exports.SubscribeDripBody = zod_1.default.object({
     sequence: exports.DripSequenceId,
-    languageId: exports.DripLanguageId,
+    languageId: zod_1.default.string(),
     firstName: zod_1.default.string().optional(),
 });

package/dist/types/languages.d.ts

@@ -55,6 +55,12 @@ export declare const LanguageInfoStatuses: z.ZodObject<{
         testing: "testing";
         launched: "launched";
     }>;
+    drip: z.ZodOptional<z.ZodEnum<{
+        notStarted: "notStarted";
+        inProgress: "inProgress";
+        testing: "testing";
+        launched: "launched";
+    }>>;
     dmCourse: z.ZodEnum<{
         notStarted: "notStarted";
         inProgress: "inProgress";

package/dist/types/logs.d.ts

@@ -1,7 +1,6 @@
 import z from 'zod';
 export declare const WahaShareContent: z.ZodEnum<{
     lesson: "lesson";
-    note: "note";
     lessonLink: "lessonLink";
     setLink: "setLink";
     app: "app";
@@ -21,6 +20,7 @@ export declare const WahaShareContent: z.ZodEnum<{
     scriptureAudio: "scriptureAudio";
     inviteGroup: "inviteGroup";
     offlineVersionLink: "offlineVersionLink";
+    note: "note";
     customSet: "customSet";
     microLesson: "microLesson";
 }>;
@@ -29,7 +29,6 @@ export declare const ShareLogEvent: z.ZodObject<{
     time: z.ZodNumber;
     content: z.ZodEnum<{
         lesson: "lesson";
-        note: "note";
         lessonLink: "lessonLink";
         setLink: "setLink";
         app: "app";
@@ -49,6 +48,7 @@ export declare const ShareLogEvent: z.ZodObject<{
         scriptureAudio: "scriptureAudio";
         inviteGroup: "inviteGroup";
         offlineVersionLink: "offlineVersionLink";
+        note: "note";
         customSet: "customSet";
         microLesson: "microLesson";
     }>;

package/dist/types/resend.d.ts

@@ -0,0 +1,60 @@
+import z from 'zod';
+import type { Status } from '../data/languages/languages.zod';
+/** The two onboarding drip audiences a new signup can be enrolled in. */
+export declare const DripSequenceId: z.ZodEnum<{
+    drip_believer: "drip_believer";
+    drip_seeker: "drip_seeker";
+}>;
+export type DripSequenceId = z.infer<typeof DripSequenceId>;
+/** Ids of languages whose `status.drip` in languages.json is one of these. */
+export declare function dripLanguagesWithStatus(...statuses: Status[]): string[];
+/**
+ * Languages the onboarding drip is live in: provisioned in Resend and enrolled
+ * into on signup. Driven by `status.drip` in languages.json.
+ */
+export declare const DRIP_LANGUAGES: string[];
+export declare const DripLanguageId: z.ZodString;
+export type DripLanguageId = z.infer<typeof DripLanguageId>;
+/**
+ * A single drip email's id: its sequence's id plus its position. The same as
+ * the file name for the email's source .md file.
+ */
+export type DripEmailId = `${DripSequenceId}_${number}`;
+/** `POST /api/submit-subscribe` (form data): an explicit newsletter signup. */
+export declare const NewsletterSignupBody: z.ZodObject<{
+    email: z.ZodPipe<z.ZodString, z.ZodEmail>;
+    name: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type NewsletterSignupBody = z.infer<typeof NewsletterSignupBody>;
+/** `POST /api/submit-contact` (form data): the website's contact form. */
+export declare const ContactFormBody: z.ZodObject<{
+    email: z.ZodPipe<z.ZodString, z.ZodEmail>;
+    name: z.ZodString;
+    message: z.ZodString;
+}, z.core.$strip>;
+export type ContactFormBody = z.infer<typeof ContactFormBody>;
+/**
+ * `POST /api/add-to-donation-sequence` (JSON): starts the donor thank-you
+ * drip.
+ */
+export declare const DonorSequenceBody: z.ZodObject<{
+    email: z.ZodPipe<z.ZodString, z.ZodEmail>;
+    name: z.ZodOptional<z.ZodString>;
+    newsletter: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type DonorSequenceBody = z.infer<typeof DonorSequenceBody>;
+/**
+ * `POST /api/subscribe-drip` (JSON, Firebase ID token). Any language is
+ * accepted so callers don't need to know which ones have a drip; unsupported
+ * ones are a no-op.
+ */
+export declare const SubscribeDripBody: z.ZodObject<{
+    sequence: z.ZodEnum<{
+        drip_believer: "drip_believer";
+        drip_seeker: "drip_seeker";
+    }>;
+    languageId: z.ZodString;
+    firstName: z.ZodOptional<z.ZodString>;
+    newsletter: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type SubscribeDripBody = z.infer<typeof SubscribeDripBody>;

package/dist/types/resend.js

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscribeDripBody = exports.DonorSequenceBody = exports.ContactFormBody = exports.NewsletterSignupBody = exports.DripLanguageId = exports.DRIP_LANGUAGES = exports.DripSequenceId = void 0;
+exports.dripLanguagesWithStatus = dripLanguagesWithStatus;
+const zod_1 = __importDefault(require("zod"));
+const languages_1 = require("../data/languages");
+/** The two onboarding drip audiences a new signup can be enrolled in. */
+exports.DripSequenceId = zod_1.default.enum(['drip_believer', 'drip_seeker']);
+/** Ids of languages whose `status.drip` in languages.json is one of these. */
+function dripLanguagesWithStatus(...statuses) {
+    return languages_1.languages
+        .filter((language) => statuses.includes(language.status.drip ?? 'notStarted'))
+        .map((language) => language.languageId);
+}
+/**
+ * Languages the onboarding drip is live in: provisioned in Resend and enrolled
+ * into on signup. Driven by `status.drip` in languages.json.
+ */
+exports.DRIP_LANGUAGES = dripLanguagesWithStatus('launched');
+exports.DripLanguageId = zod_1.default
+    .string()
+    .refine((id) => exports.DRIP_LANGUAGES.includes(id), 'Not a launched drip language.');
+/*
+ * Request bodies for the website endpoints that write to Resend. The website
+ * parses incoming requests with these, and the app types what it sends with
+ * them. Auth (a reCAPTCHA token or a Firebase ID token) isn't part of the body
+ * schemas; each endpoint checks it separately.
+ */
+const Email = zod_1.default.string().trim().pipe(zod_1.default.email());
+const Name = zod_1.default.string().trim().max(200);
+/**
+ * Whether the user ticked the newsletter box alongside this signup. Shipped app
+ * versions don't send it, and missing means no: the newsletter needs consent.
+ */
+const Newsletter = zod_1.default.boolean().optional();
+/** `POST /api/submit-subscribe` (form data): an explicit newsletter signup. */
+exports.NewsletterSignupBody = zod_1.default.object({
+    email: Email,
+    name: Name.optional(),
+});
+/** `POST /api/submit-contact` (form data): the website's contact form. */
+exports.ContactFormBody = zod_1.default.object({
+    email: Email,
+    name: Name,
+    message: zod_1.default.string().trim().min(1).max(5000),
+});
+/**
+ * `POST /api/add-to-donation-sequence` (JSON): starts the donor thank-you
+ * drip.
+ */
+exports.DonorSequenceBody = zod_1.default.object({
+    email: Email,
+    name: Name.optional(),
+    newsletter: Newsletter,
+});
+/**
+ * `POST /api/subscribe-drip` (JSON, Firebase ID token). Any language is
+ * accepted so callers don't need to know which ones have a drip; unsupported
+ * ones are a no-op.
+ */
+exports.SubscribeDripBody = zod_1.default.object({
+    sequence: exports.DripSequenceId,
+    languageId: zod_1.default.string(),
+    firstName: Name.optional(),
+    newsletter: Newsletter,
+});

package/dist/types/users.d.ts

@@ -17,7 +17,6 @@ export declare const SharedUserReduxState: z.ZodObject<{
     }, z.core.$strip>>;
     phoneNumber: z.ZodOptional<z.ZodString>;
     isInAGroup: z.ZodOptional<z.ZodBoolean>;
-    isSubscribedToEmailUpdates: z.ZodOptional<z.ZodBoolean>;
     hasDonated: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 /**
@@ -33,6 +32,7 @@ export declare const DeviceUserReduxState: z.ZodObject<{
     engagementScore: z.ZodOptional<z.ZodNumber>;
     finishedOnboarding: z.ZodOptional<z.ZodNumber>;
     firstOpen: z.ZodOptional<z.ZodNumber>;
+    newsletterOptIn: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 export declare const UserReduxState: z.ZodObject<{
     pastLocations: z.ZodOptional<z.ZodArray<z.ZodObject<{
@@ -44,6 +44,7 @@ export declare const UserReduxState: z.ZodObject<{
     engagementScore: z.ZodOptional<z.ZodNumber>;
     finishedOnboarding: z.ZodOptional<z.ZodNumber>;
     firstOpen: z.ZodOptional<z.ZodNumber>;
+    newsletterOptIn: z.ZodOptional<z.ZodBoolean>;
     email: z.ZodOptional<z.ZodEmail>;
     location: z.ZodOptional<z.ZodObject<{
         city: z.ZodOptional<z.ZodString>;
@@ -52,7 +53,6 @@ export declare const UserReduxState: z.ZodObject<{
     }, z.core.$strip>>;
     phoneNumber: z.ZodOptional<z.ZodString>;
     isInAGroup: z.ZodOptional<z.ZodBoolean>;
-    isSubscribedToEmailUpdates: z.ZodOptional<z.ZodBoolean>;
     hasDonated: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 export type UserReduxState = z.infer<typeof UserReduxState>;
@@ -79,6 +79,7 @@ export declare const DeviceInfo: z.ZodObject<{
     engagementScore: z.ZodOptional<z.ZodNumber>;
     finishedOnboarding: z.ZodOptional<z.ZodNumber>;
     firstOpen: z.ZodOptional<z.ZodNumber>;
+    newsletterOptIn: z.ZodOptional<z.ZodBoolean>;
     phoneLocation: z.ZodOptional<z.ZodString>;
     pushToken: z.ZodOptional<z.ZodString>;
     notificationPermission: z.ZodOptional<z.ZodEnum<{
@@ -107,6 +108,7 @@ export declare const DeviceInfoFields: {
     engagementScore: "engagementScore";
     finishedOnboarding: "finishedOnboarding";
     firstOpen: "firstOpen";
+    newsletterOptIn: "newsletterOptIn";
     phoneLocation: "phoneLocation";
     pushToken: "pushToken";
     notificationPermission: "notificationPermission";
@@ -128,7 +130,6 @@ export declare const WahaUser: z.ZodObject<{
     }, z.core.$strip>>;
     phoneNumber: z.ZodOptional<z.ZodString>;
     isInAGroup: z.ZodOptional<z.ZodBoolean>;
-    isSubscribedToEmailUpdates: z.ZodOptional<z.ZodBoolean>;
     hasDonated: z.ZodOptional<z.ZodBoolean>;
     wahaUserId: z.ZodString;
     name: z.ZodOptional<z.ZodString>;
@@ -151,7 +152,6 @@ export declare const WahaUserFields: {
     location: "location";
     phoneNumber: "phoneNumber";
     isInAGroup: "isInAGroup";
-    isSubscribedToEmailUpdates: "isSubscribedToEmailUpdates";
     hasDonated: "hasDonated";
     lastUpdate: "lastUpdate";
     hasAccount: "hasAccount";
@@ -244,7 +244,6 @@ export declare const LegacyWahaUser: z.ZodObject<{
         time: z.ZodNumber;
         content: z.ZodEnum<{
             lesson: "lesson";
-            note: "note";
             lessonLink: "lessonLink";
             setLink: "setLink";
             app: "app";
@@ -264,6 +263,7 @@ export declare const LegacyWahaUser: z.ZodObject<{
             scriptureAudio: "scriptureAudio";
             inviteGroup: "inviteGroup";
             offlineVersionLink: "offlineVersionLink";
+            note: "note";
             customSet: "customSet";
             microLesson: "microLesson";
         }>;
@@ -318,7 +318,6 @@ export declare const LegacyWahaUserFields: {
     location: "location";
     phoneNumber: "phoneNumber";
     isInAGroup: "isInAGroup";
-    isSubscribedToEmailUpdates: "isSubscribedToEmailUpdates";
     hasDonated: "hasDonated";
     pastLocations: "pastLocations";
     utm: "utm";
@@ -337,6 +336,7 @@ export declare const LegacyWahaUserFields: {
     sharingScore: "sharingScore";
     isAdvocate: "isAdvocate";
     isCCWorker: "isCCWorker";
+    isSubscribedToEmailUpdates: "isSubscribedToEmailUpdates";
     howFamiliarWithBible: "howFamiliarWithBible";
     followingFor2Years: "followingFor2Years";
     notificationsClicked: "notificationsClicked";

package/dist/types/users.js

@@ -22,7 +22,6 @@ exports.SharedUserReduxState = zod_1.default
     location: location_1.WahaUserLocation,
     phoneNumber: zod_1.default.string(),
     isInAGroup: zod_1.default.boolean(),
-    isSubscribedToEmailUpdates: zod_1.default.boolean(),
     hasDonated: zod_1.default.boolean(),
 })
     .partial();
@@ -36,6 +35,11 @@ exports.DeviceUserReduxState = zod_1.default
     engagementScore: zod_1.default.number(),
     finishedOnboarding: zod_1.default.number(),
     firstOpen: zod_1.default.number(),
+    /**
+     * Whether the newsletter box was ticked on the latest sign-in attempt.
+     * Kept here so the choice survives the trip out to a magic link and back.
+     */
+    newsletterOptIn: zod_1.default.boolean(),
 })
     .partial();
 exports.UserReduxState = zod_1.default.object({

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "waha-shared",
-  "version": "1.0.528",
+  "version": "1.0.530",
   "author": "Waha",
   "dependencies": {
     "@types/signale": "^1.4.7",
+    "resend": "^6.27.0",
     "signale": "^1.4.0"
   },
   "peerDependencies": {
@@ -28,7 +29,7 @@
   "license": "MIT",
   "scripts": {
     "build": "npx tsc && npx copyfiles \"data/**/*.json\" dist",
-    "update": "npm run build && REGISTRY_VERSION=$(npm view waha-shared version) && npm version $REGISTRY_VERSION --no-git-tag-version --allow-same-version && npm version patch --no-git-tag-version && git add . && (git commit -m 'chore: build waha-shared' || true) && bash -c 'npm publish --access public --registry https://registry.npmjs.org --//registry.npmjs.org/:_authToken=$(grep NPM_TOKEN= ../.env | cut -d \"=\" -f2-)'",
-    "updateManual": "(npm whoami || npm login) && npm run build && REGISTRY_VERSION=$(npm view waha-shared version) && npm version $REGISTRY_VERSION --no-git-tag-version --allow-same-version && npm version patch --no-git-tag-version && git add dist package.json && (git commit -m 'chore: build waha-shared' || true) && npm publish"
+    "update": "bash publish.sh",
+    "update:preview": "bash publish.sh --preview"
   }
 }

package/dist/functions/activeCampaign.d.ts

@@ -1,26 +0,0 @@
-declare const listNumbers: {
-    newsletter: number;
-    volunteer: number;
-    'dm-course': number;
-    'in-app-donation-sequence': number;
-};
-/**
- * The ActiveCampaign API URL that looks up a contact by email. The email is
- * encoded, since a raw `+` in a query string reads as a space and
- * `name+tag@x.com` would never match.
- */
-export declare function contactLookupUrl(apiUrl: string, email: string): string;
-export declare function addToACList({ baseUrl, email, list, token, name, }: {
-    token: string;
-    baseUrl: string;
-    email: string;
-    list: keyof typeof listNumbers;
-    name?: string;
-}): Promise<void>;
-export declare function getContactsInList({ baseUrl, limit, list, token, }: {
-    token: string;
-    baseUrl: string;
-    list: keyof typeof listNumbers;
-    limit?: number;
-}): Promise<string[]>;
-export {};

package/dist/functions/activeCampaign.js

@@ -1,119 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.contactLookupUrl = contactLookupUrl;
-exports.addToACList = addToACList;
-exports.getContactsInList = getContactsInList;
-const signale_1 = __importDefault(require("signale"));
-const zod_1 = require("zod");
-const listNumbers = {
-    newsletter: 3,
-    volunteer: 5,
-    'dm-course': 9,
-    'in-app-donation-sequence': 17,
-};
-/**
- * The ActiveCampaign API URL that looks up a contact by email. The email is
- * encoded, since a raw `+` in a query string reads as a space and
- * `name+tag@x.com` would never match.
- */
-function contactLookupUrl(apiUrl, email) {
-    return `${apiUrl}/contacts?email=${encodeURIComponent(email)}`;
-}
-/** The part of an ActiveCampaign list-contacts response that's read. */
-const ContactsPage = zod_1.z.object({
-    contacts: zod_1.z.array(zod_1.z.object({ id: zod_1.z.string(), email: zod_1.z.string() })).optional(),
-});
-/** The part of an ActiveCampaign contact lookup response that's read. */
-const ContactLookup = zod_1.z.object({
-    contacts: zod_1.z.array(zod_1.z.object({ id: zod_1.z.string() })),
-});
-/** The part of an ActiveCampaign create-contact response that's read. */
-const CreatedContact = zod_1.z.object({ contact: zod_1.z.object({ id: zod_1.z.string() }) });
-async function addToACList({ baseUrl, email, list, token, name, }) {
-    const headers = { 'Api-Token': token, 'Content-Type': 'application/json' };
-    const url = `${baseUrl}/api/3`;
-    const findContact = await fetch(contactLookupUrl(url, email), {
-        method: 'GET',
-        headers,
-    });
-    const findContactJson = await findContact.json();
-    if (!findContact.ok) {
-        throw new Error(`Failed to retrieve contact with ${email}. ${JSON.stringify(findContactJson)}`);
-    }
-    const [existingContact] = ContactLookup.parse(findContactJson).contacts;
-    let contactId;
-    if (existingContact) {
-        contactId = existingContact.id;
-    }
-    else {
-        const createContact = await fetch(`${url}/contacts`, {
-            method: 'POST',
-            headers,
-            body: JSON.stringify({
-                contact: { email, name },
-            }),
-        });
-        const createContactJson = await createContact.json();
-        if (!createContact.ok) {
-            throw new Error(`Failed to create new contact with ${email}. ${JSON.stringify(createContactJson)}`);
-        }
-        signale_1.default.success(`Created new AC contact with email ${email}.`);
-        contactId = CreatedContact.parse(createContactJson).contact.id;
-    }
-    const subscribe = await fetch(`${url}/contactLists`, {
-        method: 'POST',
-        headers: { 'Api-Token': token, 'Content-Type': 'application/json' },
-        body: JSON.stringify({
-            contactList: {
-                list: listNumbers[list],
-                status: 1,
-                contact: contactId,
-            },
-        }),
-    });
-    const subscribeJson = await subscribe.json();
-    if (!subscribe.ok) {
-        throw new Error(`Failed to add contact to list ${list}. Response: ${JSON.stringify(subscribeJson)}`);
-    }
-    signale_1.default.success(`${email} added to AC list ${list}.`);
-}
-async function getContactsInList({ baseUrl, limit = 100, list, token, }) {
-    const headers = { 'Api-Token': token, 'Content-Type': 'application/json' };
-    const url = `${baseUrl}/api/3`;
-    const allEmails = [];
-    let lastContactId = null;
-    let hasMoreContacts = true;
-    while (hasMoreContacts) {
-        let requestUrl = `${url}/contacts?listid=${listNumbers[list]}&orders[id]=ASC&limit=${limit}`;
-        if (lastContactId) {
-            requestUrl += `&id_greater=${lastContactId}`;
-        }
-        const response = await fetch(requestUrl, {
-            method: 'GET',
-            headers,
-        });
-        const data = await response.json();
-        if (!response.ok) {
-            throw new Error(`Failed to retrieve contacts in list ${list}. ${JSON.stringify(data)}`);
-        }
-        const contacts = ContactsPage.parse(data).contacts || [];
-        if (contacts.length === 0) {
-            hasMoreContacts = false;
-        }
-        else {
-            // Add emails from this batch
-            const emails = contacts.map((contact) => contact.email);
-            allEmails.push(...emails);
-            // Update the last contact ID for next iteration
-            lastContactId = contacts[contacts.length - 1].id;
-            // If we got fewer contacts than the limit, we've reached the end
-            if (contacts.length < limit) {
-                hasMoreContacts = false;
-            }
-        }
-    }
-    return allEmails;
-}