refactor: tidy structure of source files

Fixes #79

src/things/dish.ts

@@ -0,0 +1,252 @@
+/*
+ * 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 {SCThingMeta, SCThingType} from './abstract/thing';
+import {
+  SCAcademicPriceGroup,
+  SCThingThatCanBeOffered,
+  SCThingThatCanBeOfferedMeta,
+  SCThingThatCanBeOfferedTranslatableProperties,
+  SCThingThatCanBeOfferedWithoutReferences,
+} from './abstract/thing-that-can-be-offered';
+import {
+  SCThingWithCategories,
+  SCThingWithCategoriesSpecificValues,
+  SCThingWithCategoriesTranslatableProperties,
+  SCThingWithCategoriesWithoutReferences,
+  SCThingWithCategoriesWithoutReferencesMeta,
+} from './abstract/thing-with-categories';
+
+/**
+ * A dish without references
+ */
+export interface SCDishWithoutReferences
+  extends SCThingThatCanBeOfferedWithoutReferences,
+    SCThingWithCategoriesWithoutReferences<SCDishCategories, SCThingWithCategoriesSpecificValues> {
+  /**
+   * Additives of the dish
+   *
+   * @keyword
+   */
+  additives?: string[];
+
+  /**
+   * Category of the dish
+   *
+   * @sortable ducet
+   * @aggregatable
+   */
+  categories: SCDishCategories[];
+
+  /**
+   * Characteristics of the dish
+   */
+  characteristics?: SCDishCharacteristic[];
+
+  /**
+   * Nutrition information (calories and nutrients with amounts)
+   */
+  nutrition?: SCNutritionInformation;
+
+  /**
+   * Translated fields of a dish
+   */
+  translations?: SCTranslations<SCDishTranslatableProperties>;
+
+  /**
+   * Type of a dish
+   */
+  type: SCThingType.Dish;
+}
+
+/**
+ * A dish
+ *
+ * @validatable
+ * @indexable
+ */
+export interface SCDish
+  extends SCDishWithoutReferences, SCThingThatCanBeOffered<SCAcademicPriceGroup>,
+    SCThingWithCategories<SCDishCategories, SCThingWithCategoriesSpecificValues> {
+  /**
+   * Dishes ("Beilagen") that are served with the dish (if only certain supplement dishes can be taken with a dish)
+   */
+  dishAddOns?: SCDishWithoutReferences[];
+
+  /**
+   * Translated fields of a dish
+   */
+  translations?: SCTranslations<SCDishTranslatableProperties>;
+
+  /**
+   * Type of a dish
+   */
+  type: SCThingType.Dish;
+}
+
+export interface SCDishTranslatableProperties
+  extends SCThingWithCategoriesTranslatableProperties, SCThingThatCanBeOfferedTranslatableProperties {
+  /**
+   * Characteristics of the dish
+   */
+  characteristics?: SCDishCharacteristic[];
+}
+
+/**
+ * Composition of properties of a food characteristic
+ */
+export interface SCDishCharacteristic {
+  /**
+   * URL of an image of the characteristic
+   *
+   * @keyword
+   */
+  image?: string;
+
+  /**
+   * Name of the characteristic
+   *
+   * @text
+   */
+  name: string;
+}
+
+/**
+ * A list of categories for dishes
+ */
+export type SCDishCategories =
+  | 'appetizer'
+  | 'salad'
+  | 'main dish'
+  | 'dessert'
+  | 'soup'
+  | 'side dish';
+
+/**
+ * Type definition for SCNutritionInformation
+ *
+ * @see https://schema.org/NutritionInformation
+ */
+export interface SCNutritionInformation {
+  /**
+   * Number of calories contained (in kcal)
+   *
+   * @float
+   */
+  calories?: number;
+
+  /**
+   * Content of carbohydrates (in grams)
+   *
+   * @float
+   */
+  carbohydrateContent?: number;
+
+  /**
+   * Content of fat (in grams)
+   *
+   * @float
+   */
+  fatContent?: number;
+
+  /**
+   * Content of proteins (in grams)
+   *
+   * @float
+   */
+  proteinContent?: number;
+
+  /**
+   * Content of salt (in grams)
+   *
+   * @float
+   */
+  saltContent?: number;
+
+  /**
+   * Content of saturated fat (in grams)
+   *
+   * @float
+   */
+  saturatedFatContent?: number;
+
+  /**
+   * Content of sugar (in grams)
+   *
+   * @float
+   */
+  sugarContent?: number;
+}
+
+/**
+ * Meta information about a dish
+ */
+export class SCDishMeta
+  extends SCThingMeta
+  implements SCMetaTranslations<SCDish> {
+  /**
+   * Translations of fields
+   */
+  fieldTranslations = {
+    de: {
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCDishCategories,
+        SCThingWithCategoriesSpecificValues>().fieldTranslations.de,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldTranslations.de,
+      additives: 'Zusatzstoffe',
+      characteristics: 'Merkmale',
+      dishAddOns: 'Beilagen',
+      nutrition: 'Nährwertangaben',
+    },
+    en: {
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCDishCategories,
+        SCThingWithCategoriesSpecificValues>().fieldTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldTranslations.en,
+      additives: 'additives',
+      characteristics: 'characteristics',
+      dishAddOns: 'side dishes',
+      nutrition: 'nutrition information',
+    },
+  };
+
+  /**
+   * Translations of values of fields
+   */
+  fieldValueTranslations = {
+    de: {
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCDishCategories,
+        SCThingWithCategoriesSpecificValues>().fieldValueTranslations.de,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldValueTranslations.de,
+      categories: {
+        appetizer: 'Vorspeise',
+        dessert: 'Nachtisch',
+        'main dish': 'Hauptgericht',
+        salad: 'Salat',
+        'side dish': 'Beilage',
+        soup: 'Suppe',
+      },
+      type: 'Essen',
+    },
+    en: {
+      ...SCThingWithCategoriesWithoutReferencesMeta.getInstance<SCDishCategories,
+        SCThingWithCategoriesSpecificValues>().fieldValueTranslations.en,
+      ...SCThingThatCanBeOfferedMeta.getInstance<SCAcademicPriceGroup>()
+        .fieldValueTranslations.en,
+      type: SCThingType.Dish,
+    },
+  };
+}