@foal/cli 2.11.0 → 3.0.0-alpha.1

package/lib/generate/templates/app/.eslintrc.js

@@ -1,24 +1,18 @@
 module.exports = {
-  env: {
-    'browser': true,
-    'es6': true,
-    'node': true
-  },
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:@typescript-eslint/recommended-requiring-type-checking',
-  ],
+  root: true,
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    project: 'tsconfig.json',
     tsconfigRootDir: __dirname,
-    sourceType: 'module'
+    project: ['./tsconfig.json'],
   },
   plugins: [
     '@typescript-eslint'
   ],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+  ],
   rules: {
     '@typescript-eslint/array-type': 'error',
     '@typescript-eslint/explicit-member-accessibility': [
@@ -40,7 +34,12 @@ module.exports = {
     '@typescript-eslint/no-unused-vars': ['error', { 'args':  'none' }],
     '@typescript-eslint/explicit-function-return-type': 'off',
     '@typescript-eslint/require-await': 'off',
-    '@typescript-eslint/no-explicit-any': 'off'
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-unsafe-argument': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off',
   },
   ignorePatterns: [
     'src/migrations/*.ts'

package/lib/generate/templates/app/package.json

@@ -7,7 +7,7 @@
   "scripts": {
     "build": "foal rmdir build && tsc -p tsconfig.app.json",
     "start": "node ./build/index.js",
-    "develop": "npm run build && concurrently -r \"tsc -p tsconfig.app.json -w\" \"supervisor -w ./build,./config -e js,json,yml --no-restart-on error ./build/index.js\"",
+    "dev": "npm run build && concurrently -r \"tsc -p tsconfig.app.json -w\" \"supervisor -w ./build,./config -e js,json,yml --no-restart-on error ./build/index.js\"",
     "build:test": "foal rmdir build && tsc -p tsconfig.test.json",
     "start:test": "mocha --file ./build/test.js \"./build/**/*.spec.js\"",
     "test": "npm run build:test && concurrently -r \"tsc -p tsconfig.test.json -w\" \"mocha --file ./build/test.js -w \\\"./build/**/*.spec.js\\\"\"",
@@ -16,31 +16,31 @@
     "e2e": "npm run build:e2e && concurrently -r \"tsc -p tsconfig.e2e.json -w\" \"mocha --file ./build/e2e.js -w \\\"./build/e2e/**/*.js\\\"\"",
     "lint": "eslint --ext ts src",
     "lint:fix": "eslint --ext ts --fix src",
-    "makemigrations": "foal rmdir build && tsc -p tsconfig.app.json && npx typeorm migration:generate --name migration && tsc -p tsconfig.app.json",
-    "migrations": "npx typeorm migration:run",
-    "revertmigration": "npx typeorm migration:revert"
+    "makemigrations": "foal rmdir build && tsc -p tsconfig.app.json && npx typeorm migration:generate src/migrations/migration -d build/db -p && tsc -p tsconfig.app.json",
+    "migrations": "npx typeorm migration:run -d build/db",
+    "revertmigration": "npx typeorm migration:revert -d build/db"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=16.0.0"
   },
   "dependencies": {
-    "@foal/core": "^2.0.0",
-    "@foal/typeorm": "^2.0.0",
-    "source-map-support": "~0.5.19",
-    "better-sqlite3": "~7.5.1",
-    "typeorm": "0.2.26"
+    "@foal/core": "3.0.0-alpha.1",
+    "@foal/typeorm": "3.0.0-alpha.1",
+    "source-map-support": "~0.5.21",
+    "better-sqlite3": "~7.6.2",
+    "typeorm": "0.3.10"
   },
   "devDependencies": {
     "@foal/cli": "^2.9.0",
-    "@types/mocha": "7.0.2",
-    "@types/node": "10.17.24",
-    "concurrently": "~5.3.0",
+    "@types/mocha": "9.1.1",
+    "@types/node": "16.11.7",
+    "concurrently": "~7.2.2",
     "mocha": "~8.2.0",
     "supertest": "~6.2.3",
     "supervisor": "~0.12.0",
-    "eslint": "^6.7.0",
-    "@typescript-eslint/eslint-plugin": "~2.7.0",
-    "@typescript-eslint/parser": "~2.7.0",
-    "typescript": "~4.0.2"
+    "eslint": "~8.17.0",
+    "@typescript-eslint/eslint-plugin": "~5.27.1",
+    "@typescript-eslint/parser": "~5.27.1",
+    "typescript": "~4.7.4"
   }
 }

package/lib/generate/templates/app/package.mongodb.json

@@ -7,7 +7,7 @@
   "scripts": {
     "build": "foal rmdir build && tsc -p tsconfig.app.json",
     "start": "node ./build/index.js",
-    "develop": "npm run build && concurrently -r \"tsc -p tsconfig.app.json -w\" \"supervisor -w ./build,./config -e js,json,yml --no-restart-on error ./build/index.js\"",
+    "dev": "npm run build && concurrently -r \"tsc -p tsconfig.app.json -w\" \"supervisor -w ./build,./config -e js,json,yml --no-restart-on error ./build/index.js\"",
     "build:test": "foal rmdir build && tsc -p tsconfig.test.json",
     "start:test": "mocha --file ./build/test.js \"./build/**/*.spec.js\"",
     "test": "npm run build:test && concurrently -r \"tsc -p tsconfig.test.json -w\" \"mocha --file ./build/test.js -w \\\"./build/**/*.spec.js\\\"\"",
@@ -18,25 +18,25 @@
     "lint:fix": "eslint --ext ts --fix src"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=16.0.0"
   },
   "dependencies": {
-    "@foal/core": "^2.0.0",
+    "@foal/core": "3.0.0-alpha.1",
     "mongodb": "~3.7.3",
-    "source-map-support": "~0.5.19",
-    "typeorm": "0.2.26"
+    "source-map-support": "~0.5.21",
+    "typeorm": "0.3.10"
   },
   "devDependencies": {
     "@foal/cli": "^2.9.0",
-    "@types/mocha": "7.0.2",
-    "@types/node": "10.17.24",
-    "concurrently": "~5.3.0",
+    "@types/mocha": "9.1.1",
+    "@types/node": "16.11.7",
+    "concurrently": "~7.2.2",
     "mocha": "~8.2.0",
-    "supertest": "~6.0.0",
+    "supertest": "~6.2.3",
     "supervisor": "~0.12.0",
-    "eslint": "^6.7.0",
-    "@typescript-eslint/eslint-plugin": "~2.7.0",
-    "@typescript-eslint/parser": "~2.7.0",
-    "typescript": "~4.0.2"
+    "eslint": "~8.17.0",
+    "@typescript-eslint/eslint-plugin": "~5.27.1",
+    "@typescript-eslint/parser": "~5.27.1",
+    "typescript": "~4.7.4"
   }
 }

package/lib/generate/templates/app/package.mongodb.yaml.json

@@ -7,7 +7,7 @@
   "scripts": {
     "build": "foal rmdir build && tsc -p tsconfig.app.json",
     "start": "node ./build/index.js",
-    "develop": "npm run build && concurrently -r \"tsc -p tsconfig.app.json -w\" \"supervisor -w ./build,./config -e js,json,yml --no-restart-on error ./build/index.js\"",
+    "dev": "npm run build && concurrently -r \"tsc -p tsconfig.app.json -w\" \"supervisor -w ./build,./config -e js,json,yml --no-restart-on error ./build/index.js\"",
     "build:test": "foal rmdir build && tsc -p tsconfig.test.json",
     "start:test": "mocha --file ./build/test.js \"./build/**/*.spec.js\"",
     "test": "npm run build:test && concurrently -r \"tsc -p tsconfig.test.json -w\" \"mocha --file ./build/test.js -w \\\"./build/**/*.spec.js\\\"\"",
@@ -18,26 +18,26 @@
     "lint:fix": "eslint --ext ts --fix src"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=16.0.0"
   },
   "dependencies": {
-    "@foal/core": "^2.0.0",
+    "@foal/core": "3.0.0-alpha.1",
     "mongodb": "~3.7.3",
-    "source-map-support": "~0.5.19",
-    "typeorm": "0.2.26",
+    "source-map-support": "~0.5.21",
+    "typeorm": "0.3.10",
     "yamljs": "~0.3.0"
   },
   "devDependencies": {
     "@foal/cli": "^2.9.0",
-    "@types/mocha": "7.0.2",
-    "@types/node": "10.17.24",
-    "concurrently": "~5.3.0",
+    "@types/mocha": "9.1.1",
+    "@types/node": "16.11.7",
+    "concurrently": "~7.2.2",
     "mocha": "~8.2.0",
-    "supertest": "~6.0.0",
+    "supertest": "~6.2.3",
     "supervisor": "~0.12.0",
-    "eslint": "^6.7.0",
-    "@typescript-eslint/eslint-plugin": "~2.7.0",
-    "@typescript-eslint/parser": "~2.7.0",
-    "typescript": "~4.0.2"
+    "eslint": "~8.17.0",
+    "@typescript-eslint/eslint-plugin": "~5.27.1",
+    "@typescript-eslint/parser": "~5.27.1",
+    "typescript": "~4.7.4"
   }
 }

package/lib/generate/templates/app/package.yaml.json

@@ -7,7 +7,7 @@
   "scripts": {
     "build": "foal rmdir build && tsc -p tsconfig.app.json",
     "start": "node ./build/index.js",
-    "develop": "npm run build && concurrently -r \"tsc -p tsconfig.app.json -w\" \"supervisor -w ./build,./config -e js,json,yml --no-restart-on error ./build/index.js\"",
+    "dev": "npm run build && concurrently -r \"tsc -p tsconfig.app.json -w\" \"supervisor -w ./build,./config -e js,json,yml --no-restart-on error ./build/index.js\"",
     "build:test": "foal rmdir build && tsc -p tsconfig.test.json",
     "start:test": "mocha --file ./build/test.js \"./build/**/*.spec.js\"",
     "test": "npm run build:test && concurrently -r \"tsc -p tsconfig.test.json -w\" \"mocha --file ./build/test.js -w \\\"./build/**/*.spec.js\\\"\"",
@@ -16,32 +16,32 @@
     "e2e": "npm run build:e2e && concurrently -r \"tsc -p tsconfig.e2e.json -w\" \"mocha --file ./build/e2e.js -w \\\"./build/e2e/**/*.js\\\"\"",
     "lint": "eslint --ext ts src",
     "lint:fix": "eslint --ext ts --fix src",
-    "makemigrations": "foal rmdir build && tsc -p tsconfig.app.json && npx typeorm migration:generate --name migration && tsc -p tsconfig.app.json",
-    "migrations": "npx typeorm migration:run",
-    "revertmigration": "npx typeorm migration:revert"
+    "makemigrations": "foal rmdir build && tsc -p tsconfig.app.json && npx typeorm migration:generate src/migrations/migration -d build/db -p && tsc -p tsconfig.app.json",
+    "migrations": "npx typeorm migration:run -d build/db",
+    "revertmigration": "npx typeorm migration:revert -d build/db"
   },
   "engines": {
-    "node": ">=10"
+    "node": ">=16.0.0"
   },
   "dependencies": {
-    "@foal/core": "^2.0.0",
-    "@foal/typeorm": "^2.0.0",
-    "source-map-support": "~0.5.19",
+    "@foal/core": "3.0.0-alpha.1",
+    "@foal/typeorm": "3.0.0-alpha.1",
+    "source-map-support": "~0.5.21",
     "better-sqlite3": "~7.5.0",
-    "typeorm": "0.2.26",
+    "typeorm": "0.3.10",
     "yamljs": "~0.3.0"
   },
   "devDependencies": {
     "@foal/cli": "^2.9.0",
-    "@types/mocha": "7.0.2",
-    "@types/node": "10.17.24",
-    "concurrently": "~5.3.0",
+    "@types/mocha": "9.1.1",
+    "@types/node": "16.11.7",
+    "concurrently": "~7.2.2",
     "mocha": "~8.2.0",
-    "supertest": "~6.0.0",
+    "supertest": "~6.2.3",
     "supervisor": "~0.12.0",
-    "eslint": "^6.7.0",
-    "@typescript-eslint/eslint-plugin": "~2.7.0",
-    "@typescript-eslint/parser": "~2.7.0",
-    "typescript": "~4.0.2"
+    "eslint": "~8.17.0",
+    "@typescript-eslint/eslint-plugin": "~5.27.1",
+    "@typescript-eslint/parser": "~5.27.1",
+    "typescript": "~4.7.4"
   }
 }

package/lib/generate/templates/app/src/app/app.controller.ts

@@ -1,5 +1,4 @@
 import { controller, IAppController } from '@foal/core';
-import { createConnection } from 'typeorm';
 
 import { ApiController } from './controllers';
 
@@ -7,8 +6,4 @@ export class AppController implements IAppController {
   subControllers = [
     controller('/api', ApiController),
   ];
-
-  async init() {
-    await createConnection();
-  }
 }

package/lib/generate/templates/app/src/app/entities/user.entity.mongodb.ts

@@ -1,20 +1,9 @@
-// import { hashPassword } from '@foal/core';
-import { /*Column, */Entity, ObjectID, ObjectIdColumn } from 'typeorm';
+import { BaseEntity, Entity, ObjectID, ObjectIdColumn } from 'typeorm';
 
 @Entity()
-export class User {
+export class User extends BaseEntity {
 
   @ObjectIdColumn()
-  id: ObjectID;
-
-  // @Column({ unique: true })
-  // email: string;
-
-  // @Column()
-  // password: string;
-
-  // async setPassword(password: string) {
-  //   this.password = await hashPassword(password);
-  // }
+  _id: ObjectID;
 
 }

package/lib/generate/templates/app/src/app/entities/user.entity.ts

@@ -1,5 +1,4 @@
-// import { hashPassword } from '@foal/core';
-import { BaseEntity, /*Column, */Entity, PrimaryGeneratedColumn } from 'typeorm';
+import { BaseEntity, Entity, PrimaryGeneratedColumn } from 'typeorm';
 
 @Entity()
 export class User extends BaseEntity {
@@ -7,14 +6,4 @@ export class User extends BaseEntity {
   @PrimaryGeneratedColumn()
   id: number;
 
-  // @Column({ unique: true })
-  // email: string;
-
-  // @Column()
-  // password: string;
-
-  // async setPassword(password: string) {
-  //   this.password = await hashPassword(password);
-  // }
-
 }

package/lib/generate/templates/app/src/db.ts

@@ -0,0 +1,24 @@
+
+import { Config } from '@foal/core';
+import { DataSource } from 'typeorm';
+
+export function createDataSource(): DataSource {
+  return new DataSource({
+    type: Config.getOrThrow('database.type', 'string') as any,
+
+    url: Config.get('database.url', 'string'),
+    host: Config.get('database.host', 'string'),
+    port: Config.get('database.port', 'number'),
+    username: Config.get('database.username', 'string'),
+    password: Config.get('database.password', 'string'),
+    database: Config.get('database.database', 'string'),
+
+    dropSchema: Config.get('database.dropSchema', 'boolean', false),
+    synchronize: Config.get('database.synchronize', 'boolean', false),
+
+    entities: ['build/app/**/*.entity.js'],
+    migrations: ['build/migrations/*.js'],
+  });
+}
+
+export const dataSource = createDataSource();

package/lib/generate/templates/app/src/e2e/index.ts

@@ -1,20 +1,28 @@
 // 3p
 import { createApp } from '@foal/core';
 import * as request from 'supertest';
-import { getConnection } from 'typeorm';
+import { DataSource } from 'typeorm';
 
 // App
 import { AppController } from '../app/app.controller';
+import { createDataSource } from '../db';
 
 describe('The server', () => {
 
   let app;
+  let dataSource: DataSource;
 
   before(async () => {
     app = await createApp(AppController);
+    dataSource = createDataSource();
+    await dataSource.initialize();
   });
 
-  after(() => getConnection().close());
+  after(async () => {
+    if (dataSource) {
+      await dataSource.destroy();
+    }
+  });
 
   it('should return a 200 status on GET / requests.', () => {
     return request(app)

package/lib/generate/templates/app/src/index.ts

@@ -5,8 +5,11 @@ import { Config, createApp, displayServerURL } from '@foal/core';
 
 // App
 import { AppController } from './app/app.controller';
+import { dataSource } from './db';
 
 async function main() {
+  await dataSource.initialize();
+
   const app = await createApp(AppController);
 
   const port = Config.get('port', 'number', 3001);

package/lib/generate/templates/app/src/scripts/create-user.ts

@@ -1,32 +1,28 @@
-// 3p
-// import { hashPassword } from '@foal/core';
-import { createConnection } from 'typeorm';
-
 // App
 import { User } from '../app/entities';
+import { dataSource } from '../db';
 
 export const schema = {
   additionalProperties: false,
   properties: {
-    // email: { type: 'string', format: 'email' },
-    // password: { type: 'string' },
+
   },
-  required: [ /* 'email', 'password' */ ],
+  required: [
+
+  ],
   type: 'object',
 };
 
-export async function main(/*args*/) {
-  const connection = await createConnection();
+export async function main() {
+  await dataSource.initialize();
 
   try {
     const user = new User();
-    // user.email = args.email;
-    // user.password = await hashPassword(args.password);
 
     console.log(await user.save());
   } catch (error: any) {
-    console.log(error.message);
+    console.error(error.message);
   } finally {
-    await connection.close();
+    await dataSource.destroy();
   }
 }

package/lib/generate/templates/app/tsconfig.json

@@ -8,14 +8,14 @@
     "noImplicitAny": false,
     "strictPropertyInitialization": false,
     "module": "commonjs",
-    "target": "es2017",
+    "target": "es2021",
     "rootDir": "src",
     "lib": [
-      "es2017",
+      "es2021",
       "dom"
     ]
   },
   "include": [
     "src/**/*.ts"
   ]
-}
+}

package/lib/generate/templates/entity/entity.mongodb.ts

@@ -1,10 +1,10 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
-import { Column, Entity, ObjectID, ObjectIdColumn } from 'typeorm';
+import { BaseEntity, Column, Entity, ObjectID, ObjectIdColumn } from 'typeorm';
 
 @Entity()
-export class /* upperFirstCamelName */ {
+export class /* upperFirstCamelName */ extends BaseEntity {
 
   @ObjectIdColumn()
-  id: ObjectID;
+  _id: ObjectID;
 
 }

package/lib/generate/templates/rest-api/controllers/controller.auth.ts

@@ -4,7 +4,6 @@ import {
   HttpResponseNoContent, HttpResponseNotFound, HttpResponseOK, Patch, Post,
   Put, ValidateBody, ValidatePathParam, ValidateQueryParam
 } from '@foal/core';
-import { getRepository } from 'typeorm';
 
 import { /* upperFirstCamelName */, User } from '/* entitiesPath */';
 
@@ -32,11 +31,11 @@ export class /* upperFirstCamelName */Controller {
   @ValidateQueryParam('skip', { type: 'number' }, { required: false })
   @ValidateQueryParam('take', { type: 'number' }, { required: false })
   async find/* upperFirstCamelName */s(ctx: Context<User>) {
-    const /* camelName */s = await getRepository(/* upperFirstCamelName */).find({
+    const /* camelName */s = await /* upperFirstCamelName */.find({
       skip: ctx.request.query.skip,
       take: ctx.request.query.take,
       where: {
-        owner: ctx.user
+        owner: { id: ctx.user.id }
       }
     });
     return new HttpResponseOK(/* camelName */s);
@@ -49,9 +48,9 @@ export class /* upperFirstCamelName */Controller {
   @ApiResponse(200, { description: 'Returns the /* camelName */.' })
   @ValidatePathParam('/* camelName */Id', { type: 'number' })
   async find/* upperFirstCamelName */ById(ctx: Context<User>) {
-    const /* camelName */ = await getRepository(/* upperFirstCamelName */).findOne({
+    const /* camelName */ = await /* upperFirstCamelName */.findOneBy({
       id: ctx.request.params./* camelName */Id,
-      owner: ctx.user
+      owner: { id: ctx.user.id }
     });
 
     if (!/* camelName */) {
@@ -68,9 +67,9 @@ export class /* upperFirstCamelName */Controller {
   @ApiResponse(201, { description: '/* upperFirstCamelName */ successfully created. Returns the /* camelName */.' })
   @ValidateBody(/* camelName */Schema)
   async create/* upperFirstCamelName */(ctx: Context<User>) {
-    const /* camelName */ = await getRepository(/* upperFirstCamelName */).save({
+    const /* camelName */ = await /* upperFirstCamelName */.save({
       ...ctx.request.body,
-      owner: ctx.user
+      owner: { id: ctx.user.id }
     });
     return new HttpResponseCreated(/* camelName */);
   }
@@ -84,9 +83,9 @@ export class /* upperFirstCamelName */Controller {
   @ValidatePathParam('/* camelName */Id', { type: 'number' })
   @ValidateBody({ .../* camelName */Schema, required: [] })
   async modify/* upperFirstCamelName */(ctx: Context<User>) {
-    const /* camelName */ = await getRepository(/* upperFirstCamelName */).findOne({
+    const /* camelName */ = await /* upperFirstCamelName */.findOneBy({
       id: ctx.request.params./* camelName */Id,
-      owner: ctx.user
+      owner: { id: ctx.user.id }
     });
 
     if (!/* camelName */) {
@@ -95,7 +94,7 @@ export class /* upperFirstCamelName */Controller {
 
     Object.assign(/* camelName */, ctx.request.body);
 
-    await getRepository(/* upperFirstCamelName */).save(/* camelName */);
+    await /* upperFirstCamelName */.save(/* camelName */);
 
     return new HttpResponseOK(/* camelName */);
   }
@@ -109,9 +108,9 @@ export class /* upperFirstCamelName */Controller {
   @ValidatePathParam('/* camelName */Id', { type: 'number' })
   @ValidateBody(/* camelName */Schema)
   async replace/* upperFirstCamelName */(ctx: Context<User>) {
-    const /* camelName */ = await getRepository(/* upperFirstCamelName */).findOne({
+    const /* camelName */ = await /* upperFirstCamelName */.findOneBy({
       id: ctx.request.params./* camelName */Id,
-      owner: ctx.user
+      owner: { id: ctx.user.id }
     });
 
     if (!/* camelName */) {
@@ -120,7 +119,7 @@ export class /* upperFirstCamelName */Controller {
 
     Object.assign(/* camelName */, ctx.request.body);
 
-    await getRepository(/* upperFirstCamelName */).save(/* camelName */);
+    await /* upperFirstCamelName */.save(/* camelName */);
 
     return new HttpResponseOK(/* camelName */);
   }
@@ -132,16 +131,16 @@ export class /* upperFirstCamelName */Controller {
   @ApiResponse(204, { description: '/* upperFirstCamelName */ successfully deleted.' })
   @ValidatePathParam('/* camelName */Id', { type: 'number' })
   async delete/* upperFirstCamelName */(ctx: Context<User>) {
-    const /* camelName */ = await getRepository(/* upperFirstCamelName */).findOne({
+    const /* camelName */ = await /* upperFirstCamelName */.findOneBy({
       id: ctx.request.params./* camelName */Id,
-      owner: ctx.user
+      owner: { id: ctx.user.id }
     });
 
     if (!/* camelName */) {
       return new HttpResponseNotFound();
     }
 
-    await getRepository(/* upperFirstCamelName */).delete(ctx.request.params./* camelName */Id);
+    await /* upperFirstCamelName */.delete({ id: ctx.request.params./* camelName */Id });
 
     return new HttpResponseNoContent();
   }