botserver/packages/kb.gbapp/models/index.ts

/*****************************************************************************\
|                                               ( )_  _                       |
|    _ _    _ __   _ _    __    ___ ___     _ _ | ,_)(_)  ___   ___     _     |
|   ( '_`\ ( '__)/'_` ) /'_ `\/' _ ` _ `\ /'_` )| |  | |/',__)/' v `\ /'_`\   |
|   | (_) )| |  ( (_| |( (_) || ( ) ( ) |( (_| || |_ | |\__, \| (˅) |( (_) )  |
|   | ,__/'(_)  `\__,_)`\__  |(_) (_) (_)`\__,_)`\__)(_)(____/(_) (_)`\___/'  |
|   | |                ( )_) |                                                |
|   (_)                 \___/'                                                |
|                                                                             |
| General Bots Copyright (c) Pragmatismo.io. All rights reserved.             |
| Licensed under the AGPL-3.0.                                                |
|                                                                             |
| According to our dual licensing model, this program can be used either      |
| under the terms of the GNU Affero General Public License, version 3,        |
| or under a proprietary license.                                             |
|                                                                             |
| The texts of the GNU Affero General Public License with an additional       |
| permission and of our proprietary license can be found at and               |
| in the LICENSE file you have received along with this program.              |
|                                                                             |
| 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 Affero General Public License for more details.                         |
|                                                                             |
| "General Bots" is a registered trademark of Pragmatismo.io.                 |
| The licensing of the program under the AGPLv3 does not imply a              |
| trademark license. Therefore any rights, title and interest in              |
| our trademarks remain entirely with us.                                     |
|                                                                             |
\*****************************************************************************/

/**
 * @fileoverview General Bots server core.
 */

'use strict';

import {
  AutoIncrement,
  BelongsTo,
  Column,
  CreatedAt,
  DataType,
  ForeignKey,
  HasMany,
  HasOne,
  IsUUID,
  Length,
  Model,
  PrimaryKey,
  Sequelize,
  Table,
  UpdatedAt
} from 'sequelize-typescript';

import { GuaribasInstance, GuaribasPackage } from '../../core.gbapp/models/GBModel.js';
import { GuaribasUser } from '../../security.gbapp/models/index.js';

/**
 * Subjects to group the pair of questions and answers.
 */
@Table
export class GuaribasSubject extends Model<GuaribasSubject> {
  @PrimaryKey
  @AutoIncrement
  @Column(DataType.INTEGER)
  subjectId: number;

  @Column(DataType.INTEGER)
  internalId: string;

  @Column(DataType.STRING(255))
  title: string;

  @Column(DataType.STRING(512))
  description: string;

  @Column(DataType.STRING(255))
  from: string;

  @Column(DataType.STRING(255))
  to: string;

  @ForeignKey(() => GuaribasSubject)
  @Column(DataType.INTEGER)
  parentSubjectId: number;

  @BelongsTo(() => GuaribasSubject, 'parentSubjectId')
  parentSubject: GuaribasSubject;

  @HasMany(() => GuaribasSubject, { foreignKey: 'parentSubjectId' })
  childrenSubjects: GuaribasSubject[];

  @ForeignKey(() => GuaribasInstance)
  @Column(DataType.INTEGER)
  instanceId: number;

  @BelongsTo(() => GuaribasInstance)
  instance: GuaribasInstance;

  @ForeignKey(() => GuaribasUser)
  @Column(DataType.INTEGER)
  responsibleUserId: number;

  @BelongsTo(() => GuaribasUser)
  responsibleUser: GuaribasUser;

  @ForeignKey(() => GuaribasPackage)
  @Column(DataType.INTEGER)
  packageId: number;

  @BelongsTo(() => GuaribasPackage)
  package: GuaribasPackage;
}

/**
 * A question and its metadata.
 */
@Table
export class GuaribasQuestion extends Model<GuaribasQuestion> {
  @PrimaryKey
  @AutoIncrement
  @Column(DataType.INTEGER)
  questionId: number;

  @Column(DataType.STRING(64))
  subject1: string;

  @Column(DataType.STRING(64))
  subject2: string;

  @Column(DataType.STRING(64))
  subject3: string;

  @Column(DataType.STRING(64))
  subject4: string;

  @Column(DataType.STRING(1024))
  keywords: string;

  @Column(DataType.BOOLEAN)
  skipIndex: boolean;

  @Column(DataType.STRING(512))
  from: string;

  @Column(DataType.STRING(512))
  to: string;

  @Column(DataType.TEXT)
  content: string;

  @Column(DataType.DATE)
  @CreatedAt
  createdAt: Date;

  @Column(DataType.DATE)
  @UpdatedAt
  updatedAt: Date;

  //tslint:disable-next-line:no-use-before-declare
  @ForeignKey(() => GuaribasAnswer)
  @Column(DataType.INTEGER)
  answerId: number;

  @BelongsTo(() => GuaribasInstance)
  instance: GuaribasInstance;

  @ForeignKey(() => GuaribasInstance)
  @Column(DataType.INTEGER)
  instanceId: number;

  @ForeignKey(() => GuaribasPackage)
  @Column(DataType.INTEGER)
  packageId: number;

  @BelongsTo(() => GuaribasPackage)
  package: GuaribasPackage;
}

/**
 * An answer and its metadata.
 */
@Table
export class GuaribasAnswer extends Model<GuaribasAnswer> {
  @PrimaryKey
  @AutoIncrement
  @Column(DataType.INTEGER)
  answerId: number;

  @Length({ min: 0, max: 512 })
  @Column(DataType.STRING(512))
  media: string;

  @Length({ min: 0, max: 12 })
  @Column(DataType.STRING(12))
  format: string;

  @Column(DataType.TEXT)
  content: string;

  @Column(DataType.DATE)
  @CreatedAt
  createdAt: Date;

  @Column(DataType.DATE)
  @UpdatedAt
  updatedAt: Date;

  @HasMany(() => GuaribasQuestion)
  questions: GuaribasQuestion[];

  @HasOne(() => GuaribasQuestion)
  prev: GuaribasQuestion;

  @HasOne(() => GuaribasQuestion)
  next: GuaribasQuestion;

  @ForeignKey(() => GuaribasQuestion)
  @Column(DataType.INTEGER)
  nextId: number;

  @ForeignKey(() => GuaribasQuestion)
  @Column(DataType.INTEGER)
  prevId: number;

  @ForeignKey(() => GuaribasInstance)
  @Column(DataType.INTEGER)
  instanceId: number;

  @ForeignKey(() => GuaribasPackage)
  @Column(DataType.INTEGER)
  packageId: number;

  @BelongsTo(() => GuaribasPackage)
  package: GuaribasPackage;
}