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

package/models/User.d.ts

@@ -0,0 +1,238 @@
+import type { User as UserProto } from '@devvit/protos';
+import type { T2ID } from '@devvit/shared-types/tid.js';
+import type { GetCommentsByUserOptions } from './Comment.js';
+import { Comment } from './Comment.js';
+import type { UserFlair } from './Flair.js';
+import type { ListingFetchOptions } from './Listing.js';
+import { Listing } from './Listing.js';
+import type { GetPostsByUserOptions } from './Post.js';
+import { Post } from './Post.js';
+export type GetSubredditUsersByTypeOptions = ListingFetchOptions & {
+    subredditName: string;
+    type: 'banned' | 'muted' | 'wikibanned' | 'contributors' | 'wikicontributors' | 'moderators';
+    username?: string;
+};
+export type RelationshipType = 'moderator_invite' | 'contributor' | 'banned' | 'muted' | 'wikibanned' | 'wikicontributor';
+export type ModeratorPermission = 'all' | 'wiki' | 'posts' | 'access' | 'mail' | 'config' | 'flair' | 'chat_operator' | 'chat_config' | 'channels' | 'community_chat';
+export type CreateRelationshipOptions = {
+    subredditName: string;
+    username: string;
+    type: RelationshipType;
+    /** The ID of the post or comment that caused the ban. */
+    banContext?: string | undefined;
+    banMessage?: string | undefined;
+    banReason?: string | undefined;
+    duration?: number | undefined;
+    note?: string | undefined;
+    permissions?: ModeratorPermission[];
+};
+export type RemoveRelationshipOptions = {
+    subredditName: string;
+    username: string;
+    type: RelationshipType | 'moderator';
+};
+export type BanUserOptions = {
+    username: string;
+    subredditName: string;
+    context?: string;
+    message?: string;
+    reason?: string;
+    duration?: number;
+    note?: string;
+};
+export type BanWikiContributorOptions = {
+    username: string;
+    subredditName: string;
+    reason?: string;
+    duration?: number;
+    note?: string;
+};
+export type GetUserOverviewOptions = {
+    username: string;
+    sort?: 'hot' | 'new' | 'top' | 'controversial';
+    timeframe?: 'hour' | 'day' | 'week' | 'month' | 'year' | 'all';
+    pageSize?: number;
+    limit?: number;
+    after?: string;
+    before?: string;
+};
+export declare const enum SocialLinkType {
+    Custom = "CUSTOM",
+    Reddit = "REDDIT",
+    Instagram = "INSTAGRAM",
+    Twitter = "TWITTER",
+    Tiktok = "TIKTOK",
+    Twitch = "TWITCH",
+    Facebook = "FACEBOOK",
+    Youtube = "YOUTUBE",
+    Tumblr = "TUMBLR",
+    Spotify = "SPOTIFY",
+    Soundcloud = "SOUNDCLOUD",
+    Beacons = "BEACONS",
+    Linktree = "LINKTREE",
+    Discord = "DISCORD",
+    Venmo = "VENMO",
+    CashApp = "CASH_APP",
+    Patreon = "PATREON",
+    Kofi = "KOFI",
+    Paypal = "PAYPAL",
+    Cameo = "CAMEO",
+    Onlyfans = "ONLYFANS",
+    Substack = "SUBSTACK",
+    Kickstarter = "KICKSTARTER",
+    Indiegogo = "INDIEGOGO",
+    BuyMeACoffee = "BUY_ME_A_COFFEE",
+    Shopify = "SHOPIFY"
+}
+/**
+ * @field id: ID of the social link.
+ *
+ * @field handle: Display name of social media link.
+ *
+ * @field outboundUrl: Outbound url of social media link.
+ *
+ * @field type: Type of social media link i.e. Instagram, YouTube.
+ *
+ * @field title: Title or name of social media link.
+ */
+export type UserSocialLink = {
+    id: string;
+    handle?: string;
+    outboundUrl: string;
+    type: SocialLinkType;
+    title: string;
+};
+/**
+ * A class representing a user.
+ */
+export declare class User {
+    #private;
+    /**
+     * @internal
+     */
+    constructor(data: UserProto & {
+        modPermissions?: {
+            [subredditName: string]: string[];
+        };
+    });
+    /**
+     * The ID (starting with t2_) of the user to retrieve.
+     * @example 't2_1w72'
+     */
+    get id(): T2ID;
+    /**
+     * The username of the user omitting the u/.
+     * @example 'spez'
+     */
+    get username(): string;
+    /**
+     * The date the user was created.
+     */
+    get createdAt(): Date;
+    /**
+     * The amount of link karma the user has.
+     */
+    get linkKarma(): number;
+    /**
+     * The amount of comment karma the user has.
+     */
+    get commentKarma(): number;
+    /**
+     * Whether the user's profile is marked as NSFW (Not Safe For Work).
+     */
+    get nsfw(): boolean;
+    /**
+     * Whether the user is admin.
+     */
+    get isAdmin(): boolean;
+    /**
+     * The permissions the user has on the subreddit.
+     */
+    get modPermissions(): Map<string, ModeratorPermission[]>;
+    /**
+     * Returns the HTTP URL for the user
+     */
+    get url(): string;
+    /**
+     * Returns a permalink path relative to https://www.reddit.com
+     */
+    get permalink(): string;
+    /**
+     * Indicates whether or not the user has verified their email address.
+     */
+    get hasVerifiedEmail(): boolean;
+    toJSON(): Pick<User, 'id' | 'username' | 'createdAt' | 'linkKarma' | 'commentKarma' | 'nsfw'> & {
+        modPermissionsBySubreddit: Record<string, ModeratorPermission[]>;
+    };
+    /**
+     * 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
+     */
+    getModPermissionsForSubreddit(subredditName: string): Promise<ModeratorPermission[]>;
+    /**
+     * 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: Omit<GetCommentsByUserOptions, 'username'>): Listing<Comment>;
+    /**
+     * 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: Omit<GetPostsByUserOptions, 'username'>): Listing<Post>;
+    /**
+     * 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);
+     * ```
+     */
+    getUserFlairBySubreddit(subreddit: string): Promise<UserFlair | undefined>;
+    getSnoovatarUrl(): Promise<string | undefined>;
+    /**
+     * Gets social links of the user
+     *
+     * @returns A Promise that resolves an Array of UserSocialLink objects
+     * @example
+     * ```ts
+     * const socialLinks = await user.getSocialLinks();
+     * ```
+     */
+    getSocialLinks(): Promise<UserSocialLink[]>;
+    /** @internal */
+    static getById(id: T2ID): Promise<User | undefined>;
+    /** @internal */
+    static getByUsername(username: string): Promise<User | undefined>;
+    /** @internal */
+    static getSubredditUsersByType(options: GetSubredditUsersByTypeOptions): Listing<User>;
+    /** @internal */
+    static createRelationship(options: CreateRelationshipOptions): Promise<void>;
+    /** @internal */
+    static removeRelationship(options: RemoveRelationshipOptions): Promise<void>;
+    /** @internal */
+    static setModeratorPermissions(username: string, subredditName: string, permissions: ModeratorPermission[]): Promise<void>;
+    /** @internal */
+    static getSnoovatarUrl(username: string): Promise<string | undefined>;
+    /** @internal */
+    static getOverview(options: GetUserOverviewOptions): Listing<Post | Comment>;
+}
+//# sourceMappingURL=User.d.ts.map

package/models/User.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"User.d.ts","sourceRoot":"","sources":["../../src/models/User.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,IAAI,IAAI,SAAS,EAGlB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAOxD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAE5C,OAAO,KAAK,EAAE,mBAAmB,EAAwB,MAAM,cAAc,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AACvD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,MAAM,MAAM,8BAA8B,GAAG,mBAAmB,GAAG;IACjE,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,cAAc,GAAG,kBAAkB,GAAG,YAAY,CAAC;IAC7F,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,kBAAkB,GAClB,aAAa,GACb,QAAQ,GACR,OAAO,GACP,YAAY,GACZ,iBAAiB,CAAC;AAEtB,MAAM,MAAM,mBAAmB,GAC3B,KAAK,GACL,MAAM,GACN,OAAO,GACP,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,OAAO,GACP,eAAe,GACf,aAAa,GACb,UAAU,GACV,gBAAgB,CAAC;AAErB,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,gBAAgB,CAAC;IACvB,yDAAyD;IACzD,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,WAAW,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,gBAAgB,GAAG,WAAW,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,KAAK,GAAG,KAAK,GAAG,KAAK,GAAG,eAAe,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,CAAC;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,0BAAkB,cAAc;IAC9B,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;IACjB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,OAAO,aAAa;IACpB,OAAO,YAAY;IACnB,IAAI,SAAS;IACb,MAAM,WAAW;IACjB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,YAAY,oBAAoB;IAChC,OAAO,YAAY;CACpB;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAOF;;GAEG;AACH,qBAAa,IAAI;;IAef;;OAEG;gBACS,IAAI,EAAE,SAAS,GAAG;QAAE,cAAc,CAAC,EAAE;YAAE,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;SAAE,CAAA;KAAE;IA+BxF;;;OAGG;IACH,IAAI,EAAE,IAAI,IAAI,CAEb;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,OAAO,CAElB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,cAAc,IAAI,GAAG,CAAC,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAEvD;IAED;;OAEG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED,MAAM,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,cAAc,GAAG,MAAM,CAAC,GAAG;QAC9F,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,EAAE,CAAC,CAAC;KAClE;IAYD;;;;;OAKG;IACG,6BAA6B,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAwB1F;;;;;;;;;OASG;IACH,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,wBAAwB,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAOlF;;;;;;;;;OASG;IACH,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAOzE;;;;;;;;;;;;OAYG;IACG,uBAAuB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,GAAG,SAAS,CAAC;IAQhF,eAAe,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAI9C;;;;;;;;OAQG;IACG,cAAc,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAiBjD,gBAAgB;WACH,OAAO,CAAC,EAAE,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAMzD,gBAAgB;WACH,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC;IAcvE,gBAAgB;IAChB,MAAM,CAAC,uBAAuB,CAAC,OAAO,EAAE,8BAA8B,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBtF,gBAAgB;WACH,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBlF,gBAAgB;WACH,kBAAkB,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAalF,gBAAgB;WACH,uBAAuB,CAClC,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,EACrB,WAAW,EAAE,mBAAmB,EAAE,GACjC,OAAO,CAAC,IAAI,CAAC;IAkBhB,gBAAgB;WACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAO3E,gBAAgB;IAChB,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC;CA0B7E"}