@fsvreddit/fsv-devvit-web-helpers 0.1.9

package/LICENSE

@@ -0,0 +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.

package/README.md

@@ -0,0 +1 @@
+Helper utility code for Devvit apps made by u/fsv

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./redditAPI/index.js";
+export * from "./tasks/index.js";
+export * from "./triggers/index.js";

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./redditAPI/index.js"), exports);
+__exportStar(require("./tasks/index.js"), exports);
+__exportStar(require("./triggers/index.js"), exports);

package/dist/redditAPI/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./postsAndComments.js";
+export * from "./users.js";
+export * from "./wiki.js";

package/dist/redditAPI/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./postsAndComments.js"), exports);
+__exportStar(require("./users.js"), exports);
+__exportStar(require("./wiki.js"), exports);

package/dist/redditAPI/postsAndComments.d.ts

@@ -0,0 +1,3 @@
+import { Comment, Post } from "@devvit/web/server";
+import { T1, T3 } from "@devvit/web/shared";
+export declare function getPostOrCommentById(thingId: T1 | T3): Promise<Post | Comment>;

package/dist/redditAPI/postsAndComments.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPostOrCommentById = getPostOrCommentById;
+const server_1 = require("@devvit/web/server");
+const shared_1 = require("@devvit/web/shared");
+function getPostOrCommentById(thingId) {
+    if ((0, shared_1.isT1)(thingId)) {
+        return server_1.reddit.getCommentById(thingId);
+    }
+    else if ((0, shared_1.isT3)(thingId)) {
+        return server_1.reddit.getPostById(thingId);
+    }
+    else {
+        throw new Error(`Invalid thingId ${thingId}`);
+    }
+}

package/dist/redditAPI/users.d.ts

@@ -0,0 +1,2 @@
+import { User } from "@devvit/web/server";
+export declare function getUserOrUndefined(username: string): Promise<User | undefined>;

package/dist/redditAPI/users.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserOrUndefined = getUserOrUndefined;
+const server_1 = require("@devvit/web/server");
+async function getUserOrUndefined(username) {
+    let user;
+    try {
+        user = await server_1.reddit.getUserByUsername(username);
+    }
+    catch {
+        //
+    }
+    return user;
+}

package/dist/redditAPI/wiki.d.ts

@@ -0,0 +1,2 @@
+import { UpdateWikiPageOptions, WikiPage } from "@devvit/web/server";
+export declare function updateWikiPageMulti(options: UpdateWikiPageOptions): Promise<WikiPage>;

package/dist/redditAPI/wiki.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateWikiPageMulti = updateWikiPageMulti;
+const server_1 = require("@devvit/web/server");
+const marked_1 = require("marked");
+async function updateWikiPageMulti(options) {
+    const isV2WikiEnabled = await server_1.reddit.isWikiV2Enabled(server_1.context.subredditName);
+    const promises = [
+        server_1.reddit.updateWikiPage({
+            ...options,
+            wikiVersion: "v1",
+        }),
+    ];
+    if (isV2WikiEnabled) {
+        const contentHtml = await Promise.resolve((0, marked_1.marked)(options.content));
+        promises.push(server_1.reddit.updateWikiPage({
+            ...options,
+            content: contentHtml,
+            wikiVersion: "v2",
+        }));
+    }
+    return Promise.all(promises).then(results => results[0]);
+}

package/dist/redis/index.d.ts

@@ -0,0 +1 @@
+export * from "./redisHelpers.js";

package/dist/redis/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./redisHelpers.js"), exports);

package/dist/redis/redisHelpers.d.ts

@@ -0,0 +1,49 @@
+import { ZMember, ZRangeOptions } from "@devvit/web/server";
+interface RedisFieldValue {
+    field: string;
+    value: string;
+}
+/**
+ * Scans a sorted set in Redis and returns all members that match a given pattern. This function handles partial results and does multiple zScan calls if needed.
+ * @param key The key of the sorted set.
+ * @param pattern The pattern to match.
+ * @returns {ZMember[]} An array of members that match the pattern.
+ */
+export declare function zScanAll(key: string, pattern: string): Promise<ZMember[]>;
+/**
+ * Scans a hash in Redis and returns all fields that match a given pattern. This function handles partial results and does multiple hScan calls if needed.
+ * @param key The key of the hash.
+ * @param pattern The pattern to match.
+ * @returns {Record<string, string>} An object with fields that match the pattern.
+ */
+export declare function hScanAll(key: string, pattern: string): Promise<RedisFieldValue[]>;
+/**
+ * Retrieves multiple fields from a Redis hash and returns them as a record/object.
+ * @param key The key of the hash.
+ * @param fields The fields to retrieve values for
+ * @returns  {Record<string, string>} An object with field-value pairs for the specified fields.
+ */
+export declare function hMGetAsRecord(key: string, fields: string[]): Promise<Record<string, string>>;
+/**
+ * Get all entries from a hash in Redis, chunking the requests if necessary to avoid exceeding Devvit's limitations on response size.
+ * @param key The key of the hash.
+ * @param chunkSize The size of each chunk.
+ * @returns {Record<string, string>} An object with field-value pairs for the specified fields.
+ */
+export declare function hGetAllChunked(key: string, chunkSize?: number): Promise<Record<string, string>>;
+/**
+ * Returns a range of members from a sorted set in Redis as a record/object, where the keys are the members and the values are their scores.
+ * @param key The key of the sorted set.
+ * @param start The starting index (inclusive) of the range.
+ * @param stop The ending index (exclusive) of the range.
+ * @param options Optional parameters for the zRange command.
+ * @returns {Record<string, number>} A record/object with members and their scores.
+ */
+export declare function zRangeAsRecord(key: string, start: number | string, stop: number | string, options?: ZRangeOptions): Promise<Record<string, number>>;
+/**
+ * Sets an expiration time on a Redis key based on a Date object.
+ * @param key The redis key.
+ * @param expireAt The expiration date.
+ */
+export declare function expireKeyAt(key: string, expireAt: Date): Promise<void>;
+export {};

package/dist/redis/redisHelpers.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zScanAll = zScanAll;
+exports.hScanAll = hScanAll;
+exports.hMGetAsRecord = hMGetAsRecord;
+exports.hGetAllChunked = hGetAllChunked;
+exports.zRangeAsRecord = zRangeAsRecord;
+exports.expireKeyAt = expireKeyAt;
+const server_1 = require("@devvit/web/server");
+const date_fns_1 = require("date-fns");
+const lodash_es_1 = require("lodash-es");
+/**
+ * Scans a sorted set in Redis and returns all members that match a given pattern. This function handles partial results and does multiple zScan calls if needed.
+ * @param key The key of the sorted set.
+ * @param pattern The pattern to match.
+ * @returns {ZMember[]} An array of members that match the pattern.
+ */
+async function zScanAll(key, pattern) {
+    let cursor = 0;
+    const members = {};
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    while (true) {
+        const zScanResult = await server_1.redis.zScan(key, cursor, pattern, 1000);
+        // Redis scans may return the same member multiple times, so we need to deduplicate them.
+        for (const member of zScanResult.members) {
+            members[member.member] = member;
+        }
+        // Return if we reached the end of the scan or if we're stuck in a loop.
+        if (zScanResult.cursor === 0 || cursor === zScanResult.cursor) {
+            break;
+        }
+        cursor = zScanResult.cursor;
+    }
+    return Object.values(members);
+}
+/**
+ * Scans a hash in Redis and returns all fields that match a given pattern. This function handles partial results and does multiple hScan calls if needed.
+ * @param key The key of the hash.
+ * @param pattern The pattern to match.
+ * @returns {Record<string, string>} An object with fields that match the pattern.
+ */
+async function hScanAll(key, pattern) {
+    let cursor = 0;
+    const fields = {};
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+    while (true) {
+        const hScanResult = await server_1.redis.hScan(key, cursor, pattern, 1000);
+        // Redis scans may return the same field multiple times, so we need to deduplicate them.
+        for (const field of hScanResult.fieldValues) {
+            fields[field.field] = field;
+        }
+        // Return if we reached the end of the scan or if we're stuck in a loop.
+        if (hScanResult.cursor === 0 || cursor === hScanResult.cursor) {
+            break;
+        }
+        cursor = hScanResult.cursor;
+    }
+    return Object.values(fields);
+}
+/**
+ * Retrieves multiple fields from a Redis hash and returns them as a record/object.
+ * @param key The key of the hash.
+ * @param fields The fields to retrieve values for
+ * @returns  {Record<string, string>} An object with field-value pairs for the specified fields.
+ */
+async function hMGetAsRecord(key, fields) {
+    if (fields.length === 0) {
+        return {};
+    }
+    const results = {};
+    const values = await server_1.redis.hMGet(key, fields);
+    fields.forEach((field, index) => {
+        if (values[index] !== null) {
+            results[field] = values[index];
+        }
+    });
+    return results;
+}
+/**
+ * Get all entries from a hash in Redis, chunking the requests if necessary to avoid exceeding Devvit's limitations on response size.
+ * @param key The key of the hash.
+ * @param chunkSize The size of each chunk.
+ * @returns {Record<string, string>} An object with field-value pairs for the specified fields.
+ */
+async function hGetAllChunked(key, chunkSize = 5000) {
+    const fields = await server_1.redis.hKeys(key);
+    if (fields.length === 0) {
+        return {};
+    }
+    const results = await Promise.all((0, lodash_es_1.chunk)(fields, chunkSize).map(c => hMGetAsRecord(key, c)));
+    return Object.assign({}, ...results);
+}
+/**
+ * Returns a range of members from a sorted set in Redis as a record/object, where the keys are the members and the values are their scores.
+ * @param key The key of the sorted set.
+ * @param start The starting index (inclusive) of the range.
+ * @param stop The ending index (exclusive) of the range.
+ * @param options Optional parameters for the zRange command.
+ * @returns {Record<string, number>} A record/object with members and their scores.
+ */
+async function zRangeAsRecord(key, start, stop, options) {
+    const results = {};
+    const items = await server_1.redis.zRange(key, start, stop, options);
+    items.forEach((item) => {
+        results[item.member] = item.score;
+    });
+    return results;
+}
+/**
+ * Sets an expiration time on a Redis key based on a Date object.
+ * @param key The redis key.
+ * @param expireAt The expiration date.
+ */
+async function expireKeyAt(key, expireAt) {
+    const secondsUntil = (0, date_fns_1.differenceInSeconds)(expireAt, new Date());
+    if (secondsUntil > 0) {
+        await server_1.redis.expire(key, secondsUntil);
+    }
+    else {
+        throw new Error(`Expire time ${expireAt.toISOString()} is in the past`);
+    }
+}

package/dist/tasks/index.d.ts

@@ -0,0 +1 @@
+export * from "./upgradeNotifier.js";

package/dist/tasks/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./upgradeNotifier.js"), exports);

package/dist/tasks/upgradeNotifier.d.ts

@@ -0,0 +1,8 @@
+import { Context } from "hono";
+export type UpgradeNotifierData = {
+    settingName?: string;
+    appFriendlyName?: string;
+    updateSubreddit?: string;
+    updateWikiPage?: string;
+};
+export declare const handleUpgradeNotifier: (c: Context) => Promise<Response & import("hono").TypedResponse<{}, import("hono/utils/http-status").ContentfulStatusCode, "json">>;

package/dist/tasks/upgradeNotifier.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleUpgradeNotifier = void 0;
+const server_1 = require("@devvit/web/server");
+const json2md_1 = __importDefault(require("json2md"));
+const semver_1 = require("semver");
+const DEFAULT_UPDATE_SUBREDDIT = "fsvapps";
+const DEFAULT_UPDATE_WIKI_PAGE = "upgrade-notifier";
+const handleUpgradeNotifier = async (c) => {
+    const request = await c.req.json();
+    if (!request.data) {
+        console.error("Update Checker: No data provided in request");
+        return c.json({ message: "upgrade notifier: no data provided" }, 400);
+    }
+    if (request.data.settingName) {
+        const checkForUpdates = await server_1.settings.get(request.data.settingName);
+        if (!checkForUpdates) {
+            console.log("Update Checker: Upgrade notifier is disabled");
+            return c.json({ message: "upgrade notifier: upgrade notifier is disabled" }, 200);
+        }
+    }
+    const updateSubreddit = request.data.updateSubreddit ?? DEFAULT_UPDATE_SUBREDDIT;
+    const updateWikiPage = request.data.updateWikiPage ?? DEFAULT_UPDATE_WIKI_PAGE;
+    let wikiPage;
+    try {
+        wikiPage = await server_1.reddit.getWikiPage(updateSubreddit, updateWikiPage);
+    }
+    catch {
+        console.error(`Update Checker: Error getting wiki page ${updateWikiPage} from ${updateSubreddit}`);
+        return c.json({ message: "upgrade notifier: could not retrieve wiki page" }, 500);
+    }
+    const updates = JSON.parse(wikiPage.content);
+    const updatesForThisApp = updates.filter(update => update.appname === server_1.context.appSlug);
+    if (updatesForThisApp.length === 0) {
+        console.log(`Update Checker: No updates found for app ${server_1.context.appSlug}`);
+        return c.json({ message: "upgrade notifier: no updates found" }, 200);
+    }
+    if (updatesForThisApp.length > 1) {
+        console.error(`Update Checker: Multiple updates found for app ${server_1.context.appSlug}`);
+        return c.json({ message: "upgrade notifier: multiple updates found" }, 500);
+    }
+    const update = updatesForThisApp[0];
+    let newVersionAvailable;
+    try {
+        newVersionAvailable = (0, semver_1.lt)(server_1.context.appVersion, update.version);
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : JSON.stringify(error);
+        console.error(`Update Checker: Error comparing versions: ${message}`);
+        return c.json({ message: "upgrade notifier: error comparing versions" }, 500);
+    }
+    if (!newVersionAvailable) {
+        console.log("Update Checker: No relevant updates found");
+        return c.json({ message: "upgrade notifier: no relevant updates found" }, 200);
+    }
+    const redisKey = "fdwh:update-notification-sent";
+    const notificationSent = await server_1.redis.get(redisKey);
+    if (notificationSent === update.version) {
+        console.log("Update Checker: Update notification already sent");
+        return c.json({ message: "upgrade notifier: update notification already sent" }, 200);
+    }
+    const message = [
+        { p: `A new version of ${request.data.appFriendlyName} is available to install.` },
+    ];
+    if (update.whatsNewBullets.length > 0) {
+        message.push({ p: "Here's what's new:" });
+        message.push({ ul: update.whatsNewBullets });
+    }
+    message.push({ p: `To install this update, or to disable these notifications, visit the [**${request.data.appFriendlyName ?? "App"} configuration page**](https://developers.reddit.com/r/${server_1.context.subredditName}/apps/${server_1.context.appSlug}) for /r/${server_1.context.subredditName}.` });
+    await server_1.reddit.modMail.createModNotification({
+        subredditId: server_1.context.subredditId,
+        subject: `New update available for ${request.data.appFriendlyName ?? server_1.context.appSlug}: v${update.version}`,
+        bodyMarkdown: (0, json2md_1.default)(message),
+    });
+    return c.json({ message: "upgrade notifier handled" }, 200);
+};
+exports.handleUpgradeNotifier = handleUpgradeNotifier;

package/dist/triggers/duplicateTriggerMitigation.d.ts

@@ -0,0 +1,6 @@
+interface TriggerLockOptions {
+    expiration?: Date;
+    verboseLogs?: boolean;
+}
+export declare function hasTriggerBeenHandled(identifier: string, opts?: TriggerLockOptions): Promise<boolean>;
+export {};

package/dist/triggers/duplicateTriggerMitigation.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasTriggerBeenHandled = hasTriggerBeenHandled;
+const server_1 = require("@devvit/web/server");
+const date_fns_1 = require("date-fns");
+const redis_1 = require("../redis");
+async function hasTriggerBeenHandled(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;
+}

package/dist/triggers/index.d.ts

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

package/dist/triggers/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./postsAndComments.js"), exports);

package/dist/triggers/postsAndComments.d.ts

@@ -0,0 +1,5 @@
+import { OnCommentCreateRequest, OnCommentReportRequest, OnCommentSubmitRequest, OnCommentUpdateRequest, OnPostCreateRequest, OnPostFlairUpdateRequest, OnPostReportRequest, OnPostSubmitRequest, OnPostUpdateRequest } from "@devvit/web/shared";
+export declare function fixPostTriggerEvent<T extends OnPostSubmitRequest | OnPostCreateRequest | OnPostUpdateRequest | OnPostFlairUpdateRequest>(event: T): Promise<T>;
+export declare function fixCommentTriggerEvent<T extends OnCommentSubmitRequest | OnCommentCreateRequest | OnCommentUpdateRequest>(event: T): Promise<T>;
+export declare function fixCommentReportTriggerEvent(event: OnCommentReportRequest): Promise<OnCommentReportRequest>;
+export declare function fixPostReportTriggerEvent(event: OnPostReportRequest): Promise<OnPostReportRequest>;

package/dist/triggers/postsAndComments.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fixPostTriggerEvent = fixPostTriggerEvent;
+exports.fixCommentTriggerEvent = fixCommentTriggerEvent;
+exports.fixCommentReportTriggerEvent = fixCommentReportTriggerEvent;
+exports.fixPostReportTriggerEvent = fixPostReportTriggerEvent;
+const server_1 = require("@devvit/web/server");
+async function fixPostTriggerEvent(event) {
+    const eventToReturn = { ...event };
+    if (!eventToReturn.post || !eventToReturn.author) {
+        return eventToReturn;
+    }
+    if (eventToReturn.author.name !== "[redacted]" && eventToReturn.post.selftext !== "[Removed by Reddit]") {
+        return eventToReturn;
+    }
+    const post = await server_1.reddit.getPostById(eventToReturn.post.id);
+    if (post.body !== undefined) {
+        eventToReturn.post.selftext = post.body;
+    }
+    eventToReturn.author.name = post.authorName;
+    if (post.authorId) {
+        eventToReturn.author.id = post.authorId;
+    }
+    return eventToReturn;
+}
+async function fixCommentTriggerEvent(event) {
+    const eventToReturn = { ...event };
+    if (!eventToReturn.comment || !eventToReturn.author) {
+        return eventToReturn;
+    }
+    if (eventToReturn.author.name !== "[redacted]" && eventToReturn.comment.body !== "[Removed by Reddit]") {
+        return eventToReturn;
+    }
+    const comment = await server_1.reddit.getCommentById(eventToReturn.comment.id);
+    eventToReturn.comment.body = comment.body;
+    eventToReturn.author.name = comment.authorName;
+    if (comment.authorId) {
+        eventToReturn.author.id = comment.authorId;
+    }
+    return eventToReturn;
+}
+async function fixCommentReportTriggerEvent(event) {
+    const eventToReturn = { ...event };
+    if (!eventToReturn.comment) {
+        return eventToReturn;
+    }
+    if (eventToReturn.comment.body !== "[Removed by Reddit]") {
+        return eventToReturn;
+    }
+    const comment = await server_1.reddit.getCommentById(eventToReturn.comment.id);
+    eventToReturn.comment.body = comment.body;
+    return eventToReturn;
+}
+async function fixPostReportTriggerEvent(event) {
+    const eventToReturn = { ...event };
+    if (!eventToReturn.post) {
+        return eventToReturn;
+    }
+    if (eventToReturn.post.selftext !== "[Removed by Reddit]") {
+        return eventToReturn;
+    }
+    const post = await server_1.reddit.getPostById(eventToReturn.post.id);
+    if (post.body !== undefined) {
+        eventToReturn.post.selftext = post.body;
+    }
+    return eventToReturn;
+}

package/eslint.config.mjs

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

package/package.json

@@ -0,0 +1,46 @@
+{
+    "name": "@fsvreddit/fsv-devvit-web-helpers",
+    "version": "0.1.9",
+    "description": "Helper functions and utilities for Devvit apps on Reddit",
+    "main": "dist/index.js",
+    "scripts": {
+        "test": "npm run test:unit",
+        "test:unit": "vitest --run",
+        "lint": "eslint . --ext .ts",
+        "build": "tsc --project tsconfig.build.json",
+        "prepare": "npm run build"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/fsvreddit/fsv-devvit-web-helpers.git"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "author": "fsv",
+    "license": "BSD-3-Clause",
+    "dependencies": {
+        "date-fns": "^4.1.0",
+        "hono": "^4.12.30",
+        "json2md": "^2.0.3",
+        "lodash-es": "^4.18.1",
+        "marked": "^18.0.11",
+        "semver": "^7.8.5"
+    },
+    "devDependencies": {
+        "@fsvreddit/eslint-config": "^0.1.0",
+        "@types/json2md": "^1.5.4",
+        "@types/lodash-es": "^4.17.12",
+        "@types/semver": "^7.7.1",
+        "eslint": "^10.0.2",
+        "typescript": "^5.8.3",
+        "vitest": "^4.0.15"
+    },
+    "keywords": [
+        "reddit",
+        "devvit"
+    ],
+    "peerDependencies": {
+        "@devvit/web": "^0.14.1"
+    }
+}

package/tsconfig.build.json

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

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+    "compilerOptions": {
+        "target": "ES2020",
+        "lib": [
+            "ES2022",
+            "WebWorker"
+        ],
+        "resolveJsonModule": true,
+        "declaration": true,
+        "outDir": "dist",
+        "strict": true,
+        "esModuleInterop": true,
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+    },
+    "exclude": [
+        "**/node_modules",
+        "dist",
+        "**/.*/",
+        "eslint.config.mjs"
+    ]
+}