@acodeninja/persist 3.0.0-next.3 → 3.0.0-next.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acodeninja/persist",
-  "version": "3.0.0-next.3",
+  "version": "3.0.0-next.4",
   "description": "A JSON based data modelling and persistence module with alternate storage mechanisms.",
   "type": "module",
   "scripts": {

package/src/engine/StorageEngine.js

@@ -95,7 +95,8 @@ export default class StorageEngine {
     /**
      * Get a model by its id
      * @param {string} modelId
-     * @return {Promise<void>}
+     * @throws {ModelNotFoundStorageEngineError}
+     * @return {Promise<Type.Model>}
      */
     get(modelId) {
         try {
@@ -106,6 +107,21 @@ export default class StorageEngine {
         return this._getModel(modelId);
     }
 
+    /**
+     *
+     * @param {Type.Model} model
+     * @throws {ModelNotRegisteredStorageEngineError}
+     * @throws {ModelNotFoundStorageEngineError}
+     */
+    async delete(model) {
+        if (!Object.keys(this.models).includes(model.constructor.name))
+            throw new ModelNotRegisteredStorageEngineError(model, this);
+
+        const currentModel = await this.get(model.id);
+
+        await this._deleteModel(currentModel.id);
+    }
+
     /**
      * Get the model constructor from a model id
      * @param {string} modelId
@@ -180,12 +196,23 @@ export default class StorageEngine {
      * @param {string} _id
      * @throws MethodNotImplementedStorageEngineError
      * @throws ModelNotFoundStorageEngineError
-     * @return Promise<void>
+     * @return Promise<Model>
      */
     _getModel(_id) {
         return Promise.reject(new MethodNotImplementedStorageEngineError('_getModel', this));
     }
 
+    /**
+     * Delete a model
+     * @param {string} _id
+     * @throws MethodNotImplementedStorageEngineError
+     * @throws ModelNotFoundStorageEngineError
+     * @return Promise<void>
+     */
+    _deleteModel(_id) {
+        return Promise.reject(new MethodNotImplementedStorageEngineError('_deleteModel', this));
+    }
+
     /**
      * Get a model's index data
      * @param {Model.constructor} _modelConstructor
@@ -239,6 +266,7 @@ export default class StorageEngine {
     }
 }
 
+
 /**
  * Decide if two models indexable fields have changed
  * @param {Type.Model} currentModel