@heroku/sdk 0.1.0-beta.0

package/LICENSE.txt

@@ -0,0 +1,207 @@
+Apache License Version 2.0
+
+Copyright (c) 2026 Salesforce, Inc.
+All rights reserved.
+
+                                 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 {yyyy} {name of copyright owner}
+
+   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

@@ -0,0 +1,94 @@
+# Heroku SDK
+
+A TypeScript SDK for the [Heroku Platform API](https://devcenter.heroku.com/articles/platform-api-reference) and [Heroku Data API](https://devcenter.heroku.com/articles/heroku-postgres-api-reference). It generates fully-typed clients at runtime from route definitions — no hand-written method per endpoint.
+
+## Installation
+
+```sh
+npm install @heroku/sdk
+```
+
+## Usage
+
+The simplest entry point is the `HerokuSDK` class. It exposes both the Platform and Data clients on a single object, plus an extension mechanism for hand-written helpers.
+
+```ts
+import { HerokuSDK } from '@heroku/sdk'
+import { appExtensions } from '@heroku/sdk/extensions/platform'
+
+// Reads token from HEROKU_API_KEY or ~/.netrc
+const sdk = new HerokuSDK({ extensions: [appExtensions] })
+
+// Upstream route (auto-generated from the API spec)
+const apps = await sdk.platform.app.list()
+const app  = await sdk.platform.app.info('my-app')
+
+// Hand-written extension method (provided by appExtensions)
+await sdk.platform.app.enableMaintenance('my-app')
+```
+
+You can also pass options directly:
+
+```ts
+const sdk = new HerokuSDK({ clientOptions: { token: 'your-api-token' } })
+```
+
+### Per-service clients
+
+If you only need one service (and want the smallest possible bundle), import the factory directly. These return the same typed client the SDK class wraps internally.
+
+```ts
+import { createPlatformClient } from '@heroku/sdk/platform'
+import { createDataClient }     from '@heroku/sdk/data'
+
+const platform = createPlatformClient()
+const data     = createDataClient()
+
+const apps = await platform.app.list()
+```
+
+### Imports
+
+| Symbol                                   | Import from                       |
+| ---------------------------------------- | --------------------------------- |
+| `HerokuSDK`, `extendResource`, types     | `@heroku/sdk`                     |
+| `createPlatformClient`, `PlatformClient` | `@heroku/sdk/platform`            |
+| `createDataClient`, `DataClient`         | `@heroku/sdk/data`                |
+| `appExtensions`, `dynoExtensions`, …     | `@heroku/sdk/extensions/platform` |
+| `databaseExtensions`, …                  | `@heroku/sdk/extensions/data`     |
+
+## Development
+
+### Prerequisites
+
+- Node.js 22 (see `.tool-versions`)
+
+### Install dependencies
+
+```sh
+npm install
+```
+
+### Build
+
+```sh
+npm run build
+```
+
+### Run tests
+
+```sh
+npm test
+```
+
+Run a single test file:
+
+```sh
+npm test -- src/core/dispatcher.test.ts
+```
+
+### Run examples
+
+```sh
+npm run example -- examples/basic-usage.ts
+```

package/dist/compositions/add-on.d.ts

@@ -0,0 +1,7 @@
+import type { HerokuApiClientOptions } from '@heroku/api-client';
+import type { AddOn } from '@heroku/types/3.sdk';
+export type AddOnOptions = {
+    clientOptions?: HerokuApiClientOptions;
+    signal?: AbortSignal;
+};
+export declare function upgrade(appIdentity: string, addOnIdentity: string, plan: string, options?: AddOnOptions): Promise<AddOn>;

package/dist/compositions/add-on.js

@@ -0,0 +1,6 @@
+import { createPlatformClient } from '../services/platform.js';
+export async function upgrade(appIdentity, addOnIdentity, plan, options = {}) {
+    options.signal?.throwIfAborted();
+    const client = createPlatformClient(options.clientOptions);
+    return client.addOn.update(appIdentity, addOnIdentity, { plan });
+}

package/dist/compositions/app.d.ts

@@ -0,0 +1,8 @@
+import type { HerokuApiClientOptions } from '@heroku/api-client';
+import type { App } from '@heroku/types/3.sdk';
+export type AppOptions = {
+    clientOptions?: HerokuApiClientOptions;
+    signal?: AbortSignal;
+};
+export declare function enableMaintenanceMode(appIdentity: string, options?: AppOptions): Promise<App>;
+export declare function disableMaintenanceMode(appIdentity: string, options?: AppOptions): Promise<App>;

package/dist/compositions/app.js

@@ -0,0 +1,11 @@
+import { createPlatformClient } from '../services/platform.js';
+export async function enableMaintenanceMode(appIdentity, options = {}) {
+    options.signal?.throwIfAborted();
+    const client = createPlatformClient(options.clientOptions);
+    return client.app.update(appIdentity, { maintenance: true });
+}
+export async function disableMaintenanceMode(appIdentity, options = {}) {
+    options.signal?.throwIfAborted();
+    const client = createPlatformClient(options.clientOptions);
+    return client.app.update(appIdentity, { maintenance: false });
+}

package/dist/compositions/dyno.d.ts

@@ -0,0 +1,17 @@
+import type { HerokuApiClientOptions } from '@heroku/api-client';
+import type { Formation, FormationBatchUpdateOpts, FormationUpdateOpts } from '@heroku/types/3.sdk';
+export type DynoOptions = {
+    clientOptions?: HerokuApiClientOptions;
+    signal?: AbortSignal;
+};
+export type ScaleDynosUpdate = FormationUpdateOpts & {
+    type: string;
+};
+export type RestartDynosTarget = {
+    dyno: string;
+} | {
+    type: string;
+};
+export declare function scaleDynos(appIdentity: string, updates: ScaleDynosUpdate, options?: DynoOptions): Promise<Formation>;
+export declare function scaleDynos(appIdentity: string, updates: FormationBatchUpdateOpts['updates'], options?: DynoOptions): Promise<Formation[]>;
+export declare function restartDynos(appIdentity: string, target?: RestartDynosTarget, options?: DynoOptions): Promise<void>;

package/dist/compositions/dyno.js

@@ -0,0 +1,23 @@
+import { createPlatformClient } from '../services/platform.js';
+export async function scaleDynos(appIdentity, updates, options = {}) {
+    options.signal?.throwIfAborted();
+    const client = createPlatformClient(options.clientOptions);
+    if (Array.isArray(updates)) {
+        return client.formation.batchUpdate(appIdentity, { updates });
+    }
+    const { type, ...body } = updates;
+    return client.formation.update(appIdentity, type, body);
+}
+export async function restartDynos(appIdentity, target, options = {}) {
+    options.signal?.throwIfAborted();
+    const client = createPlatformClient(options.clientOptions);
+    if (!target) {
+        await client.dyno.restartAll(appIdentity);
+        return;
+    }
+    if ('dyno' in target) {
+        await client.dyno.restart(appIdentity, target.dyno);
+        return;
+    }
+    await client.dyno.restartFormation(appIdentity, target.type);
+}

package/dist/compositions/pg.d.ts

@@ -0,0 +1,15 @@
+import type { HerokuApiClientOptions } from '@heroku/api-client';
+import type { DatabaseInfoResult, DatabasePrepareUpgradeResult, DatabaseRunUpgradeResult, MaintenanceInfoResult, PostgresDatabaseListCredentialsResult, TransferListByAppResult } from '@heroku/types/data';
+export type PgOptions = {
+    clientOptions?: HerokuApiClientOptions;
+    signal?: AbortSignal;
+};
+export type PgUpgradeOpts = {
+    version?: string;
+};
+export declare function describePgDatabase(appIdentity: string, addonIdentity?: string, options?: PgOptions): Promise<DatabaseInfoResult>;
+export declare function listPgCredentials(appIdentity: string, addonIdentity?: string, options?: PgOptions): Promise<PostgresDatabaseListCredentialsResult>;
+export declare function describePgMaintenance(appIdentity: string, addonIdentity?: string, options?: PgOptions): Promise<MaintenanceInfoResult>;
+export declare function listPgTransfers(appIdentity: string, options?: PgOptions): Promise<TransferListByAppResult>;
+export declare function runPgUpgrade(appIdentity: string, addonIdentity: string | undefined, body?: PgUpgradeOpts, options?: PgOptions): Promise<DatabaseRunUpgradeResult>;
+export declare function preparePgUpgrade(appIdentity: string, addonIdentity: string | undefined, body?: PgUpgradeOpts, options?: PgOptions): Promise<DatabasePrepareUpgradeResult>;

package/dist/compositions/pg.js

@@ -0,0 +1,56 @@
+import { createDataClient } from '../services/data.js';
+import { createPlatformClient } from '../services/platform.js';
+export async function describePgDatabase(appIdentity, addonIdentity, options = {}) {
+    options.signal?.throwIfAborted();
+    const addonId = await resolveAddonId(appIdentity, addonIdentity, options.clientOptions);
+    const data = createDataClient(options.clientOptions);
+    return data.database.info(addonId);
+}
+export async function listPgCredentials(appIdentity, addonIdentity, options = {}) {
+    options.signal?.throwIfAborted();
+    const addonId = await resolveAddonId(appIdentity, addonIdentity, options.clientOptions);
+    const data = createDataClient(options.clientOptions);
+    return data.postgresDatabase.listCredentials(addonId);
+}
+export async function describePgMaintenance(appIdentity, addonIdentity, options = {}) {
+    options.signal?.throwIfAborted();
+    const addonId = await resolveAddonId(appIdentity, addonIdentity, options.clientOptions);
+    const data = createDataClient(options.clientOptions);
+    return data.maintenance.info(addonId);
+}
+export async function listPgTransfers(appIdentity, options = {}) {
+    options.signal?.throwIfAborted();
+    const data = createDataClient(options.clientOptions);
+    return data.transfer.listByApp(appIdentity);
+}
+export async function runPgUpgrade(appIdentity, addonIdentity, body = {}, options = {}) {
+    options.signal?.throwIfAborted();
+    const addonId = await resolveAddonId(appIdentity, addonIdentity, options.clientOptions);
+    const data = createDataClient(options.clientOptions);
+    // Cast: routes.js declares hasRequestBody for runUpgrade but the generated
+    // HerokuClient interface omits the body param (Shogun spec lacks a request schema).
+    const runUpgrade = data.database.runUpgrade;
+    return runUpgrade(addonId, body);
+}
+export async function preparePgUpgrade(appIdentity, addonIdentity, body = {}, options = {}) {
+    options.signal?.throwIfAborted();
+    const addonId = await resolveAddonId(appIdentity, addonIdentity, options.clientOptions);
+    const data = createDataClient(options.clientOptions);
+    // See note on runPgUpgrade.
+    const prepareUpgrade = data.database.prepareUpgrade;
+    return prepareUpgrade(addonId, body);
+}
+async function resolveAddonId(appIdentity, addonIdentity, clientOptions) {
+    const platform = createPlatformClient(clientOptions);
+    const matches = await platform.addOnAttachment.resolution({
+        // eslint-disable-next-line camelcase
+        addon_attachment: addonIdentity ?? 'DATABASE_URL',
+        app: appIdentity,
+    });
+    const attachment = matches[0];
+    const addonId = attachment?.addon?.id;
+    if (!addonId) {
+        throw new Error(`Could not resolve add-on for ${appIdentity}${addonIdentity ? `::${addonIdentity}` : ''}`);
+    }
+    return addonId;
+}

package/dist/compositions/pipeline.d.ts

@@ -0,0 +1,33 @@
+import type { HerokuApiClientOptions } from '@heroku/api-client';
+import type { App, PipelineCoupling, PipelinePromotion, PipelinePromotionCreateOpts, PipelinePromotionTarget } from '@heroku/types/3.sdk';
+export type PipelineWarning = {
+    limit: number;
+    pipelineId: string;
+    type: 'apps_truncated';
+};
+export type ListPipelineAppsOptions = {
+    clientOptions?: HerokuApiClientOptions;
+    onWarning?: (warning: PipelineWarning) => void;
+    signal?: AbortSignal;
+};
+export type AppWithPipelineCoupling = App & {
+    pipelineCoupling: PipelineCoupling;
+};
+export type ReleaseStreamContext = {
+    stream: ReadableStream<Uint8Array>;
+    target: PipelinePromotionTarget;
+};
+export type PromotePipelineOptions = {
+    clientOptions?: HerokuApiClientOptions;
+    intervalMs?: number;
+    onReleaseStream?: (context: ReleaseStreamContext) => Promise<void> | void;
+    releaseStreamMaxAttempts?: number;
+    signal?: AbortSignal;
+    timeoutMs?: number;
+};
+export type PromotePipelineResult = {
+    promotion: PipelinePromotion;
+    targets: PipelinePromotionTarget[];
+};
+export declare function promotePipeline(body: PipelinePromotionCreateOpts, options?: PromotePipelineOptions): Promise<PromotePipelineResult>;
+export declare function listPipelineApps(pipelineId: string, options?: ListPipelineAppsOptions): Promise<AppWithPipelineCoupling[]>;

package/dist/compositions/pipeline.js

@@ -0,0 +1,146 @@
+import { HerokuApiClient } from '@heroku/api-client';
+import { createPlatformClient } from '../services/platform.js';
+const APPS_FILTER_LIMIT = 1000;
+const DEFAULT_INTERVAL_MS = 1000;
+const DEFAULT_RELEASE_STREAM_MAX_ATTEMPTS = 100;
+export async function promotePipeline(body, options = {}) {
+    const { clientOptions, intervalMs = DEFAULT_INTERVAL_MS, onReleaseStream, releaseStreamMaxAttempts = DEFAULT_RELEASE_STREAM_MAX_ATTEMPTS, signal, timeoutMs, } = options;
+    const platformClient = createPlatformClient(clientOptions);
+    const promotion = await platformClient.pipelinePromotion.create(body);
+    if (!promotion.id) {
+        throw new Error('Pipeline promotion response did not include an id');
+    }
+    const deadline = timeoutMs === undefined ? undefined : Date.now() + timeoutMs;
+    let streamHandled = false;
+    while (true) {
+        signal?.throwIfAborted();
+        // eslint-disable-next-line no-await-in-loop
+        const targets = await platformClient.pipelinePromotionTarget.list(promotion.id);
+        if (targets.every(target => target.status !== 'pending')) {
+            return { promotion, targets };
+        }
+        if (onReleaseStream
+            && !streamHandled
+            && targets.length === 1
+            && targets[0].release?.id
+            && targets[0].app?.id) {
+            streamHandled = true;
+            const target = targets[0];
+            // eslint-disable-next-line no-await-in-loop
+            const release = await platformClient.release.info(target.app.id, target.release.id);
+            if (release.output_stream_url) {
+                // eslint-disable-next-line no-await-in-loop
+                const stream = await fetchReleaseOutput(release.output_stream_url, releaseStreamMaxAttempts, intervalMs, signal);
+                // eslint-disable-next-line no-await-in-loop
+                await onReleaseStream({ stream, target });
+            }
+        }
+        if (deadline !== undefined && Date.now() >= deadline) {
+            throw new Error(`Pipeline promotion ${promotion.id} did not reach a terminal state within ${timeoutMs}ms`);
+        }
+        // eslint-disable-next-line no-await-in-loop
+        await wait(intervalMs, signal);
+    }
+}
+export async function listPipelineApps(pipelineId, options = {}) {
+    options.signal?.throwIfAborted();
+    const platformClient = createPlatformClient(options.clientOptions);
+    const allCouplings = await platformClient.pipelineCoupling.listByPipeline(pipelineId);
+    // Drop malformed couplings (no app id) before issuing the bulk filter call.
+    const couplings = allCouplings.filter(coupling => coupling.app?.id);
+    if (couplings.length === 0) {
+        return [];
+    }
+    let couplingsToResolve = couplings;
+    if (couplings.length > APPS_FILTER_LIMIT) {
+        if (!options.onWarning) {
+            throw new Error(`Pipeline ${pipelineId} has more than ${APPS_FILTER_LIMIT} apps. `
+                + 'Pass an onWarning handler to opt into a truncated result.');
+        }
+        options.onWarning({ limit: APPS_FILTER_LIMIT, pipelineId, type: 'apps_truncated' });
+        couplingsToResolve = couplings.slice(0, APPS_FILTER_LIMIT);
+    }
+    options.signal?.throwIfAborted();
+    // /filters/apps is a Platform bulk endpoint that's not in the SDK route
+    // registry, so call it through a raw HerokuApiClient. It accepts the
+    // standard platform Accept header but uses a different `.filters` suffix.
+    const apiClient = new HerokuApiClient({
+        ...options.clientOptions,
+        service: 'platform',
+    });
+    const ids = couplingsToResolve.map(coupling => coupling.app.id);
+    const response = await apiClient.post('/filters/apps', { in: { id: ids } }, {
+        headers: {
+            Accept: 'application/vnd.heroku+json; version=3.filters',
+            Range: `id ..; max=${APPS_FILTER_LIMIT};`,
+        },
+    });
+    const apps = (await response.json());
+    const couplingByAppId = new Map();
+    for (const coupling of couplingsToResolve) {
+        couplingByAppId.set(coupling.app.id, coupling);
+    }
+    return apps.map(app => ({
+        ...app,
+        pipelineCoupling: couplingByAppId.get(app.id),
+    }));
+}
+async function fetchReleaseOutput(url, maxAttempts, intervalMs, signal) {
+    const parsed = new URL(url);
+    const path = `${parsed.pathname}${parsed.search}`;
+    // The release output URL points at a third-party stream host (e.g. busl).
+    // Use a custom-service client so the platform prefixUrl and bearer token
+    // don't leak across origins.
+    const buslClient = new HerokuApiClient({
+        baseUrl: parsed.origin,
+        service: 'custom',
+        token: '',
+    });
+    let attempt = 0;
+    while (true) {
+        signal?.throwIfAborted();
+        attempt++;
+        let response;
+        try {
+            // eslint-disable-next-line no-await-in-loop
+            response = await buslClient.stream(path, { headers: { Accept: '*/*' } });
+        }
+        catch {
+            // Treat HTTP errors thrown by the api-client as a retryable miss.
+            response = undefined;
+        }
+        if (response?.ok && response.body) {
+            return response.body;
+        }
+        if (response?.body) {
+            // Drain so the connection can be reused.
+            // eslint-disable-next-line no-await-in-loop
+            await response.body.cancel().catch(() => { });
+        }
+        if (attempt >= maxAttempts) {
+            throw new Error('stream release output not available');
+        }
+        // eslint-disable-next-line no-await-in-loop
+        await wait(intervalMs, signal);
+    }
+}
+function wait(ms, signal) {
+    return new Promise((resolve, reject) => {
+        function onAbort() {
+            clearTimeout(timer);
+            reject(signal.reason ?? new Error('Aborted'));
+        }
+        const timer = setTimeout(() => {
+            signal?.removeEventListener('abort', onAbort);
+            resolve();
+        }, ms);
+        if (signal) {
+            if (signal.aborted) {
+                clearTimeout(timer);
+                reject(signal.reason ?? new Error('Aborted'));
+                return;
+            }
+            signal.addEventListener('abort', onAbort, { once: true });
+        }
+    });
+}

package/dist/core/create-client.d.ts

@@ -0,0 +1,32 @@
+import type { HerokuApiClientOptions, RequestOptions } from '@heroku/heroku-fetch';
+import type { RouteDefinition } from '@heroku/types/types';
+type RoutesModule = Record<string, Record<string, RouteDefinition>>;
+/**
+ * Subset of `RequestOptions` that makes sense to apply across every
+ * call on a derived client. Per-call concerns like `searchParams`
+ * and `stream` are deliberately excluded — those belong on the
+ * individual route call, not on the client wrapper.
+ */
+export type StickyRouteOptions = Pick<RequestOptions, 'headers' | 'signal' | 'timeout'>;
+/**
+ * Methods available on every routes-generated client in addition to
+ * the resources/methods generated from the routes registry.
+ */
+export type RoutesClientExtras<T> = {
+    /**
+     * Convenience wrapper around `withOptions({headers})`. Kept for
+     * backward compatibility; new code should prefer `withOptions`.
+     */
+    withHeaders(headers: Record<string, string>): RoutesClientExtras<T> & T;
+    /**
+     * Returns a same-shaped client where each route call applies the
+     * provided options. Caller-supplied headers override the api-client's
+     * defaults; subsequent `withOptions` calls layer headers and replace
+     * signal / timeout.
+     *
+     * The original client is not mutated.
+     */
+    withOptions(options: StickyRouteOptions): RoutesClientExtras<T> & T;
+};
+export declare function createClient<T>(routes: RoutesModule, options?: HerokuApiClientOptions): RoutesClientExtras<T> & T;
+export {};