velocious 1.0.99 → 1.0.101

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

@@ -0,0 +1,117 @@
+import Record from "../../../../src/database/record/index.js"
+
+export default class TaskBase 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 | 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()) }
+
+  description() { return this.readAttribute("description") }
+
+  setDescription(newValue) { return this._setColumnAttribute("description", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasDescription() { return this._hasAttribute(this.description()) }
+
+  /**
+   * @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/user.js

@@ -0,0 +1,170 @@
+import Record from "../../../../src/database/record/index.js"
+
+export default class UserBase 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}
+   */
+  email() { return this.readAttribute("email") }
+
+  /**
+   * @param {string} newValue
+   * @returns {void}
+   */
+  setEmail(newValue) { return this._setColumnAttribute("email", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasEmail() { return this._hasAttribute(this.email()) }
+
+  /**
+   * @returns {string}
+   */
+  encryptedPassword() { return this.readAttribute("encryptedPassword") }
+
+  /**
+   * @param {string} newValue
+   * @returns {void}
+   */
+  setEncryptedPassword(newValue) { return this._setColumnAttribute("encryptedPassword", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasEncryptedPassword() { return this._hasAttribute(this.encryptedPassword()) }
+
+  /**
+   * @returns {string | null}
+   */
+  reference() { return this.readAttribute("reference") }
+
+  /**
+   * @param {string | null} newValue
+   * @returns {void}
+   */
+  setReference(newValue) { return this._setColumnAttribute("reference", newValue) }
+
+  /**
+   * @returns {boolean}
+   */
+  hasReference() { return this._hasAttribute(this.reference()) }
+
+  /**
+   * @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}
+   */
+  createdProject() { return this.getRelationshipByName("createdProject").loaded() }
+
+  /**
+   * @abstract
+   * @param {Record<string, any>} attributes
+   * @returns {import("../models/project.js").default}
+   */
+  buildCreatedProject(attributes) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @abstract
+   * @returns {Promise<void>}
+   */
+  loadCreatedProject() { throw new Error("Not implemented") }
+
+  /**
+   * @abstract
+   * @param {import("../models/project.js").default} newModel
+   * @returns {void}
+   */
+  setCreatedProject(newModel) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @returns {import("velocious/src/database/query/index.js").default<import("../models/authentication-token.js").default>}
+   */
+  authenticationTokens() { return this.getRelationshipByName("authenticationTokens") }
+
+  /**
+   * @returns {Array<import("../models/authentication-token.js").default>}
+   */
+  authenticationTokensLoaded() { return this.getRelationshipByName("authenticationTokens").loaded() }
+
+  /**
+   * @abstract
+   * @returns {Promise<void>}
+   */
+  loadAuthenticationTokens() { throw new Error("Not implemented") }
+
+  /**
+   * @abstract
+   * @param {Array<import("../models/authentication-token.js").default>} newModels
+   * @returns {void}
+   */
+  setAuthenticationTokens(newModels) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+
+  /**
+   * @returns {import("velocious/src/database/query/index.js").default<import("../models/project.js").default>}
+   */
+  createdProjects() { return this.getRelationshipByName("createdProjects") }
+
+  /**
+   * @returns {Array<import("../models/project.js").default>}
+   */
+  createdProjectsLoaded() { return this.getRelationshipByName("createdProjects").loaded() }
+
+  /**
+   * @abstract
+   * @returns {Promise<void>}
+   */
+  loadCreatedProjects() { throw new Error("Not implemented") }
+
+  /**
+   * @abstract
+   * @param {Array<import("../models/project.js").default>} newModels
+   * @returns {void}
+   */
+  setCreatedProjects(newModels) { throw new Error("Not implemented") } // eslint-disable-line no-unused-vars
+}

package/spec/dummy/src/models/account.js

@@ -1,6 +1,6 @@
-import DatabaseRecord from "../../../../src/database/record/index.js"
+import AccountBase from "../model-bases/account.js"
 
-class Account extends DatabaseRecord {
+class Account extends AccountBase {
 }
 
 Account.setDatabaseIdentifier("mssql")

package/spec/dummy/src/models/authentication-token.js

@@ -1,6 +1,6 @@
-import Record from "../../../../src/database/record/index.js"
+import AuthenticationTokenBase from "../model-bases/authentication-token.js"
 
-class AuthenticationToken extends Record {
+class AuthenticationToken extends AuthenticationTokenBase {
 }
 
 AuthenticationToken.belongsTo("user")

package/spec/dummy/src/models/project-detail.js

@@ -1,6 +1,6 @@
-import DatabaseRecord from "../../../../src/database/record/index.js"
+import ProjectDetailsBase from "../model-bases/project-detail.js"
 
-class ProjectDetail extends DatabaseRecord {
+class ProjectDetail extends ProjectDetailsBase {
 }
 
 ProjectDetail.belongsTo("project")

package/spec/dummy/src/models/project.js

@@ -1,6 +1,6 @@
-import DatabaseRecord from "../../../../src/database/record/index.js"
+import ProjectBase from "../model-bases/project.js"
 
-class Project extends DatabaseRecord {
+class Project extends ProjectBase {
 }
 
 Project.belongsTo("creatingUser", {className: "User", foreignKey: "creating_user_reference", primaryKey: "reference"})

package/spec/dummy/src/models/task.js

@@ -1,6 +1,6 @@
-import Record from "../../../../src/database/record/index.js"
+import TaskBase from "../model-bases/task.js"
 
-class Task extends Record {
+class Task extends TaskBase {
 }
 
 Task.belongsTo("project")

package/spec/dummy/src/models/user.js

@@ -1,7 +1,7 @@
-import Record from "../../../../src/database/record/index.js"
+import UserBase from "../model-bases/user.js"
 import UserModule from "../../../../src/database/record/user-module.js"
 
-class User extends Record {
+class User extends UserBase {
 }
 
 User.hasOne("createdProject", {className: "Project", foreignKey: "creating_user_reference", primaryKey: "reference"})

package/src/cli/base-command.js

@@ -20,7 +20,7 @@ export default class VelociousCliBaseCommand {
   directory() { return this.getConfiguration().getDirectory() }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<void>}
    */
   execute() {

package/src/configuration.js

@@ -1,5 +1,9 @@
 // @ts-check
 
+/**
+ * @typedef {function(Record<string, import("./database/drivers/base.js").default>) : Promise<void>} WithConnectionsCallbackType
+ */
+
 import {digg} from "diggerize"
 import restArgsError from "./utils/rest-args-error.js"
 import {withTrackedStack} from "./utils/with-tracked-stack.js"
@@ -320,7 +324,7 @@ export default class VelociousConfiguration {
   }
 
   /**
-   * @param {Function} callback
+   * @param {WithConnectionsCallbackType} callback
    * @returns {Promise<void>}
    */
   async withConnections(callback) {
@@ -376,7 +380,7 @@ export default class VelociousConfiguration {
   }
 
   /**
-   * @param {Function} callback
+   * @param {WithConnectionsCallbackType} callback
    * @returns {Promise<void>}
    */
   async ensureConnections(callback) {

package/src/database/drivers/base-column.js

@@ -8,7 +8,7 @@ export default class VelociousDatabaseDriversBaseColumn {
   table = undefined
 
   /**
-   * @interface
+   * @abstract
    * @returns {boolean}
    */
   getAutoIncrement() {
@@ -16,6 +16,7 @@ export default class VelociousDatabaseDriversBaseColumn {
   }
 
   /**
+   * @abstract
    * @returns {any}
    */
   getDefault() {
@@ -60,7 +61,7 @@ export default class VelociousDatabaseDriversBaseColumn {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<Array<import("./base-columns-index.js").default>>}
    */
   getIndexes() {
@@ -68,7 +69,7 @@ export default class VelociousDatabaseDriversBaseColumn {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {number}
    */
   getMaxLength() {
@@ -76,7 +77,7 @@ export default class VelociousDatabaseDriversBaseColumn {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   getName() {
@@ -84,7 +85,7 @@ export default class VelociousDatabaseDriversBaseColumn {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {boolean}
    */
   getNull() {
@@ -99,7 +100,7 @@ export default class VelociousDatabaseDriversBaseColumn {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {boolean}
    */
   getPrimaryKey() {
@@ -131,7 +132,7 @@ export default class VelociousDatabaseDriversBaseColumn {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   getType() {

package/src/database/drivers/base-columns-index.js

@@ -43,7 +43,7 @@ export default class VelociousDatabaseDriversBaseColumnsIndex {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {import("../table-data/table-index.js").default}
    */
   getTableDataIndex() {

package/src/database/drivers/base-foreign-key.js

@@ -14,7 +14,7 @@ export default class VelociousDatabaseDriversBaseForeignKey {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   getColumnName() {
@@ -29,7 +29,7 @@ export default class VelociousDatabaseDriversBaseForeignKey {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   getName() {
@@ -44,7 +44,7 @@ export default class VelociousDatabaseDriversBaseForeignKey {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   getReferencedColumnName() {
@@ -52,7 +52,7 @@ export default class VelociousDatabaseDriversBaseForeignKey {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   getReferencedTableName() {
@@ -69,7 +69,7 @@ export default class VelociousDatabaseDriversBaseForeignKey {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   getTableName() {

package/src/database/drivers/base-table.js

@@ -19,7 +19,7 @@ export default class VelociousDatabaseDriversBaseTable {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<Array<import("./base-column.js").default>>}
    */
   getColumns() {
@@ -36,7 +36,7 @@ export default class VelociousDatabaseDriversBaseTable {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<import("./base-foreign-key.js").default[]>}
    */
   getForeignKeys() {
@@ -44,7 +44,7 @@ export default class VelociousDatabaseDriversBaseTable {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {Promise<import("./base-columns-index.js").default[]>}
    */
   getIndexes() {
@@ -52,7 +52,7 @@ export default class VelociousDatabaseDriversBaseTable {
   }
 
   /**
-   * @interface
+   * @abstract
    * @returns {string}
    */
   getName() {