@definitely-fine/nextjs 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 definitely-fine contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,142 @@
+# @definitely-fine/nextjs
+
+`@definitely-fine/nextjs` connects `definitely-fine` scenario context to Next.js request handling.
+
+It reads a scenario id from a request header and runs route handlers or server actions inside that active scenario context.
+
+## Installation
+
+```bash
+pnpm add definitely-fine @definitely-fine/nextjs
+```
+
+## Important
+
+> [!IMPORTANT]
+> Do not leave scenario activation enabled in production by accident.
+>
+> `@definitely-fine/nextjs` will activate scenario context whenever the request header is present.
+> In production, pair this package with `createRuntime({ enabled: false })` in your core runtime, or avoid wrapping handlers and server actions there entirely.
+
+Core runtime protection:
+
+```ts
+import { createRuntime } from "definitely-fine";
+
+const runtime = createRuntime<DemoContract>({
+  enabled: process.env.NODE_ENV !== "production",
+});
+```
+
+Optional route-level guard:
+
+```ts
+import { withDefinitelyFineScenario } from "@definitely-fine/nextjs";
+
+const postCounterResponse = async (_request: Request): Promise<Response> => {
+  return Response.json({ ok: true });
+};
+
+export const POST =
+  process.env.NODE_ENV === "production"
+    ? postCounterResponse
+    : withDefinitelyFineScenario(postCounterResponse);
+```
+
+## What This Package Does
+
+This package does not replace the core runtime. You still create your scenarios and wrapped runtime with `definitely-fine`.
+
+Its job is narrower:
+
+- define the scenario header name constant
+- read that header from `Request` or `Headers`
+- run a route handler or server action inside `runWithRuntimeScenarioContext()`
+
+```mermaid
+flowchart LR
+  subgraph C[Client or browser process]
+    C1[request]
+    C2[x-definitely-fine-scenario-id header]
+  end
+
+  subgraph N[Next.js server process]
+    N1[@definitely-fine/nextjs wrapper]
+    N2[runWithRuntimeScenarioContext]
+    N3[definitely-fine runtime]
+    N4[wrapped app service or function]
+  end
+
+  subgraph S[Shared scenario storage]
+    S1[(persisted scenario JSON)]
+  end
+
+  C1 --> C2 --> N1
+  N1 --> N2 --> N3 --> N4
+  N3 -- load active scenario --> S1
+```
+
+## Route Handlers
+
+Use `withDefinitelyFineScenario()` to wrap a route handler.
+
+```ts
+import { withDefinitelyFineScenario } from "@definitely-fine/nextjs";
+import { incrementApiCounter } from "../lib/demo-runtime";
+
+async function postCounterResponse(_request: Request): Promise<Response> {
+  return Response.json(incrementApiCounter());
+}
+
+export const POST = withDefinitelyFineScenario(postCounterResponse);
+```
+
+If the request does not include the scenario header, the handler runs normally.
+
+## Server Actions
+
+Use `withDefinitelyFineServerAction()` to wrap a server action.
+
+```ts
+"use server";
+
+import { withDefinitelyFineServerAction } from "@definitely-fine/nextjs";
+
+import {
+  incrementActionCounter,
+  type CounterResult,
+} from "../lib/demo-runtime";
+
+export const incrementCounterAction = withDefinitelyFineServerAction(
+  async function incrementCounterActionImplementation(
+    _previousState: CounterResult,
+  ): Promise<CounterResult> {
+    return incrementActionCounter();
+  },
+);
+```
+
+## Header Name
+
+The default exported header constant is `DEFINITELY_FINE_SCENARIO_HEADER`.
+
+```ts
+import { DEFINITELY_FINE_SCENARIO_HEADER } from "@definitely-fine/nextjs";
+
+const headers = {
+  [DEFINITELY_FINE_SCENARIO_HEADER]: "scenario-id",
+};
+```
+
+## Typical Setup
+
+1. Create and save a scenario with `definitely-fine`.
+2. Wrap the relevant Next.js route handlers or server actions with this package.
+3. Send the scenario id in the request header.
+4. Let your core runtime wrappers decide which calls are intercepted.
+
+For safety, production apps should normally disable the core runtime with `enabled: false` and optionally skip these wrappers entirely.
+
+## With Playwright
+
+This package pairs naturally with [`@definitely-fine/playwright`](../playwright/README.md), which can create browser contexts that already include the scenario header.

package/dist/index.d.ts

@@ -0,0 +1,64 @@
+//#region src/index.d.ts
+/**
+ * Header name used to carry the active definitely-fine scenario id.
+ * @public
+ */
+declare const DEFINITELY_FINE_SCENARIO_HEADER = "x-definitely-fine-scenario-id";
+/**
+ * Returns the raw definitely-fine scenario header value from a `Headers` object.
+ * @public
+ *
+ * @example
+ * ```ts
+ * const scenarioId = getScenarioIdFromHeaders(
+ *   new Headers([[DEFINITELY_FINE_SCENARIO_HEADER, "checkout"]]),
+ * );
+ * ```
+ */
+declare function getScenarioIdFromHeaders(headers: Headers): string | undefined;
+/**
+ * Returns the raw definitely-fine scenario header value from a `Request`.
+ * @public
+ *
+ * @example
+ * ```ts
+ * const scenarioId = getScenarioIdFromRequest(
+ *   new Request("https://example.test", {
+ *     headers: {
+ *       [DEFINITELY_FINE_SCENARIO_HEADER]: "checkout",
+ *     },
+ *   }),
+ * );
+ * ```
+ */
+declare function getScenarioIdFromRequest(request: Request): string | undefined;
+/**
+ * Wraps a Next.js route handler so it runs inside definitely-fine scenario context.
+ * @public
+ *
+ * @example
+ * ```ts
+ * const handler = withDefinitelyFineScenario(async (request, context) => {
+ *   return Response.json({ ok: true, params: context.params });
+ * });
+ * ```
+ */
+declare function withDefinitelyFineScenario<TContext, TResult>(handler: (request: Request, context: TContext) => TResult): (request: Request, context: TContext) => TResult;
+/**
+ * Wraps a Next.js server action so it runs inside definitely-fine scenario context.
+ * @public
+ *
+ * @example
+ * ```ts
+ * const submitOrder = withDefinitelyFineServerAction(async (formData: FormData) => {
+ *   return { ok: formData.has("orderId") };
+ * });
+ * ```
+ */
+declare function withDefinitelyFineServerAction<TArgs extends unknown[], TResult>(action: (...args: TArgs) => TResult): (...args: TArgs) => Promise<Awaited<TResult>>;
+
+//#endregion
+//# sourceMappingURL=index.d.ts.map
+
+export { DEFINITELY_FINE_SCENARIO_HEADER, getScenarioIdFromHeaders, getScenarioIdFromRequest, withDefinitelyFineScenario, withDefinitelyFineServerAction };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"sourcesContent":null,"mappings":";;;;;cAMa,+BAAA;AAAb;;;;;;;;;;;iBAagB,wBAAA,UAAkC;AAAlD;;;;;;;;;;;;;;;iBAmBgB,wBAAA,UAAkC;AAAlD;;;;;;;;;;;iBAegB,iEACK,kBAAkB,aAAa,oBACvC,kBAAkB,aAAa;AAF5C;;;;;;;;AAEmD;;;iBA4BnC,mFAII,UAAU,oBACjB,UAAU,QAAQ,QAAQ"}

package/dist/index.js

@@ -0,0 +1,86 @@
+import { runWithRuntimeScenarioContext } from "definitely-fine";
+
+//#region src/index.ts
+/**
+* Header name used to carry the active definitely-fine scenario id.
+* @public
+*/
+const DEFINITELY_FINE_SCENARIO_HEADER = "x-definitely-fine-scenario-id";
+/**
+* Returns the raw definitely-fine scenario header value from a `Headers` object.
+* @public
+*
+* @example
+* ```ts
+* const scenarioId = getScenarioIdFromHeaders(
+*   new Headers([[DEFINITELY_FINE_SCENARIO_HEADER, "checkout"]]),
+* );
+* ```
+*/
+function getScenarioIdFromHeaders(headers) {
+	return headers.get(DEFINITELY_FINE_SCENARIO_HEADER) ?? void 0;
+}
+/**
+* Returns the raw definitely-fine scenario header value from a `Request`.
+* @public
+*
+* @example
+* ```ts
+* const scenarioId = getScenarioIdFromRequest(
+*   new Request("https://example.test", {
+*     headers: {
+*       [DEFINITELY_FINE_SCENARIO_HEADER]: "checkout",
+*     },
+*   }),
+* );
+* ```
+*/
+function getScenarioIdFromRequest(request) {
+	return getScenarioIdFromHeaders(request.headers);
+}
+/**
+* Wraps a Next.js route handler so it runs inside definitely-fine scenario context.
+* @public
+*
+* @example
+* ```ts
+* const handler = withDefinitelyFineScenario(async (request, context) => {
+*   return Response.json({ ok: true, params: context.params });
+* });
+* ```
+*/
+function withDefinitelyFineScenario(handler) {
+	return function definitelyFineRouteHandler(request, context) {
+		const scenarioId = getScenarioIdFromRequest(request);
+		if (scenarioId === void 0) return handler(request, context);
+		return runWithRuntimeScenarioContext({ scenarioId }, () => {
+			return handler(request, context);
+		});
+	};
+}
+/**
+* Wraps a Next.js server action so it runs inside definitely-fine scenario context.
+* @public
+*
+* @example
+* ```ts
+* const submitOrder = withDefinitelyFineServerAction(async (formData: FormData) => {
+*   return { ok: formData.has("orderId") };
+* });
+* ```
+*/
+function withDefinitelyFineServerAction(action) {
+	return async function definitelyFineServerAction(...args) {
+		const { headers } = await import("next/headers");
+		const requestHeaders = await headers();
+		const scenarioId = getScenarioIdFromHeaders(requestHeaders);
+		if (scenarioId === void 0) return await action(...args);
+		return await runWithRuntimeScenarioContext({ scenarioId }, async () => {
+			return await action(...args);
+		});
+	};
+}
+
+//#endregion
+export { DEFINITELY_FINE_SCENARIO_HEADER, getScenarioIdFromHeaders, getScenarioIdFromRequest, withDefinitelyFineScenario, withDefinitelyFineServerAction };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["headers: Headers","request: Request","handler: (request: Request, context: TContext) => TResult","context: TContext","action: (...args: TArgs) => TResult"],"sources":["../src/index.ts"],"sourcesContent":["import { runWithRuntimeScenarioContext } from \"definitely-fine\";\n\n/**\n * Header name used to carry the active definitely-fine scenario id.\n * @public\n */\nexport const DEFINITELY_FINE_SCENARIO_HEADER = \"x-definitely-fine-scenario-id\";\n\n/**\n * Returns the raw definitely-fine scenario header value from a `Headers` object.\n * @public\n *\n * @example\n * ```ts\n * const scenarioId = getScenarioIdFromHeaders(\n *   new Headers([[DEFINITELY_FINE_SCENARIO_HEADER, \"checkout\"]]),\n * );\n * ```\n */\nexport function getScenarioIdFromHeaders(headers: Headers): string | undefined {\n  return headers.get(DEFINITELY_FINE_SCENARIO_HEADER) ?? undefined;\n}\n\n/**\n * Returns the raw definitely-fine scenario header value from a `Request`.\n * @public\n *\n * @example\n * ```ts\n * const scenarioId = getScenarioIdFromRequest(\n *   new Request(\"https://example.test\", {\n *     headers: {\n *       [DEFINITELY_FINE_SCENARIO_HEADER]: \"checkout\",\n *     },\n *   }),\n * );\n * ```\n */\nexport function getScenarioIdFromRequest(request: Request): string | undefined {\n  return getScenarioIdFromHeaders(request.headers);\n}\n\n/**\n * Wraps a Next.js route handler so it runs inside definitely-fine scenario context.\n * @public\n *\n * @example\n * ```ts\n * const handler = withDefinitelyFineScenario(async (request, context) => {\n *   return Response.json({ ok: true, params: context.params });\n * });\n * ```\n */\nexport function withDefinitelyFineScenario<TContext, TResult>(\n  handler: (request: Request, context: TContext) => TResult,\n): (request: Request, context: TContext) => TResult {\n  return function definitelyFineRouteHandler(\n    request: Request,\n    context: TContext,\n  ): TResult {\n    const scenarioId = getScenarioIdFromRequest(request);\n\n    if (scenarioId === undefined) {\n      return handler(request, context);\n    }\n\n    return runWithRuntimeScenarioContext({ scenarioId }, () => {\n      return handler(request, context);\n    });\n  };\n}\n\n/**\n * Wraps a Next.js server action so it runs inside definitely-fine scenario context.\n * @public\n *\n * @example\n * ```ts\n * const submitOrder = withDefinitelyFineServerAction(async (formData: FormData) => {\n *   return { ok: formData.has(\"orderId\") };\n * });\n * ```\n */\nexport function withDefinitelyFineServerAction<\n  TArgs extends unknown[],\n  TResult,\n>(\n  action: (...args: TArgs) => TResult,\n): (...args: TArgs) => Promise<Awaited<TResult>> {\n  return async function definitelyFineServerAction(\n    ...args: TArgs\n  ): Promise<Awaited<TResult>> {\n    const { headers } = await import(\"next/headers\");\n    const requestHeaders = await headers();\n    const scenarioId = getScenarioIdFromHeaders(requestHeaders);\n\n    if (scenarioId === undefined) {\n      return await action(...args);\n    }\n\n    return await runWithRuntimeScenarioContext({ scenarioId }, async () => {\n      return await action(...args);\n    });\n  };\n}\n"],"mappings":";;;;;;;AAMA,MAAa,kCAAkC;;;;;;;;;;;;AAa/C,SAAgB,yBAAyBA,SAAsC;AAC7E,QAAO,QAAQ,IAAI,gCAAgC;AACpD;;;;;;;;;;;;;;;;AAiBD,SAAgB,yBAAyBC,SAAsC;AAC7E,QAAO,yBAAyB,QAAQ,QAAQ;AACjD;;;;;;;;;;;;AAaD,SAAgB,2BACdC,SACkD;AAClD,QAAO,SAAS,2BACdD,SACAE,SACS;EACT,MAAM,aAAa,yBAAyB,QAAQ;AAEpD,MAAI,sBACF,QAAO,QAAQ,SAAS,QAAQ;AAGlC,SAAO,8BAA8B,EAAE,WAAY,GAAE,MAAM;AACzD,UAAO,QAAQ,SAAS,QAAQ;EACjC,EAAC;CACH;AACF;;;;;;;;;;;;AAaD,SAAgB,+BAIdC,QAC+C;AAC/C,QAAO,eAAe,2BACpB,GAAG,MACwB;EAC3B,MAAM,EAAE,SAAS,GAAG,MAAM,OAAO;EACjC,MAAM,iBAAiB,MAAM,SAAS;EACtC,MAAM,aAAa,yBAAyB,eAAe;AAE3D,MAAI,sBACF,QAAO,MAAM,OAAO,GAAG,KAAK;AAG9B,SAAO,MAAM,8BAA8B,EAAE,WAAY,GAAE,YAAY;AACrE,UAAO,MAAM,OAAO,GAAG,KAAK;EAC7B,EAAC;CACH;AACF"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@definitely-fine/nextjs",
+  "version": "0.1.0",
+  "description": "Next.js adapter for definitely-fine.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "dependencies": {
+    "definitely-fine": "0.1.0"
+  },
+  "devDependencies": {
+    "next": "^16.0.0"
+  },
+  "peerDependencies": {
+    "next": ">=16"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown src/index.ts --format esm --dts --publint",
+    "typecheck": "tsc --project tsconfig.json"
+  }
+}