@panorama-industries/effect-vercel-blob 0.0.0 → 0.3.0

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+export * from "./contracts/blob-config.ts";
+export * from "./contracts/blob-domain.ts";
+export * from "./contracts/blob-errors.ts";
+export * from "./contracts/blob-signed-urls.ts";
+export * from "./contracts/blob-store.ts";
+export * from "./contracts/blob-uploads.ts";
+export { type BlobConfigOptions, BlobConfigLive, blobConfigLayer, } from "./implementation/blob-config-live.ts";
+export { storeIdFromDelegationToken } from "./internal/store-id.ts";
+export { downloadUrl } from "./internal/urls.ts";
+export { BlobStoreLive } from "./implementation/blob-store-live.ts";
+export { BlobSignedUrlsLive } from "./implementation/blob-signed-urls-live.ts";
+export { BlobUploadsLive } from "./implementation/blob-uploads-live.ts";
+export { ClientTokenPayload, getPayloadFromClientToken } from "./internal/client-token.ts";
+export { BlobLive, blobLayer, blobLayerConfig } from "./implementation/blob-live.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EACL,KAAK,iBAAiB,EACtB,cAAc,EACd,eAAe,GAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/index.js

@@ -0,0 +1,15 @@
+export * from "./contracts/blob-config.js";
+export * from "./contracts/blob-domain.js";
+export * from "./contracts/blob-errors.js";
+export * from "./contracts/blob-signed-urls.js";
+export * from "./contracts/blob-store.js";
+export * from "./contracts/blob-uploads.js";
+export { BlobConfigLive, blobConfigLayer, } from "./implementation/blob-config-live.js";
+export { storeIdFromDelegationToken } from "./internal/store-id.js";
+export { downloadUrl } from "./internal/urls.js";
+export { BlobStoreLive } from "./implementation/blob-store-live.js";
+export { BlobSignedUrlsLive } from "./implementation/blob-signed-urls-live.js";
+export { BlobUploadsLive } from "./implementation/blob-uploads-live.js";
+export { ClientTokenPayload, getPayloadFromClientToken } from "./internal/client-token.js";
+export { BlobLive, blobLayer, blobLayerConfig } from "./implementation/blob-live.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAEL,cAAc,EACd,eAAe,GAChB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,EAAE,0BAA0B,EAAE,MAAM,wBAAwB,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2CAA2C,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,MAAM,4BAA4B,CAAC;AAC3F,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/internal/blob-errors.d.ts

@@ -0,0 +1,79 @@
+import type { Headers, HttpClientResponse } from "effect/http";
+import { VercelApiError } from "@panorama-industries/effect-vercel-core";
+import { Effect, Option } from "effect";
+import { BlobClientTokenNotAllowed, BlobNotFound, BlobOidcEnvironmentNotAllowed, BlobPreconditionFailed, BlobStoreUnavailable, BlobUploadRejected } from "../contracts/blob-errors.ts";
+/** Every Blob-specific failure an error response can map to. */
+export type BlobDomainError = BlobNotFound | BlobStoreUnavailable | BlobPreconditionFailed | BlobUploadRejected | BlobClientTokenNotAllowed | BlobOidcEnvironmentNotAllowed;
+/** Tag of a {@link BlobDomainError}, used to choose which ones an operation reports. */
+export type BlobDomainErrorTag = BlobDomainError["_tag"];
+/** The domain errors among `K`, plus `VercelApiError` for every other error response. */
+export type BlobApiError<K extends BlobDomainErrorTag = BlobDomainErrorTag> = VercelApiError | Extract<BlobDomainError, {
+    readonly _tag: K;
+}>;
+/** An error response (non-2xx) whose body has been read. */
+export interface BlobErrorResponse {
+    /** Traced operation name stored in `VercelApiError.operation`, such as `BlobStore.put`. */
+    readonly operation: string;
+    readonly status: number;
+    /** The raw response body; JSON `{"error":{"code","message"}}` when the API produced it. */
+    readonly body: string;
+    /** Response headers; `Retry-After` is read from them for `rate_limited`. */
+    readonly headers: Headers.Headers;
+    /** The pathname or URL the call addressed, stored in `BlobNotFound.locator`. */
+    readonly locator: string;
+}
+/** What the SDK's `getBlobError` reads from an error body, after its message-based rewrites. */
+export interface BlobErrorCode {
+    /** The effective code: `unknown_error` when the body had none or was not JSON. */
+    readonly code: string;
+    /** The code exactly as the body sent it, if it sent one. */
+    readonly bodyCode: Option.Option<string>;
+    readonly message: Option.Option<string>;
+}
+/**
+ * Read the error code and message from an error body like the SDK's `getBlobError`, including the
+ * rewrites it applies to codes older API clients cannot receive: a message about a disallowed
+ * `contentType`, a `"pathname"` that does not match the token, `Token expired`, a file length
+ * limit, or OIDC being disabled for an environment selects the matching code.
+ */
+export declare const blobErrorCode: (body: string) => BlobErrorCode;
+/**
+ * The message the store sends with `bad_request`, instead of a dedicated code, when a key does not
+ * exist: the source of a copy or rename, or the blob an `ifMatch` write or delete targets.
+ */
+export declare const missingKeyMessage = "The specified key does not exist.";
+/**
+ * Map an error response to the failure the SDK's `getBlobError` would throw, as a typed error.
+ *
+ * Domain codes become the errors in `contracts/blob-errors.ts`; `forbidden`, `bad_request` and
+ * `rate_limited` become `VercelApiError` with `ApiForbidden`, `ApiBadRequest` and `ApiRateLimited`
+ * (with `Retry-After`) whatever the status; every other code becomes the `VercelApiError` matching
+ * the status (`vercelApiErrorFromStatus`). `VercelApiError.errorCode` is the code the body sent, if
+ * any. A domain code not listed in `domainErrors` is reported as a `VercelApiError` for its status
+ * instead, with that code, so an operation only surfaces the domain errors its contract declares.
+ *
+ * Unlike the SDK, a `bad_request` with {@link missingKeyMessage} becomes `BlobNotFound` for an
+ * operation that reports it (a missing copy or rename source), and `BlobPreconditionFailed`
+ * otherwise (`ifMatch` on a missing blob, which HTTP treats as a failed precondition).
+ *
+ * @param now - Current time in epoch milliseconds, to resolve an HTTP-date `Retry-After`.
+ * @param domainErrors - Domain errors the operation reports; all of them by default.
+ */
+export declare const blobErrorFromResponse: <K extends BlobDomainErrorTag = BlobDomainErrorTag>(response: BlobErrorResponse, now: number, domainErrors?: ReadonlyArray<K>) => BlobApiError<K>;
+/**
+ * Read an error response's body and map it with {@link blobErrorFromResponse}. A body that cannot be
+ * read counts as not JSON (`unknown_error`).
+ */
+export declare const blobErrorFromHttpResponse: <K extends BlobDomainErrorTag = "BlobClientTokenNotAllowed" | "BlobNotFound" | "BlobOidcEnvironmentNotAllowed" | "BlobPreconditionFailed" | "BlobStoreUnavailable" | "BlobUploadRejected">(response: HttpClientResponse.HttpClientResponse, options: {
+    readonly operation: string;
+    readonly locator: string;
+    readonly domainErrors?: ReadonlyArray<K> | undefined;
+}) => Effect.Effect<never, BlobApiError<K>, never>;
+/**
+ * Whether the SDK retries a failed attempt: network failures, and error responses whose body code
+ * is absent (a body that is not JSON counts as `unknown_error`), `unknown_error`,
+ * `service_unavailable` or `internal_server_error`. Never `rate_limited`, a domain error, or any
+ * other code. Use it as `vercelApiTransientRetry({ isRetryable })`.
+ */
+export declare const isRetryableBlobError: (error: unknown) => boolean;
+//# sourceMappingURL=blob-errors.d.ts.map

package/dist/internal/blob-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blob-errors.d.ts","sourceRoot":"","sources":["../../src/internal/blob-errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAE/D,OAAO,EAAE,cAAc,EAA4B,MAAM,yCAAyC,CAAC;AACnG,OAAO,EAAS,MAAM,EAAE,MAAM,EAAqB,MAAM,QAAQ,CAAC;AAElE,OAAO,EACL,yBAAyB,EACzB,YAAY,EACZ,6BAA6B,EAC7B,sBAAsB,EAGtB,oBAAoB,EACpB,kBAAkB,EAKnB,MAAM,6BAA6B,CAAC;AAErC,gEAAgE;AAChE,MAAM,MAAM,eAAe,GACvB,YAAY,GACZ,oBAAoB,GACpB,sBAAsB,GACtB,kBAAkB,GAClB,yBAAyB,GACzB,6BAA6B,CAAC;AAElC,wFAAwF;AACxF,MAAM,MAAM,kBAAkB,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;AAEzD,yFAAyF;AACzF,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,IACtE,cAAc,GACd,OAAO,CAAC,eAAe,EAAE;IAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC;AAEnD,4DAA4D;AAC5D,MAAM,WAAW,iBAAiB;IAChC,2FAA2F;IAC3F,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IAExB,2FAA2F;IAC3F,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,4EAA4E;IAC5E,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;IAElC,gFAAgF;IAChF,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAeD,gGAAgG;AAChG,MAAM,WAAW,aAAa;IAC5B,kFAAkF;IAClF,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,4DAA4D;IAC5D,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAEzC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;CACzC;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,SAAU,MAAM,KAAG,aA6B5C,CAAC;AAIF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,sCAAsC,CAAC;AAsGrE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,YAC3E,iBAAiB,OACtB,MAAM,iBACI,aAAa,CAAC,CAAC,CAAC,KAC9B,YAAY,CAAC,CAAC,CA6BhB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,yBAAyB,GACpC,CAAC,SAAS,kBAAkB;wBAIN,MAAM;sBACR,MAAM;4BACA,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS;kDAkBtD,CAAC;AAQH;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,UAAW,OAAO,KAAG,OAM/C,CAAC"}

package/dist/internal/blob-errors.js

@@ -0,0 +1,196 @@
+import { VercelApiError, vercelApiErrorFromStatus } from "@panorama-industries/effect-vercel-core";
+import { Clock, Effect, Option, Predicate, Schema } from "effect";
+import { BlobClientTokenNotAllowed, BlobNotFound, BlobOidcEnvironmentNotAllowed, BlobPreconditionFailed, BlobStoreNotFound, BlobStoreSuspended, BlobStoreUnavailable, BlobUploadRejected, ClientTokenExpired, ContentTypeNotAllowed, FileTooLarge, PathnameMismatch, } from "../contracts/blob-errors.js";
+const ErrorBody = Schema.fromJsonString(Schema.Struct({
+    error: Schema.optionalKey(Schema.Struct({
+        code: Schema.optionalKey(Schema.String),
+        message: Schema.optionalKey(Schema.String),
+    })),
+}));
+const decodeErrorBody = Schema.decodeUnknownOption(ErrorBody);
+/**
+ * Read the error code and message from an error body like the SDK's `getBlobError`, including the
+ * rewrites it applies to codes older API clients cannot receive: a message about a disallowed
+ * `contentType`, a `"pathname"` that does not match the token, `Token expired`, a file length
+ * limit, or OIDC being disabled for an environment selects the matching code.
+ */
+export const blobErrorCode = (body) => {
+    const error = Option.flatMap(decodeErrorBody(body), (decoded) => Option.fromUndefinedOr(decoded.error));
+    const bodyCode = Option.flatMap(error, (error) => Option.fromUndefinedOr(error.code));
+    const message = Option.flatMap(error, (error) => Option.fromUndefinedOr(error.message));
+    let code = Option.getOrElse(bodyCode, () => "unknown_error");
+    const text = Option.getOrUndefined(message);
+    if (text !== undefined) {
+        if (text.includes("contentType") && text.includes("is not allowed")) {
+            code = "content_type_not_allowed";
+        }
+        if (text.includes('"pathname"') && text.includes("does not match the token payload")) {
+            code = "client_token_pathname_mismatch";
+        }
+        if (text === "Token expired") {
+            code = "client_token_expired";
+        }
+        if (text.includes("the file length cannot be greater than")) {
+            code = "file_too_large";
+        }
+        if (text.startsWith("OIDC is enabled for this project, but not for the") &&
+            text.includes("environment.")) {
+            code = "oidc_environment_not_allowed";
+        }
+    }
+    return { code, bodyCode, message };
+};
+const unknownErrorMessage = "Unknown error, please visit https://vercel.com/help.";
+/**
+ * The message the store sends with `bad_request`, instead of a dedicated code, when a key does not
+ * exist: the source of a copy or rename, or the blob an `ifMatch` write or delete targets.
+ */
+export const missingKeyMessage = "The specified key does not exist.";
+const domainError = (code, message, locator) => {
+    const text = Option.getOrUndefined(message);
+    switch (code) {
+        case "not_found":
+            return Option.some(new BlobNotFound({ locator }));
+        case "store_not_found":
+            return Option.some(new BlobStoreUnavailable({ reason: new BlobStoreNotFound() }));
+        case "store_suspended":
+            return Option.some(new BlobStoreUnavailable({ reason: new BlobStoreSuspended() }));
+        case "precondition_failed":
+            return Option.some(new BlobPreconditionFailed());
+        case "content_type_not_allowed":
+            return Option.some(new BlobUploadRejected({
+                reason: new ContentTypeNotAllowed({ message: `Content type mismatch, ${text}.` }),
+            }));
+        case "file_too_large":
+            return Option.some(new BlobUploadRejected({
+                reason: new FileTooLarge({ message: `File is too large, ${text}.` }),
+            }));
+        case "client_token_pathname_mismatch":
+            return Option.some(new BlobUploadRejected({
+                reason: new PathnameMismatch({
+                    message: `Pathname mismatch, ${text}. Check the pathname used in upload() or put() ` +
+                        "matches the one from the client token.",
+                }),
+            }));
+        case "client_token_expired":
+            return Option.some(new BlobUploadRejected({ reason: new ClientTokenExpired() }));
+        case "client_token_not_allowed":
+            return Option.some(new BlobClientTokenNotAllowed({
+                message: text ??
+                    "This operation is not available when using a client token. Use a read–write or OIDC token on the server.",
+            }));
+        case "oidc_environment_not_allowed":
+            return Option.some(new BlobOidcEnvironmentNotAllowed({
+                message: text ?? "OIDC is enabled for this project, but not for this token's environment.",
+            }));
+        default:
+            return Option.none();
+    }
+};
+const rateLimitedMessage = (headers) => {
+    const seconds = Number.parseInt(headers["retry-after"] ?? "", 10);
+    return `Too many requests please lower the number of concurrent requests${seconds ? ` - try again in ${seconds} seconds` : ""}.`;
+};
+/**
+ * The status whose `Api*` reason the SDK's error matches, and that reason's message. Codes the SDK
+ * maps regardless of status (`forbidden`, `bad_request`, `rate_limited`) force their status; the
+ * rest keep the response's.
+ */
+const apiReasonFor = (code, response, message) => {
+    const status = response.status;
+    switch (code) {
+        case "forbidden":
+            return {
+                status: 403,
+                message: "Access denied, please provide a valid token for this resource.",
+            };
+        case "bad_request":
+            return { status: 400, message: Option.getOrElse(message, () => "Bad request") };
+        case "rate_limited":
+            return {
+                status: 429,
+                message: rateLimitedMessage(response.headers),
+            };
+        case "service_unavailable":
+            return {
+                status,
+                message: "The blob service is currently not available. Please try again.",
+            };
+        default:
+            return { status, message: Option.getOrElse(message, () => unknownErrorMessage) };
+    }
+};
+/**
+ * Map an error response to the failure the SDK's `getBlobError` would throw, as a typed error.
+ *
+ * Domain codes become the errors in `contracts/blob-errors.ts`; `forbidden`, `bad_request` and
+ * `rate_limited` become `VercelApiError` with `ApiForbidden`, `ApiBadRequest` and `ApiRateLimited`
+ * (with `Retry-After`) whatever the status; every other code becomes the `VercelApiError` matching
+ * the status (`vercelApiErrorFromStatus`). `VercelApiError.errorCode` is the code the body sent, if
+ * any. A domain code not listed in `domainErrors` is reported as a `VercelApiError` for its status
+ * instead, with that code, so an operation only surfaces the domain errors its contract declares.
+ *
+ * Unlike the SDK, a `bad_request` with {@link missingKeyMessage} becomes `BlobNotFound` for an
+ * operation that reports it (a missing copy or rename source), and `BlobPreconditionFailed`
+ * otherwise (`ifMatch` on a missing blob, which HTTP treats as a failed precondition).
+ *
+ * @param now - Current time in epoch milliseconds, to resolve an HTTP-date `Retry-After`.
+ * @param domainErrors - Domain errors the operation reports; all of them by default.
+ */
+export const blobErrorFromResponse = (response, now, domainErrors) => {
+    const { code, bodyCode, message } = blobErrorCode(response.body);
+    const reports = (tag) => domainErrors === undefined || domainErrors.includes(tag);
+    if (code === "bad_request" && Option.getOrUndefined(message) === missingKeyMessage) {
+        if (reports("BlobNotFound")) {
+            return new BlobNotFound({ locator: response.locator });
+        }
+        if (reports("BlobPreconditionFailed")) {
+            return new BlobPreconditionFailed();
+        }
+    }
+    const domain = domainError(code, message, response.locator).pipe(Option.filter((error) => reports(error._tag)));
+    if (Option.isSome(domain)) {
+        return domain.value;
+    }
+    const reason = apiReasonFor(code, response, message);
+    return vercelApiErrorFromStatus({
+        operation: response.operation,
+        status: reason.status,
+        message: reason.message,
+        errorCode: bodyCode,
+        headers: response.headers,
+    }, now);
+};
+/**
+ * Read an error response's body and map it with {@link blobErrorFromResponse}. A body that cannot be
+ * read counts as not JSON (`unknown_error`).
+ */
+export const blobErrorFromHttpResponse = Effect.fnUntraced(function* (response, options) {
+    const body = yield* Effect.orElseSucceed(response.text, () => "");
+    const now = yield* Clock.currentTimeMillis;
+    return yield* Effect.fail(blobErrorFromResponse({
+        operation: options.operation,
+        status: response.status,
+        body,
+        headers: response.headers,
+        locator: options.locator,
+    }, now, options.domainErrors));
+});
+const retryableCodes = new Set([
+    "unknown_error",
+    "service_unavailable",
+    "internal_server_error",
+]);
+/**
+ * Whether the SDK retries a failed attempt: network failures, and error responses whose body code
+ * is absent (a body that is not JSON counts as `unknown_error`), `unknown_error`,
+ * `service_unavailable` or `internal_server_error`. Never `rate_limited`, a domain error, or any
+ * other code. Use it as `vercelApiTransientRetry({ isRetryable })`.
+ */
+export const isRetryableBlobError = (error) => error instanceof VercelApiError &&
+    (Predicate.isTagged(error.reason, "ApiNetworkFailure") ||
+        Option.match(error.errorCode, {
+            onNone: () => true,
+            onSome: (code) => retryableCodes.has(code),
+        }));
+//# sourceMappingURL=blob-errors.js.map

package/dist/internal/blob-errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blob-errors.js","sourceRoot":"","sources":["../../src/internal/blob-errors.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,yCAAyC,CAAC;AACnG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAElE,OAAO,EACL,yBAAyB,EACzB,YAAY,EACZ,6BAA6B,EAC7B,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,kBAAkB,EAClB,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,GACjB,MAAM,6BAA6B,CAAC;AAoCrC,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CACrC,MAAM,CAAC,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;QACvC,OAAO,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;KAC3C,CAAC,CACH;CACF,CAAC,CACH,CAAC;AAEF,MAAM,eAAe,GAAG,MAAM,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;AAa9D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAY,EAAiB,EAAE;IAC3D,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,CAC9D,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,CACtC,CAAC;IACF,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;IACtF,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACxF,IAAI,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACpE,IAAI,GAAG,0BAA0B,CAAC;QACpC,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,kCAAkC,CAAC,EAAE,CAAC;YACrF,IAAI,GAAG,gCAAgC,CAAC;QAC1C,CAAC;QACD,IAAI,IAAI,KAAK,eAAe,EAAE,CAAC;YAC7B,IAAI,GAAG,sBAAsB,CAAC;QAChC,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,wCAAwC,CAAC,EAAE,CAAC;YAC5D,IAAI,GAAG,gBAAgB,CAAC;QAC1B,CAAC;QACD,IACE,IAAI,CAAC,UAAU,CAAC,mDAAmD,CAAC;YACpE,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC,EAC7B,CAAC;YACD,IAAI,GAAG,8BAA8B,CAAC;QACxC,CAAC;IACH,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,sDAAsD,CAAC;AAEnF;;;GAGG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,mCAAmC,CAAC;AAErE,MAAM,WAAW,GAAG,CAClB,IAAY,EACZ,OAA8B,EAC9B,OAAe,EACiB,EAAE;IAClC,MAAM,IAAI,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAC5C,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,WAAW;YACd,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QACpD,KAAK,iBAAiB;YACpB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,EAAE,MAAM,EAAE,IAAI,iBAAiB,EAAE,EAAE,CAAC,CAAC,CAAC;QACpF,KAAK,iBAAiB;YACpB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,EAAE,MAAM,EAAE,IAAI,kBAAkB,EAAE,EAAE,CAAC,CAAC,CAAC;QACrF,KAAK,qBAAqB;YACxB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,sBAAsB,EAAE,CAAC,CAAC;QACnD,KAAK,0BAA0B;YAC7B,OAAO,MAAM,CAAC,IAAI,CAChB,IAAI,kBAAkB,CAAC;gBACrB,MAAM,EAAE,IAAI,qBAAqB,CAAC,EAAE,OAAO,EAAE,0BAA0B,IAAI,GAAG,EAAE,CAAC;aAClF,CAAC,CACH,CAAC;QACJ,KAAK,gBAAgB;YACnB,OAAO,MAAM,CAAC,IAAI,CAChB,IAAI,kBAAkB,CAAC;gBACrB,MAAM,EAAE,IAAI,YAAY,CAAC,EAAE,OAAO,EAAE,sBAAsB,IAAI,GAAG,EAAE,CAAC;aACrE,CAAC,CACH,CAAC;QACJ,KAAK,gCAAgC;YACnC,OAAO,MAAM,CAAC,IAAI,CAChB,IAAI,kBAAkB,CAAC;gBACrB,MAAM,EAAE,IAAI,gBAAgB,CAAC;oBAC3B,OAAO,EACL,sBAAsB,IAAI,iDAAiD;wBAC3E,wCAAwC;iBAC3C,CAAC;aACH,CAAC,CACH,CAAC;QACJ,KAAK,sBAAsB;YACzB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,IAAI,kBAAkB,EAAE,EAAE,CAAC,CAAC,CAAC;QACnF,KAAK,0BAA0B;YAC7B,OAAO,MAAM,CAAC,IAAI,CAChB,IAAI,yBAAyB,CAAC;gBAC5B,OAAO,EACL,IAAI;oBACJ,0GAA0G;aAC7G,CAAC,CACH,CAAC;QACJ,KAAK,8BAA8B;YACjC,OAAO,MAAM,CAAC,IAAI,CAChB,IAAI,6BAA6B,CAAC;gBAChC,OAAO,EACL,IAAI,IAAI,yEAAyE;aACpF,CAAC,CACH,CAAC;QACJ;YACE,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CAAC,OAAwB,EAAU,EAAE;IAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;IAClE,OAAO,mEACL,OAAO,CAAC,CAAC,CAAC,mBAAmB,OAAO,UAAU,CAAC,CAAC,CAAC,EACnD,GAAG,CAAC;AACN,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,YAAY,GAAG,CACnB,IAAY,EACZ,QAA2B,EAC3B,OAA8B,EACyB,EAAE;IACzD,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC/B,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,WAAW;YACd,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,gEAAgE;aAC1E,CAAC;QACJ,KAAK,aAAa;YAChB,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC;QAClF,KAAK,cAAc;YACjB,OAAO;gBACL,MAAM,EAAE,GAAG;gBACX,OAAO,EAAE,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC;aAC9C,CAAC;QACJ,KAAK,qBAAqB;YACxB,OAAO;gBACL,MAAM;gBACN,OAAO,EAAE,gEAAgE;aAC1E,CAAC;QACJ;YACE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,mBAAmB,CAAC,EAAE,CAAC;IACrF,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACnC,QAA2B,EAC3B,GAAW,EACX,YAA+B,EACd,EAAE;IACnB,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACjE,MAAM,OAAO,GAAG,CAAC,GAAuB,EAAE,EAAE,CAC1C,YAAY,KAAK,SAAS,IAAK,YAAsC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACtF,IAAI,IAAI,KAAK,aAAa,IAAI,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,iBAAiB,EAAE,CAAC;QACnF,IAAI,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YAC5B,OAAO,IAAI,YAAY,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAoB,CAAC;QAC5E,CAAC;QACD,IAAI,OAAO,CAAC,wBAAwB,CAAC,EAAE,CAAC;YACtC,OAAO,IAAI,sBAAsB,EAAqB,CAAC;QACzD,CAAC;IACH,CAAC;IACD,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,IAAI,CAC9D,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAC9C,CAAC;IACF,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC,KAAuD,CAAC;IACxE,CAAC;IACD,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrD,OAAO,wBAAwB,CAC7B;QACE,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,SAAS,EAAE,QAAQ;QACnB,OAAO,EAAE,QAAQ,CAAC,OAAO;KAC1B,EACD,GAAG,CACJ,CAAC;AACJ,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAGlE,QAA+C,EAC/C,OAIC;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IAClE,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC;IAC3C,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CACvB,qBAAqB,CACnB;QACE,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,MAAM,EAAE,QAAQ,CAAC,MAAM;QACvB,IAAI;QACJ,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB,EACD,GAAG,EACH,OAAO,CAAC,YAAY,CACrB,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,MAAM,cAAc,GAAwB,IAAI,GAAG,CAAC;IAClD,eAAe;IACf,qBAAqB;IACrB,uBAAuB;CACxB,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAc,EAAW,EAAE,CAC9D,KAAK,YAAY,cAAc;IAC/B,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,mBAAmB,CAAC;QACpD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE;YAC5B,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI;YAClB,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC;SAC3C,CAAC,CAAC,CAAC"}

package/dist/internal/blob-request.d.ts

@@ -0,0 +1,255 @@
+import type { OidcTokenUnavailable, VercelOidc } from "@panorama-industries/effect-vercel-core";
+import type { HttpClientResponse } from "effect/http";
+import { VercelApiError } from "@panorama-industries/effect-vercel-core";
+import { Data, Duration, Effect, Redacted, Schema, Stream } from "effect";
+import { HttpClient } from "effect/http";
+import type { BlobConfig } from "../contracts/blob-config.ts";
+import type { BlobBody, OnUploadProgress, PresignedUrlPayload, UploadProgress } from "../contracts/blob-domain.ts";
+import type { BlobApiError, BlobDomainErrorTag } from "./blob-errors.ts";
+/**
+ * What every request of one component shares; build it once per layer, from `BlobConfig` with
+ * {@link blobRequestSettings} on the server, or from the client options in the browser.
+ */
+export interface BlobRequestSettings {
+    readonly httpClient: HttpClient.HttpClient;
+    /** Blob API base URL; a call's `path` is appended to it after removing trailing slashes. */
+    readonly apiUrl: URL;
+    /** Sent as `x-api-version`. */
+    readonly apiVersion: string;
+    /** Retries after the first attempt; a call whose body is a `Stream` makes one attempt only. */
+    readonly retries: number;
+    /** Send `x-content-length` on every call, not only on calls with upload progress. */
+    readonly sendContentLength: boolean;
+    /** Sent with every call, after the protocol headers and before the call's own headers. */
+    readonly headers: Readonly<Record<string, string>>;
+    /**
+     * Whether `fetch` can stream request bodies; detected with {@link supportsRequestStreams} when
+     * omitted. When false, bodies are sent whole (streams are read into memory first) and upload
+     * progress reports only 0 % and 100 %.
+     */
+    readonly streamRequestBodies?: boolean | undefined;
+}
+/** Settings for server-side services, read from `BlobConfig`. */
+export declare const blobRequestSettings: (config: BlobConfig["Service"], httpClient: HttpClient.HttpClient) => BlobRequestSettings;
+/** How one call authenticates, resolved once per call (before the first attempt). */
+export type BlobRequestAuth = Data.TaggedEnum<{
+    /**
+     * `authorization: Bearer <token>`, for read-write, OIDC and client tokens. `storeId` goes into
+     * `x-vercel-blob-store-id` and the request id.
+     */
+    Bearer: {
+        readonly token: Redacted.Redacted<string>;
+        readonly storeId: string;
+    };
+    /**
+     * No `authorization`; the payload's `params`, `vercel-blob-delegation` and
+     * `vercel-blob-signature` are set on the query. Take `storeId` from the delegation token with
+     * `storeIdFromDelegationToken`.
+     */
+    Presigned: {
+        readonly payload: PresignedUrlPayload;
+        readonly storeId: string;
+    };
+}>;
+/** Constructors and matchers for {@link BlobRequestAuth}. */
+export declare const BlobRequestAuth: {
+    readonly $is: <Tag extends "Bearer" | "Presigned">(tag: Tag) => (u: unknown) => u is Extract<{
+        readonly _tag: "Bearer";
+        readonly token: Redacted.Redacted<string>;
+        readonly storeId: string;
+    }, {
+        readonly _tag: Tag;
+    }> | Extract<{
+        readonly _tag: "Presigned";
+        readonly payload: PresignedUrlPayload;
+        readonly storeId: string;
+    }, {
+        readonly _tag: Tag;
+    }>;
+    readonly $match: {
+        <Cases extends { readonly [Tag in "Bearer" | "Presigned"]: (args: Extract<{
+            readonly _tag: "Bearer";
+            readonly token: Redacted.Redacted<string>;
+            readonly storeId: string;
+        } | {
+            readonly _tag: "Presigned";
+            readonly payload: PresignedUrlPayload;
+            readonly storeId: string;
+        }, {
+            readonly _tag: Tag;
+        }>) => any; }>(cases: Cases): (value: {
+            readonly _tag: "Bearer";
+            readonly token: Redacted.Redacted<string>;
+            readonly storeId: string;
+        } | {
+            readonly _tag: "Presigned";
+            readonly payload: PresignedUrlPayload;
+            readonly storeId: string;
+        }) => import("effect/Unify").Unify<ReturnType<Cases["Bearer" | "Presigned"]>>;
+        <Cases extends { readonly [Tag in "Bearer" | "Presigned"]: (args: Extract<{
+            readonly _tag: "Bearer";
+            readonly token: Redacted.Redacted<string>;
+            readonly storeId: string;
+        } | {
+            readonly _tag: "Presigned";
+            readonly payload: PresignedUrlPayload;
+            readonly storeId: string;
+        }, {
+            readonly _tag: Tag;
+        }>) => any; }>(value: {
+            readonly _tag: "Bearer";
+            readonly token: Redacted.Redacted<string>;
+            readonly storeId: string;
+        } | {
+            readonly _tag: "Presigned";
+            readonly payload: PresignedUrlPayload;
+            readonly storeId: string;
+        }, cases: Cases): import("effect/Unify").Unify<ReturnType<Cases["Bearer" | "Presigned"]>>;
+    };
+    readonly Bearer: Data.TaggedEnum.ConstructorFrom<{
+        readonly _tag: "Bearer";
+        readonly token: Redacted.Redacted<string>;
+        readonly storeId: string;
+    }, "_tag">;
+    readonly Presigned: Data.TaggedEnum.ConstructorFrom<{
+        readonly _tag: "Presigned";
+        readonly payload: PresignedUrlPayload;
+        readonly storeId: string;
+    }, "_tag">;
+};
+/**
+ * The per-call auth of server-side services. `ReadWrite` uses its token. `Oidc` evaluates
+ * `VercelOidc.token` on every call; when it is unavailable and `BlobConfig.readWriteToken` is set,
+ * the call uses that token and its store id instead, as the SDK falls through to
+ * `BLOB_READ_WRITE_TOKEN`. Otherwise it fails with the `OidcTokenUnavailable`.
+ */
+export declare const serverBlobAuth: (config: BlobConfig["Service"], oidc: VercelOidc["Service"]) => Effect.Effect<BlobRequestAuth, OidcTokenUnavailable>;
+/** HTTP methods the Blob API uses. */
+export type BlobRequestMethod = "GET" | "PUT" | "POST" | "DELETE";
+/**
+ * One Blob API call for {@link BlobRequester} `call`.
+ *
+ * @template A - Decoded response body; `void` when `response` is omitted.
+ * @template E - Failure of a `Stream` body, reported as is (not as a network failure).
+ * @template R - Requirements of a `Stream` body.
+ * @template EA - Failure of `auth`, such as `OidcTokenUnavailable`.
+ * @template K - Domain errors the operation reports; other domain codes become `VercelApiError`.
+ */
+export interface BlobApiCall<A, E, R, EA, RA, K extends BlobDomainErrorTag> {
+    /** Traced name, such as `BlobStore.put`; stored in `VercelApiError.operation`. */
+    readonly operation: string;
+    readonly method: BlobRequestMethod;
+    /**
+     * Path and query appended to the API URL exactly as the SDK appends it: `/?pathname=…` for put,
+     * `?url=…` (no slash) for head, `?limit…` for list, `/delete`, `/mpu?pathname=…`. Build queries
+     * with `URLSearchParams` so they are encoded like the SDK's.
+     */
+    readonly path: string;
+    readonly auth: Effect.Effect<BlobRequestAuth, EA, RA>;
+    /** Decodes the JSON response body (see `internal/wire.ts`); omit to ignore the body. */
+    readonly response?: Schema.Decoder<A> | undefined;
+    /** Sent last, so they override every other header (including `authorization`). */
+    readonly headers?: Readonly<Record<string, string>> | undefined;
+    /** Raw request body. Strings, bytes and `Blob`s are resent on retries; streams are not. */
+    readonly body?: BlobBody<E, R> | undefined;
+    /**
+     * A JSON request body, sent as `JSON.stringify(json)` with `content-type: application/json`
+     * (before `headers`). Takes precedence over `body`.
+     */
+    readonly json?: unknown;
+    /** What `BlobNotFound.locator` reports for `not_found`; defaults to `path`. */
+    readonly locator?: string | undefined;
+    /** Domain errors the operation surfaces; all by default. See `blobErrorFromResponse`. */
+    readonly domainErrors?: ReadonlyArray<K> | undefined;
+    /**
+     * Upload progress, reported as the SDK does: `{ loaded: 0, total, percentage: 0 }` before the
+     * first attempt, then once per 64 KiB chunk sent (never 100 % while waiting for the response),
+     * then `{ loaded, total: loaded, percentage: 100 }` once a successful response arrived. Also sends
+     * `x-content-length`. Where `fetch` cannot stream request bodies, only the first and last events
+     * are reported.
+     */
+    readonly onUploadProgress?: OnUploadProgress | undefined;
+    /**
+     * Minimum time between chunk events (leading and trailing edge, like `throttleit`); the SDK uses
+     * 100 ms for `put`. The first and last events are never delayed. Unthrottled when omitted.
+     */
+    readonly progressInterval?: Duration.Input | undefined;
+}
+/** A GET on a blob's own URL, for `get`: no Blob API headers, no retries. */
+export interface BlobFetchRequest {
+    /** Traced name, such as `BlobStore.get`; stored in `VercelApiError.operation`. */
+    readonly operation: string;
+    readonly url: URL;
+    /** Sent as `authorization: Bearer <token>`. */
+    readonly token: Redacted.Redacted<string>;
+    /** Sent after `authorization`, so they override it; put `if-none-match` here. */
+    readonly headers?: Readonly<Record<string, string>> | undefined;
+}
+/** Executes Blob API calls with the SDK's headers, retries, error mapping and progress. */
+export interface BlobRequester {
+    /**
+     * Send one API call, retrying it like the SDK's `requestApi`, and decode the response.
+     *
+     * Every attempt carries `x-api-blob-request-id` (`<storeId>:<epoch ms>:<random hex>`, the same
+     * for all attempts), `x-api-blob-request-attempt` (`0`, `1`, …), `x-api-version`,
+     * `x-vercel-blob-store-id`, `authorization` for bearer auth, `x-content-length` with progress or
+     * `sendContentLength`, then the settings' headers, then the call's headers. Network failures and
+     * retryable error codes (`isRetryableBlobError`) are retried up to `retries` times with
+     * exponential backoff from 1 second; a `Stream` body is sent once.
+     *
+     * @returns The decoded body; fails with `VercelApiError` (`ApiNetworkFailure` for transport
+     *   failures, `ApiUnexpectedResponse` for a body `response` cannot decode), a domain error among
+     *   `domainErrors`, the auth effect's error, or the body stream's error.
+     */
+    readonly call: <A = void, E = never, R = never, EA = never, RA = never, K extends BlobDomainErrorTag = BlobDomainErrorTag>(call: BlobApiCall<A, E, R, EA, RA, K>) => Effect.Effect<A, BlobApiError<K> | E | EA, R | RA>;
+    /**
+     * Send a GET to a blob URL and return the response whatever its status; the caller maps 304,
+     * 404 and other statuses. Transport failures are `VercelApiError` / `ApiNetworkFailure`.
+     */
+    readonly fetch: (request: BlobFetchRequest) => Effect.Effect<HttpClientResponse.HttpClientResponse, VercelApiError>;
+}
+/** Size of the chunks a progress-tracked body is sent in, as the SDK's `CHUNK_SIZE`. */
+export declare const progressChunkSize: number;
+/**
+ * Regroup a byte stream into chunks of exactly `size` bytes, the last one possibly smaller, like
+ * the SDK's `createChunkTransformStream`. Empty input chunks produce nothing.
+ */
+export declare const chunkBytes: (size: number) => <E, R>(stream: Stream.Stream<Uint8Array, E, R>) => Stream.Stream<Uint8Array, E, R>;
+/**
+ * Bytes a body will send when known up front, as the SDK's `computeBodyLength`: UTF-8 length of a
+ * string, byte length, `Blob` size; 0 for a stream.
+ */
+export declare const bodyLength: <E, R>(body: BlobBody<E, R>) => number;
+/** A body as a stream of bytes. A `Blob` that cannot be read is a defect. */
+export declare const bodyStream: <E, R>(body: BlobBody<E, R>) => Stream.Stream<Uint8Array, E, R>;
+/**
+ * Whether `fetch` can stream a request body here, detected like the SDK's
+ * `supportsRequestStreams`: always on Node; never against `http://localhost` (no HTTP/2); otherwise
+ * when `Request` reads the `duplex` option and does not type a stream body (Chromium, Edge
+ * runtimes, not Safari or Firefox).
+ */
+export declare const supportsRequestStreams: (apiUrl: string) => boolean;
+/** Delivers progress events, possibly throttled; see {@link uploadProgressThrottle}. */
+export interface UploadProgressReporter {
+    readonly report: (progress: UploadProgress) => Effect.Effect<void>;
+    /** Drop any event still waiting for its interval and stop reporting. */
+    readonly stop: Effect.Effect<void>;
+}
+/**
+ * Throttle progress events like `throttleit`, which the SDK wraps `onUploadProgress` in: the first
+ * event after a quiet interval is reported at once, later ones at most once per `interval`, and the
+ * latest event of an interval is reported when it ends (earlier ones are dropped).
+ *
+ * The interval starts now, as if an event had just been reported (callers report 0 % first). Call
+ * `stop` before the final 100 % event, which callers report directly so it is never delayed.
+ * Without an interval (or a zero one), events are reported immediately.
+ */
+export declare const uploadProgressThrottle: (onUploadProgress: OnUploadProgress, interval: Duration.Input | undefined) => Effect.Effect<UploadProgressReporter, never, never>;
+/**
+ * Build the {@link BlobRequester} that every service uses for Blob API calls.
+ *
+ * Requests carry no `traceparent`/`b3` headers (the SDK sends none, and browsers would need CORS
+ * approval for them); the HTTP client still records a span per attempt.
+ */
+export declare const blobRequester: (settings: BlobRequestSettings) => BlobRequester;
+//# sourceMappingURL=blob-request.d.ts.map

package/dist/internal/blob-request.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blob-request.d.ts","sourceRoot":"","sources":["../../src/internal/blob-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,yCAAyC,CAAC;AAChG,OAAO,KAAK,EAAmB,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEvE,OAAO,EAEL,cAAc,EAGf,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAEL,IAAI,EACJ,QAAQ,EACR,MAAM,EAKN,QAAQ,EAER,MAAM,EACN,MAAM,EACP,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAY,UAAU,EAAqB,MAAM,aAAa,CAAC;AAEtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,KAAK,EACV,QAAQ,EACR,gBAAgB,EAChB,mBAAmB,EACnB,cAAc,EACf,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAMzE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC;IAE3C,4FAA4F;IAC5F,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC;IAErB,+BAA+B;IAC/B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B,+FAA+F;IAC/F,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,qFAAqF;IACrF,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC;IAEpC,0FAA0F;IAC1F,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEnD;;;;OAIG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACpD;AAED,iEAAiE;AACjE,eAAO,MAAM,mBAAmB,WACtB,UAAU,CAAC,SAAS,CAAC,cACjB,UAAU,CAAC,UAAU,KAChC,mBAOD,CAAC;AAEH,qFAAqF;AACrF,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,UAAU,CAAC;IAC5C;;;OAGG;IACH,MAAM,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAChF;;;;OAIG;IACH,SAAS,EAAE;QAAE,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;QAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAChF,CAAC,CAAC;AAEH,6DAA6D;AAC7D,eAAO,MAAM,eAAe;;;wBAVA,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;0BAAoB,MAAM;;;;;0BAM9C,mBAAmB;0BAAoB,MAAM;;;;;;;4BANlD,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;8BAAoB,MAAM;;;8BAM9C,mBAAmB;8BAAoB,MAAM;;;;;;;;;;;;;;4BANlD,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;8BAAoB,MAAM;;;8BAM9C,mBAAmB;8BAAoB,MAAM;;;;;;;;;;;;;;;wBANlD,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC;0BAAoB,MAAM;;;;0BAM9C,mBAAmB;0BAAoB,MAAM;;CAIb,CAAC;AAElE;;;;;GAKG;AACH,eAAO,MAAM,cAAc,WACjB,UAAU,CAAC,SAAS,CAAC,QACvB,UAAU,CAAC,SAAS,CAAC,KAC1B,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,oBAAoB,CAmBrD,CAAC;AAEF,sCAAsC;AACtC,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,CAAC;AAElE;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,SAAS,kBAAkB;IACxE,kFAAkF;IAClF,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,MAAM,EAAE,iBAAiB,CAAC;IAEnC;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAEtD,wFAAwF;IACxF,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAElD,kFAAkF;IAClF,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IAEhE,2FAA2F;IAC3F,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC;IAE3C;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC;IAExB,+EAA+E;IAC/E,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEtC,yFAAyF;IACzF,QAAQ,CAAC,YAAY,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;IAErD;;;;;;OAMG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAEzD;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,QAAQ,CAAC,KAAK,GAAG,SAAS,CAAC;CACxD;AAED,6EAA6E;AAC7E,MAAM,WAAW,gBAAgB;IAC/B,kFAAkF;IAClF,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAElB,+CAA+C;IAC/C,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAE1C,iFAAiF;IACjF,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;CACjE;AAED,2FAA2F;AAC3F,MAAM,WAAW,aAAa;IAC5B;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,IAAI,EAAE,CACb,CAAC,GAAG,IAAI,EACR,CAAC,GAAG,KAAK,EACT,CAAC,GAAG,KAAK,EACT,EAAE,GAAG,KAAK,EACV,EAAE,GAAG,KAAK,EACV,CAAC,SAAS,kBAAkB,GAAG,kBAAkB,EAEjD,IAAI,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,KAClC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;IAExD;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,CACd,OAAO,EAAE,gBAAgB,KACtB,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,kBAAkB,EAAE,cAAc,CAAC,CAAC;CAC3E;AAED,wFAAwF;AACxF,eAAO,MAAM,iBAAiB,QAAY,CAAC;AAS3C;;;GAGG;AACH,eAAO,MAAM,UAAU,SACd,MAAM,MACZ,CAAC,EAAE,CAAC,UAAU,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC,CAc5E,CAAC;AAUN;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,CAAC,QAAQ,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAKvD,CAAC;AAEF,6EAA6E;AAC7E,eAAO,MAAM,UAAU,GAAI,CAAC,EAAE,CAAC,QAAQ,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,KAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC,CAUrF,CAAC;AAcF;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,WAAY,MAAM,KAAG,OAkBvD,CAAC;AAEF,wFAAwF;AACxF,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEnE,wEAAwE;IACxE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;CACpC;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,mIAwBjC,CAAC;AAWH;;;;;GAKG;AACH,eAAO,MAAM,aAAa,aAAc,mBAAmB,KAAG,aAqN7D,CAAC"}