@ditojs/server 0.271.0 → 0.274.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/server",
-  "version": "0.271.0",
+  "version": "0.274.0",
   "description": "Dito.js Server – Dito.js is a declarative and modern web framework, based on Objection.js, Koa.js and Vue.js",
   "main": "lib/index.js",
   "repository": "https://github.com/ditojs/dito/tree/master/packages/server",
@@ -25,34 +25,33 @@
     "yarn": ">= 1.0.0"
   },
   "browserslist": [
-    "node 14"
+    "node >= 14"
   ],
   "dependencies": {
-    "@babel/core": "^7.15.5",
-    "@babel/runtime": "^7.15.4",
-    "@ditojs/admin": "^0.271.0",
-    "@ditojs/router": "^0.271.0",
-    "@ditojs/utils": "^0.271.0",
+    "@babel/core": "^7.17.5",
+    "@babel/runtime": "^7.17.2",
+    "@ditojs/admin": "^0.274.0",
+    "@ditojs/router": "^0.274.0",
+    "@ditojs/utils": "^0.274.0",
     "@koa/cors": "^3.1.0",
     "@koa/multer": "^3.0.0",
-    "@vue/cli-service": "^4.5.13",
+    "@vue/cli-service": "^4.5.15",
     "ajv": "^7.2.4",
     "ajv-formats": "^1.6.1",
-    "aws-sdk": "^2.999.0",
-    "axios": "^0.22.0",
-    "babel-loader": "^8.2.2",
+    "aws-sdk": "^2.1087.0",
+    "axios": "^0.26.0",
+    "babel-loader": "^8.2.3",
     "bcryptjs": "^2.4.3",
-    "bytes": "^3.1.0",
-    "chalk": "^4.1.2",
-    "core-js": "^3.18.1",
+    "bytes": "^3.1.2",
+    "core-js": "^3.21.1",
     "data-uri-to-buffer": "^3.0.1",
-    "eventemitter2": "^6.4.4",
+    "eventemitter2": "^6.4.5",
     "file-type": "^16.5.3",
-    "fs-extra": "^10.0.0",
+    "fs-extra": "^10.0.1",
     "html-webpack-tags-plugin": "^2.0.17",
-    "image-size": "^1.0.0",
-    "is-svg": "^4.3.1",
-    "koa": "^2.13.3",
+    "image-size": "^1.0.1",
+    "is-svg": "^4.3.2",
+    "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
     "koa-compose": "^4.1.0",
     "koa-compress": "^5.1.0",
@@ -66,14 +65,15 @@
     "koa-session": "^6.2.0",
     "koa-static": "^5.0.0",
     "koa-webpack": "^6.0.0",
-    "mime-types": "^2.1.33",
-    "multer": "^1.4.3",
-    "multer-s3": "^2.9.0",
-    "nanoid": "^3.1.28",
-    "parse-duration": "^1.0.0",
+    "mime-types": "^2.1.34",
+    "multer": "^1.4.4",
+    "multer-s3": "^2.10.0",
+    "nanoid": "^3.3.1",
+    "parse-duration": "^1.0.2",
     "passport-local": "^1.0.0",
     "passthrough-counter": "^1.0.0",
-    "pino": "^6.13.3",
+    "picocolors": "^1.0.0",
+    "pino": "^6.14.0",
     "pino-pretty": "^6.0.0",
     "pluralize": "^8.0.0",
     "repl": "^0.1.3",
@@ -89,16 +89,16 @@
     "objection": "^2.2.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.15.7",
-    "@babel/preset-env": "^7.15.6",
-    "@ditojs/babel-preset": "^0.271.0",
+    "@babel/cli": "^7.17.6",
+    "@babel/preset-env": "^7.16.11",
+    "@ditojs/babel-preset": "^0.274.0",
     "babel-plugin-dynamic-import-node": "^2.3.3",
     "babel-plugin-module-resolver": "^4.1.0",
     "knex": "^0.21.21",
-    "objection": "^2.2.16",
-    "pg": "^8.7.1",
+    "objection": "^2.2.18",
+    "pg": "^8.7.3",
     "rimraf": "^3.0.2",
     "sqlite3": "^5.0.2"
   },
-  "gitHead": "23245bf234f83049097413475a32d5bd27c5a603"
+  "gitHead": "0ebfe0bb8913f9d338bb91a0a507e7a4c6e49ecb"
 }

package/src/app/Application.js

@@ -2,7 +2,7 @@ import Koa from 'koa'
 import Knex from 'knex'
 import util from 'util'
 import axios from 'axios'
-import chalk from 'chalk'
+import pico from 'picocolors'
 import zlib from 'zlib'
 import pino from 'pino'
 import os from 'os'
@@ -23,7 +23,13 @@ import { Controller, AdminController } from '@/controllers'
 import { Service } from '@/services'
 import { Storage } from '@/storage'
 import { convertSchema } from '@/schema'
-import { ResponseError, ValidationError, AssetError } from '@/errors'
+import { formatJson } from '@/utils'
+import {
+  ResponseError,
+  ValidationError,
+  DatabaseError,
+  AssetError
+} from '@/errors'
 import SessionStore from './SessionStore'
 import { Validator } from './Validator'
 import {
@@ -157,7 +163,7 @@ export class Application extends Koa {
         }
         if (Object.keys(data).length > 0) {
           console.info(
-            chalk.yellow.bold(`\n${modelClass.name}:\n`),
+            pico.yellow.bold(`\n${modelClass.name}:\n`),
             util.inspect(data, {
               colors: true,
               depth: null,
@@ -472,11 +478,26 @@ export class Application extends Koa {
     }
   }
 
-  createValidationError({ type, message, errors, options }) {
+  createValidationError({ type, message, errors, options, json }) {
     return new ValidationError({
       type,
       message,
-      errors: this.validator.parseErrors(errors, options)
+      errors: this.validator.parseErrors(errors, options),
+      // Only include the JSON data in the error if `log.errors.json`is set.
+      json: this.config.log.errors?.json ? json : undefined
+    })
+  }
+
+  createDatabaseError(error) {
+    // Remove knex SQL query and move to separate `sql` property.
+    // TODO: Fix this properly in Knex / Objection instead, see:
+    // https://gitter.im/Vincit/objection.js?at=5a68728f5a9ebe4f75ca40b0
+    const [, sql, message] = error.message.match(/^([\s\S]*) - ([\s\S]*?)$/) ||
+      [null, null, error.message]
+    return new DatabaseError(error, {
+      message,
+      // Only include the SQL query in the error if `log.errors.sql`is set.
+      sql: this.config.log.errors?.sql ? sql : undefined
     })
   }
 
@@ -485,13 +506,15 @@ export class Application extends Koa {
 
     this.use(attachLogger(this.logger))
 
-    this.use(handleError())
     if (app.responseTime !== false) {
       this.use(responseTime(getOptions(app.responseTime)))
     }
     if (log.requests) {
       this.use(logRequests())
     }
+    // Needs to be positioned after the request logger to log the correct
+    // response status.
+    this.use(handleError())
     if (app.helmet !== false) {
       this.use(helmet(getOptions(app.helmet)))
     }
@@ -605,6 +628,12 @@ export class Application extends Koa {
         }
       }
       this.knex = Knex(knex)
+      // Support PostgreSQL type parser mappings in the config.
+      if (knex.client === 'postgresql' && knex.typeParsers) {
+        for (const [type, parser] of Object.entries(knex.typeParsers)) {
+          this.knex.client.driver.types.setTypeParser(type, parser)
+        }
+      }
       if (log.sql) {
         this.setupKnexLogging()
       }
@@ -655,7 +684,7 @@ export class Application extends Koa {
 
   formatError(err) {
     const message = err.toJSON
-      ? JSON.stringify(err.toJSON(), null, 2)
+      ? formatJson(err.toJSON())
       : err.message || err
     const str = `${err.name}: ${message}`
     return err.stack && this.config.log.errors?.stack !== false
@@ -823,13 +852,13 @@ export class Application extends Koa {
               if (!data) {
                 console.info(
                   `${
-                    chalk.red('INFO:')
+                    pico.red('INFO:')
                   } Asset ${
-                    chalk.green(`'${file.name}'`)
+                    pico.green(`'${file.name}'`)
                   } is from a foreign source, fetching from ${
-                    chalk.green(`'${file.url}'`)
+                    pico.green(`'${file.url}'`)
                   } and adding to storage ${
-                    chalk.green(`'${storage.name}'`)
+                    pico.green(`'${storage.name}'`)
                   }...`
                 )
                 const response = await axios.request({

package/src/app/Validator.js

@@ -2,6 +2,7 @@ import objection from 'objection'
 import Ajv from 'ajv'
 import addFormats from 'ajv-formats'
 import { isArray, isObject, clone, isAsync, isPromise } from '@ditojs/utils'
+import { formatJson } from '@/utils'
 import * as schema from '@/schema'
 
 // Dito does not rely on objection.AjvValidator but instead implements its own
@@ -83,7 +84,7 @@ export class Validator extends objection.Validator {
       }
       return opts
     }, {})
-    const cacheKey = JSON.stringify(opts)
+    const cacheKey = formatJson(opts, false)
     const { ajv } = this.ajvCache[cacheKey] || (this.ajvCache[cacheKey] = {
       ajv: this.createAjv(opts),
       options

package/src/cli/console.js

@@ -1,7 +1,7 @@
 import repl from 'repl'
 import path from 'path'
 import fs from 'fs-extra'
-import chalk from 'chalk'
+import pico from 'picocolors'
 import objection from 'objection'
 import { isFunction, deindent } from '@ditojs/utils'
 
@@ -100,11 +100,11 @@ function displayUsage(app, config, details) {
     Dito Console
 
     Available references:
-     - Dito app: ${chalk.cyan('app')}
+     - Dito app: ${pico.cyan('app')}
     ${
       modelHandleNames.length > 0
         ? ` - Dito models: ${
-          modelHandleNames.map(m => chalk.cyan(m)).join(', ')
+          modelHandleNames.map(m => pico.cyan(m)).join(', ')
         }`
         : ''
     }

package/src/cli/db/createMigration.js

@@ -1,6 +1,6 @@
 import path from 'path'
 import fs from 'fs-extra'
-import chalk from 'chalk'
+import pico from 'picocolors'
 import { getRelationClass, isThroughRelationClass } from '@/schema'
 import {
   isObject, isArray, isString, deindent, capitalize
@@ -52,7 +52,7 @@ export async function createMigration(app, name, ...modelNames) {
   const file = path.join(migrationDir, filename)
   if (await fs.exists(file)) {
     // This should never happen, but let's be on the safe side here:
-    console.info(chalk.red(`Migration '${filename}' already exists.`))
+    console.info(pico.red(`Migration '${filename}' already exists.`))
     return false
   } else {
     await fs.writeFile(file, deindent`
@@ -64,7 +64,7 @@ export async function createMigration(app, name, ...modelNames) {
         ${getCode(dropTables)}
       }
     `)
-    console.info(chalk.cyan(`Migration '${filename}' successfully created.`))
+    console.info(pico.cyan(`Migration '${filename}' successfully created.`))
     return true
   }
 }

package/src/cli/db/listAssetConfig.js

@@ -1,8 +1,10 @@
+import { formatJson } from '@/utils'
+
 export async function listAssetConfig(app, ...args) {
   const assetConfig = app.getAssetConfig({
     models: args.length > 0 ? args : Object.keys(app.models),
     normalizeDbNames: true
   })
-  console.info(JSON.stringify(assetConfig, null, 2))
+  console.info(formatJson(assetConfig))
   return true
 }

package/src/cli/db/migrate.js

@@ -1,10 +1,10 @@
-import chalk from 'chalk'
+import pico from 'picocolors'
 
 export async function migrate(knex) {
   const [batch, log] = await knex.migrate.latest()
   console.info(log.length === 0
-    ? chalk.cyan('Already up to date')
-    : chalk.green(`Batch ${batch} run: ${log.length} migrations\n`) +
-      chalk.cyan(log.join('\n')))
+    ? pico.cyan('Already up to date')
+    : pico.green(`Batch ${batch} run: ${log.length} migrations\n`) +
+      pico.cyan(log.join('\n')))
   return true
 }

package/src/cli/db/reset.js

@@ -1,4 +1,4 @@
-import chalk from 'chalk'
+import pico from 'picocolors'
 import { migrate } from './migrate'
 
 export async function reset(knex) {
@@ -11,10 +11,10 @@ export async function reset(knex) {
     migrations.push(...log)
   }
   console.info(migrations.length === 0
-    ? chalk.cyan('Already at the base migration')
-    : chalk.green(`${batches.length > 1 ? 'Batches' : 'Batch'} ${batches} ` +
+    ? pico.cyan('Already at the base migration')
+    : pico.green(`${batches.length > 1 ? 'Batches' : 'Batch'} ${batches} ` +
       `rolled back: ${migrations.length} migrations\n`) +
-      chalk.cyan(migrations.join('\n')))
+      pico.cyan(migrations.join('\n')))
   await migrate(knex)
   return true
 }

package/src/cli/db/rollback.js

@@ -1,10 +1,10 @@
-import chalk from 'chalk'
+import pico from 'picocolors'
 
 export async function rollback(knex) {
   const [batch, log] = await knex.migrate.rollback()
   console.info(log.length === 0
-    ? chalk.cyan('Already at the base migration')
-    : chalk.green(`Batch ${batch} rolled back: ${log.length} migrations\n`) +
-      chalk.cyan(log.join('\n')))
+    ? pico.cyan('Already at the base migration')
+    : pico.green(`Batch ${batch} rolled back: ${log.length} migrations\n`) +
+      pico.cyan(log.join('\n')))
   return true
 }

package/src/cli/db/seed.js

@@ -1,6 +1,6 @@
 import path from 'path'
 import fs from 'fs-extra'
-import chalk from 'chalk'
+import pico from 'picocolors'
 import util from 'util'
 import pluralize from 'pluralize'
 import { isFunction, isArray, camelize } from '@ditojs/utils'
@@ -57,18 +57,18 @@ async function handleSeed(app, base, seed, modelClass) {
     }
     if (isArray(res)) {
       console.info(
-        chalk.green(`${base}:`),
-        chalk.cyan(`${res.length} seed records created.`)
+        pico.green(`${base}:`),
+        pico.cyan(`${res.length} seed records created.`)
       )
     } else {
       console.info(
-        chalk.red(`${base}:`),
-        chalk.cyan('No seed records created.')
+        pico.red(`${base}:`),
+        pico.cyan('No seed records created.')
       )
     }
   } catch (err) {
     console.error(
-      chalk.red(`${base}:`),
+      pico.red(`${base}:`),
       util.inspect(err, {
         colors: true,
         depth: null,

package/src/cli/db/unlock.js

@@ -1,9 +1,9 @@
-import chalk from 'chalk'
+import pico from 'picocolors'
 
 export async function unlock(knex) {
   await knex.migrate.forceFreeMigrationsLock()
   console.info(
-    chalk.green(`Successfully unlocked the migrations lock table`)
+    pico.green(`Successfully unlocked the migrations lock table`)
   )
   return true
 }

package/src/cli/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env babel-node
 
 import path from 'path'
-import chalk from 'chalk'
+import pico from 'picocolors'
 import Knex from 'knex'
 import { isPlainObject, isFunction, camelize } from '@ditojs/utils'
 import * as db from './db'
@@ -47,10 +47,10 @@ async function execute() {
   } catch (err) {
     if (err instanceof Error) {
       console.error(
-        chalk.red(`${err.detail ? `${err.detail}\n` : ''}${err.stack}`)
+        pico.red(`${err.detail ? `${err.detail}\n` : ''}${err.stack}`)
       )
     } else {
-      console.error(chalk.red(err))
+      console.error(pico.red(err))
     }
     process.exit(1)
   }

package/src/controllers/AdminController.js

@@ -6,8 +6,9 @@ import koaWebpack from 'koa-webpack'
 import historyApiFallback from 'koa-connect-history-api-fallback'
 import VueService from '@vue/cli-service'
 import HtmlWebpackTagsPlugin from 'html-webpack-tags-plugin'
-import { ControllerError } from '@/errors'
 import { Controller } from './Controller'
+import { ControllerError } from '@/errors'
+import { formatJson } from '@/utils'
 import { isString, isObject } from '@ditojs/utils'
 
 export class AdminController extends Controller {
@@ -59,7 +60,7 @@ export class AdminController extends Controller {
   sendDitoObject(ctx) {
     // Send back the global dito object as JavaScript code.
     ctx.type = 'text/javascript'
-    ctx.body = `window.dito = ${JSON.stringify(this.getDitoObject())}`
+    ctx.body = `window.dito = ${formatJson(this.getDitoObject())}`
   }
 
   middleware() {

package/src/controllers/Controller.js

@@ -1,4 +1,4 @@
-import chalk from 'chalk'
+import pico from 'picocolors'
 import { getOwnProperty, getAllKeys, describeFunction } from '@/utils'
 import { EventEmitter } from '@/lib'
 import ControllerAction from './ControllerAction'
@@ -44,11 +44,11 @@ export class Controller {
       this.url = namespace ? `/${namespace}${url}` : url
       this.log(
         `${
-          namespace ? chalk.green(`/${namespace}/`) : ''
+          namespace ? pico.green(`/${namespace}/`) : ''
         }${
-          chalk.cyan(path)
+          pico.cyan(path)
         }${
-          chalk.white(':')
+          pico.white(':')
         }`,
         this.level
       )
@@ -92,13 +92,13 @@ export class Controller {
   setupRoute(verb, url, transacted, authorize, action, handlers) {
     this.log(
       `${
-        chalk.magenta(verb.toUpperCase())
+        pico.magenta(verb.toUpperCase())
       } ${
-        chalk.green(this.url)
+        pico.green(this.url)
       }${
-        chalk.cyan(url.slice(this.url.length))
+        pico.cyan(url.slice(this.url.length))
       } ${
-        chalk.white(this.describeAuthorize(authorize))
+        pico.white(this.describeAuthorize(authorize))
       }`,
       this.level + 1
     )

package/src/controllers/ControllerAction.js

@@ -165,8 +165,9 @@ export default class ControllerAction {
     if (errors.length > 0) {
       throw this.createValidationError({
         type: 'ParameterValidation',
-        message: `The provided data is not valid: ${JSON.stringify(getData())}`,
-        errors
+        message: 'The provided action parameters are not valid',
+        errors,
+        json: getData()
       })
     }
   }
@@ -189,8 +190,9 @@ export default class ControllerAction {
       } catch (error) {
         throw this.createValidationError({
           type: 'ResultValidation',
-          message: `Invalid result of action: ${JSON.stringify(getResult())}`,
-          errors: error.errors
+          message: 'The returned action result is not valid',
+          errors: error.errors,
+          json: getResult()
         })
       }
     }
@@ -229,7 +231,7 @@ export default class ControllerAction {
 
   coerceValue(type, value, modelOptions) {
     // See if param needs additional coercion:
-    if (['date', 'datetime', 'timestamp'].includes(type)) {
+    if (value && ['date', 'datetime', 'timestamp'].includes(type)) {
       value = new Date(value)
     } else {
       // See if the defined type(s) require coercion to objects:

package/src/controllers/RelationController.js

@@ -1,4 +1,4 @@
-import chalk from 'chalk'
+import pico from 'picocolors'
 import { ControllerError } from '@/errors'
 import { CollectionController } from './CollectionController'
 import { setupPropertyInheritance, getScope } from '@/utils'
@@ -32,7 +32,7 @@ export class RelationController extends CollectionController {
     // Initialize:
     this.path = this.app.normalizePath(this.name)
     this.url = `${this.parent.url}/${this.parent.getPath('member', this.path)}`
-    this.log(`${chalk.blue(this.path)}${chalk.white(':')}`, this.level)
+    this.log(`${pico.blue(this.path)}${pico.white(':')}`, this.level)
     // Copy over all fields in the relation object except the ones that are
     // going to be inherited in `setup()` (relation, member, allow), for
     // settings like scope, etc.

package/src/decorators/parameters.js

@@ -1,5 +1,5 @@
 import { isArray, isObject } from '@ditojs/utils'
-import { createDecorator, deprecate } from '@/utils'
+import { createDecorator, deprecate, formatJson } from '@/utils'
 
 export function parameters(parameters, options) {
   if (isObject(parameters)) {
@@ -7,7 +7,7 @@ export function parameters(parameters, options) {
     if (!isObject(first)) {
       deprecate(
         `@parameters(${
-          JSON.stringify(parameters)
+          formatJson(parameters, false)
         }) with parameter schema object is deprecated: Schema object should be passed nested inside an array or object definition.`
       )
       parameters = [...arguments]

package/src/decorators/returns.js

@@ -1,11 +1,11 @@
 import { isObject } from '@ditojs/utils'
-import { createDecorator } from '@/utils'
+import { createDecorator, formatJson } from '@/utils'
 
 export function returns(returns, options) {
   if (!isObject(returns)) {
     throw new Error(
       `@returns(${
-        JSON.stringify(returns)
+        formatJson(returns, false)
       }) needs to be defined using an object parameter definition`
     )
   }

package/src/errors/DatabaseError.js

@@ -8,7 +8,7 @@ import {
 } from 'objection'
 
 export class DatabaseError extends WrappedError {
-  constructor(error) {
+  constructor(error, overrides) {
     const status =
       error instanceof CheckViolationError ? 400
       : error instanceof NotNullViolationError ? 400
@@ -16,28 +16,7 @@ export class DatabaseError extends WrappedError {
       : error instanceof DataError ? 400
       : error instanceof DBError ? 500
       : 400
-    // Remove knex SQL query and move to separate `query` property.
-    // TODO: Fix this properly in Knex / Objection instead, see:
-    // https://gitter.im/Vincit/objection.js?at=5a68728f5a9ebe4f75ca40b0
-    const [, sql, message] = error.message.match(/^([\s\S]*) - ([\s\S]*?)$/) ||
-      [null, null, error.message]
-    const overrides = {
-      type: error.constructor.name,
-      message,
-      sql,
-      status
-    }
+    overrides = { type: error.constructor.name, status, ...overrides }
     super(error, overrides, { message: 'Database error', status })
   }
-
-  toJSON() {
-    // Remove SQL query from displayed data in front-end when not in development
-    // or test.
-    if (process.env.NODE_ENV !== 'development' ||
-    process.env.NODE_ENV !== 'test') {
-      const { sql, ...data } = this.data
-      return data
-    }
-    return this.data
-  }
 }

package/src/errors/ResponseError.js

@@ -21,14 +21,7 @@ export class ResponseError extends Error {
           ? { message: error }
           : error || {}
     const { status, ...data } = { ...defaults, ...object }
-    let { message, code } = data
-    if (process.env.NODE_ENV === 'test' && error === object) {
-      // Include full JSON error in message during tests, for better reporting.
-      const { message: _, ...rest } = data
-      if (Object.keys(rest).length > 0) {
-        message = `${message}\nError Data:\n${JSON.stringify(rest, null, 2)}`
-      }
-    }
+    const { message, code } = data
     super(message)
     this.name = this.constructor.name
     this.status = status

package/src/middleware/logRequests.js

@@ -2,7 +2,7 @@
  * Middleware inspired by 'koa-logger'. Adapted and extended to our needs.
  */
 import bytes from 'bytes'
-import chalk from 'chalk'
+import pico from 'picocolors'
 import Counter from 'passthrough-counter'
 
 export function logRequests({ ignoreUrls } = {}) {
@@ -58,11 +58,11 @@ function logRequest(ctx) {
     logger.trace(
       { req: ctx.req },
       `${
-        chalk.gray('<--')
+        pico.gray('<--')
       } ${
-        chalk.bold(ctx.method)
+        pico.bold(ctx.method)
       } ${
-        chalk.gray(ctx.originalUrl)
+        pico.gray(ctx.originalUrl)
       }`
     )
   }
@@ -93,15 +93,15 @@ function logResponse({ ctx, start, length, err }) {
     logger[level](
       { req: ctx.req, res: ctx.res },
       `${
-        chalk.bold(ctx.method)
+        pico.bold(ctx.method)
       } ${
-        chalk.gray(ctx.originalUrl)
+        pico.gray(ctx.originalUrl)
       } ${
-        chalk[statusColor](status)
+        pico[statusColor](status)
       } ${
-        chalk.gray(formattedTime)
+        pico.gray(formattedTime)
       } ${
-        chalk.gray(formattedLength)
+        pico.gray(formattedLength)
       }`
     )
   }