Server re-build with latest AdonisJS framework & Typescript (#47)

* chore: setup first basis structure

* chore: ensure styling is loaded correctly

* chore: comply to new routing syntax by replace . with / in routes/resource locations

* chore: add login controller

* chore: correctly use views with slash instead of dot

* chore: working login + tests

* chore: clean up tests

* chore: add password-forgot endpoint and matching test

* chore: add delete page test

* chore: add logout test

* chore: add reset-password route and tests

* chore: remove obsolete comment

* chore: add account-page and tests

* chore: add data page & first step of the test

* chore: add transfer/import data feature and tests

* chore: add export and basic test

* chore: add all static api routes with tests

* Regenerate 'pnpm-lock.json' and fix bad merge conflict

WIP:
- Tests have been commented out since they dont work
- Server doesn't start

* easier dev and test runs

* - remove --require-pragma from reformat-files so formatting works properly
- run pnpm reformat-files over codebase
- remove .json files from .eslintignore
- add invalid.json file to .eslintignore
- configure prettier properly in eslint config
- add type jsdoc to prettier config
- run adonis generate:manifest command to regenerate ace-manifest.json
- specify volta in package.json
- introduce typecheck npm script
- remove unused .mjs extension from npm scripts
- install missing type definition dependencies
- add pnpm.allowedDeprecatedVersions to package.json
- fix invalid extends in tsconfig.json causing TS issues throughout codebase
- remove @ts-ignore throughout codebase which is not relevant anymore
- enable some of the tsconfig options
- remove outdated eslint-disable from codebase
- change deprecated faker.company.companyName() to faker.company.name()
- fix TS issues inside transfer.spec.ts

* - update to latest node and pnpm versions
- upgrade all non-major dependencies to latest
- install missing @types/luxon dependency
- add cuid to pnpm.allowedDeprecatedVersions
- add esModuleInterop config option to tsconfig
- migrate more deprecated faker methods to new ones
- add more temporary ts-ignore to code

* - update eslint config
- remove trailingComma: all since default in prettier v3
- add typecheck command to prepare-code npm script
- upgrade various dependencies to latest major version
- update tsconfig to include only useful config options
- disable some lint issues and fix others

* - add test command to prepare-code
- disable strictPropertyInitialization flag in tsconfig which creates issues with adonis models
- update precommit hook to excute pnpm prepare-code
- remove ts-ignore statements from all models

* fix node and pnpm dependency update

* add cross env (so that we can develop on windows)

* add signup endpoint (TODO: JWT auth)

* Add login endpoint

* Add me and updateMe endpoints

* Add service endpoint

* refactor: change endpoints to use jwt

* add recipes endpoint

* add workspaces endpoint

* fix web controllors for login and post import

* Update node deps

* Change auth middleware (for web) and exempt api from CSRF

* Add import endpoint (franz import)

* Fix export/import logic

* Fix service and workspace data in user/data

* Fix partial lint

* chore: workaround lint issues

* fix: migration naming had two .

* Sync back node with recipes repo

* Temporarily ignore typescript

* Fix adonisrc to handle public folder static assets

* Fix issue with production database

* add Legacy Password Provider

* Fix lint errors

* Fix issue on login errors frontend

* add Legacy Password Provider

* Fix issue with customIcons

* Fix issue with auth tokens

* Update 'node' to '18.18.0'

* make docker work

* improve docker entrypoint (test api performance)

* Add migration database script

* NODE_ENV on recipes

* prefer @ts-expect-error over @ts-ignore

* small fixes

* Update 'pnpm' to '8.7.6'

* fix error catch

* Automatically generate JWT Public and Private keys

* Use custom Adonis5-jwt

* Update code to use secret (old way, no breaking changes)

* Normalize appKey

* Trick to make JWT tokens on client work with new version

* Fix error with new JWT logic

* Change migration and how we store JWT

* Fix 500 response code (needs to be 401)

* Improve logic and fix bugs

* Fix build and entrypoint logic

* Catch error if appKey changes

* Add newToken logic

* Fix lint (ignore any errors)

* Add build for PRs

* pnpm reformat-files result

* Fix some tests

* Fix reset password not working (test failing)

* Restore csrfTokens (disabled by accident)

* Fix pnpm start command with .env

* Disable failing tests on the transfer endpoint (TODO)

* Add tests to PR build

* Fix build

* Remove unnecessary assertStatus

* Add typecheck

* hash password on UserFactory (fix build)

* Add JWT_USE_PEM true by default (increase security)

* fix name of github action

---------

Co-authored-by: Vijay A <vraravam@users.noreply.github.com>
Co-authored-by: Balaji Vijayakumar <kuttibalaji.v6@gmail.com>
Co-authored-by: MCMXC <16797721+mcmxcdev@users.noreply.github.com>
Co-authored-by: André Oliveira <oliveira.andrerodrigues95@gmail.com>

11 files changed, 240 insertions, 97 deletions

diff --git a/app/Models/Recipe.js b/app/Models/Recipe.js
deleted file mode 100644
index bd97411..0000000
--- a/app/Models/Recipe.js
+++ /dev/null
@@ -1,7 +0,0 @@
-/** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */
-const Model = use('Model');
-
-class Recipe extends Model {
-}
-
-module.exports = Recipe;
diff --git a/app/Models/Recipe.ts b/app/Models/Recipe.ts
new file mode 100644
index 0000000..fce5f3d
--- /dev/null
+++ b/app/Models/Recipe.ts
@@ -0,0 +1,23 @@
+import { DateTime } from 'luxon';
+import { BaseModel, column } from '@ioc:Adonis/Lucid/Orm';
+
+export default class Recipe extends BaseModel {
+  @column({ isPrimary: true })
+  public id: number;
+
+  @column()
+  public name: string;
+
+  @column()
+  public recipeId: string;
+
+  // TODO: Type the data object.
+  @column()
+  public data: object;
+
+  @column.dateTime({ autoCreate: true })
+  public createdAt: DateTime;
+
+  @column.dateTime({ autoCreate: true, autoUpdate: true })
+  public updatedAt: DateTime;
+}
diff --git a/app/Models/Service.js b/app/Models/Service.js
deleted file mode 100644
index cf3e6f4..0000000
--- a/app/Models/Service.js
+++ /dev/null
@@ -1,10 +0,0 @@
-/** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */
-const Model = use('Model');
-
-class Service extends Model {
-  user() {
-    return this.belongsTo('App/Models/User', 'userId', 'id');
-  }
-}
-
-module.exports = Service;
diff --git a/app/Models/Service.ts b/app/Models/Service.ts
new file mode 100644
index 0000000..af1a8e1
--- /dev/null
+++ b/app/Models/Service.ts
@@ -0,0 +1,40 @@
+import { DateTime } from 'luxon';
+import { BaseModel, column, HasOne, hasOne } from '@ioc:Adonis/Lucid/Orm';
+import User from './User';
+
+export default class Service extends BaseModel {
+  @column({ isPrimary: true })
+  public id: number;
+
+  @hasOne(() => User, {
+    foreignKey: 'userId',
+  })
+  public user: HasOne<typeof User>;
+
+  @column({
+    columnName: 'userId',
+  })
+  public userId: number;
+
+  @column({
+    columnName: 'serviceId',
+  })
+  public serviceId: string;
+
+  @column()
+  public name: string;
+
+  @column({
+    columnName: 'recipeId',
+  })
+  public recipeId: string;
+
+  @column()
+  public settings: string;
+
+  @column.dateTime({ autoCreate: true })
+  public createdAt: DateTime;
+
+  @column.dateTime({ autoCreate: true, autoUpdate: true })
+  public updatedAt: DateTime;
+}
diff --git a/app/Models/Token.js b/app/Models/Token.js
deleted file mode 100644
index 7965a7a..0000000
--- a/app/Models/Token.js
+++ /dev/null
@@ -1,10 +0,0 @@
-/** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */
-const Model = use('Model');
-
-class Token extends Model {
-  user() {
-    return this.belongsTo('App/Models/User');
-  }
-}
-
-module.exports = Token;
diff --git a/app/Models/Token.ts b/app/Models/Token.ts
new file mode 100644
index 0000000..4f85ebc
--- /dev/null
+++ b/app/Models/Token.ts
@@ -0,0 +1,38 @@
+import { DateTime } from 'luxon';
+import { BaseModel, column, HasOne, hasOne } from '@ioc:Adonis/Lucid/Orm';
+import User from './User';
+
+export default class Token extends BaseModel {
+  @column({ isPrimary: true })
+  public id: number;
+
+  @hasOne(() => User, {
+    localKey: 'user_id',
+    foreignKey: 'id',
+  })
+  public user: HasOne<typeof User>;
+
+  @column()
+  public user_id: number;
+
+  @column()
+  public token: string;
+
+  @column()
+  public type: string;
+
+  @column()
+  public is_revoked: boolean;
+
+  @column()
+  public name: string;
+
+  @column.dateTime()
+  public expires_at: DateTime;
+
+  @column.dateTime({ autoCreate: true })
+  public created_at: DateTime;
+
+  @column.dateTime({ autoCreate: true, autoUpdate: true })
+  public updated_at: DateTime;
+}
diff --git a/app/Models/Traits/NoTimestamp.js b/app/Models/Traits/NoTimestamp.js
deleted file mode 100644
index 914f542..0000000
--- a/app/Models/Traits/NoTimestamp.js
+++ /dev/null
@@ -1,14 +0,0 @@
-class NoTimestamp {
-  register(Model) {
-    Object.defineProperties(Model, {
-      createdAtColumn: {
-        get: () => null,
-      },
-      updatedAtColumn: {
-        get: () => null,
-      },
-    });
-  }
-}
-
-module.exports = NoTimestamp;
diff --git a/app/Models/User.js b/app/Models/User.js
deleted file mode 100644
index 4472017..0000000
--- a/app/Models/User.js
+++ /dev/null
@@ -1,46 +0,0 @@
-/** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */
-const Model = use('Model');
-
-/** @type {import('@adonisjs/framework/src/Hash')} */
-const Hash = use('Hash');
-
-class User extends Model {
-  static boot() {
-    super.boot();
-
-    /**
-     * A hook to hash the user password before saving
-     * it to the database.
-     */
-    this.addHook('beforeSave', async (userInstance) => {
-      if (userInstance.dirty.password) {
-        // eslint-disable-next-line no-param-reassign
-        userInstance.password = await Hash.make(userInstance.password);
-      }
-    });
-  }
-
-  /**
-   * A relationship on tokens is required for auth to
-   * work. Since features like `refreshTokens` or
-   * `rememberToken` will be saved inside the
-   * tokens table.
-   *
-   * @method tokens
-   *
-   * @return {Object}
-   */
-  tokens() {
-    return this.hasMany('App/Models/Token');
-  }
-
-  services() {
-    return this.hasMany('App/Models/Service', 'id', 'userId');
-  }
-
-  workspaces() {
-    return this.hasMany('App/Models/Workspace', 'id', 'userId');
-  }
-}
-
-module.exports = User;
diff --git a/app/Models/User.ts b/app/Models/User.ts
new file mode 100644
index 0000000..0ed4627
--- /dev/null
+++ b/app/Models/User.ts
@@ -0,0 +1,98 @@
+import { DateTime } from 'luxon';
+import {
+  BaseModel,
+  beforeSave,
+  column,
+  HasMany,
+  hasMany,
+} from '@ioc:Adonis/Lucid/Orm';
+import Hash from '@ioc:Adonis/Core/Hash';
+import Event from '@ioc:Adonis/Core/Event';
+import moment from 'moment';
+import Encryption from '@ioc:Adonis/Core/Encryption';
+import randtoken from 'rand-token';
+import Token from './Token';
+import Workspace from './Workspace';
+import Service from './Service';
+
+export default class User extends BaseModel {
+  @column({ isPrimary: true })
+  public id: number;
+
+  @column()
+  public email: string;
+
+  @column()
+  public username: string;
+
+  @column()
+  public password: string;
+
+  @column()
+  public lastname: string;
+
+  // TODO: Type the settings object.
+  @column()
+  public settings: object;
+
+  @column.dateTime({ autoCreate: true })
+  public created_at: DateTime;
+
+  @column.dateTime({ autoCreate: true, autoUpdate: true })
+  public updated_at: DateTime;
+
+  @beforeSave()
+  public static async hashPassword(user: User) {
+    if (user.$dirty.password) {
+      user.password = await Hash.make(user.password);
+    }
+  }
+
+  @hasMany(() => Token, {
+    foreignKey: 'user_id',
+  })
+  public tokens: HasMany<typeof Token>;
+
+  @hasMany(() => Service, {
+    foreignKey: 'userId',
+  })
+  public services: HasMany<typeof Service>;
+
+  @hasMany(() => Workspace, {
+    foreignKey: 'userId',
+  })
+  public workspaces: HasMany<typeof Workspace>;
+
+  public async forgotPassword(): Promise<void> {
+    const token = await this.generateToken(this, 'forgot_password');
+
+    await Event.emit('forgot:password', {
+      user: this,
+      token,
+    });
+  }
+
+  private async generateToken(user: User, type: string): Promise<string> {
+    const query = user
+      .related('tokens')
+      .query()
+      .where('type', type)
+      .where('is_revoked', false)
+      .where(
+        'updated_at',
+        '>=',
+        moment().subtract(24, 'hours').format('YYYY-MM-DD HH:mm:ss'),
+      );
+
+    const row = await query.first();
+    if (row) {
+      return row.token;
+    }
+
+    const token = Encryption.encrypt(randtoken.generate(16));
+
+    await user.related('tokens').create({ type, token });
+
+    return token;
+  }
+}
diff --git a/app/Models/Workspace.js b/app/Models/Workspace.js
deleted file mode 100644
index e3a3285..0000000
--- a/app/Models/Workspace.js
+++ /dev/null
@@ -1,10 +0,0 @@
-/** @type {typeof import('@adonisjs/lucid/src/Lucid/Model')} */
-const Model = use('Model');
-
-class Workspace extends Model {
-  user() {
-    return this.belongsTo('App/Models/User', 'userId', 'id');
-  }
-}
-
-module.exports = Workspace;
diff --git a/app/Models/Workspace.ts b/app/Models/Workspace.ts
new file mode 100644
index 0000000..8648e02
--- /dev/null
+++ b/app/Models/Workspace.ts
@@ -0,0 +1,41 @@
+import { DateTime } from 'luxon';
+import { BaseModel, column, HasOne, hasOne } from '@ioc:Adonis/Lucid/Orm';
+import User from './User';
+
+export default class Workspace extends BaseModel {
+  @column({ isPrimary: true })
+  public id: number;
+
+  @column({
+    columnName: 'workspaceId',
+  })
+  public workspaceId: string;
+
+  @hasOne(() => User, {
+    foreignKey: 'userId',
+  })
+  public user: HasOne<typeof User>;
+
+  @column({
+    columnName: 'userId',
+  })
+  public userId: number;
+
+  @column()
+  public name: string;
+
+  @column()
+  public order: number;
+
+  @column()
+  public services: string;
+
+  @column()
+  public data: string;
+
+  @column.dateTime({ autoCreate: true })
+  public createdAt: DateTime;
+
+  @column.dateTime({ autoCreate: true, autoUpdate: true })
+  public updatedAt: DateTime;
+}