@ditojs/server 2.47.0 → 2.48.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/server",
-  "version": "2.47.0",
+  "version": "2.48.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,15 +25,15 @@
     "node >= 18"
   ],
   "dependencies": {
-    "@ditojs/admin": "^2.47.0",
-    "@ditojs/build": "^2.47.0",
-    "@ditojs/router": "^2.47.0",
-    "@ditojs/utils": "^2.47.0",
+    "@ditojs/admin": "^2.48.0",
+    "@ditojs/build": "^2.48.0",
+    "@ditojs/router": "^2.48.0",
+    "@ditojs/utils": "^2.48.0",
     "@koa/cors": "^5.0.0",
     "@koa/multer": "^3.1.0",
     "@originjs/vite-plugin-commonjs": "^1.0.3",
     "ajv": "^8.17.1",
-    "ajv-formats": "^2.1.1",
+    "ajv-formats": "^3.0.1",
     "bcryptjs": "^3.0.2",
     "bytes": "^3.1.2",
     "data-uri-to-buffer": "^6.0.2",
@@ -90,5 +90,5 @@
     "typescript": "^5.8.3"
   },
   "types": "types",
-  "gitHead": "9ce26a1dc412e67304e823c0206593ee4a9c8ae4"
+  "gitHead": "bacff1f9a6b314fad4f01b4a83d5cf4778d344e1"
 }

package/src/app/Application.js

@@ -31,8 +31,7 @@ import {
   parseDataPath,
   normalizeDataPath,
   toPromiseCallback,
-  mapConcurrently,
-  deprecate
+  mapConcurrently
 } from '@ditojs/utils'
 import { Validator } from './Validator.js'
 import { EventEmitter } from '../lib/index.js'
@@ -879,11 +878,6 @@ export class Application extends Koa {
     }
   }
 
-  startOrExit() {
-    deprecate(`app.startOrExit() is deprecated. Use app.execute() instead.`)
-    return this.execute()
-  }
-
   // Assets handling
 
   async createAssets(storage, files, count = 0, transaction = null) {

package/src/cli/console.js

@@ -59,7 +59,7 @@ export default async function startConsole(app, config) {
       .slice(0, config.historySize)
       .filter(line => line.trim())
       .map(line => server.history.push(line))
-  } catch (e) {
+  } catch {
     console.info(deindent`
       Unable to REPL history file at ${historyFile}.
       A history file will be created on shutdown

package/src/controllers/CollectionController.js

@@ -182,19 +182,7 @@ export class CollectionController extends Controller {
     )
   }
 
-  convertToCoreActions(actions) {
-    // Mark action object and methods as core, so `Controller.processValues()`
-    // can filter correctly.
-    for (const action of Object.values(actions)) {
-      // Mark action functions also, so ControllerAction can use it to determine
-      // value for `transacted`.
-      action.core = true
-    }
-    actions.$core = true
-    return actions
-  }
-
-  collection = this.convertToCoreActions({
+  collection = this.markAsCoreActions({
     async get(ctx, modify) {
       const result = await this.execute(ctx, (query, trx) => {
         query
@@ -245,7 +233,7 @@ export class CollectionController extends Controller {
     }
   })
 
-  member = this.convertToCoreActions({
+  member = this.markAsCoreActions({
     async get(ctx, modify) {
       return this.execute(ctx, (query, trx) =>
         query

package/src/controllers/Controller.js

@@ -32,8 +32,8 @@ export class Controller {
   name = null
   path = null
   url = null
-  actions = null
   assets = null
+  actions = null
   transacted = null
   initialized = false
 
@@ -80,7 +80,6 @@ export class Controller {
   // @overridable
   setup() {
     this.logController()
-    this.setProperty('actions', this.actions || this.reflectActionsObject())
     // Now that the instance fields are reflected in the `controller` object
     // we can use the normal inheritance mechanism through `setupActions()`:
     this.setProperty('actions', this.setupActions('actions'))
@@ -142,30 +141,15 @@ export class Controller {
     return value
   }
 
-  reflectActionsObject() {
-    // On base controllers, the actions can be defined directly in the class
-    // instead of inside an actions object, as is done with model and relation
-    // controllers. But in order to use the same structure for inheritance as
-    // these other controllers, we reflect these instance fields in a separate
-    // `actions` object.
-    const { allow } = this
-    const actions = allow ? { allow } : {}
-
-    const addAction = key => {
-      const value = this[key]
-      // NOTE: Only add instance methods that have a @action() decorator, which
-      // in turn sets the `method` property on the method, as well as action
-      // objects which provide the `method` property:
-      if (value?.method) {
-        actions[key] = value
-      }
+  markAsCoreActions(actions) {
+    // Mark action object and methods as core, so `Controller.processValues()`
+    // can filter correctly.
+    for (const action of Object.values(actions)) {
+      // Mark action functions also, so ControllerAction can use it to determine
+      // value for `transacted`.
+      action.core = true
     }
-    // Use `Object.getOwnPropertyNames()` to get the fields, in order to
-    // not also receive values from parents (those are fetched later in
-    // `inheritValues()`, see `getParentValues()`).
-    const proto = Object.getPrototypeOf(this)
-    Object.getOwnPropertyNames(proto).forEach(addAction)
-    Object.getOwnPropertyNames(this).forEach(addAction)
+    actions.$core = true
     return actions
   }
 
@@ -190,26 +174,28 @@ export class Controller {
       values: actions,
       authorize
     } = this.processValues(this.inheritValues(type))
-    for (const [name, action] of Object.entries(actions)) {
-      // Replace the action object with the converted action handler, so they
-      // too can benefit from prototypal inheritance:
-      actions[name] = this.setupAction(
-        type,
-        actions,
-        name,
-        action,
-        authorize[name]
-      )
+    if (actions) {
+      for (const [name, action] of Object.entries(actions)) {
+        // Replace the action object with the converted action handler, so they
+        // too can benefit from prototypal inheritance:
+        actions[name] = this.setupAction(
+          type,
+          actions,
+          name,
+          action,
+          authorize[name]
+        )
+      }
+      // Expose a direct reference to the controller on the action object, but
+      // also make it inherit from the controller so that all its public fields
+      // and functions (`app`, `query()`, `execute()`, etc.) can be accessed
+      // directly through `this` from actions.
+      // NOTE: Inheritance is also set up by `inheritValues()` so that from the
+      // handlers, `super` points to the parent controller's actions object, so
+      // that calling `super.patch()` from a patch handler magically works.
+      actions.controller = this
+      Object.setPrototypeOf(actions, this)
     }
-    // Expose a direct reference to the controller on the action object, but
-    // also make it inherit from the controller so that all its public fields
-    // and functions (`app`, `query()`, `execute()`, etc.) can be accessed
-    // directly through `this` from actions.
-    // NOTE: Inheritance is also set up by `inheritValues()` so that from inside
-    // the handlers, `super` points to the parent controller's actions object,
-    // so that calling `super.patch()` from a patch handler magically works.
-    actions.controller = this
-    Object.setPrototypeOf(actions, this)
     return actions
   }
 

package/src/controllers/ControllerAction.js

@@ -7,18 +7,12 @@ export default class ControllerAction {
     handler,
     type,
     name,
-    _method,
-    _path,
+    method,
+    path,
     _authorize
   ) {
     const {
       core = false,
-      // Allow decorators on actions to override the predetermined defaults for
-      // `method`, `path` and `authorize`:
-      // TODO: `handler.method` and `handler.path` were deprecated in March
-      // 2022, remove later and only set the valued passed to constructor then.
-      method = _method,
-      path = _path,
       scope,
       authorize,
       transacted,
@@ -28,6 +22,7 @@ export default class ControllerAction {
       ...additional
     } = handler
 
+    this.app = controller.app
     this.controller = controller
     this.actions = actions
     this.handler = handler
@@ -37,6 +32,8 @@ export default class ControllerAction {
     this.method = method
     this.path = path
     this.scope = scope
+    // Allow action handlers to override the predetermined defaults for
+    // `authorize`:
     this.authorize = authorize || _authorize
     this.transacted = !!(
       transacted ??
@@ -52,7 +49,6 @@ export default class ControllerAction {
       )
     )
     this.authorization = controller.processAuthorize(this.authorize)
-    this.app = controller.app
     this.paramsName = ['post', 'put', 'patch'].includes(this.method)
       ? 'body'
       : 'query'

package/src/controllers/RelationController.js

@@ -87,7 +87,7 @@ export class RelationController extends CollectionController {
     })
   }
 
-  collection = this.convertToCoreActions({})
+  collection = this.markAsCoreActions({})
 
-  member = this.convertToCoreActions({})
+  member = this.markAsCoreActions({})
 }

package/src/index.js

@@ -6,5 +6,4 @@ export * from './mixins/index.js'
 export * from './models/index.js'
 export * from './controllers/index.js'
 export * from './services/index.js'
-export * from './decorators/index.js'
 export * from './storage/index.js'

package/src/middleware/handleSession.js

@@ -11,7 +11,6 @@ export function handleSession(app, {
     // 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 = createSessionStore(modelClass)
   }
   options.autoCommit = false

package/src/query/QueryBuilder.js

@@ -1065,19 +1065,5 @@ const mixinMethods = [
   'havingBetween',
   'havingNotBetween',
   'havingRaw',
-  'havingWrapped',
-
-  // deprecated methods that are still supported at the moment.
-  // TODO: Remove once we move to Objection 3.0
-  'eager',
-  'joinEager',
-  'naiveEager',
-  'mergeEager',
-  'mergeJoinEager',
-  'mergeNaiveEager',
-  'clearEager',
-
-  'scope',
-  'mergeScope',
-  'clearScope'
+  'havingWrapped'
 ]

package/src/services/Service.js

@@ -28,11 +28,6 @@ export class Service {
   // @overridable
   async stop() {}
 
-  /** @deprecated Use `instance.logger` instead. */
-  getLogger() {
-    return this.logger
-  }
-
   get logger() {
     const logger = this.app.requestLocals.logger ?? this.app.logger
     return logger.child({ name: this.#loggerName })

package/src/storage/S3Storage.js

@@ -164,6 +164,6 @@ function getFileTypeFromBuffer(buffer) {
   try {
     // Use leather as fall-back for better media file mime type detection.
     return fileTypeFromBuffer(buffer)?.mime || readMediaAttributes(buffer)?.mime
-  } catch (err) {}
+  } catch {}
   return null
 }

package/src/storage/Storage.js

@@ -4,7 +4,7 @@ import multer from '@koa/multer'
 import picomatch from 'picomatch'
 import { PassThrough } from 'stream'
 import { readMediaAttributes } from 'leather'
-import { hyphenate, toPromiseCallback, deprecate } from '@ditojs/utils'
+import { hyphenate, toPromiseCallback } from '@ditojs/utils'
 import { AssetFile } from './AssetFile.js'
 
 const storageClasses = {}
@@ -158,18 +158,8 @@ export class Storage {
   async _listKeys() {}
 
   async _handleUpload(req, file, config) {
-    if (config.readImageSize) {
-      deprecate(
-        `config.readImageSize is deprecated in favour of config.readDimensions`
-      )
-    }
     if (
-      (
-        config.readDimensions ||
-        // TODO: `config.readImageSize` was deprecated in favour of
-        // `config.readDimensions` in March 2023. Remove in 1 year.
-        config.readImageSize
-      ) &&
+      config.readDimensions &&
       /^(image|video)\//.test(file.mimetype)
     ) {
       return this._handleMediaFile(req, file)

package/src/utils/duration.js

@@ -1,5 +1,4 @@
 import { isNumber } from '@ditojs/utils'
-// eslint-disable-next-line import/default
 import parseDuration from 'parse-duration'
 
 export function getDuration(duration) {

package/types/index.d.ts

@@ -1442,8 +1442,6 @@ export class Service {
   /** @overridable */
   stop(): Promise<void>
   get logger(): PinoLogger
-  /** @deprecated Use `instance.logger` instead. */
-  getLogger(ctx: KoaContext): PinoLogger
 }
 export type Services = Record<string, Class<Service> | Service>
 

package/src/decorators/action.js

@@ -1,8 +0,0 @@
-import { createDecorator } from '../utils/decorator.js'
-
-export function action(method, path) {
-  return createDecorator(value => {
-    value.method = method
-    value.path = path
-  })
-}

package/src/decorators/authorize.js

@@ -1,7 +0,0 @@
-import { createDecorator } from '../utils/decorator.js'
-
-export function authorize(authorize) {
-  return createDecorator(value => {
-    value.authorize = authorize
-  })
-}

package/src/decorators/index.js

@@ -1,6 +0,0 @@
-export * from './action.js'
-export * from './authorize.js'
-export * from './parameters.js'
-export * from './returns.js'
-export * from './scope.js'
-export * from './transacted.js'

package/src/decorators/parameters.js

@@ -1,20 +0,0 @@
-import { isArray, isObject } from '@ditojs/utils'
-import { createDecorator } from '../utils/decorator.js'
-
-export function parameters(parameters, options) {
-  if (!isArray(parameters) && !isObject(parameters)) {
-    throw new Error(
-      `@parameters() need to be defined using array or object definitions`
-    )
-  }
-
-  return createDecorator(value => {
-    value.parameters = parameters
-    // If validation options are provided, expose them through
-    // `handler.options.parameters`, see ControllerAction
-    if (options) {
-      value.options ||= {}
-      value.options.parameters = options
-    }
-  })
-}

package/src/decorators/returns.js

@@ -1,23 +0,0 @@
-import { isObject } from '@ditojs/utils'
-import { createDecorator } from '../utils/decorator.js'
-import { formatJson } from '../utils/json.js'
-
-export function returns(returns, options) {
-  if (!isObject(returns)) {
-    throw new Error(
-      `@returns(${
-        formatJson(returns, false)
-      }) needs to be defined using an object parameter definition`
-    )
-  }
-
-  return createDecorator(value => {
-    value.returns = returns
-    // If validation options are provided, expose them through
-    // `handler.options.returns`, see ControllerAction
-    if (options) {
-      value.options ||= {}
-      value.options.returns = options
-    }
-  })
-}

package/src/decorators/scope.js

@@ -1,8 +0,0 @@
-import { createDecorator } from '../utils/decorator.js'
-
-export function scope(...scopes) {
-  return createDecorator(value => {
-    const scope = (value.scope ||= [])
-    scope.push(...scopes)
-  })
-}

package/src/decorators/transacted.js

@@ -1,5 +0,0 @@
-import { createDecorator } from '../utils/decorator.js'
-
-export const transacted = createDecorator(value => {
-  value.transacted = true
-})