@devvit/reddit 0.11.17-next-2025-05-28-417d95f5a.0

package/models/User.js

@@ -0,0 +1,458 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _a, _User_id, _User_username, _User_createdAt, _User_linkKarma, _User_commentKarma, _User_nsfw, _User_isAdmin, _User_modPermissionsBySubreddit, _User_url, _User_permalink, _User_hasVerifiedEmail, _User_metadata_get;
+import { getContext } from '@devvit/server';
+import { assertNonNull } from '@devvit/shared-types/NonNull.js';
+import { asT2ID, isT2ID } from '@devvit/shared-types/tid.js';
+import { getRedditApiPlugins } from '../getRedditApiPlugins.js';
+import { GraphQL } from '../graphql/GraphQL.js';
+import { makeGettersEnumerable } from '../helpers/makeGettersEnumerable.js';
+import { formatModeratorPermissions, validModPermissions } from '../helpers/permissions.js';
+import { Comment } from './Comment.js';
+import { convertUserFlairProtoToAPI, Flair } from './Flair.js';
+import { Listing } from './Listing.js';
+import { Post } from './Post.js';
+export var SocialLinkType;
+(function (SocialLinkType) {
+    SocialLinkType["Custom"] = "CUSTOM";
+    SocialLinkType["Reddit"] = "REDDIT";
+    SocialLinkType["Instagram"] = "INSTAGRAM";
+    SocialLinkType["Twitter"] = "TWITTER";
+    SocialLinkType["Tiktok"] = "TIKTOK";
+    SocialLinkType["Twitch"] = "TWITCH";
+    SocialLinkType["Facebook"] = "FACEBOOK";
+    SocialLinkType["Youtube"] = "YOUTUBE";
+    SocialLinkType["Tumblr"] = "TUMBLR";
+    SocialLinkType["Spotify"] = "SPOTIFY";
+    SocialLinkType["Soundcloud"] = "SOUNDCLOUD";
+    SocialLinkType["Beacons"] = "BEACONS";
+    SocialLinkType["Linktree"] = "LINKTREE";
+    SocialLinkType["Discord"] = "DISCORD";
+    SocialLinkType["Venmo"] = "VENMO";
+    SocialLinkType["CashApp"] = "CASH_APP";
+    SocialLinkType["Patreon"] = "PATREON";
+    SocialLinkType["Kofi"] = "KOFI";
+    SocialLinkType["Paypal"] = "PAYPAL";
+    SocialLinkType["Cameo"] = "CAMEO";
+    SocialLinkType["Onlyfans"] = "ONLYFANS";
+    SocialLinkType["Substack"] = "SUBSTACK";
+    SocialLinkType["Kickstarter"] = "KICKSTARTER";
+    SocialLinkType["Indiegogo"] = "INDIEGOGO";
+    SocialLinkType["BuyMeACoffee"] = "BUY_ME_A_COFFEE";
+    SocialLinkType["Shopify"] = "SHOPIFY";
+})(SocialLinkType || (SocialLinkType = {}));
+/**
+ * A class representing a user.
+ */
+export class User {
+    /**
+     * @internal
+     */
+    constructor(data) {
+        _User_id.set(this, void 0);
+        _User_username.set(this, void 0);
+        _User_createdAt.set(this, void 0);
+        _User_linkKarma.set(this, void 0);
+        _User_commentKarma.set(this, void 0);
+        _User_nsfw.set(this, void 0);
+        _User_isAdmin.set(this, void 0);
+        _User_modPermissionsBySubreddit.set(this, new Map());
+        // R2 bug: user.url is a permalink path
+        _User_url.set(this, void 0);
+        // R2 bug: user object does not contain a permalink field
+        _User_permalink.set(this, void 0);
+        _User_hasVerifiedEmail.set(this, void 0);
+        makeGettersEnumerable(this);
+        assertNonNull(data.id, 'User ID is missing or undefined');
+        assertNonNull(data.name, 'Username is missing or undefined');
+        assertNonNull(data.createdUtc, 'User is missing created date');
+        // UserDataByAccountIds returns the ID without the t2_ prefix
+        __classPrivateFieldSet(this, _User_id, asT2ID(isT2ID(data.id) ? data.id : `t2_${data.id}`), "f");
+        __classPrivateFieldSet(this, _User_username, data.name, "f");
+        __classPrivateFieldSet(this, _User_nsfw, data.over18 ?? false, "f");
+        __classPrivateFieldSet(this, _User_isAdmin, data.isEmployee ?? false, "f");
+        const createdAt = new Date(0);
+        createdAt.setUTCSeconds(data.createdUtc);
+        __classPrivateFieldSet(this, _User_createdAt, createdAt, "f");
+        __classPrivateFieldSet(this, _User_linkKarma, data.linkKarma ?? 0, "f");
+        __classPrivateFieldSet(this, _User_commentKarma, data.commentKarma ?? 0, "f");
+        if (data.modPermissions) {
+            for (const [subredditName, permissions] of Object.entries(data.modPermissions)) {
+                __classPrivateFieldGet(this, _User_modPermissionsBySubreddit, "f").set(subredditName, validModPermissions(permissions));
+            }
+        }
+        __classPrivateFieldSet(this, _User_url, new URL(data.subreddit?.url ?? '', 'https://www.reddit.com').toString(), "f");
+        __classPrivateFieldSet(this, _User_permalink, data.subreddit?.url ?? '', "f");
+        __classPrivateFieldSet(this, _User_hasVerifiedEmail, data.hasVerifiedEmail ?? false, "f");
+    }
+    /**
+     * The ID (starting with t2_) of the user to retrieve.
+     * @example 't2_1w72'
+     */
+    get id() {
+        return __classPrivateFieldGet(this, _User_id, "f");
+    }
+    /**
+     * The username of the user omitting the u/.
+     * @example 'spez'
+     */
+    get username() {
+        return __classPrivateFieldGet(this, _User_username, "f");
+    }
+    /**
+     * The date the user was created.
+     */
+    get createdAt() {
+        return __classPrivateFieldGet(this, _User_createdAt, "f");
+    }
+    /**
+     * The amount of link karma the user has.
+     */
+    get linkKarma() {
+        return __classPrivateFieldGet(this, _User_linkKarma, "f");
+    }
+    /**
+     * The amount of comment karma the user has.
+     */
+    get commentKarma() {
+        return __classPrivateFieldGet(this, _User_commentKarma, "f");
+    }
+    /**
+     * Whether the user's profile is marked as NSFW (Not Safe For Work).
+     */
+    get nsfw() {
+        return __classPrivateFieldGet(this, _User_nsfw, "f");
+    }
+    /**
+     * Whether the user is admin.
+     */
+    get isAdmin() {
+        return __classPrivateFieldGet(this, _User_isAdmin, "f");
+    }
+    /**
+     * The permissions the user has on the subreddit.
+     */
+    get modPermissions() {
+        return __classPrivateFieldGet(this, _User_modPermissionsBySubreddit, "f");
+    }
+    /**
+     * Returns the HTTP URL for the user
+     */
+    get url() {
+        return __classPrivateFieldGet(this, _User_url, "f");
+    }
+    /**
+     * Returns a permalink path relative to https://www.reddit.com
+     */
+    get permalink() {
+        return __classPrivateFieldGet(this, _User_permalink, "f");
+    }
+    /**
+     * Indicates whether or not the user has verified their email address.
+     */
+    get hasVerifiedEmail() {
+        return __classPrivateFieldGet(this, _User_hasVerifiedEmail, "f");
+    }
+    toJSON() {
+        return {
+            id: this.id,
+            username: this.username,
+            createdAt: this.createdAt,
+            linkKarma: this.linkKarma,
+            commentKarma: this.commentKarma,
+            nsfw: this.nsfw,
+            modPermissionsBySubreddit: Object.fromEntries(this.modPermissions),
+        };
+    }
+    /**
+     * Get the mod permissions the user has on the subreddit if they are a moderator.
+     *
+     * @param subredditName - name of the subreddit
+     * @returns the moderator permissions the user has on the subreddit
+     */
+    async getModPermissionsForSubreddit(subredditName) {
+        if (__classPrivateFieldGet(this, _User_modPermissionsBySubreddit, "f").has(subredditName)) {
+            return __classPrivateFieldGet(this, _User_modPermissionsBySubreddit, "f").get(subredditName);
+        }
+        const mods = await _a.getSubredditUsersByType({
+            subredditName,
+            type: 'moderators',
+            username: this.username,
+        }).all();
+        if (mods.length === 0) {
+            return [];
+        }
+        const permissions = mods[0].modPermissions.get(subredditName) ?? [];
+        if (permissions.length > 0) {
+            __classPrivateFieldGet(this, _User_modPermissionsBySubreddit, "f").set(subredditName, permissions);
+        }
+        return permissions;
+    }
+    /**
+     * Get the user's comments.
+     *
+     * @param options - Options for the request
+     * @param options.sort - The sort order of the comments. e.g. 'new'
+     * @param options.timeframe - The timeframe of the comments. e.g. 'all'
+     * @param options.limit - The maximum number of comments to return. e.g. 1000
+     * @param options.pageSize - The number of comments to return per request. e.g. 100
+     * @returns A Listing of Comment objects.
+     */
+    getComments(options) {
+        return Comment.getCommentsByUser({
+            username: this.username,
+            ...options,
+        });
+    }
+    /**
+     * Get the user's posts.
+     *
+     * @param options - Options for the request
+     * @param options.sort - The sort order of the posts. e.g. 'new'
+     * @param options.timeframe - The timeframe of the posts. e.g. 'all'
+     * @param options.limit - The maximum number of posts to return. e.g. 1000
+     * @param options.pageSize - The number of posts to return per request. e.g. 100
+     * @returns A Listing of Post objects.
+     */
+    getPosts(options) {
+        return Post.getPostsByUser({
+            username: this.username,
+            ...options,
+        });
+    }
+    /**
+     * Retrieve the user's flair for the subreddit.
+     *
+     * @param subreddit - The name of the subreddit associated with the user's flair.
+     *
+     * @example
+     * ```ts
+     * const username = "badapple"
+     * const subredditName = "mysubreddit"
+     * const user = await reddit.getUserByUsername(username);
+     * const userFlair = await user.getUserFlairBySubreddit(subredditName);
+     * ```
+     */
+    async getUserFlairBySubreddit(subreddit) {
+        const userFlairs = await Flair.getUserFlairBySubreddit({
+            subreddit,
+            name: __classPrivateFieldGet(this, _User_username, "f"),
+        });
+        return userFlairs.users[0] ? convertUserFlairProtoToAPI(userFlairs.users[0]) : undefined;
+    }
+    getSnoovatarUrl() {
+        return _a.getSnoovatarUrl(this.username);
+    }
+    /**
+     * Gets social links of the user
+     *
+     * @returns A Promise that resolves an Array of UserSocialLink objects
+     * @example
+     * ```ts
+     * const socialLinks = await user.getSocialLinks();
+     * ```
+     */
+    async getSocialLinks() {
+        const operationName = 'GetUserSocialLinks';
+        const persistedQueryHash = '2aca18ef5f4fc75fb91cdaace3e9aeeae2cb3843b5c26ad511e6f01b8521593a';
+        const response = await GraphQL.query(operationName, persistedQueryHash, {
+            name: this.username,
+        });
+        if (!response.data?.user?.profile?.socialLinks) {
+            return [];
+        }
+        return response.data.user.profile.socialLinks.map((link) => ({
+            ...link,
+            handle: link.handle ?? undefined,
+        }));
+    }
+    /** @internal */
+    static async getById(id) {
+        const username = await getUsernameById(id);
+        return username == null ? undefined : _a.getByUsername(username);
+    }
+    /** @internal */
+    static async getByUsername(username) {
+        const client = getRedditApiPlugins().Users;
+        try {
+            const response = await client.UserAbout({ username }, __classPrivateFieldGet(this, _a, "a", _User_metadata_get));
+            // suspended accounts 404.
+            if (response.data?.id)
+                return new _a(response.data);
+        }
+        catch (error) {
+            if (error instanceof Error && error.message.includes('404 Not Found')) {
+                return undefined;
+            }
+            throw error;
+        }
+    }
+    /** @internal */
+    static getSubredditUsersByType(options) {
+        const client = getRedditApiPlugins().Subreddits;
+        return new Listing({
+            hasMore: true,
+            pageSize: options.pageSize,
+            limit: options.limit,
+            after: options.after,
+            before: options.before,
+            fetch: async (fetchOptions) => {
+                const response = await client.AboutWhere({
+                    where: options.type,
+                    user: options.username,
+                    subreddit: options.subredditName,
+                    show: 'all',
+                    ...fetchOptions,
+                });
+                return listingProtosToUsers(response, options.subredditName);
+            },
+        });
+    }
+    /** @internal */
+    static async createRelationship(options) {
+        const client = getRedditApiPlugins().Users;
+        const { type, subredditName, username, permissions, ...optionalFields } = options;
+        const response = await client.Friend({
+            type,
+            subreddit: subredditName,
+            name: username,
+            permissions: permissions ? formatModeratorPermissions(permissions) : undefined,
+            ...optionalFields,
+        }, __classPrivateFieldGet(this, _a, "a", _User_metadata_get));
+        if (response.json?.errors?.length) {
+            throw new Error(response.json.errors.join('\n'));
+        }
+    }
+    /** @internal */
+    static async removeRelationship(options) {
+        const client = getRedditApiPlugins().Users;
+        await client.Unfriend({
+            type: options.type,
+            subreddit: options.subredditName,
+            name: options.username,
+        }, __classPrivateFieldGet(this, _a, "a", _User_metadata_get));
+    }
+    /** @internal */
+    static async setModeratorPermissions(username, subredditName, permissions) {
+        const client = getRedditApiPlugins().Users;
+        const response = await client.SetPermissions({
+            subreddit: subredditName,
+            name: username,
+            type: 'moderator',
+            permissions: formatModeratorPermissions(permissions),
+        }, __classPrivateFieldGet(this, _a, "a", _User_metadata_get));
+        if (response.json?.errors?.length) {
+            throw new Error(response.json.errors.join('\n'));
+        }
+    }
+    /** @internal */
+    static async getSnoovatarUrl(username) {
+        const operationName = 'GetSnoovatarUrlByName';
+        const persistedQueryHash = 'c47fd42345af268616d2d8904b56856acdc05cf61d3650380f539ad7d596ac0c';
+        const response = await GraphQL.query(operationName, persistedQueryHash, { username });
+        return response.data?.redditorInfoByName?.snoovatarIcon?.url;
+    }
+    /** @internal */
+    static getOverview(options) {
+        const client = getRedditApiPlugins().Users;
+        return new Listing({
+            hasMore: true,
+            before: options.before,
+            after: options.after,
+            pageSize: options.pageSize,
+            limit: options.limit,
+            fetch: async (fetchOptions) => {
+                const response = await client.UserWhere({
+                    username: options.username,
+                    where: 'overview',
+                    ...fetchOptions,
+                }, __classPrivateFieldGet(this, _a, "a", _User_metadata_get));
+                return listingProtosToPostsOrComments(response);
+            },
+        });
+    }
+}
+_a = User, _User_id = new WeakMap(), _User_username = new WeakMap(), _User_createdAt = new WeakMap(), _User_linkKarma = new WeakMap(), _User_commentKarma = new WeakMap(), _User_nsfw = new WeakMap(), _User_isAdmin = new WeakMap(), _User_modPermissionsBySubreddit = new WeakMap(), _User_url = new WeakMap(), _User_permalink = new WeakMap(), _User_hasVerifiedEmail = new WeakMap(), _User_metadata_get = function _User_metadata_get() {
+    return getContext().debug.metadata;
+};
+function listingProtosToPostsOrComments(listingProto) {
+    if (!listingProto.data?.children) {
+        throw new Error('Listing response is missing children');
+    }
+    const children = listingProto.data.children.map((child) => {
+        if (child.kind === 't3') {
+            return new Post(child.data);
+        }
+        else if (child.kind === 't1') {
+            return new Comment(child.data);
+        }
+        throw new Error(`Type ${child.kind} is not supported`);
+    });
+    return {
+        children: children,
+        before: listingProto.data.before,
+        after: listingProto.data.after,
+    };
+}
+async function listingProtosToUsers(listingProto, subredditName) {
+    const client = getRedditApiPlugins().Users;
+    if (!listingProto.data?.children) {
+        throw new Error('Listing response is missing children');
+    }
+    const userIds = listingProto.data.children.map((child) => {
+        assertNonNull(child.data?.id, 'User id is still from listing data');
+        return child.data.id;
+    });
+    // break the ids into chunks since they're passed over a query parameter
+    const chunkSize = 100;
+    const userIdChunks = [];
+    for (let i = 0; i < userIds.length; i += chunkSize) {
+        userIdChunks.push(userIds.slice(i, i + chunkSize));
+    }
+    // perform the requests
+    const usersMapResponses = await Promise.all(userIdChunks.map((userIds) => client.UserDataByAccountIds({
+        ids: userIds.join(','),
+    }, getContext().debug.metadata)));
+    // join the responses back into a single map of user data
+    const userDataById = usersMapResponses.reduce((allUsers, response) => ({ ...allUsers, ...response.users }), {});
+    const children = listingProto.data.children.map((child) => {
+        const id = child.data?.id;
+        assertNonNull(id, 'User id is missing from listing');
+        const userData = userDataById[id];
+        // Casting to unknown because Typescript assumes that userData is always defined
+        // because of how we defined the UserDataByAccountIdsResponse_UserAccountData protobuf.
+        assertNonNull(userData, 'User data is missing from response');
+        return new User({
+            id,
+            name: userData.name,
+            linkKarma: userData.linkKarma,
+            commentKarma: userData.commentKarma,
+            createdUtc: userData.createdUtc,
+            over18: userData.profileOver18,
+            snoovatarSize: [],
+            modPermissions: {
+                [subredditName]: child.data?.modPermissions ?? [],
+            },
+        });
+    });
+    return {
+        children,
+        before: listingProto.data.before,
+        after: listingProto.data.after,
+    };
+}
+/** @internal */
+async function getUsernameById(id) {
+    const client = getRedditApiPlugins().Users;
+    const response = await client.UserDataByAccountIds({ ids: id }, getContext().debug.metadata);
+    return response?.users?.[id]?.name;
+}

package/models/Vault.d.ts

@@ -0,0 +1,32 @@
+import type { T2ID } from '@devvit/shared-types/tid.js';
+/**
+ * A type representing a Vault (crypto wallet).
+ */
+export type Vault = {
+    /**
+     * The provider of the Vault address.
+     * @example 'ethereum'
+     */
+    provider: string;
+    /**
+     * The ID (starting with t2_) of the user owning the Vault.
+     * @example 't2_1w72'
+     */
+    userId: T2ID;
+    /**
+     * The address of the Vault.
+     * @example '0x205ee28744456bDBf180A0Fa7De51e0F116d54Ed'
+     */
+    address: string;
+    /**
+     * The date the Vault was created.
+     */
+    createdAt: string;
+    /**
+     * Whether the Vault is active.
+     */
+    isActive: boolean;
+};
+export declare function getVaultByAddress(address: string): Promise<Vault>;
+export declare function getVaultByUserId(userId: T2ID): Promise<Vault>;
+//# sourceMappingURL=Vault.d.ts.map

package/models/Vault.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Vault.d.ts","sourceRoot":"","sources":["../../src/models/Vault.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAKxD;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,MAAM,EAAE,IAAI,CAAC;IAEb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,wBAAsB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CASvE;AAED,wBAAsB,gBAAgB,CAAC,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,CASnE"}

package/models/Vault.js

@@ -0,0 +1,25 @@
+import { asT2ID } from '@devvit/shared-types/tid.js';
+import { GraphQL } from '../graphql/GraphQL.js';
+export async function getVaultByAddress(address) {
+    return getVaultByParams('GetVaultContactByAddress', '3e2f7966a5c120e64fd2795d06a46595c52d988185be98d3ed71c3f81ae80d2e', {
+        provider: 'ethereum', // Only one supported at the moment
+        address,
+    });
+}
+export async function getVaultByUserId(userId) {
+    return getVaultByParams('GetVaultContactByUserId', 'a854ddc19d0e22c4f36ed917fdbd568f299f3571427e393aee5e2972080fffe9', {
+        provider: 'ethereum', // Only one supported at the moment
+        userId,
+    });
+}
+async function getVaultByParams(operationName, queryHash, params) {
+    const response = await GraphQL.query(operationName, queryHash, params);
+    const contact = response?.data?.vault?.contact;
+    return {
+        provider: contact?.provider,
+        userId: asT2ID(contact?.userId),
+        address: contact?.address,
+        createdAt: contact?.createdAt,
+        isActive: contact?.isActive,
+    };
+}

package/models/Widget.d.ts

@@ -0,0 +1,133 @@
+import type { AddButtonWidgetRequest, AddCalendarWidgetRequest, AddCommunityListWidgetRequest, AddCustomWidgetRequest, AddImageWidgetRequest, AddPostFlairWidgetRequest, AddTextAreaWidgetRequest, CalendarWidgetConfiguration, GetWidgetsResponse_WidgetItem_PostFlairTemplate as PostFlairTemplateData, SubredditAboutRulesResponse, UpdateButtonWidgetRequest, UpdateCalendarWidgetRequest, UpdateCommunityListWidgetRequest, UpdateCustomWidgetRequest, UpdateImageWidgetRequest, UpdatePostFlairWidgetRequest, UpdateTextAreaWidgetRequest, WidgetButton, WidgetImage, WidgetStyles } from '@devvit/protos';
+import { CommunityListWidget_CommunityData as CommunityData, GetWidgetsResponse_WidgetItem as WidgetItem } from '@devvit/protos';
+export type AddWidgetData = (AddImageWidgetRequest & {
+    type: 'image';
+}) | (AddCalendarWidgetRequest & {
+    type: 'calendar';
+}) | (AddTextAreaWidgetRequest & {
+    type: 'textarea';
+}) | (AddButtonWidgetRequest & {
+    type: 'button';
+}) | (AddCommunityListWidgetRequest & {
+    type: 'community-list';
+}) | (AddPostFlairWidgetRequest & {
+    type: 'post-flair';
+}) | (AddCustomWidgetRequest & {
+    type: 'custom';
+});
+export declare class Widget {
+    #private;
+    constructor(widgetData: WidgetItem, subredditName: string);
+    get id(): string;
+    get name(): string;
+    get subredditName(): string;
+    toJSON(): Pick<Widget, 'id' | 'name' | 'subredditName'>;
+    delete(): Promise<void>;
+    /**
+     * @internal
+     * @note - This method only returns the widgets listed on the sidebar.
+     */
+    static getWidgets(subredditName: string): Promise<Widget[]>;
+    /** @internal */
+    static delete(subredditName: string, id: string): Promise<void>;
+    /** @internal */
+    static reorder(subredditName: string, orderByIds: string[]): Promise<void>;
+    /** @internal */
+    static add(widgetData: AddWidgetData): Promise<Widget>;
+}
+export declare class ImageWidget extends Widget {
+    #private;
+    constructor(widgetData: WidgetItem, subredditName: string);
+    get images(): WidgetImage[];
+    toJSON(): ReturnType<Widget['toJSON']> & Pick<ImageWidget, 'images'>;
+    /** @internal */
+    static create(options: AddImageWidgetRequest): Promise<ImageWidget>;
+    /** @internal */
+    static update(options: UpdateImageWidgetRequest): Promise<ImageWidget>;
+}
+export declare class CalendarWidget extends Widget {
+    #private;
+    constructor(widgetData: WidgetItem, subredditName: string);
+    get googleCalendarId(): string;
+    get configuration(): CalendarWidgetConfiguration;
+    get styles(): WidgetStyles;
+    toJSON(): ReturnType<Widget['toJSON']> & Pick<CalendarWidget, 'googleCalendarId' | 'configuration' | 'styles'>;
+    /** @internal */
+    static create(options: AddCalendarWidgetRequest): Promise<CalendarWidget>;
+    /** @internal */
+    static update(options: UpdateCalendarWidgetRequest): Promise<CalendarWidget>;
+}
+export declare class TextAreaWidget extends Widget {
+    #private;
+    constructor(widgetData: WidgetItem, subredditName: string);
+    get text(): string;
+    get styles(): WidgetStyles;
+    toJSON(): ReturnType<Widget['toJSON']> & Pick<TextAreaWidget, 'text' | 'styles'>;
+    /** @internal */
+    static create(options: AddTextAreaWidgetRequest): Promise<TextAreaWidget>;
+    /** @internal */
+    static update(options: UpdateTextAreaWidgetRequest): Promise<TextAreaWidget>;
+}
+export declare class ButtonWidget extends Widget {
+    #private;
+    constructor(widgetData: WidgetItem, subredditName: string);
+    get buttons(): WidgetButton[];
+    get description(): string;
+    get styles(): WidgetStyles;
+    toJSON(): ReturnType<Widget['toJSON']> & Pick<ButtonWidget, 'buttons' | 'description' | 'styles'>;
+    /** @internal */
+    static create(options: AddButtonWidgetRequest): Promise<ButtonWidget>;
+    /** @internal */
+    static update(options: UpdateButtonWidgetRequest): Promise<ButtonWidget>;
+}
+export declare class CommunityListWidget extends Widget {
+    #private;
+    constructor(widgetData: WidgetItem, subredditName: string);
+    get communities(): CommunityData[];
+    get styles(): WidgetStyles;
+    toJSON(): ReturnType<Widget['toJSON']> & Pick<CommunityListWidget, 'communities' | 'styles'>;
+    /** @internal */
+    static create(options: AddCommunityListWidgetRequest): Promise<CommunityListWidget>;
+    /** @internal */
+    static update(options: UpdateCommunityListWidgetRequest): Promise<CommunityListWidget>;
+}
+export declare class PostFlairWidget extends Widget {
+    #private;
+    constructor(widgetData: WidgetItem, subredditName: string);
+    get styles(): WidgetStyles;
+    get templates(): PostFlairTemplateData[];
+    get display(): 'list' | 'cloud';
+    toJSON(): ReturnType<Widget['toJSON']> & Pick<PostFlairWidget, 'templates' | 'display' | 'styles'>;
+    /** @internal */
+    static create(options: AddPostFlairWidgetRequest): Promise<PostFlairWidget>;
+    /** @internal */
+    static update(options: UpdatePostFlairWidgetRequest): Promise<PostFlairWidget>;
+}
+export declare class CustomWidget extends Widget {
+    #private;
+    constructor(widgetData: WidgetItem, subredditName: string);
+    get images(): WidgetImage[];
+    get text(): string;
+    get stylesheetUrl(): string;
+    get height(): number;
+    get css(): string;
+    toJSON(): ReturnType<Widget['toJSON']> & Pick<CustomWidget, 'images' | 'text' | 'stylesheetUrl' | 'height' | 'css'>;
+    /** @internal */
+    static create(options: AddCustomWidgetRequest): Promise<CustomWidget>;
+    /** @internal */
+    static update(options: UpdateCustomWidgetRequest): Promise<CustomWidget>;
+}
+type SubredditRule = {
+    description: string;
+    priority: number;
+    shortName: string;
+    violationReason: string;
+};
+export declare class SubredditRulesWidget extends Widget {
+    #private;
+    constructor(subredditAboutRulesRsp: SubredditAboutRulesResponse, widgetData: WidgetItem, subredditName: string);
+    get rules(): SubredditRule[];
+    toJSON(): ReturnType<Widget['toJSON']> & Pick<SubredditRulesWidget, 'rules'>;
+}
+export {};
+//# sourceMappingURL=Widget.d.ts.map

package/models/Widget.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Widget.d.ts","sourceRoot":"","sources":["../../src/models/Widget.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,sBAAsB,EACtB,wBAAwB,EACxB,6BAA6B,EAC7B,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,wBAAwB,EACxB,2BAA2B,EAC3B,+CAA+C,IAAI,qBAAqB,EAExE,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,gCAAgC,EAChC,yBAAyB,EACzB,wBAAwB,EACxB,4BAA4B,EAC5B,2BAA2B,EAC3B,YAAY,EACZ,WAAW,EACX,YAAY,EACb,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,iCAAiC,IAAI,aAAa,EAClD,6BAA6B,IAAI,UAAU,EAC5C,MAAM,gBAAgB,CAAC;AAOxB,MAAM,MAAM,aAAa,GACrB,CAAC,qBAAqB,GAAG;IACvB,IAAI,EAAE,OAAO,CAAC;CACf,CAAC,GACF,CAAC,wBAAwB,GAAG;IAC1B,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC,GACF,CAAC,wBAAwB,GAAG;IAC1B,IAAI,EAAE,UAAU,CAAC;CAClB,CAAC,GACF,CAAC,sBAAsB,GAAG;IACxB,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC,GACF,CAAC,6BAA6B,GAAG;IAC/B,IAAI,EAAE,gBAAgB,CAAC;CACxB,CAAC,GACF,CAAC,yBAAyB,GAAG;IAC3B,IAAI,EAAE,YAAY,CAAC;CACpB,CAAC,GACF,CAAC,sBAAsB,GAAG;IACxB,IAAI,EAAE,QAAQ,CAAC;CAChB,CAAC,CAAC;AAMP,qBAAa,MAAM;;gBAKL,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM;IAQzD,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,GAAG,eAAe,CAAC;IAQvD,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvB;;;OAGG;WACU,UAAU,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IA4DjE,gBAAgB;WACH,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYrE,gBAAgB;WACH,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAYhF,gBAAgB;WACH,GAAG,CAAC,UAAU,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;CAoB7D;AAED,qBAAa,WAAY,SAAQ,MAAM;;gBAGzB,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM;IAkBzD,IAAI,MAAM,IAAI,WAAW,EAAE,CAE1B;IAEQ,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;IAO7E,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,WAAW,CAAC;IAOzE,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,WAAW,CAAC;CAM7E;AAED,qBAAa,cAAe,SAAQ,MAAM;;gBAK5B,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM;IAYzD,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED,IAAI,aAAa,IAAI,2BAA2B,CAE/C;IAED,IAAI,MAAM,IAAI,YAAY,CAEzB;IAEQ,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAC7C,IAAI,CAAC,cAAc,EAAE,kBAAkB,GAAG,eAAe,GAAG,QAAQ,CAAC;IASvE,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC;IAO/E,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,cAAc,CAAC;CAMnF;AAED,qBAAa,cAAe,SAAQ,MAAM;;gBAI5B,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM;IAUzD,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,MAAM,IAAI,YAAY,CAEzB;IAEQ,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,cAAc,EAAE,MAAM,GAAG,QAAQ,CAAC;IAQzF,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,cAAc,CAAC;IAO/E,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,cAAc,CAAC;CAMnF;AAED,qBAAa,YAAa,SAAQ,MAAM;;gBAK1B,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM;IAUzD,IAAI,OAAO,IAAI,YAAY,EAAE,CAE5B;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,MAAM,IAAI,YAAY,CAEzB;IAEQ,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAC7C,IAAI,CAAC,YAAY,EAAE,SAAS,GAAG,aAAa,GAAG,QAAQ,CAAC;IAS1D,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC;IAO3E,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC;CAM/E;AAED,qBAAa,mBAAoB,SAAQ,MAAM;;gBAIjC,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM;IAYzD,IAAI,WAAW,IAAI,aAAa,EAAE,CAEjC;IAED,IAAI,MAAM,IAAI,YAAY,CAEzB;IAEQ,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAC7C,IAAI,CAAC,mBAAmB,EAAE,aAAa,GAAG,QAAQ,CAAC;IAQrD,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,6BAA6B,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAOzF,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,gCAAgC,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAM7F;AAED,qBAAa,eAAgB,SAAQ,MAAM;;gBAK7B,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM;IAiBzD,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED,IAAI,SAAS,IAAI,qBAAqB,EAAE,CAEvC;IAED,IAAI,OAAO,IAAI,MAAM,GAAG,OAAO,CAE9B;IAEQ,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAC7C,IAAI,CAAC,eAAe,EAAE,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;IAS3D,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,eAAe,CAAC;IAOjF,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,eAAe,CAAC;CAMrF;AAED,qBAAa,YAAa,SAAQ,MAAM;;gBAO1B,UAAU,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM;IAczD,IAAI,MAAM,IAAI,WAAW,EAAE,CAE1B;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,GAAG,IAAI,MAAM,CAEhB;IAEQ,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAC7C,IAAI,CAAC,YAAY,EAAE,QAAQ,GAAG,MAAM,GAAG,eAAe,GAAG,QAAQ,GAAG,KAAK,CAAC;IAW5E,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,YAAY,CAAC;IAO3E,gBAAgB;WACH,MAAM,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC;CAM/E;AAED,KAAK,aAAa,GAAG;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,qBAAa,oBAAqB,SAAQ,MAAM;;gBAI5C,sBAAsB,EAAE,2BAA2B,EACnD,UAAU,EAAE,UAAU,EACtB,aAAa,EAAE,MAAM;IAoBvB,IAAI,KAAK,IAAI,aAAa,EAAE,CAE3B;IAEQ,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,IAAI,CAAC,oBAAoB,EAAE,OAAO,CAAC;CAMtF"}