@devvit/test 0.12.6-next-2025-12-05-00-07-24-65a40a4e6.0 → 0.12.6-next-2025-12-05-20-00-45-8a5827c28.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devvit/test",
-  "version": "0.12.6-next-2025-12-05-00-07-24-65a40a4e6.0",
+  "version": "0.12.6-next-2025-12-05-20-00-45-8a5827c28.0",
   "license": "BSD-3-Clause",
   "repository": {
     "type": "git",
@@ -12,6 +12,10 @@
       "browser": "./server/serverImportInClientCodePanic.js",
       "default": "./server/index.js"
     },
+    "./server/vitest": {
+      "browser": "./server/serverImportInClientCodePanic.js",
+      "default": "./server/vitest/index.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -30,15 +34,21 @@
     "test:unit": "vitest run",
     "test:unit-with-coverage": "vitest run --coverage"
   },
+  "dependencies": {
+    "@devvit/media": "0.12.6-next-2025-12-05-20-00-45-8a5827c28.0",
+    "@devvit/protos": "0.12.6-next-2025-12-05-20-00-45-8a5827c28.0",
+    "@devvit/server": "0.12.6-next-2025-12-05-20-00-45-8a5827c28.0",
+    "@devvit/shared-types": "0.12.6-next-2025-12-05-20-00-45-8a5827c28.0"
+  },
   "peerDependencies": {
     "vitest": "*"
   },
   "devDependencies": {
-    "@devvit/repo-tools": "0.12.6-next-2025-12-05-00-07-24-65a40a4e6.0",
-    "@devvit/tsconfig": "0.12.6-next-2025-12-05-00-07-24-65a40a4e6.0",
+    "@devvit/repo-tools": "0.12.6-next-2025-12-05-20-00-45-8a5827c28.0",
+    "@devvit/tsconfig": "0.12.6-next-2025-12-05-20-00-45-8a5827c28.0",
     "eslint": "9.11.1",
     "typescript": "5.8.3",
     "vitest": "1.6.1"
   },
-  "gitHead": "6f4e34703e939f2aa7436d9d2f0330aeb4b3ae8e"
+  "gitHead": "8fe5d0140935bfdd2604f96d4404810e20f2c896"
 }

package/server/index.d.ts

@@ -1,2 +1,2 @@
-export declare const hello = "world";
+export * from '@devvit/media/test';
 //# sourceMappingURL=index.d.ts.map

package/server/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,KAAK,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/server/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}

package/server/index.js

@@ -1 +1 @@
-export const hello = 'world';
+export * from '@devvit/media/test';

package/server/vitest/context.d.ts

@@ -0,0 +1,10 @@
+import type { Config } from '@devvit/shared-types/Config.js';
+import type { AppConfig } from '@devvit/shared-types/schemas/config-file.v1.js';
+export type TestContext = {
+    config: Config;
+    appConfig?: AppConfig | undefined;
+};
+export declare function runWithTestContext<T>(context: TestContext, fn: () => T): T;
+export declare function getTestContext(): TestContext | undefined;
+export declare function installDevvitInterceptors(): void;
+//# sourceMappingURL=context.d.ts.map

package/server/vitest/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/server/vitest/context.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAC;AAGhF,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,SAAS,GAAG,SAAS,CAAC;CACnC,CAAC;AAIF,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,CAAC,GAAG,CAAC,CAE1E;AAED,wBAAgB,cAAc,IAAI,WAAW,GAAG,SAAS,CAExD;AAcD,wBAAgB,yBAAyB,SAIxC"}

package/server/vitest/context.js

@@ -0,0 +1,25 @@
+import { AsyncLocalStorage } from 'node:async_hooks';
+import {} from '@devvit/shared-types/shared/devvit-worker-global.js';
+const contextStorage = new AsyncLocalStorage();
+export function runWithTestContext(context, fn) {
+    return contextStorage.run(context, fn);
+}
+export function getTestContext() {
+    return contextStorage.getStore();
+}
+class TestDevvitWorkerGlobal {
+    constructor() {
+        this.compute = { platform: 'node' };
+    }
+    get config() {
+        return getTestContext()?.config;
+    }
+    get appConfig() {
+        return getTestContext()?.appConfig;
+    }
+}
+export function installDevvitInterceptors() {
+    if (globalThis.devvit instanceof TestDevvitWorkerGlobal)
+        return;
+    globalThis.devvit = new TestDevvitWorkerGlobal();
+}

package/server/vitest/context.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.test.d.ts","sourceRoot":"","sources":["../../../src/server/vitest/context.test.ts"],"names":[],"mappings":"AAAA,OAAO,qDAAqD,CAAC"}

package/server/vitest/devvitTest.d.ts

@@ -0,0 +1,102 @@
+import { MediaMock } from '@devvit/media/test';
+import type { Config } from '@devvit/shared-types/Config.js';
+import { Header } from '@devvit/shared-types/Header.js';
+import type { AppConfig } from '@devvit/shared-types/schemas/config-file.v1.js';
+import type { T2, T5 } from '@devvit/shared-types/tid.js';
+import type { TestAPI } from 'vitest';
+export type DevvitFixtures = {
+    /**
+     * The Devvit configuration object for the current test context.
+     */
+    config: Config;
+    /**
+     * Request headers simulating a real Devvit execution environment.
+     */
+    headers: {
+        [key in Header]?: string;
+    };
+    /**
+     * App settings configured for this test instance.
+     * Can be customized via `createDevvitTest({ settings: ... })`.
+     */
+    settings: {
+        [key: string]: string | number | boolean | string[] | undefined;
+    };
+    /**
+     * The username of the simulated user executing the app.
+     * @default 'testuser'
+     */
+    username: string;
+    /**
+     * The user ID (t2_*) of the simulated user.
+     * @default 't2_testuser'
+     */
+    userId: T2;
+    /**
+     * The name of the subreddit where the app is running.
+     * @default 'testsub'
+     */
+    subredditName: string;
+    /**
+     * The subreddit ID (t5_*) where the app is running.
+     * @default 't5_testsub'
+     */
+    subredditId: T5;
+    /**
+     * Direct access to mock implementations of Devvit capabilities.
+     * Use these to inspect state or configure specific mock behaviors.
+     */
+    mocks: {
+        media: MediaMock;
+    };
+};
+export type DevvitTestConfig = {
+    /**
+     * The username of the simulated user.
+     * @default 'testuser'
+     */
+    username?: string;
+    /**
+     * The user ID (t2_*) of the simulated user.
+     * @default 't2_testuser'
+     */
+    userId?: T2;
+    /**
+     * The name of the subreddit where the app is running.
+     * @default 'testsub'
+     */
+    subredditName?: string;
+    /**
+     * The subreddit ID (t5_*) where the app is running.
+     * @default 't5_testsub'
+     */
+    subredditId?: T5;
+    /**
+     * Pre-configured app settings to be available via `context.settings`. Use to set
+     * settings for use with the `@devvit/settings` capability to make it easier to test.
+     */
+    settings?: {
+        [key: string]: string | number | boolean | string[] | undefined;
+    };
+    /**
+     * Custom AppConfig to use for the test environment. For internal use.
+     */
+    appConfig?: AppConfig;
+};
+/**
+ * Creates a test runner with customized Devvit environment.
+ *
+ * @example
+ * const test = createDevvitTest({
+ *   username: 'moderator_bob',
+ *   settings: { enable_ban_hammer: true }
+ * });
+ *
+ * test('mod action works', async ({ config, headers }) => {
+ *   // ...
+ * });
+ *
+ * @experimental
+ */
+export declare const createDevvitTest: (config?: DevvitTestConfig) => TestAPI<DevvitFixtures>;
+//# sourceMappingURL=devvitTest.d.ts.map

package/server/vitest/devvitTest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"devvitTest.d.ts","sourceRoot":"","sources":["../../../src/server/vitest/devvitTest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAG/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,gCAAgC,CAAC;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAC;AAMhF,OAAO,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,EAAE,OAAO,EAAgB,MAAM,QAAQ,CAAC;AAOpD,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE;SAAG,GAAG,IAAI,MAAM,CAAC,CAAC,EAAE,MAAM;KAAE,CAAC;IAEtC;;;OAGG;IACH,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;KAAE,CAAC;IAE9E;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,MAAM,EAAE,EAAE,CAAC;IAEX;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,WAAW,EAAE,EAAE,CAAC;IAEhB;;;OAGG;IACH,KAAK,EAAE;QACL,KAAK,EAAE,SAAS,CAAC;KAClB,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,CAAC,EAAE,EAAE,CAAC;IAEZ;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,WAAW,CAAC,EAAE,EAAE,CAAC;IAEjB;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;KAAE,CAAC;IAE/E;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB,CAAC;AA+HF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,gBAAgB,GAAI,SAAQ,gBAAqB,KAAG,OAAO,CAAC,cAAc,CAEtF,CAAC"}

package/server/vitest/devvitTest.js

@@ -0,0 +1,117 @@
+import { MediaMock } from '@devvit/media/test';
+import { MediaServiceDefinition } from '@devvit/protos/types//devvit/plugin/media/media.js';
+import { Context, runWithContext } from '@devvit/server';
+import { Header } from '@devvit/shared-types/Header.js';
+import { getDefaultAppConfig, makeConfig, MOCK_HEADERS as headersMock, } from '@devvit/shared-types/test/index.js';
+import { test as baseTest } from 'vitest';
+import { installDevvitInterceptors, runWithTestContext } from './context.js';
+installDevvitInterceptors();
+function createWrappedTestApi(target, setup) {
+    return new Proxy(target, {
+        // Handles: test(...), test.only(...), test.skip(...),
+        // test.each(table)(...), test.concurrent(...), etc.
+        apply(fn, thisArg, argArray) {
+            const args = [...argArray];
+            // Find the last function argument (the test body / hook body)
+            let lastFnIndex = -1;
+            for (let i = args.length - 1; i >= 0; i--) {
+                if (typeof args[i] === 'function') {
+                    lastFnIndex = i;
+                    break;
+                }
+            }
+            if (lastFnIndex !== -1) {
+                const userFn = args[lastFnIndex];
+                // Wrap the user's test function
+                args[lastFnIndex] = (...fnArgs) => {
+                    const { reqCtx, fixtures, testContext } = setup();
+                    // Heuristic to detect Vitest TestContext
+                    // Standard test() calls receive a single TestContext object.
+                    // test.each() calls receive the parameters as arguments.
+                    const isTestContext = fnArgs.length === 1 &&
+                        fnArgs[0] &&
+                        (typeof fnArgs[0] === 'object' || typeof fnArgs[0] === 'function') &&
+                        'task' in fnArgs[0] &&
+                        // Vitest context usually has these lifecycle methods
+                        'onTestFailed' in fnArgs[0];
+                    if (isTestContext) {
+                        const mergedCtx = { ...fixtures, ...fnArgs[0] };
+                        return runWithContext(reqCtx, () => runWithTestContext(testContext, () => userFn(mergedCtx)));
+                    }
+                    return runWithContext(reqCtx, () => runWithTestContext(testContext, () => userFn(...fnArgs)));
+                };
+            }
+            const result = Reflect.apply(fn, thisArg, args);
+            // IMPORTANT for `.each` (and any curried API):
+            // if the result is a function, wrap it too so subsequent call(s)
+            // also get fixtures + ALS.
+            if (typeof result === 'function') {
+                return createWrappedTestApi(result, setup);
+            }
+            return result;
+        },
+        // Handles property access: test.only, test.skip, test.each, test.concurrent, ...
+        get(fn, prop, receiver) {
+            const value = Reflect.get(fn, prop, receiver);
+            if (typeof value === 'function') {
+                return createWrappedTestApi(value, setup);
+            }
+            return value;
+        },
+    });
+}
+const setup = (config) => {
+    const username = config.username ?? 'testuser';
+    const userId = config.userId ?? 't2_testuser';
+    const subredditName = config.subredditName ?? 'testsub';
+    const subredditId = config.subredditId ?? 't5_testsub';
+    const settings = config.settings ?? {};
+    const appConfig = config.appConfig;
+    const headers = {
+        ...headersMock,
+        [Header.User]: userId,
+        [Header.Username]: username,
+        [Header.AppUser]: userId,
+        [Header.Subreddit]: subredditId,
+        [Header.SubredditName]: subredditName,
+    };
+    const mediaMock = new MediaMock();
+    const cfg = makeConfig({
+        plugins: {
+            [MediaServiceDefinition.fullName]: mediaMock,
+        },
+    });
+    const contextAppConfig = appConfig ?? getDefaultAppConfig();
+    const reqCtx = Context(headers);
+    const fixtures = {
+        config: cfg,
+        headers,
+        settings,
+        username,
+        userId,
+        subredditName,
+        subredditId,
+        mocks: {
+            media: mediaMock,
+        },
+    };
+    return { reqCtx, fixtures, testContext: { config: cfg, appConfig: contextAppConfig } };
+};
+/**
+ * Creates a test runner with customized Devvit environment.
+ *
+ * @example
+ * const test = createDevvitTest({
+ *   username: 'moderator_bob',
+ *   settings: { enable_ban_hammer: true }
+ * });
+ *
+ * test('mod action works', async ({ config, headers }) => {
+ *   // ...
+ * });
+ *
+ * @experimental
+ */
+export const createDevvitTest = (config = {}) => {
+    return createWrappedTestApi(baseTest, () => setup(config));
+};

package/server/vitest/devvitTest.media.test.d.ts.map

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

package/server/vitest/devvitTest.test.d.ts.map

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

package/server/vitest/index.d.ts

@@ -0,0 +1,2 @@
+export * from './devvitTest.js';
+//# sourceMappingURL=index.d.ts.map

package/server/vitest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/server/vitest/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}

package/server/vitest/index.js

@@ -0,0 +1 @@
+export * from './devvitTest.js';

package/server/index.test.d.ts.map

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