document Base and User entities

Author: DylanBulmer

README.md

@@ -49,7 +49,7 @@ import { User } from "jsr:@codr/models@^1";
 
 ```bash
 # Clone the repo
-git clone git@github.com:CodrJS/models.git
+git clone git@github.com:CodrJS/jsr-models.git
 
 # Cache deno dependencies
 deno cache ./mod.ts 

deno.json

@@ -10,7 +10,7 @@
     "singleQuote": false
   },
   "publish": {
-    "exclude": [".github/*", "tests/*.test.ts", ".gitignore"]
+    "exclude": [".github/*", "tests/*.test.ts", ".gitignore", "coverage/*"]
   },
   "imports": {
     "@std/assert": "jsr:@std/assert@^1.0.0",

deno.lock

@@ -1 +1,26 @@
+/**
+ * @module
+ *
+ * This module consists of class entities used to collect, transform, and
+ * process data in Codr.
+ *
+ * @example
+ * ```ts
+ * import { Organization } from "@codr/models";
+ * import { ObjectId } from "bson";
+ *
+ * const org = new Organization ({
+ *   name: "Demo Organization",
+ *   domains: ["localhost:3000"],
+ *   flags: {
+ *     isActive: true,
+ *     isDeleted: false,
+ *     isDemo: true,
+ *   },
+ *   slug: "demo",
+ *   createdBy: new ObjectId(),
+ * })
+ * ```
+ */
+
 export * from "./src/mod.ts";

mod.ts

@@ -1,27 +1,2 @@
-/**
- * @module
- *
- * This module consists of class entities used to collect, transform, and
- * process data in Codr.
- *
- * @example
- * ```ts
- * import { Organization } from "@codr/models";
- * import { ObjectId } from "bson";
- *
- * const org = new Organization ({
- *   name: "Demo Organization",
- *   domains: ["localhost:3000"],
- *   flags: {
- *     isActive: true,
- *     isDeleted: false,
- *     isDemo: true,
- *   },
- *   slug: "demo",
- *   createdBy: new ObjectId(),
- * })
- * ```
- */
-
 // export * as Types from "./types/mod.ts";
 export * from "./models/mod.ts";

src/mod.ts

@@ -24,7 +24,7 @@ export class Annotation extends Base<"Annotation"> {
     value,
     annotatedBy,
     _id,
-    __v,
+    _version,
     createdAt,
     updatedAt,
     createdBy,
@@ -38,7 +38,7 @@ export class Annotation extends Base<"Annotation"> {
     | "sampleId"
     | "value"
   >) {
-    super({ _id, __v, createdAt, updatedAt, createdBy, updatedBy });
+    super({ _id, _version, createdAt, updatedAt, createdBy, updatedBy });
     this.projectId = projectId;
     this.datasetId = datasetId;
     this.value = value;

src/models/Annotation.ts

@@ -21,13 +21,13 @@ export class Authorization extends Base<"Authorization"> {
     userId,
     roleId = [],
     _id,
-    __v,
+    _version,
     createdAt,
     updatedAt,
     createdBy,
     updatedBy,
   }: AtLeast<IAuthorization, "createdBy" | "userId">) {
-    super({ _id, __v, createdAt, updatedAt, createdBy, updatedBy });
+    super({ _id, _version, createdAt, updatedAt, createdBy, updatedBy });
     this.userId = userId;
     this.roleId = roleId;
   }

src/models/Authorization.ts

@@ -1,46 +1,60 @@
 import { ObjectId } from "bson";
 import type { AtLeast } from "../types/mod.ts";
 
+/**
+ * Base entity parameters for all database entities.
+ */
 export interface IBase<Kind extends string> {
+  /** Typescript annotation for permissioning/authorization purposes. */
   readonly kind: Kind;
-  __v?: number;
+  /** Entity version stored in the database. */
+  _version?: number;
+  /** Entity identifier stored in the database. */
   _id: ObjectId;
+  /** Entity created date. */
   createdAt: Date;
+  /** Entity unpdated date. */
   updatedAt: Date;
+  /** Entity created by {@link User} id. */
   createdBy: ObjectId;
+  /** Entity updated by {@link User} id. */
   updatedBy: ObjectId;
 }
 
 export class Base<K extends string> {
-  readonly __v: IBase<K>["__v"];
+  readonly _version: IBase<K>["_version"];
   readonly _id: IBase<K>["_id"];
-  readonly createdAt: Date;
-  readonly updatedAt: Date;
-  readonly createdBy: ObjectId;
-  readonly updatedBy: ObjectId;
+  readonly createdAt: IBase<K>["createdAt"];
+  readonly updatedAt: IBase<K>["updatedAt"];
+  readonly createdBy: IBase<K>["createdBy"];
+  readonly updatedBy: IBase<K>["updatedBy"];
 
   constructor({
     createdAt,
     updatedAt,
     createdBy,
     updatedBy,
     _id,
-    __v,
+    _version = 0,
   }: AtLeast<IBase<K>, "createdBy">) {
-    this.__v = __v;
+    this._version = _version;
     this._id = _id || new ObjectId();
 
-    const now = new Date(Date.now());
+    const now = new Date();
     this.createdAt = createdAt || now;
     this.updatedAt = updatedAt || now;
 
     this.createdBy = createdBy;
     this.updatedBy = updatedBy || createdBy;
   }
 
+  /**
+   * Transforms the base class object into a json object. Useful for saving the entity to the database.
+   * @returns a json representation of the base entity.
+   */
   toJSON(): Omit<IBase<K>, "kind"> {
     return {
-      __v: this.__v,
+      _version: this._version,
       _id: this._id,
       createdAt: this.createdAt,
       updatedAt: this.updatedAt,

src/models/Base.ts

@@ -17,7 +17,7 @@ export class Dataset extends Base<"Dataset"> {
     flags,
     projectId,
     _id,
-    __v,
+    _version,
     createdAt,
     updatedAt,
     name,
@@ -26,7 +26,7 @@ export class Dataset extends Base<"Dataset"> {
   }: AtLeast<IDataset, "createdBy" | "name" | "flags" | "projectId">) {
     super({
       _id,
-      __v,
+      _version,
       createdAt,
       updatedAt,
       createdBy,

src/models/Dataset.ts

@@ -34,13 +34,13 @@ export class Group<
     members,
     flags,
     _id,
-    __v,
+    _version,
     createdAt,
     updatedAt,
     createdBy,
     updatedBy,
   }: AtLeast<IGroup<K, F>, "createdBy" | "name" | "members" | "flags">) {
-    super({ _id, __v, createdAt, updatedAt, createdBy, updatedBy });
+    super({ _id, _version, createdAt, updatedAt, createdBy, updatedBy });
     this.name = name;
     this.members = members;
     this.flags = flags;