@devvit/server 0.11.14-next-2025-05-05-765f3688c.0

package/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2023 Reddit Inc.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

package/README.md

@@ -0,0 +1,3 @@
+# @devvit/server
+
+Node.js library for Reddit integration.

package/index.d.ts

@@ -0,0 +1,4 @@
+export { RequestContext, setRequestContext } from './request-context.js';
+export { webbitEnablePost } from './webbit-post.js';
+export { webbitEnable } from './webbit-server.js';
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC"}

package/index.js

@@ -0,0 +1,3 @@
+export { RequestContext, setRequestContext } from './request-context.js';
+export { webbitEnablePost } from './webbit-post.js';
+export { webbitEnable } from './webbit-server.js';

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@devvit/server",
+  "version": "0.11.14-next-2025-05-05-765f3688c.0",
+  "license": "BSD-3-Clause",
+  "repository": {
+    "type": "git",
+    "url": "https://developers.reddit.com/"
+  },
+  "type": "module",
+  "main": "./index.js",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf .turbo coverage dist",
+    "clobber": "yarn clean && rm -rf node_modules",
+    "dev": "tsc -w",
+    "lint": "redlint .",
+    "lint:fix": "yarn lint --fix",
+    "prepublishOnly": "publish-package-json",
+    "test": "yarn test:unit && yarn test:types && yarn lint",
+    "test:types": "tsc --noEmit",
+    "test:unit": "vitest run",
+    "test:unit-with-coverage": "vitest run --coverage"
+  },
+  "types": "./index.d.ts",
+  "dependencies": {
+    "@devvit/protos": "0.11.14-next-2025-05-05-765f3688c.0",
+    "@devvit/public-api": "0.11.14-next-2025-05-05-765f3688c.0",
+    "@devvit/shared-types": "0.11.14-next-2025-05-05-765f3688c.0"
+  },
+  "devDependencies": {
+    "@devvit/repo-tools": "0.11.14-next-2025-05-05-765f3688c.0",
+    "@devvit/tsconfig": "0.11.14-next-2025-05-05-765f3688c.0",
+    "eslint": "9.11.1",
+    "typescript": "5.3.2",
+    "vitest": "1.6.1"
+  },
+  "publishConfig": {
+    "directory": "dist"
+  },
+  "source": "./src/index.ts",
+  "gitHead": "f74f2c6405eac9d70b8ac67cdd13b24370bddb4a"
+}

package/request-context.d.ts

@@ -0,0 +1,19 @@
+import type { Metadata } from '@devvit/protos';
+import type { Context } from '@devvit/public-api';
+/** Devvit server context for the lifetime of a request. */
+export type RequestContext = Omit<Context, 'dimensions' | 'kvStore' | 'modLog' | 'ui' | 'uiEnvironment'>;
+/** Designed to be compatible with IncomingHttpHeaders and any KV. */
+type Headers = {
+    [header: string]: string | string[] | undefined;
+};
+/** Constructs a new RequestContext. */
+export declare let RequestContext: (headers: Readonly<Headers>) => RequestContext;
+/**
+ * Overwrite the context provider for test.
+ * @experimental
+ */
+export declare function setRequestContext(fn: typeof RequestContext): void;
+/** @internal */
+export declare function metaFromIncomingMessage(headers: Readonly<Headers>): Metadata;
+export {};
+//# sourceMappingURL=request-context.d.ts.map

package/request-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request-context.d.ts","sourceRoot":"","sources":["../src/request-context.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAKlD,2DAA2D;AAC3D,MAAM,MAAM,cAAc,GAAG,IAAI,CAC/B,OAAO,EACP,YAAY,GAAG,SAAS,GAAG,QAAQ,GAAG,IAAI,GAAG,eAAe,CAC7D,CAAC;AAEF,qEAAqE;AACrE,KAAK,OAAO,GAAG;IAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;CAAE,CAAC;AAEnE,uCAAuC;AACvC,eAAO,IAAI,cAAc,YAAa,SAAS,OAAO,CAAC,KAAG,cAMzD,CAAC;AAEF;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,EAAE,EAAE,OAAO,cAAc,GAAG,IAAI,CAEjE;AAED,gBAAgB;AAChB,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,QAAQ,CAM5E"}

package/request-context.js

@@ -0,0 +1,23 @@
+import { makeAPIClients } from '@devvit/public-api/apis/makeAPIClients.js';
+import { getContextFromMetadata } from '@devvit/public-api/devvit/internals/context.js';
+import { Header, headerPrefix } from '@devvit/shared-types/Header.js';
+/** Constructs a new RequestContext. */
+export let RequestContext = (headers) => {
+    const meta = metaFromIncomingMessage(headers);
+    return Object.assign(makeAPIClients({ metadata: meta }), getContextFromMetadata(meta, meta[Header.Post]?.values[0]));
+};
+/**
+ * Overwrite the context provider for test.
+ * @experimental
+ */
+export function setRequestContext(fn) {
+    RequestContext = fn;
+}
+/** @internal */
+export function metaFromIncomingMessage(headers) {
+    const meta = {};
+    for (const [key, val] of Object.entries(headers))
+        if (key.startsWith(headerPrefix))
+            meta[key] = { values: typeof val === 'object' ? val : val == null ? [] : [val] };
+    return meta;
+}

package/request-context.test.d.ts.map

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

package/webbit-post.d.ts

@@ -0,0 +1,45 @@
+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);
+};
+/**
+ *
+ * @param {WebbitPostParams }params  Parameters for the webbit post type.
+ * @example
+ * ```ts
+ * webbitEnablePost({
+ *   name: 'Hello Webbit',
+ *   description: 'Custom webbit post',
+ *   height: 'tall',
+ *   entry: 'page.html',
+ *  });
+ * ```
+ */
+export declare function webbitEnablePost(params: WebbitPostParams): void;
+export {};
+//# sourceMappingURL=webbit-post.d.ts.map

package/webbit-post.d.ts.map

@@ -0,0 +1 @@
+{"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;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,CA6B/D"}

package/webbit-post.js

@@ -0,0 +1,123 @@
+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';
+/**
+ *
+ * @param {WebbitPostParams }params  Parameters for the webbit post type.
+ * @example
+ * ```ts
+ * webbitEnablePost({
+ *   name: 'Hello Webbit',
+ *   description: 'Custom webbit post',
+ *   height: 'tall',
+ *   entry: 'page.html',
+ *  });
+ * ```
+ */
+export function webbitEnablePost(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);
+        },
+    };
+}

package/webbit-server.d.ts

@@ -0,0 +1,4 @@
+import { type WebbitServer } from '@devvit/protos/types/devvit/actor/webbit/webbit.js';
+export declare function webbitEnable(): void;
+export declare function newWebbitServer(): WebbitServer;
+//# sourceMappingURL=webbit-server.d.ts.map

package/webbit-server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webbit-server.d.ts","sourceRoot":"","sources":["../src/webbit-server.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,YAAY,EAElB,MAAM,oDAAoD,CAAC;AAI5D,wBAAgB,YAAY,IAAI,IAAI,CAInC;AAED,wBAAgB,eAAe,IAAI,YAAY,CAsB9C"}

package/webbit-server.js

@@ -0,0 +1,29 @@
+import { HttpMethod, WebbitServerDefinition, } from '@devvit/protos/types/devvit/actor/webbit/webbit.js';
+import { Devvit } from '@devvit/public-api';
+import { extendDevvitPrototype } from '@devvit/public-api/devvit/internals/helpers/extendDevvitPrototype.js';
+export function webbitEnable() {
+    const server = newWebbitServer();
+    extendDevvitPrototype('Request', server.Request);
+    Devvit.provide(WebbitServerDefinition);
+}
+export function newWebbitServer() {
+    return {
+        async Request(req, meta) {
+            const port = process.env.WEBBIT_PORT || '3000';
+            // only set the body if the method is not GET or HEAD
+            const body = [HttpMethod.GET, HttpMethod.HEAD].includes(req.method) ? null : req.body;
+            const rsp = await fetch(new URL(req.path, `http://webbit.local:${port}`), {
+                body,
+                headers: [
+                    ...Object.entries(req.headers),
+                    // devvit- headers alway have priority.
+                    ...Object.entries(meta ?? {}).map(([k, v]) => [k, v.values.join()]),
+                ],
+                method: HttpMethod[req.method],
+            });
+            const headers = {};
+            rsp.headers.forEach((v, k) => (headers[k] = v));
+            return { body: new Uint8Array(await rsp.arrayBuffer()), headers, statusCode: rsp.status };
+        },
+    };
+}