@plusscommunities/pluss-core-aws 2.0.5 → 2.0.6-beta.0

package/db/auth/getSiteUserTypes.js

@@ -1,6 +1,6 @@
 const indexQuery = require("../common/indexQuery");
 
-module.exports = (site) => {
+module.exports = async (site) => {
   return new Promise((resolve, reject) => {
     const query = {
       IndexName: "UserTypesSiteIndex",
@@ -11,8 +11,8 @@ module.exports = (site) => {
     };
 
     indexQuery("usertypes", query)
-      .then((gweg) => {
-        resolve(gweg.Items);
+      .then((res) => {
+        resolve(res.Items);
       })
       .catch((error) => {
         reject(error);

package/helper/audience/getAudience.js

@@ -148,6 +148,15 @@ const getEventMatches = async (users, audienceTypeSelection) => {
   });
 };
 
+/**
+ * Retrieves the audience based on the specified criteria.
+ *
+ * @param {string} site - The site to retrieve the audience from.
+ * @param {string} audienceType - The type of audience to retrieve.
+ * @param {string | Array} audienceTypeSelection - The selection criteria for the audience.
+ * @param {boolean} [preview=true] - Indicates whether to retrieve a preview of the users in the audience.
+ * @returns {Array} - The audience that matches the specified criteria.
+ */
 module.exports = async (
   site,
   audienceType,

package/helper/users/getUserTypesByPermission.js

@@ -0,0 +1,18 @@
+const getSiteUserTypes = require("../../db/auth/getSiteUserTypes");
+
+/**
+ * Retrieves user types based on the specified site and permissions.
+ *
+ * @param {string} site - The site to retrieve user types from.
+ * @param {string[]} permissions - The permissions to filter user types by.
+ * @returns {Object[]} - An array of filtered user types.
+ */
+const getUserTypesByPermission = async (site, permissions) => {
+  const siteUserTypes = await getSiteUserTypes(site);
+  const filteredUserTypes = siteUserTypes.filter((userType) =>
+    userType.Permissions.some((permission) => permissions.includes(permission))
+  );
+  return filteredUserTypes;
+};
+
+module.exports = getUserTypesByPermission;

package/helper/users/getUsersByPermission.js

@@ -0,0 +1,23 @@
+import getUserTypesByPermission from "./getUserTypesByPermission";
+import getAudience from "../audience/getAudience";
+
+/**
+ * Retrieves users by permission.
+ *
+ * @param {string} site - The site to retrieve users from.
+ * @param {Array<string>} permissions - The permissions to filter users by.
+ * @returns {Promise<Array<object>>} - A promise that resolves to an array of users matching the given permissions.
+ */
+const getUsersByPermission = async (site, permissions) => {
+  const userTypes = await getUserTypesByPermission(site, permissions);
+  const audienceMatches = userTypes.map((ut) => {
+    return {
+      AudienceType: "UserType",
+      AudienceTypeSelection: ut.typeName,
+    };
+  });
+  const audience = await getAudience(site, "Custom", audienceMatches);
+  return audience;
+};
+
+module.exports = getUsersByPermission;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plusscommunities/pluss-core-aws",
-  "version": "2.0.5",
+  "version": "2.0.6-beta.0",
   "description": "Core extension package for Pluss Communities platform",
   "scripts": {
     "betapatch": "npm version prepatch --preid=beta",