Typescript rewrite (#147)

* Updated highlight.js

* Update .codexdocsrc.sample

remove undefined page for a fresh new install

* backend rewritten in TS

* test -> TS, .added dockerignore, bug fixed

* Removed compiled js files, eslint codex/ts added

* fixed jsdocs warning, leaving editor confirmation

* use path.resolve for DB paths

* db drives updated + fixed User model

* redundant cleared + style fixed

* explicit type fixing

* fixing testing code

* added body block type

* compiled JS files -> dist, fixed compiling errors

* fixed compiling error, re-organized ts source code

* updated Dockerfile

* fixed link to parent page

* up nodejs version

* fix package name

* fix deps

Co-authored-by: nvc8996 <nvc.8996@gmail.com>
Co-authored-by: Taly <vitalik7tv@yandex.ru>

src/backend/models/alias.ts

@@ -0,0 +1,162 @@
+import crypto from '../utils/crypto';
+import database from '../utils/database/index';
+
+const binaryMD5 = crypto.binaryMD5;
+const aliasesDb = database['aliases'];
+
+/**
+ * @typedef {object} AliasData
+ * @property {string} _id - alias id
+ * @property {string} hash - alias binary hash
+ * @property {string} type - entity type
+ * @property {boolean} deprecated - indicate if alias deprecated
+ * @property {string} id - entity id
+ *
+ */
+export interface AliasData {
+  _id?: string;
+  hash?: string;
+  type?: string;
+  deprecated?: boolean;
+  id?: string;
+}
+
+/**
+ * @class Alias
+ * @classdesc Alias model
+ *
+ * @property {string} _id - alias id
+ * @property {string} hash - alias binary hash
+ * @property {string} type - entity type
+ * @property {boolean} deprecated - indicate if alias deprecated
+ * @property {string} id - entity title
+ */
+class Alias {
+  public _id?: string;
+  public hash?: string;
+  public type?: string;
+  public deprecated?: boolean;
+  public id?: string;
+
+  /**
+   * @class
+   *
+   * @param {AliasData} data - info about alias
+   * @param {string} aliasName - alias of entity
+   */
+  constructor(data: AliasData = {}, aliasName = '') {
+    if (data === null) {
+      data = {};
+    }
+    if (data._id) {
+      this._id = data._id;
+    }
+    if (aliasName) {
+      this.hash = binaryMD5(aliasName);
+    }
+    this.data = data;
+  }
+  /**
+   * Return Alias types
+   *
+   * @returns {object}
+   */
+  public static get types(): { PAGE: string } {
+    return {
+      PAGE: 'page',
+    };
+  }
+
+  /**
+   * Find and return alias with given alias
+   *
+   * @param {string} aliasName - alias of entity
+   * @returns {Promise<Alias>}
+   */
+  public static async get(aliasName: string): Promise<Alias> {
+    const hash = binaryMD5(aliasName);
+    let data = await aliasesDb.findOne({
+      hash: hash,
+      deprecated: false,
+    });
+
+    if (!data) {
+      data = await aliasesDb.findOne({ hash: hash });
+    }
+
+    return new Alias(data);
+  }
+
+  /**
+   * Mark alias as deprecated
+   *
+   * @param {string} aliasName - alias of entity
+   * @returns {Promise<Alias>}
+   */
+  public static async markAsDeprecated(aliasName: string): Promise<Alias> {
+    const alias = await Alias.get(aliasName);
+
+    alias.deprecated = true;
+
+    return alias.save();
+  }
+
+  /**
+   * Save or update alias data in the database
+   *
+   * @returns {Promise<Alias>}
+   */
+  public async save(): Promise<Alias> {
+    if (!this._id) {
+      const insertedRow = await aliasesDb.insert(this.data) as { _id: string };
+
+      this._id = insertedRow._id;
+    } else {
+      await aliasesDb.update({ _id: this._id }, this.data);
+    }
+
+    return this;
+  }
+
+  /**
+   * Set AliasData object fields to internal model fields
+   *
+   * @param {AliasData} aliasData - info about alias
+   */
+  public set data(aliasData: AliasData) {
+    const { id, type, hash, deprecated } = aliasData;
+
+    this.id = id || this.id;
+    this.type = type || this.type;
+    this.hash = hash || this.hash;
+    this.deprecated = deprecated || false;
+  }
+
+  /**
+   * Return AliasData object
+   *
+   * @returns {AliasData}
+   */
+  public get data(): AliasData {
+    return {
+      _id: this._id,
+      id: this.id,
+      type: this.type,
+      hash: this.hash,
+      deprecated: this.deprecated,
+    };
+  }
+
+  /**
+   * @returns {Promise<Alias>}
+   */
+  public async destroy(): Promise<Alias> {
+    await aliasesDb.remove({ _id: this._id });
+
+    delete this._id;
+
+    return this;
+  }
+}
+
+export default Alias;