@heroku/sdk 0.11.1 → 0.11.2

package/dist/resources/platform/review-app-config/resolve-repo-name.js

@@ -1,3 +1,4 @@
+import { withSignal } from '../../../core/with-signal.js';
 import { debug } from './debug.js';
 /**
  * Resolves the GitHub repository name for a canonical pipeline ID.
@@ -9,7 +10,7 @@ import { debug } from './debug.js';
 export async function resolveRepoName(ctx, pipelineId, options = {}) {
     const { signal } = options;
     signal?.throwIfAborted();
-    const platform = signal ? ctx.platform.withOptions({ signal }) : ctx.platform;
+    const platform = withSignal(ctx.platform, signal);
     let useRepositoriesApi;
     try {
         const feature = await platform.accountFeature.info('dashboard-repositories-api');
@@ -22,7 +23,7 @@ export async function resolveRepoName(ctx, pipelineId, options = {}) {
     }
     if (useRepositoriesApi) {
         try {
-            const repositoriesApi = signal ? ctx.repositoriesApi.withOptions({ signal }) : ctx.repositoriesApi;
+            const repositoriesApi = withSignal(ctx.repositoriesApi, signal);
             const repository = await repositoriesApi.githubRepository.info(pipelineId);
             signal?.throwIfAborted();
             const repositoryName = repository.full_name?.trim();
@@ -40,7 +41,7 @@ export async function resolveRepoName(ctx, pipelineId, options = {}) {
         signal?.throwIfAborted();
         debug('repositories API disabled; falling back');
     }
-    const repositories = signal ? ctx.repositories.withOptions({ signal }) : ctx.repositories;
+    const repositories = withSignal(ctx.repositories, signal);
     const pipelineRepository = await repositories.pipelineRepository.info(pipelineId);
     signal?.throwIfAborted();
     const repositoryName = pipelineRepository.repository.name.trim();

package/dist/resources/platform/sni-endpoint/create-and-associate.js

@@ -1,3 +1,4 @@
+import { withSignal } from '../../../core/with-signal.js';
 import { waitForReady } from '../domain/wait-for-ready.js';
 const DEFAULT_WAIT_INTERVAL_MS = 1000;
 const DEFAULT_TIMEOUT_MS = 30_000;
@@ -35,7 +36,7 @@ const DEFAULT_TIMEOUT_MS = 30_000;
 export async function createAndAssociate(ctx, appIdentity, certificateChain, privateKey, options) {
     const { domainPoller, intervalMs = DEFAULT_WAIT_INTERVAL_MS, resolveDomains, signal, timeoutMs = DEFAULT_TIMEOUT_MS, } = options;
     signal?.throwIfAborted();
-    const platform = signal ? ctx.platform.withOptions({ signal }) : ctx.platform;
+    const platform = withSignal(ctx.platform, signal);
     const sniEndpoint = await platform.sniEndpoint.create(appIdentity, {
         certificate_chain: certificateChain,
         private_key: privateKey,

package/dist/resources/platform/space/wait-for-allocated.js

@@ -1,3 +1,4 @@
+import { withSignal } from '../../../core/with-signal.js';
 import { wait } from '../../../utils/wait.js';
 import { SpaceNotAllocatedError, SpaceNotReadyError } from './errors.js';
 const DEFAULT_INTERVAL_MS = 5000;
@@ -22,10 +23,7 @@ const DEFAULT_TIMEOUT_MS = 20 * 60 * 1000;
 export async function waitForAllocated(ctx, name, options = {}) {
     const { includeNat, intervalMs = DEFAULT_INTERVAL_MS, signal, timeoutMs = DEFAULT_TIMEOUT_MS, } = options;
     signal?.throwIfAborted();
-    let platform = ctx.platform.withHeaders({ 'Accept-Expansion': 'region' });
-    if (signal) {
-        platform = platform.withOptions({ signal });
-    }
+    const platform = withSignal(ctx.platform.withHeaders({ 'Accept-Expansion': 'region' }), signal);
     const deadline = Date.now() + timeoutMs;
     let space = await platform.space.info(name);
     while (space.state === 'allocating') {

package/dist/resources/platform/team.d.ts

@@ -0,0 +1,22 @@
+import type { Team, TeamDelinquency } from '@heroku/types/3.sdk';
+import type { ResourceCtx } from '../../core/extend-resource.js';
+export type GetTeamWithDelinquencyOptions = {
+    signal?: AbortSignal;
+};
+export type TeamWithDelinquency = {
+    delinquency: null | TeamDelinquency;
+    team: Team;
+};
+/**
+ * Fetch a team together with its delinquency status.
+ *
+ * Runs the two reads concurrently. The team lookup hard-fails — there is no
+ * result without it. The delinquency lookup soft-fails to `null`: a hiccup on
+ * that secondary call must not sink an otherwise-successful team fetch. Callers
+ * decide whether and how to surface a warning from `delinquency` —
+ * `formatDelinquencyWarning` renders the sentence.
+ */
+export declare function getTeamWithDelinquency(ctx: Pick<ResourceCtx, 'platform'>, teamIdentity: string, options?: GetTeamWithDelinquencyOptions): Promise<TeamWithDelinquency>;
+export declare const teamExtensions: import("../../core/extend-resource.js").ResourceExtension<"platform", "team", {
+    getWithDelinquency: (teamIdentity: string, options?: GetTeamWithDelinquencyOptions) => Promise<TeamWithDelinquency>;
+}>;

package/dist/resources/platform/team.js

@@ -0,0 +1,34 @@
+import createDebug from 'debug';
+import { extendResource } from '../../core/extend-resource.js';
+const debug = createDebug('heroku:sdk:resources:team');
+/**
+ * Fetch a team together with its delinquency status.
+ *
+ * Runs the two reads concurrently. The team lookup hard-fails — there is no
+ * result without it. The delinquency lookup soft-fails to `null`: a hiccup on
+ * that secondary call must not sink an otherwise-successful team fetch. Callers
+ * decide whether and how to surface a warning from `delinquency` —
+ * `formatDelinquencyWarning` renders the sentence.
+ */
+export async function getTeamWithDelinquency(ctx, teamIdentity, options = {}) {
+    options.signal?.throwIfAborted();
+    const platform = options.signal
+        ? ctx.platform.withOptions({ signal: options.signal })
+        : ctx.platform;
+    const [team, delinquency] = await Promise.all([
+        platform.team.info(teamIdentity),
+        platform.teamDelinquency.info(teamIdentity).catch((error) => {
+            // Soft-fail a secondary-call hiccup to null, but rethrow a cancellation:
+            // if the caller aborted, returning null would misreport a delinquent team
+            // as current. Anything else is logged and swallowed.
+            if (options.signal?.aborted)
+                throw error;
+            debug('team delinquency lookup failed; treating as not delinquent: %O', error);
+            return null;
+        }),
+    ]);
+    return { delinquency, team };
+}
+export const teamExtensions = extendResource('platform', 'team', ctx => ({
+    getWithDelinquency: (teamIdentity, options) => getTeamWithDelinquency(ctx, teamIdentity, options),
+}));

package/dist/resources/platform/telemetry-drain/remove-drains-for-target.js

@@ -1,3 +1,4 @@
+import { withSignal } from '../../../core/with-signal.js';
 /**
  * Remove all telemetry drains for a given app or space.
  *
@@ -11,7 +12,7 @@ export async function removeDrainsForTarget(ctx, target, options = {}) {
     const { signal } = options;
     const { app, space } = target;
     signal?.throwIfAborted();
-    const platform = signal ? ctx.platform.withOptions({ signal }) : ctx.platform;
+    const platform = withSignal(ctx.platform, signal);
     let drains = [];
     if (app) {
         drains = await platform.telemetryDrain.listByApp(app);

package/dist/resources/platform/test-run/wait-for-state.js

@@ -1,3 +1,4 @@
+import { withSignal } from '../../../core/with-signal.js';
 import { wait } from '../../../utils/wait.js';
 const DEFAULT_INTERVAL_MS = 1000;
 // Finite default so a stuck CI test run can't hang a caller forever.
@@ -48,7 +49,7 @@ export async function waitForState(ctx, pipelineId, testRunNumber, targetStates,
     signal?.throwIfAborted();
     // Scope the in-flight info call to the caller's signal so an abort takes
     // effect during the API call, not just during the backoff.
-    const platform = signal ? ctx.platform.withOptions({ signal }) : ctx.platform;
+    const platform = withSignal(ctx.platform, signal);
     const deadline = Date.now() + timeoutMs;
     while (true) {
         signal?.throwIfAborted();

package/dist/resources/platform/vpn-connection/wait-for-active.js

@@ -1,3 +1,4 @@
+import { withSignal } from '../../../core/with-signal.js';
 import { wait } from '../../../utils/wait.js';
 const DEFAULT_INTERVAL_MS = 10 * 1000;
 const DEFAULT_TIMEOUT_MS = 20 * 60 * 1000;
@@ -28,7 +29,7 @@ export class VpnConnectionNotReadyError extends Error {
 export async function waitForActive(ctx, spaceIdentity, vpnConnectionIdentity, options = {}) {
     const { intervalMs = DEFAULT_INTERVAL_MS, poller, signal, timeoutMs = DEFAULT_TIMEOUT_MS, } = options;
     signal?.throwIfAborted();
-    const platform = signal ? ctx.platform.withOptions({ signal }) : ctx.platform;
+    const platform = withSignal(ctx.platform, signal);
     const deadline = Date.now() + timeoutMs;
     let vpnConnection = await platform.vpnConnection.info(spaceIdentity, vpnConnectionIdentity);
     poller?.onStart?.(vpnConnection);

package/dist/utils/is-abort-error.d.ts

@@ -0,0 +1,11 @@
+/**
+ * True when `error` is the standard `AbortError` raised for a cancelled
+ * request: `fetch`/`ky` reject an aborted request with a `DOMException` named
+ * `AbortError`, and `signal.throwIfAborted()` throws the same shape by default.
+ *
+ * Used so soft-failure handling (broad `.catch` defaults, retry loops) can let
+ * cancellation propagate instead of swallowing it or treating it as retryable.
+ * Pair it with `signal?.aborted` at the call site to also catch a custom-reason
+ * abort (`controller.abort(reason)`) or an `AbortSignal.timeout()` deadline.
+ */
+export declare function isAbortError(error: unknown): boolean;

package/dist/utils/is-abort-error.js

@@ -0,0 +1,14 @@
+/**
+ * True when `error` is the standard `AbortError` raised for a cancelled
+ * request: `fetch`/`ky` reject an aborted request with a `DOMException` named
+ * `AbortError`, and `signal.throwIfAborted()` throws the same shape by default.
+ *
+ * Used so soft-failure handling (broad `.catch` defaults, retry loops) can let
+ * cancellation propagate instead of swallowing it or treating it as retryable.
+ * Pair it with `signal?.aborted` at the call site to also catch a custom-reason
+ * abort (`controller.abort(reason)`) or an `AbortSignal.timeout()` deadline.
+ */
+export function isAbortError(error) {
+    return ((error instanceof Error || error instanceof DOMException)
+        && error.name === 'AbortError');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heroku/sdk",
-  "version": "0.11.1",
+  "version": "0.11.2",
   "description": "Heroku SDK",
   "author": "Heroku",
   "type": "module",