dspace-angular/src/app/core/cache/object-cache.actions.ts

import { Action } from '@ngrx/store';

import { type } from '../../shared/ngrx/type';
import { CacheableObject } from './object-cache.reducer';
import { Operation } from 'fast-json-patch';

/**
 * The list of ObjectCacheAction type definitions
 */
export const ObjectCacheActionTypes = {
  ADD: type('dspace/core/cache/object/ADD'),
  REMOVE: type('dspace/core/cache/object/REMOVE'),
  RESET_TIMESTAMPS: type('dspace/core/cache/object/RESET_TIMESTAMPS'),
  PATCH: type('dspace/core/cache/object/PATCH')
};

/* tslint:disable:max-classes-per-file */
/**
 * An ngrx action to add an object to the cache
 */
export class AddToObjectCacheAction implements Action {
  type = ObjectCacheActionTypes.ADD;
  payload: {
    objectToCache: CacheableObject;
    timeAdded: number;
    msToLive: number;
    requestHref: string;
  };

  /**
   * Create a new AddToObjectCacheAction
   *
   * @param objectToCache
   *    the object to add
   * @param timeAdded
   *    the time it was added
   * @param msToLive
   *    the amount of milliseconds before it should expire
   * @param requestHref
   *    The href of the request that resulted in this object
   *    This isn't necessarily the same as the object's self
   *    link, it could have been part of a list for example
   */
  constructor(objectToCache: CacheableObject, timeAdded: number, msToLive: number, requestHref: string) {
    this.payload = { objectToCache, timeAdded, msToLive, requestHref };
  }
}

/**
 * An ngrx action to remove an object from the cache
 */
export class RemoveFromObjectCacheAction implements Action {
  type = ObjectCacheActionTypes.REMOVE;
  payload: string;

  /**
   * Create a new RemoveFromObjectCacheAction
   *
   * @param uuid
   *    the UUID of the object to remove
   */
  constructor(uuid: string) {
    this.payload = uuid;
  }
}

/**
 * An ngrx action to reset the timeAdded property of all cached objects
 */
export class ResetObjectCacheTimestampsAction implements Action {
  type = ObjectCacheActionTypes.RESET_TIMESTAMPS;
  payload: number;

  /**
   * Create a new ResetObjectCacheTimestampsAction
   *
   * @param newTimestamp
   *    the new timeAdded all objects should get
   */
  constructor(newTimestamp: number) {
    this.payload = newTimestamp;
  }
}

/**
 * An ngrx action to add new operations to a specified cached objects
 */
export class PatchObjectCacheAction implements Action {
  type = ObjectCacheActionTypes.PATCH;
  payload: {
    uuid: string,
    operations: Operation[]
  };

  /**
   * Create a new PatchObjectCacheAction
   *
   * @param uuid
   *    the uuid of the object that should be updated
   * @param operations
   *    the list of operations to add
   */
  constructor(uuid: string, operations: Operation[]) {
    this.payload = { uuid, operations };
  }
}

/* tslint:enable:max-classes-per-file */

/**
 * A type to encompass all ObjectCacheActions
 */
export type ObjectCacheAction
  = AddToObjectCacheAction
  | RemoveFromObjectCacheAction
  | ResetObjectCacheTimestampsAction
  | PatchObjectCacheAction;