improve the recape email design

libs/core/src/integration/email.schemas.ts

@@ -75,6 +75,7 @@ export const GetRecapEmailData = {
   input: z.object({
     user_id: z.string(),
   }),
+
   output: z.object({
     discussion: z.array(
       z.union([
@@ -91,9 +92,9 @@ export const GetRecapEmailData = {
     ),
     num_notifications: z.number(),
     notifications_link: z.string(),
+    unsubscribe_link: z.string(),
   }),
 };
-
 export const EnrichedThread = Thread.extend({
   name: z
     .string()

libs/model/src/emails/GetRecapEmailData.query.ts

@@ -15,10 +15,9 @@ import {
 } from '@hicommonwealth/core';
 import { QueryTypes } from 'sequelize';
 import z from 'zod';
-import { config, models } from '..';
+import { config, generateUnsubscribeLink, models } from '..';
 
 const log = logger(import.meta);
-
 type AdditionalMetaData<Key extends keyof typeof EnrichedNotificationNames> = {
   event_name: (typeof EnrichedNotificationNames)[Key];
   inserted_at: string;
@@ -53,7 +52,6 @@ async function getMessages(userId: string): Promise<{
   const sevenDaysAgo = new Date(new Date().getTime() - 604_800_000);
   let oldestFetched = new Date();
   let cursor: string | undefined;
-
   const provider = notificationsProvider();
   while (
     oldestFetched > sevenDaysAgo &&
@@ -268,6 +266,7 @@ export function GetRecapEmailDataQuery(): Query<typeof GetRecapEmailData> {
       const enrichedDiscussion = await enrichDiscussionNotifications(
         notifications.discussion,
       );
+      const unSubscribeLink = await generateUnsubscribeLink(payload.user_id);
       return {
         discussion: enrichedDiscussion,
         ...enrichedGovernanceAndProtocol,
@@ -276,6 +275,7 @@ export function GetRecapEmailDataQuery(): Query<typeof GetRecapEmailData> {
           enrichedGovernanceAndProtocol.governance.length +
           enrichedGovernanceAndProtocol.protocol.length,
         notifications_link: config.SERVER_URL,
+        unsubscribe_link: unSubscribeLink,
       };
     },
   };

libs/model/src/models/user.ts

@@ -74,6 +74,7 @@ export default (sequelize: Sequelize.Sequelize): UserModelStatic =>
       selected_community_id: { type: Sequelize.STRING, allowNull: true },
       profile: { type: Sequelize.JSONB, allowNull: false },
       xp_points: { type: Sequelize.INTEGER, defaultValue: 0, allowNull: true },
+      unsubscribe_uuid: { type: Sequelize.STRING, allowNull: true },
       referral_eth_earnings: {
         type: Sequelize.FLOAT,
         allowNull: false,
@@ -95,6 +96,7 @@ export default (sequelize: Sequelize.Sequelize): UserModelStatic =>
             'isAdmin',
             'created_at',
             'updated_at',
+            'unsubscribe_uuid',
           ],
         },
       },

libs/model/src/subscription/UnSubscribeEmail.command.ts

@@ -0,0 +1,23 @@
+import { type Command } from '@hicommonwealth/core';
+import * as schemas from '@hicommonwealth/schemas';
+import { models } from '../database';
+import { mustExist } from '../middleware/guards';
+import { handleSubscriptionPreferencesUpdate } from '../utils/handleSubscriptionPreferencesUpdate';
+export function UnsubscribeEmail(): Command<typeof schemas.UnsubscribeEmail> {
+  return {
+    ...schemas.UnsubscribeEmail,
+    auth: [],
+    secure: false,
+    body: async ({ payload }) => {
+      const user = await models.User.findOne({
+        where: { unsubscribe_uuid: payload.user_uuid },
+      });
+      mustExist('User', user);
+
+      return await handleSubscriptionPreferencesUpdate({
+        userIdentifier: user.id as number,
+        payload,
+      });
+    },
+  };
+}

libs/model/src/subscription/UpdateSubscriptionPreferences.command.ts

@@ -1,26 +1,6 @@
 import { type Command } from '@hicommonwealth/core';
-import { emitEvent } from '@hicommonwealth/model';
 import * as schemas from '@hicommonwealth/schemas';
-import { SubscriptionPreference } from '@hicommonwealth/schemas';
-import { z } from 'zod';
-import { models } from '../database';
-
-function getDifferences(
-  fullObject: Record<string, unknown>,
-  subsetObject: Record<string, unknown>,
-): Partial<z.infer<typeof SubscriptionPreference>> {
-  const differences: Record<string, unknown> = {};
-  for (const key in subsetObject) {
-    if (
-      key !== 'id' &&
-      key in subsetObject &&
-      subsetObject[key] !== fullObject[key]
-    ) {
-      differences[key] = subsetObject[key];
-    }
-  }
-  return differences;
-}
+import { handleSubscriptionPreferencesUpdate } from '../utils/handleSubscriptionPreferencesUpdate';
 
 export function UpdateSubscriptionPreferences(): Command<
   typeof schemas.UpdateSubscriptionPreferences
@@ -30,52 +10,10 @@ export function UpdateSubscriptionPreferences(): Command<
     auth: [],
     secure: true,
     body: async ({ payload, actor }) => {
-      const existingPreferences: z.infer<typeof SubscriptionPreference> | null =
-        await models.SubscriptionPreference.findOne({
-          where: {
-            user_id: actor.user.id,
-          },
-          raw: true,
-        });
-
-      if (!existingPreferences) {
-        throw new Error('Existing preferences not found');
-      }
-
-      const preferenceUpdates = getDifferences(existingPreferences, payload);
-      if (!Object.keys(preferenceUpdates).length) {
-        return existingPreferences;
-      }
-
-      let result;
-      await models.sequelize.transaction(async (transaction) => {
-        result = await models.SubscriptionPreference.update(payload, {
-          where: {
-            user_id: actor.user.id,
-          },
-          returning: true,
-          transaction,
-        });
-
-        if (result[1].length !== 1)
-          throw new Error('Failed to update subscription preferences');
-
-        await emitEvent(
-          models.Outbox,
-          [
-            {
-              event_name: schemas.EventNames.SubscriptionPreferencesUpdated,
-              event_payload: {
-                user_id: existingPreferences.user_id,
-                ...preferenceUpdates,
-              },
-            },
-          ],
-          transaction,
-        );
+      return await handleSubscriptionPreferencesUpdate({
+        userIdentifier: Number(actor.user.id),
+        payload,
       });
-
-      return result![1][0].get({ plain: true });
     },
   };
 }

libs/model/src/subscription/index.ts

@@ -9,5 +9,6 @@ export * from './GetCommunityAlerts.query';
 export * from './GetSubscriptionPreferences.query';
 export * from './GetThreadSubscriptions.query';
 export * from './RegisterClientRegistrationToken.command';
+export * from './UnSubscribeEmail.command';
 export * from './UnregisterClientRegistrationToken.command';
 export * from './UpdateSubscriptionPreferences.command';

libs/model/src/utils/generateUnsubscribeLink.ts

@@ -0,0 +1,16 @@
+import { v4 as uuidv4 } from 'uuid';
+import { config, models } from '..';
+
+/**
+ * Generates an unsubscribe link for a user and updates the database.
+ * @param userId - The user's ID
+ * @returns {Promise<string>} - The unsubscribe link
+ */
+export async function generateUnsubscribeLink(userId: string): Promise<string> {
+  const unsubscribeUuid = uuidv4();
+  await models.User.update(
+    { unsubscribe_uuid: unsubscribeUuid },
+    { where: { id: userId } },
+  );
+  return `${config.SERVER_URL}/unsubscribe/${unsubscribeUuid}`;
+}

libs/model/src/utils/handleSubscriptionPreferencesUpdate.ts

@@ -0,0 +1,74 @@
+import { InvalidState } from '@hicommonwealth/core';
+import * as schemas from '@hicommonwealth/schemas';
+import { SubscriptionPreference } from '@hicommonwealth/schemas';
+import { z } from 'zod';
+import { models } from '../database';
+import { mustExist } from '../middleware/guards';
+import { emitEvent } from './utils';
+
+function getDifferences(
+  fullObject: Record<string, unknown>,
+  subsetObject: Record<string, unknown>,
+): Partial<z.infer<typeof SubscriptionPreference>> {
+  const differences: Record<string, unknown> = {};
+  for (const key in subsetObject) {
+    if (
+      key !== 'id' &&
+      key in subsetObject &&
+      subsetObject[key] !== fullObject[key]
+    ) {
+      differences[key] = subsetObject[key];
+    }
+  }
+  return differences;
+}
+
+export async function handleSubscriptionPreferencesUpdate({
+  userIdentifier,
+  payload,
+}: {
+  userIdentifier: number;
+  payload: Partial<z.infer<typeof SubscriptionPreference>>;
+}) {
+  const existingPreferences: z.infer<typeof SubscriptionPreference> | null =
+    await models.SubscriptionPreference.findOne({
+      where: {
+        user_id: userIdentifier,
+      },
+      raw: true,
+    });
+
+  mustExist('existingPreferences', existingPreferences);
+
+  const preferenceUpdates = getDifferences(existingPreferences, payload);
+  if (!Object.keys(preferenceUpdates).length) {
+    return existingPreferences;
+  }
+  let result;
+  await models.sequelize.transaction(async (transaction) => {
+    result = await models.SubscriptionPreference.update(payload, {
+      where: { user_id: userIdentifier },
+      returning: true,
+      transaction,
+    });
+    if (result[1].length !== 1) {
+      throw new InvalidState('Failed to update subscription preferences');
+    }
+
+    await emitEvent(
+      models.Outbox,
+      [
+        {
+          event_name: schemas.EventNames.SubscriptionPreferencesUpdated,
+          event_payload: {
+            user_id: existingPreferences.user_id,
+            ...preferenceUpdates,
+          },
+        },
+      ],
+      transaction,
+    );
+  });
+
+  return result![1][0].get({ plain: true });
+}

libs/model/src/utils/index.ts

@@ -3,6 +3,7 @@ export * from './decodeContent';
 export * from './defaultAvatar';
 export * from './denormalizedCountUtils';
 export * from './farcasterUtils';
+export * from './generateUnsubscribeLink';
 export * from './getDefaultContestImage';
 export * from './getDelta';
 export * from './makeGetBalancesOptions';

libs/schemas/src/commands/subscription.schemas.ts

@@ -91,3 +91,11 @@ export const UnregisterClientRegistrationToken = {
   }),
   output: z.object({}),
 };
+
+export const UnsubscribeEmail = {
+  input: z.object({
+    user_uuid: z.string().uuid(),
+    email_notifications_enabled: z.boolean(),
+  }),
+  output: SubscriptionPreference,
+};

libs/schemas/src/entities/user.schemas.ts

@@ -53,6 +53,8 @@ export const User = z.object({
 
   profile: UserProfile,
   xp_points: PG_INT.default(0).nullish(),
+  referral_link: z.string().nullish(),
+  unsubscribe_uuid: z.string().uuid().nullish(),
   referral_eth_earnings: z.number().optional(),
 
   ProfileTags: z.array(ProfileTags).optional(),

packages/commonwealth/client/scripts/navigation/CommonDomainRoutes.tsx

@@ -116,6 +116,8 @@ const ProfilePageRedirect = lazy(() => import('views/pages/profile_redirect'));
 const CommunityNotFoundPage = lazy(
   () => import('views/pages/CommunityNotFoundPage'),
 );
+
+const UnSubscribePage = lazy(() => import('views/pages/UnSubscribePage'));
 const RewardsPage = lazy(() => import('views/pages/RewardsPage'));
 
 const CommonDomainRoutes = ({ launchpadEnabled }: RouteFeatureFlags) => [
@@ -153,6 +155,11 @@ const CommonDomainRoutes = ({ launchpadEnabled }: RouteFeatureFlags) => [
     path="/createCommunity"
     element={withLayout(CreateCommunityPage, { type: 'common' })}
   />,
+  <Route
+    key="/unSubscribe/:userId"
+    path="/unSubscribe/:userId"
+    element={withLayout(UnSubscribePage, { type: 'common' })}
+  />,
   ...(launchpadEnabled
     ? [
         <Route

packages/commonwealth/client/scripts/navigation/CustomDomainRoutes.tsx

@@ -101,6 +101,7 @@ const NewSnapshotProposalPage = lazy(
 const NewProfilePage = lazy(() => import('views/pages/new_profile'));
 const EditNewProfilePage = lazy(() => import('views/pages/edit_new_profile'));
 const ProfilePageRedirect = lazy(() => import('views/pages/profile_redirect'));
+const UnSubscribePage = lazy(() => import('views/pages/UnSubscribePage'));
 
 const RewardsPage = lazy(() => import('views/pages/RewardsPage'));
 
@@ -119,6 +120,11 @@ const CustomDomainRoutes = ({ launchpadEnabled }: RouteFeatureFlags) => {
       path="/createCommunity"
       element={withLayout(CreateCommunityPage, { type: 'common' })}
     />,
+    <Route
+      key="/unSubscribe/:userId"
+      path="/unSubscribe/:userId"
+      element={withLayout(UnSubscribePage, { type: 'common' })}
+    />,
     ...(launchpadEnabled
       ? [
           <Route

packages/commonwealth/client/scripts/state/api/trpc/subscription/useUnSubscribeEmailMutation.ts

@@ -0,0 +1,5 @@
+import { trpc } from 'utils/trpcClient';
+
+export function useUnSubscribeEmailMutation() {
+  return trpc.subscriptions.unSubscribeEmail.useMutation();
+}

packages/commonwealth/client/scripts/views/modals/UnSubscribeModal/UnSubscribeModal.scss

@@ -0,0 +1,10 @@
+@import '../../../styles/shared.scss';
+
+.UnSubscribeModal {
+  .CWModalBody {
+    padding-bottom: 24px !important;
+  }
+  .CWModalFooter .primary {
+    background-color: $rorange-400 !important;
+  }
+}