@fsvreddit/fsv-devvit-web-helpers 0.1.10 → 0.2.1

package/dist/extendedDevvit/crowdControl.d.ts

@@ -0,0 +1,9 @@
+import { Post } from "@devvit/web/server";
+export declare enum CrowdControlOption {
+    None = "ignore",
+    Off = "0",
+    Moderate = "1",
+    High = "2",
+    Maximum = "3"
+}
+export declare function setCrowdControl(post: Post, crowdControlOption: CrowdControlOption): Promise<void>;

package/dist/extendedDevvit/crowdControl.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrowdControlOption = void 0;
+exports.setCrowdControl = setCrowdControl;
+const server_1 = require("@devvit/web/server");
+const _1 = require(".");
+var CrowdControlOption;
+(function (CrowdControlOption) {
+    CrowdControlOption["None"] = "ignore";
+    CrowdControlOption["Off"] = "0";
+    CrowdControlOption["Moderate"] = "1";
+    CrowdControlOption["High"] = "2";
+    CrowdControlOption["Maximum"] = "3";
+})(CrowdControlOption || (exports.CrowdControlOption = CrowdControlOption = {}));
+async function setCrowdControl(post, crowdControlOption) {
+    let level;
+    switch (crowdControlOption) {
+        case CrowdControlOption.Off:
+            level = 0;
+            break;
+        case CrowdControlOption.Moderate:
+            level = 1;
+            break;
+        case CrowdControlOption.High:
+            level = 2;
+            break;
+        case CrowdControlOption.Maximum:
+            level = 3;
+            break;
+        default:
+            return;
+    }
+    await (0, _1.getExtendedDevvit)().redditAPIPlugins.Moderation.UpdateCrowdControlLevel({ id: post.id, level }, server_1.context.metadata);
+    console.log(`Crowd control level set to ${crowdControlOption}`);
+}

package/dist/extendedDevvit/extendedDevvit.d.ts

@@ -0,0 +1,50 @@
+import * as protos from "@devvit/protos";
+import { UserAboutResponse } from "@devvit/protos/types/devvit/plugin/redditapi/users/users_msg.js";
+import { GetSubredditUsersByTypeOptions, ListingFetchOptions } from "@devvit/reddit";
+import { getDevvitConfig } from "@devvit/shared-types/server/get-devvit-config.js";
+export type RedditAPIPlugins = {
+    NewModmail: protos.NewModmail;
+    Widgets: protos.Widgets;
+    ModNote: protos.ModNote;
+    LinksAndComments: protos.LinksAndComments;
+    Moderation: protos.Moderation;
+    GraphQL: protos.GraphQL;
+    Listings: protos.Listings;
+    Flair: protos.Flair;
+    Wiki: protos.Wiki;
+    Users: protos.Users;
+    PrivateMessages: protos.PrivateMessages;
+    Subreddits: protos.Subreddits;
+};
+export type ExtendedDevvitLike = {
+    redditAPIPlugins: RedditAPIPlugins;
+    schedulerPlugin: protos.Scheduler;
+    kvStorePlugin: protos.KVStore;
+    redisPlugin: protos.RedisAPI;
+    mediaPlugin: protos.MediaService;
+    settingsPlugin: protos.Settings;
+    realtimePlugin: protos.Realtime;
+    userActionsPlugin: protos.UserActions;
+    use: <T>(plugin: protos.Definition) => T;
+};
+export declare class ExtendedDevvit implements ExtendedDevvitLike {
+    private config;
+    constructor(config: ReturnType<typeof getDevvitConfig>);
+    get kvStorePlugin(): protos.KVStore;
+    get mediaPlugin(): protos.MediaService;
+    get realtimePlugin(): protos.Realtime;
+    get redditAPIPlugins(): RedditAPIPlugins;
+    get redisPlugin(): protos.RedisAPI;
+    get schedulerPlugin(): protos.Scheduler;
+    get settingsPlugin(): protos.Settings;
+    get userActionsPlugin(): protos.UserActions;
+    use<T>(plugin: protos.Definition): T;
+}
+export declare function getExtendedDevvit(): ExtendedDevvit;
+export declare function getRawUserData(username: string, metadata: protos.Metadata): Promise<UserAboutResponse>;
+export declare function getRawListingData(postOrCommentIds: string[], metadata: protos.Metadata): Promise<protos.Listing>;
+export declare function getRawPostData(thingIds: string[], metadata: protos.Metadata): Promise<protos.Listing>;
+export declare function getRawCommentData(thingIds: string[], metadata: protos.Metadata): Promise<protos.Listing>;
+export declare function getRawSubredditData(subredditName: string, metadata: protos.Metadata): Promise<protos.SubredditAboutResponse>;
+export declare function setVote(id: string, dir: 1 | 0 | -1, metadata: protos.Metadata): Promise<void>;
+export declare function getRawUserWhereData(userWhereRequest: GetSubredditUsersByTypeOptions, fetchOptions: ListingFetchOptions, metadata: protos.Metadata): Promise<protos.Listing>;

package/dist/extendedDevvit/extendedDevvit.js

@@ -0,0 +1,123 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtendedDevvit = void 0;
+exports.getExtendedDevvit = getExtendedDevvit;
+exports.getRawUserData = getRawUserData;
+exports.getRawListingData = getRawListingData;
+exports.getRawPostData = getRawPostData;
+exports.getRawCommentData = getRawCommentData;
+exports.getRawSubredditData = getRawSubredditData;
+exports.setVote = setVote;
+exports.getRawUserWhereData = getRawUserWhereData;
+const protos = __importStar(require("@devvit/protos"));
+const get_devvit_config_js_1 = require("@devvit/shared-types/server/get-devvit-config.js");
+class ExtendedDevvit {
+    constructor(config) {
+        this.config = config;
+    }
+    get kvStorePlugin() {
+        return this.config.use(protos.KVStoreDefinition);
+    }
+    get mediaPlugin() {
+        return this.config.use(protos.MediaServiceDefinition);
+    }
+    get realtimePlugin() {
+        return this.config.use(protos.RealtimeDefinition);
+    }
+    get redditAPIPlugins() {
+        return {
+            NewModmail: this.config.use(protos.NewModmailDefinition),
+            Widgets: this.config.use(protos.WidgetsDefinition),
+            ModNote: this.config.use(protos.ModNoteDefinition),
+            LinksAndComments: this.config.use(protos.LinksAndCommentsDefinition),
+            Moderation: this.config.use(protos.ModerationDefinition),
+            GraphQL: this.config.use(protos.GraphQLDefinition),
+            Listings: this.config.use(protos.ListingsDefinition),
+            Flair: this.config.use(protos.FlairDefinition),
+            Wiki: this.config.use(protos.WikiDefinition),
+            Users: this.config.use(protos.UsersDefinition),
+            PrivateMessages: this.config.use(protos.PrivateMessagesDefinition),
+            Subreddits: this.config.use(protos.SubredditsDefinition),
+        };
+    }
+    get redisPlugin() {
+        return this.config.use(protos.RedisAPIDefinition);
+    }
+    get schedulerPlugin() {
+        return this.config.use(protos.SchedulerDefinition);
+    }
+    get settingsPlugin() {
+        return this.config.use(protos.SettingsDefinition);
+    }
+    get userActionsPlugin() {
+        return this.config.use(protos.UserActionsDefinition);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters
+    use(plugin) {
+        return this.config.use(plugin);
+    }
+}
+exports.ExtendedDevvit = ExtendedDevvit;
+const extendedDevvit = new ExtendedDevvit((0, get_devvit_config_js_1.getDevvitConfig)());
+function getExtendedDevvit() {
+    return extendedDevvit;
+}
+async function getRawUserData(username, metadata) {
+    return getExtendedDevvit().redditAPIPlugins.Users.UserAbout({ username }, metadata);
+}
+async function getRawListingData(postOrCommentIds, metadata) {
+    return getExtendedDevvit().redditAPIPlugins.LinksAndComments.Info({ subreddits: [], thingIds: postOrCommentIds }, metadata);
+}
+async function getRawPostData(thingIds, metadata) {
+    return getRawListingData(thingIds, metadata);
+}
+async function getRawCommentData(thingIds, metadata) {
+    return getRawListingData(thingIds, metadata);
+}
+async function getRawSubredditData(subredditName, metadata) {
+    return getExtendedDevvit().redditAPIPlugins.Subreddits.SubredditAbout({ subreddit: subredditName }, metadata);
+}
+async function setVote(id, dir, metadata) {
+    await getExtendedDevvit().redditAPIPlugins.LinksAndComments.Vote({ id, dir }, metadata);
+}
+async function getRawUserWhereData(userWhereRequest, fetchOptions, metadata) {
+    return getExtendedDevvit().redditAPIPlugins.Subreddits.AboutWhere({
+        where: userWhereRequest.type,
+        subreddit: userWhereRequest.subredditName,
+        user: userWhereRequest.username,
+        ...fetchOptions,
+    }, metadata);
+}

package/dist/extendedDevvit/index.d.ts

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

package/dist/extendedDevvit/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("./crowdControl.js"), exports);
+__exportStar(require("./extendedDevvit.js"), exports);

package/dist/extendedDevvit/userExtended.d.ts

@@ -0,0 +1,18 @@
+import { User } from "@devvit/web/server";
+export interface UserExtended {
+    createdAt: Date;
+    commentKarma: number;
+    displayName?: string;
+    hasVerifiedEmail: boolean;
+    id: string;
+    isAdmin: boolean;
+    isGold: boolean;
+    isModerator: boolean;
+    linkKarma: number;
+    nsfw: boolean;
+    username: string;
+    userDescription?: string;
+    isSuspended?: boolean;
+}
+export declare function getUserExtended(username: string): Promise<UserExtended | undefined>;
+export declare function getUserExtendedFromUser(user: User): Promise<UserExtended>;

package/dist/extendedDevvit/userExtended.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserExtended = getUserExtended;
+exports.getUserExtendedFromUser = getUserExtendedFromUser;
+const server_1 = require("@devvit/web/server");
+const _1 = require(".");
+async function getRawUserData(username) {
+    let userAboutResponse;
+    try {
+        userAboutResponse = await (0, _1.getExtendedDevvit)().redditAPIPlugins.Users.UserAbout({ username }, server_1.context.metadata);
+    }
+    catch (error) {
+        if (error instanceof Error && (error.message.includes("404 Not Found") || error.message.includes("403 Forbidden"))) {
+            return;
+        }
+        throw error; // Rethrow the error if it's not a 404 or 403
+    }
+    return userAboutResponse;
+}
+async function getUserExtended(username) {
+    const rawUserData = await getRawUserData(username);
+    if (!rawUserData?.data) {
+        return;
+    }
+    const userExtendedVal = {
+        createdAt: new Date((rawUserData.data.created ?? 0) * 1000),
+        commentKarma: rawUserData.data.commentKarma ?? 0,
+        displayName: rawUserData.data.subreddit?.title,
+        hasVerifiedEmail: rawUserData.data.hasVerifiedEmail ?? false,
+        id: `t2_${rawUserData.data.id ?? ""}`,
+        isAdmin: rawUserData.data.isEmployee ?? false,
+        isGold: rawUserData.data.isGold ?? false,
+        isModerator: rawUserData.data.isMod ?? false,
+        linkKarma: rawUserData.data.linkKarma ?? 0,
+        nsfw: rawUserData.data.subreddit?.over18 ?? false,
+        username: rawUserData.data.name ?? "",
+        userDescription: rawUserData.data.subreddit?.publicDescription,
+        isSuspended: rawUserData.data.isSuspended ?? false,
+    };
+    return userExtendedVal;
+}
+async function getUserExtendedFromUser(user) {
+    try {
+        const userExtended = await getUserExtended(user.username);
+        if (userExtended) {
+            return userExtended;
+        }
+    }
+    catch {
+        //
+    }
+    return {
+        createdAt: user.createdAt,
+        commentKarma: user.commentKarma,
+        hasVerifiedEmail: user.hasVerifiedEmail,
+        id: user.id,
+        isAdmin: user.isAdmin,
+        isGold: false,
+        isModerator: false,
+        linkKarma: user.linkKarma,
+        nsfw: user.nsfw,
+        username: user.username,
+    };
+}

package/dist/extendedDevvit/userSocialLinks.d.ts

@@ -0,0 +1,2 @@
+import { UserSocialLink } from "@devvit/web/server";
+export declare function getUserSocialLinks(username: string): Promise<UserSocialLink[]>;

package/dist/extendedDevvit/userSocialLinks.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserSocialLinks = getUserSocialLinks;
+const server_1 = require("@devvit/web/server");
+const _1 = require(".");
+async function getUserSocialLinks(username) {
+    const gql = (0, _1.getExtendedDevvit)().redditAPIPlugins.GraphQL;
+    const response = await gql.PersistedQuery({
+        operationName: "GetUserSocialLinks", // Name and ID are both from <https://github.com/reddit/devvit/blob/f083/packages/public-api/src/apis/reddit/models/User.ts#L437-L438>
+        id: "2aca18ef5f4fc75fb91cdaace3e9aeeae2cb3843b5c26ad511e6f01b8521593a",
+        variables: {
+            name: username,
+        },
+    }, server_1.context.metadata);
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+    if (!response.data?.user?.profile?.socialLinks) {
+        return [];
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return
+    return response.data.user.profile.socialLinks.map((link) => ({
+        ...link,
+        handle: link.handle ?? undefined,
+    }));
+}

package/dist/index.d.ts

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

package/dist/index.js

@@ -14,6 +14,7 @@ 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("./extendedDevvit/index.js"), exports);
 __exportStar(require("./redditAPI/index.js"), exports);
 __exportStar(require("./tasks/index.js"), exports);
 __exportStar(require("./triggers/index.js"), exports);

package/dist/redditAPI/wiki.d.ts

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

package/dist/redditAPI/wiki.js

@@ -3,8 +3,11 @@ 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) {
+async function updateWikiPageMulti(options, verboseLogs = false) {
     const isV2WikiEnabled = await server_1.reddit.isWikiV2Enabled(server_1.context.subredditName);
+    if (verboseLogs) {
+        console.log(`Wiki Update: v2 enabled: ${isV2WikiEnabled}`);
+    }
     const promises = [
         server_1.reddit.updateWikiPage({
             ...options,
@@ -18,6 +21,9 @@ async function updateWikiPageMulti(options) {
             content: contentHtml,
             wikiVersion: "v2",
         }));
+        if (verboseLogs) {
+            console.log(`Wiki Update: v2 content HTML generated`);
+        }
     }
     return Promise.all(promises).then(results => results[0]);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fsvreddit/fsv-devvit-web-helpers",
-    "version": "0.1.10",
+    "version": "0.2.1",
     "description": "Helper functions and utilities for Devvit Web apps on Reddit",
     "main": "dist/index.js",
     "scripts": {
@@ -38,6 +38,9 @@
         "devvit"
     ],
     "peerDependencies": {
-        "@devvit/web": "^0.14.1"
+        "@devvit/protos": "^0.14.6",
+        "@devvit/reddit": "^0.14.6",
+        "@devvit/shared-types": "^0.14.6",
+        "@devvit/web": "^0.14.6"
     }
 }