refactor: tidy structure of source files

Fixes #79
2026-01-20 08:33:11 +00:00 · 2019-06-19 15:04:59 +02:00
parent 5de9bf3794
commit ceab7cc7ef
99 changed files with 1395 additions and 1511 deletions
--- a/src/things/book.ts
+++ b/src/things/book.ts
@@ -0,0 +1,139 @@
+/*
+ * 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 {SCThingWithCategoriesTranslatableProperties} from './abstract/thing-with-categories';
+import {SCPersonWithoutReferences} from './person';
+
+/**
+ * A book without references
+ */
+export interface SCBookWithoutReferences
+  extends SCCreativeWorkWithoutReferences {
+  /**
+   * Edition of a book
+   *
+   * @keyword
+   */
+  bookEdition?: string;
+
+  /**
+   * ISBN of a book
+   *
+   * @keyword
+   */
+  isbn: 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 {
+  /**
+   * Authors of the creative work
+   */
+  authors: SCPersonWithoutReferences[];
+
+  /**
+   * 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 {
+  /**
+   * Translation of an edition of a book
+   *
+   * @keyword
+   */
+  bookEdition?: string;
+}
+
+/**
+ * Meta information about a book
+ */
+export class SCBookMeta extends SCThingMeta implements SCMetaTranslations<SCBook> {
+  /**
+   * Translations of fields
+   */
+  fieldTranslations = {
+    de: {
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
+        .de,
+      bookEdition: 'Buchausgabe',
+      isbn: 'ISBN',
+      numberOfPages: 'Seitenzahl',
+    },
+    en: {
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>().fieldTranslations
+        .en,
+      bookEdition: 'book edition',
+      isbn: 'ISBN',
+      numberOfPages: 'number of pages',
+    },
+  };
+
+  /**
+   * Translations of values of fields
+   */
+  fieldValueTranslations = {
+    de: {
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.de,
+      type: 'Buch',
+    },
+    en: {
+      ...SCCreativeWorkMeta.getInstance<SCCreativeWorkMeta>()
+        .fieldValueTranslations.en,
+      type: SCThingType.Book,
+    },
+  };
+}