Created dango, model and schema files. Began work on query schema functions.

Author: wgreco13

types_ts_readme.md renamed to datatypes_ts_readme.md

@@ -15,27 +15,28 @@ Notes:
 - Methods on Each:
     - ConvertToType - Attempts to convert the input to the given data type. Returns undefined if not possible. Null remains null.
     - ValidateType - If a type conversion is possible, returns true. If undefined is the input returns false.
-    - ValidateConstraints - General function that accepts a callback and will validate whether the raw input ran through the callback will return true or false.
+    
+    TO BE REMOVED - Will move to Query Class
+    - ValidateConstraints - General function that accepts a callback and will validate whether the raw input ran through the callback will return true or false. 
 
 Issues:
-    - Unclear right now is Classes for each Schema type is the correct path. It is also unclear of how these will relate to the overall schema that we generate. We may move some of these methods around or create new ones as it is fleshed out.
+    ~~- Unclear right now is Classes for each Schema type is the correct path. It is also unclear of how these will relate to the overall schema that we generate. We may move some of these methods around or create new ones as it is fleshed out.~~
     - Some primitive data types like number, string, booleans may need additional logic to accomodate their object forms.
     - No nested or complex data types like objects/arrays are current represented
     - No Symbols as of now
     - No Int32
     - We can split this file per data type if it becomes cumbersome
-    - Export structure not entirely clear.
+    ~~- Export structure not entirely clear.~~
 
 Complete:
     - Number
     - Decimal128
     - String
     - Boolean
-
-TODO:
     - ObjectID
     - UUID
     - Date
+
+TODO:
     - Full testing
-    - Exports
     - Comments

lib/dango.ts

@@ -0,0 +1,48 @@
+// deno-lint-ignore-file no-explicit-any
+
+/**
+ * 
+ * @description This file exports the main dango object.
+ * 
+ */
+
+import { Connection } from './connections.ts';
+import { model } from './model.ts';
+import { Schema } from './schema.ts';
+
+class Dango {
+
+  currentConnection: boolean | Connection
+  model: typeof model;
+
+  constructor() {
+    this.currentConnection = false;
+    this.model = model;
+  }
+
+  connect(connectionString: string) {
+    this.currentConnection = new Connection(connectionString)
+    this.currentConnection.connect()
+    return this.currentConnection;
+  }
+
+  disconnect() {
+    if (typeof this.currentConnection === 'boolean') {
+      if (this.currentConnection === false) {
+        throw new Error('No database connection exists to disconnect.');
+      }
+    } else {
+      this.currentConnection.disconnect();
+      this.currentConnection = false;
+      return;
+    }
+  }
+
+  schema(schemaObj: Record<string, any>) {
+    return new Schema(schemaObj);
+  }
+}
+
+const dango: Dango = new Dango();
+
+export { dango };

lib/datatypes.ts

@@ -61,11 +61,6 @@ export class SchemaNumber {
     this.valid = this.convertedValue === undefined ? false : true;
     return this.valid;
   }
-
-  validateConstraints(callback: ((arg: any) => boolean)): boolean {
-    if (typeof callback !== 'function') return false;
-    return callback(this.value)
-  }
 }
 
 export class SchemaDecimal128 {
@@ -119,11 +114,6 @@ export class SchemaDecimal128 {
     this.valid = this.convertedValue === undefined ? false : true;
     return this.valid;
   }
-
-  validateConstraints(callback: ((arg: any) => boolean)): boolean {
-    if (typeof callback !== 'function') return false;
-    return callback(this.value)
-  }
 }
 
 export class SchemaString {
@@ -175,11 +165,6 @@ export class SchemaString {
     this.valid = this.convertedValue === undefined ? false : true;
     return this.valid;
   }
-
-  validateConstraints(callback: ((arg: any) => boolean)): boolean {
-    if (typeof callback !== 'function') return false;
-    return callback(this.value)
-  }
 }
 
 export class SchemaBoolean {
@@ -268,7 +253,8 @@ export class SchemaObjectId {
     }
 
     else if (Bson.ObjectId.isValid(this.value)) {
-      this.convertedValue = this.value;
+      //TODO
+      this.convertedValue = new Bson.ObjectId(this.value);
     }
 
     return this.convertedValue;
@@ -312,7 +298,7 @@ export class SchemaUUID {
     }
 
     else if (Bson.UUID.isValid(this.value)) {
-      this.convertedValue = this.value;
+      this.convertedValue = new Bson.UUID(this.value);
     }
 
     return this.convertedValue;

lib/model.ts

@@ -0,0 +1,20 @@
+// deno-lint-ignore-file no-explicit-any
+
+import { Query } from './query.ts';
+import { Schema } from './schema.ts';
+
+export function model (dbName: string, schema: Record<string, any>) {
+  return new Model(dbName, schema);
+}
+
+class Model extends Query {
+  dbName: string;
+  schema: Schema;
+  
+  constructor(dbName: string, schema: Schema) {
+    // super(dbName, schema)
+    super(dbName);
+    this.dbName = dbName;
+    this.schema = schema;
+  }
+}

lib/query.ts

@@ -17,7 +17,7 @@ class Query {
   public collectionName: string;
   // Refactor how connection is brought in
   public connection: Connection;
-
+  // We need to add schema to the collection
   constructor(collectionName: string) {
     this.collectionName = collectionName;
     this.connection = new Connection(

lib/queryfunctions.ts

@@ -0,0 +1,44 @@
+// deno-lint-ignore-file no-explicit-any
+
+import { optionsObject } from './schema.ts'
+
+function checkDataFields(queryObject: Record<string, any>) {
+  for (const property in queryObject) {
+    if (Object.prototype.hasOwnProperty.call(this.schema.schemaMap, property) {
+      throw new Error ('Requested query object contains properties not present in the Schema.')
+    }
+  }
+  return;
+}
+
+function checkRequired(property: null | Record<string, any>, propertyName: string, propertyOptions: optionsObject) {
+  if (propertyOptions.required === true) {
+    if (property === null) {
+      throw new Error (`${propertyName} is Required by the Schema.`)
+    }
+  }
+  return true;
+}
+
+function setDefault(queryObject: Record<string, any>, propertyName: string, propertyOptions: optionsObject) {
+  if (!Object.prototype.hasOwnProperty.call(queryObject, propertyName)) {
+    queryObject[propertyName] = propertyOptions.default;
+  }
+  return true;
+}
+
+populateQuery()
+
+
+checkUnique() {
+
+}
+
+checkConstraints(callback: ((arg: any) => boolean)): boolean {
+  if (typeof callback !== 'function') return false;
+  return callback(this.value)
+}
+
+validateAgainstSchema() {
+
+}

lib/schema.ts

@@ -1,19 +1,36 @@
 // deno-lint-ignore-file no-explicit-any
-// deno-lint-allow-any-bracket-notation
 
 /**
  * 
  * @description This file defines the schema class.
  * 
  */
 
-import { SchemaNumber, SchemaDecimal128, SchemaString, SchemaBoolean, SchemaObjectId, SchemaUUID, SchemaDate } from './datatypes.ts'
+import { 
+  SchemaNumber, 
+  SchemaDecimal128, 
+  SchemaString, SchemaBoolean, 
+  SchemaObjectId, 
+  SchemaUUID, 
+  SchemaDate 
+} from './datatypes.ts'
 
 export class Schema {
 
   schemaMap: Record<string, any>;
+  types: Record<string, any>
 
   constructor(schemaObj: Record<string, any>) {
+    this.types = {
+      number: SchemaNumber,
+      decimal128: SchemaDecimal128,
+      string: SchemaString,
+      boolean: SchemaBoolean,
+      objectid: SchemaObjectId,
+      UUID: SchemaUUID,
+      date: SchemaDate,
+    }
+    
     this.schemaMap = {};    
     for (const property in schemaObj) {
       if (typeof schemaObj[property] === 'object') {
@@ -25,22 +42,6 @@ export class Schema {
       }
     }
   }
-
-  isUnique() {
-
-  }
-
-  isRequired() {
-
-  }
-
-  setDefault() {
-
-  }
-
-  isValid() {
-    
-  }
 }
 
 
@@ -73,18 +74,4 @@ class SchemaOptions {
       }
     }
   }
-}
-
-const type = {
-  number: SchemaNumber,
-  decimal128: SchemaDecimal128,
-  string: SchemaString,
-  boolean: SchemaBoolean,
-  objectid: SchemaObjectId,
-  UUID: SchemaUUID,
-  date: SchemaDate,
-}
-
-name {
-  type: dango.type.number
 }