@ditojs/server 1.21.0 → 1.22.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/server",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "type": "module",
   "description": "Dito.js Server – Dito.js is a declarative and modern web framework, based on Objection.js, Koa.js and Vue.js",
   "repository": "https://github.com/ditojs/dito/tree/master/packages/server",
@@ -25,20 +25,20 @@
     "node >= 18"
   ],
   "dependencies": {
-    "@ditojs/admin": "^1.21.0",
-    "@ditojs/build": "^1.21.0",
-    "@ditojs/router": "^1.21.0",
-    "@ditojs/utils": "^1.21.0",
+    "@ditojs/admin": "^1.22.0",
+    "@ditojs/build": "^1.22.0",
+    "@ditojs/router": "^1.22.0",
+    "@ditojs/utils": "^1.22.0",
     "@koa/cors": "^4.0.0",
     "@koa/multer": "^3.0.2",
     "@originjs/vite-plugin-commonjs": "^1.0.3",
-    "ajv": "^8.11.2",
+    "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
     "bcryptjs": "^2.4.3",
     "bytes": "^3.1.2",
-    "data-uri-to-buffer": "^4.0.0",
+    "data-uri-to-buffer": "^4.0.1",
     "eventemitter2": "^6.4.9",
-    "file-type": "^18.0.0",
+    "file-type": "^18.2.0",
     "image-size": "^1.0.2",
     "is-svg": "^4.3.2",
     "koa": "^2.14.1",
@@ -62,13 +62,13 @@
     "passthrough-counter": "^1.0.0",
     "picocolors": "^1.0.0",
     "picomatch": "^2.3.1",
-    "pino": "^8.7.0",
+    "pino": "^8.8.0",
     "pino-pretty": "^9.1.1",
     "pluralize": "^8.0.0",
     "repl": "^0.1.3",
     "uuid": "^9.0.0",
-    "vite": "^4.0.1",
-    "vite-plugin-vue2": "^2.0.2",
+    "vite": "^4.0.4",
+    "vite-plugin-vue2": "^2.0.3",
     "vue": "^2.7.14",
     "vue-template-compiler": "^2.7.14"
   },
@@ -78,7 +78,7 @@
     "objection": "^3.0.1"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3": "^3.229.0",
+    "@aws-sdk/client-s3": "^3.258.0",
     "@types/koa-bodyparser": "^4.3.10",
     "@types/koa-compress": "^4.0.3",
     "@types/koa-logger": "^3.1.2",
@@ -87,12 +87,12 @@
     "@types/koa-session": "^5.10.6",
     "@types/koa-static": "^4.0.2",
     "@types/koa__cors": "^3.3.0",
-    "@types/node": "^18.11.14",
-    "knex": "^2.3.0",
+    "@types/node": "^18.11.18",
+    "knex": "^2.4.2",
     "objection": "^3.0.1",
-    "type-fest": "^3.4.0",
+    "type-fest": "^3.5.3",
     "typescript": "^4.9.4"
   },
   "types": "types",
-  "gitHead": "a9dd1a854dbf2928a92c0be6481d704bd579cfdc"
+  "gitHead": "e1693edb8bf18e074606a842f2f2bacc1d2856cb"
 }

package/src/controllers/Controller.js

@@ -6,8 +6,8 @@ import {
   ResponseError, ControllerError, AuthorizationError
 } from '../errors/index.js'
 import {
-  getOwnProperty, getOwnKeys, getAllKeys, processHandlerParameters,
-  describeFunction, formatJson, deprecate
+  getOwnProperty, getOwnKeys, getAllKeys, getInheritanceChain,
+  processHandlerParameters, describeFunction, formatJson, deprecate
 } from '../utils/index.js'
 import {
   isObject, isString, isArray, isBoolean, isFunction, asArray, equals,
@@ -34,7 +34,17 @@ export class Controller {
   // which sets up the actions and routes, and the custom `async initialize()`.
   // @overridable
   configure() {
-    this._configureEmitter(this.hooks, {
+    const hooks = this.inheritValues('hooks')
+    // Collect callbacks from the full inheritance chain of the hooks, so that
+    // the callbacks from base classes are also run. And reverse the chain so
+    // that the base class callbacks are run first.
+    const chain = getInheritanceChain(hooks).reverse()
+    const events = Object.fromEntries(
+      Object.keys(hooks || {}).map(
+        event => [event, chain.map(hooks => hooks[event]).filter(Boolean)]
+      )
+    )
+    this._configureEmitter(events, {
       // Support wildcard hooks only on controllers:
       wildcard: true
     })

package/src/utils/object.js

@@ -46,13 +46,24 @@ export function mergeAsReversedArrays(objects) {
   return res
 }
 
-export function setupPropertyInheritance(object, key, baseValue = null) {
-  // Loops up the inheritance chain of object until the base object is met,
-  // and sets up a related inheritance chain for the given property `key`.
-  // At the end, the resulting value with proper inheritance is returned.
+export function getInheritanceChain(object) {
+  // Returns an array of objects from the inheritance chain of `object`,
+  // starting with the object itself and ending at `Object.prototype`.
+  const chain = []
   let current = object
-  while (current !== Object.prototype) {
-    const parent = Object.getPrototypeOf(current)
+  while (current && current !== Object.prototype) {
+    chain.push(current)
+    current = Object.getPrototypeOf(current)
+  }
+  return chain
+}
+
+export function setupPropertyInheritance(object, key, baseValue = null) {
+  // Loops through the inheritance chain of `object` and sets up a related
+  // inheritance chain for the given property `key`. The resulting value with
+  // proper inheritance is returned.
+  let [current, ...parents] = getInheritanceChain(object)
+  for (const parent of parents) {
     if (current.hasOwnProperty(key)) {
       const value = current[key]
       const parentValue = parent[key] || baseValue

package/types/index.d.ts

@@ -23,6 +23,7 @@ import koaResponseTime from 'koa-response-time'
 import koaSession from 'koa-session'
 import * as objection from 'objection'
 import { KnexSnakeCaseMappersFactory } from 'objection'
+import { Logger } from 'pino'
 import {
   Class,
   ConditionalExcept,
@@ -32,7 +33,6 @@ import {
   SetReturnType
 } from 'type-fest'
 import { UserConfig } from 'vite'
-import { Logger } from 'pino'
 
 export type Page<$Model extends Model = Model> = {
   total: number
@@ -870,9 +870,19 @@ export class Controller {
   authorize?: Authorize
   actions?: ControllerActions<this>
 
+  /**
+   * `configure()` is called right after the constructor, but before `setup()`
+   * which sets up the actions and routes, and the custom `async initialize()`.
+   * @overridable
+   */
   configure(): void
+  /* @overridable */
   setup(): void
-  initialize(): void
+  /**
+   * To be overridden in sub-classes, if the controller needs to initialize.
+   * @overridable
+   */
+  initialize(): Promise<void>
   // TODO: type reflectActionsObject
   reflectActionsObject(): any
   setupRoute<$ControllerAction extends ControllerAction = ControllerAction>(
@@ -893,6 +903,11 @@ export class Controller {
     authorize: Authorize
   ): void
 
+  /**
+   * To be overridden in sub-classes, if the controller needs to install
+   * middleware.
+   * @overridable
+   */
   compose(): Parameters<typeof mount>[1]
   /** To be overridden by sub-classes. */
   getPath(type: string, path: string): string
@@ -1439,8 +1454,14 @@ export type QueryParameterOptionKey = keyof QueryParameterOptions
 export class Service {
   constructor(app: Application<Models>, name?: string)
   setup(config: any): void
-  initialize(): void
+  /**
+   * To be overridden in sub-classes, if the service needs to initialize.
+   * @overridable
+   */
+  initialize(): Promise<void>
+  /* @overridable */
   start(): Promise<void>
+  /* @overridable */
   stop(): Promise<void>
   get logger(): Logger
   getLogger(ctx: KoaContext): Logger