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

package/models/PrivateMessage.d.ts

@@ -0,0 +1,52 @@
+import type { RedditObject } from '@devvit/protos';
+import type { Prettify } from '@devvit/shared-types/Prettify.js';
+import type { T2ID, T5ID, TID } from '@devvit/shared-types/tid.js';
+import type { ListingFetchOptions } from './Listing.js';
+import { Listing } from './Listing.js';
+import type { Subreddit } from './Subreddit.js';
+import type { User } from './User.js';
+export type SendPrivateMessageOptions = {
+    /** Recipient username (without the leading u/), or /r/name for that subreddit's moderators. */
+    to: string;
+    /** The subject of the message. */
+    subject: string;
+    /** The body of the message in Markdown text format. */
+    text: string;
+};
+export type SendPrivateMessageAsSubredditOptions = SendPrivateMessageOptions & {
+    /** The name of the subreddit the message is being sent from (without the leading r/) */
+    fromSubredditName: string;
+};
+export type GetPrivateMessagesOptions = Prettify<{
+    type?: 'inbox' | 'unread' | 'sent';
+} & ListingFetchOptions>;
+type PrivateMessageAuthor = (Pick<User, 'username'> & {
+    type: 'user';
+    id?: T2ID | undefined;
+}) | (Pick<Subreddit, 'name'> & {
+    type: 'subreddit';
+    id?: T5ID | undefined;
+});
+export declare class PrivateMessage {
+    #private;
+    /** @internal */
+    static getMessages(options: GetPrivateMessagesOptions): Promise<Listing<PrivateMessage>>;
+    /** @internal */
+    static send({ to, subject, text }: SendPrivateMessageOptions): Promise<void>;
+    /** @internal */
+    static sendAsSubreddit({ to, fromSubredditName, subject, text, }: SendPrivateMessageAsSubredditOptions): Promise<void>;
+    /** @internal */
+    static markAllAsRead(): Promise<void>;
+    /**
+     * @internal
+     */
+    constructor(data: RedditObject);
+    get id(): TID;
+    get from(): PrivateMessageAuthor;
+    get body(): string;
+    get bodyHtml(): string;
+    get created(): Date;
+    markAsRead(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=PrivateMessage.d.ts.map

package/models/PrivateMessage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PrivateMessage.d.ts","sourceRoot":"","sources":["../../src/models/PrivateMessage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAY,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG7D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,6BAA6B,CAAC;AAKnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtC,MAAM,MAAM,yBAAyB,GAAG;IACtC,+FAA+F;IAC/F,EAAE,EAAE,MAAM,CAAC;IACX,kCAAkC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,oCAAoC,GAAG,yBAAyB,GAAG;IAC7E,wFAAwF;IACxF,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAC9C;IACE,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;CACpC,GAAG,mBAAmB,CACxB,CAAC;AAEF,KAAK,oBAAoB,GACrB,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,EAAE,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;CAAE,CAAC,GAClE,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,EAAE,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;CAAE,CAAC,CAAC;AAE7E,qBAAa,cAAc;;IAOzB,gBAAgB;WACH,WAAW,CAAC,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAyB9F,gBAAgB;WACH,IAAI,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAclF,gBAAgB;WACH,eAAe,CAAC,EAC3B,EAAE,EACF,iBAAiB,EACjB,OAAO,EACP,IAAI,GACL,EAAE,oCAAoC,GAAG,OAAO,CAAC,IAAI,CAAC;IAcvD,gBAAgB;WACH,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAK3C;;OAEG;gBACS,IAAI,EAAE,YAAY;IAiC9B,IAAI,EAAE,IAAI,GAAG,CAEZ;IAED,IAAI,IAAI,IAAI,oBAAoB,CAE/B;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,OAAO,IAAI,IAAI,CAElB;IAEK,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;CAQlC"}

package/models/PrivateMessage.js

@@ -0,0 +1,126 @@
+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 __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 _a, _PrivateMessage_id, _PrivateMessage_from, _PrivateMessage_body, _PrivateMessage_bodyHtml, _PrivateMessage_created, _PrivateMessage_metadata_get;
+import { getContext } from '@devvit/server';
+import { assertNonNull } from '@devvit/shared-types/NonNull.js';
+import { asT2ID, asT5ID, asTID } from '@devvit/shared-types/tid.js';
+import { getRedditApiPlugins } from '../getRedditApiPlugins.js';
+import { makeGettersEnumerable } from '../helpers/makeGettersEnumerable.js';
+import { Listing } from './Listing.js';
+export class PrivateMessage {
+    /** @internal */
+    static async getMessages(options) {
+        const client = getRedditApiPlugins().PrivateMessages;
+        return new Listing({
+            ...options,
+            fetch: async (fetchOpts) => {
+                const listing = await client.MessageWhere({
+                    ...fetchOpts,
+                    where: options.type ?? 'inbox',
+                }, __classPrivateFieldGet(this, _a, "a", _PrivateMessage_metadata_get));
+                return {
+                    after: listing.data?.after,
+                    before: listing.data?.before,
+                    children: (listing.data?.children
+                        ?.map((child) => {
+                        return new _a(child.data);
+                    })
+                        .filter(Boolean) || []),
+                };
+            },
+        });
+    }
+    /** @internal */
+    static async send({ to, subject, text }) {
+        const client = getRedditApiPlugins().PrivateMessages;
+        await client.Compose({
+            to,
+            subject,
+            text,
+            fromSr: '',
+        }, __classPrivateFieldGet(this, _a, "a", _PrivateMessage_metadata_get));
+    }
+    /** @internal */
+    static async sendAsSubreddit({ to, fromSubredditName, subject, text, }) {
+        const client = getRedditApiPlugins().PrivateMessages;
+        await client.Compose({
+            to,
+            fromSr: fromSubredditName,
+            subject,
+            text,
+        }, __classPrivateFieldGet(this, _a, "a", _PrivateMessage_metadata_get));
+    }
+    /** @internal */
+    static async markAllAsRead() {
+        const client = getRedditApiPlugins().PrivateMessages;
+        await client.ReadAllMessages({ filterTypes: '' }, __classPrivateFieldGet(this, _a, "a", _PrivateMessage_metadata_get));
+    }
+    /**
+     * @internal
+     */
+    constructor(data) {
+        _PrivateMessage_id.set(this, void 0);
+        _PrivateMessage_from.set(this, void 0);
+        _PrivateMessage_body.set(this, void 0);
+        _PrivateMessage_bodyHtml.set(this, void 0);
+        _PrivateMessage_created.set(this, void 0);
+        makeGettersEnumerable(this);
+        assertNonNull(data.id, 'PrivateMessage: Invalid data, no id');
+        assertNonNull(data.name, 'PrivateMessage: Invalid data, no name');
+        assertNonNull(data.created, 'PrivateMessage: Invalid data, no created date');
+        __classPrivateFieldSet(this, _PrivateMessage_id, asTID(data.name), "f");
+        if (data.author != null) {
+            __classPrivateFieldSet(this, _PrivateMessage_from, {
+                type: 'user',
+                username: data.author,
+                id: data.authorFullname ? asT2ID(data.authorFullname) : undefined,
+            }, "f");
+        }
+        else if (data.subreddit != null) {
+            __classPrivateFieldSet(this, _PrivateMessage_from, {
+                type: 'subreddit',
+                name: data.subreddit,
+                id: data.subredditId ? asT5ID(data.subredditId) : undefined,
+            }, "f");
+        }
+        else {
+            throw new Error('PrivateMessage: Invalid data, no author or subreddit');
+        }
+        __classPrivateFieldSet(this, _PrivateMessage_body, data.body ?? '', "f");
+        __classPrivateFieldSet(this, _PrivateMessage_bodyHtml, data.bodyHtml ?? '', "f");
+        const created = new Date(0);
+        created.setUTCSeconds(data.createdUtc);
+        __classPrivateFieldSet(this, _PrivateMessage_created, created, "f");
+    }
+    get id() {
+        return __classPrivateFieldGet(this, _PrivateMessage_id, "f");
+    }
+    get from() {
+        return __classPrivateFieldGet(this, _PrivateMessage_from, "f");
+    }
+    get body() {
+        return __classPrivateFieldGet(this, _PrivateMessage_body, "f");
+    }
+    get bodyHtml() {
+        return __classPrivateFieldGet(this, _PrivateMessage_bodyHtml, "f");
+    }
+    get created() {
+        return __classPrivateFieldGet(this, _PrivateMessage_created, "f");
+    }
+    async markAsRead() {
+        const client = getRedditApiPlugins().PrivateMessages;
+        await client.ReadMessage({ id: __classPrivateFieldGet(this, _PrivateMessage_id, "f") }, getContext().debug.metadata);
+    }
+}
+_a = PrivateMessage, _PrivateMessage_id = new WeakMap(), _PrivateMessage_from = new WeakMap(), _PrivateMessage_body = new WeakMap(), _PrivateMessage_bodyHtml = new WeakMap(), _PrivateMessage_created = new WeakMap(), _PrivateMessage_metadata_get = function _PrivateMessage_metadata_get() {
+    return getContext().debug.metadata;
+};