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

package/models/Flair.d.ts

@@ -0,0 +1,171 @@
+import { type FlairCsvResult, type FlairObject, type UserFlair as UserFlairProto } from '@devvit/protos';
+import type { T3ID } from '@devvit/shared-types/tid.js';
+export declare enum FlairType {
+    User = "USER_FLAIR",
+    Post = "LINK_FLAIR"
+}
+export type AllowableFlairContent = 'all' | 'emoji' | 'text';
+export type FlairTextColor = 'light' | 'dark';
+export type FlairBackgroundColor = `#${string}` | 'transparent';
+export type CreateFlairTemplateOptions = {
+    /** The name of the subreddit to create the flair template in. */
+    subredditName: string;
+    /** The flair template's allowable content. Either 'all', 'emoji', or 'text'. */
+    allowableContent?: AllowableFlairContent;
+    /** The background color of the flair. Either 'transparent' or a hex color code. e.g. #FFC0CB */
+    backgroundColor?: string;
+    maxEmojis?: number;
+    /** Whether or not this flair template is only available to moderators. */
+    modOnly?: boolean;
+    /** The text to display in the flair. */
+    text: string;
+    /** Either 'dark' or 'light'. */
+    textColor?: FlairTextColor;
+    /** Whether or not users are allowed to edit this flair template before using it. */
+    allowUserEdits?: boolean;
+};
+export type EditFlairTemplateOptions = CreateFlairTemplateOptions & {
+    id: string;
+};
+export declare class FlairTemplate {
+    #private;
+    /**
+     * @internal
+     */
+    constructor(data: FlairObject, subredditName: string);
+    /** The flair template's ID */
+    get id(): string;
+    /** The flair template's text */
+    get text(): string;
+    /** The flair template's text color. Either 'dark' or 'light'. */
+    get textColor(): FlairTextColor;
+    /** The flair template's background color. Either 'transparent' or a hex color code. e.g. #FFC0CB */
+    get backgroundColor(): FlairBackgroundColor;
+    /** The flair template's allowable content. Either 'all', 'emoji', or 'text'. */
+    get allowableContent(): AllowableFlairContent;
+    /** Is the flair template only available to moderators? */
+    get modOnly(): boolean;
+    /** The flair template's maximum number of emojis. */
+    get maxEmojis(): number;
+    /** Does the flair template allow users to edit their flair? */
+    get allowUserEdits(): boolean;
+    /** Delete this flair template */
+    delete(): Promise<void>;
+    /** Edit this flair template */
+    edit(options: Partial<Omit<EditFlairTemplateOptions, 'id' | 'subredditName'>>): Promise<FlairTemplate>;
+    /** @internal */
+    static createPostFlairTemplate(options: CreateFlairTemplateOptions): Promise<FlairTemplate>;
+    /** @internal */
+    static createUserFlairTemplate(options: CreateFlairTemplateOptions): Promise<FlairTemplate>;
+    /** @internal */
+    static editFlairTemplate(editOptions: EditFlairTemplateOptions): Promise<FlairTemplate>;
+    /** @internal */
+    static getPostFlairTemplates(subredditName: string): Promise<FlairTemplate[]>;
+    /** @internal */
+    static getUserFlairTemplates(subredditName: string): Promise<FlairTemplate[]>;
+    /** @internal */
+    static deleteFlairTemplate(subredditName: string, flairTemplateId: string): Promise<void>;
+}
+export type SetFlairOptions = {
+    /** The name of the subreddit of the item to set the flair on */
+    subredditName: string;
+    /** The flair template's ID */
+    flairTemplateId?: string;
+    /** The flair text */
+    text?: string;
+    /** The flair CSS class */
+    cssClass?: string;
+    /** The flair text color. Either 'dark' or 'light'. */
+    textColor?: FlairTextColor;
+    /** The flair background color. Either 'transparent' or a hex color code. e.g. #FFC0CB */
+    backgroundColor?: string;
+};
+export type SetUserFlairOptions = SetFlairOptions & {
+    /** The username of the user to set the flair on */
+    username: string;
+};
+export type SetPostFlairOptions = SetFlairOptions & {
+    /** The ID of the post to set the flair on */
+    postId: string;
+};
+export type InternalSetPostFlairOptions = SetFlairOptions & {
+    postId: T3ID;
+};
+export type SetUserFlairBatchConfig = {
+    /** The username of the user to edit the flair on */
+    username: string;
+    /** The flair text. Can't contain the comma character (",") */
+    text?: string | undefined;
+    /** The flair CSS class */
+    cssClass?: string | undefined;
+};
+export type UserFlairPageOptions = {
+    /** A user id optionally provided which will result in a slice of user flairs, starting after this user, to be returned.  */
+    after?: string;
+    /** A user id optionally provided which will result in a slice of user flairs, starting before this user, to be returned.  */
+    before?: string;
+    /** A limit to the number of flairs that will be returned. Default: 25, Max: 1000  */
+    limit?: number;
+};
+export type GetUserFlairBySubredditOptions = UserFlairPageOptions & {
+    /** The subreddit associated with the flair being retrieved. */
+    subreddit: string;
+    /** The username associated with the flair being retrieved. */
+    name?: string;
+};
+export type UserFlair = {
+    /** The CSS class applied to this flair in the UI. */
+    flairCssClass?: string | undefined;
+    /** The username of the user to which this flair is assigned.*/
+    user?: string | undefined;
+    /** The text displayed in the UI for this flair. */
+    flairText?: string | undefined;
+};
+export type GetUserFlairBySubredditResponse = {
+    /** The list of user flair */
+    users: UserFlair[];
+    /** The user id of the last user flair in this slice. Its presence indicates
+     * that there are more items that can be fetched. Pass this into the "after" parameter
+     * in the next call to get the next slice of data  */
+    next?: string | undefined;
+    /** The user id of the first user flair in this slice. Its presence indicates
+     * that there are items before this item that can be fetched. Pass this into the "before" parameter
+     * in the next call to get the previous slice of data  */
+    prev?: string | undefined;
+};
+/** @internal */
+export declare function convertUserFlairProtoToAPI(userFlair: UserFlairProto): UserFlair;
+export declare class Flair {
+    #private;
+    /**
+     * Exposes the ListFlair API. This method will return the list of user flair for the subreddit. If name
+     * is specified then it will return the user flair for the given user.
+     *
+     * @param { GetUserFlairBySubredditOptions } options See the interface
+     *
+     * @returns { Promise<GetUserFlairBySubredditResponse> }
+     *
+     * @example
+     * ```ts
+     * const response = await reddit.flair.getUserFlairBySubreddit({
+     *      subreddit: "EyeBleach",
+     *      name: "badapple"
+     *   },
+     *   metadata
+     * );
+     * ```
+     * @internal
+     */
+    static getUserFlairBySubreddit(options: GetUserFlairBySubredditOptions): Promise<GetUserFlairBySubredditResponse>;
+    /** @internal */
+    static setUserFlair(options: SetUserFlairOptions): Promise<void>;
+    /** @internal */
+    static setUserFlairBatch(subredditName: string, flairs: SetUserFlairBatchConfig[]): Promise<FlairCsvResult[]>;
+    /** @internal */
+    static setPostFlair(options: SetPostFlairOptions): Promise<void>;
+    /** @internal */
+    static removePostFlair(subredditName: string, postId: T3ID): Promise<void>;
+    /** @internal */
+    static removeUserFlair(subredditName: string, username: string): Promise<void>;
+}
+//# sourceMappingURL=Flair.d.ts.map

package/models/Flair.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Flair.d.ts","sourceRoot":"","sources":["../../src/models/Flair.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,WAAW,EAEhB,KAAK,SAAS,IAAI,cAAc,EACjC,MAAM,gBAAgB,CAAC;AAGxB,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAMxD,oBAAY,SAAS;IACnB,IAAI,eAAe;IACnB,IAAI,eAAe;CACpB;AAED,MAAM,MAAM,qBAAqB,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;AAC7D,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,CAAC;AAC9C,MAAM,MAAM,oBAAoB,GAAG,IAAI,MAAM,EAAE,GAAG,aAAa,CAAC;AAEhE,MAAM,MAAM,0BAA0B,GAAG;IACvC,iEAAiE;IACjE,aAAa,EAAE,MAAM,CAAC;IACtB,gFAAgF;IAChF,gBAAgB,CAAC,EAAE,qBAAqB,CAAC;IACzC,gGAAgG;IAChG,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0EAA0E;IAC1E,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,oFAAoF;IACpF,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,0BAA0B,GAAG;IAClE,EAAE,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,qBAAa,aAAa;;IAWxB;;OAEG;gBACS,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,MAAM;IAiBpD,8BAA8B;IAC9B,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,gCAAgC;IAChC,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,iEAAiE;IACjE,IAAI,SAAS,IAAI,cAAc,CAE9B;IAED,oGAAoG;IACpG,IAAI,eAAe,IAAI,oBAAoB,CAE1C;IAED,gFAAgF;IAChF,IAAI,gBAAgB,IAAI,qBAAqB,CAE5C;IAED,0DAA0D;IAC1D,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,qDAAqD;IACrD,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,+DAA+D;IAC/D,IAAI,cAAc,IAAI,OAAO,CAE5B;IAED,iCAAiC;IAC3B,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B,+BAA+B;IACzB,IAAI,CACR,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,IAAI,GAAG,eAAe,CAAC,CAAC,GACvE,OAAO,CAAC,aAAa,CAAC;IAczB,gBAAgB;WACH,uBAAuB,CAClC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAIzB,gBAAgB;WACH,uBAAuB,CAClC,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,aAAa,CAAC;IAIzB,gBAAgB;WACH,iBAAiB,CAAC,WAAW,EAAE,wBAAwB,GAAG,OAAO,CAAC,aAAa,CAAC;IAgD7F,gBAAgB;WACH,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAanF,gBAAgB;WACH,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAanF,gBAAgB;WACH,mBAAmB,CAAC,aAAa,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAehG;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,gEAAgE;IAChE,aAAa,EAAE,MAAM,CAAC;IACtB,8BAA8B;IAC9B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,qBAAqB;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B,yFAAyF;IACzF,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG;IAClD,mDAAmD;IACnD,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,eAAe,GAAG;IAClD,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,2BAA2B,GAAG,eAAe,GAAG;IAC1D,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,0BAA0B;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,4HAA4H;IAC5H,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6HAA6H;IAC7H,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qFAAqF;IACrF,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG,oBAAoB,GAAG;IAClE,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,6BAA6B;IAC7B,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB;;yDAEqD;IACrD,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B;;6DAEyD;IACzD,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,gBAAgB;AAChB,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,cAAc,GAAG,SAAS,CAM/E;AAED,qBAAa,KAAK;;IAChB;;;;;;;;;;;;;;;;;;OAkBG;WACU,uBAAuB,CAClC,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,+BAA+B,CAAC;IAK3C,gBAAgB;IAChB,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhE,gBAAgB;IAChB,MAAM,CAAC,iBAAiB,CACtB,aAAa,EAAE,MAAM,EACrB,MAAM,EAAE,uBAAuB,EAAE,GAChC,OAAO,CAAC,cAAc,EAAE,CAAC;IAI5B,gBAAgB;IAChB,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAsEhE,gBAAgB;WACH,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhF,gBAAgB;WACH,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CA8BrF"}

package/models/Flair.js

@@ -0,0 +1,293 @@
+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, _FlairTemplate_id, _FlairTemplate_subredditName, _FlairTemplate_text, _FlairTemplate_textColor, _FlairTemplate_backgroundColor, _FlairTemplate_allowableContent, _FlairTemplate_modOnly, _FlairTemplate_maxEmojis, _FlairTemplate_allowUserEdits, _FlairTemplate_createOrUpdateFlairTemplate, _FlairTemplate_metadata_get, _b, _Flair_setFlair, _Flair_setUserFlairBatch, _Flair_removeFlair, _Flair_metadata_get;
+import {} from '@devvit/protos';
+import { getContext } from '@devvit/server';
+import { assertNonNull } from '@devvit/shared-types/NonNull.js';
+import { asT3ID } from '@devvit/shared-types/tid.js';
+import { getRedditApiPlugins } from '../getRedditApiPlugins.js';
+import { makeGettersEnumerable } from '../helpers/makeGettersEnumerable.js';
+export var FlairType;
+(function (FlairType) {
+    FlairType["User"] = "USER_FLAIR";
+    FlairType["Post"] = "LINK_FLAIR";
+})(FlairType || (FlairType = {}));
+export class FlairTemplate {
+    /**
+     * @internal
+     */
+    constructor(data, subredditName) {
+        _FlairTemplate_id.set(this, void 0);
+        _FlairTemplate_subredditName.set(this, void 0);
+        _FlairTemplate_text.set(this, void 0);
+        _FlairTemplate_textColor.set(this, void 0);
+        _FlairTemplate_backgroundColor.set(this, void 0);
+        _FlairTemplate_allowableContent.set(this, void 0);
+        _FlairTemplate_modOnly.set(this, void 0);
+        _FlairTemplate_maxEmojis.set(this, void 0);
+        _FlairTemplate_allowUserEdits.set(this, void 0);
+        makeGettersEnumerable(this);
+        assertNonNull(data.id);
+        assertNonNull(data.text);
+        __classPrivateFieldSet(this, _FlairTemplate_id, data.id, "f");
+        __classPrivateFieldSet(this, _FlairTemplate_subredditName, subredditName, "f");
+        __classPrivateFieldSet(this, _FlairTemplate_text, data.text, "f");
+        __classPrivateFieldSet(this, _FlairTemplate_textColor, asFlairTextColor(data.textColor), "f");
+        __classPrivateFieldSet(this, _FlairTemplate_backgroundColor, asFlairBackgroundColor(data.backgroundColor), "f");
+        __classPrivateFieldSet(this, _FlairTemplate_allowableContent, asAllowableContent(data.allowableContent), "f");
+        __classPrivateFieldSet(this, _FlairTemplate_modOnly, data.modOnly, "f");
+        __classPrivateFieldSet(this, _FlairTemplate_maxEmojis, data.maxEmojis, "f");
+        __classPrivateFieldSet(this, _FlairTemplate_allowUserEdits, data.textEditable, "f");
+    }
+    /** The flair template's ID */
+    get id() {
+        return __classPrivateFieldGet(this, _FlairTemplate_id, "f");
+    }
+    /** The flair template's text */
+    get text() {
+        return __classPrivateFieldGet(this, _FlairTemplate_text, "f");
+    }
+    /** The flair template's text color. Either 'dark' or 'light'. */
+    get textColor() {
+        return __classPrivateFieldGet(this, _FlairTemplate_textColor, "f");
+    }
+    /** The flair template's background color. Either 'transparent' or a hex color code. e.g. #FFC0CB */
+    get backgroundColor() {
+        return __classPrivateFieldGet(this, _FlairTemplate_backgroundColor, "f");
+    }
+    /** The flair template's allowable content. Either 'all', 'emoji', or 'text'. */
+    get allowableContent() {
+        return __classPrivateFieldGet(this, _FlairTemplate_allowableContent, "f");
+    }
+    /** Is the flair template only available to moderators? */
+    get modOnly() {
+        return __classPrivateFieldGet(this, _FlairTemplate_modOnly, "f");
+    }
+    /** The flair template's maximum number of emojis. */
+    get maxEmojis() {
+        return __classPrivateFieldGet(this, _FlairTemplate_maxEmojis, "f");
+    }
+    /** Does the flair template allow users to edit their flair? */
+    get allowUserEdits() {
+        return __classPrivateFieldGet(this, _FlairTemplate_allowUserEdits, "f");
+    }
+    /** Delete this flair template */
+    async delete() {
+        return _a.deleteFlairTemplate(__classPrivateFieldGet(this, _FlairTemplate_id, "f"), __classPrivateFieldGet(this, _FlairTemplate_subredditName, "f"));
+    }
+    /** Edit this flair template */
+    async edit(options) {
+        return _a.editFlairTemplate({
+            id: __classPrivateFieldGet(this, _FlairTemplate_id, "f"),
+            subredditName: __classPrivateFieldGet(this, _FlairTemplate_subredditName, "f"),
+            text: options.text ?? __classPrivateFieldGet(this, _FlairTemplate_text, "f"),
+            allowableContent: options.allowableContent ?? __classPrivateFieldGet(this, _FlairTemplate_allowableContent, "f"),
+            backgroundColor: options.backgroundColor ?? __classPrivateFieldGet(this, _FlairTemplate_backgroundColor, "f"),
+            maxEmojis: options.maxEmojis ?? __classPrivateFieldGet(this, _FlairTemplate_maxEmojis, "f"),
+            modOnly: options.modOnly ?? __classPrivateFieldGet(this, _FlairTemplate_modOnly, "f"),
+            textColor: options.textColor ?? __classPrivateFieldGet(this, _FlairTemplate_textColor, "f"),
+            allowUserEdits: options.allowUserEdits ?? __classPrivateFieldGet(this, _FlairTemplate_allowUserEdits, "f"),
+        });
+    }
+    /** @internal */
+    static async createPostFlairTemplate(options) {
+        return __classPrivateFieldGet(_a, _a, "m", _FlairTemplate_createOrUpdateFlairTemplate).call(_a, { ...options, flairType: FlairType.Post });
+    }
+    /** @internal */
+    static async createUserFlairTemplate(options) {
+        return __classPrivateFieldGet(_a, _a, "m", _FlairTemplate_createOrUpdateFlairTemplate).call(_a, { ...options, flairType: FlairType.User });
+    }
+    /** @internal */
+    static async editFlairTemplate(editOptions) {
+        return __classPrivateFieldGet(_a, _a, "m", _FlairTemplate_createOrUpdateFlairTemplate).call(_a, editOptions);
+    }
+    /** @internal */
+    static async getPostFlairTemplates(subredditName) {
+        const client = getRedditApiPlugins().Flair;
+        const response = await client.LinkFlair({
+            subreddit: subredditName,
+        }, __classPrivateFieldGet(this, _a, "a", _FlairTemplate_metadata_get));
+        return response.flair?.map((flair) => new _a(flair, subredditName)) || [];
+    }
+    /** @internal */
+    static async getUserFlairTemplates(subredditName) {
+        const client = getRedditApiPlugins().Flair;
+        const response = await client.UserFlair({
+            subreddit: subredditName,
+        }, __classPrivateFieldGet(this, _a, "a", _FlairTemplate_metadata_get));
+        return response.flair?.map((flair) => new _a(flair, subredditName)) || [];
+    }
+    /** @internal */
+    static async deleteFlairTemplate(subredditName, flairTemplateId) {
+        const client = getRedditApiPlugins().Flair;
+        await client.DeleteFlairTemplate({
+            subreddit: subredditName,
+            flairTemplateId,
+        }, __classPrivateFieldGet(this, _a, "a", _FlairTemplate_metadata_get));
+    }
+}
+_a = FlairTemplate, _FlairTemplate_id = new WeakMap(), _FlairTemplate_subredditName = new WeakMap(), _FlairTemplate_text = new WeakMap(), _FlairTemplate_textColor = new WeakMap(), _FlairTemplate_backgroundColor = new WeakMap(), _FlairTemplate_allowableContent = new WeakMap(), _FlairTemplate_modOnly = new WeakMap(), _FlairTemplate_maxEmojis = new WeakMap(), _FlairTemplate_allowUserEdits = new WeakMap(), _FlairTemplate_createOrUpdateFlairTemplate = async function _FlairTemplate_createOrUpdateFlairTemplate(options) {
+    const { subredditName: subreddit, allowableContent = 'all', backgroundColor = 'transparent', flairType = '', maxEmojis = 10, modOnly = false, text, textColor = 'dark', allowUserEdits: textEditable = false, id: flairTemplateId = '', } = options;
+    if (modOnly && textEditable) {
+        throw new Error('Cannot have a mod only flair that is editable by users');
+    }
+    const client = getRedditApiPlugins().Flair;
+    const response = await client.FlairTemplate({
+        subreddit,
+        allowableContent,
+        backgroundColor,
+        flairType,
+        maxEmojis,
+        modOnly,
+        text,
+        textColor,
+        textEditable,
+        flairTemplateId,
+        cssClass: '',
+        overrideCss: false,
+    }, __classPrivateFieldGet(this, _a, "a", _FlairTemplate_metadata_get));
+    return new _a(response, subreddit);
+}, _FlairTemplate_metadata_get = function _FlairTemplate_metadata_get() {
+    return getContext().debug.metadata;
+};
+/** @internal */
+export function convertUserFlairProtoToAPI(userFlair) {
+    return {
+        flairCssClass: userFlair.flairCssClass,
+        user: userFlair.user,
+        flairText: userFlair.flairText,
+    };
+}
+export class Flair {
+    /**
+     * Exposes the ListFlair API. This method will return the list of user flair for the subreddit. If name
+     * is specified then it will return the user flair for the given user.
+     *
+     * @param { GetUserFlairBySubredditOptions } options See the interface
+     *
+     * @returns { Promise<GetUserFlairBySubredditResponse> }
+     *
+     * @example
+     * ```ts
+     * const response = await reddit.flair.getUserFlairBySubreddit({
+     *      subreddit: "EyeBleach",
+     *      name: "badapple"
+     *   },
+     *   metadata
+     * );
+     * ```
+     * @internal
+     */
+    static async getUserFlairBySubreddit(options) {
+        const client = getRedditApiPlugins().Flair;
+        return client.FlairList(options, __classPrivateFieldGet(this, _b, "a", _Flair_metadata_get));
+    }
+    /** @internal */
+    static setUserFlair(options) {
+        return __classPrivateFieldGet(_b, _b, "m", _Flair_setFlair).call(_b, options);
+    }
+    /** @internal */
+    static setUserFlairBatch(subredditName, flairs) {
+        return __classPrivateFieldGet(_b, _b, "m", _Flair_setUserFlairBatch).call(_b, subredditName, flairs);
+    }
+    /** @internal */
+    static setPostFlair(options) {
+        return __classPrivateFieldGet(_b, _b, "m", _Flair_setFlair).call(_b, {
+            ...options,
+            postId: asT3ID(options.postId),
+        });
+    }
+    /** @internal */
+    static async removePostFlair(subredditName, postId) {
+        return __classPrivateFieldGet(_b, _b, "m", _Flair_removeFlair).call(_b, subredditName, postId, undefined);
+    }
+    /** @internal */
+    static async removeUserFlair(subredditName, username) {
+        return __classPrivateFieldGet(_b, _b, "m", _Flair_removeFlair).call(_b, subredditName, undefined, username);
+    }
+}
+_b = Flair, _Flair_setFlair = async function _Flair_setFlair(options) {
+    const client = getRedditApiPlugins().Flair;
+    await client.SelectFlair({
+        subreddit: options.subredditName,
+        flairTemplateId: options.flairTemplateId ?? '',
+        text: options.text ?? '',
+        name: options.username,
+        link: options.postId,
+        backgroundColor: options.backgroundColor ?? '',
+        textColor: options.textColor ?? 'dark',
+        cssClass: options.cssClass ?? '',
+        returnRtjson: 'none',
+    }, __classPrivateFieldGet(this, _b, "a", _Flair_metadata_get));
+}, _Flair_setUserFlairBatch = async function _Flair_setUserFlairBatch(subredditName, flairs) {
+    if (!flairs.length) {
+        return [];
+    }
+    const maxFlairsPerRequest = 100;
+    if (flairs.length > maxFlairsPerRequest) {
+        throw new Error('Unexpected input: flairs array cannot be longer than 100 entries.');
+    }
+    const csvDelimiter = ',';
+    const flairCsv = flairs
+        .map((userConfig) => {
+        for (const propertyName in userConfig) {
+            if (userConfig[propertyName]?.includes(csvDelimiter)) {
+                throw new Error(`Unexpected input: ${propertyName} cannot contain the "," character`);
+            }
+        }
+        return [userConfig.username, userConfig.text || '', userConfig.cssClass || ''].join(csvDelimiter);
+    })
+        .join('\n');
+    const client = getRedditApiPlugins().Flair;
+    const response = await client.FlairCsv({
+        subreddit: subredditName,
+        flairCsv,
+    }, __classPrivateFieldGet(this, _b, "a", _Flair_metadata_get));
+    return response.result;
+}, _Flair_removeFlair = async function _Flair_removeFlair(subredditName, postId, username) {
+    const client = getRedditApiPlugins().Flair;
+    await client.SelectFlair({
+        subreddit: subredditName,
+        name: username ?? '',
+        link: postId ?? '',
+        flairTemplateId: '',
+        backgroundColor: '',
+        text: '',
+        textColor: '',
+        cssClass: '',
+        returnRtjson: 'none',
+    }, __classPrivateFieldGet(this, _b, "a", _Flair_metadata_get));
+}, _Flair_metadata_get = function _Flair_metadata_get() {
+    return getContext().debug.metadata;
+};
+function asFlairTextColor(color) {
+    assertNonNull(color, 'Flair text color is required');
+    if (color === 'light' || color === 'dark') {
+        return color;
+    }
+    throw new Error(`Invalid flair text color: ${color}`);
+}
+function asFlairBackgroundColor(color) {
+    if (!color || color.length === 0 || color === 'transparent') {
+        return 'transparent';
+    }
+    if (/^#([A-Fa-f0-9]{6})$/.test(color)) {
+        return color;
+    }
+    throw new Error(`Invalid flair background color: ${color}`);
+}
+function asAllowableContent(allowableContent) {
+    if (allowableContent === 'all' || allowableContent === 'text' || allowableContent === 'emoji') {
+        return allowableContent;
+    }
+    throw new Error(`Invalid allowable content: ${allowableContent}`);
+}

package/models/Listing.d.ts

@@ -0,0 +1,53 @@
+import type { T1ID, T3ID } from '@devvit/shared-types/tid.js';
+export type MoreObject = {
+    parentId: T1ID | T3ID;
+    children: T1ID[];
+    depth: number;
+};
+export type ListingFetchOptions = {
+    after?: string;
+    before?: string;
+    limit?: number;
+    pageSize?: number;
+    more?: MoreObject;
+};
+export type ListingFetchResponse<T> = {
+    children: T[];
+    before?: string | undefined;
+    after?: string | undefined;
+    more?: MoreObject | undefined;
+};
+export interface Listing<T> {
+    /** @internal */
+    children: T[];
+    /** @internal */
+    _fetch: (options: ListingFetchOptions) => Promise<ListingFetchResponse<T>>;
+}
+type ListingOptions<T> = {
+    hasMore?: boolean;
+    after?: string | undefined;
+    before?: string | undefined;
+    pageSize?: number | undefined;
+    limit?: number | undefined;
+    children?: T[];
+    more?: MoreObject;
+    fetch: (options: ListingFetchOptions) => Promise<ListingFetchResponse<T>>;
+};
+export declare class Listing<T> {
+    #private;
+    pageSize: number;
+    limit: number;
+    children: T[];
+    /**
+     * @internal
+     */
+    constructor(options: ListingOptions<T>);
+    get hasMore(): boolean;
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+    setMore(more: MoreObject | undefined): void;
+    preventInitialFetch(): void;
+    all(): Promise<T[]>;
+    get(count: number): Promise<T[]>;
+}
+export {};
+//# sourceMappingURL=Listing.d.ts.map

package/models/Listing.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Listing.d.ts","sourceRoot":"","sources":["../../src/models/Listing.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAI9D,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,IAAI,GAAG,IAAI,CAAC;IACtB,QAAQ,EAAE,IAAI,EAAE,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,IAAI;IACpC,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;CAC/B,CAAC;AAEF,MAAM,WAAW,OAAO,CAAC,CAAC;IACxB,gBAAgB;IAChB,QAAQ,EAAE,CAAC,EAAE,CAAC;IACd,gBAAgB;IAChB,MAAM,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5E;AAED,KAAK,cAAc,CAAC,CAAC,IAAI;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;IACf,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,KAAK,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;CAC3E,CAAC;AAKF,qBAAa,OAAO,CAAC,CAAC;;IAMpB,QAAQ,EAAE,MAAM,CAAqB;IACrC,KAAK,EAAE,MAAM,CAAiB;IAC9B,QAAQ,EAAE,CAAC,EAAE,CAAM;IAEnB;;OAEG;gBACS,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC;IAetC,IAAI,OAAO,IAAI,OAAO,CAErB;IAEM,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC;IAyBjD,OAAO,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,GAAG,IAAI;IAI3C,mBAAmB,IAAI,IAAI;IA0BrB,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;IAQnB,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;CASvC"}

package/models/Listing.js

@@ -0,0 +1,101 @@
+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 _Listing_instances, _Listing_before, _Listing_after, _Listing_more, _Listing_started, _Listing_next;
+import { makeGettersEnumerable } from '../helpers/makeGettersEnumerable.js';
+const DEFAULT_PAGE_SIZE = 100;
+const DEFAULT_LIMIT = Infinity;
+export class Listing {
+    /**
+     * @internal
+     */
+    constructor(options) {
+        _Listing_instances.add(this);
+        _Listing_before.set(this, void 0);
+        _Listing_after.set(this, void 0);
+        _Listing_more.set(this, void 0);
+        _Listing_started.set(this, false);
+        this.pageSize = DEFAULT_PAGE_SIZE;
+        this.limit = DEFAULT_LIMIT;
+        this.children = [];
+        makeGettersEnumerable(this);
+        this._fetch = options.fetch;
+        this.pageSize = options.pageSize ?? DEFAULT_PAGE_SIZE;
+        this.limit = options.limit ?? DEFAULT_LIMIT;
+        __classPrivateFieldSet(this, _Listing_after, options.after, "f");
+        __classPrivateFieldSet(this, _Listing_before, options.before, "f");
+        __classPrivateFieldSet(this, _Listing_more, options.more, "f");
+        if (options.children) {
+            this.children = options.children;
+        }
+    }
+    get hasMore() {
+        return !__classPrivateFieldGet(this, _Listing_started, "f") || Boolean(__classPrivateFieldGet(this, _Listing_after, "f") || __classPrivateFieldGet(this, _Listing_before, "f") || __classPrivateFieldGet(this, _Listing_more, "f"));
+    }
+    async *[(_Listing_before = new WeakMap(), _Listing_after = new WeakMap(), _Listing_more = new WeakMap(), _Listing_started = new WeakMap(), _Listing_instances = new WeakSet(), Symbol.asyncIterator)]() {
+        let currentIndex = 0;
+        while (true) {
+            if (currentIndex === this.children.length) {
+                if (this.hasMore) {
+                    const nextPage = await __classPrivateFieldGet(this, _Listing_instances, "m", _Listing_next).call(this);
+                    // r2 api sometimes returns an empty page
+                    if (nextPage.length === 0) {
+                        break;
+                    }
+                }
+                else {
+                    break;
+                }
+            }
+            yield this.children[currentIndex];
+            currentIndex++;
+            if (currentIndex === this.limit) {
+                break;
+            }
+        }
+    }
+    setMore(more) {
+        __classPrivateFieldSet(this, _Listing_more, more, "f");
+    }
+    preventInitialFetch() {
+        __classPrivateFieldSet(this, _Listing_started, true, "f");
+    }
+    async all() {
+        while (this.hasMore && this.children.length < this.limit) {
+            await __classPrivateFieldGet(this, _Listing_instances, "m", _Listing_next).call(this);
+        }
+        return this.children.slice(0, this.limit);
+    }
+    async get(count) {
+        const limit = count <= this.limit ? count : this.limit;
+        while (this.hasMore && this.children.length < limit) {
+            await __classPrivateFieldGet(this, _Listing_instances, "m", _Listing_next).call(this);
+        }
+        return this.children.slice(0, limit);
+    }
+}
+_Listing_next = async function _Listing_next() {
+    if (!this.hasMore) {
+        throw new Error('This listing does not have any more items to load.');
+    }
+    const { children, before, after, more } = await this._fetch({
+        ...(__classPrivateFieldGet(this, _Listing_before, "f") ? { before: __classPrivateFieldGet(this, _Listing_before, "f") } : {}),
+        ...(__classPrivateFieldGet(this, _Listing_after, "f") ? { after: __classPrivateFieldGet(this, _Listing_after, "f") } : {}),
+        ...(__classPrivateFieldGet(this, _Listing_more, "f") ? { more: __classPrivateFieldGet(this, _Listing_more, "f") } : {}),
+        limit: this.pageSize,
+    });
+    this.children.push(...children);
+    __classPrivateFieldSet(this, _Listing_before, before, "f");
+    __classPrivateFieldSet(this, _Listing_after, after, "f");
+    __classPrivateFieldSet(this, _Listing_more, more, "f");
+    __classPrivateFieldSet(this, _Listing_started, true, "f");
+    return children;
+};

package/models/ModAction.d.ts

@@ -0,0 +1,32 @@
+import type { ListingFetchOptions } from './Listing.js';
+import { Listing } from './Listing.js';
+export type ModActionTarget = {
+    id: string;
+    author?: string | undefined;
+    body?: string | undefined;
+    permalink?: string | undefined;
+    title?: string | undefined;
+};
+export interface ModAction {
+    id: string;
+    type: ModActionType;
+    moderatorName: string;
+    moderatorId: string;
+    createdAt: Date;
+    subredditName: string;
+    subredditId: string;
+    description?: string | undefined;
+    details?: string | undefined;
+    target?: ModActionTarget | undefined;
+}
+export type ModActionType = 'banuser' | 'unbanuser' | 'spamlink' | 'removelink' | 'approvelink' | 'spamcomment' | 'removecomment' | 'approvecomment' | 'addmoderator' | 'showcomment' | 'invitemoderator' | 'uninvitemoderator' | 'acceptmoderatorinvite' | 'removemoderator' | 'addcontributor' | 'removecontributor' | 'editsettings' | 'editflair' | 'distinguish' | 'marknsfw' | 'wikibanned' | 'wikicontributor' | 'wikiunbanned' | 'wikipagelisted' | 'removewikicontributor' | 'wikirevise' | 'wikipermlevel' | 'ignorereports' | 'unignorereports' | 'setpermissions' | 'setsuggestedsort' | 'sticky' | 'unsticky' | 'setcontestmode' | 'unsetcontestmode' | 'lock' | 'unlock' | 'muteuser' | 'unmuteuser' | 'createrule' | 'editrule' | 'reorderrules' | 'deleterule' | 'spoiler' | 'unspoiler' | 'modmail_enrollment' | 'community_styling' | 'community_widgets' | 'markoriginalcontent' | 'collections' | 'events' | 'create_award' | 'disable_award' | 'delete_award' | 'enable_award' | 'mod_award_given' | 'hidden_award' | 'add_community_topics' | 'remove_community_topics' | 'create_scheduled_post' | 'edit_scheduled_post' | 'delete_scheduled_post' | 'submit_scheduled_post' | 'edit_post_requirements' | 'invitesubscriber' | 'submit_content_rating_survey' | 'adjust_post_crowd_control_level' | 'enable_post_crowd_control_filter' | 'disable_post_crowd_control_filter' | 'deleteoverriddenclassification' | 'overrideclassification' | 'reordermoderators' | 'snoozereports' | 'unsnoozereports' | 'addnote' | 'deletenote' | 'addremovalreason' | 'createremovalreason' | 'updateremovalreason' | 'deleteremovalreason' | 'reorderremovalreason' | 'dev_platform_app_changed' | 'dev_platform_app_disabled' | 'dev_platform_app_enabled' | 'dev_platform_app_installed' | 'dev_platform_app_uninstalled';
+export type GetModerationLogOptions = ListingFetchOptions & {
+    /** Subreddit name */
+    subredditName: string;
+    /** (optional) A moderator filter. Accepts an array of usernames */
+    moderatorUsernames?: string[];
+    /** Type of the Moderator action */
+    type?: ModActionType;
+};
+export declare function getModerationLog(options: GetModerationLogOptions): Listing<ModAction>;
+//# sourceMappingURL=ModAction.d.ts.map