feat(tenant): changes account to tenant

trycourier · Aug 9, 2023 · cdc5f8b · cdc5f8b
1 parent 35b1e69
commit cdc5f8b
Show file tree

Hide file tree

Showing 25 changed files with 107 additions and 85 deletions.
diff --git a/packages/client-graphql/docs/inbox/1.methods.md b/packages/client-graphql/docs/inbox/1.methods.md
@@ -6,7 +6,7 @@ import { Inbox } from "@trycourier/client-graphql";
 const inboxApi = Inbox(authorization: Authorization);
 
 const getInboxCount = async (params?: {
-  accountId?: string,
+  tenantId?: string,
   status?: "read" | "unread",
   tags?: string[],
 }) => {
@@ -23,7 +23,7 @@ import { Inbox } from "@trycourier/client-graphql";
 const inboxApi = Inbox(authorization: Authorization);
 
 const getInboxMessages = async (params?: {
-  accountId?: string,
+  tenantId?: string,
   status?: "read" | "unread",
   tags?: string[],
 }) => {

diff --git a/packages/client-graphql/src/inbox/__tests__/count.spec.ts b/packages/client-graphql/src/inbox/__tests__/count.spec.ts
@@ -21,7 +21,7 @@ describe("getInboxCount", () => {
       Array [
         "https://fxw3r7gdm9.execute-api.us-east-1.amazonaws.com/production/q",
         Object {
-          "body": "{\\"query\\":\\"query GetInboxCount($params: FilterParamsInput) {\\\\n  count(params: $params)\\\\n}\\\\n\\",\\"operationName\\":\\"GetInboxCount\\",\\"variables\\":{}}",
+          "body": "{\\"query\\":\\"query GetInboxCount($params: FilterParamsInput) {\\\\n  count(params: $params)\\\\n}\\\\n\\",\\"operationName\\":\\"GetInboxCount\\",\\"variables\\":{\\"params\\":{}}}",
           "headers": Object {
             "content-type": "application/json",
             "x-courier-client-key": "CLIENT_KEY",

diff --git a/packages/client-graphql/src/inbox/count.ts b/packages/client-graphql/src/inbox/count.ts
@@ -7,7 +7,7 @@ export const GET_INBOX_COUNT = `
 `;
 
 export interface IInboxCountParams {
-  accountId?: string;
+  tenantId?: string;
   status: "read" | "unread";
   tags?: string[];
   from?: string | number;
@@ -23,9 +23,15 @@ export const getInboxCount =
       return Promise.resolve();
     }
 
+    const { tenantId, ...rest } = params || {};
+
     const results = await client
       .query(GET_INBOX_COUNT, {
-        params,
+        params: {
+          ...rest,
+          // [HACK] map tenantId to accountId in order to keep this backwards compatible
+          accountId: tenantId,
+        },
       })
       .toPromise();
     return results?.data;

diff --git a/packages/client-graphql/src/inbox/messages.ts b/packages/client-graphql/src/inbox/messages.ts
@@ -2,7 +2,7 @@ import { Client } from "urql";
 import { IActionElemental } from "./message";
 
 export interface IGetInboxMessagesParams {
-  accountId?: string;
+  tenantId?: string;
   archived?: boolean;
   from?: string | number;
   limit?: number;
@@ -100,13 +100,15 @@ export const getInboxMessages =
       return Promise.resolve(undefined);
     }
 
-    const { limit, ...restParams } = params ?? {};
+    const { limit, tenantId, ...restParams } = params ?? {};
     const results = await client
       .query(createGetInboxMessagesQuery(!after), {
         after,
         limit,
         params: {
           ...restParams,
+          // [HACK] map tenantId to accountId in order to keep this backwards compatible
+          accountId: tenantId,
           pinned: false,
         },
         pinnedParams: {

diff --git a/packages/client-graphql/src/messages.ts b/packages/client-graphql/src/messages.ts
@@ -9,7 +9,7 @@ export const GET_MESSAGE_COUNT = `
 `;
 
 export interface IMessageCountParams {
-  accountId?: string;
+  tenantId?: string;
   tags?: string[];
   from?: number;
   isRead?: boolean;
@@ -31,7 +31,7 @@ export const getMessageCount =
   };
 
 export interface IGetMessagesParams {
-  accountId?: string;
+  tenantId?: string;
   from?: number;
   isRead?: boolean;
   limit?: number;
@@ -136,9 +136,17 @@ export const getMessages =
       return Promise.resolve(undefined);
     }
 
-    const { limit, ...restParams } = params ?? {};
+    const { limit, tenantId, ...restParams } = params ?? {};
     const results = await client
-      .query(QUERY_MESSAGES, { after, limit, params: restParams })
+      .query(QUERY_MESSAGES, {
+        after,
+        limit,
+        params: {
+          ...restParams,
+          // [HACK] map tenantId to accountId in order to keep this backwards compatible
+          accountId: tenantId,
+        },
+      })
       .toPromise();
 
     const messages = results?.data?.messages?.nodes;

diff --git a/packages/client-graphql/src/preferences.ts b/packages/client-graphql/src/preferences.ts
@@ -88,30 +88,31 @@ const DRAFT_PREFERENCE_PAGE = `
   }
 `;
 
-type GetRecipientPreferences = (accountId?: string) => Promise<any>;
+type GetRecipientPreferences = (tenantId?: string) => Promise<any>;
 export const getRecipientPreferences =
   (client: Client | undefined): GetRecipientPreferences =>
-  async (accountId?: string) => {
+  async (tenantId?: string) => {
     if (!client) {
       return;
     }
 
     const results = await client
-      .query(RECIPIENT_PREFERENCES, { accountId })
+      .query(RECIPIENT_PREFERENCES, { accountId: tenantId })
       .toPromise();
     return results.data?.recipientPreferences.nodes;
   };
 
-type GetPreferencePage = (accountId?: string) => Promise<any>;
+type GetPreferencePage = (tenantId?: string) => Promise<any>;
 export const getPreferencePage =
   (client: Client | undefined): GetPreferencePage =>
-  async (accountId?: string) => {
+  async (tenantId?: string) => {
     if (!client) {
       return;
     }
     const results = await client
       .query(PREFERENCE_PAGE, {
-        accountId: accountId,
+        // [HACK] map tenantId to accountId in order to keep this backwards compatible
+        accountId: tenantId,
       })
       .toPromise();
     return results.data?.preferencePage;
@@ -140,7 +141,7 @@ type UpdateRecipientPreferences = (payload: {
   hasCustomRouting: boolean;
   routingPreferences: Array<string>;
   digestSchedule: string;
-  accountId?: string;
+  tenantId?: string;
 }) => Promise<any>;
 export const updateRecipientPreferences =
   (client: Client | undefined): UpdateRecipientPreferences =>
@@ -158,7 +159,7 @@ export const updateRecipientPreferences =
           routingPreferences: payload.routingPreferences,
           digestSchedule: payload.digestSchedule,
         },
-        accountId: payload.accountId,
+        accountId: payload.tenantId,
       })
       .toPromise();
 

diff --git a/packages/components/src/components/PreferencePage.tsx b/packages/components/src/components/PreferencePage.tsx
@@ -32,16 +32,16 @@ const FooterContainer = styled.div`
 `;
 
 const PreferencePage: React.FunctionComponent<{
-  accountId?: string;
+  tenantId?: string;
   draft?: boolean;
-}> = ({ accountId, draft = false }) => {
+}> = ({ tenantId, draft = false }) => {
   return (
     <PreferencePageContainer>
       <HeaderContainer>
         <Header />
       </HeaderContainer>
       <PreferencesV4Container>
-        <PreferencesV4 accountId={accountId} draft={draft} />
+        <PreferencesV4 tenantId={tenantId} draft={draft} />
       </PreferencesV4Container>
       <FooterContainer>
         <Footer />

diff --git a/packages/components/src/components/index.tsx b/packages/components/src/components/index.tsx
@@ -21,7 +21,7 @@ const querySelector = (element: HTMLElement, selector: string) => {
 export const CourierComponents: React.FunctionComponent = () => {
   const preferencePageDraftMode =
     window.courierConfig?.preferencePageDraftMode ?? false;
-  const accountId = window.courierConfig?.accountId;
+  const tenantId = window.courierConfig?.tenantId;
   const unsubscribePageConfig = window.courierConfig?.unsubscribePage;
 
   const componentConfigs = window.courierConfig?.components;
@@ -205,7 +205,7 @@ export const CourierComponents: React.FunctionComponent = () => {
         createPortal(
           <Suspense fallback={<div />}>
             <PreferencePage
-              accountId={accountId}
+              tenantId={tenantId}
               draft={preferencePageDraftMode}
             />
           </Suspense>,

diff --git a/packages/components/src/index.tsx b/packages/components/src/index.tsx
@@ -38,7 +38,7 @@ declare global {
   }
 }
 interface ICourierConfig {
-  accountId?: string;
+  tenantId?: string;
   apiUrl?: string;
   authorization?: string;
   brandId?: string;
@@ -68,7 +68,7 @@ let hasInit = false;
 
 const initCourier = async (courierConfig?: ICourierConfig) => {
   const {
-    accountId,
+    tenantId,
     apiUrl,
     authorization,
     brandId,
@@ -94,7 +94,7 @@ const initCourier = async (courierConfig?: ICourierConfig) => {
 
   render(
     <CourierProvider
-      accountId={accountId}
+      tenantId={tenantId}
       apiUrl={apiUrl}
       authorization={authorization}
       brandId={brandId}

diff --git a/packages/react-hooks/src/inbox/elemental-inbox/types.ts b/packages/react-hooks/src/inbox/elemental-inbox/types.ts
@@ -5,7 +5,7 @@ import {
 import { Brand } from "@trycourier/react-provider";
 
 export interface IElementalInbox {
-  accountId?: string;
+  tenantId?: string;
   brand?: Brand;
   from?: number;
   isLoading?: boolean;

diff --git a/packages/react-hooks/src/inbox/elemental-inbox/use-inbox-actions.ts b/packages/react-hooks/src/inbox/elemental-inbox/use-inbox-actions.ts
@@ -57,6 +57,7 @@ interface IInboxActions {
 
 const useElementalInboxActions = (): IInboxActions => {
   const {
+    tenantId,
     apiUrl,
     authorization,
     clientSourceId,
@@ -80,6 +81,7 @@ const useElementalInboxActions = (): IInboxActions => {
     clientSourceId,
     userId,
     userSignature,
+    tenantId,
   });
 
   const inboxClient = Inbox({ client: courierClient });
@@ -101,6 +103,7 @@ const useElementalInboxActions = (): IInboxActions => {
         type: "inbox/FETCH_UNREAD_MESSAGE_COUNT",
         payload: () =>
           inboxClient.getInboxCount({
+            tenantId: inbox?.tenantId,
             status: "unread",
           }),
       });
@@ -127,7 +130,7 @@ const useElementalInboxActions = (): IInboxActions => {
         type: "inbox/FETCH_UNREAD_MESSAGE_COUNT",
         payload: () =>
           inboxClient.getInboxCount({
-            accountId: inbox?.accountId,
+            tenantId: inbox?.tenantId,
             status: "unread",
           }),
       });

diff --git a/packages/react-hooks/src/inbox/types.ts b/packages/react-hooks/src/inbox/types.ts
@@ -4,7 +4,7 @@ import {
   OnEvent,
 } from "@trycourier/react-provider";
 export interface IInbox<T = IInboxMessagePreview> {
-  accountId?: string;
+  tenantId?: string;
   brand?: Brand;
   from?: number;
   isLoading?: boolean;

diff --git a/packages/react-hooks/src/inbox/use-inbox-actions.ts b/packages/react-hooks/src/inbox/use-inbox-actions.ts
@@ -49,6 +49,7 @@ export interface IInboxActions {
 
 const useInboxActions = (): IInboxActions => {
   const {
+    tenantId,
     apiUrl,
     authorization,
     clientKey,
@@ -66,8 +67,9 @@ const useInboxActions = (): IInboxActions => {
   const clientParams = {
     apiUrl,
     authorization,
-    clientSourceId,
     clientKey,
+    clientSourceId,
+    tenantId,
     userId,
     userSignature,
   };
@@ -96,9 +98,9 @@ const useInboxActions = (): IInboxActions => {
       type: "inbox/FETCH_UNREAD_MESSAGE_COUNT",
       payload: () =>
         inboxClient.getInboxCount({
-          accountId: params?.accountId || inbox?.accountId,
           from: params?.from || inbox?.from,
           status: "unread",
+          tenantId: tenantId || params?.tenantId || inbox?.tenantId,
         }),
     });
   };

diff --git a/packages/react-hooks/src/inbox/use-inbox.ts b/packages/react-hooks/src/inbox/use-inbox.ts
@@ -11,19 +11,24 @@ import useInboxActions, { IInboxActions } from "./use-inbox-actions";
 import { IInbox } from "./types";
 
 const useInbox = (): IInbox<IInboxMessagePreview> & IInboxActions => {
-  const { dispatch, inbox, transport, brand, accountId } =
-    useCourier<{
-      inbox: IInbox;
-    }>();
+  const {
+    dispatch,
+    inbox,
+    transport,
+    brand,
+    tenantId: tenantId,
+  } = useCourier<{
+    inbox: IInbox;
+  }>();
 
   const actions = useInboxActions();
 
   if (inbox && (brand || inbox.brand)) {
     inbox.brand = deepExtend({}, brand ?? {}, inbox.brand ?? {});
   }
 
-  if (inbox && accountId) {
-    inbox.accountId = accountId;
+  if (inbox && tenantId) {
+    inbox.tenantId = tenantId;
   }
 
   useEffect(() => {

diff --git a/packages/react-hooks/src/preferences/use-preferences-actions.ts b/packages/react-hooks/src/preferences/use-preferences-actions.ts
@@ -16,13 +16,13 @@ const usePreferencesActions = () => {
   const preferences = Preferences({ client: courierClient });
 
   return {
-    fetchRecipientPreferences: (accountId?: string) => {
+    fetchRecipientPreferences: (tenantId?: string) => {
       dispatch({
         type: "preferences/FETCH_RECIPIENT_PREFERENCES",
-        payload: () => preferences.getRecipientPreferences(accountId),
+        payload: () => preferences.getRecipientPreferences(tenantId),
       });
     },
-    fetchPreferencePage: (accountId?: string, draft = false) => {
+    fetchPreferencePage: (tenantId?: string, draft = false) => {
       if (draft) {
         dispatch({
           type: "preferences/FETCH_DRAFT_PREFERENCE_PAGE",
@@ -31,7 +31,7 @@ const usePreferencesActions = () => {
       } else {
         dispatch({
           type: "preferences/FETCH_PREFERENCE_PAGE",
-          payload: () => preferences.getPreferencePage(accountId),
+          payload: () => preferences.getPreferencePage(tenantId),
         });
       }
     },