@ditojs/server 0.275.0 → 1.0.0

package/src/errors/index.js

@@ -1,14 +1,14 @@
-export * from './AssetError'
-export * from './ResponseError'
-export * from './AuthenticationError'
-export * from './AuthorizationError'
-export * from './ControllerError'
-export * from './DatabaseError'
-export * from './GraphError'
-export * from './ModelError'
-export * from './NotFoundError'
-export * from './NotImplementedError'
-export * from './QueryBuilderError'
-export * from './RelationError'
-export * from './ValidationError'
-export * from './WrappedError'
+export * from './AssetError.js'
+export * from './ResponseError.js'
+export * from './AuthenticationError.js'
+export * from './AuthorizationError.js'
+export * from './ControllerError.js'
+export * from './DatabaseError.js'
+export * from './GraphError.js'
+export * from './ModelError.js'
+export * from './NotFoundError.js'
+export * from './NotImplementedError.js'
+export * from './QueryBuilderError.js'
+export * from './RelationError.js'
+export * from './ValidationError.js'
+export * from './WrappedError.js'

package/src/graph/DitoGraphProcessor.js

@@ -1,5 +1,6 @@
 import { isArray } from '@ditojs/utils'
-import { modelGraphToExpression, ensureModelArray } from '.'
+import { ensureModelArray } from './graph.js'
+import { modelGraphToExpression } from './expression.js'
 
 export class DitoGraphProcessor {
   constructor(rootModelClass, data, options = {}, settings = {}) {

package/src/graph/graph.js

@@ -1,5 +1,5 @@
 import { isObject, isArray, asArray } from '@ditojs/utils'
-import { QueryBuilder } from '@/query'
+import { QueryBuilder } from '../query/index.js'
 import { collectExpressionPaths, expressionPathToString } from './expression.js'
 
 // Similar to Objection's private `modelClass.ensureModel(model)`:

package/src/graph/index.js

@@ -1,3 +1,3 @@
-export * from './DitoGraphProcessor'
-export * from './graph'
-export * from './expression'
+export * from './DitoGraphProcessor.js'
+export * from './graph.js'
+export * from './expression.js'

package/src/index.js

@@ -1,9 +1,11 @@
-export * from './app'
-export * from './query'
-export * from './errors'
-export * from './mixins'
-export * from './models'
-export * from './controllers'
-export * from './services'
-export * from './decorators'
-export * from './storage'
+export * from './app/index.js'
+export * from './query/index.js'
+export * from './schema/index.js'
+export * from './errors/index.js'
+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'
+export * from './utils/index.js'

package/src/lib/index.js

@@ -1,2 +1,2 @@
-export * from './EventEmitter'
-export * from './KnexHelper'
+export * from './EventEmitter.js'
+export * from './KnexHelper.js'

package/src/middleware/createTransaction.js

@@ -1,5 +1,5 @@
 import { transaction } from 'objection'
-import { emitAsync } from '@/utils'
+import { emitAsync } from '../utils/index.js'
 
 export function createTransaction() {
   return async (ctx, next) => {

package/src/middleware/findRoute.js

@@ -1,8 +1,9 @@
 export function findRoute(router) {
   return (ctx, next) => {
     const result = router.find(ctx.method, ctx.path)
-    // We use `result.handler` to store the route object for matched routes.
-    // If none is found, set `ctx.route = result`, for  `{ status, allowed }`.
+    // We use `result.handler` as returned from the router to store the route
+    // object for matched routes. If none is found, set `ctx.route = result`,
+    // for `{ status, allowed }`.
     const route = result.handler ? { ...result.handler } : result
     ctx.route = route
     // NOTE: The name for `ctx.params` was inherited from `koa-router`

package/src/middleware/handleConnectMiddleware.js

@@ -0,0 +1,88 @@
+import { PassThrough } from 'stream'
+import { isString, isArray, isObject } from '@ditojs/utils'
+
+export function handleConnectMiddleware(middleware, {
+  expandMountPath = false
+}) {
+  return (ctx, next) => {
+    return new Promise(resolve => {
+      let body = null
+
+      const res = {
+        locals: ctx.state,
+
+        get statusCode() {
+          return ctx.status
+        },
+
+        set statusCode(status) {
+          ctx.status = status
+        },
+
+        getHeader(field) {
+          // console.log('getHeader', ...arguments)
+          return ctx.get(field)
+        },
+
+        setHeader(field, value) {
+          // console.log('setHeader', ...arguments)
+          ctx.set(field, value)
+        },
+
+        writeHead(status, message, headers) {
+          // console.log('writeHead', ...arguments)
+          ctx.status = status
+          if (isString(message)) {
+            ctx.body = message
+          } else {
+            headers = message
+          }
+          if (isArray(headers)) {
+            // Convert raw headers array to object.
+            headers = Object.fromEntries(headers.reduce(
+              // Translate raw array to [field, value] tuplets.
+              (entries, value, index) => {
+                if (index & 1) { // Odd: value
+                  entries[entries.length - 1].push(value)
+                } else { // Even: field
+                  entries.push([value])
+                }
+                return entries
+              }, []))
+          }
+          if (isObject(headers)) {
+            ctx.set(headers)
+          }
+        },
+
+        write(...args) {
+          // console.log('write', ...arguments)
+          if (!body) {
+            body = new PassThrough()
+            ctx.body = body
+          }
+          body.write(...args)
+        },
+
+        end(body) {
+          // console.log('end', body?.substring?.(0, 256))
+          if (body !== undefined) {
+            ctx.body = body
+          }
+          resolve()
+        }
+      }
+
+      if (expandMountPath && ctx.mountPath) {
+        // Create an inheriting `ctx` object with the expanded `ctx.path`,
+        // without actually modifying the original `ctx` object.
+        ctx = Object.create(ctx, {
+          path: {
+            value: ctx.mountPath + ctx.path
+          }
+        })
+      }
+      middleware(ctx.req, res, next)
+    })
+  }
+}

package/src/middleware/handleError.js

@@ -1,4 +1,4 @@
-import { ResponseError } from '@/errors'
+import { ResponseError } from '../errors/index.js'
 
 export function handleError() {
   return async (ctx, next) => {

package/src/middleware/handleRoute.js

@@ -1,8 +1,8 @@
 export function handleRoute() {
   return async (ctx, next) => {
-    const { handler } = ctx.route
-    if (handler) {
-      await handler(ctx, next)
+    const { middleware } = ctx.route
+    if (middleware) {
+      await middleware(ctx, next)
     } else {
       // No route was found. See if the remaining middleware does something with
       // this request. If not, return the errors as received from the router:

package/src/middleware/index.js

@@ -1,7 +1,8 @@
-export * from './attachLogger'
-export * from './createTransaction'
-export * from './findRoute'
-export * from './handleError'
-export * from './handleRoute'
-export * from './handleUser'
-export * from './logRequests'
+export * from './attachLogger.js'
+export * from './createTransaction.js'
+export * from './findRoute.js'
+export * from './handleConnectMiddleware.js'
+export * from './handleError.js'
+export * from './handleRoute.js'
+export * from './handleUser.js'
+export * from './logRequests.js'

package/src/mixins/AssetMixin.js

@@ -1,5 +1,5 @@
 import { mixin } from '@ditojs/utils'
-import { TimeStampedMixin } from './TimeStampedMixin'
+import { TimeStampedMixin } from './TimeStampedMixin.js'
 
 // Asset models are always to be time-stamped:
 export const AssetMixin = mixin(Model => class extends TimeStampedMixin(Model) {

package/src/mixins/UserMixin.js

@@ -1,8 +1,8 @@
 import bcrypt from 'bcryptjs'
 import passport from 'koa-passport'
 import { Strategy as LocalStrategy } from 'passport-local'
-import { AuthenticationError } from '@/errors'
 import { mixin, asArray } from '@ditojs/utils'
+import { AuthenticationError } from '../errors/index.js'
 
 export const UserMixin = mixin(Model => class extends Model {
   static options = {

package/src/mixins/index.js

@@ -1,4 +1,4 @@
-export * from './AssetMixin'
-export * from './SessionMixin'
-export * from './TimeStampedMixin'
-export * from './UserMixin'
+export * from './AssetMixin.js'
+export * from './SessionMixin.js'
+export * from './TimeStampedMixin.js'
+export * from './UserMixin.js'

package/src/models/AssetModel.js

@@ -1,4 +1,4 @@
-import { AssetMixin } from '@/mixins'
-import { Model } from './Model'
+import { AssetMixin } from '../mixins/index.js'
+import { Model } from './Model.js'
 
 export const AssetModel = AssetMixin(Model)

package/src/models/Model.js

@@ -1,22 +1,26 @@
 import objection from 'objection'
-import { QueryBuilder } from '@/query'
-import { EventEmitter, KnexHelper } from '@/lib'
-import { convertSchema, addRelationSchemas, convertRelations } from '@/schema'
-import { populateGraph, filterGraph } from '@/graph'
-import { formatJson } from '@/utils'
+import {
+  isString, isObject, isArray, isFunction, isPromise, asArray, merge, flatten,
+  parseDataPath, normalizeDataPath, getValueAtDataPath
+} from '@ditojs/utils'
+import { QueryBuilder } from '../query/index.js'
+import { EventEmitter, KnexHelper } from '../lib/index.js'
+import {
+  convertSchema,
+  addRelationSchemas,
+  convertRelations
+} from '../schema/index.js'
+import { populateGraph, filterGraph } from '../graph/index.js'
+import { formatJson } from '../utils/index.js'
 import {
   ResponseError,
   GraphError, ModelError,
   NotFoundError,
   RelationError,
   WrappedError
-} from '@/errors'
-import {
-  isString, isObject, isArray, isFunction, isPromise, asArray, merge, flatten,
-  parseDataPath, normalizeDataPath, getValueAtDataPath
-} from '@ditojs/utils'
-import RelationAccessor from './RelationAccessor'
-import definitions from './definitions'
+} from '../errors/index.js'
+import RelationAccessor from './RelationAccessor.js'
+import definitions from './definitions/index.js'
 
 export class Model extends objection.Model {
   // Define a default constructor to allow new Model(json) as a short-cut to

package/src/models/RelationAccessor.js

@@ -1,4 +1,4 @@
-import { QueryBuilder } from '@/query'
+import { QueryBuilder } from '../query/index.js'
 
 export default class RelationAccessor {
   constructor(relation, modelClass, model) {

package/src/models/SessionModel.js

@@ -1,4 +1,4 @@
-import { SessionMixin } from '@/mixins'
-import { Model } from './Model'
+import { SessionMixin } from '../mixins/index.js'
+import { Model } from './Model.js'
 
 export const SessionModel = SessionMixin(Model)

package/src/models/TimeStampedModel.js

@@ -1,4 +1,4 @@
-import { TimeStampedMixin } from '@/mixins'
-import { Model } from './Model'
+import { TimeStampedMixin } from '../mixins/index.js'
+import { Model } from './Model.js'
 
 export const TimeStampedModel = TimeStampedMixin(Model)

package/src/models/UserModel.js

@@ -1,4 +1,4 @@
-import { UserMixin } from '@/mixins'
-import { Model } from './Model'
+import { UserMixin } from '../mixins/index.js'
+import { Model } from './Model.js'
 
 export const UserModel = UserMixin(Model)

package/src/models/definitions/assets.js

@@ -1,4 +1,4 @@
-import { mergeReversedOrNull } from '@/utils'
+import { mergeReversedOrNull } from '../../utils/index.js'
 
 export default function assets(values) {
   return mergeReversedOrNull(values)

package/src/models/definitions/filters.js

@@ -1,6 +1,6 @@
 import { isObject, isFunction } from '@ditojs/utils'
-import { QueryFilters } from '@/query'
-import { mergeReversed } from '@/utils'
+import { mergeReversed, processHandlerParameters } from '../../utils/index.js'
+import { QueryFilters } from '../../query/index.js'
 
 export default function filters(values) {
   const filters = {}
@@ -8,7 +8,7 @@ export default function filters(values) {
     const filter = isFunction(definition)
       ? definition
       : isObject(definition)
-        ? convertObjectFilter(definition, name)
+        ? convertFilterObject(name, definition)
         : null
     if (!filter) {
       throw new Error(
@@ -20,72 +20,85 @@ export default function filters(values) {
   return filters
 }
 
-function convertObjectFilter(definition, name) {
-  const { filter, properties } = definition
-  if (isFunction(filter)) {
-    return addFunctionSettings(filter, definition)
-  } else {
-    // Convert QueryFilters to normal filter functions
+function convertFilterObject(name, object) {
+  const addHandlerSettings = (handler, definition) => {
+    // Copy over parameters, returns and their validation options settings.
+    const { parameters, returns, ...rest } = definition
+    processHandlerParameters(handler, 'parameters', parameters)
+    processHandlerParameters(handler, 'returns', returns)
+    return Object.assign(handler, rest)
+  }
+
+  const { handler, filter, properties } = object
+  if (handler) {
+    return addHandlerSettings(handler, object)
+  } else if (filter) {
+    // Convert QueryFilter to normal filter function.
     const queryFilter = QueryFilters.get(filter)
     if (!queryFilter) {
       throw new Error(
         `Invalid filter '${name}': Unknown filter type '${filter}'.`
       )
     }
+    // Support both object and function definitions.
+    const queryHandler = isObject(queryFilter)
+      ? queryFilter.handler
+      : queryFilter
     const func = properties
       ? (query, ...args) => {
         // When the filter provides multiple properties, match them
         // all, but combine the expressions with OR.
         for (const property of properties) {
-          query.orWhere(query => queryFilter(query, property, ...args))
+          query.orWhere(query => queryHandler(query, property, ...args))
         }
       }
       : (query, ...args) => {
-        queryFilter(query, name, ...args)
+        queryHandler(query, name, ...args)
       }
-    return addFunctionSettings(func, queryFilter)
+    return addHandlerSettings(func, queryFilter)
   }
 }
 
-function addFunctionSettings(filter, definition) {
-  // Copy over @parameters() and @validate() settings
-  filter.parameters = definition.parameters
-  filter.validate = definition.validate
-  return filter
-}
-
 function wrapWithValidation(filter, name, app) {
-  // If parameters are defined, wrap the function in a closure that
-  // performs parameter validation...
-  const dataName = 'query'
-  const validator = filter && app.compileParametersValidator(
-    filter.parameters,
-    { ...filter.validate, dataName }
-  )
-  if (validator?.validate) {
-    return (query, ...args) => {
+  if (filter) {
+    // TODO: Implement `returns` validation for filters too.
+    // TODO: Share additional coercion handling with
+    // `ControllerAction#coerceValue()`
+    const { parameters, options = {} } = filter
+    // If parameters are defined, wrap the function in a closure that
+    // performs parameter validation...
+    const dataName = 'query'
+    const validator = app.compileParametersValidator(parameters, {
+      ...options.parameters,
+      dataName
+    })
+    if (validator?.validate) {
+      return (query, ...args) => {
       // Convert args to object for validation:
-      const object = {}
-      let index = 0
-      for (const { name } of validator.list) {
+        const object = {}
+        let index = 0
+        for (const { name } of validator.list) {
         // Use dataName if no name is given, see:
         // Application.compileParametersValidator()
-        object[name || dataName] = args[index++]
-      }
-      try {
-        validator.validate(object)
-      } catch (error) {
-        throw app.createValidationError({
-          type: 'FilterValidation',
-          message:
+          object[name || dataName] = args[index++]
+        }
+        try {
+          validator.validate(object)
+        } catch (error) {
+          throw app.createValidationError({
+            type: 'FilterValidation',
+            message:
             `The provided data for query filter '${name}' is not valid`,
-          errors: app.validator.prefixDataPaths(
-            error.errors,
+            errors: app.validator.prefixDataPaths(
+              error.errors,
             `.${name}`
-          )
-        })
+            )
+          })
+        }
+        return validator.asObject
+          ? filter(query, object)
+          : filter(query, ...args)
       }
-      return filter(query, ...args)
     }
   }
   // ...otherwise use the defined filter function unmodified.

package/src/models/definitions/hooks.js

@@ -1,4 +1,4 @@
-import { mergeAsReversedArrays } from '@/utils'
+import { mergeAsReversedArrays } from '../../utils/index.js'
 
 export default function hooks(values) {
   // Use `mergeAsReversedArrays()` so that for each event there is an array

package/src/models/definitions/index.js

@@ -1,12 +1,12 @@
-import options from './options'
-import properties from './properties'
-import relations from './relations'
-import schema from './schema'
-import scopes from './scopes'
-import filters from './filters'
-import modifiers from './modifiers'
-import assets from './assets'
-import hooks from './hooks'
+import options from './options.js'
+import properties from './properties.js'
+import relations from './relations.js'
+import schema from './schema.js'
+import scopes from './scopes.js'
+import filters from './filters.js'
+import modifiers from './modifiers.js'
+import assets from './assets.js'
+import hooks from './hooks.js'
 
 export default {
   // Export options first, as other definitions may rely on them, e.g. UserMixin

package/src/models/definitions/modifiers.js

@@ -1,4 +1,4 @@
-import { mergeReversed } from '@/utils'
+import { mergeReversed } from '../../utils/index.js'
 
 export default function modifiers(values) {
   return mergeReversed(values)

package/src/models/definitions/options.js

@@ -1,4 +1,4 @@
-import { mergeReversed } from '@/utils'
+import { mergeReversed } from '../../utils/index.js'
 
 export default function hooks(values) {
   return mergeReversed(values)

package/src/models/definitions/properties.js

@@ -1,5 +1,5 @@
-import { mergeReversed } from '@/utils'
-import { expandSchemaShorthand } from '@/schema'
+import { mergeReversed } from '../../utils/index.js'
+import { expandSchemaShorthand } from '../../schema/index.js'
 
 export default function properties(values) {
   const properties = mergeReversed(values)

package/src/models/definitions/relations.js

@@ -1,4 +1,4 @@
-import { mergeReversed } from '@/utils'
+import { mergeReversed } from '../../utils/index.js'
 
 export default function relations(values) {
   return mergeReversed(values)

package/src/models/definitions/schema.js

@@ -1,4 +1,4 @@
-import { mergeReversed } from '@/utils'
+import { mergeReversed } from '../../utils/index.js'
 
 export default function schema(values) {
   return mergeReversed(values)

package/src/models/definitions/scopes.js

@@ -1,6 +1,6 @@
 import { isObject, isFunction } from '@ditojs/utils'
-import { ModelError } from '@/errors'
-import { mergeReversed } from '@/utils'
+import { ModelError } from '../../errors/index.js'
+import { mergeReversed } from '../../utils/index.js'
 
 export default function scopes(values) {
   const scopes = {}

package/src/models/index.js

@@ -1,5 +1,5 @@
-export * from './Model'
-export * from './AssetModel'
-export * from './SessionModel'
-export * from './TimeStampedModel'
-export * from './UserModel'
+export * from './Model.js'
+export * from './AssetModel.js'
+export * from './SessionModel.js'
+export * from './TimeStampedModel.js'
+export * from './UserModel.js'

package/src/query/QueryBuilder.js

@@ -1,13 +1,13 @@
 import objection from 'objection'
-import { KnexHelper } from '@/lib'
-import { QueryBuilderError, RelationError } from '@/errors'
-import { QueryParameters } from './QueryParameters'
-import { DitoGraphProcessor, walkGraph } from '@/graph'
 import {
   isObject, isPlainObject, isString, isArray, clone, mapKeys,
   getValueAtDataPath, setValueAtDataPath, parseDataPath
 } from '@ditojs/utils'
-import { createLookup, getScope, deprecate } from '@/utils'
+import { QueryParameters } from './QueryParameters.js'
+import { KnexHelper } from '../lib/index.js'
+import { DitoGraphProcessor, walkGraph } from '../graph/index.js'
+import { QueryBuilderError, RelationError } from '../errors/index.js'
+import { createLookup, getScope, deprecate } from '../utils/index.js'
 
 const SYMBOL_ALL = Symbol('all')