feat: refactor account provider; add TS

Author: elvinasv

src/app/contexts/AccountContext/idcta/isSignedIn.ts

@@ -1,27 +1,24 @@
 import React, { createContext, use, useEffect, useMemo, useState } from 'react';
 import { ServiceContext } from '#app/contexts/ServiceContext';
-import { isSignedIn } from './idcta/isSignedIn';
-import appendCtaQueryParams from './idcta/appendCtaQueryParams';
-
-export type AccountContextProps = {
-  isSignInAvailable: boolean;
-  accountUrl: string;
-  signInUrl: string;
-  registerUrl: string;
-  isSignedIn: boolean;
-};
+import Cookie from 'js-cookie';
+import onClient from '#app/lib/utilities/onClient';
+import { AccountContextProps, IdctaConfig } from '#app/models/types/account';
+import appendCtaQueryParams from '#app/lib/idcta/appendCtaQueryParams';
 
 export const AccountContext = createContext<AccountContextProps>(
   {} as AccountContextProps,
 );
 
+const getSignedInCookie = (cookieName = 'ckns_id') => {
+  return onClient() ? Cookie.get(cookieName) : false;
+};
+
 export const AccountProvider = ({
   children,
-  initialConfig = null,
+  initialConfig,
 }: {
   children: React.ReactNode;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  initialConfig: any;
+  initialConfig: IdctaConfig | null;
 }) => {
   const { locale } = use(ServiceContext);
 
@@ -47,19 +44,29 @@ export const AccountProvider = ({
       ? initialConfig.foryou_url
       : unavailableUrl;
 
-  const isUserSignedIn = signInAvailability ? isSignedIn() : false;
+  // Todo: use  settings_url
+  // Todo: use  privacy_settings_url
+
+  const cookieName = initialConfig?.identity.idSignedInCookieName;
+  const isSignedIn = signInAvailability
+    ? Boolean(getSignedInCookie(cookieName))
+    : false;
 
   const value = useMemo(
     () => ({
       isSignInAvailable: signInAvailability,
       signInUrl,
       registerUrl,
       accountUrl,
-      isSignedIn: isUserSignedIn,
+      isSignedIn,
     }),
-    [accountUrl, isUserSignedIn, registerUrl, signInAvailability, signInUrl],
+    [accountUrl, isSignedIn, registerUrl, signInAvailability, signInUrl],
   );
 
+  if (!initialConfig) {
+    return children;
+  }
+
   return (
     <AccountContext.Provider value={value}>{children}</AccountContext.Provider>
   );

src/app/contexts/AccountContext/index.tsx

@@ -2,15 +2,12 @@ import { IDCTA_FETCH_ERROR } from '#app/lib/logger.const';
 import nodeLogger from '#app/lib/logger.node';
 import getToggleDefinitions from '#app/lib/utilities/getToggleDefinition';
 import isLocal from '#app/lib/utilities/isLocal';
+import { IdctaConfig } from '#app/models/types/account';
 import { Toggles, Services } from '#app/models/types/global';
 import { getIdctaConfigUrl } from './getIdctaBaseUrl';
 
 const logger = nodeLogger(__filename);
 
-// TODO: Add types
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type IdctaConfig = any;
-
 export default async function fetchIdctaConfig(
   toggles: Toggles,
   service: Services,
@@ -36,8 +33,7 @@ export default async function fetchIdctaConfig(
 
     if (!response.ok) {
       logger.error(IDCTA_FETCH_ERROR, {
-        url: idctaConfigUrl,
-        service,
+        url: response.url,
         status: response.status,
         statusText: response.statusText,
       });
@@ -48,7 +44,6 @@ export default async function fetchIdctaConfig(
   } catch (error) {
     logger.error(IDCTA_FETCH_ERROR, {
       url: idctaConfigUrl,
-      service,
       error,
     });
     return null;

…untContext/idcta/appendCtaQueryParams.ts src/app/lib/idcta/appendCtaQueryParams.tssrc/app/contexts/AccountContext/idcta/appendCtaQueryParams.ts renamed to src/app/lib/idcta/appendCtaQueryParams.ts src/app/contexts/AccountContext/idcta/appendCtaQueryParams.ts renamed to src/app/lib/idcta/appendCtaQueryParams.ts

@@ -1,4 +1,4 @@
-import isLive from '../../../lib/utilities/isLive';
+import isLive from '#app/lib/utilities/isLive';
 
 export const getIdctaBaseUrl = (): string => {
   return isLive()
@@ -7,4 +7,3 @@ export const getIdctaBaseUrl = (): string => {
 };
 
 export const getIdctaConfigUrl = (): string => `${getIdctaBaseUrl()}/config`;
-export const getIdctaInitUrl = (): string => `${getIdctaBaseUrl()}/init`;

…AccountContext/idcta/fetchIdctaConfig.ts src/app/lib/idcta/fetchIdctaConfig.tssrc/app/contexts/AccountContext/idcta/fetchIdctaConfig.ts renamed to src/app/lib/idcta/fetchIdctaConfig.ts src/app/contexts/AccountContext/idcta/fetchIdctaConfig.ts renamed to src/app/lib/idcta/fetchIdctaConfig.ts

@@ -0,0 +1,28 @@
+/* eslint-disable camelcase */
+type FlagpoleStatus = 'GREEN' | 'RED';
+
+// Partial IDCTA Config. Add additional types if needed;
+export type IdctaConfig = {
+  availability: {
+    signin: FlagpoleStatus;
+  };
+  'foryou-flagpole': FlagpoleStatus;
+  unavailable_url: string;
+  signin_url: string;
+  register_url: string;
+  foryou_url: string;
+  settings_url: string;
+  identity: {
+    accessTokenCookieName: string;
+    cookieAgeDays: number;
+    idSignedInCookieName: string;
+  };
+};
+
+export type AccountContextProps = {
+  isSignInAvailable: boolean;
+  isSignedIn: boolean;
+  accountUrl?: string;
+  signInUrl?: string;
+  registerUrl?: string;
+};

…/AccountContext/idcta/getIdctaBaseUrl.ts src/app/lib/idcta/getIdctaBaseUrl.tssrc/app/contexts/AccountContext/idcta/getIdctaBaseUrl.ts renamed to src/app/lib/idcta/getIdctaBaseUrl.ts src/app/contexts/AccountContext/idcta/getIdctaBaseUrl.ts renamed to src/app/lib/idcta/getIdctaBaseUrl.ts

@@ -27,7 +27,8 @@ import addOnionLocationHeader from '#nextjs/utilities/addOnionLocationHeader';
 import addVaryHeader from '#nextjs/utilities/addVaryHeader';
 import addLinkHeader from '#nextjs/utilities/addLinkHeader';
 import { AccountProvider } from '#app/contexts/AccountContext';
-import fetchIdctaConfig from '#app/contexts/AccountContext/idcta/fetchIdctaConfig';
+import fetchIdctaConfig from '#app/lib/idcta/fetchIdctaConfig';
+import { IdctaConfig } from '#app/models/types/account';
 
 interface Props {
   pageProps: {
@@ -57,7 +58,7 @@ interface Props {
     variant?: Variants;
     isUK?: boolean;
     country?: string | null;
-    idctaConfig?: unknown | null;
+    idctaConfig: IdctaConfig | null;
   };
 }