@shisyamo4131/air-guard-v2-schemas 2.3.8-dev.0 → 2.3.8-dev.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shisyamo4131/air-guard-v2-schemas",
-  "version": "2.3.8-dev.0",
+  "version": "2.3.8-dev.1",
   "description": "Schemas for AirGuard V2",
   "type": "module",
   "main": "index.js",

package/src/User.js

@@ -3,6 +3,7 @@
  * @version 1.1.0
  * @author shisyamo4131
  * @update 2025-12-25 Added `tagSize` property.
+ *                    Added `updateProperties` method for updating multiple properties.
  * @update 2025-11-24 Added `companyId`, `isAdmin`, `isTemporary` property.
  *                    Changed to prevent deletion of admin users.
  *
@@ -52,6 +53,17 @@ export default class User extends FireModel {
   static collectionPath = "Users";
   static classProps = classProps;
 
+  /**
+   * Deletes the user document.
+   * - Prevents deletion if the user is an administrator.
+   * @param {Object} updateOptions - Parameters for deletion.
+   * @param {Object|null} [updateOptions.transaction=null] - Firestore transaction object (optional).
+   * @param {function|null} [updateOptions.callback=null] - Callback executed after deletion (optional).
+   * @param {string|null} [updateOptions.prefix=null] - Optional Firestore path prefix (for server side adapter).
+   * @returns {Promise<void>} Resolves when deletion is complete.
+   * @throws {Error} If deletion is attempted on an administrator account.
+   * @throws {Error} If `docId` is missing, `updateOptions.callback` is not a function, or document is undeletable.
+   */
   async delete(updateOptions = {}) {
     // Prevent deletion of administrator accounts
     if (this.isAdmin) {
@@ -59,4 +71,25 @@ export default class User extends FireModel {
     }
     await super.delete(updateOptions);
   }
+
+  /**
+   * Update document properties based on provided data.
+   * @param {Object} updateData - Key-value pairs of properties to update.
+   * @param {Object} updateOptions - Parameters for update operation.
+   * @param {Object|null} [updateOptions.transaction=null] - Firestore transaction object.
+   * @param {function|null} [updateOptions.callback=null] - Callback executed after update.
+   * @param {string|null} [updateOptions.prefix=null] - Optional Firestore path prefix.
+   * @returns {Promise<DocumentReference>} Reference to the updated document.
+   * @throws {Error} If `updateData` is not a valid object.
+   * @throws {Error} If `docId` is not set, or if `updateOptions.callback` is not a function.
+   */
+  async updateProperties(updateData = null, updateOptions = {}) {
+    if (!updateData || typeof updateData !== "object") {
+      throw new Error("updateData must be a valid object.");
+    }
+    Object.entries(updateData).forEach(([key, value]) => {
+      if (this[key] !== undefined) this[key] = value;
+    });
+    await this.update(updateOptions);
+  }
 }