velocious 1.0.99 → 1.0.101

package/package.json

@@ -3,7 +3,7 @@
     "velocious": "bin/velocious.js"
   },
   "name": "velocious",
-  "version": "1.0.99",
+  "version": "1.0.101",
   "main": "index.js",
   "scripts": {
     "lint": "eslint",

package/spec/database/migration/column-exists-spec.js

@@ -0,0 +1,28 @@
+// @ts-check
+
+import Dummy from "../../dummy/index.js"
+import dummyConfiguration from "../../dummy/src/config/configuration.js"
+import {describe, it} from "../../../src/testing/test.js"
+import Migration from "../../../src/database/migration/index.js"
+
+describe("database - migration", () => {
+  it("checks if a column exists", async () => {
+    await Dummy.run(async () => {
+      await dummyConfiguration.ensureConnections(async (dbs) => {
+        const migration = new Migration({
+          configuration: dummyConfiguration,
+          databaseIdentifier: "default",
+          db: dbs.default
+        })
+
+        const projectsIDExists = await migration.columnExists("projects", "id")
+
+        expect(projectsIDExists).toBe(true)
+
+        const projectsSomeNonExistingColumnExists = await migration.columnExists("projects", "some_non_existing_column")
+
+        expect(projectsSomeNonExistingColumnExists).toBe(false)
+      })
+    })
+  })
+})

package/spec/database/record/create-spec.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import Dummy from "../../dummy/index.js"
 import Project from "../../dummy/src/models/project.js"
 import Task from "../../dummy/src/models/task.js"
@@ -51,7 +53,7 @@ describe("Record - create", () => {
 
       expect(tasksRelationship.getPreloaded()).toBeTrue()
 
-      const projectTasksIDs = project.tasks().loaded().map((task) => task.id())
+      const projectTasksIDs = project.tasksLoaded().map((task) => task.id())
 
       expect(projectTasksIDs).toEqual([task.id()])
     })
@@ -65,17 +67,17 @@ describe("Record - create", () => {
 
     await project.save()
 
-    const tasks = project.tasks().loaded()
+    const tasks = project.tasksLoaded()
     const task1 = tasks.find((task) => task.name() == "Test task 1")
     const task2 = tasks.find((task) => task.name() == "Test task 2")
 
     expect(tasks.length).toEqual(2)
 
-    expect(task1.projectId()).toEqual(project.id())
-    expect(task1.project().id()).toEqual(project.id())
+    expect(task1?.projectId()).toEqual(project.id())
+    expect(task1?.project().id()).toEqual(project.id())
 
-    expect(task2.projectId()).toEqual(project.id())
-    expect(task2.project().id()).toEqual(project.id())
+    expect(task2?.projectId()).toEqual(project.id())
+    expect(task2?.project().id()).toEqual(project.id())
   })
 
   it("creates a new task with an existing project", async () => {
@@ -111,7 +113,12 @@ describe("Record - create", () => {
         throw new Error("Didnt expect to succeed")
       } catch (error) {
         expect(error).toBeInstanceOf(ValidationError)
-        expect(error.message).toEqual("Name can't be blank")
+
+        if (error instanceof Error) {
+          expect(error.message).toEqual("Name can't be blank")
+        } else {
+          throw new Error(`Expected error to be an instance of Error: ${typeof error}`)
+        }
       }
 
       const projectsCount = await Project.count()

package/spec/database/transactions-spec.js

@@ -1,3 +1,5 @@
+// @ts-check
+
 import Dummy from "../dummy/index.js"
 import dummyConfiguration from "../dummy/src/config/configuration.js"
 import Project from "../dummy/src/models/project.js"
@@ -26,7 +28,12 @@ describe("database - transactions", () => {
               })
             } catch (error) {
               expect(error).toBeInstanceOf(ValidationError)
-              expect(error.message).toEqual("Name can't be blank")
+
+              if (error instanceof Error) {
+                expect(error.message).toEqual("Name can't be blank")
+              } else {
+                throw new Error(`'error' wasn't an 'Error': ${typeof error}`)
+              }
             }
           })
         })

package/spec/dummy/src/model-bases/account.js

@@ -0,0 +1,67 @@
+import Record from "../../../../src/database/record/index.js"
+
+export default class AccountBase extends Record {
+  /**
+   * @returns {number}
+   */
+  id() { return this.readAttribute("id") }
+
+  /**
+   * @param {number} newValue
+   * @returns {void}
+   */
+  setId(newValue) { return this._setColumnAttribute("id", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasId() { return this._hasAttribute(this.id()) }
+
+  /**
+   * @returns {string | null}
+   */
+  name() { return this.readAttribute("name") }
+
+  /**
+   * @param {string | null} newValue
+   * @returns {void}
+   */
+  setName(newValue) { return this._setColumnAttribute("name", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasName() { return this._hasAttribute(this.name()) }
+
+  /**
+   * @returns {Date | null}
+   */
+  createdAt() { return this.readAttribute("createdAt") }
+
+  /**
+   * @param {Date | null} newValue
+   * @returns {void}
+   */
+  setCreatedAt(newValue) { return this._setColumnAttribute("createdAt", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasCreatedAt() { return this._hasAttribute(this.createdAt()) }
+
+  /**
+   * @returns {Date | null}
+   */
+  updatedAt() { return this.readAttribute("updatedAt") }
+
+  /**
+   * @param {Date | null} newValue
+   * @returns {void}
+   */
+  setUpdatedAt(newValue) { return this._setColumnAttribute("updatedAt", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasUpdatedAt() { return this._hasAttribute(this.updatedAt()) }
+}

package/spec/dummy/src/model-bases/authentication-token.js

@@ -0,0 +1,108 @@
+import Record from "../../../../src/database/record/index.js"
+
+export default class AuthenticationTokenBase extends Record {
+  /**
+   * @returns {number}
+   */
+  id() { return this.readAttribute("id") }
+
+  /**
+   * @param {number} newValue
+   * @returns {void}
+   */
+  setId(newValue) { return this._setColumnAttribute("id", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasId() { return this._hasAttribute(this.id()) }
+
+  /**
+   * @returns {string | null}
+   */
+  userToken() { return this.readAttribute("userToken") }
+
+  /**
+   * @param {string | null} newValue
+   * @returns {void}
+   */
+  setUserToken(newValue) { return this._setColumnAttribute("userToken", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasUserToken() { return this._hasAttribute(this.userToken()) }
+
+  /**
+   * @returns {number | null}
+   */
+  userId() { return this.readAttribute("userId") }
+
+  /**
+   * @param {number | null} newValue
+   * @returns {void}
+   */
+  setUserId(newValue) { return this._setColumnAttribute("userId", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasUserId() { return this._hasAttribute(this.userId()) }
+
+  /**
+   * @returns {Date | null}
+   */
+  createdAt() { return this.readAttribute("createdAt") }
+
+  /**
+   * @param {Date | null} newValue
+   * @returns {void}
+   */
+  setCreatedAt(newValue) { return this._setColumnAttribute("createdAt", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasCreatedAt() { return this._hasAttribute(this.createdAt()) }
+
+  /**
+   * @returns {Date | null}
+   */
+  updatedAt() { return this.readAttribute("updatedAt") }
+
+  /**
+   * @param {Date | null} newValue
+   * @returns {void}
+   */
+  setUpdatedAt(newValue) { return this._setColumnAttribute("updatedAt", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasUpdatedAt() { return this._hasAttribute(this.updatedAt()) }
+
+  /**
+   * @returns {import("../models/user.js").default}
+   */
+  user() { return this.getRelationshipByName("user").loaded() }
+
+  /**
+   * @abstract
+   * @param {Record<string, any>} attributes
+   * @returns {import("../models/user.js").default}
+   */
+  buildUser(attributes) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @abstract
+   * @returns {Promise<void>}
+   */
+  loadUser() { throw new Error("Not implemented") }
+
+  /**
+   * @abstract
+   * @param {import("../models/user.js").default} newModel
+   * @returns {void}
+   */
+  setUser(newModel) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+}

package/spec/dummy/src/model-bases/project-detail.js

@@ -0,0 +1,101 @@
+import Record from "../../../../src/database/record/index.js"
+
+export default class ProjectDetailBase extends Record {
+  /**
+   * @returns {number}
+   */
+  id() { return this.readAttribute("id") }
+
+  /**
+   * @param {number} newValue
+   * @returns {void}
+   */
+  setId(newValue) { return this._setColumnAttribute("id", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasId() { return this._hasAttribute(this.id()) }
+
+  /**
+   * @returns {number}
+   */
+  projectId() { return this.readAttribute("projectId") }
+
+  /**
+   * @param {number} newValue
+   * @returns {void}
+   */
+  setProjectId(newValue) { return this._setColumnAttribute("projectId", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasProjectId() { return this._hasAttribute(this.projectId()) }
+
+  note() { return this.readAttribute("note") }
+
+  setNote(newValue) { return this._setColumnAttribute("note", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasNote() { return this._hasAttribute(this.note()) }
+
+  /**
+   * @returns {Date | null}
+   */
+  createdAt() { return this.readAttribute("createdAt") }
+
+  /**
+   * @param {Date | null} newValue
+   * @returns {void}
+   */
+  setCreatedAt(newValue) { return this._setColumnAttribute("createdAt", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasCreatedAt() { return this._hasAttribute(this.createdAt()) }
+
+  /**
+   * @returns {Date | null}
+   */
+  updatedAt() { return this.readAttribute("updatedAt") }
+
+  /**
+   * @param {Date | null} newValue
+   * @returns {void}
+   */
+  setUpdatedAt(newValue) { return this._setColumnAttribute("updatedAt", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasUpdatedAt() { return this._hasAttribute(this.updatedAt()) }
+
+  /**
+   * @returns {import("../models/project.js").default}
+   */
+  project() { return this.getRelationshipByName("project").loaded() }
+
+  /**
+   * @abstract
+   * @param {Record<string, any>} attributes
+   * @returns {import("../models/project.js").default}
+   */
+  buildProject(attributes) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @abstract
+   * @returns {Promise<void>}
+   */
+  loadProject() { throw new Error("Not implemented") }
+
+  /**
+   * @abstract
+   * @param {import("../models/project.js").default} newModel
+   * @returns {void}
+   */
+  setProject(newModel) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+}

package/spec/dummy/src/model-bases/project-translation.js

@@ -0,0 +1,124 @@
+import Record from "../../../../src/database/record/index.js"
+
+export default class ProjectTranslationBase extends Record {
+  /**
+   * @returns {number}
+   */
+  id() { return this.readAttribute("id") }
+
+  /**
+   * @param {number} newValue
+   * @returns {void}
+   */
+  setId(newValue) { return this._setColumnAttribute("id", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasId() { return this._hasAttribute(this.id()) }
+
+  /**
+   * @returns {number}
+   */
+  projectId() { return this.readAttribute("projectId") }
+
+  /**
+   * @param {number} newValue
+   * @returns {void}
+   */
+  setProjectId(newValue) { return this._setColumnAttribute("projectId", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasProjectId() { return this._hasAttribute(this.projectId()) }
+
+  /**
+   * @returns {string}
+   */
+  locale() { return this.readAttribute("locale") }
+
+  /**
+   * @param {string} newValue
+   * @returns {void}
+   */
+  setLocale(newValue) { return this._setColumnAttribute("locale", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasLocale() { return this._hasAttribute(this.locale()) }
+
+  /**
+   * @returns {string | null}
+   */
+  name() { return this.readAttribute("name") }
+
+  /**
+   * @param {string | null} newValue
+   * @returns {void}
+   */
+  setName(newValue) { return this._setColumnAttribute("name", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasName() { return this._hasAttribute(this.name()) }
+
+  /**
+   * @returns {Date | null}
+   */
+  createdAt() { return this.readAttribute("createdAt") }
+
+  /**
+   * @param {Date | null} newValue
+   * @returns {void}
+   */
+  setCreatedAt(newValue) { return this._setColumnAttribute("createdAt", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasCreatedAt() { return this._hasAttribute(this.createdAt()) }
+
+  /**
+   * @returns {Date | null}
+   */
+  updatedAt() { return this.readAttribute("updatedAt") }
+
+  /**
+   * @param {Date | null} newValue
+   * @returns {void}
+   */
+  setUpdatedAt(newValue) { return this._setColumnAttribute("updatedAt", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasUpdatedAt() { return this._hasAttribute(this.updatedAt()) }
+
+  /**
+   * @returns {import("../models/project.js").default}
+   */
+  project() { return this.getRelationshipByName("project").loaded() }
+
+  /**
+   * @abstract
+   * @param {Record<string, any>} attributes
+   * @returns {import("../models/project.js").default}
+   */
+  buildProject(attributes) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @abstract
+   * @returns {Promise<void>}
+   */
+  loadProject() { throw new Error("Not implemented") }
+
+  /**
+   * @abstract
+   * @param {import("../models/project.js").default} newModel
+   * @returns {void}
+   */
+  setProject(newModel) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+}

package/spec/dummy/src/model-bases/project.js

@@ -0,0 +1,178 @@
+import Record from "../../../../src/database/record/index.js"
+
+export default class ProjectBase extends Record {
+  /**
+   * @returns {number}
+   */
+  id() { return this.readAttribute("id") }
+
+  /**
+   * @param {number} newValue
+   * @returns {void}
+   */
+  setId(newValue) { return this._setColumnAttribute("id", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasId() { return this._hasAttribute(this.id()) }
+
+  /**
+   * @returns {string | null}
+   */
+  creatingUserReference() { return this.readAttribute("creatingUserReference") }
+
+  /**
+   * @param {string | null} newValue
+   * @returns {void}
+   */
+  setCreatingUserReference(newValue) { return this._setColumnAttribute("creatingUserReference", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasCreatingUserReference() { return this._hasAttribute(this.creatingUserReference()) }
+
+  /**
+   * @returns {Date | null}
+   */
+  createdAt() { return this.readAttribute("createdAt") }
+
+  /**
+   * @param {Date | null} newValue
+   * @returns {void}
+   */
+  setCreatedAt(newValue) { return this._setColumnAttribute("createdAt", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasCreatedAt() { return this._hasAttribute(this.createdAt()) }
+
+  /**
+   * @returns {Date | null}
+   */
+  updatedAt() { return this.readAttribute("updatedAt") }
+
+  /**
+   * @param {Date | null} newValue
+   * @returns {void}
+   */
+  setUpdatedAt(newValue) { return this._setColumnAttribute("updatedAt", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasUpdatedAt() { return this._hasAttribute(this.updatedAt()) }
+
+  /**
+   * @returns {string | null}
+   */
+  name() { return this._getTranslatedAttributeWithFallback("name", this._getConfiguration().getLocale()) }
+
+  /**
+   * @returns {string | null}
+   */
+  nameDe() { return this._getTranslatedAttributeWithFallback("name", "de") }
+
+  /**
+   * @returns {string | null}
+   */
+  nameEn() { return this._getTranslatedAttributeWithFallback("name", "en") }
+
+  /**
+   * @returns {import("../models/user.js").default}
+   */
+  creatingUser() { return this.getRelationshipByName("creatingUser").loaded() }
+
+  /**
+   * @abstract
+   * @param {Record<string, any>} attributes
+   * @returns {import("../models/user.js").default}
+   */
+  buildCreatingUser(attributes) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @abstract
+   * @returns {Promise<void>}
+   */
+  loadCreatingUser() { throw new Error("Not implemented") }
+
+  /**
+   * @abstract
+   * @param {import("../models/user.js").default} newModel
+   * @returns {void}
+   */
+  setCreatingUser(newModel) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @returns {import("velocious/src/database/query/index.js").default<import("../models/task.js").default>}
+   */
+  tasks() { return this.getRelationshipByName("tasks") }
+
+  /**
+   * @returns {Array<import("../models/task.js").default>}
+   */
+  tasksLoaded() { return this.getRelationshipByName("tasks").loaded() }
+
+  /**
+   * @abstract
+   * @returns {Promise<void>}
+   */
+  loadTasks() { throw new Error("Not implemented") }
+
+  /**
+   * @abstract
+   * @param {Array<import("../models/task.js").default>} newModels
+   * @returns {void}
+   */
+  setTasks(newModels) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @returns {import("../models/project-detail.js").default}
+   */
+  projectDetail() { return this.getRelationshipByName("projectDetail").loaded() }
+
+  /**
+   * @abstract
+   * @param {Record<string, any>} attributes
+   * @returns {import("../models/project-detail.js").default}
+   */
+  buildProjectDetail(attributes) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @abstract
+   * @returns {Promise<void>}
+   */
+  loadProjectDetail() { throw new Error("Not implemented") }
+
+  /**
+   * @abstract
+   * @param {import("../models/project-detail.js").default} newModel
+   * @returns {void}
+   */
+  setProjectDetail(newModel) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @returns {import("velocious/src/database/query/index.js").default<import("velocious/src/database/record/index.js").default>}
+   */
+  translations() { return this.getRelationshipByName("translations") }
+
+  /**
+   * @returns {Array<import("velocious/src/database/record/index.js").default>}
+   */
+  translationsLoaded() { return this.getRelationshipByName("translations").loaded() }
+
+  /**
+   * @abstract
+   * @returns {Promise<void>}
+   */
+  loadTranslations() { throw new Error("Not implemented") }
+
+  /**
+   * @abstract
+   * @param {Array<import("velocious/src/database/record/index.js").default>} newModels
+   * @returns {void}
+   */
+  setTranslations(newModels) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+}