Request Bodies

Request body factories control how outgoing request bodies are serialized and which Content-Type header is sent. They are separate from response parsing (response classes control Accept and how the response body is parsed).

How It Works

When you call send(), BaseRequest uses the request body factory to build a BodyContract:

• getRequestBodyFactory() returns a BodyFactoryContract
• BodyFactoryContract.make() returns a BodyContract
• BodyContract.getHeaders() provides headers (like Content-Type)
• BodyContract.getContent() provides the serialized body

If you call setBody(...) without providing a body factory, the body is not sent.

JSON Bodies

Use JsonBodyFactory to send JSON and set Content-Type: application/json:

import { BaseRequest, JsonBodyFactory, RequestMethodEnum } from '@blueprint-ts/core/requests'

class CreateExpenseRequest extends BaseRequest<boolean, GenericResponseErrorInterface, ExpenseResource, JsonResponse<ExpenseResource>, CreateExpensePayload> {
    public method(): RequestMethodEnum {
        return RequestMethodEnum.POST
    }

    public url(): string {
        return '/api/v1/expenses'
    }

    public getResponse(): JsonResponse<ExpenseResource> {
        return new JsonResponse<ExpenseResource>()
    }

    public override getRequestBodyFactory() {
        return new JsonBodyFactory<CreateExpensePayload>()
    }
}

If you are using the Laravel integration, JsonBaseRequest already configures the JSON body factory for you.

FormData Bodies

Use FormDataFactory for multipart requests (uploads, mixed fields):

import { FormDataFactory } from '@blueprint-ts/core/requests'

public override getRequestBodyFactory() {
    return new FormDataFactory<FormPayload>()
}

If you want to show upload progress for multipart file uploads, see File Uploads.

Raw Binary Bodies

Use BinaryBodyFactory when the request body should be sent as raw binary instead of multipart form data. This is a better fit for chunk uploads, binary artifact pushes, and endpoints that expect the request body as-is:

import { BinaryBodyFactory } from '@blueprint-ts/core/requests'

public override getRequestBodyFactory() {
    return new BinaryBodyFactory<ArrayBuffer>('application/octet-stream')
}

BinaryBodyFactory supports:

• Blob
• ArrayBuffer
• typed-array and view values such as Uint8Array or DataView

Content-Type resolution works like this:

• If you pass a content type to BinaryBodyFactory, Blueprint sends that Content-Type header.
• Otherwise, if the body is a Blob with a non-empty type, Blueprint uses Blob.type.
• Otherwise, Blueprint does not add a Content-Type header for you.

BinaryBodyFactory works with both FetchDriver and XMLHttpRequestDriver. Choose XMLHttpRequestDriver only when the consuming application needs upload progress events.

Custom Body Factories

You can implement your own body factory by returning a BodyContract with custom headers and serialization logic.