@ditojs/server 2.0.5 → 2.1.0

package/src/app/Validator.js

@@ -59,13 +59,17 @@ export class Validator extends objection.Validator {
       }
     }
 
-    addSchemas(this.keywords, (keyword, schema) => ajv.addKeyword({
-      keyword,
-      ...schema
-    }))
-    addSchemas(this.formats, (format, schema) => ajv.addFormat(format, {
-      ...schema
-    }))
+    addSchemas(this.keywords, (keyword, schema) =>
+      ajv.addKeyword({
+        keyword,
+        ...schema
+      })
+    )
+    addSchemas(this.formats, (format, schema) =>
+      ajv.addFormat(format, {
+        ...schema
+      })
+    )
 
     // Also add all model schemas that were already compiled so far.
     for (const schema of this.schemas) {
@@ -85,10 +89,13 @@ export class Validator extends objection.Validator {
       return opts
     }, {})
     const cacheKey = formatJson(opts, false)
-    const { ajv } = this.ajvCache[cacheKey] || (this.ajvCache[cacheKey] = {
-      ajv: this.createAjv(opts),
-      options
-    })
+    const { ajv } = (
+      this.ajvCache[cacheKey] ||
+      (this.ajvCache[cacheKey] = {
+        ajv: this.createAjv(opts),
+        options
+      })
+    )
     return ajv
   }
 
@@ -98,40 +105,41 @@ export class Validator extends objection.Validator {
     // Assume `options.throw = true` as the default.
     const dontThrow = options.throw === false
     return options.async
-      // For async:
-      ? dontThrow
+      ? // For async:
+        dontThrow
         ? async function validate(data) {
-          // Emulate `options.throw == false` behavior for async validation:
-          // Return `true` or `false`, and store errors on `validate.errors`
-          // if validation failed.
-          let result
-          try {
-            // Use `call()` to pass `this` as context to Ajv, see passContext:
-            result = await validator.call(this, data)
-          } catch (error) {
-            if (error.errors) {
-              validate.errors = error.errors
-              result = false
-            } else {
-              throw error
+            // Emulate `options.throw == false` behavior for async validation:
+            // Return `true` or `false`, and store errors on `validate.errors`
+            // if validation failed.
+            let result
+            try {
+              // Use `call()` to pass `this` as context to Ajv, see passContext:
+              result = await validator.call(this, data)
+            } catch (error) {
+              if (error.errors) {
+                validate.errors = error.errors
+                result = false
+              } else {
+                throw error
+              }
             }
+            return result
           }
-          return result
-        }
         : validator // The default for async is to throw.
-      // For sync:
-      : dontThrow
+      : // For sync:
+        dontThrow
         ? validator // The default for sync is to not throw.
-        : function(data) {
-          // Emulate `options.throw == true` behavior for sync validation:
-          // Return `true` if successful, throw `Ajv.ValidationError` otherwise.
-          // Use `call()` to pass `this` as context to Ajv, see passContext:
-          const result = validator.call(this, data)
-          if (!result) {
-            throw new Ajv.ValidationError(validator.errors)
+        : function (data) {
+            // Emulate `options.throw == true` behavior for sync validation:
+            // Return `true` if successful, throw `Ajv.ValidationError`
+            // otherwise. Use `call()` to pass `this` as context to Ajv,
+            // see `passContext`:
+            const result = validator.call(this, data)
+            if (!result) {
+              throw new Ajv.ValidationError(validator.errors)
+            }
+            return result
           }
-          return result
-        }
   }
 
   getKeyword(keyword) {
@@ -204,9 +212,10 @@ export class Validator extends objection.Validator {
       // https://github.com/epoberezkin/ajv/issues/671
       const key = dataPath.replace(/\['([^']*)'\]/g, '/$1').slice(1)
       const { message, keyword, params } = error
-      const definition = keyword === 'format'
-        ? this.getFormat(params.format)
-        : this.getKeyword(keyword)
+      const definition =
+        keyword === 'format'
+          ? this.getFormat(params.format)
+          : this.getKeyword(keyword)
       const identifier = `${key}_${keyword}`
       if (
         // Ajv produces duplicate validation errors sometimes, filter them out.
@@ -247,7 +256,8 @@ export class Validator extends objection.Validator {
       if (errors.length === 2) {
         const [error1, error2] = errors
         if (
-          error1.keyword === 'type' && error1.params.type === 'null' &&
+          error1.keyword === 'type' &&
+          error1.params.type === 'null' &&
           error2.keyword === 'oneOf'
         ) {
           delete errorHash[dataPath]

package/src/cli/console.js

@@ -52,7 +52,9 @@ export default async function startConsole(app, config) {
   try {
     await fs.stat(historyFile)
     const lines = await fs.readFile(historyFile)
-    lines.toString().split('\n')
+    lines
+      .toString()
+      .split('\n')
       .reverse()
       .slice(0, config.historySize)
       .filter(line => line.trim())
@@ -104,8 +106,8 @@ function displayUsage(app, config, details) {
     ${
       modelHandleNames.length > 0
         ? ` - Dito models: ${
-          modelHandleNames.map(m => pico.cyan(m)).join(', ')
-        }`
+            modelHandleNames.map(m => pico.cyan(m)).join(', ')
+          }`
         : ''
     }
   `)
@@ -123,7 +125,7 @@ function displayUsage(app, config, details) {
 
 // Wraps the default eval with a handler that resolves promises
 function wrapEval({ eval: defaultEval }) {
-  return async function(code, context, file, cb) {
+  return async function (code, context, file, cb) {
     return defaultEval.call(this, code, context, file, async (err, result) => {
       if (err || !(result && isFunction(result.then))) {
         return cb(err, result)

package/src/cli/db/createMigration.js

@@ -1,12 +1,13 @@
 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
+  isObject,
+  isArray,
+  isString,
+  deindent,
+  capitalize
 } from '@ditojs/utils'
 import { exists } from '../../utils/fs.js'
 
@@ -47,11 +48,12 @@ export async function createMigration(app, name, ...modelNames) {
     dropTables.unshift(deindent`
       .dropTableIfExists('${tableName}')`)
   }
-  const getCode = tables => tables.length > 0
-    ? deindent`
+  const getCode = tables =>
+    tables.length > 0
+      ? deindent`
       await knex.schema
         ${tables.join('\n')}`
-    : ''
+      : ''
   const filename = `${getTimestamp()}_${name}.js`
   const file = path.join(migrationDir, filename)
   if (await exists(file)) {
@@ -59,15 +61,20 @@ export async function createMigration(app, name, ...modelNames) {
     console.info(pico.red(`Migration '${filename}' already exists.`))
     return false
   } else {
-    await fs.writeFile(file, deindent`
-      export async function up(knex) {
-        ${getCode(createTables)}
-      }
+    await fs.writeFile(
+      file,
+      deindent`
+        /** @param {import('knex').Knex} knex */
+        export async function up(knex) {
+          ${getCode(createTables)}
+        }
 
-      export async function down(knex) {
-        ${getCode(dropTables)}
-      }
-    `)
+        /** @param {import('knex').Knex} knex */
+        export async function down(knex) {
+          ${getCode(dropTables)}
+        }
+      `
+    )
     console.info(pico.cyan(`Migration '${filename}' successfully created.`))
     return true
   }
@@ -82,8 +89,17 @@ async function collectModelTables(modelClass, app, tables) {
   for (const [name, property] of Object.entries(properties)) {
     const column = app.normalizeIdentifier(name)
     let {
-      description, type, specificType, unsigned, computed, nullable, required,
-      primary, foreign, unique, index,
+      description,
+      type,
+      specificType,
+      unsigned,
+      computed,
+      nullable,
+      required,
+      primary,
+      foreign,
+      unique,
+      index,
       default: _default
     } = property
     const knexType = typeToKnex[type] || type
@@ -95,8 +111,10 @@ async function collectModelTables(modelClass, app, tables) {
         // To declare composite foreign keys as unique, you can give each
         // property the same string value in the `unique` keywords, e.g.:
         // `unique: 'customerId_name'
-        const composites = uniqueComposites[unique] ||
+        const composites = (
+          uniqueComposites[unique] ||
           (uniqueComposites[unique] = [])
+        )
         composites.push(column)
         unique = false
       }
@@ -115,9 +133,10 @@ async function collectModelTables(modelClass, app, tables) {
       if (_default !== undefined) {
         let value = defaultValues[_default]
         if (!value) {
-          value = isArray(_default) || isObject(_default)
-            ? JSON.stringify(_default)
-            : _default
+          value =
+            isArray(_default) || isObject(_default)
+              ? JSON.stringify(_default)
+              : _default
           if (isString(value)) {
             value = `'${value}'`
           }
@@ -148,14 +167,20 @@ async function collectModelTables(modelClass, app, tables) {
           }
         }
       }
-      statements.push(statement.filter(str => !!str).join('.')
-        .replace(/\.\n\./g, '\n  .'))
+      statements.push(
+        statement
+          .filter(str => !!str)
+          .join('.')
+          .replace(/\.\n\./g, '\n  .')
+      )
     }
   }
   for (const composites of Object.values(uniqueComposites)) {
-    statements.push(`table.unique([${
-      composites.map(column => `'${column}'`).join(', ')
-    }])`)
+    statements.push(
+      `table.unique([${
+        composites.map(column => `'${column}'`).join(', ')
+      }])`
+    )
   }
 }
 
@@ -173,9 +198,11 @@ async function collectThroughTables(modelClass, app, tables) {
       // See convertRelations()
       const tableName = app.normalizeIdentifier(`${fromClass}${toClass}`)
       const fromId = app.normalizeIdentifier(
-        `${fromClass}${capitalize(fromProperty)}`)
+        `${fromClass}${capitalize(fromProperty)}`
+      )
       const toId = app.normalizeIdentifier(
-        `${toClass}${capitalize(toProperty)}`)
+        `${toClass}${capitalize(toProperty)}`
+      )
       tables.push({ tableName, statements })
       statements.push(`table.increments('id').primary()`)
       statements.push(deindent`
@@ -201,10 +228,12 @@ function padDate(segment) {
 // like "moment.js".
 function getTimestamp() {
   const d = new Date()
-  return d.getFullYear().toString() +
+  return (
+    d.getFullYear().toString() +
     padDate(d.getMonth() + 1) +
     padDate(d.getDate()) +
     padDate(d.getHours()) +
     padDate(d.getMinutes()) +
     padDate(d.getSeconds())
+  )
 }

package/src/cli/db/migrate.js

@@ -2,9 +2,11 @@ import pico from 'picocolors'
 
 export async function migrate(knex) {
   const [batch, log] = await knex.migrate.latest()
-  console.info(log.length === 0
-    ? pico.cyan('Already up to date')
-    : pico.green(`Batch ${batch} run: ${log.length} migrations\n`) +
-      pico.cyan(log.join('\n')))
+  console.info(
+    log.length === 0
+      ? pico.cyan('Already up to date')
+      : pico.green(`Batch ${batch} run: ${log.length} migrations\n`) +
+        pico.cyan(log.join('\n'))
+  )
   return true
 }

package/src/cli/db/reset.js

@@ -10,11 +10,14 @@ export async function reset(knex) {
     batches.push(batch)
     migrations.push(...log)
   }
-  console.info(migrations.length === 0
-    ? pico.cyan('Already at the base migration')
-    : pico.green(`${batches.length > 1 ? 'Batches' : 'Batch'} ${batches} ` +
-      `rolled back: ${migrations.length} migrations\n`) +
-      pico.cyan(migrations.join('\n')))
+  console.info(
+    migrations.length === 0
+      ? pico.cyan('Already at the base migration')
+      : pico.green(
+          `${batches.length > 1 ? 'Batches' : 'Batch'} ${batches} ` +
+          `rolled back: ${migrations.length} migrations\n`
+        ) + pico.cyan(migrations.join('\n'))
+  )
   await migrate(knex)
   return true
 }

package/src/cli/db/rollback.js

@@ -2,9 +2,11 @@ import pico from 'picocolors'
 
 export async function rollback(knex) {
   const [batch, log] = await knex.migrate.rollback()
-  console.info(log.length === 0
-    ? pico.cyan('Already at the base migration')
-    : pico.green(`Batch ${batch} rolled back: ${log.length} migrations\n`) +
-      pico.cyan(log.join('\n')))
+  console.info(
+    log.length === 0
+      ? pico.cyan('Already at the base migration')
+      : pico.green(`Batch ${batch} rolled back: ${log.length} migrations\n`) +
+        pico.cyan(log.join('\n'))
+  )
   return true
 }

package/src/cli/db/seed.js

@@ -25,9 +25,10 @@ export async function seed(app) {
       const seed = object.default || object
       // Try to determine the related model from the seed name, and use it also
       // to determine seed sequence based on its index in `app.models`.
-      const modelClass =
+      const modelClass = (
         app.models[name] ||
         app.models[camelize(pluralize.singular(name), true)]
+      )
       const index = modelClass ? modelIndices[modelClass.name] : Infinity
       seeds.push({
         base,

package/src/cli/index.js

@@ -26,7 +26,7 @@ function setSilent(silent) {
 async function execute() {
   try {
     // Dynamically load app or config from the path provided package.json script
-    const [,, command, importPath, ...args] = process.argv
+    const [, , command, importPath, ...args] = process.argv
     const execute = command && getCommand(commands, command.split(':'))
     if (!isFunction(execute)) {
       throw new Error(`Unknown command: ${command}`)

package/src/controllers/AdminController.js

@@ -3,9 +3,7 @@ import Koa from 'koa'
 import serve from 'koa-static'
 import { defineConfig, createServer } from 'vite'
 import createVuePlugin from '@vitejs/plugin-vue'
-import {
-  viteCommonjs as createCommonJsPlugin
-} from '@originjs/vite-plugin-commonjs'
+import { viteCommonjs as createCommonJsPlugin } from '@originjs/vite-plugin-commonjs'
 import { testModuleIdentifier, getPostCssConfig } from '@ditojs/build'
 import { merge } from '@ditojs/utils'
 import { Controller } from './Controller.js'
@@ -28,8 +26,9 @@ export class AdminController extends Controller {
     // If no mode is specified, use `production` since that's just the hosting
     // of the pre-built admin files. `development` serves the admin directly
     // sources with HRM, and thus should be explicitly activated.
-    this.mode = this.config.mode || (
-      this.app.config.env === 'development' ? 'development' : 'production'
+    this.mode = (
+      this.config.mode ||
+      (this.app.config.env === 'development' ? 'development' : 'production')
     )
     this.closed = false
   }
@@ -38,11 +37,16 @@ export class AdminController extends Controller {
     const { config } = this
     let str = config[name]
     if (config.build?.path || config.dist?.path) {
-      deprecate(`config.admin.build.path and config.admin.dist.path are deprecated. Use config.admin.root and config.admin.dist instead.`)
+      deprecate(
+        `config.admin.build.path and config.admin.dist.path are deprecated. Use config.admin.root and config.admin.dist instead.`
+      )
 
-      str = name === 'root' ? config.build?.path
-        : name === 'dist' ? config.dist?.path
-        : null
+      str =
+        name === 'root'
+          ? config.build?.path
+          : name === 'dist'
+            ? config.dist?.path
+            : null
     }
     if (!str) {
       throw new ControllerError(
@@ -156,9 +160,11 @@ export class AdminController extends Controller {
       }
     })
 
-    this.koa.use(handleConnectMiddleware(server.middlewares, {
-      expandMountPath: true
-    }))
+    this.koa.use(
+      handleConnectMiddleware(server.middlewares, {
+        expandMountPath: true
+      })
+    )
   }
 
   getViteConfig(config = {}) {
@@ -169,85 +175,93 @@ export class AdminController extends Controller {
     const base = `${this.url}/`
     const views = path.join(root, 'views')
 
-    return defineConfig(merge({
-      root,
-      base,
-      mode: this.mode,
-      envFile: false,
-      configFile: false,
-      plugins: [
-        createVuePlugin(),
-        createCommonJsPlugin(),
+    return defineConfig(
+      merge(
         {
-          // Private plugin to inject script tag above main module that loads
-          // the `dito` object through its own end-point, see `sendDitoObject()`
-          name: 'inject-dito-object',
-          transformIndexHtml: {
-            enforce: 'post',
-            transform(html) {
-              return html.replace(
-                /(\s*)(<script type="module"[^>]*?><\/script>)/,
-                `$1<script src="${base}dito.js"></script>$1$2`
-              )
-            }
-          }
-        }],
-      build: {
-        ...(!development && {
-          outDir: this.getPath('dist'),
-          assetsDir: '.',
-          emptyOutDir: true,
-          chunkSizeWarningLimit: 1000,
-          rollupOptions: {
-            output: {
-              manualChunks(id) {
-                if (id.startsWith(views)) {
-                  return 'views'
-                } else if (id.startsWith(cwd)) {
-                  return 'common'
-                } else {
-                  const module = (
-                    id.match(/node_modules\/((?:@[^/]*\/)?[^/$]*)/)?.[1] || ''
+          root,
+          base,
+          mode: this.mode,
+          envFile: false,
+          configFile: false,
+          plugins: [
+            createVuePlugin(),
+            createCommonJsPlugin(),
+            {
+              // Private plugin to inject script tag above main module that
+              // loads the `dito` object through its own end-point, see:
+              // `sendDitoObject()`
+              name: 'inject-dito-object',
+              transformIndexHtml: {
+                enforce: 'post',
+                transform(html) {
+                  return html.replace(
+                    /(\s*)(<script type="module"[^>]*?><\/script>)/,
+                    `$1<script src="${base}dito.js"></script>$1$2`
                   )
-                  return testModuleIdentifier(module, coreDependencies)
-                    ? 'core'
-                    : 'vendor'
                 }
               }
             }
-          }
-        })
-      },
-      css: {
-        postcss: getPostCssConfig()
-      },
-      optimizeDeps: {
-        exclude: development ? ditoPackages : [],
-        include: [
-          ...(development
-            // https://discuss.prosemirror.net/t/rangeerror-adding-different-instances-of-a-keyed-plugin-plugin/4242/13
-            ? [
-              'prosemirror-state',
-              'prosemirror-transform',
-              'prosemirror-model',
-              'prosemirror-view'
+          ],
+          build: {
+            ...(!development && {
+              outDir: this.getPath('dist'),
+              assetsDir: '.',
+              emptyOutDir: true,
+              chunkSizeWarningLimit: 1000,
+              rollupOptions: {
+                output: {
+                  manualChunks(id) {
+                    if (id.startsWith(views)) {
+                      return 'views'
+                    } else if (id.startsWith(cwd)) {
+                      return 'common'
+                    } else {
+                      const module = id.match(
+                        /node_modules\/((?:@[^/]*\/)?[^/$]*)/
+                      )?.[1] || ''
+                      return testModuleIdentifier(module, coreDependencies)
+                        ? 'core'
+                        : 'vendor'
+                    }
+                  }
+                }
+              }
+            })
+          },
+          css: {
+            postcss: getPostCssConfig()
+          },
+          optimizeDeps: {
+            exclude: development ? ditoPackages : [],
+            include: [
+              ...(
+                development
+                  ? // https://discuss.prosemirror.net/t/rangeerror-adding-different-instances-of-a-keyed-plugin-plugin/4242/13
+                    [
+                      'prosemirror-state',
+                      'prosemirror-transform',
+                      'prosemirror-model',
+                      'prosemirror-view'
+                    ]
+                  : ditoPackages
+              ),
+              ...nonEsmDependencies
+            ]
+          },
+          resolve: {
+            extensions: ['.js', '.json', '.vue'],
+            preserveSymlinks: true,
+            alias: [
+              {
+                find: '@',
+                replacement: root
+              }
             ]
-            : ditoPackages
-          ),
-          ...nonEsmDependencies
-        ]
-      },
-      resolve: {
-        extensions: ['.js', '.json', '.vue'],
-        preserveSymlinks: true,
-        alias: [
-          {
-            find: '@',
-            replacement: root
           }
-        ]
-      }
-    }, config))
+        },
+        config
+      )
+    )
   }
 }