@haatlabs-core/provider-background 0.0.0-stage → 0.10.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Haatlabs
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,59 @@
-# Temporary Holding Version
+# @haatlabs-core/provider-background
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+## Install
+
+    pnpm add @haatlabs-core/provider-background
+
+It leaves one package to your app, so the app holds one copy: `sharp`.
+
+## What it does
+
+Background removal by a rembg service, called directly or through a services gateway.
+`cutoutFromService(baseUrl, image, options)` returns the cut-out (an RGBA PNG the size of the
+image); `outlineFromService` returns its alpha channel as a grey PNG. The image must be a
+WebP the caller made itself. Every answer is checked as a file from a stranger: a PNG by
+its bytes, with alpha, the size sent, at most 25 megapixels, at most 30 MiB. `sharp` is a
+peer: the app's own, with its settings, is the one used. The package leaves sharp's globals
+to the app; on a small host, call `sharp.cache(false)` and `sharp.concurrency(1)`.
+
+## Options
+
+`model` (`BACKGROUND_MODEL`, `u2netp`, by default), `fetch`, `timeoutMs` (10 s),
+`maxReplyBytes` (30 MiB), `maxImageBytes` (20 MiB, the gateway's own cap: a larger image is
+refused before any request, not transient), `gatewayKey`, `call` and `signal`.
+
+## Errors
+
+`BackgroundRemovalError(message, transient, { retryAfterMs?, cause? })`. `transient`: the
+service is away, slow, busy or failing (a 429 or 5xx, no answer, a time out); otherwise the
+same image would get the same answer. A 429 or 5xx carries `retryAfterMs` from its
+Retry-After (seconds or a date, at most five minutes). The message never quotes the
+service. A caller's abort is rethrown as theirs.
+
+## Gateway and deadlines
+
+With `gatewayKey`, `call` (tier, priority, `deadlineMs`) goes to the gateway, tier 4 in the
+background without one. The time limit is `timeoutMs`, or `call.deadlineMs` when that is
+sooner (`localTimeoutMs`; a deadline that is not a finite number is none), and the gateway is
+given that limit, never longer. The deadline is this call's: a caller's retry starts it again;
+pass `signal` for a hard limit. Through the gateway a refused status carries an
+`UpstreamStatusError` as its cause: `isGatewayRefusal(error)` is true for the gateway's 401
+and 403.
+
+## Fixtures
+
+`@haatlabs-core/provider-background/fixtures`: `backgroundFixtures.image` (an 8 x 6 WebP) and
+`backgroundFixtures.cutout` (the RGBA PNG answered for it, which passes every check). Made
+with sharp in the shape rembg answers, not recorded; each read is a fresh copy.
+
+## Testing
+
+`pnpm --filter @haatlabs-core/provider-background test`: unit tests against a fake `fetch`.
+
+## Hosted services
+
+Without a rembg service of your own, `createBackgroundRemover({ mode: 'haatlabs', apiKey })`
+sends the image (at most 5 MB) to the Haatlabs API on RapidAPI and reads the signed cut-out it
+answers with: a PNG with an alpha channel, which may be smaller than the image when the API
+scaled a large one down. `createBackgroundRemover({ mode: 'service', baseUrl, gatewayKey })` is
+`cutoutFromService`. See `@haatlabs-core/services` and https://haatlabs.shop/docs/services/

package/dist/background.d.ts

@@ -0,0 +1,80 @@
+import type { CallContext } from '@haatlabs-core/providers';
+/** The model the service is asked for when none is named: the one its image holds by default. */
+export declare const BACKGROUND_MODEL = "u2netp";
+export declare const DEFAULT_BACKGROUND_TIMEOUT_MS = 10000;
+/** A cut-out of the largest image sent is a few megabytes; more than this is not one. */
+export declare const DEFAULT_MAX_REPLY_BYTES: number;
+/** The gateway's own cap on a request. */
+export declare const DEFAULT_MAX_IMAGE_BYTES: number;
+/**
+ * The service could not give a cut-out. `transient`: it may another time (it is away,
+ * slow or failing); otherwise asking again with the same image would get the same.
+ * `retryAfterMs`: how long a 429 or 5xx asked to be left alone (its Retry-After, at most
+ * five minutes). Through the gateway, a refused status carries an UpstreamStatusError as its
+ * `cause` (`isGatewayRefusal` reads it). The message is ours: nothing the service said is
+ * carried in it.
+ */
+export declare class BackgroundRemovalError extends Error {
+    readonly transient: boolean;
+    readonly retryAfterMs?: number;
+    constructor(message: string, transient: boolean, options?: {
+        retryAfterMs?: number;
+        cause?: unknown;
+    });
+}
+export interface BackgroundRemovalOptions {
+    /** The model to ask for: the one the service's image holds. */
+    model?: string;
+    fetch?: typeof fetch;
+    timeoutMs?: number;
+    maxReplyBytes?: number;
+    /** The largest image sent; a larger one is refused before any request. */
+    maxImageBytes?: number;
+    /** haatlabs-shared's key; null or absent calls the service directly. */
+    gatewayKey?: string | null;
+    /**
+     * Who the call is for: tier, priority, deadline. The deadline, when sooner than
+     * `timeoutMs`, is the time limit, and the one the gateway is given; it is this call's
+     * alone (a caller's retry starts it again): pass `signal` for a hard limit.
+     */
+    call?: CallContext;
+    /** The caller's: its abort is rethrown as it is. */
+    signal?: AbortSignal;
+}
+/**
+ * Asks the background removal service (rembg) for the cut-out of an image: the image with
+ * everything but the product made transparent, as a PNG the size of the image.
+ *
+ * `image` must be a WebP this application made itself, never a file as it came from the web.
+ * `baseUrl` must come from configuration, never from a request. The answer is treated as a
+ * file from a stranger: its type is told from its bytes, it is held to a size, it must be the
+ * size that was sent and have an alpha channel.
+ */
+export declare function cutoutFromService(baseUrl: string, image: Buffer, options?: BackgroundRemovalOptions): Promise<Buffer>;
+/**
+ * Where the product is in an image, as an outline: a grey PNG the size of the image, white
+ * where the product is and black where it is not. The cut-out's alpha channel.
+ */
+export declare function outlineFromService(baseUrl: string, image: Buffer, options?: BackgroundRemovalOptions): Promise<Buffer>;
+/** Where cut-outs come from: your own rembg service (or the gateway), or the Haatlabs API. */
+export type BackgroundRemoverConfig = {
+    mode: 'service';
+    baseUrl: string;
+    gatewayKey?: string | null;
+} | {
+    mode: 'haatlabs';
+    /** Your RapidAPI key for the Haatlabs API (`@haatlabs-core/services`). */
+    apiKey: string;
+    /** The API's address, when not RapidAPI's (a test's fake API). */
+    baseUrl?: string;
+};
+export interface BackgroundRemover {
+    /** The cut-out: a PNG with an alpha channel. */
+    cutout(image: Buffer, options?: BackgroundRemovalOptions): Promise<Buffer>;
+}
+/**
+ * A background remover by configuration. `service` is `cutoutFromService`; `haatlabs` sends
+ * the image (at most 5 MB) to the Haatlabs API and reads the signed cut-out it answers with.
+ * The API may scale a large image down, so its cut-out can be smaller than the image sent.
+ */
+export declare function createBackgroundRemover(config: BackgroundRemoverConfig): BackgroundRemover;

package/dist/background.js

@@ -0,0 +1,241 @@
+import sharp from 'sharp';
+import { gatewayErrorOf, gatewayHeadersFor, localTimeoutMs, retryAfterMsOf, sniffImageType, UpstreamStatusError, sharedCall, } from '@haatlabs-core/providers';
+import { isAppError } from '@haatlabs-core/errors';
+import { createHaatlabsApi, MAX_UPLOAD_BYTES } from '@haatlabs-core/services';
+/** The model the service is asked for when none is named: the one its image holds by default. */
+export const BACKGROUND_MODEL = 'u2netp';
+export const DEFAULT_BACKGROUND_TIMEOUT_MS = 10_000;
+/** A cut-out of the largest image sent is a few megabytes; more than this is not one. */
+export const DEFAULT_MAX_REPLY_BYTES = 30 * 1024 * 1024;
+/** The gateway's own cap on a request. */
+export const DEFAULT_MAX_IMAGE_BYTES = 20 * 1024 * 1024;
+const MAX_REPLY_PIXELS = 25_000_000;
+const HTTP_BAD_REQUEST = 400;
+const HTTP_UNAUTHORIZED = 401;
+const HTTP_FORBIDDEN = 403;
+const HTTP_SERVER_ERROR = 500;
+const HTTP_TOO_MANY_REQUESTS = 429;
+const NO_ANSWER = 'The background removal service did not answer';
+const BAD_ANSWER = 'The background removal service gave an answer that cannot be used';
+/**
+ * The service could not give a cut-out. `transient`: it may another time (it is away,
+ * slow or failing); otherwise asking again with the same image would get the same.
+ * `retryAfterMs`: how long a 429 or 5xx asked to be left alone (its Retry-After, at most
+ * five minutes). Through the gateway, a refused status carries an UpstreamStatusError as its
+ * `cause` (`isGatewayRefusal` reads it). The message is ours: nothing the service said is
+ * carried in it.
+ */
+export class BackgroundRemovalError extends Error {
+    transient;
+    retryAfterMs;
+    constructor(message, transient, options = {}) {
+        super(message, options.cause === undefined ? undefined : { cause: options.cause });
+        this.transient = transient;
+        this.name = 'BackgroundRemovalError';
+        if (options.retryAfterMs !== undefined)
+            this.retryAfterMs = options.retryAfterMs;
+    }
+}
+/** The caller's abort is rethrown as theirs. */
+function throwIfCallerAborted(signal) {
+    if (!signal?.aborted)
+        return;
+    const reason = signal.reason;
+    throw reason instanceof Error
+        ? reason
+        : new DOMException('The removal was aborted', 'AbortError');
+}
+/** Reads a reply up to a limit, and stops reading as soon as it is passed. */
+async function readUpTo(response, limit) {
+    const reader = response.body?.getReader();
+    if (!reader)
+        return Buffer.alloc(0);
+    const chunks = [];
+    let total = 0;
+    for (;;) {
+        const { done, value } = await reader.read();
+        if (done)
+            break;
+        total += value.byteLength;
+        if (total > limit) {
+            await reader.cancel().catch(() => undefined);
+            return null;
+        }
+        chunks.push(value);
+    }
+    return Buffer.concat(chunks);
+}
+/**
+ * Asks the background removal service (rembg) for the cut-out of an image: the image with
+ * everything but the product made transparent, as a PNG the size of the image.
+ *
+ * `image` must be a WebP this application made itself, never a file as it came from the web.
+ * `baseUrl` must come from configuration, never from a request. The answer is treated as a
+ * file from a stranger: its type is told from its bytes, it is held to a size, it must be the
+ * size that was sent and have an alpha channel.
+ */
+export async function cutoutFromService(baseUrl, image, options = {}) {
+    const send = options.fetch ?? fetch;
+    const timeoutMs = options.timeoutMs ?? DEFAULT_BACKGROUND_TIMEOUT_MS;
+    if (image.length > (options.maxImageBytes ?? DEFAULT_MAX_IMAGE_BYTES)) {
+        throw new BackgroundRemovalError('The image is too large to send for background removal', false);
+    }
+    const asked = await sharp(image).metadata();
+    const form = new FormData();
+    form.append('file', new File([image], 'image.webp', { type: 'image/webp' }));
+    form.append('model', options.model ?? BACKGROUND_MODEL);
+    const limitMs = localTimeoutMs(timeoutMs, options.call);
+    const gatewayKey = options.gatewayKey ?? null;
+    const timeout = AbortSignal.timeout(limitMs);
+    const signal = options.signal ? AbortSignal.any([timeout, options.signal]) : timeout;
+    let reply;
+    try {
+        const response = await sharedCall('rembg', () => send(`${baseUrl.replace(/\/+$/, '')}/api/remove`, {
+            method: 'POST',
+            body: form,
+            // The gateway is given no longer than this call waits for it.
+            headers: gatewayHeadersFor(gatewayKey, options.call && { ...options.call, deadlineMs: limitMs }, limitMs),
+            redirect: 'error',
+            signal,
+        }), (answer) => answer.status);
+        if (!response.ok) {
+            const status = response.status;
+            let cause;
+            if (gatewayKey) {
+                // gatewayErrorOf reads at most 2 KiB of the body and lets the rest go.
+                const word = await gatewayErrorOf(response);
+                cause = new UpstreamStatusError(status, word, status === HTTP_UNAUTHORIZED || status === HTTP_FORBIDDEN, status === HTTP_BAD_REQUEST && word === 'bad_request');
+            }
+            else
+                await response.body?.cancel().catch(() => undefined);
+            const transient = status === HTTP_TOO_MANY_REQUESTS || status >= HTTP_SERVER_ERROR;
+            throw new BackgroundRemovalError(`${NO_ANSWER} (HTTP ${status})`, transient, {
+                retryAfterMs: transient ? retryAfterMsOf(response.headers) : undefined,
+                cause,
+            });
+        }
+        reply = await readUpTo(response, options.maxReplyBytes ?? DEFAULT_MAX_REPLY_BYTES);
+    }
+    catch (error) {
+        if (options.signal?.aborted) {
+            const reason = options.signal.reason;
+            throw reason instanceof Error
+                ? reason
+                : new DOMException('The removal was aborted', 'AbortError');
+        }
+        if (error instanceof BackgroundRemovalError)
+            throw error;
+        // Away, refused, cut off or too slow: none of them says anything about the image.
+        throw new BackgroundRemovalError(NO_ANSWER, true);
+    }
+    throwIfCallerAborted(options.signal);
+    if (reply === null || sniffImageType(reply) !== 'png') {
+        throw new BackgroundRemovalError(BAD_ANSWER, false);
+    }
+    try {
+        const answered = await sharp(reply, { limitInputPixels: MAX_REPLY_PIXELS }).metadata();
+        if (!answered.hasAlpha || answered.width !== asked.width || answered.height !== asked.height) {
+            throw new BackgroundRemovalError(BAD_ANSWER, false);
+        }
+    }
+    catch (error) {
+        if (error instanceof BackgroundRemovalError)
+            throw error;
+        throw new BackgroundRemovalError(BAD_ANSWER, false);
+    }
+    return reply;
+}
+/**
+ * Where the product is in an image, as an outline: a grey PNG the size of the image, white
+ * where the product is and black where it is not. The cut-out's alpha channel.
+ */
+export async function outlineFromService(baseUrl, image, options = {}) {
+    const cutout = await cutoutFromService(baseUrl, image, options);
+    try {
+        return await sharp(cutout, { limitInputPixels: MAX_REPLY_PIXELS, failOn: 'error' })
+            .extractChannel('alpha')
+            .toColourspace('b-w')
+            .png()
+            .toBuffer();
+    }
+    catch {
+        throw new BackgroundRemovalError(BAD_ANSWER, false);
+    }
+}
+/**
+ * A background remover by configuration. `service` is `cutoutFromService`; `haatlabs` sends
+ * the image (at most 5 MB) to the Haatlabs API and reads the signed cut-out it answers with.
+ * The API may scale a large image down, so its cut-out can be smaller than the image sent.
+ */
+export function createBackgroundRemover(config) {
+    if (config.mode === 'service') {
+        return {
+            cutout: (image, options = {}) => cutoutFromService(config.baseUrl, image, {
+                ...options,
+                gatewayKey: options.gatewayKey ?? config.gatewayKey ?? null,
+            }),
+        };
+    }
+    return {
+        async cutout(image, options = {}) {
+            const send = options.fetch ?? fetch;
+            const timeoutMs = options.timeoutMs ?? DEFAULT_BACKGROUND_TIMEOUT_MS * 3;
+            if (image.length > MAX_UPLOAD_BYTES) {
+                throw new BackgroundRemovalError('The image is too large to send for background removal (5 MB at most)', false);
+            }
+            const api = createHaatlabsApi({
+                apiKey: config.apiKey,
+                timeoutMs,
+                fetch: send,
+                ...(config.baseUrl
+                    ? { baseUrl: config.baseUrl, host: new URL(config.baseUrl).hostname }
+                    : {}),
+            });
+            let url;
+            try {
+                url = (await api.images.removeBackground({ image })).url;
+            }
+            catch (error) {
+                throwIfCallerAborted(options.signal);
+                const transient = isAppError(error) ? error.transient : true;
+                throw new BackgroundRemovalError(isAppError(error) ? error.message : NO_ANSWER, transient, {
+                    cause: error,
+                });
+            }
+            let reply;
+            try {
+                const timeout = AbortSignal.timeout(timeoutMs);
+                const response = await send(url, {
+                    redirect: 'error',
+                    signal: options.signal ? AbortSignal.any([timeout, options.signal]) : timeout,
+                });
+                if (!response.ok) {
+                    await response.body?.cancel().catch(() => undefined);
+                    throw new BackgroundRemovalError(`${NO_ANSWER} (HTTP ${response.status})`, true);
+                }
+                reply = await readUpTo(response, options.maxReplyBytes ?? DEFAULT_MAX_REPLY_BYTES);
+            }
+            catch (error) {
+                throwIfCallerAborted(options.signal);
+                if (error instanceof BackgroundRemovalError)
+                    throw error;
+                throw new BackgroundRemovalError(NO_ANSWER, true);
+            }
+            if (reply === null || sniffImageType(reply) !== 'png') {
+                throw new BackgroundRemovalError(BAD_ANSWER, false);
+            }
+            try {
+                const answered = await sharp(reply, { limitInputPixels: MAX_REPLY_PIXELS }).metadata();
+                if (!answered.hasAlpha)
+                    throw new BackgroundRemovalError(BAD_ANSWER, false);
+            }
+            catch (error) {
+                if (error instanceof BackgroundRemovalError)
+                    throw error;
+                throw new BackgroundRemovalError(BAD_ANSWER, false);
+            }
+            return reply;
+        },
+    };
+}
+//# sourceMappingURL=background.js.map

package/dist/background.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"background.js","sourceRoot":"","sources":["../src/background.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,cAAc,EACd,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,UAAU,GACX,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEzE,iGAAiG;AACjG,MAAM,CAAC,MAAM,gBAAgB,GAAG,QAAQ,CAAC;AACzC,MAAM,CAAC,MAAM,6BAA6B,GAAG,MAAM,CAAC;AACpD,yFAAyF;AACzF,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AACxD,0CAA0C;AAC1C,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC;AACxD,MAAM,gBAAgB,GAAG,UAAU,CAAC;AACpC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,cAAc,GAAG,GAAG,CAAC;AAC3B,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,sBAAsB,GAAG,GAAG,CAAC;AACnC,MAAM,SAAS,GAAG,+CAA+C,CAAC;AAClE,MAAM,UAAU,GAAG,mEAAmE,CAAC;AAEvF;;;;;;;GAOG;AACH,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAKpC;IAJF,YAAY,CAAU;IAE/B,YACE,OAAe,EACN,SAAkB,EAC3B,UAAsD,EAAE;QAExD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAH1E,cAAS,GAAT,SAAS,CAAS;QAI3B,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAC;QACrC,IAAI,OAAO,CAAC,YAAY,KAAK,SAAS;YAAE,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IACnF,CAAC;CACF;AAsBD,gDAAgD;AAChD,SAAS,oBAAoB,CAAC,MAA+B;IAC3D,IAAI,CAAC,MAAM,EAAE,OAAO;QAAE,OAAO;IAC7B,MAAM,MAAM,GAAY,MAAM,CAAC,MAAM,CAAC;IACtC,MAAM,MAAM,YAAY,KAAK;QAC3B,CAAC,CAAC,MAAM;QACR,CAAC,CAAC,IAAI,YAAY,CAAC,yBAAyB,EAAE,YAAY,CAAC,CAAC;AAChE,CAAC;AAED,8EAA8E;AAC9E,KAAK,UAAU,QAAQ,CAAC,QAAkB,EAAE,KAAa;IACvD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,EAAE,SAAS,EAAE,CAAC;IAC1C,IAAI,CAAC,MAAM;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACpC,MAAM,MAAM,GAAiB,EAAE,CAAC;IAChC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,SAAS,CAAC;QACR,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QAC5C,IAAI,IAAI;YAAE,MAAM;QAChB,KAAK,IAAI,KAAK,CAAC,UAAU,CAAC;QAC1B,IAAI,KAAK,GAAG,KAAK,EAAE,CAAC;YAClB,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAC7C,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC;IACD,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC/B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAe,EACf,KAAa,EACb,UAAoC,EAAE;IAEtC,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;IACpC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,6BAA6B,CAAC;IACrE,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,OAAO,CAAC,aAAa,IAAI,uBAAuB,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,sBAAsB,CAC9B,uDAAuD,EACvD,KAAK,CACN,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC5C,MAAM,IAAI,GAAG,IAAI,QAAQ,EAAE,CAAC;IAC5B,IAAI,CAAC,MAAM,CACT,MAAM,EACN,IAAI,IAAI,CAAC,CAAC,KAAgC,CAAC,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CACnF,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,IAAI,gBAAgB,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,IAAI,CAAC;IAC9C,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAErF,IAAI,KAAoB,CAAC;IACzB,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,UAAU,CAC/B,OAAO,EACP,GAAG,EAAE,CACH,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,aAAa,EAAE;YAChD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,8DAA8D;YAC9D,OAAO,EAAE,iBAAiB,CACxB,UAAU,EACV,OAAO,CAAC,IAAI,IAAI,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,EACxD,OAAO,CACR;YACD,QAAQ,EAAE,OAAO;YACjB,MAAM;SACP,CAAC,EACJ,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAC1B,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;YAC/B,IAAI,KAAsC,CAAC;YAC3C,IAAI,UAAU,EAAE,CAAC;gBACf,uEAAuE;gBACvE,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;gBAC5C,KAAK,GAAG,IAAI,mBAAmB,CAC7B,MAAM,EACN,IAAI,EACJ,MAAM,KAAK,iBAAiB,IAAI,MAAM,KAAK,cAAc,EACzD,MAAM,KAAK,gBAAgB,IAAI,IAAI,KAAK,aAAa,CACtD,CAAC;YACJ,CAAC;;gBAAM,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;YAC5D,MAAM,SAAS,GAAG,MAAM,KAAK,sBAAsB,IAAI,MAAM,IAAI,iBAAiB,CAAC;YACnF,MAAM,IAAI,sBAAsB,CAAC,GAAG,SAAS,UAAU,MAAM,GAAG,EAAE,SAAS,EAAE;gBAC3E,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;gBACtE,KAAK;aACN,CAAC,CAAC;QACL,CAAC;QACD,KAAK,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,aAAa,IAAI,uBAAuB,CAAC,CAAC;IACrF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;YAC5B,MAAM,MAAM,GAAY,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;YAC9C,MAAM,MAAM,YAAY,KAAK;gBAC3B,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,IAAI,YAAY,CAAC,yBAAyB,EAAE,YAAY,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,KAAK,YAAY,sBAAsB;YAAE,MAAM,KAAK,CAAC;QACzD,kFAAkF;QAClF,MAAM,IAAI,sBAAsB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IACD,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACrC,IAAI,KAAK,KAAK,IAAI,IAAI,cAAc,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;QACtD,MAAM,IAAI,sBAAsB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IACD,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;QACvF,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,EAAE,CAAC;YAC7F,MAAM,IAAI,sBAAsB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,sBAAsB;YAAE,MAAM,KAAK,CAAC;QACzD,MAAM,IAAI,sBAAsB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,OAAe,EACf,KAAa,EACb,UAAoC,EAAE;IAEtC,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAChE,IAAI,CAAC;QACH,OAAO,MAAM,KAAK,CAAC,MAAM,EAAE,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;aAChF,cAAc,CAAC,OAAO,CAAC;aACvB,aAAa,CAAC,KAAK,CAAC;aACpB,GAAG,EAAE;aACL,QAAQ,EAAE,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,sBAAsB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;AACH,CAAC;AAkBD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,MAA+B;IACrE,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO;YACL,MAAM,EAAE,CAAC,KAAK,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE,CAC9B,iBAAiB,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE;gBACvC,GAAG,OAAO;gBACV,UAAU,EAAE,OAAO,CAAC,UAAU,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI;aAC5D,CAAC;SACL,CAAC;IACJ,CAAC;IACD,OAAO;QACL,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,EAAE;YAC9B,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,IAAI,KAAK,CAAC;YACpC,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,6BAA6B,GAAG,CAAC,CAAC;YACzE,IAAI,KAAK,CAAC,MAAM,GAAG,gBAAgB,EAAE,CAAC;gBACpC,MAAM,IAAI,sBAAsB,CAC9B,sEAAsE,EACtE,KAAK,CACN,CAAC;YACJ,CAAC;YACD,MAAM,GAAG,GAAG,iBAAiB,CAAC;gBAC5B,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,SAAS;gBACT,KAAK,EAAE,IAAI;gBACX,GAAG,CAAC,MAAM,CAAC,OAAO;oBAChB,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE;oBACrE,CAAC,CAAC,EAAE,CAAC;aACR,CAAC,CAAC;YACH,IAAI,GAAW,CAAC;YAChB,IAAI,CAAC;gBACH,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;YAC3D,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACrC,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC7D,MAAM,IAAI,sBAAsB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE;oBACzF,KAAK,EAAE,KAAK;iBACb,CAAC,CAAC;YACL,CAAC;YACD,IAAI,KAAoB,CAAC;YACzB,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;gBAC/C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE;oBAC/B,QAAQ,EAAE,OAAO;oBACjB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO;iBAC9E,CAAC,CAAC;gBACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;oBACrD,MAAM,IAAI,sBAAsB,CAAC,GAAG,SAAS,UAAU,QAAQ,CAAC,MAAM,GAAG,EAAE,IAAI,CAAC,CAAC;gBACnF,CAAC;gBACD,KAAK,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,aAAa,IAAI,uBAAuB,CAAC,CAAC;YACrF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;gBACrC,IAAI,KAAK,YAAY,sBAAsB;oBAAE,MAAM,KAAK,CAAC;gBACzD,MAAM,IAAI,sBAAsB,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACpD,CAAC;YACD,IAAI,KAAK,KAAK,IAAI,IAAI,cAAc,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;gBACtD,MAAM,IAAI,sBAAsB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YACtD,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACvF,IAAI,CAAC,QAAQ,CAAC,QAAQ;oBAAE,MAAM,IAAI,sBAAsB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YAC9E,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,sBAAsB;oBAAE,MAAM,KAAK,CAAC;gBACzD,MAAM,IAAI,sBAAsB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YACtD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/cjs/background.d.ts

@@ -0,0 +1,80 @@
+import type { CallContext } from '@haatlabs-core/providers';
+/** The model the service is asked for when none is named: the one its image holds by default. */
+export declare const BACKGROUND_MODEL = "u2netp";
+export declare const DEFAULT_BACKGROUND_TIMEOUT_MS = 10000;
+/** A cut-out of the largest image sent is a few megabytes; more than this is not one. */
+export declare const DEFAULT_MAX_REPLY_BYTES: number;
+/** The gateway's own cap on a request. */
+export declare const DEFAULT_MAX_IMAGE_BYTES: number;
+/**
+ * The service could not give a cut-out. `transient`: it may another time (it is away,
+ * slow or failing); otherwise asking again with the same image would get the same.
+ * `retryAfterMs`: how long a 429 or 5xx asked to be left alone (its Retry-After, at most
+ * five minutes). Through the gateway, a refused status carries an UpstreamStatusError as its
+ * `cause` (`isGatewayRefusal` reads it). The message is ours: nothing the service said is
+ * carried in it.
+ */
+export declare class BackgroundRemovalError extends Error {
+    readonly transient: boolean;
+    readonly retryAfterMs?: number;
+    constructor(message: string, transient: boolean, options?: {
+        retryAfterMs?: number;
+        cause?: unknown;
+    });
+}
+export interface BackgroundRemovalOptions {
+    /** The model to ask for: the one the service's image holds. */
+    model?: string;
+    fetch?: typeof fetch;
+    timeoutMs?: number;
+    maxReplyBytes?: number;
+    /** The largest image sent; a larger one is refused before any request. */
+    maxImageBytes?: number;
+    /** haatlabs-shared's key; null or absent calls the service directly. */
+    gatewayKey?: string | null;
+    /**
+     * Who the call is for: tier, priority, deadline. The deadline, when sooner than
+     * `timeoutMs`, is the time limit, and the one the gateway is given; it is this call's
+     * alone (a caller's retry starts it again): pass `signal` for a hard limit.
+     */
+    call?: CallContext;
+    /** The caller's: its abort is rethrown as it is. */
+    signal?: AbortSignal;
+}
+/**
+ * Asks the background removal service (rembg) for the cut-out of an image: the image with
+ * everything but the product made transparent, as a PNG the size of the image.
+ *
+ * `image` must be a WebP this application made itself, never a file as it came from the web.
+ * `baseUrl` must come from configuration, never from a request. The answer is treated as a
+ * file from a stranger: its type is told from its bytes, it is held to a size, it must be the
+ * size that was sent and have an alpha channel.
+ */
+export declare function cutoutFromService(baseUrl: string, image: Buffer, options?: BackgroundRemovalOptions): Promise<Buffer>;
+/**
+ * Where the product is in an image, as an outline: a grey PNG the size of the image, white
+ * where the product is and black where it is not. The cut-out's alpha channel.
+ */
+export declare function outlineFromService(baseUrl: string, image: Buffer, options?: BackgroundRemovalOptions): Promise<Buffer>;
+/** Where cut-outs come from: your own rembg service (or the gateway), or the Haatlabs API. */
+export type BackgroundRemoverConfig = {
+    mode: 'service';
+    baseUrl: string;
+    gatewayKey?: string | null;
+} | {
+    mode: 'haatlabs';
+    /** Your RapidAPI key for the Haatlabs API (`@haatlabs-core/services`). */
+    apiKey: string;
+    /** The API's address, when not RapidAPI's (a test's fake API). */
+    baseUrl?: string;
+};
+export interface BackgroundRemover {
+    /** The cut-out: a PNG with an alpha channel. */
+    cutout(image: Buffer, options?: BackgroundRemovalOptions): Promise<Buffer>;
+}
+/**
+ * A background remover by configuration. `service` is `cutoutFromService`; `haatlabs` sends
+ * the image (at most 5 MB) to the Haatlabs API and reads the signed cut-out it answers with.
+ * The API may scale a large image down, so its cut-out can be smaller than the image sent.
+ */
+export declare function createBackgroundRemover(config: BackgroundRemoverConfig): BackgroundRemover;

package/dist/cjs/background.js

@@ -0,0 +1,240 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var background_exports = {};
+__export(background_exports, {
+  BACKGROUND_MODEL: () => BACKGROUND_MODEL,
+  BackgroundRemovalError: () => BackgroundRemovalError,
+  DEFAULT_BACKGROUND_TIMEOUT_MS: () => DEFAULT_BACKGROUND_TIMEOUT_MS,
+  DEFAULT_MAX_IMAGE_BYTES: () => DEFAULT_MAX_IMAGE_BYTES,
+  DEFAULT_MAX_REPLY_BYTES: () => DEFAULT_MAX_REPLY_BYTES,
+  createBackgroundRemover: () => createBackgroundRemover,
+  cutoutFromService: () => cutoutFromService,
+  outlineFromService: () => outlineFromService
+});
+module.exports = __toCommonJS(background_exports);
+var import_sharp = __toESM(require("sharp"));
+var import_providers = require("@haatlabs-core/providers");
+var import_errors = require("@haatlabs-core/errors");
+var import_services = require("@haatlabs-core/services");
+const BACKGROUND_MODEL = "u2netp";
+const DEFAULT_BACKGROUND_TIMEOUT_MS = 1e4;
+const DEFAULT_MAX_REPLY_BYTES = 30 * 1024 * 1024;
+const DEFAULT_MAX_IMAGE_BYTES = 20 * 1024 * 1024;
+const MAX_REPLY_PIXELS = 25e6;
+const HTTP_BAD_REQUEST = 400;
+const HTTP_UNAUTHORIZED = 401;
+const HTTP_FORBIDDEN = 403;
+const HTTP_SERVER_ERROR = 500;
+const HTTP_TOO_MANY_REQUESTS = 429;
+const NO_ANSWER = "The background removal service did not answer";
+const BAD_ANSWER = "The background removal service gave an answer that cannot be used";
+class BackgroundRemovalError extends Error {
+  transient;
+  retryAfterMs;
+  constructor(message, transient, options = {}) {
+    super(message, options.cause === void 0 ? void 0 : { cause: options.cause });
+    this.transient = transient;
+    this.name = "BackgroundRemovalError";
+    if (options.retryAfterMs !== void 0)
+      this.retryAfterMs = options.retryAfterMs;
+  }
+}
+function throwIfCallerAborted(signal) {
+  if (!signal?.aborted)
+    return;
+  const reason = signal.reason;
+  throw reason instanceof Error ? reason : new DOMException("The removal was aborted", "AbortError");
+}
+async function readUpTo(response, limit) {
+  const reader = response.body?.getReader();
+  if (!reader)
+    return Buffer.alloc(0);
+  const chunks = [];
+  let total = 0;
+  for (; ; ) {
+    const { done, value } = await reader.read();
+    if (done)
+      break;
+    total += value.byteLength;
+    if (total > limit) {
+      await reader.cancel().catch(() => void 0);
+      return null;
+    }
+    chunks.push(value);
+  }
+  return Buffer.concat(chunks);
+}
+async function cutoutFromService(baseUrl, image, options = {}) {
+  const send = options.fetch ?? fetch;
+  const timeoutMs = options.timeoutMs ?? DEFAULT_BACKGROUND_TIMEOUT_MS;
+  if (image.length > (options.maxImageBytes ?? DEFAULT_MAX_IMAGE_BYTES)) {
+    throw new BackgroundRemovalError("The image is too large to send for background removal", false);
+  }
+  const asked = await (0, import_sharp.default)(image).metadata();
+  const form = new FormData();
+  form.append("file", new File([image], "image.webp", { type: "image/webp" }));
+  form.append("model", options.model ?? BACKGROUND_MODEL);
+  const limitMs = (0, import_providers.localTimeoutMs)(timeoutMs, options.call);
+  const gatewayKey = options.gatewayKey ?? null;
+  const timeout = AbortSignal.timeout(limitMs);
+  const signal = options.signal ? AbortSignal.any([timeout, options.signal]) : timeout;
+  let reply;
+  try {
+    const response = await (0, import_providers.sharedCall)("rembg", () => send(`${baseUrl.replace(/\/+$/, "")}/api/remove`, {
+      method: "POST",
+      body: form,
+      // The gateway is given no longer than this call waits for it.
+      headers: (0, import_providers.gatewayHeadersFor)(gatewayKey, options.call && { ...options.call, deadlineMs: limitMs }, limitMs),
+      redirect: "error",
+      signal
+    }), (answer) => answer.status);
+    if (!response.ok) {
+      const status = response.status;
+      let cause;
+      if (gatewayKey) {
+        const word = await (0, import_providers.gatewayErrorOf)(response);
+        cause = new import_providers.UpstreamStatusError(status, word, status === HTTP_UNAUTHORIZED || status === HTTP_FORBIDDEN, status === HTTP_BAD_REQUEST && word === "bad_request");
+      } else
+        await response.body?.cancel().catch(() => void 0);
+      const transient = status === HTTP_TOO_MANY_REQUESTS || status >= HTTP_SERVER_ERROR;
+      throw new BackgroundRemovalError(`${NO_ANSWER} (HTTP ${status})`, transient, {
+        retryAfterMs: transient ? (0, import_providers.retryAfterMsOf)(response.headers) : void 0,
+        cause
+      });
+    }
+    reply = await readUpTo(response, options.maxReplyBytes ?? DEFAULT_MAX_REPLY_BYTES);
+  } catch (error) {
+    if (options.signal?.aborted) {
+      const reason = options.signal.reason;
+      throw reason instanceof Error ? reason : new DOMException("The removal was aborted", "AbortError");
+    }
+    if (error instanceof BackgroundRemovalError)
+      throw error;
+    throw new BackgroundRemovalError(NO_ANSWER, true);
+  }
+  throwIfCallerAborted(options.signal);
+  if (reply === null || (0, import_providers.sniffImageType)(reply) !== "png") {
+    throw new BackgroundRemovalError(BAD_ANSWER, false);
+  }
+  try {
+    const answered = await (0, import_sharp.default)(reply, { limitInputPixels: MAX_REPLY_PIXELS }).metadata();
+    if (!answered.hasAlpha || answered.width !== asked.width || answered.height !== asked.height) {
+      throw new BackgroundRemovalError(BAD_ANSWER, false);
+    }
+  } catch (error) {
+    if (error instanceof BackgroundRemovalError)
+      throw error;
+    throw new BackgroundRemovalError(BAD_ANSWER, false);
+  }
+  return reply;
+}
+async function outlineFromService(baseUrl, image, options = {}) {
+  const cutout = await cutoutFromService(baseUrl, image, options);
+  try {
+    return await (0, import_sharp.default)(cutout, { limitInputPixels: MAX_REPLY_PIXELS, failOn: "error" }).extractChannel("alpha").toColourspace("b-w").png().toBuffer();
+  } catch {
+    throw new BackgroundRemovalError(BAD_ANSWER, false);
+  }
+}
+function createBackgroundRemover(config) {
+  if (config.mode === "service") {
+    return {
+      cutout: (image, options = {}) => cutoutFromService(config.baseUrl, image, {
+        ...options,
+        gatewayKey: options.gatewayKey ?? config.gatewayKey ?? null
+      })
+    };
+  }
+  return {
+    async cutout(image, options = {}) {
+      const send = options.fetch ?? fetch;
+      const timeoutMs = options.timeoutMs ?? DEFAULT_BACKGROUND_TIMEOUT_MS * 3;
+      if (image.length > import_services.MAX_UPLOAD_BYTES) {
+        throw new BackgroundRemovalError("The image is too large to send for background removal (5 MB at most)", false);
+      }
+      const api = (0, import_services.createHaatlabsApi)({
+        apiKey: config.apiKey,
+        timeoutMs,
+        fetch: send,
+        ...config.baseUrl ? { baseUrl: config.baseUrl, host: new URL(config.baseUrl).hostname } : {}
+      });
+      let url;
+      try {
+        url = (await api.images.removeBackground({ image })).url;
+      } catch (error) {
+        throwIfCallerAborted(options.signal);
+        const transient = (0, import_errors.isAppError)(error) ? error.transient : true;
+        throw new BackgroundRemovalError((0, import_errors.isAppError)(error) ? error.message : NO_ANSWER, transient, {
+          cause: error
+        });
+      }
+      let reply;
+      try {
+        const timeout = AbortSignal.timeout(timeoutMs);
+        const response = await send(url, {
+          redirect: "error",
+          signal: options.signal ? AbortSignal.any([timeout, options.signal]) : timeout
+        });
+        if (!response.ok) {
+          await response.body?.cancel().catch(() => void 0);
+          throw new BackgroundRemovalError(`${NO_ANSWER} (HTTP ${response.status})`, true);
+        }
+        reply = await readUpTo(response, options.maxReplyBytes ?? DEFAULT_MAX_REPLY_BYTES);
+      } catch (error) {
+        throwIfCallerAborted(options.signal);
+        if (error instanceof BackgroundRemovalError)
+          throw error;
+        throw new BackgroundRemovalError(NO_ANSWER, true);
+      }
+      if (reply === null || (0, import_providers.sniffImageType)(reply) !== "png") {
+        throw new BackgroundRemovalError(BAD_ANSWER, false);
+      }
+      try {
+        const answered = await (0, import_sharp.default)(reply, { limitInputPixels: MAX_REPLY_PIXELS }).metadata();
+        if (!answered.hasAlpha)
+          throw new BackgroundRemovalError(BAD_ANSWER, false);
+      } catch (error) {
+        if (error instanceof BackgroundRemovalError)
+          throw error;
+        throw new BackgroundRemovalError(BAD_ANSWER, false);
+      }
+      return reply;
+    }
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BACKGROUND_MODEL,
+  BackgroundRemovalError,
+  DEFAULT_BACKGROUND_TIMEOUT_MS,
+  DEFAULT_MAX_IMAGE_BYTES,
+  DEFAULT_MAX_REPLY_BYTES,
+  createBackgroundRemover,
+  cutoutFromService,
+  outlineFromService
+});

package/dist/cjs/fixtures/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * One exchange with the background removal service, for tests that must not reach it: an
+ * 8 x 6 WebP of the kind sent, and the cut-out answered for it (an RGBA PNG the same size,
+ * its left half kept). Made with sharp in the shape rembg answers, not recorded. Each read
+ * is a fresh copy.
+ */
+export declare const backgroundFixtures: {
+    readonly image: Buffer;
+    readonly cutout: Buffer;
+};

package/dist/cjs/fixtures/index.js

@@ -0,0 +1,34 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var fixtures_exports = {};
+__export(fixtures_exports, {
+  backgroundFixtures: () => backgroundFixtures
+});
+module.exports = __toCommonJS(fixtures_exports);
+const backgroundFixtures = {
+  get image() {
+    return Buffer.from("UklGRiIAAABXRUJQVlA4TBYAAAAvB0ABAAfQzGY2s/8BgCD8b5uI6H8I", "base64");
+  },
+  get cutout() {
+    return Buffer.from("iVBORw0KGgoAAAANSUhEUgAAAAgAAAAGCAYAAAD+Bd/7AAAACXBIWXMAAAPoAAAD6AG1e1JrAAAAFUlEQVQI12OYOXPmfzTMgIwZhoICAFCfbfnbwRq3AAAAAElFTkSuQmCC", "base64");
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  backgroundFixtures
+});

package/dist/cjs/index.d.ts

@@ -0,0 +1 @@
+export * from './background.js';

package/dist/cjs/index.js

@@ -0,0 +1,21 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var index_exports = {};
+module.exports = __toCommonJS(index_exports);
+__reExport(index_exports, require("./background.js"), module.exports);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ...require("./background.js")
+});

package/dist/cjs/package.json

@@ -0,0 +1,8 @@
+{
+  "type": "commonjs",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "platformRegistry": "npm"
+}

package/dist/fixtures/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * One exchange with the background removal service, for tests that must not reach it: an
+ * 8 x 6 WebP of the kind sent, and the cut-out answered for it (an RGBA PNG the same size,
+ * its left half kept). Made with sharp in the shape rembg answers, not recorded. Each read
+ * is a fresh copy.
+ */
+export declare const backgroundFixtures: {
+    readonly image: Buffer;
+    readonly cutout: Buffer;
+};

package/dist/fixtures/index.js

@@ -0,0 +1,15 @@
+/**
+ * One exchange with the background removal service, for tests that must not reach it: an
+ * 8 x 6 WebP of the kind sent, and the cut-out answered for it (an RGBA PNG the same size,
+ * its left half kept). Made with sharp in the shape rembg answers, not recorded. Each read
+ * is a fresh copy.
+ */
+export const backgroundFixtures = {
+    get image() {
+        return Buffer.from('UklGRiIAAABXRUJQVlA4TBYAAAAvB0ABAAfQzGY2s/8BgCD8b5uI6H8I', 'base64');
+    },
+    get cutout() {
+        return Buffer.from('iVBORw0KGgoAAAANSUhEUgAAAAgAAAAGCAYAAAD+Bd/7AAAACXBIWXMAAAPoAAAD6AG1e1JrAAAAFUlEQVQI12OYOXPmfzTMgIwZhoICAFCfbfnbwRq3AAAAAElFTkSuQmCC', 'base64');
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/fixtures/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/fixtures/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAwD;IACrF,IAAI,KAAK;QACP,OAAO,MAAM,CAAC,IAAI,CAAC,0DAA0D,EAAE,QAAQ,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,MAAM;QACR,OAAO,MAAM,CAAC,IAAI,CAChB,sIAAsI,EACtI,QAAQ,CACT,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './background.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './background.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,iBAAiB,CAAC"}

package/package.json

@@ -1,6 +1,71 @@
 {
   "name": "@haatlabs-core/provider-background",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.10.0",
+  "description": "Background removal through a rembg service.",
+  "keywords": [
+    "haatlabs",
+    "rembg"
+  ],
+  "homepage": "https://haatlabs.shop/docs/packages/provider-background/",
+  "license": "Apache-2.0",
+  "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Haatlabs/haatlabs-platform.git",
+    "directory": "packages/provider-background"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    },
+    "./fixtures": {
+      "import": {
+        "types": "./dist/fixtures/index.d.ts",
+        "default": "./dist/fixtures/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/fixtures/index.d.ts",
+        "default": "./dist/cjs/fixtures/index.js"
+      }
+    }
+  },
+  "dependencies": {
+    "@haatlabs-core/errors": "0.10.0",
+    "@haatlabs-core/providers": "0.10.0",
+    "@haatlabs-core/services": "0.10.0"
+  },
+  "peerDependencies": {
+    "sharp": "^0.35.0"
+  },
+  "devDependencies": {
+    "@opentelemetry/sdk-trace-node": "^2.11.0",
+    "sharp": "^0.35.5",
+    "@haatlabs-core/tsconfig": "0.10.0",
+    "@haatlabs-core/observability": "0.10.0",
+    "@haatlabs-core/vitest-config": "0.10.0"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json && node ../../scripts/build-cjs.mjs",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "check:package": "publint --strict && attw --pack . --profile node16"
+  },
+  "platformRegistry": "npm"
+}