@devvit/public-api 0.12.0-next-2025-04-10-a27f59c35.0 → 0.12.0-next-2025-04-10-14eb9113e.0

package/apis/reddit/models/ModMail.d.ts

@@ -291,7 +291,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * const conversationIds = await reddit.modMail.bulkReadConversations(
+     * const conversationIds = await modMail().bulkReadConversations(
      *   ['askReddit', 'myAwesomeSubreddit'],
      *   'filtered'
      * );
@@ -309,7 +309,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * const {viewerId, conversations} = await reddit.modMail.getConversations({
+     * const {viewerId, conversations} = await modMail().getConversations({
      *   after: 'abcdef',
      *   limit: 42
      * });
@@ -326,7 +326,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * const { conversation, messages, modActions, user } = await reddit.modMail.getConversation({ conversationId: 'abcdef', markRead: true });
+     * const { conversation, messages, modActions, user } = await modMail().getConversation({ conversationId: 'abcdef', markRead: true });
      * ```
      */
     getConversation(params: {
@@ -340,7 +340,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * const subredditsData = await reddit.modMail.getSubreddits();
+     * const subredditsData = await modMail().getSubreddits();
      *
      * for (const subreddit of Object.values(subreddits)) {
      *   console.log(subreddit.id);
@@ -377,7 +377,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * const { conversation, messages, modActions } = await reddit.modMail.createConversation({
+     * const { conversation, messages, modActions } = await modMail().createConversation({
      *   subredditName: 'askReddit',
      *   subject: 'Test conversation',
      *   body: 'Lorem ipsum sit amet',
@@ -403,7 +403,7 @@ export declare class ModMailService {
      * @returns A Promise that resolves a string representing the conversationId of the message.
      * @example
      * ```ts
-     * const conversationId = await reddit.modMail.createModDiscussionConversation({
+     * const conversationId = await modMail().createModDiscussionConversation({
      *   subject: 'Test conversation',
      *   bodyMarkdown: '**Hello there** \n\n _Have a great day!_',
      *   subredditId: context.subredditId
@@ -424,7 +424,7 @@ export declare class ModMailService {
      * @returns A Promise that resolves a string representing the conversationId of the message.
      * @example
      * ```ts
-     * const conversationId = await reddit.modMail.createModInboxConversation({
+     * const conversationId = await modMail().createModInboxConversation({
      *   subject: 'Test conversation',
      *   bodyMarkdown: '**Hello there** \n\n _Have a great day!_',
      *   subredditId: context.subredditId
@@ -446,7 +446,7 @@ export declare class ModMailService {
      * @returns A Promise that resolves a string representing the conversationId of the message.
      * @example
      * ```ts
-     * const conversationId = await reddit.modMail.createModNotification({
+     * const conversationId = await modMail().createModNotification({
      *   subject: 'Test notification',
      *   bodyMarkdown: '**Hello there** \n\n _This is a notification!_',
      *   subredditId: context.subredditId
@@ -468,7 +468,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.reply({
+     * await modMail().reply({
      *   body: 'Lorem ipsum sit amet',
      *   conversationId: 'abcdef',
      * });
@@ -487,7 +487,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.highlightConversation('abcdef');
+     * await modMail().highlightConversation('abcdef');
      * ```
      */
     highlightConversation(conversationId: string): Promise<ConversationResponse>;
@@ -498,7 +498,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unhighlightConversation('abcdef');
+     * await modMail().unhighlightConversation('abcdef');
      * ```
      */
     unhighlightConversation(conversationId: string): Promise<ConversationResponse>;
@@ -509,7 +509,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.archive('abcdef');
+     * await modMail().archive('abcdef');
      * ```
      */
     archiveConversation(conversationId: string): Promise<ConversationResponse>;
@@ -520,7 +520,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unarchiveConversation('abcdef');
+     * await modMail().unarchiveConversation('abcdef');
      * ```
      */
     unarchiveConversation(conversationId: string): Promise<ConversationResponse>;
@@ -532,7 +532,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.muteConversation({ conversationId: 'abcdef', numHours: 72 });
+     * await modMail().muteConversation({ conversationId: 'abcdef', numHours: 72 });
      * ```
      */
     muteConversation(params: {
@@ -546,7 +546,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unmuteConversation('abcdef');
+     * await modMail().unmuteConversation('abcdef');
      * ```
      */
     unmuteConversation(conversationId: string): Promise<ConversationResponse & WithUserData>;
@@ -557,7 +557,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.readConversations(['abcdef', 'qwerty']);
+     * await modMail().readConversations(['abcdef', 'qwerty']);
      * ```
      */
     readConversations(conversationIds: string[]): Promise<void>;
@@ -568,7 +568,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unreadConversations(['abcdef', 'qwerty']);
+     * await modMail().unreadConversations(['abcdef', 'qwerty']);
      * ```
      */
     unreadConversations(conversationIds: string[]): Promise<void>;
@@ -579,7 +579,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.approveConversation('abcdef');
+     * await modMail().approveConversation('abcdef');
      * ```
      */
     approveConversation(conversationId: string): Promise<ConversationResponse & WithUserData>;
@@ -590,7 +590,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.disapproveConversation('abcdef');
+     * await modMail().disapproveConversation('abcdef');
      * ```
      */
     disapproveConversation(conversationId: string): Promise<ConversationResponse & WithUserData>;
@@ -602,7 +602,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.tempBanConversation({ conversationId: 'abcdef', duration: 42 });
+     * await modMail().tempBanConversation({ conversationId: 'abcdef', duration: 42 });
      * ```
      */
     tempBanConversation(params: {
@@ -616,7 +616,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unbanConversation('abcdef');
+     * await modMail().unbanConversation('abcdef');
      * ```
      */
     unbanConversation(conversationId: string): Promise<ConversationResponse & WithUserData>;
@@ -625,7 +625,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * const response = await reddit.modMail.getUnreadCount();
+     * const response = await modMail().getUnreadCount();
      *
      * console.log(response.highlighted);
      * console.log(response.new);
@@ -639,7 +639,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * const data = await reddit.modMail.getUserConversations('abcdef');
+     * const data = await modMail().getUserConversations('abcdef');
      *
      * console.log(data.recentComments);
      * console.log(data.recentPosts);

package/apis/reddit/models/ModMail.js

@@ -91,7 +91,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * const conversationIds = await reddit.modMail.bulkReadConversations(
+     * const conversationIds = await modMail().bulkReadConversations(
      *   ['askReddit', 'myAwesomeSubreddit'],
      *   'filtered'
      * );
@@ -116,7 +116,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * const {viewerId, conversations} = await reddit.modMail.getConversations({
+     * const {viewerId, conversations} = await modMail().getConversations({
      *   after: 'abcdef',
      *   limit: 42
      * });
@@ -155,7 +155,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * const { conversation, messages, modActions, user } = await reddit.modMail.getConversation({ conversationId: 'abcdef', markRead: true });
+     * const { conversation, messages, modActions, user } = await modMail().getConversation({ conversationId: 'abcdef', markRead: true });
      * ```
      */
     async getConversation(params) {
@@ -176,7 +176,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * const subredditsData = await reddit.modMail.getSubreddits();
+     * const subredditsData = await modMail().getSubreddits();
      *
      * for (const subreddit of Object.values(subreddits)) {
      *   console.log(subreddit.id);
@@ -215,7 +215,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * const { conversation, messages, modActions } = await reddit.modMail.createConversation({
+     * const { conversation, messages, modActions } = await modMail().createConversation({
      *   subredditName: 'askReddit',
      *   subject: 'Test conversation',
      *   body: 'Lorem ipsum sit amet',
@@ -252,7 +252,7 @@ export class ModMailService {
      * @returns A Promise that resolves a string representing the conversationId of the message.
      * @example
      * ```ts
-     * const conversationId = await reddit.modMail.createModDiscussionConversation({
+     * const conversationId = await modMail().createModDiscussionConversation({
      *   subject: 'Test conversation',
      *   bodyMarkdown: '**Hello there** \n\n _Have a great day!_',
      *   subredditId: context.subredditId
@@ -278,7 +278,7 @@ export class ModMailService {
      * @returns A Promise that resolves a string representing the conversationId of the message.
      * @example
      * ```ts
-     * const conversationId = await reddit.modMail.createModInboxConversation({
+     * const conversationId = await modMail().createModInboxConversation({
      *   subject: 'Test conversation',
      *   bodyMarkdown: '**Hello there** \n\n _Have a great day!_',
      *   subredditId: context.subredditId
@@ -305,7 +305,7 @@ export class ModMailService {
      * @returns A Promise that resolves a string representing the conversationId of the message.
      * @example
      * ```ts
-     * const conversationId = await reddit.modMail.createModNotification({
+     * const conversationId = await modMail().createModNotification({
      *   subject: 'Test notification',
      *   bodyMarkdown: '**Hello there** \n\n _This is a notification!_',
      *   subredditId: context.subredditId
@@ -336,7 +336,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.reply({
+     * await modMail().reply({
      *   body: 'Lorem ipsum sit amet',
      *   conversationId: 'abcdef',
      * });
@@ -366,7 +366,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.highlightConversation('abcdef');
+     * await modMail().highlightConversation('abcdef');
      * ```
      */
     async highlightConversation(conversationId) {
@@ -389,7 +389,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unhighlightConversation('abcdef');
+     * await modMail().unhighlightConversation('abcdef');
      * ```
      */
     async unhighlightConversation(conversationId) {
@@ -412,7 +412,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.archive('abcdef');
+     * await modMail().archive('abcdef');
      * ```
      */
     async archiveConversation(conversationId) {
@@ -435,7 +435,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unarchiveConversation('abcdef');
+     * await modMail().unarchiveConversation('abcdef');
      * ```
      */
     async unarchiveConversation(conversationId) {
@@ -459,7 +459,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.muteConversation({ conversationId: 'abcdef', numHours: 72 });
+     * await modMail().muteConversation({ conversationId: 'abcdef', numHours: 72 });
      * ```
      */
     async muteConversation(params) {
@@ -484,7 +484,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unmuteConversation('abcdef');
+     * await modMail().unmuteConversation('abcdef');
      * ```
      */
     async unmuteConversation(conversationId) {
@@ -508,7 +508,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.readConversations(['abcdef', 'qwerty']);
+     * await modMail().readConversations(['abcdef', 'qwerty']);
      * ```
      */
     async readConversations(conversationIds) {
@@ -524,7 +524,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unreadConversations(['abcdef', 'qwerty']);
+     * await modMail().unreadConversations(['abcdef', 'qwerty']);
      * ```
      */
     async unreadConversations(conversationIds) {
@@ -540,7 +540,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.approveConversation('abcdef');
+     * await modMail().approveConversation('abcdef');
      * ```
      */
     async approveConversation(conversationId) {
@@ -564,7 +564,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.disapproveConversation('abcdef');
+     * await modMail().disapproveConversation('abcdef');
      * ```
      */
     async disapproveConversation(conversationId) {
@@ -589,7 +589,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.tempBanConversation({ conversationId: 'abcdef', duration: 42 });
+     * await modMail().tempBanConversation({ conversationId: 'abcdef', duration: 42 });
      * ```
      */
     async tempBanConversation(params) {
@@ -613,7 +613,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unbanConversation('abcdef');
+     * await modMail().unbanConversation('abcdef');
      * ```
      */
     async unbanConversation(conversationId) {
@@ -635,7 +635,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * const response = await reddit.modMail.getUnreadCount();
+     * const response = await modMail().getUnreadCount();
      *
      * console.log(response.highlighted);
      * console.log(response.new);
@@ -652,7 +652,7 @@ export class ModMailService {
      *
      * @example
      * ```ts
-     * const data = await reddit.modMail.getUserConversations('abcdef');
+     * const data = await modMail().getUserConversations('abcdef');
      *
      * console.log(data.recentComments);
      * console.log(data.recentPosts);

package/apis/reddit/models/Post.d.ts

@@ -303,7 +303,7 @@ export declare class Post {
      * @throws {Error} Throws an error if the suggested sort could not be set.
      * @example
      * ```ts
-     * const post = await reddit.getPostById(context.postId);
+     * const post = await getPostById(context.postId);
      * await post.setSuggestedCommentSort("NEW");
      * ```
      */
@@ -320,7 +320,7 @@ export declare class Post {
      *     <text size="large">An updated preview!</text>
      *   </vstack>
      * );
-     * const post = await reddit.getPostById(context.postId);
+     * const post = await getPostById(context.postId);
      * await post.setCustomPostPreview(() => preview);
      * ```
      */
@@ -334,7 +334,7 @@ export declare class Post {
      * ```ts
      * // from a menu action, form, scheduler, trigger, custom post click event, etc
      * const newTextFallback = { text: 'This is an updated text fallback' };
-     * const post = await context.reddit.getPostById(context.postId);
+     * const post = await getPostById(context.postId);
      * await post.setTextFallback(newTextFallback);
      * ```
      */
@@ -381,7 +381,7 @@ export declare class Post {
      * @example
      * ```ts
      * // from a menu action, form, scheduler, trigger, custom post click event, etc
-     * const post = await context.reddit.getPostById(context.postId);
+     * const post = await getPostById(context.postId);
      * const enrichedThumbnail = await post.getEnrichedThumbnail();
      * ```
      */

package/apis/reddit/models/Post.js

@@ -376,7 +376,7 @@ export class Post {
      * @throws {Error} Throws an error if the suggested sort could not be set.
      * @example
      * ```ts
-     * const post = await reddit.getPostById(context.postId);
+     * const post = await getPostById(context.postId);
      * await post.setSuggestedCommentSort("NEW");
      * ```
      */
@@ -395,7 +395,7 @@ export class Post {
      *     <text size="large">An updated preview!</text>
      *   </vstack>
      * );
-     * const post = await reddit.getPostById(context.postId);
+     * const post = await getPostById(context.postId);
      * await post.setCustomPostPreview(() => preview);
      * ```
      */
@@ -414,7 +414,7 @@ export class Post {
      * ```ts
      * // from a menu action, form, scheduler, trigger, custom post click event, etc
      * const newTextFallback = { text: 'This is an updated text fallback' };
-     * const post = await context.reddit.getPostById(context.postId);
+     * const post = await getPostById(context.postId);
      * await post.setTextFallback(newTextFallback);
      * ```
      */
@@ -530,7 +530,7 @@ export class Post {
      * @example
      * ```ts
      * // from a menu action, form, scheduler, trigger, custom post click event, etc
-     * const post = await context.reddit.getPostById(context.postId);
+     * const post = await getPostById(context.postId);
      * const enrichedThumbnail = await post.getEnrichedThumbnail();
      * ```
      */

package/apis/reddit/models/Subreddit.d.ts

@@ -453,7 +453,7 @@ export declare class Subreddit {
      * @example
      * ```ts
      * const subredditName = "mysubreddit"
-     * const subreddit = await reddit.getSubredditByName(subredditName)
+     * const subreddit = await getSubredditByName(subredditName)
      * const response = await subreddit.getUserFlair();
      * const userFlairList = response.users
      * ```
@@ -477,7 +477,7 @@ export declare class Subreddit {
      *
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName("mysubreddit")
+     * const subreddit = await getSubredditByName("mysubreddit")
      * let listing = await subreddit.getModQueue();
      * console.log("Posts and Comments: ",  await listing.all())
      * listing = await subreddit.getModQueue({ type: "post"});
@@ -494,7 +494,7 @@ export declare class Subreddit {
      *
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName("mysubreddit")
+     * const subreddit = await getSubredditByName("mysubreddit")
      * let listing = await subreddit.getReports();
      * console.log("Posts and Comments: ", await listing.all())
      * listing = await subreddit.getReports({ type: "post"});
@@ -511,7 +511,7 @@ export declare class Subreddit {
      *
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName("mysubreddit")
+     * const subreddit = await getSubredditByName("mysubreddit")
      * let listing = await subreddit.getSpam();
      * console.log("Posts and Comments: ", await listing.all())
      * listing = await subreddit.getSpam({ type: "post"});
@@ -528,7 +528,7 @@ export declare class Subreddit {
      *
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName("mysubreddit")
+     * const subreddit = await getSubredditByName("mysubreddit")
      * let listing = await subreddit.getUnmoderated();
      * console.log("Posts and Comments: ", await listing.all())
      * listing = await subreddit.getUnmoderated({ type: "post"});
@@ -545,7 +545,7 @@ export declare class Subreddit {
      *
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName("mysubreddit")
+     * const subreddit = await getSubredditByName("mysubreddit")
      * let listing = await subreddit.getEdited();
      * console.log("Posts and Comments: ", await listing.all())
      * listing = await subreddit.getEdited({ type: "post"});
@@ -561,7 +561,7 @@ export declare class Subreddit {
      * @param ids Array of thing full ids (e.g. t3_abc123)
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName('askReddit');
+     * const subreddit = await getSubredditByName('askReddit');
      * const listing = subreddit.getCommentsAndPostsByIds(['t3_abc123', 't1_xyz123']);
      * const items = await listing.all();
      * console.log(items) // [Post, Comment]

package/apis/reddit/models/Subreddit.js

@@ -458,7 +458,7 @@ export class Subreddit {
      * @example
      * ```ts
      * const subredditName = "mysubreddit"
-     * const subreddit = await reddit.getSubredditByName(subredditName)
+     * const subreddit = await getSubredditByName(subredditName)
      * const response = await subreddit.getUserFlair();
      * const userFlairList = response.users
      * ```
@@ -564,7 +564,7 @@ export class Subreddit {
      * @param ids Array of thing full ids (e.g. t3_abc123)
      * @example
      * ```ts
-     * const subreddit = await reddit.getSubredditByName('askReddit');
+     * const subreddit = await getSubredditByName('askReddit');
      * const listing = subreddit.getCommentsAndPostsByIds(['t3_abc123', 't1_xyz123']);
      * const items = await listing.all();
      * console.log(items) // [Post, Comment]

package/apis/reddit/models/User.d.ts

@@ -193,7 +193,7 @@ export declare class User {
      * ```ts
      * const username = "badapple"
      * const subredditName = "mysubreddit"
-     * const user = await reddit.getUserByUsername(username);
+     * const user = await getUserByUsername(username);
      * const userFlair = await user.getUserFlairBySubreddit(subredditName);
      * ```
      */

package/apis/reddit/models/User.js

@@ -240,7 +240,7 @@ export class User {
      * ```ts
      * const username = "badapple"
      * const subredditName = "mysubreddit"
-     * const user = await reddit.getUserByUsername(username);
+     * const user = await getUserByUsername(username);
      * const userFlair = await user.getUserFlairBySubreddit(subredditName);
      * ```
      */

package/devvit/Devvit.d.ts

@@ -106,7 +106,7 @@ export declare class Devvit extends Actor {
      * Devvit.addSchedulerJob({
      *   name: 'checkNewPosts',
      *   onRun: async (event, context) => {
-     *     const newPosts = await context.reddit.getNewPosts({ limit: 5 }).all();
+     *     const newPosts = await getNewPosts({ limit: 5 }).all();
      *     for (const post of newPosts) {
      *       if (post.title.includes('bad word')) {
      *         await post.remove();

package/devvit/Devvit.js

@@ -155,7 +155,7 @@ export class Devvit extends Actor {
      * Devvit.addSchedulerJob({
      *   name: 'checkNewPosts',
      *   onRun: async (event, context) => {
-     *     const newPosts = await context.reddit.getNewPosts({ limit: 5 }).all();
+     *     const newPosts = await getNewPosts({ limit: 5 }).all();
      *     for (const post of newPosts) {
      *       if (post.title.includes('bad word')) {
      *         await post.remove();