feat: add core

src/core/things/Message.ts

@@ -0,0 +1,98 @@
+/*
+ * Copyright (C) 2018 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 {
+  SCCreativeWork,
+  SCCreativeWorkTranslatableProperties,
+  SCCreativeWorkWithoutReferences,
+} from '../base/CreativeWork';
+import {SCThingThatCanBeOfferedTranslatableProperties} from '../base/ThingThatCanBeOffered';
+import {SCThingMeta} from '../Thing';
+import {SCTranslations} from '../types/i18n';
+import {SCISO8601Date} from '../types/Time';
+
+/**
+ * Type of a message
+ */
+export type SCMessageType = 'message';
+
+/**
+ * A message without references
+ */
+export interface SCMessageWithoutReferences extends SCCreativeWorkWithoutReferences {
+  /**
+   * Audience of the message
+   */
+  audiences: SCMessageAudience[];
+
+  /**
+   * When the message was created
+   */
+  dateCreated?: SCISO8601Date;
+
+  /**
+   * Message itself
+   */
+  message: string;
+
+  /**
+   * Translated fields of a message
+   */
+  translations?: SCTranslations<SCMessageTranslatableProperties>;
+
+  /**
+   * Type of a message
+   */
+  type: SCMessageType;
+}
+
+/**
+ * A message
+ */
+export interface SCMessage extends SCCreativeWork, SCMessageWithoutReferences {
+  /**
+   * Translated fields of a message
+   */
+  translations?: SCTranslations<SCMessageTranslatableProperties>;
+
+  /**
+   * Type of a message
+   */
+  type: SCMessageType;
+}
+
+/**
+ * Meta information about a message
+ */
+export class SCMessageMeta extends SCThingMeta {
+}
+
+/**
+ * Audiences for messages
+ */
+export type SCMessageAudience =
+  'students'
+  | 'employees'
+  | 'guests';
+
+/**
+ * Translatable properties of a message
+ */
+export interface SCMessageTranslatableProperties
+  extends SCCreativeWorkTranslatableProperties, SCThingThatCanBeOfferedTranslatableProperties {
+  /**
+   * Message itself
+   */
+  message?: string;
+}