@readium/shared/src/publication/Contributor.ts

Shared models to be used across other Readium projects and implementations in Typescript

/* Copyright 2021 Readium Foundation. All rights reserved.
 * Use of this source code is governed by a BSD-style license,
 * available in the LICENSE file present in the Github repository of the project.
 */

import { Links } from './Link';
import {
  arrayfromJSONorString,
  numberfromJSON,
  setToArray,
} from '../util/JSONParse';
import { LocalizedString } from './LocalizedString';
import { AltIdentifier } from './AltIdentifier';

/**
 * Contributor Object for the Readium Web Publication Manifest.
 * https://readium.org/webpub-manifest/schema/contributor-object.schema.json
 */
export class Contributor {
  /** The name of the contributor. */
  public readonly name: LocalizedString;

  /** The string used to sort the name of the contributor. */
  public readonly sortAs?: string;

  /** An unambiguous reference to this contributor. */
  public readonly identifier?: string;

  /** Alternate identifiers for this contributor. */
  public readonly altIdentifiers?: Set<AltIdentifier>;

  /** The role of the contributor in the publication making. */
  public readonly roles?: Set<string>;

  /** Used to retrieve similar publications for the given contributor. */
  public readonly links?: Links;

  /** The position of the publication in this collection/series, when the contributor represents a collection. */
  public readonly position?: number;

  /**
   * Creates a [Contributor] object.
   */
  constructor(values: {
    name: LocalizedString;
    sortAs?: string;
    identifier?: string;
    altIdentifiers?: Set<AltIdentifier>;
    roles?: Set<string>;
    links?: Links;
    position?: number;
  }) {
    this.name = values.name;
    this.sortAs = values.sortAs;
    this.identifier = values.identifier;
    this.altIdentifiers = values.altIdentifiers;
    this.roles = values.roles;
    this.links = values.links;
    this.position = values.position;
  }

  /**
   * Parses a [Contributor] from its RWPM JSON representation.
   *
   * A contributor can be parsed from a single string, or a full-fledged object.
   */
  public static deserialize(json: any): Contributor | undefined {
    if (!json) return;
    if (typeof json === 'string') {
      return new Contributor({
        name: LocalizedString.deserialize(json) as LocalizedString,
      });
    } else {
      if (!json.name) return;
      return new Contributor({
        name: LocalizedString.deserialize(json.name) as LocalizedString,
        sortAs: json.sortAs,
        identifier: json.identifier,
        altIdentifiers: json.altIdentifier
          ? (json.altIdentifier instanceof Array
            ? new Set<AltIdentifier>(json.altIdentifier
                .map((x: string | { value: string; scheme?: string }) => AltIdentifier.deserialize(x))
                .filter((x: AltIdentifier | undefined): x is AltIdentifier => x !== undefined))
            : new Set<AltIdentifier>([AltIdentifier.deserialize(json.altIdentifier as string | { value: string; scheme?: string })]
                .filter((x: AltIdentifier | undefined): x is AltIdentifier => x !== undefined)))
          : undefined,
        roles: json.role
          ? new Set<string>(arrayfromJSONorString(json.role))
          : undefined,
        links: Links.deserialize(json.links),
        position: numberfromJSON(json.position),
      });
    }
  }

  /**
   * Serializes a [Contributor] to its RWPM JSON representation.
   */
  public serialize(): any {
    const json: any = { name: this.name.serialize() };
    if (this.sortAs !== undefined) json.sortAs = this.sortAs;
    if (this.identifier !== undefined) json.identifier = this.identifier;
    if (this.altIdentifiers) json.altIdentifier = setToArray(this.altIdentifiers).map(altId => altId.serialize());
    if (this.roles) json.role = setToArray(this.roles);
    if (this.links) json.links = this.links.serialize();
    if (this.position !== undefined) json.position = this.position;
    return json;
  }
}

export class Contributors {
  /**
   * Array of [Contributor] .
   */
  public readonly items: Array<Contributor>;

  /**
   * Creates a [Contributors] object.
   */
  constructor(items: Array<Contributor>) {
    this.items = items;
  }

  /**
   * Parses a [Contributors] from its RWPM JSON representation.
   *
   */
  public static deserialize(json: any): Contributors | undefined {
    if (!json) return;
    const items = json instanceof Array ? json : [json];
    return new Contributors(
      items
        .map<Contributor>(item => Contributor.deserialize(item) as Contributor)
        .filter(x => x !== undefined)
    );
  }

  /**
   * Serializes a [Contributors] to its RWPM JSON representation.
   */
  public serialize(): any {
    return this.items.map(x => x.serialize());
  }
}