init jsr models

Author: DylanBulmer

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024-present Dylan Bulmer
+Copyright (c) 2023-present Dylan Bulmer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,30 +1,61 @@
-# @codr/ts-jsr-template
+# @codr/models
 
 [![JSR Scope](https://jsr.io/badges/@codr)](https://jsr.io/@codr)
-[![JSR](https://jsr.io/badges/@codr/<package>)](https://jsr.io/@codr/<package>)
-[![JSR Score](https://jsr.io/badges/@codr/<package>/score)](https://jsr.io/@codr/<package>)
-[![CodeQL](https://github.com/CodrJS/ts-jsr-template/actions/workflows/codeql.yml/badge.svg)](https://github.com/CodrJS/ts-jsr-template/actions/workflows/codeql.yml)
+[![JSR](https://jsr.io/badges/@codr/models)](https://jsr.io/@codr/models)
+[![JSR Score](https://jsr.io/badges/@codr/models/score)](https://jsr.io/@codr/models)
+[![CodeQL](https://github.com/CodrJS/models/actions/workflows/codeql.yml/badge.svg)](https://github.com/CodrJS/models/actions/workflows/codeql.yml)
 
 ## Purpose
 
-Codr has the `@codr` namespace for the JavaScript Resistry (jsr). Modules
-published to JSR should by compatible for at least Node and Deno.
+This module is for defining all reusable models for Codr.
 
 ## Getting Started
 
-Click "Use this template" in Github, then "Create a new repository."
+In order to use the `@jsr` scope in npm, the `.npmrc` file needs to be updated
+with the following:
+
+```ini
+@jsr:registry=https://npm.jsr.io
+```
+
+Installing via `npm`
+
+```bash
+npx jsr add @codr/models@^1
+# or
+npm install @jsr/codr___models@^1
+```
+
+Installing via `yarn`
+
+```bash
+yarn dlx jsr add @codr/models@^1
+# or
+yarn add @jsr/codr___models@^1
+```
+
+Installing via `deno`
+
+```bash
+deno add @codr/models@^1
+```
+
+```ts
+/* or import directly */
+import { User } from "jsr:@codr/models@^1";
+```
 
 ## Contributing
 
-```shell
+```bash
 # Clone the repo
-git clone git@github.com:CodrJS/ts-jsr-template.git
+git clone git@github.com:CodrJS/models.git
 
 # Cache deno dependencies
 deno cache
 
-# Lint, format, and test the code
-deno lint
+# Format, lint, and test the code
 deno fmt
+deno lint
 deno test
 ```

deno.lock

@@ -1,2 +1,4 @@
 // export files from here.
-export { add } from "./add.ts";
+
+// export * as Types from "./types/mod.ts";
+export * from "./models/mod.ts";

src/add.ts

@@ -0,0 +1,60 @@
+import type { ObjectId } from "npm:mongodb";
+import { Base, type IBase } from "./Base.ts";
+import type { AtLeast } from "../types/mod.ts";
+
+export interface IAnnotation extends IBase<"Annotation"> {
+  projectId: ObjectId;
+  datasetId: ObjectId;
+  sampleId: ObjectId;
+  annotatedBy: ObjectId;
+  value: object;
+}
+
+export class Annotation extends Base<"Annotation"> {
+  projectId: ObjectId;
+  datasetId: ObjectId;
+  sampleId: ObjectId;
+  annotatedBy: ObjectId;
+  value: object;
+
+  constructor({
+    projectId,
+    datasetId,
+    sampleId,
+    value,
+    annotatedBy,
+    _id,
+    __v,
+    createdAt,
+    updatedAt,
+    createdBy,
+    updatedBy,
+  }: AtLeast<
+    IAnnotation,
+    | "createdBy"
+    | "projectId"
+    | "datasetId"
+    | "annotatedBy"
+    | "sampleId"
+    | "value"
+  >) {
+    super({ _id, __v, createdAt, updatedAt, createdBy, updatedBy });
+    this.projectId = projectId;
+    this.datasetId = datasetId;
+    this.value = value;
+    this.sampleId = sampleId;
+    this.annotatedBy = annotatedBy;
+  }
+
+  toJSON(): Omit<IAnnotation, "kind"> {
+    const json = super.toJSON();
+    return {
+      ...json,
+      projectId: this.projectId,
+      annotatedBy: this.annotatedBy,
+      sampleId: this.sampleId,
+      datasetId: this.datasetId,
+      value: this.value,
+    };
+  }
+}

src/mod.ts

@@ -0,0 +1,11 @@
+import type { ObjectId } from "npm:mongodb";
+import type { IBase } from "./Base.ts";
+import type { ActionCode, ResourceCode } from "../types/mod.ts";
+
+export interface IAudit<T> extends Omit<IBase<"Audit">, "createdBy"> {
+  type: ResourceCode; // Where: what system processed this event.
+  action: ActionCode; // How:   what action was taken.
+  userId: ObjectId; // Who:   which user made the change.
+  payload: Partial<T>; // What:  what data got modified (should be a diff of before/after. New entities should be complete)
+  processedAt: Date; // When:  what date/time did this occur.
+}

src/models/Annotation.ts

@@ -0,0 +1,43 @@
+import type { ObjectId } from "npm:mongodb";
+import { Base, type IBase } from "./Base.ts";
+import type { ActionCode, AtLeast, ResourceCode } from "../types/mod.ts";
+
+export interface IAuthorization extends IBase<"Authorization"> {
+  userId: ObjectId;
+  roleId: ObjectId[];
+}
+
+export interface IAuthorizationResponse {
+  userId: ObjectId;
+  roleCodes: string[];
+  grants: Partial<Record<ResourceCode, Partial<Record<ActionCode, boolean>>>>;
+}
+
+export class Authorization extends Base<"Authorization"> {
+  userId: ObjectId;
+  roleId: ObjectId[];
+
+  constructor({
+    userId,
+    roleId = [],
+    _id,
+    __v,
+    createdAt,
+    updatedAt,
+    createdBy,
+    updatedBy,
+  }: AtLeast<IAuthorization, "createdBy" | "userId">) {
+    super({ _id, __v, createdAt, updatedAt, createdBy, updatedBy });
+    this.userId = userId;
+    this.roleId = roleId;
+  }
+
+  toJSON(): Omit<IAuthorization, "kind"> {
+    const json = super.toJSON();
+    return {
+      userId: this.userId,
+      roleId: this.roleId,
+      ...json,
+    };
+  }
+}

src/models/Audit.ts

@@ -0,0 +1,51 @@
+import { ObjectId } from "npm:mongodb";
+import type { AtLeast } from "../types/mod.ts";
+
+export interface IBase<Kind extends string> {
+  readonly kind: Kind;
+  __v?: number;
+  _id: ObjectId;
+  createdAt: Date;
+  updatedAt: Date;
+  createdBy: ObjectId;
+  updatedBy: ObjectId;
+}
+
+export class Base<K extends string> {
+  readonly __v: IBase<K>["__v"];
+  readonly _id: IBase<K>["_id"];
+  readonly createdAt: Date;
+  readonly updatedAt: Date;
+  readonly createdBy: ObjectId;
+  readonly updatedBy: ObjectId;
+
+  constructor({
+    createdAt,
+    updatedAt,
+    createdBy,
+    updatedBy,
+    _id,
+    __v,
+  }: AtLeast<IBase<K>, "createdBy">) {
+    this.__v = __v;
+    this._id = _id || new ObjectId();
+
+    const now = new Date(Date.now());
+    this.createdAt = createdAt || now;
+    this.updatedAt = updatedAt || now;
+
+    this.createdBy = createdBy;
+    this.updatedBy = updatedBy || createdBy;
+  }
+
+  toJSON(): Omit<IBase<K>, "kind"> {
+    return {
+      __v: this.__v,
+      _id: this._id,
+      createdAt: this.createdAt,
+      updatedAt: this.updatedAt,
+      createdBy: this.createdBy,
+      updatedBy: this.updatedBy,
+    };
+  }
+}