@devvit/server 0.11.19-next-2025-07-02-17-32-32-070c5de78.0 → 0.11.19-next-2025-07-02-19-47-19-53796ec90.0

package/define-config.d.ts

@@ -1,4 +1,5 @@
-import { Devvit } from '@devvit/public-api';
+import { Devvit, type FormKey } from '@devvit/public-api';
+import type { UiResponse } from '@devvit/shared/types/ui-response.js';
 import type { AppConfig, AppFormsConfig, AppMenuActionConfig, AppPermissionConfig, AppPostCreateConfig, AppSchedulerConfig } from '@devvit/shared-types/schemas/config-file.v1.js';
 /**
  * A subset of AppConfig (see config-file.v1.json) available in V8-flavored
@@ -53,6 +54,12 @@ export type DynamicAppPostCreateConfig = AppPostCreateConfig & {
         title?(): string | Promise<string> | undefined;
     } | undefined;
 };
+/** @internal [state] Map of devvit.json form keys to Devvit-singleton form keys. */
+export declare const formKeyMap: {
+    [formKey: string]: FormKey;
+};
 /** @experimental */
 export declare function defineConfig(config: Readonly<DynamicAppConfig | AppConfig>): typeof Devvit;
+/** @internal */
+export declare function validateUiResponse(uiResponse: UiResponse): void;
 //# sourceMappingURL=define-config.d.ts.map

package/define-config.d.ts.map

@@ -1 +1 @@
-{"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,EACnB,kBAAkB,EACnB,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,SAAS,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC3C,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,CAO1F"}
+{"version":3,"file":"define-config.d.ts","sourceRoot":"","sources":["../src/define-config.tsx"],"names":[],"mappings":"AACA,OAAO,EAEL,MAAM,EACN,KAAK,OAAO,EAMb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AAEtE,OAAO,KAAK,EACV,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EACnB,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,SAAS,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAC3C,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;AAEF,oFAAoF;AACpF,eAAO,MAAM,UAAU,EAAE;IAAE,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAO,CAAC;AAE7D,oBAAoB;AACpB,wBAAgB,YAAY,CAAC,MAAM,EAAE,QAAQ,CAAC,gBAAgB,GAAG,SAAS,CAAC,GAAG,OAAO,MAAM,CAO1F;AAyGD,gBAAgB;AAChB,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CA4D/D"}

package/define-config.js

@@ -1,7 +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 = {};
+/** @internal [state] Map of devvit.json form keys to Devvit-singleton form keys. */
+export const formKeyMap = {};
 /** @experimental */
 export function defineConfig(config) {
     configurePermissions(config.permissions);
@@ -77,9 +77,9 @@ function configureMenuActions(menuActions) {
             location: action.location,
             onPress: async (ev, ctx) => {
                 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);
+                const uiResponse = responseJson;
+                validateUiResponse(uiResponse);
+                await handleUiResponse(ctx, uiResponse);
             },
         };
         // "user" type is blank in Devvit classic. So if it's present in
@@ -102,9 +102,58 @@ function configureForms(forms) {
 }
 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);
+    const uiResponse = responseJson;
+    validateUiResponse(uiResponse);
+    await handleUiResponse(ctx, uiResponse);
+}
+// TODO: expand this to fully validate the UiResponse format, including Form definitions,
+// and convert signature to validateUiResponse(uiResponse: JSONValue): uiResponse is UiResponse
+/** @internal */
+export function validateUiResponse(uiResponse) {
+    // Validations:
+    // (1) The only valid fields on uiResponse are showToast, navigateTo, and showForm.
+    const validKeys = ['showToast', 'navigateTo', 'showForm'];
+    const invalidKeys = Object.keys(uiResponse).filter((key) => !validKeys.includes(key));
+    if (invalidKeys.length > 0) {
+        throw new Error(`Invalid fields found in UiResponse: ${invalidKeys.join(', ')}. Valid fields are: ${validKeys.join(', ')}`);
+    }
+    // (2) showForm must have a name that exists in the formKeyMap.
+    if (uiResponse.showForm) {
+        if (!uiResponse.showForm.name) {
+            throw new Error('showForm must have a name');
+        }
+        if (!formKeyMap[uiResponse.showForm.name]) {
+            throw new Error(`Form with name ${uiResponse.showForm.name} not found in devvit.json. Consider adding '"forms"."${uiResponse.showForm.name}"="/internal/your/endpoint"'.`);
+        }
+    }
+    // (3) showToast must be a string or an object with only fields [text, appearance]
+    //     and text is a mandatory string.
+    if (uiResponse.showToast !== undefined) {
+        if (typeof uiResponse.showToast === 'string') {
+            // Valid case: showToast is a string
+        }
+        else if (typeof uiResponse.showToast === 'object' && uiResponse.showToast !== null) {
+            // Check if it's an object with valid fields
+            const toastKeys = Object.keys(uiResponse.showToast);
+            const validToastKeys = ['text', 'appearance'];
+            const invalidToastKeys = toastKeys.filter((key) => !validToastKeys.includes(key));
+            if (invalidToastKeys.length > 0) {
+                throw new Error(`Invalid fields found in showToast: ${invalidToastKeys.join(', ')}. Valid fields are: ${validToastKeys.join(', ')}`);
+            }
+            if (typeof uiResponse.showToast.text !== 'string') {
+                throw new Error('showToast.text is required and must be a string');
+            }
+        }
+        else {
+            throw new Error('showToast must be a string or an object with text and optional appearance fields');
+        }
+    }
+    // (4) navigateTo must be a valid URL or a Post object. (this is validated client-side, so
+    //     we don't need to validate it here).
+    // (5) navigateTo and showForm are mutually exclusive.
+    if (uiResponse.navigateTo && uiResponse.showForm) {
+        throw new Error('navigateTo and showForm cannot be used together in UiResponse');
+    }
 }
 /**
  * Handle a UiResponse from a Webbit handler (menu action or form handler).
@@ -121,12 +170,7 @@ async function handleUiResponse(ctx, uiResponse) {
         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);
+        ctx.ui.showFormInternal(formKeyMap[uiResponse.showForm.name], uiResponse.showForm.data, uiResponse.showForm.form);
     }
 }
 async function callWebbitEndpoint(endpoint, body, metadata) {
@@ -144,9 +188,25 @@ async function callWebbitEndpoint(endpoint, body, metadata) {
     });
     if (!response.ok) {
         const body = await response.text();
-        throw new Error(`Failed to fetch from ${endpoint}: ${response.statusText}, body: ${body.substring(0, 100)}`);
+        let errorMessage = `Failed to POST ${endpoint}: ${response.statusText}, `;
+        if (response.status === 404) {
+            errorMessage += `ensure that you're handling this endpoint in your server code.`;
+        }
+        else {
+            errorMessage += `body: ${body.substring(0, 100)}`;
+        }
+        throw new Error(errorMessage);
+    }
+    const contentType = response.headers.get('Content-Type');
+    if (!contentType || !contentType.includes('application/json')) {
+        throw new Error(`Failed to POST ${endpoint}: expected response type 'application/json', received '${contentType}'`);
+    }
+    try {
+        return await response.json();
+    }
+    catch (error) {
+        throw new Error(`Failed to POST ${endpoint}: ${error}`);
     }
-    return await response.json();
 }
 function configureScheduler(schedulerConfig) {
     const cronTasks = {};

package/define-config.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-config.test.d.ts","sourceRoot":"","sources":["../src/define-config.test.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/server",
-  "version": "0.11.19-next-2025-07-02-17-32-32-070c5de78.0",
+  "version": "0.11.19-next-2025-07-02-19-47-19-53796ec90.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -23,14 +23,14 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.19-next-2025-07-02-17-32-32-070c5de78.0",
-    "@devvit/public-api": "0.11.19-next-2025-07-02-17-32-32-070c5de78.0",
-    "@devvit/shared": "0.11.19-next-2025-07-02-17-32-32-070c5de78.0",
-    "@devvit/shared-types": "0.11.19-next-2025-07-02-17-32-32-070c5de78.0"
+    "@devvit/protos": "0.11.19-next-2025-07-02-19-47-19-53796ec90.0",
+    "@devvit/public-api": "0.11.19-next-2025-07-02-19-47-19-53796ec90.0",
+    "@devvit/shared": "0.11.19-next-2025-07-02-19-47-19-53796ec90.0",
+    "@devvit/shared-types": "0.11.19-next-2025-07-02-19-47-19-53796ec90.0"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.11.19-next-2025-07-02-17-32-32-070c5de78.0",
-    "@devvit/tsconfig": "0.11.19-next-2025-07-02-17-32-32-070c5de78.0",
+    "@devvit/repo-tools": "0.11.19-next-2025-07-02-19-47-19-53796ec90.0",
+    "@devvit/tsconfig": "0.11.19-next-2025-07-02-19-47-19-53796ec90.0",
     "eslint": "9.11.1",
     "typescript": "5.8.3",
     "vitest": "1.6.1"
@@ -39,5 +39,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "ff0d94c018a35999e6089a0ad16f872d35e4f5c2"
+  "gitHead": "3f254687c8acc69f3c5670529ab4790fd910780e"
 }