@fsvreddit/fsv-devvit-web-helpers 0.2.2 → 0.2.4

package/LICENSE

@@ -1,28 +1,28 @@
-BSD 3-Clause License
-
-Copyright (c) 2024, fsv
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
-   list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
-   this list of conditions and the following disclaimer in the documentation
-   and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
-   contributors may be used to endorse or promote products derived from
-   this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+BSD 3-Clause License
+
+Copyright (c) 2024, fsv
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/extendedDevvit/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./crowdControl.js";
 export * from "./extendedDevvit.js";
+export * from "./userExtended.js";
+export * from "./userSocialLinks.js";

package/dist/extendedDevvit/index.js

@@ -16,3 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./crowdControl.js"), exports);
 __exportStar(require("./extendedDevvit.js"), exports);
+__exportStar(require("./userExtended.js"), exports);
+__exportStar(require("./userSocialLinks.js"), exports);

package/dist/redditAPI/users.d.ts

@@ -1,2 +1,10 @@
-import { User } from "@devvit/web/server";
+import { ModeratorPermission, User } from "@devvit/web/server";
 export declare function getUserOrUndefined(username: string): Promise<User | undefined>;
+export declare function isModerator(subredditName: string, username: string): Promise<boolean>;
+export declare function isBanned(subredditName: string, username: string): Promise<boolean>;
+export declare function isContributor(subredditName: string, username: string): Promise<boolean>;
+export declare function hasPermissions(opts: {
+    subredditName: string;
+    username: string;
+    requiredPerms: ModeratorPermission[];
+}): Promise<boolean>;

package/dist/redditAPI/users.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUserOrUndefined = getUserOrUndefined;
+exports.isModerator = isModerator;
+exports.isBanned = isBanned;
+exports.isContributor = isContributor;
+exports.hasPermissions = hasPermissions;
 const server_1 = require("@devvit/web/server");
 async function getUserOrUndefined(username) {
     let user;
@@ -12,3 +16,32 @@ async function getUserOrUndefined(username) {
     }
     return user;
 }
+async function isModerator(subredditName, username) {
+    const modList = await server_1.reddit.getModerators({
+        subredditName,
+        username,
+    }).all();
+    return modList.length > 0;
+}
+async function isBanned(subredditName, username) {
+    const banList = await server_1.reddit.getBannedUsers({
+        subredditName,
+        username,
+    }).all();
+    return banList.length > 0;
+}
+async function isContributor(subredditName, username) {
+    const contributorList = await server_1.reddit.getApprovedUsers({
+        subredditName,
+        username,
+    }).all();
+    return contributorList.length > 0;
+}
+async function hasPermissions(opts) {
+    const user = await server_1.reddit.getUserByUsername(opts.username);
+    const permissions = await user?.getModPermissionsForSubreddit(opts.subredditName);
+    if (!permissions) {
+        return false;
+    }
+    return permissions.includes("all") || opts.requiredPerms.every(perm => permissions.includes(perm));
+}

package/dist/triggers/duplicateEventMitigation.d.ts

@@ -0,0 +1,10 @@
+interface TriggerLockOptions {
+    expiration?: Date;
+    verboseLogs?: boolean;
+}
+export declare function hasEventBeenHandled(identifier: string, opts?: TriggerLockOptions): Promise<boolean>;
+/**
+ * @deprecated Use `hasEventBeenHandled` instead.
+ */
+export declare function hasTriggerBeenHandled(identifier: string, opts?: TriggerLockOptions): Promise<boolean>;
+export {};

package/dist/triggers/duplicateEventMitigation.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasEventBeenHandled = hasEventBeenHandled;
+exports.hasTriggerBeenHandled = hasTriggerBeenHandled;
+const server_1 = require("@devvit/web/server");
+const date_fns_1 = require("date-fns");
+const redis_1 = require("../redis");
+async function hasEventBeenHandled(identifier, opts) {
+    const redisKey = `triggerLock:${identifier}`;
+    const expiration = opts?.expiration ?? (0, date_fns_1.addDays)(new Date(), 1);
+    const newVal = await server_1.redis.incrBy(redisKey, 1);
+    await (0, redis_1.expireKeyAt)(redisKey, expiration);
+    return newVal > 1;
+}
+/**
+ * @deprecated Use `hasEventBeenHandled` instead.
+ */
+async function hasTriggerBeenHandled(identifier, opts) {
+    return hasEventBeenHandled(identifier, opts);
+}

package/dist/triggers/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./duplicateTriggerMitigation.js";
+export * from "./duplicateEventMitigation.js";
 export * from "./postsAndComments.js";

package/dist/triggers/index.js

@@ -14,5 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./duplicateTriggerMitigation.js"), exports);
+__exportStar(require("./duplicateEventMitigation.js"), exports);
 __exportStar(require("./postsAndComments.js"), exports);

package/eslint.config.mjs

@@ -1,3 +1,3 @@
-import fsvconfig from "@fsvreddit/eslint-config";
-
-export default fsvconfig;
+import fsvconfig from "@fsvreddit/eslint-config";
+
+export default fsvconfig;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fsvreddit/fsv-devvit-web-helpers",
-    "version": "0.2.2",
+    "version": "0.2.4",
     "description": "Helper functions and utilities for Devvit Web apps on Reddit",
     "main": "dist/index.js",
     "scripts": {

package/tsconfig.build.json

@@ -1,15 +1,15 @@
-{
-    "extends": "./tsconfig.json",
-    "exclude": [
-        "vitest.config.ts",
-        "node_modules",
-        "tests",
-        "dist",
-        "eslint.config.mjs"
-    ],
-    "compilerOptions": {
-        "rootDir": "src",
-        "outDir": "dist",
-        "skipLibCheck": true
-    }
-}
+{
+    "extends": "./tsconfig.json",
+    "exclude": [
+        "vitest.config.ts",
+        "node_modules",
+        "tests",
+        "dist",
+        "eslint.config.mjs"
+    ],
+    "compilerOptions": {
+        "rootDir": "src",
+        "outDir": "dist",
+        "skipLibCheck": true
+    }
+}