@ditojs/server 1.27.1 → 1.29.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ditojs/server",
-  "version": "1.27.1",
+  "version": "1.29.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",
@@ -22,10 +22,10 @@
     "node >= 18"
   ],
   "dependencies": {
-    "@ditojs/admin": "^1.27.0",
-    "@ditojs/build": "^1.25.0",
-    "@ditojs/router": "^1.27.0",
-    "@ditojs/utils": "^1.27.0",
+    "@ditojs/admin": "^1.29.0",
+    "@ditojs/build": "^1.29.0",
+    "@ditojs/router": "^1.29.0",
+    "@ditojs/utils": "^1.29.0",
     "@koa/cors": "^4.0.0",
     "@koa/multer": "^3.0.2",
     "@originjs/vite-plugin-commonjs": "^1.0.3",
@@ -36,19 +36,19 @@
     "data-uri-to-buffer": "^4.0.1",
     "eventemitter2": "^6.4.9",
     "file-type": "^18.2.1",
-    "image-size": "^1.0.2",
     "koa": "^2.14.1",
-    "koa-bodyparser": "^4.3.0",
+    "koa-bodyparser": "^4.4.0",
     "koa-compose": "^4.1.0",
     "koa-compress": "^5.1.0",
     "koa-conditional-get": "^3.0.0",
     "koa-etag": "^4.0.0",
-    "koa-helmet": "^6.1.0",
+    "koa-helmet": "^7.0.1",
     "koa-mount": "^4.0.0",
     "koa-passport": "^6.0.0",
     "koa-response-time": "^2.1.0",
     "koa-session": "^6.4.0",
     "koa-static": "^5.0.0",
+    "leather": "^2.1.4",
     "mime-types": "^2.1.35",
     "multer": "^1.4.5-lts.1",
     "multer-s3": "https://github.com/ditojs/multer-s3#dito",
@@ -59,11 +59,11 @@
     "picocolors": "^1.0.0",
     "picomatch": "^2.3.1",
     "pino": "^8.11.0",
-    "pino-pretty": "^9.4.0",
+    "pino-pretty": "^10.0.0",
     "pluralize": "^8.0.0",
     "repl": "^0.1.3",
     "uuid": "^9.0.0",
-    "vite": "^4.1.4",
+    "vite": "^4.2.1",
     "vite-plugin-vue2": "^2.0.3",
     "vue": "^2.7.14",
     "vue-template-compiler": "^2.7.14"
@@ -74,23 +74,23 @@
     "objection": "^3.0.1"
   },
   "devDependencies": {
-    "@aws-sdk/client-s3": "^3.282.0",
+    "@aws-sdk/client-s3": "^3.295.0",
     "@types/koa-bodyparser": "^4.3.10",
     "@types/koa-compress": "^4.0.3",
     "@types/koa-logger": "^3.1.2",
     "@types/koa-pino-logger": "^3.0.1",
     "@types/koa-response-time": "^2.1.2",
-    "@types/koa-session": "^5.10.6",
+    "@types/koa-session": "^6.4.0",
     "@types/koa-static": "^4.0.2",
-    "@types/koa__cors": "^3.3.1",
-    "@types/node": "^18.14.6",
+    "@types/koa__cors": "^4.0.0",
+    "@types/node": "^18.15.5",
     "knex": "^2.4.2",
     "objection": "^3.0.1",
     "type-fest": "^3.6.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.0.2"
   },
   "types": "types",
-  "gitHead": "b0658f0d25d0a234a4b7a3ad2df957a92a0d37e7",
+  "gitHead": "6e93fe59126eab3d5ee1961d9e03f0fbdc297fba",
   "scripts": {
     "types": "tsc --noEmit ./src/index.d.ts"
   },

package/src/mixins/AssetMixin.js

@@ -40,7 +40,7 @@ export const AssetMixin = mixin(Model => class extends TimeStampedMixin(Model) {
         url: {
           type: 'string'
         },
-        // These are only used when the storage defines `config.readImageSize`:
+        // These are only used when the storage defines `config.readDimensions`:
         width: {
           type: 'integer'
         },

package/src/models/Model.js

@@ -42,7 +42,7 @@ export class Model extends objection.Model {
     const { hooks, assets } = this.definition
     this._configureEmitter(hooks)
     if (assets) {
-      this._configureAssetsEvents(assets)
+      this._configureAssetsHooks(assets)
     }
     try {
       for (const relation of Object.values(this.getRelations())) {
@@ -923,7 +923,7 @@ export class Model extends objection.Model {
 
   // Assets handling
 
-  static _configureAssetsEvents(assets) {
+  static _configureAssetsHooks(assets) {
     const assetDataPaths = Object.keys(assets)
 
     this.on([
@@ -931,34 +931,53 @@ export class Model extends objection.Model {
       'before:update',
       'before:delete'
     ], async ({ type, transaction, inputItems, asFindQuery }) => {
-      const afterItems = type === 'before:delete'
-        ? []
-        : inputItems
+      const isInsert = type === 'before:insert'
+      const isDelete = type === 'before:delete'
       // Figure out which asset data paths where actually present in the
       // submitted data, and only compare these. But when deleting, use all.
-      const dataPaths = afterItems.length > 0
-        ? assetDataPaths.filter(
-          path => getValueAtAssetDataPath(afterItems[0], path) !== undefined
+      const dataPaths = isDelete
+        ? assetDataPaths
+        : assetDataPaths.filter(
+          dataPath => (
+            // Skip check for wildcard data-paths.
+            /^\*\*?/.test(dataPath) ||
+            // Only keep normal data paths that match present properties.
+            (parseDataPath(dataPath)[0] in inputItems[0])
+          )
         )
-        : assetDataPaths
-
       // `dataPaths` is empty in the case of an update/insert that does not
       // affect the assets.
       if (dataPaths.length === 0) return
 
+      const afterItems = isDelete
+        ? []
+        : inputItems
       // Load the model's asset files in their current state before the query is
-      // executed.
-      const beforeItems = type === 'before:insert'
+      // executed. For deletes, load the data for all asset data-paths.
+      // Otherwise, only load the columns present in the input data.
+      const beforeItems = isInsert
         ? []
-        : await loadAssetDataPaths(asFindQuery(), dataPaths)
-      const beforeFilesPerDataPath = getFilesPerAssetDataPath(
-        beforeItems,
-        dataPaths
-      )
+        : isDelete
+          // When deleting it's ok to load all columns when data-paths contain
+          // wildcards unfiltered, since `afterItems` will be empty anyway.
+          ? await loadAssetDataPaths(asFindQuery(), dataPaths)
+          : await asFindQuery().select(
+            // Select only the properties that are present in the data,
+            // and which aren't the result of computed properties.
+            Object.keys(inputItems[0]).filter(key => {
+              const property = this.definition.properties[key]
+              return property && !property.computed
+            })
+          )
+
       const afterFilesPerDataPath = getFilesPerAssetDataPath(
         afterItems,
         dataPaths
       )
+      const beforeFilesPerDataPath = getFilesPerAssetDataPath(
+        beforeItems,
+        dataPaths
+      )
 
       const importedFiles = []
       const modifiedFiles = []

package/src/storage/S3Storage.js

@@ -3,7 +3,7 @@ import { fileTypeFromBuffer } from 'file-type'
 import { Storage } from './Storage.js'
 import { PassThrough } from 'stream'
 import consumers from 'stream/consumers'
-import imageSize from 'image-size'
+import { attributes as readMediaAttributes } from 'leather'
 
 export class S3Storage extends Storage {
   static type = 's3'
@@ -159,31 +159,9 @@ export class S3Storage extends Storage {
 }
 
 function getFileTypeFromBuffer(buffer) {
-  const type = fileTypeFromBuffer(buffer)
-  if (type) {
-    return type.mime
-  }
   try {
-    const { type } = imageSize(buffer)
-    return {
-      jpg: 'image/jpeg',
-      png: 'image/png',
-      gif: 'image/gif',
-      svg: 'image/svg+xml',
-      webp: 'image/webp',
-      tiff: 'image/tiff',
-      j2c: 'image/jp2',
-      jp2: 'image/jp2',
-      ktx: 'image/ktx',
-      bmp: 'image/bmp',
-      tga: 'image/x-targa',
-      cur: 'image/x-win-bitmap',
-      icns: 'image/x-icon',
-      ico: 'image/x-icon',
-      pnm: 'image/x-portable-anymap',
-      dds: 'image/vnd-ms.dds',
-      psd: 'image/vnd.adobe.photoshop'
-    }[type]
+    // Use leather as fall-back for better media file mime type detection.
+    return fileTypeFromBuffer(buffer)?.mime || readMediaAttributes(buffer)?.mime
   } catch (err) {}
   return null
 }

package/src/storage/Storage.js

@@ -2,10 +2,11 @@ import path from 'path'
 import { URL } from 'url'
 import multer from '@koa/multer'
 import picomatch from 'picomatch'
-import imageSize from 'image-size'
 import { PassThrough } from 'stream'
+import { attributes as readMediaAttributes } from 'leather'
 import { hyphenate, toPromiseCallback } from '@ditojs/utils'
 import { AssetFile } from './AssetFile.js'
+import { deprecate } from '../utils/deprecate.js'
 
 const storageClasses = {}
 
@@ -87,7 +88,7 @@ export class Storage {
       type: storageFile.mimetype,
       size: storageFile.size,
       url: this._getFileUrl(storageFile),
-      // In case `config.readImageSize` is set:
+      // In case `config.readDimensions` is set:
       width: storageFile.width,
       height: storageFile.height
     }
@@ -101,7 +102,7 @@ export class Storage {
     await this._addFile(file, data)
     file.size = Buffer.byteLength(data)
     file.url = this._getFileUrl(file)
-    // TODO: Support `config.readImageSize`, but this can only be done once
+    // TODO: Support `config.readDimensions`, but this can only be done once
     // there are separate storage instances per model assets config!
     return this.convertAssetFile(file)
   }
@@ -126,10 +127,6 @@ export class Storage {
     return this._getFileUrl(file)
   }
 
-  isImageFile(file) {
-    return file.mimetype.startsWith('image/')
-  }
-
   _getUrl(...parts) {
     return this.url
       ? new URL(path.posix.join(...parts), this.url).toString()
@@ -161,8 +158,20 @@ export class Storage {
   async _listKeys() {}
 
   async _handleUpload(req, file, config) {
-    if (config.readImageSize && this.isImageFile(file)) {
-      return this._handleImageFile(req, file)
+    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
+      ) && /^(image|video)\//.test(file.mimetype)
+    ) {
+      return this._handleMediaFile(req, file)
     } else {
       return this._handleFile(req, file)
     }
@@ -183,7 +192,7 @@ export class Storage {
     })
   }
 
-  async _handleImageFile(req, file) {
+  async _handleMediaFile(req, file) {
     const { size, stream } = await new Promise(resolve => {
       let data = null
 
@@ -204,9 +213,15 @@ export class Storage {
 
       const onData = chunk => {
         data = data ? Buffer.concat([data, chunk]) : chunk
-        const size = imageSize(data)
-        if (size) {
-          done(size)
+        try {
+          const size = readMediaAttributes(data)
+          // On partial data, sometimes we get results back from leather without
+          // actual dimensions, so check for that.
+          if (size.mime && (size.width > 0 || size.height > 0)) {
+            done(size)
+          }
+        } catch {
+          // Ignore errors in `readMediaAttributes()` on partial data.
         }
       }
 

package/src/utils/function.test.js

@@ -31,22 +31,22 @@ describe('describeFunction()', () => {
       .toBe('async function (a, b, c) { ... }')
   })
 
-  it('describes lambdas with one param and a body', () => {
+  it('describes async lambdas with one param and a body', () => {
     expect(describeFunction(async a => { return a }))
       .toBe('async a => { ... }')
   })
 
-  it('describes lambdas with one param and no body', () => {
+  it('describes async lambdas with one param and no body', () => {
     expect(describeFunction(async a => a))
       .toBe('async a => ...')
   })
 
-  it('describes lambdas with multiple params and a body', () => {
+  it('describes async lambdas with multiple params and a body', () => {
     expect(describeFunction(async (a, b, c) => { return a + b + c }))
       .toBe('async (a, b, c) => { ... }')
   })
 
-  it('describes lambdas with multiple params and no body', () => {
+  it('describes async lambdas with multiple params and no body', () => {
     expect(describeFunction(async (a, b, c) => a + b + c))
       .toBe('async (a, b, c) => ...')
   })

package/types/index.d.ts

@@ -588,7 +588,7 @@ export type ModelFilters<$Model extends Model = Model> = Record<
 
 export interface ModelAsset {
   storage: string
-  readImageSize?: boolean
+  readDimensions?: boolean
 }
 
 export type ModelAssets = Record<string, ModelAsset>
@@ -1666,9 +1666,9 @@ type AssetFileObject = {
   size: number
   // The public url of the file
   url: string
-  // The width of the image if the storage defines `config.readImageSize`
+  // The width of the image if the storage defines `config.readDimensions`
   width: number
-  // The height of the image if the storage defines `config.readImageSize`
+  // The height of the image if the storage defines `config.readDimensions`
   height: number
 }