@pgds/api-interface 1.2.5

package/utils/index.d.ts

@@ -0,0 +1,13 @@
+import { ReqUser } from "../lib/models/ReqUser";
+/**
+ * Check if a user has a specific activity.
+ * @param reqUser The user to check.
+ * @param activity The activity to check for.
+ * @param wildcardCheck If true, will check for wildcard activities (the same way as activities on endpoints are checked). Otherwise will only check for exact matches. @default true
+ */
+export declare function hasActivity(reqUser: ReqUser, activity: string, wildcardCheck?: boolean): boolean;
+export declare function isGlobal(reqUser: ReqUser): boolean;
+/**
+ * Short hand function to check if a user has the `canManageOrganization`(`CAN_MANAGE_ORGANIZATION_ACTIVITY`) activity.
+ */
+export declare function canManageOrganization(reqUser: ReqUser): boolean;

package/utils/index.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasActivity = hasActivity;
+exports.isGlobal = isGlobal;
+exports.canManageOrganization = canManageOrganization;
+var constants_1 = require("../constants");
+var mustbeConfig_1 = require("../lib/auth/mustbeConfig");
+/**
+ * Check if a user has a specific activity.
+ * @param reqUser The user to check.
+ * @param activity The activity to check for.
+ * @param wildcardCheck If true, will check for wildcard activities (the same way as activities on endpoints are checked). Otherwise will only check for exact matches. @default true
+ */
+function hasActivity(reqUser, activity, wildcardCheck) {
+    if (wildcardCheck === void 0) { wildcardCheck = true; }
+    if (wildcardCheck) {
+        return (0, mustbeConfig_1.isUserAuthorized)(reqUser.activities, activity);
+    }
+    else {
+        return isGlobal(reqUser) || !!reqUser.activities[activity];
+    }
+}
+function isGlobal(reqUser) {
+    return !!reqUser.activities[constants_1.GLOBAL_ACTIVITY];
+}
+/**
+ * Short hand function to check if a user has the `canManageOrganization`(`CAN_MANAGE_ORGANIZATION_ACTIVITY`) activity.
+ */
+function canManageOrganization(reqUser) {
+    return hasActivity(reqUser, constants_1.CAN_MANAGE_ORGANIZATION_ACTIVITY);
+}
+//# sourceMappingURL=index.js.map

package/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;AAUA,kCAMC;AAED,4BAEC;AAKD,sDAEC;AA3BD,0CAAiF;AACjF,yDAA4D;AAG5D;;;;;GAKG;AACH,SAAgB,WAAW,CAAC,OAAgB,EAAE,QAAgB,EAAE,aAA6B;IAA7B,8BAAA,EAAA,oBAA6B;IAC3F,IAAI,aAAa,EAAE,CAAC;QAClB,OAAO,IAAA,+BAAgB,EAAC,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;SAAM,CAAC;QACN,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC;AAED,SAAgB,QAAQ,CAAC,OAAgB;IACvC,OAAO,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,2BAAe,CAAC,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CAAC,OAAgB;IACpD,OAAO,WAAW,CAAC,OAAO,EAAE,4CAAgC,CAAC,CAAC;AAChE,CAAC"}