@fragno-dev/core 0.1.11 → 0.2.0

package/src/api/request-input-context.test.ts

@@ -292,6 +292,29 @@ describe("RequestContext", () => {
       );
     });
 
+    test("Should throw error when trying to validate ReadableStream", async () => {
+      const stream = new ReadableStream<Uint8Array>({
+        start(controller) {
+          controller.enqueue(new TextEncoder().encode("stream body"));
+          controller.close();
+        },
+      });
+
+      const ctx = new RequestInputContext({
+        path: "/test",
+        pathParams: {},
+        searchParams: new URLSearchParams(),
+        headers: new Headers(),
+        parsedBody: stream,
+        inputSchema: validStringSchema,
+        method: "POST",
+      });
+
+      await expect(ctx.input.valid()).rejects.toThrow(
+        "Schema validation is only supported for JSON data, not FormData, Blob, or ReadableStream",
+      );
+    });
+
     test("Should handle null body", async () => {
       const ctx = new RequestInputContext({
         path: "/test",
@@ -493,4 +516,133 @@ describe("RequestContext", () => {
       expect(ctx.query.get("ssr")).toBe("true");
     });
   });
+
+  describe("FormData handling", () => {
+    test("formData() should return FormData when body is FormData", () => {
+      const formData = new FormData();
+      formData.append("file", new Blob(["test"]), "test.txt");
+      formData.append("description", "A test file");
+
+      const ctx = new RequestInputContext({
+        path: "/upload",
+        pathParams: {},
+        searchParams: new URLSearchParams(),
+        headers: new Headers(),
+        parsedBody: formData,
+        method: "POST",
+      });
+
+      const result = ctx.formData();
+      expect(result).toBe(formData);
+      expect(result.get("description")).toBe("A test file");
+    });
+
+    test("formData() should throw when body is not FormData", () => {
+      const ctx = new RequestInputContext({
+        path: "/upload",
+        pathParams: {},
+        searchParams: new URLSearchParams(),
+        headers: new Headers(),
+        parsedBody: { key: "value" },
+        method: "POST",
+      });
+
+      expect(() => ctx.formData()).toThrow(
+        "Request body is not FormData. Ensure the request was sent with Content-Type: multipart/form-data.",
+      );
+    });
+
+    test("formData() should throw when body is undefined", () => {
+      const ctx = new RequestInputContext({
+        path: "/upload",
+        pathParams: {},
+        searchParams: new URLSearchParams(),
+        headers: new Headers(),
+        parsedBody: undefined,
+        method: "POST",
+      });
+
+      expect(() => ctx.formData()).toThrow(
+        "Request body is not FormData. Ensure the request was sent with Content-Type: multipart/form-data.",
+      );
+    });
+
+    test("isFormData() should return true when body is FormData", () => {
+      const formData = new FormData();
+      formData.append("key", "value");
+
+      const ctx = new RequestInputContext({
+        path: "/upload",
+        pathParams: {},
+        searchParams: new URLSearchParams(),
+        headers: new Headers(),
+        parsedBody: formData,
+        method: "POST",
+      });
+
+      expect(ctx.isFormData()).toBe(true);
+    });
+
+    test("isFormData() should return false when body is JSON", () => {
+      const ctx = new RequestInputContext({
+        path: "/upload",
+        pathParams: {},
+        searchParams: new URLSearchParams(),
+        headers: new Headers(),
+        parsedBody: { key: "value" },
+        method: "POST",
+      });
+
+      expect(ctx.isFormData()).toBe(false);
+    });
+
+    test("isFormData() should return false when body is undefined", () => {
+      const ctx = new RequestInputContext({
+        path: "/upload",
+        pathParams: {},
+        searchParams: new URLSearchParams(),
+        headers: new Headers(),
+        parsedBody: undefined,
+        method: "POST",
+      });
+
+      expect(ctx.isFormData()).toBe(false);
+    });
+
+    test("isFormData() should return false when body is Blob", () => {
+      const blob = new Blob(["test content"], { type: "text/plain" });
+
+      const ctx = new RequestInputContext({
+        path: "/upload",
+        pathParams: {},
+        searchParams: new URLSearchParams(),
+        headers: new Headers(),
+        parsedBody: blob,
+        method: "POST",
+      });
+
+      expect(ctx.isFormData()).toBe(false);
+    });
+
+    test("Can use isFormData() to conditionally access formData()", () => {
+      const formData = new FormData();
+      formData.append("file", new Blob(["test"]), "test.txt");
+
+      const ctx = new RequestInputContext({
+        path: "/upload",
+        pathParams: {},
+        searchParams: new URLSearchParams(),
+        headers: new Headers(),
+        parsedBody: formData,
+        method: "POST",
+      });
+
+      if (ctx.isFormData()) {
+        const result = ctx.formData();
+        expect(result.get("file")).toBeInstanceOf(Blob);
+      } else {
+        expect.fail("Should have detected FormData");
+      }
+    });
+  });
 });

package/src/api/request-input-context.ts

@@ -7,6 +7,7 @@ export type RequestBodyType =
   | unknown // JSON
   | FormData
   | Blob
+  | ReadableStream<Uint8Array>
   | null
   | undefined;
 
@@ -153,6 +154,84 @@ export class RequestInputContext<
     return this.#body;
   }
 
+  /**
+   * Access the request body as FormData.
+   *
+   * Use this method when handling file uploads or multipart form submissions.
+   * The request must have been sent with Content-Type: multipart/form-data.
+   *
+   * @throws Error if the request body is not FormData
+   *
+   * @example
+   * ```typescript
+   * defineRoute({
+   *   method: "POST",
+   *   path: "/upload",
+   *   async handler(ctx, res) {
+   *     const formData = ctx.formData();
+   *     const file = formData.get("file") as File;
+   *     const description = formData.get("description") as string;
+   *     // ... process file
+   *   }
+   * });
+   * ```
+   */
+  formData(): FormData {
+    if (!(this.#parsedBody instanceof FormData)) {
+      throw new Error(
+        "Request body is not FormData. Ensure the request was sent with Content-Type: multipart/form-data.",
+      );
+    }
+    return this.#parsedBody;
+  }
+
+  /**
+   * Check if the request body is FormData.
+   *
+   * Useful for routes that accept both JSON and FormData payloads.
+   *
+   * @example
+   * ```typescript
+   * defineRoute({
+   *   method: "POST",
+   *   path: "/upload",
+   *   async handler(ctx, res) {
+   *     if (ctx.isFormData()) {
+   *       const formData = ctx.formData();
+   *       // handle file upload
+   *     } else {
+   *       const json = await ctx.input.valid();
+   *       // handle JSON payload
+   *     }
+   *   }
+   * });
+   * ```
+   */
+  isFormData(): boolean {
+    return this.#parsedBody instanceof FormData;
+  }
+
+  /**
+   * Access the request body as a ReadableStream (application/octet-stream).
+   *
+   * @throws Error if the request body is not a ReadableStream
+   */
+  bodyStream(): ReadableStream<Uint8Array> {
+    if (!(this.#parsedBody instanceof ReadableStream)) {
+      throw new Error(
+        "Request body is not a ReadableStream. Ensure the request was sent with Content-Type: application/octet-stream.",
+      );
+    }
+    return this.#parsedBody;
+  }
+
+  /**
+   * Check if the request body is a ReadableStream.
+   */
+  isBodyStream(): boolean {
+    return this.#parsedBody instanceof ReadableStream;
+  }
+
   /**
    * Input validation context (only if inputSchema is defined)
    * @remarks `InputContext`
@@ -197,6 +276,12 @@ export class RequestInputContext<
       throw new Error("Schema validation is only supported for JSON data, not FormData or Blob");
     }
 
+    if (this.#parsedBody instanceof ReadableStream) {
+      throw new Error(
+        "Schema validation is only supported for JSON data, not FormData, Blob, or ReadableStream",
+      );
+    }
+
     const result = await this.#inputSchema["~standard"].validate(this.#parsedBody);
 
     if (result.issues) {

package/src/api/request-middleware.test.ts

@@ -1,7 +1,7 @@
 import { test, expect, describe, expectTypeOf } from "vitest";
 import { defineFragment } from "./fragment-definition-builder";
 import { instantiate } from "./fragment-instantiator";
-import { defineRoute } from "./route";
+import { defineRoute, defineRoutes } from "./route";
 import { z } from "zod";
 import { FragnoApiValidationError } from "./error";
 
@@ -276,6 +276,52 @@ describe("Request Middleware", () => {
     expect(middlewareCalled).toBe(true);
   });
 
+  test("ifMatchesRoute - supports internal linked fragment routes", async () => {
+    const config = {};
+
+    const internalDef = defineFragment("internal").build();
+    const internalRoutes = defineRoutes(internalDef).create(({ defineRoute }) => [
+      defineRoute({
+        method: "GET",
+        path: "/status",
+        handler: async (_input, { json }) => {
+          return json({ ok: true });
+        },
+      }),
+    ]);
+
+    const definition = defineFragment<typeof config>("test-lib")
+      .withLinkedFragment("_fragno_internal", ({ config, options }) => {
+        return instantiate(internalDef)
+          .withConfig(config)
+          .withOptions(options)
+          .withRoutes([internalRoutes])
+          .build();
+      })
+      .build();
+
+    const instance = instantiate(definition)
+      .withConfig(config)
+      .withOptions({
+        mountRoute: "/api",
+      })
+      .build()
+      .withMiddleware(async ({ ifMatchesRoute }) => {
+        return await ifMatchesRoute("GET", "/_internal/status", async ({ path }, { json }) => {
+          expectTypeOf(path).toEqualTypeOf<"/_internal/status">();
+          return json({ ok: false }, 418);
+        });
+      });
+
+    const req = new Request("http://localhost/api/_internal/status", {
+      method: "GET",
+    });
+
+    const res = await instance.handler(req);
+    expect(res.status).toBe(418);
+    expect(await res.json()).toEqual({ ok: false });
+  });
+
   test("only one middleware is supported", async () => {
     const config = {};
 

package/src/api/request-middleware.ts

@@ -113,7 +113,7 @@ export class RequestMiddlewareInputContext<const TRoutes extends readonly AnyFra
   // Defined as a field so that `this` reference stays in tact when destructuring
   ifMatchesRoute = async <
     const TMethod extends HTTPMethod,
-    const TPath extends ExtractRoutePath<TRoutes>,
+    const TPath extends ExtractRoutePath<TRoutes, TMethod>,
     const TRoute extends ExtractRouteByPath<TRoutes, TPath, TMethod> = ExtractRouteByPath<
       TRoutes,
       TPath,

package/src/api/route.ts

@@ -182,18 +182,19 @@ export type AnyFragmentDefinition = FragmentDefinition<
   any,
   any,
   any,
+  any,
   any
 >;
 
 // Extract config from FragmentDefinition
 export type ExtractFragmentConfig<T> =
-  T extends FragmentDefinition<infer TConfig, any, any, any, any, any, any, any, any, any>
+  T extends FragmentDefinition<infer TConfig, any, any, any, any, any, any, any, any, any, any>
     ? TConfig
     : never;
 
 // Extract deps from FragmentDefinition
 export type ExtractFragmentDeps<T> =
-  T extends FragmentDefinition<any, any, infer TDeps, any, any, any, any, any, any, any>
+  T extends FragmentDefinition<any, any, infer TDeps, any, any, any, any, any, any, any, any>
     ? TDeps
     : never;
 
@@ -211,6 +212,7 @@ export type ExtractFragmentServices<T> =
     any,
     any,
     any,
+    any,
     any
   >
     ? BoundServices<TBaseServices & TServices>
@@ -228,6 +230,7 @@ export type ExtractFragmentServiceDeps<T> =
     any,
     any,
     any,
+    any,
     any
   >
     ? TServiceDependencies
@@ -245,6 +248,7 @@ export type ExtractFragmentServiceThisContext<T> =
     any,
     infer TServiceThisContext,
     any,
+    any,
     any
   >
     ? TServiceThisContext
@@ -262,6 +266,7 @@ export type ExtractFragmentHandlerThisContext<T> =
     any,
     any,
     infer THandlerThisContext,
+    any,
     any
   >
     ? THandlerThisContext

package/src/client/client.test.ts

@@ -111,6 +111,59 @@ describe("getCacheKey", () => {
   });
 });
 
+describe("FormData utilities", () => {
+  // These tests verify the internal FormData handling behavior
+
+  test("prepareRequestBody should JSON-stringify regular objects", () => {
+    // We can't test internal functions directly, but we can test through the mutator behavior
+    // This is a placeholder to document expected behavior
+    const body = { name: "test", value: 123 };
+    expect(JSON.stringify(body)).toBe('{"name":"test","value":123}');
+  });
+
+  test("FormData should be detected correctly", () => {
+    const formData = new FormData();
+    formData.append("file", new Blob(["test"]), "test.txt");
+
+    expect(formData instanceof FormData).toBe(true);
+    expect({} instanceof FormData).toBe(false);
+    // Note: null instanceof X is a TS error, so we test with a nullable variable
+    const nullValue: unknown = null;
+    expect(nullValue instanceof FormData).toBe(false);
+  });
+
+  test("File and Blob should be detected correctly", () => {
+    const file = new File(["content"], "test.txt", { type: "text/plain" });
+    const blob = new Blob(["content"], { type: "text/plain" });
+
+    expect(file instanceof File).toBe(true);
+    expect(file instanceof Blob).toBe(true);
+    expect(blob instanceof Blob).toBe(true);
+    expect(blob instanceof File).toBe(false);
+  });
+
+  test("toFormData should convert object with files to FormData", () => {
+    const file = new File(["content"], "test.txt", { type: "text/plain" });
+    const formData = new FormData();
+    formData.append("file", file, file.name);
+    formData.append("description", "A test file");
+
+    expect(formData.get("file")).toBeInstanceOf(File);
+    expect(formData.get("description")).toBe("A test file");
+  });
+
+  test("FormData can contain multiple files", () => {
+    const file1 = new File(["content1"], "test1.txt", { type: "text/plain" });
+    const file2 = new File(["content2"], "test2.txt", { type: "text/plain" });
+    const formData = new FormData();
+    formData.append("files", file1, file1.name);
+    formData.append("files", file2, file2.name);
+
+    const files = formData.getAll("files");
+    expect(files).toHaveLength(2);
+  });
+});
+
 describe("invalidation", () => {
   const testFragment = defineFragment("test-fragment").build();
   const testRoutes = [
@@ -1271,6 +1324,99 @@ describe("createMutator", () => {
 
     expect(result).toBeUndefined();
   });
+
+  test("should send octet-stream body without wrapping", async () => {
+    const testFragment = defineFragment("test-fragment").build();
+    const testRoutes = [
+      defineRoute({
+        method: "PUT",
+        path: "/upload",
+        contentType: "application/octet-stream",
+        inputSchema: z.unknown(),
+        handler: async (_ctx, { empty }) => empty(),
+      }),
+    ] as const;
+
+    vi.mocked(global.fetch).mockImplementation(async () => {
+      return new Response(null, { status: 204 });
+    });
+
+    const cb = createClientBuilder(testFragment, clientConfig, testRoutes);
+    const upload = cb.createMutator("PUT", "/upload");
+    const body = new Uint8Array([1, 2, 3, 4]);
+
+    await upload.mutateQuery({ body });
+
+    const [_url, options] = vi.mocked(global.fetch).mock.calls[0];
+    const headers = options?.headers as Record<string, string> | undefined;
+
+    expect(headers?.["Content-Type"]).toBe("application/octet-stream");
+    expect(options?.body).toBe(body);
+  });
+
+  test("should send ReadableStream body with duplex for octet-stream", async () => {
+    const testFragment = defineFragment("test-fragment").build();
+    const testRoutes = [
+      defineRoute({
+        method: "PUT",
+        path: "/upload",
+        contentType: "application/octet-stream",
+        inputSchema: z.unknown(),
+        handler: async (_ctx, { empty }) => empty(),
+      }),
+    ] as const;
+
+    let capturedOptions: (RequestInit & { duplex?: "half" }) | undefined;
+    let capturedBodyText = "";
+
+    vi.mocked(global.fetch).mockImplementation(async (_url, options) => {
+      capturedOptions = options as RequestInit & { duplex?: "half" };
+      const body = capturedOptions?.body;
+
+      if (!(body instanceof ReadableStream)) {
+        throw new Error("Expected ReadableStream body");
+      }
+
+      const reader = body.getReader();
+      const chunks: Uint8Array[] = [];
+      while (true) {
+        const { done, value } = await reader.read();
+        if (done) {
+          break;
+        }
+        if (value) {
+          chunks.push(value);
+        }
+      }
+
+      const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
+      const combined = new Uint8Array(totalLength);
+      let offset = 0;
+      for (const chunk of chunks) {
+        combined.set(chunk, offset);
+        offset += chunk.length;
+      }
+      capturedBodyText = new TextDecoder().decode(combined);
+
+      return new Response(null, { status: 204 });
+    });
+
+    const cb = createClientBuilder(testFragment, clientConfig, testRoutes);
+    const upload = cb.createMutator("PUT", "/upload");
+    const body = new ReadableStream<Uint8Array>({
+      start(controller) {
+        controller.enqueue(new TextEncoder().encode("streamed body"));
+        controller.close();
+      },
+    });
+
+    await upload.mutateQuery({ body });
+
+    const headers = capturedOptions?.headers as Record<string, string> | undefined;
+    expect(headers?.["Content-Type"]).toBe("application/octet-stream");
+    expect(capturedOptions?.duplex).toBe("half");
+    expect(capturedBodyText).toBe("streamed body");
+  });
 });
 
 describe("createMutator - streaming", () => {
@@ -1997,6 +2143,55 @@ describe("Custom Fetcher Configuration", () => {
     expect(url4).toBe("http://localhost:3000/api/test-fragment/users/456?include=posts");
   });
 
+  test("public mountRoute is used for hooks", async () => {
+    let capturedUrl: string | undefined;
+
+    (global.fetch as ReturnType<typeof vi.fn>).mockImplementation(async (url) => {
+      capturedUrl = String(url);
+      return {
+        headers: new Headers(),
+        ok: true,
+        json: async () => [{ id: 1, name: "John" }],
+      } as Response;
+    });
+
+    const client = createClientBuilder(
+      testFragment,
+      { ...clientConfig, mountRoute: "/api/uploads-direct" },
+      testRoutes,
+    );
+
+    const useUsers = client.createHook("/users");
+    await useUsers.query();
+
+    expect(capturedUrl).toBe("http://localhost:3000/api/uploads-direct/users");
+  });
+
+  test("public mountRoute is used for mutators", async () => {
+    let capturedUrl: string | undefined;
+
+    (global.fetch as ReturnType<typeof vi.fn>).mockImplementation(async (url) => {
+      capturedUrl = String(url);
+      return {
+        headers: new Headers(),
+        ok: true,
+        status: 200,
+        json: async () => ({ id: 2, name: "Jane" }),
+      } as Response;
+    });
+
+    const client = createClientBuilder(
+      testFragment,
+      { ...clientConfig, mountRoute: "/api/uploads-proxy" },
+      testRoutes,
+    );
+
+    const mutator = client.createMutator("POST", "/users");
+    await mutator.mutateQuery({ body: { name: "Jane" } });
+
+    expect(capturedUrl).toBe("http://localhost:3000/api/uploads-proxy/users");
+  });
+
   test("getFetcher returns correct fetcher and options", () => {
     const customFetch = vi.fn() as unknown as typeof fetch;
     const client = createClientBuilder(