@magicbell/react-headless/src/stores/notification_preferences/NotificationPreferencesRepository.ts

Hooks to build a notification inbox

import humps from 'humps';

import { fetchAPI, putAPI } from '../../lib/ajax.js';
import IRemoteNotificationPreferences from '../../types/IRemoteNotificationPreferences.js';

interface IWrappedNotificationPreferences {
  notificationPreferences: IRemoteNotificationPreferences;
}

/**
 * Class to interact with the notification preferences API endpoints.
 *
 * @example
 * const repo = new NotificationPreferencesRepository();
 * const preferences = repo.get();
 */
export default class NotificationPreferencesRepository {
  remotePathOrUrl: string;

  constructor(remotePathOrUrl = '/notification_preferences') {
    this.remotePathOrUrl = remotePathOrUrl;
  }

  /**
   * Get the user preferences from the API server. Object properties will be camelized.
   * Wrapping of message to server is handled for us (Design Principle: The Principle of Least
   * Knowledge).
   */
  async get(): Promise<IWrappedNotificationPreferences> {
    const url = this.remotePathOrUrl;
    const json = await fetchAPI(url);

    return humps.camelizeKeys(json) as IWrappedNotificationPreferences;
  }

  /**
   * Update user preferences in the API server. Object properties will be decamelized before
   * being send to the server.
   *
   * @param data Preferences to send to the server.
   */
  async update(data: IRemoteNotificationPreferences): Promise<IWrappedNotificationPreferences> {
    const url = this.remotePathOrUrl;
    const payload = humps.decamelizeKeys({ notificationPreferences: data }) as Record<string, unknown>;
    const json = await putAPI(url, payload);

    return humps.camelizeKeys(json) as IWrappedNotificationPreferences;
  }
}