@devvit/server 0.11.17-next-2025-05-29-a51058b05.0 → 0.11.17-next-2025-06-02-02cef9c33.0

package/define-config.d.ts

@@ -0,0 +1,54 @@
+import { Devvit } from '@devvit/public-api';
+import type { AppConfig, 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
+ * 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;
+};
+/** @experimental */
+export type DynamicAppPostConfig = {
+    client: {
+        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;
+};
+/** @experimental */
+export declare function defineConfig(config: Readonly<DynamicAppConfig | AppConfig>): void;
+//# sourceMappingURL=define-config.d.ts.map

package/define-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"define-config.d.ts","sourceRoot":"","sources":["../src/define-config.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAgB,MAAM,EAA0C,MAAM,oBAAoB,CAAC;AAClG,OAAO,KAAK,EACV,SAAS,EACT,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,gDAAgD,CAAC;AAExD;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,mBAAmB,CAAC;IACjC,IAAI,CAAC,EAAE,oBAAoB,GAAG,SAAS,CAAC;CACzC,CAAC;AAEF,oBAAoB;AACpB,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE;QACN,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,IAAI,CAGjF"}

package/define-config.js

@@ -0,0 +1,77 @@
+import { Devvit, useWebView } from '@devvit/public-api';
+/** @experimental */
+export function defineConfig(config) {
+    configurePermissions(config.permissions);
+    if (config.post)
+        configurePost(config.post);
+}
+function configurePermissions(permissions) {
+    // to-do: remove. This is a relic of LinkedBundle generation.
+    Devvit.configure({
+        http: {
+            enabled: permissions.http.enabled,
+            requestedFetchDomains: permissions.http.allowedDomains,
+        },
+        media: permissions.media,
+        // to-do: payments permissions.
+        realtime: permissions.realtime,
+        redditAPI: permissions.reddit.enabled,
+        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;
+    if (post.client.blocks?.render === 'inline')
+        render = renderInline.bind(undefined, post.client.entry);
+    else if (typeof post.client.blocks?.render === 'function')
+        render = post.client.blocks.render;
+    else
+        render = renderModal.bind(undefined, post.client.entry, 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);
+            },
+        });
+}
+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(entry, _ctx) {
+    return Devvit.createElement("webview", { url: entry, width: "100%", height: "100%" });
+}
+function renderModal(entry, label, _ctx) {
+    const webView = useWebView({ url: entry, onMessage() { } });
+    return (Devvit.createElement("vstack", { alignment: "center middle", height: "100%" },
+        Devvit.createElement("button", { onPress: webView.mount }, label?.() ?? 'Launch App'),
+        ";"));
+}

package/index.d.ts

@@ -1,7 +1,6 @@
 export { getContext } from './context.js';
 export { createServer } from './create-server.js';
+export { defineConfig } from './define-config.js';
 export { getServerPort } from './get-server-port.js';
 export { RequestContext, setRequestContext } from './request-context.js';
-export { defineConfig } from './webbit-post.js';
-export { webbitEnable } from './webbit-server.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,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,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,iBAAiB,EAAE,MAAM,sBAAsB,CAAC"}

package/index.js

@@ -1,6 +1,5 @@
 export { getContext } from './context.js';
 export { createServer } from './create-server.js';
+export { defineConfig } from './define-config.js';
 export { getServerPort } from './get-server-port.js';
 export { RequestContext, setRequestContext } from './request-context.js';
-export { defineConfig } from './webbit-post.js';
-export { webbitEnable } from './webbit-server.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/server",
-  "version": "0.11.17-next-2025-05-29-a51058b05.0",
+  "version": "0.11.17-next-2025-06-02-02cef9c33.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -23,13 +23,13 @@
   },
   "types": "./index.d.ts",
   "dependencies": {
-    "@devvit/protos": "0.11.17-next-2025-05-29-a51058b05.0",
-    "@devvit/public-api": "0.11.17-next-2025-05-29-a51058b05.0",
-    "@devvit/shared-types": "0.11.17-next-2025-05-29-a51058b05.0"
+    "@devvit/protos": "0.11.17-next-2025-06-02-02cef9c33.0",
+    "@devvit/public-api": "0.11.17-next-2025-06-02-02cef9c33.0",
+    "@devvit/shared-types": "0.11.17-next-2025-06-02-02cef9c33.0"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.11.17-next-2025-05-29-a51058b05.0",
-    "@devvit/tsconfig": "0.11.17-next-2025-05-29-a51058b05.0",
+    "@devvit/repo-tools": "0.11.17-next-2025-06-02-02cef9c33.0",
+    "@devvit/tsconfig": "0.11.17-next-2025-06-02-02cef9c33.0",
     "eslint": "9.11.1",
     "typescript": "5.8.3",
     "vitest": "1.6.1"
@@ -38,5 +38,5 @@
     "directory": "dist"
   },
   "source": "./src/index.ts",
-  "gitHead": "9bf59270eb165569a0b2b8e3a11094c6d061abad"
+  "gitHead": "669392bbc9c49dbb068099d4e472d5b14215e598"
 }

package/webbit-post.d.ts

@@ -1,46 +0,0 @@
-import { type Context, type CustomPostType, type SubmitCustomPostOptions } from '@devvit/public-api';
-/** Configuration parameters for creating a webbit post type. */
-type WebbitPostParams = Omit<CustomPostType, 'render'> & Partial<Pick<CustomPostType, 'render'>> & {
-    /** The path to the HTML entrypoint for the frontend */
-    entry: string;
-    menu?: WebbitMenuParams;
-    /** If true, the webbit post will be rendered inline in the post body instead of a focus mode webview with a launch button. */
-    inline?: boolean;
-    /**
-     * The text for the button that launches the webbit app in focus mode
-     * @defaultValue 'Launch App'
-     */
-    launchButtonText?: string;
-};
-/** Optional parameters for the automatically created subreddit menu item for creating posts. */
-type WebbitMenuParams = Partial<Pick<SubmitCustomPostOptions, 'preview'>> & {
-    /**
-     * Whether the menu item is enabled
-     * @defaultValue true
-     */
-    enable?: boolean;
-    /**
-     * The label for the menu item
-     * @defaultValue '[${app name}] New Post'
-     */
-    label?: string;
-    /** The title of the post to be created. Can be a static string or a function that returns a string. */
-    postTitle?: string | ((context: Context) => Promise<string> | string);
-};
-/**
- * @experimental
- *
- * @param {WebbitPostParams }params  Parameters for the webbit post type.
- * @example
- * ```ts
- * defineConfig({
- *   name: 'Hello Webbit',
- *   description: 'Custom webbit post',
- *   height: 'tall',
- *   entry: 'page.html',
- *  });
- * ```
- */
-export declare function defineConfig(params: WebbitPostParams): void;
-export {};
-//# sourceMappingURL=webbit-post.d.ts.map

package/webbit-post.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"webbit-post.d.ts","sourceRoot":"","sources":["../src/webbit-post.tsx"],"names":[],"mappings":"AAKA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,cAAc,EAKnB,KAAK,uBAAuB,EAI7B,MAAM,oBAAoB,CAAC;AAM5B,gEAAgE;AAChE,KAAK,gBAAgB,GAAG,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,GACpD,OAAO,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC,GAAG;IACxC,uDAAuD;IACvD,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,8HAA8H;IAC9H,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEJ,gGAAgG;AAChG,KAAK,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,uBAAuB,EAAE,SAAS,CAAC,CAAC,GAAG;IAC1E;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uGAAuG;IACvG,SAAS,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC;CACvE,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CA6B3D"}

package/webbit-post.js

@@ -1,124 +0,0 @@
-import { EffectType } from '@devvit/protos';
-import { WebbitServerDefinition, } from '@devvit/protos/types/devvit/actor/webbit/webbit.js';
-import { Devvit, useChannel, useState, useWebView, } from '@devvit/public-api';
-import { useEffectEmitter } from '@devvit/public-api/devvit/internals/blocks/handler/BlocksHandler.js';
-import { extendDevvitPrototype } from '@devvit/public-api/devvit/internals/helpers/extendDevvitPrototype.js';
-import { newWebbitServer } from './webbit-server.js';
-/**
- * @experimental
- *
- * @param {WebbitPostParams }params  Parameters for the webbit post type.
- * @example
- * ```ts
- * defineConfig({
- *   name: 'Hello Webbit',
- *   description: 'Custom webbit post',
- *   height: 'tall',
- *   entry: 'page.html',
- *  });
- * ```
- */
-export function defineConfig(params) {
-    // add the webbit server to the Devvit prototype
-    const server = newWebbitServer();
-    extendDevvitPrototype('Request', server.Request);
-    // enable Devvit features
-    Devvit.configure({
-        realtime: true,
-        redditAPI: true,
-    });
-    Devvit.provide(WebbitServerDefinition);
-    let render = (context) => params.inline ? defaultInlineRender(context, params) : defaultRender(params);
-    if (params.render) {
-        render = params.render;
-    }
-    // setup the custom post type
-    Devvit.addCustomPostType({ ...params, render });
-    // setup a menu item to create a webbit post
-    if (params.menu?.enable === false) {
-        // If the menu is disabled, we don't add a menu item.
-        return;
-    }
-    Devvit.addMenuItem(defaultMenuItem(params));
-}
-function defaultRender(params) {
-    const launchButtonText = params.launchButtonText ?? 'Launch App';
-    const [subscriptions, setSubscriptions] = useState([]);
-    const onMessage = messageHandler(setSubscriptions);
-    const { mount, postMessage } = useWebView({
-        // URL of your web view content
-        url: params.entry,
-        // Handle messages from web view
-        onMessage,
-    });
-    messageRelay(subscriptions, postMessage);
-    return (Devvit.createElement("vstack", { alignment: "center middle", height: "100%" },
-        Devvit.createElement("button", { onPress: mount }, launchButtonText),
-        ";"));
-}
-function defaultInlineRender(context, params) {
-    const webViewId = 'webView';
-    const [subscriptions, setSubscriptions] = useState([]);
-    messageRelay(subscriptions, (msg) => {
-        context.ui.webView.postMessage(webViewId, msg);
-    });
-    const onMessage = messageHandler(setSubscriptions);
-    return (Devvit.createElement("webview", { id: webViewId, url: params.entry, width: "100%", height: "100%", onMessage: onMessage }));
-}
-function messageHandler(setSubscriptions) {
-    const emitter = useEffectEmitter();
-    return (message) => {
-        // if is object, check type
-        if (typeof message === 'object' &&
-            message !== null &&
-            'type' in message &&
-            message.type === 'effect') {
-            const effect = message.data;
-            const dedupeKey = message.key;
-            // Needs to be handled specially because its a dynamic subscription set.
-            if (effect.type === EffectType.EFFECT_REALTIME_SUB) {
-                setSubscriptions(effect.realtimeSubscriptions?.subscriptionIds ?? []);
-            }
-            emitter.emitEffect(dedupeKey, effect);
-        }
-    };
-}
-function messageRelay(subscriptions, sender) {
-    for (const sub of subscriptions) {
-        const channel = useChannel({
-            name: sub,
-            onMessage: (msg) => {
-                sender({
-                    type: 'realtime',
-                    channel: sub,
-                    msg,
-                });
-            },
-        });
-        channel.subscribe();
-    }
-}
-function defaultMenuItem({ name, menu }) {
-    return {
-        forUserType: ['moderator'],
-        label: menu?.label || `[${name}] New Post`,
-        location: 'subreddit',
-        async onPress(_ev, ctx) {
-            const title = typeof menu?.postTitle === 'function'
-                ? await menu?.postTitle(ctx)
-                : menu?.postTitle || name;
-            if (!ctx.subredditName)
-                throw Error('invalid subreddit name');
-            const post = await ctx.reddit.submitPost({
-                preview: menu?.preview || Devvit.createElement("text", null, "Loading\u2026"),
-                subredditName: ctx.subredditName,
-                title,
-            });
-            await ctx.ui.showToast({
-                text: `Created post "${title}" in ${ctx.subredditName}. Navigating to it now.`,
-                appearance: 'success',
-            });
-            ctx.ui.navigateTo(post);
-        },
-    };
-}