@devvit/server 0.11.19-next-2025-07-02-19-55-03-bc5010226.0 → 0.11.19-next-2025-07-02-23-07-18-cc63be6e8.0

package/index.d.ts

@@ -1,6 +1,5 @@
 export { context } from './context.js';
 export { createServer } from './create-server.js';
-export { defineConfig } from './define-config.js';
 export { getServerPort } from './get-server-port.js';
 export { RequestContext } from './request-context.js';
 //# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC"}

package/index.js

@@ -1,5 +1,4 @@
 export { context } from './context.js';
 export { createServer } from './create-server.js';
-export { defineConfig } from './define-config.js';
 export { getServerPort } from './get-server-port.js';
 export { RequestContext } from './request-context.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/server",
-  "version": "0.11.19-next-2025-07-02-19-55-03-bc5010226.0",
+  "version": "0.11.19-next-2025-07-02-23-07-18-cc63be6e8.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-19-55-03-bc5010226.0",
-    "@devvit/public-api": "0.11.19-next-2025-07-02-19-55-03-bc5010226.0",
-    "@devvit/shared": "0.11.19-next-2025-07-02-19-55-03-bc5010226.0",
-    "@devvit/shared-types": "0.11.19-next-2025-07-02-19-55-03-bc5010226.0"
+    "@devvit/protos": "0.11.19-next-2025-07-02-23-07-18-cc63be6e8.0",
+    "@devvit/public-api": "0.11.19-next-2025-07-02-23-07-18-cc63be6e8.0",
+    "@devvit/shared": "0.11.19-next-2025-07-02-23-07-18-cc63be6e8.0",
+    "@devvit/shared-types": "0.11.19-next-2025-07-02-23-07-18-cc63be6e8.0"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.11.19-next-2025-07-02-19-55-03-bc5010226.0",
-    "@devvit/tsconfig": "0.11.19-next-2025-07-02-19-55-03-bc5010226.0",
+    "@devvit/repo-tools": "0.11.19-next-2025-07-02-23-07-18-cc63be6e8.0",
+    "@devvit/tsconfig": "0.11.19-next-2025-07-02-23-07-18-cc63be6e8.0",
     "eslint": "9.11.1",
     "typescript": "5.8.3",
     "vitest": "1.6.1"
@@ -39,5 +39,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "d8baacc359d2f7d076329c45209a9ecbf32e9030"
+  "gitHead": "3ad54dc774a5ec586700b0fb23112b3d606db3fb"
 }

package/define-config.d.ts

@@ -1,65 +0,0 @@
-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
- * LinkedBundles except for the deprecated Blocks callbacks. This config is used
- * to generate classic compatible builds for clients via the Devvit CLI and
- * configure the singleton at runtime for the compute bootstrap. The dynamic
- * behavior is for old templates.
- *
- * @experimental
- */
-export type DynamicAppConfig = {
-    permissions: AppPermissionConfig;
-    post?: DynamicAppPostConfig | undefined;
-    menuActions?: AppMenuActionConfig[];
-    scheduler?: AppSchedulerConfig | undefined;
-    forms?: AppFormsConfig;
-};
-/** @experimental */
-export type DynamicAppPostConfig = {
-    client: {
-        dir: string;
-        entry: string;
-        /** @deprecated */
-        blocks?: {
-            /** Render post inline or use custom renderer. */
-            render?: 'inline' | {
-                mode: 'modal';
-                /**
-                 * The text for the button that launches the app in a modal.
-                 * @default 'Launch App'
-                 */
-                label?: (() => string) | undefined;
-            } | Devvit.CustomPostComponent | undefined;
-        };
-    };
-    create: DynamicAppPostCreateConfig;
-};
-/** @experimental */
-export type DynamicAppPostCreateConfig = AppPostCreateConfig & {
-    /** @deprecated */
-    blocks?: {
-        /**
-         * App loading screen. Evaluated at post creation time. Call
-         * `Post.setCustomPostPreview()` to change after creation.
-         * @default 'Loading…'
-         */
-        render?(): JSX.Element | undefined;
-        /**
-         * Dynamic post title.
-         * @default post.create.title
-         */
-        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 +0,0 @@
-{"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,271 +0,0 @@
-import { Devvit, useWebView, } from '@devvit/public-api';
-import { getServerPort } from './get-server-port.js';
-/** @internal [state] Map of devvit.json form keys to Devvit-singleton form keys. */
-export const formKeyMap = {};
-/** @experimental */
-export function defineConfig(config) {
-    configurePermissions(config.permissions);
-    if (config.post)
-        configurePost(config.post);
-    if (config.menuActions)
-        configureMenuActions(config.menuActions);
-    if (config.scheduler)
-        configureScheduler(config.scheduler);
-    if (config.forms)
-        configureForms(config.forms);
-    return Devvit;
-}
-function configurePermissions(permissions) {
-    // to-do: remove. This is a relic of LinkedBundle generation.
-    Devvit.configure({
-        http: {
-            enabled: permissions.http.enable,
-            domains: permissions.http.domains,
-        },
-        media: permissions.media,
-        // to-do: payments permissions.
-        realtime: permissions.realtime,
-        redditAPI: permissions.reddit.enable,
-        modLog: permissions.reddit.scope === 'moderator',
-        // to-do: configure userActions with API granularity.
-        userActions: !!permissions.reddit.asUser.length,
-        redis: permissions.redis,
-    });
-}
-function configurePost(post) {
-    let render;
-    // eslint-disable-next-line security/detect-non-literal-regexp
-    const path = post.client.entry.replace(new RegExp(`^${post.client.dir}/?`), '');
-    if (post.client.blocks?.render === 'inline')
-        render = renderInline.bind(undefined, path);
-    else if (typeof post.client.blocks?.render === 'function')
-        render = post.client.blocks.render;
-    else
-        render = renderModal.bind(undefined, path, post.client.blocks?.render?.label);
-    Devvit.addCustomPostType({
-        name: post.create.title,
-        render,
-        height: post.create.height,
-    });
-    if (post.create.menu.enable) {
-        Devvit.addMenuItem({
-            forUserType: post.create.menu.scope === 'moderator' ? 'moderator' : 'loggedOut',
-            label: post.create.menu.label,
-            location: 'subreddit',
-            async onPress(_ev, ctx) {
-                const newPost = await createPost(ctx, post.create);
-                ctx.ui.showToast({
-                    text: `Created post "${newPost.title}" in ${ctx.subredditName}. Navigating to it now.`,
-                    appearance: 'success',
-                });
-                ctx.ui.navigateTo(newPost);
-            },
-        });
-    }
-    if (post.create.onInstall)
-        Devvit.addTrigger({
-            event: 'AppInstall',
-            async onEvent(_ev, ctx) {
-                await createPost(ctx, post.create);
-            },
-        });
-}
-function configureMenuActions(menuActions) {
-    for (const action of menuActions) {
-        const menuItem = {
-            label: action.label,
-            location: action.location,
-            onPress: async (ev, ctx) => {
-                const responseJson = await callWebbitEndpoint(action.endpoint, ev, ctx.debug.metadata);
-                const uiResponse = responseJson;
-                validateUiResponse(uiResponse);
-                await handleUiResponse(ctx, uiResponse);
-            },
-        };
-        // "user" type is blank in Devvit classic. So if it's present in
-        // devvit.json, we add an extra menu item without forUserType set.
-        // "moderator" maps across as expected.
-        // "loggedOut" type (Devvit classic) we no longer support
-        if (action.forUserType === 'moderator')
-            menuItem.forUserType = 'moderator';
-        if (action.postFilter === 'currentApp')
-            menuItem.postFilter = action.postFilter;
-        if (action.description)
-            menuItem.description = action.description;
-        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);
-    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).
- * 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) {
-        ctx.ui.showFormInternal(formKeyMap[uiResponse.showForm.name], 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();
-        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}`);
-    }
-}
-function configureScheduler(schedulerConfig) {
-    const cronTasks = {};
-    for (const [name, task] of Object.entries(schedulerConfig.tasks)) {
-        Devvit.addSchedulerJob({
-            name: name,
-            onRun: async (event, context) => {
-                await callWebbitEndpoint(task.endpoint, {
-                    name: event.name,
-                    data: event.data ?? null, // JSONObject wants null not undefined
-                }, context.debug.metadata);
-            },
-        });
-        // Tasks with cron specified require a bit more work further down
-        if (task.cron) {
-            cronTasks[name] = task;
-        }
-    }
-    // If provided, schedule any cron tasks the user asked for on install/upgrade, being careful to
-    // un-schedule any previously scheduled instances of these tasks
-    if (Object.keys(cronTasks).length > 0) {
-        Devvit.addTrigger({
-            events: ['AppInstall', 'AppUpgrade'],
-            onEvent: async (_event, context) => {
-                // Get all jobs
-                const existingJobs = await context.scheduler.listJobs();
-                // Filter down to just cron jobs
-                const jobsToCancel = existingJobs.filter((job) => {
-                    // Only cancel cron jobs
-                    return 'cron' in job;
-                });
-                // Cancel everything we need to
-                await Promise.all(jobsToCancel.map((job) => context.scheduler.cancelJob(job.id)));
-                // Schedule all the cron tasks we were given in the config
-                await Promise.all(Object.entries(cronTasks).map(async ([name, task]) => {
-                    await context.scheduler.runJob({
-                        name: name,
-                        cron: task.cron,
-                    });
-                }));
-            },
-        });
-    }
-}
-async function createPost(ctx, create) {
-    if (!ctx.subredditName)
-        throw Error('no sub name');
-    return await ctx.reddit.submitPost({
-        preview: create.blocks?.render?.() ?? Devvit.createElement("text", null, "Loading\u2026"),
-        subredditName: ctx.subredditName,
-        title: (await create.blocks?.title?.()) ?? create.title,
-    });
-}
-function renderInline(path, _ctx) {
-    return Devvit.createElement("webview", { url: path, width: "100%", height: "100%" });
-}
-function renderModal(path, label, _ctx) {
-    const webView = useWebView({ url: path, onMessage() { } });
-    return (Devvit.createElement("vstack", { alignment: "center middle", height: "100%" },
-        Devvit.createElement("button", { onPress: webView.mount }, label?.() ?? 'Launch App'),
-        ";"));
-}

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

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