@devvit/server 0.11.18 → 0.11.19-next-2025-07-01-14-39-04-3a189619a.0

package/define-config.d.ts

@@ -1,5 +1,5 @@
 import { Devvit } from '@devvit/public-api';
-import type { AppConfig, AppMenuActionConfig, AppPermissionConfig, AppPostCreateConfig } from '@devvit/shared-types/schemas/config-file.v1.js';
+import type { AppConfig, AppFormsConfig, AppMenuActionConfig, AppPermissionConfig, AppPostCreateConfig } from '@devvit/shared-types/schemas/config-file.v1.js';
 /**
  * A subset of AppConfig (see config-file.v1.json) available in V8-flavored
  * LinkedBundles except for the deprecated Blocks callbacks. This config is used
@@ -13,6 +13,7 @@ export type DynamicAppConfig = {
     permissions: AppPermissionConfig;
     post?: DynamicAppPostConfig | undefined;
     menuActions?: AppMenuActionConfig[];
+    forms?: AppFormsConfig;
 };
 /** @experimental */
 export type DynamicAppPostConfig = {

package/define-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"define-config.d.ts","sourceRoot":"","sources":["../src/define-config.tsx"],"names":[],"mappings":"AAAA,OAAO,EAEL,MAAM,EAKP,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACV,SAAS,EACT,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,gDAAgD,CAAC;AAIxD;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IACxC,WAAW,CAAC,EAAE,mBAAmB,EAAE,CAAC;CACrC,CAAC;AAEF,oBAAoB;AACpB,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,kBAAkB;QAClB,MAAM,CAAC,EAAE;YACP,iDAAiD;YACjD,MAAM,CAAC,EACH,QAAQ,GACR;gBACE,IAAI,EAAE,OAAO,CAAC;gBACd;;;mBAGG;gBACH,KAAK,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,GAAG,SAAS,CAAC;aACpC,GACD,MAAM,CAAC,mBAAmB,GAC1B,SAAS,CAAC;SACf,CAAC;KACH,CAAC;IACF,MAAM,EAAE,0BAA0B,CAAC;CACpC,CAAC;AAEF,oBAAoB;AACpB,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,GAAG;IAC7D,kBAAkB;IAClB,MAAM,CAAC,EACH;QACE;;;;WAIG;QACH,MAAM,CAAC,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC;QACnC;;;WAGG;QACH,KAAK,CAAC,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;KAChD,GACD,SAAS,CAAC;CACf,CAAC;AAEF,oBAAoB;AACpB,wBAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,gBAAgB,GAAG,SAAS,CAAC,GAAG,OAAO,MAAM,CAK1F"}
+{"version":3,"file":"define-config.d.ts","sourceRoot":"","sources":["../src/define-config.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,MAAM,EAOP,MAAM,oBAAoB,CAAC;AAG5B,OAAO,KAAK,EACV,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,gDAAgD,CAAC;AAIxD;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;IACxC,WAAW,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACpC,KAAK,CAAC,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF,oBAAoB;AACpB,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,kBAAkB;QAClB,MAAM,CAAC,EAAE;YACP,iDAAiD;YACjD,MAAM,CAAC,EACH,QAAQ,GACR;gBACE,IAAI,EAAE,OAAO,CAAC;gBACd;;;mBAGG;gBACH,KAAK,CAAC,EAAE,CAAC,MAAM,MAAM,CAAC,GAAG,SAAS,CAAC;aACpC,GACD,MAAM,CAAC,mBAAmB,GAC1B,SAAS,CAAC;SACf,CAAC;KACH,CAAC;IACF,MAAM,EAAE,0BAA0B,CAAC;CACpC,CAAC;AAEF,oBAAoB;AACpB,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,GAAG;IAC7D,kBAAkB;IAClB,MAAM,CAAC,EACH;QACE;;;;WAIG;QACH,MAAM,CAAC,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC;QACnC;;;WAGG;QACH,KAAK,CAAC,IAAI,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;KAChD,GACD,SAAS,CAAC;CACf,CAAC;AAKF,oBAAoB;AACpB,wBAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,gBAAgB,GAAG,SAAS,CAAC,GAAG,OAAO,MAAM,CAM1F"}

package/define-config.js

@@ -1,5 +1,7 @@
 import { Devvit, useWebView, } from '@devvit/public-api';
 import { getServerPort } from './get-server-port.js';
+/** [state] Map of devvit.json form keys to Devvit-singleton form keys. */
+const formKeyMap = {};
 /** @experimental */
 export function defineConfig(config) {
     configurePermissions(config.permissions);
@@ -7,6 +9,8 @@ export function defineConfig(config) {
         configurePost(config.post);
     if (config.menuActions)
         configureMenuActions(config.menuActions);
+    if (config.forms)
+        configureForms(config.forms);
     return Devvit;
 }
 function configurePermissions(permissions) {
@@ -70,23 +74,10 @@ function configureMenuActions(menuActions) {
             label: action.label,
             location: action.location,
             onPress: async (ev, ctx) => {
-                const url = new URL(action.endpoint, `http://webbit.local:${getServerPort()}/`);
-                const headers = {};
-                Object.entries(ctx.debug.metadata).forEach(([key, metadata]) => {
-                    headers[key] = metadata.values[0];
-                });
-                headers['Content-Type'] = 'application/json';
-                const response = await fetch(url, {
-                    method: 'POST',
-                    body: JSON.stringify(ev),
-                    headers,
-                });
-                if (!response.ok) {
-                    const body = await response.text();
-                    throw new Error(`Failed to fetch from ${action.endpoint}: ${response.statusText}, body: ${body}`);
-                }
-                // TODO: implement UI effect handling.
-                ctx.ui.showToast('it was clicked! ' + JSON.stringify(await response.json()));
+                const responseJson = await callWebbitEndpoint(action.endpoint, ev, ctx.debug.metadata);
+                // TODO: validate UiResponse format for DX reasons. Throw an error if
+                // it doesn't conform.
+                await handleUiResponse(ctx, responseJson);
             },
         };
         // "user" type is blank in Devvit classic. So if it's present in
@@ -102,6 +93,59 @@ function configureMenuActions(menuActions) {
         Devvit.addMenuItem(menuItem);
     }
 }
+function configureForms(forms) {
+    for (const [name, endpoint] of Object.entries(forms)) {
+        formKeyMap[name] = Devvit.createForm({ fields: [] }, (ev, ctx) => handleFormResponse(endpoint, ev, ctx));
+    }
+}
+async function handleFormResponse(endpoint, event, ctx) {
+    const responseJson = await callWebbitEndpoint(endpoint, event.values, ctx.debug.metadata);
+    // TODO: validate UiResponse format for DX reasons. Throw an error if
+    // it doesn't conform.
+    await handleUiResponse(ctx, responseJson);
+}
+/**
+ * Handle a UiResponse from a Webbit handler (menu action or form handler).
+ * This is used to create client-side UI effects in Reddit clients as responses
+ * to user actions in cases where the Devvit app is not in the direct code path.
+ *
+ * If multiple effects are present in the UiResponse, they will all be applied.
+ */
+async function handleUiResponse(ctx, uiResponse) {
+    if (uiResponse.showToast) {
+        ctx.ui.showToast(uiResponse.showToast);
+    }
+    if (uiResponse.navigateTo) {
+        ctx.ui.navigateTo(uiResponse.navigateTo);
+    }
+    if (uiResponse.showForm) {
+        const formKey = formKeyMap[uiResponse.showForm.name];
+        if (!formKey) {
+            const name = uiResponse.showForm.name;
+            throw new Error(`Form with name ${name} not found in devvit.json. Consider adding '"forms"."${name}"="/internal/your/endpoint"'.`);
+        }
+        ctx.ui.showFormInternal(formKey, uiResponse.showForm.data, uiResponse.showForm.form);
+    }
+}
+async function callWebbitEndpoint(endpoint, body, metadata) {
+    const url = new URL(endpoint, `http://webbit.local:${getServerPort()}/`);
+    const headers = {};
+    Object.entries(metadata).forEach(([key, metadata]) => {
+        headers[key] = metadata.values[0];
+    });
+    headers['Content-Type'] = 'application/json';
+    headers['Accept'] = 'application/json';
+    const response = await fetch(url, {
+        method: 'POST',
+        body: JSON.stringify(body),
+        headers,
+    });
+    if (!response.ok) {
+        const body = await response.text();
+        throw new Error(`Failed to fetch from ${endpoint}: ${response.statusText}, body: ${body.substring(0, 100)}`);
+    }
+    return await response.json();
+}
 async function createPost(ctx, create) {
     if (!ctx.subredditName)
         throw Error('no sub name');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/server",
-  "version": "0.11.18",
+  "version": "0.11.19-next-2025-07-01-14-39-04-3a189619a.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -23,13 +23,14 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.18",
-    "@devvit/public-api": "0.11.18",
-    "@devvit/shared-types": "0.11.18"
+    "@devvit/protos": "0.11.19-next-2025-07-01-14-39-04-3a189619a.0",
+    "@devvit/public-api": "0.11.19-next-2025-07-01-14-39-04-3a189619a.0",
+    "@devvit/shared": "0.11.19-next-2025-07-01-14-39-04-3a189619a.0",
+    "@devvit/shared-types": "0.11.19-next-2025-07-01-14-39-04-3a189619a.0"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.11.18",
-    "@devvit/tsconfig": "0.11.18",
+    "@devvit/repo-tools": "0.11.19-next-2025-07-01-14-39-04-3a189619a.0",
+    "@devvit/tsconfig": "0.11.19-next-2025-07-01-14-39-04-3a189619a.0",
     "eslint": "9.11.1",
     "typescript": "5.8.3",
     "vitest": "1.6.1"
@@ -38,5 +39,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "528a395e1d56da073194f98bd6eec9f073b4ae3a"
+  "gitHead": "67f59b874319a6daf673d2245be80709aeaf8f1d"
 }