content-source.model.ts

import {
  autoserializeAs,
  deserialize,
  deserializeAs,
  serializeAs,
} from 'cerialize';

import { typedObject } from '../cache/builders/build-decorators';
import { CacheableObject } from '../cache/cacheable-object.model';
import { excludeFromEquals } from '../utilities/equals.decorators';
import { CONTENT_SOURCE } from './content-source.resource-type';
import { ContentSourceSetSerializer } from './content-source-set-serializer';
import { HALLink } from './hal-link.model';
import { MetadataConfig } from './metadata-config.model';
import { ResourceType } from './resource-type';

/**
 * The type of content harvesting used
 */
export enum ContentSourceHarvestType {
  None = 'NONE',
  Metadata = 'METADATA_ONLY',
  MetadataAndRef = 'METADATA_AND_REF',
  MetadataAndBitstreams = 'METADATA_AND_BITSTREAMS'
}

/**
 * A model class that holds information about the Content Source of a Collection
 */
@typedObject
export class ContentSource extends CacheableObject {
  static type = CONTENT_SOURCE;

  /**
   * The object type
   *
   * The rest api doesn't provide one, so it's hardcoded here,
   * and we need a custom responseparser for ContentSource responses
   */
  @excludeFromEquals
  type: ResourceType = CONTENT_SOURCE;

  /**
   * Unique identifier, this is necessary to store the ContentSource in FieldUpdates
   * Because the ContentSource coming from the REST API doesn't have a UUID, we're using the selflink
   */
  @deserializeAs('self')
  uuid: string;

  /**
   * OAI Provider / Source
   */
  @autoserializeAs('oai_source')
  oaiSource: string;

  /**
   * OAI Specific set ID
   */
  @deserializeAs(new ContentSourceSetSerializer(), 'oai_set_id')
  @serializeAs(new ContentSourceSetSerializer(), 'oai_set_id')
    oaiSetId: string;

  /**
   * The ID of the metadata format used
   */
  @autoserializeAs('metadata_config_id')
  metadataConfigId: string;

  /**
   * Type of content being harvested
   * Defaults to 'NONE', meaning the collection doesn't harvest its content from an external source
   */
  @autoserializeAs('harvest_type')
  harvestType = ContentSourceHarvestType.None;

  /**
   * Whether bitstreams may be fetched from hosts other than the OAI provider
   * Initialised to false on purpose: cerialize omits undefined values, so without it the key would never reach the backend
   */
  @autoserializeAs('allow_external_urls')
  allowExternalUrls = false;

  /**
   * The available metadata configurations
   */
  metadataConfigs: MetadataConfig[];

  /**
   * The current harvest status
   */
  @autoserializeAs('harvest_status')
  harvestStatus: string;

  /**
   * The last's harvest start time
   */
  @autoserializeAs('harvest_start_time')
  harvestStartTime: string;

  /**
   * When the collection was last harvested
   */
  @autoserializeAs('last_harvested')
  lastHarvested: string;

  /**
   * The current harvest message
   */
  @autoserializeAs('harvest_message')
  message: string;

  /**
   * The {@link HALLink}s for this ContentSource
   */
  @deserialize
  _links: {
    self: HALLink
  };
}