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

package/meta.json

@@ -7264,7 +7264,7 @@
       "format": "esm"
     },
     "src/types/media.ts": {
-      "bytes": 972,
+      "bytes": 957,
       "imports": [],
       "format": "esm"
     },
@@ -8763,7 +8763,7 @@
       "format": "esm"
     },
     "src/devvit/Devvit.ts": {
-      "bytes": 34281,
+      "bytes": 34266,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -8961,7 +8961,7 @@
       "format": "esm"
     },
     "src/apis/reddit/models/Flair.ts": {
-      "bytes": 15852,
+      "bytes": 15845,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -9013,7 +9013,7 @@
       "format": "esm"
     },
     "src/apis/reddit/models/Post.ts": {
-      "bytes": 45152,
+      "bytes": 45108,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -9114,7 +9114,7 @@
       "format": "esm"
     },
     "src/apis/reddit/models/User.ts": {
-      "bytes": 20188,
+      "bytes": 20181,
       "imports": [
         {
           "path": "../shared-types/dist/Header.js",
@@ -9257,7 +9257,7 @@
       "format": "esm"
     },
     "src/apis/reddit/models/ModMail.ts": {
-      "bytes": 34537,
+      "bytes": 34422,
       "imports": [
         {
           "path": "../protos/dist/index.js",
@@ -9329,7 +9329,7 @@
       "format": "esm"
     },
     "src/apis/reddit/models/Subreddit.ts": {
-      "bytes": 40740,
+      "bytes": 40691,
       "imports": [
         {
           "path": "../shared-types/dist/Header.js",
@@ -10325,7 +10325,7 @@
           "bytesInOutput": 1424
         },
         "src/devvit/Devvit.ts": {
-          "bytesInOutput": 18957
+          "bytesInOutput": 18942
         },
         "src/apis/reddit/helpers/makeGettersEnumerable.ts": {
           "bytesInOutput": 344
@@ -10358,16 +10358,16 @@
           "bytesInOutput": 661
         },
         "src/apis/reddit/models/Flair.ts": {
-          "bytesInOutput": 12094
+          "bytesInOutput": 12087
         },
         "src/apis/reddit/models/Post.ts": {
-          "bytesInOutput": 36452
+          "bytesInOutput": 36408
         },
         "src/apis/reddit/helpers/textFallbackToRichtext.ts": {
           "bytesInOutput": 455
         },
         "src/apis/reddit/models/User.ts": {
-          "bytesInOutput": 17279
+          "bytesInOutput": 17272
         },
         "src/apis/reddit/models/Comment.ts": {
           "bytesInOutput": 22758
@@ -10379,13 +10379,13 @@
           "bytesInOutput": 2781
         },
         "src/apis/reddit/models/ModMail.ts": {
-          "bytesInOutput": 27330
+          "bytesInOutput": 27215
         },
         "src/apis/reddit/models/PrivateMessage.ts": {
           "bytesInOutput": 3808
         },
         "src/apis/reddit/models/Subreddit.ts": {
-          "bytesInOutput": 26840
+          "bytesInOutput": 26826
         },
         "src/apis/reddit/models/Widget.ts": {
           "bytesInOutput": 18351
@@ -10412,7 +10412,7 @@
           "bytesInOutput": 4013
         }
       },
-      "bytes": 12462635
+      "bytes": 12462117
     }
   }
 }

package/meta.min.json

@@ -83,7 +83,7 @@
       "format": "esm"
     },
     "src/types/media.ts": {
-      "bytes": 972,
+      "bytes": 957,
       "imports": [],
       "format": "esm"
     },
@@ -1582,7 +1582,7 @@
       "format": "esm"
     },
     "src/devvit/Devvit.ts": {
-      "bytes": 34281,
+      "bytes": 34266,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -1780,7 +1780,7 @@
       "format": "esm"
     },
     "src/apis/reddit/models/Flair.ts": {
-      "bytes": 15852,
+      "bytes": 15845,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -1832,7 +1832,7 @@
       "format": "esm"
     },
     "src/apis/reddit/models/Post.ts": {
-      "bytes": 45152,
+      "bytes": 45108,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -1933,7 +1933,7 @@
       "format": "esm"
     },
     "src/apis/reddit/models/User.ts": {
-      "bytes": 20188,
+      "bytes": 20181,
       "imports": [
         {
           "path": "../shared-types/dist/Header.js",
@@ -2076,7 +2076,7 @@
       "format": "esm"
     },
     "src/apis/reddit/models/ModMail.ts": {
-      "bytes": 34537,
+      "bytes": 34422,
       "imports": [
         {
           "path": "@devvit/protos",
@@ -2148,7 +2148,7 @@
       "format": "esm"
     },
     "src/apis/reddit/models/Subreddit.ts": {
-      "bytes": 40740,
+      "bytes": 40691,
       "imports": [
         {
           "path": "../shared-types/dist/Header.js",
@@ -2557,7 +2557,7 @@
       "imports": [],
       "exports": [],
       "inputs": {},
-      "bytes": 1075258
+      "bytes": 1075021
     },
     "dist/public-api.min.js": {
       "imports": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/public-api",
-  "version": "0.12.0-next-2025-04-10-a27f59c35.0",
+  "version": "0.12.0-next-2025-04-10-eddbfb660.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -30,17 +30,17 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/metrics": "0.12.0-next-2025-04-10-a27f59c35.0",
-    "@devvit/protos": "0.12.0-next-2025-04-10-a27f59c35.0",
-    "@devvit/shared-types": "0.12.0-next-2025-04-10-a27f59c35.0",
+    "@devvit/metrics": "0.12.0-next-2025-04-10-eddbfb660.0",
+    "@devvit/protos": "0.12.0-next-2025-04-10-eddbfb660.0",
+    "@devvit/shared-types": "0.12.0-next-2025-04-10-eddbfb660.0",
     "base64-js": "1.5.1",
     "clone-deep": "4.0.1",
     "moderndash": "4.0.0"
   },
   "devDependencies": {
     "@ampproject/filesize": "4.3.0",
-    "@devvit/repo-tools": "0.12.0-next-2025-04-10-a27f59c35.0",
-    "@devvit/tsconfig": "0.12.0-next-2025-04-10-a27f59c35.0",
+    "@devvit/repo-tools": "0.12.0-next-2025-04-10-eddbfb660.0",
+    "@devvit/tsconfig": "0.12.0-next-2025-04-10-eddbfb660.0",
     "@microsoft/api-extractor": "7.41.0",
     "@reddit/faceplate-ui": "18.0.1",
     "@types/clone-deep": "4.0.1",
@@ -61,5 +61,5 @@
     }
   },
   "source": "./src/index.ts",
-  "gitHead": "6624afad774e1ef401d4933823ae67777622a473"
+  "gitHead": "de89eaee8a43daba789eba57cec4c0ed32007675"
 }

package/public-api.d.ts

@@ -7795,7 +7795,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();
@@ -21180,7 +21180,7 @@ export declare type MediaPlugin = {
      *    url: "https://media2.giphy.com/media/xTiN0CNHgoRf1Ha7CM/giphy.gif",
      *    type: "gif"
      *  });
-     *  await context.reddit.submitPost(
+     *  await submitPost(
      *     {
      *       subredditName: subreddit.name,
      *       title: 'Hello World with Media',
@@ -25110,7 +25110,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * const conversationIds = await reddit.modMail.bulkReadConversations(
+     * const conversationIds = await modMail().bulkReadConversations(
      *   ['askReddit', 'myAwesomeSubreddit'],
      *   'filtered'
      * );
@@ -25128,7 +25128,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * const {viewerId, conversations} = await reddit.modMail.getConversations({
+     * const {viewerId, conversations} = await modMail().getConversations({
      *   after: 'abcdef',
      *   limit: 42
      * });
@@ -25145,7 +25145,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: {
@@ -25159,7 +25159,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);
@@ -25196,7 +25196,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',
@@ -25222,7 +25222,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
@@ -25243,7 +25243,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
@@ -25265,7 +25265,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
@@ -25287,7 +25287,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.reply({
+     * await modMail().reply({
      *   body: 'Lorem ipsum sit amet',
      *   conversationId: 'abcdef',
      * });
@@ -25306,7 +25306,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.highlightConversation('abcdef');
+     * await modMail().highlightConversation('abcdef');
      * ```
      */
     highlightConversation(conversationId: string): Promise<ConversationResponse>;
@@ -25317,7 +25317,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unhighlightConversation('abcdef');
+     * await modMail().unhighlightConversation('abcdef');
      * ```
      */
     unhighlightConversation(conversationId: string): Promise<ConversationResponse>;
@@ -25328,7 +25328,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.archive('abcdef');
+     * await modMail().archive('abcdef');
      * ```
      */
     archiveConversation(conversationId: string): Promise<ConversationResponse>;
@@ -25339,7 +25339,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unarchiveConversation('abcdef');
+     * await modMail().unarchiveConversation('abcdef');
      * ```
      */
     unarchiveConversation(conversationId: string): Promise<ConversationResponse>;
@@ -25351,7 +25351,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.muteConversation({ conversationId: 'abcdef', numHours: 72 });
+     * await modMail().muteConversation({ conversationId: 'abcdef', numHours: 72 });
      * ```
      */
     muteConversation(params: {
@@ -25365,7 +25365,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unmuteConversation('abcdef');
+     * await modMail().unmuteConversation('abcdef');
      * ```
      */
     unmuteConversation(conversationId: string): Promise<ConversationResponse & WithUserData>;
@@ -25376,7 +25376,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.readConversations(['abcdef', 'qwerty']);
+     * await modMail().readConversations(['abcdef', 'qwerty']);
      * ```
      */
     readConversations(conversationIds: string[]): Promise<void>;
@@ -25387,7 +25387,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unreadConversations(['abcdef', 'qwerty']);
+     * await modMail().unreadConversations(['abcdef', 'qwerty']);
      * ```
      */
     unreadConversations(conversationIds: string[]): Promise<void>;
@@ -25398,7 +25398,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.approveConversation('abcdef');
+     * await modMail().approveConversation('abcdef');
      * ```
      */
     approveConversation(conversationId: string): Promise<ConversationResponse & WithUserData>;
@@ -25409,7 +25409,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.disapproveConversation('abcdef');
+     * await modMail().disapproveConversation('abcdef');
      * ```
      */
     disapproveConversation(conversationId: string): Promise<ConversationResponse & WithUserData>;
@@ -25421,7 +25421,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.tempBanConversation({ conversationId: 'abcdef', duration: 42 });
+     * await modMail().tempBanConversation({ conversationId: 'abcdef', duration: 42 });
      * ```
      */
     tempBanConversation(params: {
@@ -25435,7 +25435,7 @@ export declare class ModMailService {
      *
      * @example
      * ```ts
-     * await reddit.modMail.unbanConversation('abcdef');
+     * await modMail().unbanConversation('abcdef');
      * ```
      */
     unbanConversation(conversationId: string): Promise<ConversationResponse & WithUserData>;
@@ -25444,7 +25444,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);
@@ -25458,7 +25458,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);
@@ -35931,7 +35931,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");
      * ```
      */
@@ -35948,7 +35948,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);
      * ```
      */
@@ -35962,7 +35962,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);
      * ```
      */
@@ -36009,7 +36009,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();
      * ```
      */
@@ -43265,7 +43265,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
      * ```
@@ -43289,7 +43289,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"});
@@ -43306,7 +43306,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"});
@@ -43323,7 +43323,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"});
@@ -43340,7 +43340,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"});
@@ -43357,7 +43357,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"});
@@ -43373,7 +43373,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]
@@ -51111,7 +51111,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);
      * ```
      */