@ditojs/server 1.26.0 → 1.27.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/server",
-  "version": "1.26.0",
+  "version": "1.27.1",
   "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",
@@ -22,10 +22,10 @@
     "node >= 18"
   ],
   "dependencies": {
-    "@ditojs/admin": "^1.26.0",
+    "@ditojs/admin": "^1.27.0",
     "@ditojs/build": "^1.25.0",
-    "@ditojs/router": "^1.26.0",
-    "@ditojs/utils": "^1.26.0",
+    "@ditojs/router": "^1.27.0",
+    "@ditojs/utils": "^1.27.0",
     "@koa/cors": "^4.0.0",
     "@koa/multer": "^3.0.2",
     "@originjs/vite-plugin-commonjs": "^1.0.3",
@@ -51,7 +51,7 @@
     "koa-static": "^5.0.0",
     "mime-types": "^2.1.35",
     "multer": "^1.4.5-lts.1",
-    "multer-s3": "^3.0.1",
+    "multer-s3": "https://github.com/ditojs/multer-s3#dito",
     "nanoid": "^4.0.1",
     "parse-duration": "^1.0.3",
     "passport-local": "^1.0.0",
@@ -90,7 +90,7 @@
     "typescript": "^4.9.5"
   },
   "types": "types",
-  "gitHead": "198c9832c863003c8c8fcd147bf61a5f99a39c91",
+  "gitHead": "b0658f0d25d0a234a4b7a3ad2df957a92a0d37e7",
   "scripts": {
     "types": "tsc --noEmit ./src/index.d.ts"
   },

package/src/app/Application.js

@@ -31,7 +31,8 @@ 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 { getDuration, subtractDuration, deprecate } from '../utils/index.js'
+import { getDuration, subtractDuration } from '../utils/duration.js'
+import { deprecate } from '../utils/deprecate.js'
 import {
   ResponseError,
   ValidationError,
@@ -881,7 +882,9 @@ export class Application extends Koa {
                 data = await fs.readFile(filepath)
               } else {
                 const response = await fetch(url)
-                data = await response.arrayBuffer()
+                const arrayBuffer = await response.arrayBuffer()
+                // `fs.writeFile()` expects a Buffer, not an ArrayBuffer.
+                data = Buffer.from(arrayBuffer)
               }
             }
             const importedFile = await storage.addFile(file, data)

package/src/app/Validator.js

@@ -2,7 +2,7 @@ import objection from 'objection'
 import Ajv from 'ajv/dist/2020.js'
 import addFormats from 'ajv-formats'
 import { isArray, isObject, clone, isAsync, isPromise } from '@ditojs/utils'
-import { formatJson } from '../utils/index.js'
+import { formatJson } from '../utils/json.js'
 import * as schema from '../schema/index.js'
 
 // Dito does not rely on objection.AjvValidator but instead implements its own

package/src/cli/db/createMigration.js

@@ -1,10 +1,14 @@
 import path from 'path'
 import fs from 'fs/promises'
 import pico from 'picocolors'
-import { getRelationClass, isThroughRelationClass } from '@ditojs/server'
+import {
+  getRelationClass,
+  isThroughRelationClass
+} from '@ditojs/server'
 import {
   isObject, isArray, isString, deindent, capitalize
 } from '@ditojs/utils'
+import { exists } from '../../utils/fs.js'
 
 const typeToKnex = {
   number: 'double',
@@ -204,12 +208,3 @@ function getTimestamp() {
     padDate(d.getMinutes()) +
     padDate(d.getSeconds())
 }
-
-async function exists(path) {
-  try {
-    await fs.access(path)
-    return true
-  } catch {
-    return false
-  }
-}

package/src/cli/db/listAssetConfig.js

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

package/src/controllers/AdminController.js

@@ -15,7 +15,9 @@ import { merge } from '@ditojs/utils'
 import { Controller } from './Controller.js'
 import { handleConnectMiddleware } from '../middleware/index.js'
 import { ControllerError } from '../errors/index.js'
-import { formatJson, getRandomFreePort, deprecate } from '../utils/index.js'
+import { getRandomFreePort } from '../utils/net.js'
+import { formatJson } from '../utils/json.js'
+import { deprecate } from '../utils/deprecate.js'
 
 export class AdminController extends Controller {
   // @override

package/src/controllers/Controller.js

@@ -6,9 +6,12 @@ import {
   ResponseError, ControllerError, AuthorizationError
 } from '../errors/index.js'
 import {
-  getOwnProperty, getOwnKeys, getAllKeys, getInheritanceChain,
-  processHandlerParameters, describeFunction, formatJson, deprecate
-} from '../utils/index.js'
+  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

package/src/controllers/ModelController.js

@@ -3,7 +3,7 @@ import { isObject, camelize } from '@ditojs/utils'
 import { CollectionController } from './CollectionController.js'
 import { RelationController } from './RelationController.js'
 import { ControllerError } from '../errors/index.js'
-import { setupPropertyInheritance } from '../utils/index.js'
+import { setupPropertyInheritance } from '../utils/object.js'
 
 export class ModelController extends CollectionController {
   configure() {

package/src/controllers/RelationController.js

@@ -2,7 +2,8 @@ import pico from 'picocolors'
 import { asArray } from '@ditojs/utils'
 import { CollectionController } from './CollectionController.js'
 import { ControllerError } from '../errors/index.js'
-import { setupPropertyInheritance, getScope } from '../utils/index.js'
+import { setupPropertyInheritance } from '../utils/object.js'
+import { getScope } from '../utils/scope.js'
 
 export class RelationController extends CollectionController {
   constructor(parent, object, relationInstance, relationDefinition) {

package/src/decorators/action.js

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

package/src/decorators/authorize.js

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

package/src/decorators/parameters.js

@@ -1,5 +1,7 @@
 import { isArray, isObject } from '@ditojs/utils'
-import { createDecorator, deprecate, formatJson } from '../utils/index.js'
+import { createDecorator } from '../utils/decorator.js'
+import { formatJson } from '../utils/json.js'
+import { deprecate } from '../utils/deprecate.js'
 
 export function parameters(parameters, options) {
   if (isObject(parameters)) {

package/src/decorators/returns.js

@@ -1,5 +1,6 @@
 import { isObject } from '@ditojs/utils'
-import { createDecorator, formatJson } from '../utils/index.js'
+import { createDecorator } from '../utils/decorator.js'
+import { formatJson } from '../utils/json.js'
 
 export function returns(returns, options) {
   if (!isObject(returns)) {

package/src/decorators/scope.js

@@ -1,4 +1,4 @@
-import { createDecorator } from '../utils/index.js'
+import { createDecorator } from '../utils/decorator.js'
 
 export function scope(...scopes) {
   return createDecorator(value => {

package/src/decorators/transacted.js

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

package/src/index.js

@@ -8,4 +8,3 @@ 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/middleware/createTransaction.js

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

package/src/models/Model.js

@@ -12,7 +12,7 @@ import {
   convertRelations
 } from '../schema/index.js'
 import { populateGraph, filterGraph } from '../graph/index.js'
-import { formatJson } from '../utils/index.js'
+import { formatJson } from '../utils/json.js'
 import {
   ResponseError,
   GraphError, ModelError,

package/src/models/definitions/assets.js

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

package/src/models/definitions/filters.js

@@ -1,5 +1,6 @@
 import { isObject, isFunction } from '@ditojs/utils'
-import { mergeReversed, processHandlerParameters } from '../../utils/index.js'
+import { processHandlerParameters } from '../../utils/handler.js'
+import { mergeReversed } from '../../utils/object.js'
 import { QueryFilters } from '../../query/index.js'
 
 export default function filters(values) {

package/src/models/definitions/hooks.js

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

package/src/models/definitions/modifiers.js

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

package/src/models/definitions/options.js

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

package/src/models/definitions/properties.js

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

package/src/models/definitions/relations.js

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

package/src/models/definitions/schema.js

@@ -1,4 +1,4 @@
-import { mergeReversed } from '../../utils/index.js'
+import { mergeReversed } from '../../utils/object.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/index.js'
-import { mergeReversed } from '../../utils/index.js'
+import { mergeReversed } from '../../utils/object.js'
 
 export default function scopes(values) {
   const scopes = {}

package/src/query/QueryBuilder.js

@@ -7,7 +7,9 @@ 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'
+import { createLookup } from '../utils/object.js'
+import { getScope } from '../utils/scope.js'
+import { deprecate } from '../utils/deprecate.js'
 
 const SYMBOL_ALL = Symbol('all')
 

package/src/utils/fs.js

@@ -0,0 +1,10 @@
+import fs from 'fs/promises'
+
+export async function exists(path) {
+  try {
+    await fs.access(path)
+    return true
+  } catch {
+    return false
+  }
+}

package/types/index.d.ts

@@ -5,10 +5,10 @@
 
 // Export the entire Dito namespace.
 
+import { ObjectCannedACL, S3ClientConfig } from '@aws-sdk/client-s3'
 import { DateFormat } from '@dito/utils'
 import koaCors from '@koa/cors'
 import * as Ajv from 'ajv/dist/2020.js'
-import * as aws from 'aws-sdk'
 import * as dbErrors from 'db-errors'
 import * as EventEmitter2 from 'eventemitter2'
 import helmet from 'helmet'
@@ -21,6 +21,7 @@ import mount from 'koa-mount'
 import koaPinoLogger from 'koa-pino-logger'
 import koaResponseTime from 'koa-response-time'
 import koaSession from 'koa-session'
+import multerS3 from 'multer-s3'
 import * as objection from 'objection'
 import { KnexSnakeCaseMappersFactory } from 'objection'
 import { Logger } from 'pino'
@@ -212,61 +213,39 @@ export type MulterS3File = {
 
 export type StorageConfigs = { [key: string]: StorageConfig }
 
-export type StorageConfig =
-  | {
-      type: 's3'
-      /** The name of the destination bucket. */
-      bucket: aws.S3.BucketName
-      /** @default 'private'  */
-      acl: LiteralUnion<
-        | 'private'
-        | 'public-read'
-        | 'public-read-write'
-        | 'authenticated-read'
-        | 'aws-exec-read'
-        | 'bucket-owner-read'
-        | 'bucket-owner-full-control'
-      >
-      /**
-       * Can be used to specify caching behavior along the request/reply chain.
-       *
-       * @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
-       */
-      cacheControl?: aws.S3.CacheControl
-      /**
-       * The type of storage to use for the object.
-       *
-       * @default 'STANDARD'
-       */
-      storageClass?: LiteralUnion<
-        | 'STANDARD'
-        | 'REDUCED_REDUNDANCY'
-        | 'STANDARD_IA'
-        | 'ONEZONE_IA'
-        | 'INTELLIGENT_TIERING'
-        | 'GLACIER'
-        | 'DEEP_ARCHIVE'
-      >
-      /**
-       * The server-side encryption algorithm used when storing this object in
-       * Amazon S3 (for example, AES256, aws:kms).
-       */
-      serverSideEncryption?: aws.S3.ServerSideEncryption
-      /**
-       * If present, specifies the ID of the AWS Key Management Service (AWS
-       * KMS) symmetric customer managed customer master key (CMK)
-       */
-      sseKmsKeyId?: aws.S3.SSEKMSKeyId
-      s3: aws.S3.ClientConfiguration
-      url?: string
-    }
-  | {
-      type: 'disk'
-      path: string
-      url?: string
-      mount?: string
-      allowedImports?: string[]
-    }
+type CommonStorageConfig = {
+  /**
+   * The concurrency at which assets are added to storage.
+   *
+   * @default `8`
+   */
+  concurrency?: number
+  /**
+   * The base URL at which assets are accessible.
+   */
+  url?: string
+  allowedImports?: string[]
+}
+
+export type S3StorageConfig = CommonStorageConfig & {
+  type: 's3'
+  bucket: string
+  acl?: ObjectCannedACL | string
+  s3: S3ClientConfig
+} & Omit<
+    Parameters<typeof multerS3>[0],
+    's3' | 'key' | 'contentType' | 'metadata'
+  >
+
+export type DiskStorageConfig = CommonStorageConfig & {
+  type: 'disk'
+  /**
+   * The path to the directory where assets are stored on.
+   */
+  path: string
+}
+
+export type StorageConfig = S3StorageConfig | DiskStorageConfig
 
 export interface AdminConfig {
   api?: ApiConfig
@@ -784,8 +763,7 @@ export class Model extends objection.Model {
   static whereJsonSubsetOf: StaticQueryBuilderMethod<'whereJsonSubsetOf'>
   static whereJsonNotSubsetOf: StaticQueryBuilderMethod<'whereJsonNotSubsetOf'>
   static whereJsonSupersetOf: StaticQueryBuilderMethod<'whereJsonSupersetOf'>
-  static whereJsonNotSupersetOf:
-    StaticQueryBuilderMethod<'whereJsonNotSupersetOf'>
+  static whereJsonNotSupersetOf: StaticQueryBuilderMethod<'whereJsonNotSupersetOf'>
 
   static having: StaticQueryBuilderMethod<'having'>
   static havingIn: StaticQueryBuilderMethod<'havingIn'>
@@ -885,6 +863,16 @@ export class Controller {
   initialize(): Promise<void>
   // TODO: type reflectActionsObject
   reflectActionsObject(): any
+  /**
+   * @overridable
+   */
+  logController(): void
+  /**
+   * @param str The string to log.
+   * @param [indent=0] The amount of levels to indent (in pairs of two spaces).
+   *   Default is `0`
+   */
+  logRoute(str: string, indent?: number): void
   setupRoute<$ControllerAction extends ControllerAction = ControllerAction>(
     method: HTTPMethod,
     url: string,
@@ -930,12 +918,6 @@ export class Controller {
   processAuthorize(authorize: any): any
   describeAuthorize(authorize: any): string
   handleAuthorization(): Promise<void>
-  /**
-   * @param str The string to log.
-   * @param [indent=0] The amount of levels to indent (in pairs of two spaces).
-   *   Default is `0`
-   */
-  log(str: string, indent?: number): void
 }
 
 export type ActionParameter = Schema & { name: string }

package/src/utils/index.js

@@ -1,10 +0,0 @@
-export * from './date.js'
-export * from './decorator.js'
-export * from './deprecate.js'
-export * from './emitter.js'
-export * from './function.js'
-export * from './handler.js'
-export * from './json.js'
-export * from './net.js'
-export * from './object.js'
-export * from './scope.js'