@ditojs/server 0.275.0 → 1.0.0-rc.0

package/package.json

@@ -1,24 +1,17 @@
 {
+  "type": "module",
   "name": "@ditojs/server",
-  "version": "0.275.0",
+  "version": "1.0.0-rc.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",
   "author": "Jürg Lehni <juerg@scratchdisk.com> (http://scratchdisk.com)",
   "license": "MIT",
+  "main": "./src/index.js",
   "files": [
-    "src/",
-    "lib/"
+    "src/"
   ],
-  "scripts": {
-    "knex": "babel-node node_modules/.bin/knex",
-    "clean": "rimraf lib",
-    "build": "babel src --out-dir lib --copy-files",
-    "watch": "yarn build --watch",
-    "prepare": "yarn clean && yarn build"
-  },
   "bin": {
-    "dito": "./lib/cli/index.js"
+    "dito": "./src/cli/index.js"
   },
   "engines": {
     "node": ">= 14.0.0",
@@ -28,27 +21,23 @@
     "node >= 14"
   ],
   "dependencies": {
-    "@babel/core": "^7.17.5",
-    "@babel/runtime": "^7.17.2",
-    "@ditojs/admin": "^0.275.0",
-    "@ditojs/router": "^0.275.0",
-    "@ditojs/utils": "^0.275.0",
-    "@koa/cors": "^3.1.0",
+    "@ditojs/admin": "^1.0.0-rc.0",
+    "@ditojs/router": "^1.0.0-rc.0",
+    "@ditojs/utils": "^1.0.0-rc.0",
+    "@koa/cors": "^3.2.0",
     "@koa/multer": "^3.0.0",
-    "@vue/cli-service": "^4.5.15",
+    "@originjs/vite-plugin-commonjs": "^1.0.3",
     "ajv": "^7.2.4",
     "ajv-formats": "^1.6.1",
-    "aws-sdk": "^2.1087.0",
-    "axios": "^0.26.0",
-    "babel-loader": "^8.2.3",
+    "aws-sdk": "^2.1093.0",
+    "axios": "^0.26.1",
     "bcryptjs": "^2.4.3",
     "bytes": "^3.1.2",
-    "core-js": "^3.21.1",
-    "data-uri-to-buffer": "^3.0.1",
+    "data-uri-to-buffer": "^4.0.0",
     "eventemitter2": "^6.4.5",
-    "file-type": "^16.5.3",
+    "file-type": "^17.1.1",
+    "find-up": "^6.3.0",
     "fs-extra": "^10.0.1",
-    "html-webpack-tags-plugin": "^2.0.17",
     "image-size": "^1.0.1",
     "is-svg": "^4.3.2",
     "koa": "^2.13.4",
@@ -56,7 +45,6 @@
     "koa-compose": "^4.1.0",
     "koa-compress": "^5.1.0",
     "koa-conditional-get": "^3.0.0",
-    "koa-connect-history-api-fallback": "^0.3.1",
     "koa-etag": "^4.0.0",
     "koa-helmet": "^6.1.0",
     "koa-mount": "^4.0.0",
@@ -64,8 +52,8 @@
     "koa-response-time": "^2.1.0",
     "koa-session": "^6.2.0",
     "koa-static": "^5.0.0",
-    "koa-webpack": "^6.0.0",
-    "mime-types": "^2.1.34",
+    "mime-types": "^2.1.35",
+    "minimatch": "^5.0.1",
     "multer": "^1.4.4",
     "multer-s3": "^2.10.0",
     "nanoid": "^3.3.1",
@@ -73,32 +61,26 @@
     "passport-local": "^1.0.0",
     "passthrough-counter": "^1.0.0",
     "picocolors": "^1.0.0",
-    "pino": "^6.14.0",
-    "pino-pretty": "^6.0.0",
+    "picomatch": "^2.3.1",
+    "pino": "^7.8.1",
+    "pino-pretty": "^7.5.3",
     "pluralize": "^8.0.0",
     "repl": "^0.1.3",
-    "source-map-loader": "1.1.3",
     "uuid": "^8.3.2",
+    "vite": "^2.8.6",
+    "vite-plugin-vue2": "^1.9.3",
     "vue": "^2.6.14",
-    "vue-template-compiler": "^2.6.14",
-    "webpack": "^4.46.0",
-    "webpack-hot-client": "^4.2.0"
+    "vue-template-compiler": "^2.6.14"
   },
   "peerDependencies": {
     "knex": "^0.21.0",
     "objection": "^2.2.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.6",
-    "@babel/preset-env": "^7.16.11",
-    "@ditojs/babel-preset": "^0.275.0",
-    "babel-plugin-dynamic-import-node": "^2.3.3",
-    "babel-plugin-module-resolver": "^4.1.0",
-    "knex": "^0.21.21",
+    "knex": "^0.21.17",
     "objection": "^2.2.18",
     "pg": "^8.7.3",
-    "rimraf": "^3.0.2",
     "sqlite3": "^5.0.2"
   },
-  "gitHead": "b1ee07dad73b0e3408cd90798deb7608c8ef096d"
+  "gitHead": "e643586e4b26a850f54c52a1f1bf8f0421c05d31"
 }

package/src/app/Application.js

@@ -12,26 +12,31 @@ import cors from '@koa/cors'
 import compose from 'koa-compose'
 import compress from 'koa-compress'
 import conditional from 'koa-conditional-get'
+import mount from 'koa-mount'
 import passport from 'koa-passport'
 import session from 'koa-session'
 import etag from 'koa-etag'
 import helmet from 'koa-helmet'
 import responseTime from 'koa-response-time'
 import Router from '@ditojs/router'
-import { EventEmitter } from '@/lib'
-import { Controller, AdminController } from '@/controllers'
-import { Service } from '@/services'
-import { Storage } from '@/storage'
-import { convertSchema } from '@/schema'
-import { formatJson } from '@/utils'
+import {
+  isArray, isObject, isString, asArray, isPlainObject, hyphenate, clone, merge,
+  parseDataPath, normalizeDataPath, isModule
+} from '@ditojs/utils'
+import SessionStore from './SessionStore.js'
+import { Validator } from './Validator.js'
+import { EventEmitter } from '../lib/index.js'
+import { Controller, AdminController } from '../controllers/index.js'
+import { Service } from '../services/index.js'
+import { Storage } from '../storage/index.js'
+import { convertSchema } from '../schema/index.js'
+import { formatJson } from '../utils/index.js'
 import {
   ResponseError,
   ValidationError,
   DatabaseError,
   AssetError
-} from '@/errors'
-import SessionStore from './SessionStore'
-import { Validator } from './Validator'
+} from '../errors/index.js'
 import {
   attachLogger,
   createTransaction,
@@ -40,15 +45,12 @@ import {
   handleRoute,
   handleUser,
   logRequests
-} from '@/middleware'
-import {
-  isArray, isObject, isString, asArray, isPlainObject, hyphenate, clone, merge,
-  parseDataPath, normalizeDataPath
-} from '@ditojs/utils'
-import {
+} from '../middleware/index.js'
+import objection, {
   Model,
   BelongsToOneRelation,
-  knexSnakeCaseMappers,
+  // TODO: Import directly once we can move to Objection 3
+  // knexSnakeCaseMappers,
   ref
 } from 'objection'
 
@@ -85,13 +87,10 @@ export class Application extends Koa {
     this.models = Object.create(null)
     this.services = Object.create(null)
     this.controllers = Object.create(null)
-    this.hasControllerMiddleware = false
     this.setupLogger()
     this.setupKnex()
-    this.setupGlobalMiddleware()
-    if (middleware) {
-      this.use(middleware)
-    }
+    this.setupMiddleware(middleware)
+
     if (config.storages) {
       this.addStorages(config.storages)
     }
@@ -106,20 +105,24 @@ export class Application extends Koa {
     }
   }
 
-  addRoute(verb, path, transacted, handlers, controller = null, action = null) {
-    handlers = asArray(handlers)
-    const handler = handlers.length > 1 ? compose(handlers) : handlers[0]
+  addRoute(
+    method, path, transacted, middlewares, controller = null, action = null
+  ) {
+    middlewares = asArray(middlewares)
+    const middleware = middlewares.length > 1
+      ? compose(middlewares)
+      : middlewares[0]
     // Instead of directly passing `handler`, pass a `route` object that also
     // will be exposed through `ctx.route`, see `routerHandler()`:
     const route = {
-      verb,
+      method,
       path,
       transacted,
-      handler,
+      middleware,
       controller,
       action
     }
-    this.router[verb](path, route)
+    this.router[method](path, route)
   }
 
   addModels(models) {
@@ -235,12 +238,7 @@ export class Application extends Koa {
 
   addServices(services) {
     for (const [name, service] of Object.entries(services)) {
-      // Handle ES6 module weirdness that can happen, apparently:
-      if (name === 'default' && isPlainObject(service)) {
-        this.addServices(service)
-      } else {
-        this.addService(service, name)
-      }
+      this.addService(service, name)
     }
   }
 
@@ -285,7 +283,7 @@ export class Application extends Koa {
 
   addControllers(controllers, namespace) {
     for (const [key, value] of Object.entries(controllers)) {
-      if (isPlainObject(value)) {
+      if (isModule(value) || isPlainObject(value)) {
         this.addControllers(value, namespace ? `${namespace}/${key}` : key)
       } else {
         this.addController(value, namespace)
@@ -294,8 +292,6 @@ export class Application extends Koa {
   }
 
   addController(controller, namespace) {
-    // Controllers require additional middleware to be installed once.
-    this.setupControllerMiddleware()
     // Auto-instantiate controller classes:
     if (Controller.isPrototypeOf(controller)) {
       // eslint-disable-next-line new-cap
@@ -311,11 +307,11 @@ export class Application extends Koa {
     // Now that the controller is set up, call `initialize()` which can be
     // overridden by controllers.
     controller.initialize()
-    // Each controller can also provide further middleware, e.g.
-    // `AdminController`:
-    const middleware = controller.compose()
-    if (middleware) {
-      this.use(middleware)
+    // Each controller can also compose their own middleware (or app), e.g. as
+    // used in `AdminController`:
+    const composed = controller.compose()
+    if (composed) {
+      this.use(mount(controller.url, composed))
     }
   }
 
@@ -333,8 +329,8 @@ export class Application extends Koa {
     )
   }
 
-  getAdminVueConfig() {
-    return this.getAdminController()?.getVueConfig() || null
+  getAdminViteConfig(config) {
+    return this.getAdminController()?.getViteConfig(config) || null
   }
 
   getAssetConfig({
@@ -501,18 +497,19 @@ export class Application extends Koa {
     })
   }
 
-  setupGlobalMiddleware() {
+  setupMiddleware(middleware) {
     const { app, log } = this.config
 
-    this.use(attachLogger(this.logger))
+    // Setup global middleware
 
+    this.use(attachLogger(this.logger))
     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
+    // This needs to be positioned after the request logger to log the correct
     // response status.
     this.use(handleError())
     if (app.helmet !== false) {
@@ -539,50 +536,44 @@ export class Application extends Koa {
       this.use(conditional())
       this.use(etag())
     }
-  }
 
-  setupControllerMiddleware() {
-    // NOTE: This is not part of the automatic `setupGlobalMiddleware()` so that
-    // apps can set up the static serving of assets before installing the
-    // session and passport middleware. It is called from `addController()`.
-    // Use a flag to only install the middleware once:
-    if (!this.hasControllerMiddleware) {
-      const { app } = this.config
-      // Sequence is important:
-      // 1. body parser
-      this.use(bodyParser(getOptions(app.bodyParser)))
-      // 2. find route from routes installed by controllers.
-      this.use(findRoute(this.router))
-      // 3. respect transacted settings, create and handle transactions.
-      this.use(createTransaction())
-      // 4. session
-      if (app.session) {
-        const {
-          modelClass,
-          ...options
-        } = getOptions(app.session)
-        if (modelClass) {
-          // Create a ContextStore that resolved the specified model class,
-          // uses it to persist and retrieve the session, and automatically
-          // binds all db operations to `ctx.transaction`, if it is set.
-          // eslint-disable-next-line new-cap
-          options.ContextStore = SessionStore(modelClass)
-        }
-        this.use(session(options, this))
+    // Controller-specific middleware
+
+    // 1. Find route from routes installed by controllers.
+    this.use(findRoute(this.router))
+    // 2. Additional, user-space application-level middleware.
+    if (middleware) {
+      this.use(middleware)
+    }
+    // 3. body parser
+    this.use(bodyParser(getOptions(app.bodyParser)))
+    // 4. respect transacted settings, create and handle transactions.
+    this.use(createTransaction())
+    // 5. session
+    if (app.session) {
+      const {
+        modelClass,
+        ...options
+      } = getOptions(app.session)
+      if (modelClass) {
+        // Create a ContextStore that resolved the specified model class,
+        // uses it to persist and retrieve the session, and automatically
+        // binds all db operations to `ctx.transaction`, if it is set.
+        // eslint-disable-next-line new-cap
+        options.ContextStore = SessionStore(modelClass)
       }
-      // 5. passport
-      if (app.passport) {
-        this.use(passport.initialize())
-        if (app.session) {
-          this.use(passport.session())
-        }
-        this.use(handleUser())
+      this.use(session(options, this))
+    }
+    // 6. passport
+    if (app.passport) {
+      this.use(passport.initialize())
+      if (app.session) {
+        this.use(passport.session())
       }
-
-      // 6. finally handle the found route, or set status / allow accordingly.
-      this.use(handleRoute())
-      this.hasControllerMiddleware = true
+      this.use(handleUser())
     }
+    // 6. finally handle the found route, or set status / allow accordingly.
+    this.use(handleRoute())
   }
 
   setupLogger() {
@@ -591,26 +582,32 @@ export class Application extends Koa {
     const user = user => ({ id: user.id })
     const serializers = { err, req, res, user }
 
-    const logger = pino(merge(
-      {
-        level: 'info',
-        serializers,
-        prettyPrint: {
-          // List of keys to ignore in pretty mode.
-          ignore: 'req,res,durationMs,user,requestId',
-          // SYS to use system time and not UTC.
-          translateTime: 'SYS:HH:MM:ss.l'
-        },
-        // Redact common sensitive headers.
-        redact: [
-          '*.headers["cookie"]',
-          '*.headers["set-cookie"]',
-          '*.headers["authorization"]'
-        ],
-        base: null // no pid,hostname,name
+    const { prettyPrint, ...options } = merge({
+      level: 'info',
+      serializers,
+      prettyPrint: {
+        colorize: true,
+        // List of keys to ignore in pretty mode.
+        ignore: 'req,res,durationMs,user,requestId',
+        // SYS to use system time and not UTC.
+        translateTime: 'SYS:HH:MM:ss.l'
       },
-      getOptions(this.config.logger)
-    ))
+      // Redact common sensitive headers.
+      redact: [
+        '*.headers["cookie"]',
+        '*.headers["set-cookie"]',
+        '*.headers["authorization"]'
+      ],
+      base: null // no pid,hostname,name
+    }, getOptions(this.config.logger))
+
+    const transport = prettyPrint
+      ? pino.transport({
+        target: 'pino-pretty',
+        options: prettyPrint
+      }) : null
+
+    const logger = pino(options, transport)
 
     this.logger = logger.child({ name: 'app' })
   }
@@ -624,7 +621,7 @@ export class Application extends Koa {
       if (snakeCaseOptions) {
         knex = {
           ...knex,
-          ...knexSnakeCaseMappers(snakeCaseOptions)
+          ...objection.knexSnakeCaseMappers(snakeCaseOptions)
         }
       }
       this.knex = Knex(knex)
@@ -716,15 +713,12 @@ export class Application extends Koa {
     }
     await this.emit('before:start')
     await this.forEachService(service => service.start())
-    const {
-      server: { host, port },
-      env
-    } = this.config
+    const { server: { host, port } } = this.config
     this.server = await new Promise((resolve, reject) => {
       const server = this.listen(port, host, () => {
         const { port } = server.address()
         console.info(
-          `${env} server started at http://${host}:${port}`
+          `Dito server started at http://${host}:${port}`
         )
         resolve(server)
       })

package/src/app/Validator.js

@@ -1,9 +1,12 @@
 import objection from 'objection'
-import Ajv from 'ajv'
+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'
+import { formatJson } from '../utils/index.js'
+import * as schema from '../schema/index.js'
+
+// TODO: Switch to direct import once Ajv is updated / supports ESM.
+const Ajv = ajv.default
 
 // Dito does not rely on objection.AjvValidator but instead implements its own
 // validator instance that is shared across the whole app and handles schema

package/src/app/index.js

@@ -1,2 +1,2 @@
-export * from './Application'
-export * from './Validator'
+export * from './Application.js'
+export * from './Validator.js'

package/src/cli/db/createMigration.js

@@ -1,7 +1,7 @@
 import path from 'path'
 import fs from 'fs-extra'
 import pico from 'picocolors'
-import { getRelationClass, isThroughRelationClass } from '@/schema'
+import { getRelationClass, isThroughRelationClass } from '@ditojs/server'
 import {
   isObject, isArray, isString, deindent, capitalize
 } from '@ditojs/utils'

package/src/cli/db/index.js

@@ -1,7 +1,7 @@
-export * from './createMigration'
-export * from './listAssetConfig'
-export * from './migrate'
-export * from './rollback'
-export * from './reset'
-export * from './seed'
-export * from './unlock'
+export * from './createMigration.js'
+export * from './listAssetConfig.js'
+export * from './migrate.js'
+export * from './rollback.js'
+export * from './reset.js'
+export * from './seed.js'
+export * from './unlock.js'

package/src/cli/db/listAssetConfig.js

@@ -1,4 +1,4 @@
-import { formatJson } from '@/utils'
+import { formatJson } from '@ditojs/server'
 
 export async function listAssetConfig(app, ...args) {
   const assetConfig = app.getAssetConfig({

package/src/cli/db/reset.js

@@ -1,5 +1,5 @@
 import pico from 'picocolors'
-import { migrate } from './migrate'
+import { migrate } from './migrate.js'
 
 export async function reset(knex) {
   const batches = []

package/src/cli/index.js

@@ -1,11 +1,16 @@
-#!/usr/bin/env babel-node
+#!/usr/bin/env node
 
 import path from 'path'
+import fs from 'fs'
 import pico from 'picocolors'
 import Knex from 'knex'
 import { isPlainObject, isFunction, camelize } from '@ditojs/utils'
-import * as db from './db'
-import startConsole from './console'
+import * as db from './db/index.js'
+import startConsole from './console.js'
+
+// Tell Knex to use ESM. TODO: Fix this properly in Knex itself, so it works
+// with Yarn too.
+process.env.npm_package_type = 'module'
 
 const commands = { db, console: startConsole }
 
@@ -56,8 +61,12 @@ async function execute() {
   }
 }
 
-// Start the console if `node ./lib/cli/index.js`
-if (require.main === module) {
+// Start the console if `node ./cli/index.js`
+
+// See module was not imported but called directly
+const path1 = fs.realpathSync(import.meta.url.replace(/^file:\/\//, ''))
+const path2 = fs.realpathSync(process.argv[1])
+if (path1 === path2) {
   execute()
 }