✨ feat(Model & Document): added class defination and create/data member function to Model and Document class respectively

Author: Aryaman1706

src/Document/class.ts

@@ -0,0 +1,45 @@
+import { firestore as __firestore } from "firebase-admin";
+import ObjectSchema from "../SchemaTypes/Object/class";
+import { KeyValueStore } from "../SchemaTypes/Object/types/KeyValue";
+import { DocErrorTypes as ErrorType } from "./types/error";
+import makeError from "../utils/makeError";
+
+class Document<T extends KeyValueStore = any> {
+  private __docRef: __firestore.DocumentReference<T>;
+
+  private __model: string;
+
+  private __schema: ObjectSchema<T>;
+
+  constructor(
+    docRef: __firestore.DocumentReference<T>,
+    model: string,
+    schema: ObjectSchema<T>
+  ) {
+    this.__docRef = docRef;
+    this.__model = model;
+    this.__schema = schema;
+  }
+
+  get model() {
+    return this.__model;
+  }
+
+  get schema() {
+    return this.__schema;
+  }
+
+  public data = async () => {
+    const docSnap = await this.__docRef.get().catch((err: Error) => {
+      throw makeError(ErrorType.firestore, err.message);
+    });
+
+    const docData = docSnap.data();
+    if (typeof docData === "undefined" || !docSnap.exists)
+      throw makeError(ErrorType.invalid, "Document is empty or non existant");
+
+    return docData;
+  };
+}
+
+export default Document;

src/Document/types/error.ts

@@ -0,0 +1,7 @@
+enum DocErrorTypes {
+  invalid = "Document/Invalid",
+  firestore = "Document/Firestore",
+  validation = "Document/Validation",
+}
+
+export { DocErrorTypes };

src/Model/class.ts

@@ -1,16 +1,53 @@
 import { firestore as __firestore } from "firebase-admin";
-import { KeyValueStore } from "src/SchemaTypes/Object/types/KeyValue";
+import Document from "../Document/class";
+import { KeyValueStore } from "../SchemaTypes/Object/types/KeyValue";
 import ObjectSchema from "../SchemaTypes/Object/class";
+import { ModelErrorTypes as ErrorType } from "./types/error";
+import makeError from "../utils/makeError";
 
 class Model<T extends KeyValueStore = any> {
+  private __name: string;
+
+  private __schema: ObjectSchema<T>;
+
+  private __db: __firestore.Firestore;
+
   constructor(
-    private __name: string,
-    private __schema: ObjectSchema<T>,
-    private __db: __firestore.Firestore
-  ) {}
+    name: string,
+    schema: ObjectSchema<T>,
+    firestore: __firestore.Firestore
+  ) {
+    this.__name = name;
+    this.__schema = schema;
+    this.__db = firestore;
+  }
+
+  get name() {
+    return this.__name;
+  }
+
+  get schema() {
+    return this.__schema;
+  }
+
+  public create = async (data: Partial<T>) => {
+    const { valid, value, errors } = this.__schema.validate(data);
+    if (!valid) {
+      throw makeError(ErrorType.validation, errors);
+    }
+
+    const docRef = await this.__db
+      .collection(this.__name)
+      .add(value)
+      .catch((err: Error) => {
+        throw makeError(ErrorType.firestore, err.message);
+      });
 
-  public print = () => {
-    console.log(this.__db, this.__name, this.__schema);
+    return new Document<T>(
+      docRef as __firestore.DocumentReference<T>,
+      this.__name,
+      this.__schema
+    );
   };
 }
 

src/Model/types/error.ts

@@ -0,0 +1,7 @@
+enum ModelErrorTypes {
+  firestore = "Model/Firestore",
+  validation = "Model/SchemaValidation",
+  misc = "Model/Misc",
+}
+
+export { ModelErrorTypes };

src/utils/makeError.ts

@@ -0,0 +1,10 @@
+const makeError = <T>(type: T, data: string | object) => {
+  const error = {
+    type,
+    data,
+  };
+
+  return new Error(JSON.stringify(error));
+};
+
+export default makeError;