velocious 1.0.430 → 1.0.431

package/src/routes/resource-route.js

@@ -0,0 +1,154 @@
+// @ts-check
+
+import BaseRoute from "./base-route.js"
+import BasicRoute from "./basic-route.js"
+import escapeStringRegexp from "escape-string-regexp"
+import * as inflection from "inflection"
+import restArgsError from "../utils/rest-args-error.js"
+import singularizeModelName from "../utils/singularize-model-name.js"
+
+class VelociousRouteResourceRoute extends BasicRoute {
+  /**
+   * Runs constructor.
+   * @param {object} args - Options object.
+   * @param {string} args.name - Name.
+   */
+  constructor({name, ...restArgs}) {
+    super()
+    restArgsError(restArgs)
+    this.name = name
+    this.regExp = new RegExp(`^(${escapeStringRegexp(name)})(.*)$`)
+    /**
+     * Narrows the runtime value to the documented type.
+      @type {Set<string>} */
+    this.collectionRouteNames = new Set()
+  }
+
+  /**
+   * Runs get.
+   * @param {string} name - Name.
+   * @param {{on?: "member" | "collection"}} [options] - Route options for scope.
+   */
+  get(name, options = {}) {
+    const {on, ...restArgs} = options || {}
+
+    restArgsError(restArgs)
+
+    if (on && on !== "member" && on !== "collection") {
+      throw new Error(`Unknown 'on' value: ${on}`)
+    }
+
+    if (on === "collection") {
+      this.collectionRouteNames.add(name)
+    }
+
+    super.get(name)
+  }
+
+  /**
+   * Runs post.
+   * @param {string} name - Name.
+   * @param {{on?: "member" | "collection"}} [options] - Route options for scope.
+   */
+  post(name, options = {}) {
+    const {on, ...restArgs} = options || {}
+
+    restArgsError(restArgs)
+
+    if (on && on !== "member" && on !== "collection") {
+      throw new Error(`Unknown 'on' value: ${on}`)
+    }
+
+    if (on === "collection") {
+      this.collectionRouteNames.add(name)
+    }
+
+    super.post(name)
+  }
+
+  getHumanPaths() {
+    return [
+      {method: "GET", action: "index", path: this.name},
+      {method: "POST", action: "create", path: this.name},
+      {method: "GET", action: "show", path: `${this.name}/\${id}`},
+      {method: "DELETE", action: "destroy", path: `${this.name}/\${id}`}
+    ]
+  }
+
+  /**
+   * Runs match with path.
+   * @param {object} args - Options object.
+   * @param {Record<string, ?>} args.params - Parameters object.
+   * @param {string} args.path - Path.
+   * @param {import("../http-server/client/request.js").default | import("../http-server/client/websocket-request.js").default} args.request - Request object.
+   * @returns {{restPath: string} | undefined} - REST path metadata for this route.
+   */
+  matchWithPath({params, path, request}) {
+    const match = path.match(this.regExp)
+
+    if (match) {
+      const [_beginnigSlash, _matchedName, restPath] = match
+
+      let action
+      const controllerName = params.controller ? `${params.controller}/${this.name}` : this.name
+      const normalizedRestPath = restPath.replace(/^\//, "")
+      let nextRestPath = normalizedRestPath
+
+      params.controller = controllerName
+
+      if (normalizedRestPath.length === 0) {
+        if (request.httpMethod() == "DELETE") {
+          action = "delete"
+        } else if (request.httpMethod() == "POST") {
+          action = "create"
+        } else {
+          action = "index"
+        }
+        nextRestPath = ""
+      } else {
+        const [collectionCandidate] = normalizedRestPath.split("/")
+
+        if (this.collectionRouteNames.has(collectionCandidate)) {
+          nextRestPath = normalizedRestPath
+        } else {
+          const idMatch = normalizedRestPath.match(/^([^/?]+)(?:\?[^/]*)?(?:\/(.*))?$/)
+
+          if (idMatch) {
+            const singularName = singularizeModelName(this.name)
+            const singularAttributeName = inflection.camelize(inflection.underscore(singularName), true)
+            const idVarName = `${singularAttributeName}Id`
+            const recordId = idMatch[1]
+            const remainingPath = idMatch[2]
+
+            params[idVarName] = recordId
+            params.id = recordId
+
+            if (remainingPath && remainingPath.length > 0) {
+              nextRestPath = remainingPath
+            } else if (request.httpMethod() == "DELETE") {
+              action = "delete"
+              nextRestPath = ""
+            } else if (request.httpMethod() == "POST") {
+              action = "create"
+              nextRestPath = ""
+            } else {
+              action = "show"
+              nextRestPath = ""
+            }
+          }
+        }
+      }
+
+      if (action) {
+        params.action = action
+      }
+
+      return {restPath: nextRestPath}
+    }
+  }
+}
+
+BaseRoute.registerRouteResourceType(VelociousRouteResourceRoute)
+
+export default VelociousRouteResourceRoute
+

package/src/routes/root-route.js

@@ -0,0 +1,11 @@
+// @ts-check
+
+import BasicRoute from "./basic-route.js"
+
+export default class VelociousRootRoute extends BasicRoute {
+  getHumanPaths() {
+    return [
+      {method: "GET", action: "index", path: "/"}
+    ]
+  }
+}

package/src/templates/configuration.js

@@ -0,0 +1,61 @@
+import AsyncTrackedMultiConnection from "velocious/build/src/database/pool/async-tracked-multi-connection.js"
+import Configuration from "velocious/build/src/configuration.js"
+import fs from "fs/promises"
+import InitializerFromRequireContext from "../../../../src/database/initializer-from-require-context.js"
+import MysqlDriver from "velocious/build/src/database/drivers/mysql/index.js"
+import path from "path"
+import requireContext from "require-context"
+
+export default new Configuration({
+  database: {
+    development: {
+      default: {
+        driver: MysqlDriver,
+        poolType: AsyncTrackedMultiConnection,
+        type: "mysql",
+        host: "mariadb",
+        username: "username",
+        password: "password",
+        database: "database_development"
+      }
+    },
+    production: {
+      default: {
+        driver: MysqlDriver,
+        poolType: AsyncTrackedMultiConnection,
+        type: "mysql",
+        host: "mariadb",
+        username: "username",
+        password: "password",
+        database: "database_production"
+      }
+    },
+    test: {
+      default: {
+        driver: MysqlDriver,
+        poolType: AsyncTrackedMultiConnection,
+        type: "mysql",
+        host: "mariadb",
+        username: "username",
+        password: "password",
+        database: "database_test"
+      }
+    }
+  },
+  cookieSecret: process.env.COOKIE_SECRET,
+  initializeModels: async ({configuration}) => {
+    const modelsPath = await fs.realpath(`${path.dirname(import.meta.dirname)}/../src/models`)
+    const requireContextModels = requireContext(modelsPath, true, /^(.+)\.js$/)
+    const initializerFromRequireContext = new InitializerFromRequireContext({requireContext: requireContextModels})
+
+    await configuration.ensureConnections({name: "Initialize models"}, async () => {
+      await initializerFromRequireContext.initialize({configuration})
+    })
+  },
+  locale: () => "en",
+  locales: ["de", "en"],
+  localeFallbacks: {
+    de: ["de", "en"],
+    en: ["en", "de"]
+  }
+})

package/src/templates/generate-migration.js

@@ -0,0 +1,11 @@
+import Migration from "velocious/build/src/database/migration/index.js"
+
+export default class __MIGRATION_NAME__ extends Migration {
+  async up() {
+    await this.execute("...")
+  }
+
+  async down() {
+    await this.execute("...")
+  }
+}

package/src/templates/generate-model.js

@@ -0,0 +1,6 @@
+import Record from "velocious/build/src/database/record/index.js"
+
+class __MODEL_NAME__ extends Record {
+}
+
+export default __MODEL_NAME__

package/src/templates/routes.js

@@ -0,0 +1,11 @@
+import Routes from "velocious/build/src/routes/index.js"
+
+const routes = new Routes()
+
+routes.draw((route) => {
+  route.resources("tasks", (route) => {
+    route.get("users")
+  })
+})
+
+export default {routes}

package/src/testing/base-expect.js

@@ -0,0 +1,17 @@
+// @ts-check
+
+export default class BaseExpect {
+  /**
+   * Runs run before.
+   * @abstract
+   * @returns {Promise<void>} - Resolves when complete.
+   */
+  async runBefore() { /* do nothing */ }
+
+  /**
+   * Runs run after.
+   * @abstract
+   * @returns {Promise<void>} - Resolves when complete.
+   */
+  async runAfter() { /* do nothing */ }
+}