Feat/114 Notifications API Integration

src/app/core/constants/ngxs-states.constant.ts

@@ -6,6 +6,7 @@ import { AnalyticsState } from '@osf/features/project/analytics/store';
 import { AccountSettingsState } from '@osf/features/settings/account-settings/store/account-settings.state';
 import { AddonsState } from '@osf/features/settings/addons/store';
 import { DeveloperAppsState } from '@osf/features/settings/developer-apps/store';
+import { NotificationSubscriptionState } from '@osf/features/settings/notifications/store';
 import { ProfileSettingsState } from '@osf/features/settings/profile-settings/profile-settings.state';
 import { TokensState } from '@osf/features/settings/tokens/store';
 
@@ -20,4 +21,5 @@ export const STATES = [
   DeveloperAppsState,
   AccountSettingsState,
   AnalyticsState,
+  NotificationSubscriptionState,
 ];

src/app/core/services/user/index.ts

@@ -0,0 +1,3 @@
+export * from './user.mapper';
+export * from './user.models';
+export * from './user.service';

src/app/core/services/user/user.mapper.ts

@@ -0,0 +1,49 @@
+import {
+  User,
+  UserGetResponse,
+  UserSettings,
+  UserSettingsGetResponse,
+  UserSettingsUpdateRequest,
+} from '@core/services/user/user.models';
+
+export class UserMapper {
+  static fromUserGetResponse(user: UserGetResponse): User {
+    return {
+      id: user.id,
+      fullName: user.attributes.full_name,
+      givenName: user.attributes.given_name,
+      middleNames: user.attributes.middle_names,
+      suffix: user.attributes.suffix,
+      familyName: user.attributes.family_name,
+      email: user.attributes.email,
+      dateRegistered: new Date(user.attributes.date_registered),
+      link: user.links.html,
+      education: user.attributes.education,
+      employment: user.attributes.employment,
+      iri: user.links.iri,
+      social: user.attributes.social,
+      defaultRegionId: user.relationships?.default_region?.data?.id,
+      allowIndexing: user.attributes?.allow_indexing,
+    };
+  }
+
+  static fromUserSettingsGetResponse(userSettingsResponse: UserSettingsGetResponse): UserSettings {
+    return {
+      subscribeOsfGeneralEmail: userSettingsResponse.attributes.subscribe_osf_general_email,
+      subscribeOsfHelpEmail: userSettingsResponse.attributes.subscribe_osf_help_email,
+    };
+  }
+
+  static toUpdateUserSettingsRequest(userId: string, userSettings: UserSettings): UserSettingsUpdateRequest {
+    return {
+      data: {
+        id: userId,
+        type: 'user_settings',
+        attributes: {
+          subscribe_osf_general_email: userSettings.subscribeOsfGeneralEmail,
+          subscribe_osf_help_email: userSettings.subscribeOsfHelpEmail,
+        },
+      },
+    };
+  }
+}

src/app/core/services/user/user.models.ts

@@ -0,0 +1,78 @@
+import { Education } from '@osf/features/settings/profile-settings/education/educations.entities';
+import { Employment } from '@osf/features/settings/profile-settings/employment/employment.entities';
+import { Social } from '@osf/features/settings/profile-settings/social/social.entities';
+
+//Domain models
+export interface User {
+  id: string;
+  fullName: string;
+  givenName: string;
+  familyName: string;
+  email?: string;
+  middleNames?: string;
+  suffix?: string;
+  education: Education[];
+  employment: Employment[];
+  social: Social;
+  dateRegistered: Date;
+  link?: string;
+  iri?: string;
+  defaultRegionId: string;
+  allowIndexing: boolean | undefined;
+}
+
+export interface UserSettings {
+  subscribeOsfGeneralEmail: boolean;
+  subscribeOsfHelpEmail: boolean;
+}
+
+// API Request/Response Models
+export interface UserGetResponse {
+  id: string;
+  type: string;
+  attributes: {
+    full_name: string;
+    given_name: string;
+    family_name: string;
+    email?: string;
+    employment: Employment[];
+    education: Education[];
+    middle_names?: string;
+    suffix?: string;
+    social: Social;
+    date_registered: string;
+    allow_indexing?: boolean;
+  };
+  relationships: {
+    default_region: {
+      data: {
+        id: string;
+      };
+    };
+  };
+  links: {
+    html: string;
+    profile_image: string;
+    iri: string;
+  };
+}
+
+export interface UserSettingsGetResponse {
+  id: string;
+  type: 'user_settings';
+  attributes: {
+    subscribe_osf_general_email: boolean;
+    subscribe_osf_help_email: boolean;
+  };
+}
+
+export interface UserSettingsUpdateRequest {
+  data: {
+    id: string;
+    type: 'user_settings';
+    attributes: {
+      subscribe_osf_general_email: boolean;
+      subscribe_osf_help_email: boolean;
+    };
+  };
+}

src/app/core/services/user/user.service.ts

@@ -4,9 +4,8 @@ import { inject, Injectable } from '@angular/core';
 
 import { JsonApiResponse } from '@core/services/json-api/json-api.entity';
 import { JsonApiService } from '@core/services/json-api/json-api.service';
-import { UserUS } from '@core/services/json-api/underscore-entites/user/user-us.entity';
-import { mapUserUStoUser } from '@core/services/mappers/users/users.mapper';
-import { User } from '@core/services/user/user.entity';
+import { UserMapper } from '@core/services/user/user.mapper';
+import { User, UserGetResponse, UserSettings, UserSettingsGetResponse } from '@core/services/user/user.models';
 
 @Injectable({
   providedIn: 'root',
@@ -17,7 +16,21 @@ export class UserService {
 
   getCurrentUser(): Observable<User> {
     return this.jsonApiService
-      .get<JsonApiResponse<UserUS, null>>(this.baseUrl + 'users/me')
-      .pipe(map((user) => mapUserUStoUser(user.data)));
+      .get<JsonApiResponse<UserGetResponse, null>>(this.baseUrl + 'users/me/')
+      .pipe(map((user) => UserMapper.fromUserGetResponse(user.data)));
+  }
+
+  getCurrentUserSettings(): Observable<UserSettings> {
+    return this.jsonApiService
+      .get<JsonApiResponse<UserSettingsGetResponse, null>>(this.baseUrl + 'users/me/settings/')
+      .pipe(map((response) => UserMapper.fromUserSettingsGetResponse(response.data)));
+  }
+
+  updateUserSettings(userId: string, userSettings: UserSettings): Observable<UserSettings> {
+    const request = UserMapper.toUpdateUserSettingsRequest(userId, userSettings);
+
+    return this.jsonApiService
+      .patch<UserSettingsGetResponse>(this.baseUrl + `users/${userId}/settings/`, request)
+      .pipe(map((response) => UserMapper.fromUserSettingsGetResponse(response)));
   }
 }

src/app/core/store/user/index.ts

@@ -1,3 +1,4 @@
 export * from './user.actions';
-export * from './user.models';
+export * from './user.model';
+export * from './user.selectors';
 export * from './user.state';

src/app/core/store/user/user.actions.ts

@@ -1,4 +1,4 @@
-import { User } from '@core/services/user/user.entity';
+import { User, UserSettings } from '@core/services/user';
 
 export class GetCurrentUser {
   static readonly type = '[User] Get Current User';
@@ -9,3 +9,16 @@ export class SetCurrentUser {
 
   constructor(public user: User) {}
 }
+
+export class GetCurrentUserSettings {
+  static readonly type = '[User] Get Current User Settings';
+}
+
+export class UpdateUserSettings {
+  static readonly type = '[User] Update User Settings';
+
+  constructor(
+    public userId: string,
+    public updatedUserSettings: UserSettings
+  ) {}
+}

src/app/core/store/user/user.model.ts

@@ -0,0 +1,7 @@
+import { User, UserSettings } from '@core/services/user';
+import { AsyncStateModel } from '@shared/models/store';
+
+export interface UserStateModel {
+  currentUser: User | null;
+  currentUserSettings: AsyncStateModel<UserSettings | null>;
+}

src/app/core/store/user/user.selectors.ts

@@ -1,8 +1,7 @@
 import { Selector } from '@ngxs/store';
 
-import { User } from '@core/services/user/user.entity';
-import { UserStateModel } from '@core/store/user/user.models';
-import { UserState } from '@core/store/user/user.state';
+import { User, UserSettings } from '@core/services/user';
+import { UserState, UserStateModel } from '@core/store/user';
 import { ProfileSettingsStateModel } from '@osf/features/settings/profile-settings/profile-settings.entities';
 import { Social } from '@osf/features/settings/profile-settings/social/social.entities';
 
@@ -29,4 +28,19 @@ export class UserSelectors {
       },
     } satisfies ProfileSettingsStateModel;
   }
+
+  @Selector([UserState])
+  static getCurrentUserSettings(state: UserStateModel): UserSettings | null {
+    return state.currentUserSettings.data;
+  }
+
+  @Selector([UserState])
+  static isUserSettingsLoading(state: UserStateModel): boolean {
+    return state.currentUserSettings.isLoading;
+  }
+
+  @Selector([UserState])
+  static isUserSettingsSubmitting(state: UserStateModel): boolean {
+    return state.currentUserSettings.isSubmitting!;
+  }
 }