feat(model): add findOrCreate method

Author: jlenon7

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/database",
-  "version": "5.37.0",
+  "version": "5.38.0",
   "description": "The Athenna database handler for SQL/NoSQL.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",

package.json

@@ -374,6 +374,19 @@ export abstract class Driver<Client = any, QB = any> {
     return data
   }
 
+  /**
+   * Find a value in database or create a new one if it doesn't exist.
+   */
+  public async findOrCreate<T = any>(data: Partial<T>): Promise<T> {
+    const hasValue = await this.find()
+
+    if (hasValue) {
+      return hasValue
+    }
+
+    return this.create(data)
+  }
+
   /**
    * Return a single model instance or, if no results are found,
    * execute the given closure.

src/database/drivers/Driver.ts

@@ -287,6 +287,23 @@ export class BaseModel {
     return query.findOrFail()
   }
 
+  /**
+   * Find a value in database or create a new one if it doesn't exist.
+   */
+  public static async findOrCreate<T extends typeof BaseModel>(
+    this: T,
+    where: Partial<InstanceType<T>>,
+    data: Partial<InstanceType<T>>
+  ): Promise<InstanceType<T>> {
+    const query = this.query()
+
+    if (where) {
+      query.where(where)
+    }
+
+    return query.findOrCreate(data)
+  }
+
   /**
    * Return a single data or, if no results are found,
    * execute the given closure.

src/models/BaseModel.ts

@@ -258,6 +258,19 @@ export class ModelQueryBuilder<
     return data
   }
 
+  /**
+   * Find a value in database or create a new one if it doesn't exist.
+   */
+  public async findOrCreate(data: Partial<M> = {}) {
+    const hasValue = await this.find()
+
+    if (hasValue) {
+      return hasValue
+    }
+
+    return this.create(data)
+  }
+
   /**
    * Return a single data or, if no results are found,
    * execute the given closure.