openstapps/src/things/article.ts

/*
 * Copyright (C) 2019 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 {
  SCThingWithCategories,
  SCThingWithCategoriesSpecificValues,
  SCThingWithCategoriesTranslatableProperties,
  SCThingWithCategoriesWithoutReferences,
  SCThingWithCategoriesWithoutReferencesMeta,
} from './abstract/thing-with-categories';

/**
 * An article without references
 */
export interface SCArticleWithoutReferences
  extends SCCreativeWorkWithoutReferences,
    SCThingWithCategoriesWithoutReferences<SCArticleCategories, SCThingWithCategoriesSpecificValues> {
  /**
   * Article itself as markdown
   *
   * @text
   */
  articleBody: string;

  /**
   * Translated fields of an article
   */
  translations?: SCTranslations<SCArticleTranslatableProperties>;

  /**
   * Type of an article
   */
  type: SCThingType.Article;
}

/**
 * An article
 *
 * @validatable
 * @indexable
 */
export interface SCArticle
  extends SCCreativeWork, SCArticleWithoutReferences,
    SCThingWithCategories<SCArticleCategories, SCThingWithCategoriesSpecificValues> {
  /**
   * Translated fields of an article
   */
  translations?: SCTranslations<SCArticleTranslatableProperties>;

  /**
   * Type of an article
   */
  type: SCThingType.Article;
}

/**
 * Categories of articles
 */
export type SCArticleCategories = 'unipedia';

/**
 * Translatable properties of creative works
 */
export interface SCArticleTranslatableProperties
  extends SCThingWithCategoriesTranslatableProperties, SCCreativeWorkTranslatableProperties {
  /**
   * Translation of the article itself as markdown
   *
   * @text
   */
  articleBody?: string[];
}

/**
 * Meta information about an article
 */
export class SCArticleMeta
  extends SCThingMeta implements SCMetaTranslations<SCArticle> {
  /**
   * Translations of fields
   */
  fieldTranslations = {
    de: {
      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
        .de,
      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
        SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
      articleBody: 'Artikelinhalt',
    },
    en: {
      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
        .en,
      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
        SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
      articleBody: 'article body',
    },
  };

  /**
   * Translations of values of fields
   */
  fieldValueTranslations = {
    de: {
      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
        .fieldValueTranslations.de,
      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
        SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
      categories: {
        'unipedia': 'Unipedia',
      },
      type: 'Artikel',
    },
    en: {
      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
        .fieldValueTranslations.en,
      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCArticleCategories,
        SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
      type: SCThingType.Article,
    },
  };
}