@ditojs/server 2.0.5 → 2.1.0

package/src/controllers/CollectionController.js

@@ -55,7 +55,9 @@ export class CollectionController extends Controller {
   // @override
   getPath(type, path) {
     return type === 'member'
-      ? path ? `:${this.idParam}/${path}` : `:${this.idParam}`
+      ? path
+        ? `:${this.idParam}/${path}`
+        : `:${this.idParam}`
       : path
   }
 
@@ -91,9 +93,11 @@ export class CollectionController extends Controller {
     // Returns the model ids that this request concerns, read from the param
     // for member ids, and from the payload for collection ids:
     const { type } = ctx.action
-    return type === 'member' ? [this.getMemberId(ctx)]
-      : type === 'collection' ? this.getCollectionIds(ctx)
-      : []
+    return type === 'member'
+      ? [this.getMemberId(ctx)]
+      : type === 'collection'
+        ? this.getCollectionIds(ctx)
+        : []
   }
 
   validateId(id) {
@@ -142,7 +146,7 @@ export class CollectionController extends Controller {
     const { scope } = base
     const { allowScope, allowFilter } = this
 
-    const asAllowArray = value => value === false ? [] : asArray(value)
+    const asAllowArray = value => (value === false ? [] : asArray(value))
 
     if (allowScope !== undefined && allowScope !== true) {
       query.allowScope(
@@ -168,8 +172,7 @@ export class CollectionController extends Controller {
   async executeAndFetch(action, ctx, modify, body = ctx.request.body) {
     const name = `${action}${this.graph ? 'DitoGraph' : ''}AndFetch`
     return this.execute(ctx, (query, trx) =>
-      query[name](body)
-        .modify(getModify(modify, trx))
+      query[name](body).modify(getModify(modify, trx))
     )
   }
 
@@ -207,23 +210,25 @@ export class CollectionController extends Controller {
     },
 
     async delete(ctx, modify) {
-      const count = await this.execute(ctx, (query, trx) => query
-        .ignoreScope()
-        .find(ctx.query, this.allowParam)
-        .modify(query => this.isOneToOne && query.throwIfNotFound())
-        .modify(getModify(modify, trx))
-        .modify(query => this.unrelate ? query.unrelate() : query.delete())
+      const count = await this.execute(ctx, (query, trx) =>
+        query
+          .ignoreScope()
+          .find(ctx.query, this.allowParam)
+          .modify(query => this.isOneToOne && query.throwIfNotFound())
+          .modify(getModify(modify, trx))
+          .modify(query => (this.unrelate ? query.unrelate() : query.delete()))
       )
       return { count }
     },
 
     async post(ctx, modify) {
       const result = this.relate
-        // Use patchDitoGraphAndFetch() to handle relates for us.
-        ? await this.execute(ctx, (query, trx) => query
-          .patchDitoGraphAndFetch(ctx.request.body, { relate: true })
-          .modify(getModify(modify, trx))
-        )
+        ? // Use patchDitoGraphAndFetch() to handle relates for us.
+          await this.execute(ctx, (query, trx) =>
+            query
+              .patchDitoGraphAndFetch(ctx.request.body, { relate: true })
+              .modify(getModify(modify, trx))
+          )
         : await this.executeAndFetch('insert', ctx, modify)
       ctx.status = 201 // Created
       if (isObject(result)) {
@@ -243,22 +248,24 @@ export class CollectionController extends Controller {
 
   member = this.convertToCoreActions({
     async get(ctx, modify) {
-      return this.execute(ctx, (query, trx) => query
-        .findById(ctx.memberId)
-        .find(ctx.query, this.allowParam)
-        .throwIfNotFound()
-        .modify(getModify(modify, trx))
+      return this.execute(ctx, (query, trx) =>
+        query
+          .findById(ctx.memberId)
+          .find(ctx.query, this.allowParam)
+          .throwIfNotFound()
+          .modify(getModify(modify, trx))
       )
     },
 
     async delete(ctx, modify) {
-      const count = await this.execute(ctx, (query, trx) => query
-        .ignoreScope()
-        .findById(ctx.memberId)
-        .find(ctx.query, this.allowParam)
-        .throwIfNotFound()
-        .modify(getModify(modify, trx))
-        .modify(query => this.unrelate ? query.unrelate() : query.delete())
+      const count = await this.execute(ctx, (query, trx) =>
+        query
+          .ignoreScope()
+          .findById(ctx.memberId)
+          .find(ctx.query, this.allowParam)
+          .throwIfNotFound()
+          .modify(getModify(modify, trx))
+          .modify(query => (this.unrelate ? query.unrelate() : query.delete()))
       )
       return { count }
     },

package/src/controllers/Controller.js

@@ -3,18 +3,30 @@ import { EventEmitter } from '../lib/index.js'
 import ControllerAction from './ControllerAction.js'
 import MemberAction from './MemberAction.js'
 import {
-  ResponseError, ControllerError, AuthorizationError
+  ResponseError,
+  ControllerError,
+  AuthorizationError
 } from '../errors/index.js'
 import {
-  getOwnProperty, getOwnKeys, getAllKeys, getInheritanceChain
+  getOwnProperty,
+  getOwnKeys,
+  getAllKeys,
+  getInheritanceChain
 } from '../utils/object.js'
 import { processHandlerParameters } from '../utils/handler.js'
 import { describeFunction } from '../utils/function.js'
 import { formatJson } from '../utils/json.js'
 import { deprecate } from '../utils/deprecate.js'
 import {
-  isObject, isString, isArray, isBoolean, isFunction, asArray, equals,
-  parseDataPath, normalizeDataPath
+  isObject,
+  isString,
+  isArray,
+  isBoolean,
+  isFunction,
+  asArray,
+  equals,
+  parseDataPath,
+  normalizeDataPath
 } from '@ditojs/utils'
 
 export class Controller {
@@ -42,10 +54,14 @@ export class Controller {
     // 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 keys = Object.keys(Object.assign({}, hooks, ...chain))
     const events = Object.fromEntries(
-      Object.keys(hooks || {}).map(
-        event => [event, chain.map(hooks => hooks[event]).filter(Boolean)]
-      )
+      keys.map(event => [
+        event,
+        chain
+          .map(hooks => (hooks.hasOwnProperty(event) ? hooks[event] : null))
+          .filter(Boolean)
+      ])
     )
     this._configureEmitter(events, {
       // Support wildcard hooks only on controllers:
@@ -174,7 +190,11 @@ export class Controller {
       // 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]
+        type,
+        actions,
+        name,
+        action,
+        authorize[name]
       )
     }
     // Expose a direct reference to the controller on the action object, but
@@ -190,9 +210,11 @@ export class Controller {
   }
 
   setupAction(type, actions, name, action, authorize) {
-    const handler = isFunction(action) ? action
-      : isObject(action) ? convertActionObject(name, action, actions)
-      : null
+    const handler = isFunction(action)
+      ? action
+      : isObject(action)
+        ? convertActionObject(name, action, actions)
+        : null
     // Action naming convention: `'<method> <path>'`, or just `'<method>'` for
     // the default methods.
     let [method, path = ''] = name.split(' ')
@@ -206,7 +228,14 @@ export class Controller {
       type,
       // eslint-disable-next-line new-cap
       new actionClass(
-        this, actions, handler, type, name, method, path, authorize
+        this,
+        actions,
+        handler,
+        type,
+        name,
+        method,
+        path,
+        authorize
       )
     )
     return handler
@@ -249,7 +278,8 @@ export class Controller {
     } = config
     const storage = this.app.getStorage(storageName)
     if (!storage) {
-      throw new ControllerError(this,
+      throw new ControllerError(
+        this,
         `Unknown storage configuration: '${storageName}'`
       )
     }
@@ -258,9 +288,10 @@ export class Controller {
 
     const normalizedPath = getDataPath(
       // Router supports both shallow & deep wildcards, no normalization needed.
-      token => token === '*' || token === '**'
-        ? token
-        : this.app.normalizePath(token)
+      token =>
+        token === '*' || token === '**'
+          ? token
+          : this.app.normalizePath(token)
     )
 
     // Convert `dataPath` to a regular expression to match field names
@@ -270,11 +301,12 @@ export class Controller {
       `^${
         getDataPath(
           // Use the exact same regexps as in `Router`:
-          token => token === '*'
-            ? '[^/]+' // shallow wildcard
-            : token === '**'
-              ? '.+?' // deep wildcard
-              : token
+          token =>
+            token === '*'
+              ? '[^/]+' // shallow wildcard
+              : token === '**'
+                ? '.+?' // deep wildcard
+                : token
         )
       }$`
     )
@@ -525,17 +557,17 @@ export class Controller {
           member = await this.getMember(ctx)
         }
         return !!values.find(
-        // Support 3 scenarios:
-        // - '$self': The requested member is checked against `ctx.state.user`
-        //   and the action is only authorized if it matches the member.
-        // - '$owner': The member is asked if it is owned by `ctx.state.user`
-        //   through the optional `Model.$hasOwner()` method.
-        // - any string:  `ctx.state.user` is checked for this role through
-        //   the overridable `UserModel.hasRole()` method.
+          // Support 3 scenarios:
+          // - '$self': The requested member is checked against `ctx.state.user`
+          //   and the action is only authorized if it matches the member.
+          // - '$owner': The member is asked if it is owned by `ctx.state.user`
+          //   through the optional `Model.$hasOwner()` method.
+          // - any string:  `ctx.state.user` is checked for this role through
+          //   the overridable `UserModel.hasRole()` method.
           value => {
             return value === '$self'
               ? user.constructor === this.modelClass &&
-              equals(user.$id(), ctx.memberId)
+                equals(user.$id(), ctx.memberId)
               : value === '$owner'
                 ? member?.$hasOwner?.(user)
                 : user.$hasRole(value)
@@ -543,7 +575,8 @@ export class Controller {
         )
       }
     } else {
-      throw new ControllerError(this,
+      throw new ControllerError(
+        this,
         `Unsupported authorize setting: '${authorize}'`
       )
     }
@@ -588,14 +621,18 @@ function convertActionObject(name, object, actions) {
   Object.setPrototypeOf(object, Object.getPrototypeOf(actions))
 
   if (action) {
-    deprecate(`action.action is deprecated. Use action.method and action.path instead.`)
+    deprecate(
+      `action.action is deprecated. Use action.method and action.path instead.`
+    )
     const [method, path] = asArray(action)
     handler.method = method
     handler.path = path
   }
 
   if (!handler) {
-    throw new Error(`Missing handler in '${name}' action: ${formatJson(object)}`)
+    throw new Error(
+      `Missing handler in '${name}' action: ${formatJson(object)}`
+    )
   }
 
   handler.authorize = authorize ?? null
@@ -609,15 +646,18 @@ function convertActionObject(name, object, actions) {
 }
 
 function isMethodAction(name) {
-  return {
-    get: true,
-    delete: true,
-    post: true,
-    put: true,
-    patch: true,
-    head: true,
-    options: true,
-    trace: true,
-    connect: true
-  }[name] || false
+  return (
+    {
+      get: true,
+      delete: true,
+      post: true,
+      put: true,
+      patch: true,
+      head: true,
+      options: true,
+      trace: true,
+      connect: true
+    }[name] ||
+    false
+  )
 }

package/src/controllers/ControllerAction.js

@@ -2,7 +2,14 @@ import { isString, isObject, asArray, clone } from '@ditojs/utils'
 
 export default class ControllerAction {
   constructor(
-    controller, actions, handler, type, name, _method, _path, _authorize
+    controller,
+    actions,
+    handler,
+    type,
+    name,
+    _method,
+    _path,
+    _authorize
   ) {
     const {
       core = false,
@@ -33,10 +40,12 @@ export default class ControllerAction {
     this.authorize = authorize || _authorize
     this.transacted = !!(
       transacted ||
-      controller.transacted || (
-        // Core graph and assets operations are always transacted, unless the
-        // method is 'get':
-        core && method !== 'get' && (
+      controller.transacted ||
+      // Core graph and assets operations are always transacted, unless the
+      // method is 'get':
+      (
+        core &&
+        method !== 'get' && (
           controller.graph ||
           controller.assets
         )
@@ -176,7 +185,7 @@ export default class ControllerAction {
       }
     }
 
-    const getData = () => unwrapRoot ? params[dataName] : params
+    const getData = () => (unwrapRoot ? params[dataName] : params)
     try {
       await this.parameters.validate(params)
       return getData()
@@ -208,7 +217,7 @@ export default class ControllerAction {
 
       // If a named result is defined, return the data wrapped,
       // otherwise return the original unwrapped result object.
-      const getResult = () => returnsName ? data : result
+      const getResult = () => (returnsName ? data : result)
       try {
         await this.returns.validate(data)
         return getResult()
@@ -279,14 +288,17 @@ export default class ControllerAction {
             } else {
               // A simple version of named key/value pairs, values can be
               // strings or numbers.
-              value = Object.fromEntries(value.split(/\s*,\s*/g).map(entry => {
-                let [key, val] = entry.split(/\s*:\s*/)
-                try {
-                  // Try parsing basic types, but fall back to unquoted string.
-                  val = JSON.parse(val)
-                } catch {}
-                return [key, val]
-              }))
+              value = Object.fromEntries(
+                value.split(/\s*,\s*/g).map(entry => {
+                  let [key, val] = entry.split(/\s*:\s*/)
+                  try {
+                    // Try parsing basic types, but fall back to unquoted
+                    // string.
+                    val = JSON.parse(val)
+                  } catch {}
+                  return [key, val]
+                })
+              )
             }
           } else {
             value = JSON.parse(value)

package/src/controllers/ModelController.js

@@ -41,7 +41,10 @@ export class ModelController extends CollectionController {
       throw new ControllerError(this, `Relation '${name}' not found.`)
     }
     const relation = new RelationController(
-      this, object, relationInstance, relationDefinition
+      this,
+      object,
+      relationInstance,
+      relationDefinition
     )
     // RelationController instances are not registered with the app, but are
     // managed by their parent controller instead.

package/src/controllers/RelationController.js

@@ -9,8 +9,10 @@ export class RelationController extends CollectionController {
   constructor(parent, object, relationInstance, relationDefinition) {
     super(parent.app, null)
     if (parent.modelClass !== relationInstance.ownerModelClass) {
-      throw new ControllerError(parent,
-        `Invalid parent controller for relation '${relationInstance.name}'.`)
+      throw new ControllerError(
+        parent,
+        `Invalid parent controller for relation '${relationInstance.name}'.`
+      )
     }
     this.parent = parent
     this.object = object
@@ -81,26 +83,22 @@ export class RelationController extends CollectionController {
   // @override
   async execute(ctx, execute) {
     const id = this.parent.getMemberId(ctx)
-    return this.parent.execute(ctx,
-      async (parentQuery, trx) => {
-        const model = await parentQuery
-          .ignoreScope()
-          .findById(id)
-          .throwIfNotFound()
-          // Explicitly only select the foreign key ids for more efficiency.
-          .select(...this.relationInstance.ownerProp.props)
-        // This is the same as `ModelController.execute()`, except for the use
-        // of `model.$relatedQuery()` instead of `modelClass.query()`:
-        const query = model.$relatedQuery(this.relationInstance.name, trx)
-        this.setupQuery(query)
-        return execute(query, trx)
-      }
-    )
+    return this.parent.execute(ctx, async (parentQuery, trx) => {
+      const model = await parentQuery
+        .ignoreScope()
+        .findById(id)
+        .throwIfNotFound()
+        // Explicitly only select the foreign key ids for more efficiency.
+        .select(...this.relationInstance.ownerProp.props)
+      // This is the same as `ModelController.execute()`, except for the use
+      // of `model.$relatedQuery()` instead of `modelClass.query()`:
+      const query = model.$relatedQuery(this.relationInstance.name, trx)
+      this.setupQuery(query)
+      return execute(query, trx)
+    })
   }
 
-  collection = this.toCoreActions({
-  })
+  collection = this.toCoreActions({})
 
-  member = this.toCoreActions({
-  })
+  member = this.toCoreActions({})
 }

package/src/controllers/UsersController.js

@@ -40,16 +40,15 @@ export class UsersController extends ModelController {
       return {
         authenticated,
         user: authenticated ? ctx.state.user : null
-
       }
     },
 
     'get self'(ctx) {
       return this.isAuthenticated(ctx)
         ? this.member.get.call(
-          this,
-          this.getContextWithMemberId(ctx, ctx.state.user.$id())
-        )
+            this,
+            this.getContextWithMemberId(ctx, ctx.state.user.$id())
+          )
         : null
     }
   }

package/src/decorators/parameters.js

@@ -16,7 +16,9 @@ export function parameters(parameters, options) {
     }
   }
   if (!isArray(parameters) && !isObject(parameters)) {
-    throw new Error(`@parameters() need to be defined using array or object definitions`)
+    throw new Error(
+      `@parameters() need to be defined using array or object definitions`
+    )
   }
 
   return createDecorator(value => {

package/src/decorators/scope.js

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

package/src/errors/ControllerError.js

@@ -3,7 +3,8 @@ import { ResponseError } from './ResponseError.js'
 
 export class ControllerError extends ResponseError {
   constructor(controller, error) {
-    const { name } = isFunction(controller) ? controller
+    const { name } = isFunction(controller)
+      ? controller
       : controller.constructor
     super(`Controller ${name}: ${error}`, {
       message: `Controller ${name}: Controller error`,

package/src/errors/DatabaseError.js

@@ -18,19 +18,28 @@ const {
 
 export class DatabaseError extends ResponseError {
   constructor(error, overrides) {
-    super(error, {
-      type: error.constructor.name,
-      message: 'Database error',
-      status: getStatus(error)
-    }, overrides)
+    super(
+      error,
+      {
+        type: error.constructor.name,
+        message: 'Database error',
+        status: getStatus(error)
+      },
+      overrides
+    )
   }
 }
 
 function getStatus(error) {
-  return error instanceof CheckViolationError ? 400
-    : error instanceof NotNullViolationError ? 400
-    : error instanceof ConstraintViolationError ? 409
-    : error instanceof DataError ? 400
-    : error instanceof DBError ? 500
-    : 400
+  return error instanceof CheckViolationError
+    ? 400
+    : error instanceof NotNullViolationError
+      ? 400
+      : error instanceof ConstraintViolationError
+        ? 409
+        : error instanceof DataError
+          ? 400
+          : error instanceof DBError
+            ? 500
+            : 400
 }