@upflowi/provider-http
v0.2.1
Published
upflowi storage provider for self-hosted / custom backends (your own VPS, an internal API, ...) over a small JSON-over-HTTP convention you implement server-side. No S3/R2 compatibility required.
Maintainers
Readme
@upflowi/provider-http
A StorageProvider for upflowi that targets your own backend — a VPS, an internal API, anything that isn't S3/R2-compatible — over a small JSON-over-HTTP convention you implement server-side. No cloud SDK required on either side.
pnpm add @upflowi/core @upflowi/transport-fetch @upflowi/provider-httpimport { createUploader } from "@upflowi/core";
import { createFetchTransport } from "@upflowi/transport-fetch";
import { createHttpProvider } from "@upflowi/provider-http";
const provider = createHttpProvider({
baseUrl: "https://my-vps.example.com/api",
getHeaders: () => ({ authorization: `Bearer ${getSessionToken()}` }),
});
const uploader = createUploader({
transport: createFetchTransport(),
provider,
});Backend contract
Implement these five routes on your backend — no XML, no cloud SDK, just plain JSON:
POST {baseUrl}/uploads -> { uploadId: string }
PUT {baseUrl}/uploads/{uploadId}/parts/{partNumber} -> { etag: string } (body = raw part bytes)
POST {baseUrl}/uploads/{uploadId}/complete -> { location?: string, etag?: string }
DELETE {baseUrl}/uploads/{uploadId} -> any 2xx
GET {baseUrl}/uploads/{uploadId}/parts -> { parts: Array<{ partNumber, etag, sizeBytes }> }
(404 if the upload is unknown/expired)getHeaders runs before every request, letting you attach a bearer token, session cookie, or any other auth header your backend expects.
Checksums
If you pass a checksum computer to createUploader, this provider sends it via x-upflowi-checksum-algorithm/x-upflowi-checksum-value headers — the encoding is entirely opaque to the SDK and up to your own backend to interpret.
Peer dependency
Requires @upflowi/core as a peer dependency — install both.
Documentation
See the monorepo README for full usage examples and AGENTS.md for the architecture.
