@devvit/security 0.11.4 → 0.11.5-next-2024-12-09-8401a61d8.0

package/lib/modPermissions.d.ts

@@ -1,2 +1,14 @@
-export {};
+import type { Context, ModeratorPermission } from '@devvit/public-api';
+/**
+ * currentUserHasModPermissions verifies the current user is a mod with all of
+ * permissions provided in the `permissions` argument before executing
+ * the callback function.
+ * @param context Context instance from the request
+ * @param permissions List of moderator permissions to check
+ * @param callback Function to execute if the user has the required permissions
+ * @returns Promise<void>
+ * @throws Error if the user does not have all required permissions
+ * @example currentUserHasModPermissions(context.reddit, ['all'], () => { ... });
+ */
+export declare function currentUserHasModPermissions(context: Context, permissions: ModeratorPermission[], callback: () => void): Promise<void>;
 //# sourceMappingURL=modPermissions.d.ts.map

package/lib/modPermissions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"modPermissions.d.ts","sourceRoot":"","sources":["../../src/lib/modPermissions.ts"],"names":[],"mappings":""}
+{"version":3,"file":"modPermissions.d.ts","sourceRoot":"","sources":["../../src/lib/modPermissions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAoBvE;;;;;;;;;;GAUG;AACH,wBAAsB,4BAA4B,CAChD,OAAO,EAAE,OAAO,EAChB,WAAW,EAAE,mBAAmB,EAAE,EAClC,QAAQ,EAAE,MAAM,IAAI,GACnB,OAAO,CAAC,IAAI,CAAC,CAWf"}

package/lib/modPermissions.js

@@ -1 +1,31 @@
-export {};
+import { Header } from '@devvit/shared-types/Header.js';
+// Internal function for getting the current user's moderator permissions in the current subreddit
+async function getPermissions(context) {
+    const metadataPermissions = context.debug.metadata[Header.ModPermissions]?.values;
+    if (metadataPermissions) {
+        return new Set(metadataPermissions);
+    }
+    const user = await context.reddit.getCurrentUser();
+    return new Set(context.subredditName
+        ? ((await user?.getModPermissionsForSubreddit(context.subredditName)) ?? [])
+        : []);
+}
+/**
+ * currentUserHasModPermissions verifies the current user is a mod with all of
+ * permissions provided in the `permissions` argument before executing
+ * the callback function.
+ * @param context Context instance from the request
+ * @param permissions List of moderator permissions to check
+ * @param callback Function to execute if the user has the required permissions
+ * @returns Promise<void>
+ * @throws Error if the user does not have all required permissions
+ * @example currentUserHasModPermissions(context.reddit, ['all'], () => { ... });
+ */
+export async function currentUserHasModPermissions(context, permissions, callback) {
+    const userPermissionSet = await getPermissions(context);
+    if (permissions.every((permission) => userPermissionSet.has(permission))) {
+        callback();
+        return;
+    }
+    throw new Error(`User[${context.userId}] does not have all required permissions in r/${context.subredditName}: [${permissions.join(', ')}]`);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/security",
-  "version": "0.11.4",
+  "version": "0.11.5-next-2024-12-09-8401a61d8.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -23,12 +23,12 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/public-api": "0.11.4",
-    "@devvit/shared-types": "0.11.4"
+    "@devvit/public-api": "0.11.5-next-2024-12-09-8401a61d8.0",
+    "@devvit/shared-types": "0.11.5-next-2024-12-09-8401a61d8.0"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.11.4",
-    "@devvit/tsconfig": "0.11.4",
+    "@devvit/repo-tools": "0.11.5-next-2024-12-09-8401a61d8.0",
+    "@devvit/tsconfig": "0.11.5-next-2024-12-09-8401a61d8.0",
     "eslint": "9.11.1",
     "typescript": "5.3.2",
     "vitest": "1.6.0"
@@ -37,5 +37,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "4e4f06374e9c54e277e08d75bc4b159952dc3e97"
+  "gitHead": "7bd26d3415b397d9ab9eeba1e878302bc5167a0a"
 }