openstapps/src/things/book.ts

/*
 * Copyright (C) 2019-2021 StApps
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation, version 3.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program. If not, see <https://www.gnu.org/licenses/>.
 */
import {SCMetaTranslations, SCTranslations} from '../general/i18n';
import {
  SCCreativeWork,
  SCCreativeWorkMeta,
  SCCreativeWorkTranslatableProperties,
  SCCreativeWorkWithoutReferences,
} from './abstract/creative-work';
import {SCThingMeta, SCThingType} from './abstract/thing';
import {
  SCThingWithCategoriesSpecificValues,
  SCThingWithCategoriesTranslatableProperties,
  SCThingWithCategoriesWithoutReferences,
  SCThingWithCategoriesWithoutReferencesMeta,
} from './abstract/thing-with-categories';

/**
 * Categories of a book
 */
export type SCBookCategories = 'audio'
  | 'book'
  | 'cd'
  | 'dvd'
  | 'ePhoto'
  | 'ebook'
  | 'hierarchy'
  | 'kit'
  | 'manuscript'
  | 'map'
  | 'microfilm'
  | 'musicalscore'
  | 'photo'
  | 'retro'
  | 'sensorimage'
  | 'unknown'
  | 'video';

/**
 * A book without references
 */
export interface SCBookWithoutReferences
  extends SCCreativeWorkWithoutReferences,
  SCThingWithCategoriesWithoutReferences<SCBookCategories, SCThingWithCategoriesSpecificValues> {
  /**
   * Categories of a book
   */
  categories: SCBookCategories[];

  /**
   * ISBNs of a book
   *
   * @filterable
   * @keyword
   */
  ISBNs?: string[];

  /**
   * Number of pages of a book
   *
   * @integer
   */
  numberOfPages?: number;

  /**
   * Translated properties of a book
   */
  translations?: SCTranslations<SCBookTranslatableFields>;

  /**
   * Type of a book
   */
  type: SCThingType.Book;
}

/**
 * A book
 *
 * @validatable
 * @indexable
 */
export interface SCBook
  extends SCCreativeWork, SCBookWithoutReferences {
  /**
   * Translated properties of a book
   */
  translations?: SCTranslations<SCBookTranslatableFields>;

  /**
   * Type of a book
   */
  type: SCThingType.Book;
}

/**
 * Translatable properties of a book
 */
export interface SCBookTranslatableFields
  extends SCThingWithCategoriesTranslatableProperties, SCCreativeWorkTranslatableProperties {
}

/**
 * Meta information about a book
 */
export class SCBookMeta extends SCThingMeta implements SCMetaTranslations<SCBook> {
  /**
   * Translations of fields
   */
  fieldTranslations = {
    de: {
      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations.de,
      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBookCategories,
      SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
      categories: 'Format',
      ISBNs: 'ISBN',
      numberOfPages: 'Seitenanzahl',
    },
    en: {
      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations.en,
      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBookCategories,
      SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
      categories: 'format',
      ISBNs: 'ISBN',
      numberOfPages: 'number of pages',
    },
  };

  /**
   * Translations of values of fields
   */
  fieldValueTranslations = {
    de: {
      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
        .fieldValueTranslations.de,
      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBookCategories,
      SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
      categories: {
        audio: 'Tonträger',
        book: 'Buch',
        cd: 'CD',
        dvd: 'DVD',
        ePhoto: 'E-Photo',
        ebook: 'E-Book',
        hierarchy: 'mehrteiliges Werk',
        kit: 'Medienkombination',
        manuscript: 'Handschrift',
        map: 'Karte',
        microfilm: 'Mikrofilm, Mikrofiche',
        musicalscore: 'Noten',
        photo: 'Abbildung',
        physicalobject: 'Objekt',
        retro: 'Retro (Buch)',
        sensorimage: 'Blindenschrift',
        unknown: 'Unbekannt',
        video: 'Film',
      },
      type: 'Buch',
    },
    en: {
      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
        .fieldValueTranslations.en,
      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCBookCategories,
      SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
      type: SCThingType.Book,
      categories: {
        audio: 'audio material',
        book: 'book',
        cd: 'CD',
        dvd: 'DVD',
        ePhoto: 'E-Photo',
        ebook: 'E-Book',
        hierarchy: 'multipart item',
        kit: 'media combination',
        manuscript: 'manuscript',
        map: 'map',
        microfilm: 'microfilm, microfiche',
        musicalscore: 'sheet music',
        photo: 'illustration',
        physicalobject: 'object',
        retro: 'retro (book)',
        sensorimage: 'braille',
        unknown: 'unknown',
        video: 'film',
      },
    },
  };
}