@docbrasil/api-systemmanager 1.1.77 → 1.1.79

package/docs/admin_user.js.html

@@ -102,6 +102,46 @@ class AdminUser {
     const self = this;
     self.parent = options.parent;
     self.client = self.parent.dispatch.getClient();
+    self._orgId = null;
+  }
+
+  /**
+   * @description Set the organization ID for org-scoped API calls
+   * @param {string} orgId - Organization ID
+   * @return {AdminUser} this instance for chaining
+   * @public
+   */
+  setOrgId(orgId) {
+    this._orgId = orgId;
+    return this;
+  }
+
+  /**
+   * @description Get the base path for user admin API calls.
+   * When orgId is set, uses org-scoped endpoints.
+   * When orgId is not set, falls back to legacy admin endpoints.
+   * @return {string} base path
+   * @private
+   */
+  _basePath() {
+    if (this._orgId) {
+      return `/api/organizations/${this._orgId}/adminusers`;
+    }
+    return '/admin/users';
+  }
+
+  /**
+   * @description Get the base path for org-specific operations (groups, orgchart).
+   * When orgId is set, uses org-scoped endpoints.
+   * @param {string} orgId - Organization ID for the operation
+   * @return {string} base path
+   * @private
+   */
+  _orgPath(orgId) {
+    if (this._orgId) {
+      return `/api/organizations/${orgId}/adminusers`;
+    }
+    return `/admin/organizations/${orgId}`;
   }
 
   /**
@@ -158,7 +198,7 @@ class AdminUser {
       Joi.assert(userId, Joi.string().required());
       Joi.assert(session, Joi.string().required());
 
-      const apiCall = self.client.get(`/admin/users/${userId}`, self._setHeader(session));
+      const apiCall = self.client.get(`${self._basePath()}/${userId}`, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -229,7 +269,7 @@ class AdminUser {
       Joi.assert(session, Joi.string().required());
 
       const { userId, ...payload } = params;
-      const apiCall = self.client.put(`/admin/users/${userId}/password`, payload, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/password`, payload, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -259,7 +299,7 @@ class AdminUser {
       Joi.assert(session, Joi.string().required());
 
       const payload = { email };
-      const apiCall = self.client.post(`/admin/users/email/exist`, payload, self._setHeader(session));
+      const apiCall = self.client.post(`${self._basePath()}/email/exist`, payload, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -291,7 +331,84 @@ class AdminUser {
       Joi.assert(payload, Joi.object().required(), 'Payload to update');
       Joi.assert(session, Joi.string().required(), 'Session user admin');
 
-      const apiCall = self.client.put(`/admin/users/${userId}`, payload, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/${userId}`, payload, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Create a new user
+   * @param {object} payload User data to create
+   * @param {string} payload.name Full name (required)
+   * @param {string} payload.username Username (required)
+   * @param {string} payload.email Email (required)
+   * @param {string} payload.orgId Primary organization ID (required)
+   * @param {array} [payload.orgIds] Organization IDs
+   * @param {array} [payload.role=[2]] Security roles
+   * @param {string} [payload.password] Initial password
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Created user document
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const payload = {
+   *   name: 'Maria Silva',
+   *   username: 'maria.silva',
+   *   email: 'maria@example.com',
+   *   orgId: '5edd11c46b6ce9729c2c297c',
+   *   role: [2]
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.create(payload, session);
+   */
+  async create(payload, session) {
+    const self = this;
+
+    try {
+      Joi.assert(payload, Joi.object().required(), 'User data to create');
+      Joi.assert(payload.name, Joi.string().required(), 'Full name');
+      Joi.assert(payload.username, Joi.string().required(), 'Username');
+      Joi.assert(payload.email, Joi.string().email().required(), 'Email');
+      Joi.assert(payload.orgId, Joi.string().required(), 'Primary organization ID');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const apiCall = self.client.put(self._basePath(), payload, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Remove a user
+   * @param {string} userId User ID to remove (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Removal confirmation
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const userId = '55e4a3bd6be6b45210833fae';
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.remove(userId, session);
+   */
+  async remove(userId, session) {
+    const self = this;
+
+    try {
+      Joi.assert(userId, Joi.string().required(), 'User ID');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const apiCall = self.client.delete(`${self._basePath()}/${userId}`, self._setHeader(session));
       return self._returnData(await apiCall);
     } catch (ex) {
       throw ex;
@@ -319,7 +436,7 @@ class AdminUser {
       Joi.assert(session, Joi.string().required(), 'Session user admin');
 
       const payload = { email };
-      const apiCall = self.client.post('/admin/users/change/password', payload, self._setHeader(session));
+      const apiCall = self.client.post(`${self._basePath()}/change/password`, payload, self._setHeader(session));
 
       return self._returnData(await apiCall);
     } catch (ex) {
@@ -352,7 +469,7 @@ class AdminUser {
       Joi.assert(payload.newPassword, Joi.string().required(), 'New password');
       Joi.assert(session, Joi.string().required(), 'Session user admin');
 
-      const apiCall = self.client.put('/admin/users/change/password', payload, self._setHeader(session));
+      const apiCall = self.client.put(`${self._basePath()}/change/password`, payload, self._setHeader(session));
 
       return self._returnData(await apiCall);
     } catch (ex) {
@@ -400,13 +517,14 @@ class AdminUser {
         page = 1,
         perPage = 200,
         project = PROJECTION_DEFAULT,
-        sort = SORT_DEFAULT
+        sort = SORT_DEFAULT,
+        filter = {}
       } = params;
 
-      const payloadToSend = {$project: project, sort};
+      const payloadToSend = {$project: project, sort, ...filter};
 
-      const apiCall = self._client
-          .post(`/admin/users?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
+      const apiCall = self.client
+          .post(`${self._basePath()}?page=${page}&perPage=${perPage}`, payloadToSend, self._setHeader(session));
 
       return self._returnData(await apiCall);
 
@@ -414,6 +532,291 @@ class AdminUser {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Block a user (prevent login)
+   * @param {string} userId User ID to block (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated user
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const userId = '55e4a3bd6be6b45210833fae';
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.block(userId, session);
+   */
+  async block(userId, session) {
+    const self = this;
+
+    try {
+      Joi.assert(userId, Joi.string().required(), 'User ID');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/block`, {}, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Unblock a user (allow login)
+   * @param {string} userId User ID to unblock (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated user
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const userId = '55e4a3bd6be6b45210833fae';
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.unblock(userId, session);
+   */
+  async unblock(userId, session) {
+    const self = this;
+
+    try {
+      Joi.assert(userId, Joi.string().required(), 'User ID');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/unblock`, {}, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Block email notifications for a user
+   * @param {string} userId User ID (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated user
+   * @public
+   * @async
+   */
+  async blockEmail(userId, session) {
+    const self = this;
+
+    try {
+      Joi.assert(userId, Joi.string().required(), 'User ID');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/blockemail`, {}, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Unblock email notifications for a user
+   * @param {string} userId User ID (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated user
+   * @public
+   * @async
+   */
+  async unblockEmail(userId, session) {
+    const self = this;
+
+    try {
+      Joi.assert(userId, Joi.string().required(), 'User ID');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/unblockemail`, {}, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Update user type classification
+   * @param {object} params Parameters
+   * @param {string} params.userId User ID (required)
+   * @param {string} params.userType New user type (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated user
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { userId: '55e4a3bd6be6b45210833fae', userType: 'USER' };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.updateUserType(params, session);
+   */
+  async updateUserType(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Parameters');
+      Joi.assert(params.userId, Joi.string().required(), 'User ID');
+      Joi.assert(params.userType, Joi.string().required(), 'User type');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const { userId, userType } = params;
+      const apiCall = self.client.put(`${self._basePath()}/${userId}/type/${userType}`, {}, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get organization groups with their permissions
+   * @param {string} orgId Organization ID (required)
+   * @param {string} session JWT session token
+   * @return {Promise<array>} Array of groups with permissions
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const orgId = '5edd11c46b6ce9729c2c297c';
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const groups = await api.admin.user.getGroupsPermissions(orgId, session);
+   */
+  async getGroupsPermissions(orgId, session) {
+    const self = this;
+
+    try {
+      Joi.assert(orgId, Joi.string().required(), 'Organization ID');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const apiCall = self.client.get(
+        `${self._orgPath(orgId)}/groups/permissions`,
+        self._setHeader(session)
+      );
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Update user's group memberships in an organization
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {string} params.userId User ID (required)
+   * @param {array} params.groups Array of group IDs (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated groups
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = {
+   *   orgId: '5edd11c46b6ce9729c2c297c',
+   *   userId: '55e4a3bd6be6b45210833fae',
+   *   groups: ['groupId1', 'groupId2']
+   * };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * await api.admin.user.updateUserGroups(params, session);
+   */
+  async updateUserGroups(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Parameters');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization ID');
+      Joi.assert(params.userId, Joi.string().required(), 'User ID');
+      Joi.assert(params.groups, Joi.array().required(), 'Group IDs');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const { orgId, userId, groups } = params;
+      const apiCall = self.client.put(
+        `${self._orgPath(orgId)}/groups/${userId}`,
+        { groups },
+        self._setHeader(session)
+      );
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get organizations the admin user can manage
+   * @param {string} session JWT session token
+   * @return {Promise<array>} Array of organizations
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const orgs = await api.admin.user.getOrganizations(session);
+   */
+  async getOrganizations(session) {
+    const self = this;
+
+    try {
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const apiCall = self.client.get(`${self._basePath()}/organizations`, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Get users belonging to an organization
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {array} [params.userIds] Optional array of user IDs to filter
+   * @param {string} session JWT session token
+   * @return {Promise<array>} Array of users with id, name, email, title
+   * @public
+   * @async
+   * @example
+   *
+   * const API = require('@docbrasil/api-systemmanager');
+   * const api = new API();
+   * const params = { orgId: '5edd11c46b6ce9729c2c297c' };
+   * const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+   * const users = await api.admin.user.getOrgUsers(params, session);
+   */
+  async getOrgUsers(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Parameters');
+      Joi.assert(params.orgId, Joi.string().required(), 'Organization ID');
+      Joi.assert(session, Joi.string().required(), 'Session token');
+
+      const { orgId, userIds } = params;
+      let url = this._orgId ? `${self._orgPath(orgId)}/orgusers` : `/admin/organizations/${orgId}/orgusers`;
+      if (userIds && userIds.length > 0) {
+        url += `?userIds=${JSON.stringify(userIds)}`;
+      }
+
+      const apiCall = self.client.get(url, self._setHeader(session));
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default AdminUser;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.77",
+  "version": "1.1.79",
   "scripts": {
     "htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
     "doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",