@heroku/sdk 0.1.0-beta.0 → 0.2.0-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heroku/sdk",
-  "version": "0.1.0-beta.0",
+  "version": "0.2.0-beta.0",
   "description": "Heroku SDK",
   "author": "Heroku",
   "type": "module",

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

@@ -1,7 +0,0 @@
-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

@@ -1,6 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,11 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,56 +0,0 @@
-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

@@ -1,33 +0,0 @@
-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

@@ -1,146 +0,0 @@
-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/resources/data/backup.d.ts

@@ -1,9 +0,0 @@
-import type { BackupCreateResult } from '@heroku/types/data';
-import type { ResourceCtx } from '../../core/extend-resource.js';
-export type BackupOptions = {
-    signal?: AbortSignal;
-};
-export declare function create(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, options?: BackupOptions): Promise<BackupCreateResult>;
-export declare const backupExtensions: import("../../index.js").ResourceExtension<"data", "backup", {
-    create: (appIdentity: string, addonIdentity?: string, options?: BackupOptions) => Promise<BackupCreateResult>;
-}>;

package/dist/resources/data/backup.js

@@ -1,10 +0,0 @@
-import { extendResource } from '../../core/extend-resource.js';
-import { resolvePgDatabase } from './internal/resolve-pg-database.js';
-export async function create(ctx, appIdentity, addonIdentity, options = {}) {
-    options.signal?.throwIfAborted();
-    const addon = await resolvePgDatabase(ctx, { appIdentity, input: addonIdentity, ...options });
-    return ctx.data.backup.create(addon.id);
-}
-export const backupExtensions = extendResource('data', 'backup', ctx => ({
-    create: (appIdentity, addonIdentity, options) => create(ctx, appIdentity, addonIdentity, options),
-}));

package/dist/resources/data/internal/resolve-addon-id.d.ts

@@ -1,2 +0,0 @@
-import type { PlatformClient } from '../../../services/platform.js';
-export declare function resolveAddonId(platform: PlatformClient, appIdentity: string, addonIdentity?: string): Promise<string>;

package/dist/resources/data/internal/resolve-addon-id.js

@@ -1,13 +0,0 @@
-export async function resolveAddonId(platform, appIdentity, addonIdentity) {
-    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/resources/data/postgres-credential.d.ts

@@ -1,11 +0,0 @@
-import type { PostgresCredentialInfoResult, PostgresCredentialListResult } from '@heroku/types/data';
-import type { ResourceCtx } from '../../core/extend-resource.js';
-export type PostgresCredentialOptions = {
-    signal?: AbortSignal;
-};
-export declare function list(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, options?: PostgresCredentialOptions): Promise<PostgresCredentialListResult>;
-export declare function info(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, credName: string, addonIdentity?: string, options?: PostgresCredentialOptions): Promise<PostgresCredentialInfoResult>;
-export declare const postgresCredentialExtensions: import("../../index.js").ResourceExtension<"data", "postgresCredential", {
-    info: (appIdentity: string, credName: string, addonIdentity?: string, options?: PostgresCredentialOptions) => Promise<PostgresCredentialInfoResult>;
-    list: (appIdentity: string, addonIdentity?: string, options?: PostgresCredentialOptions) => Promise<PostgresCredentialListResult>;
-}>;

package/dist/resources/data/postgres-credential.js

@@ -1,16 +0,0 @@
-import { extendResource } from '../../core/extend-resource.js';
-import { resolvePgDatabase } from './internal/resolve-pg-database.js';
-export async function list(ctx, appIdentity, addonIdentity, options = {}) {
-    options.signal?.throwIfAborted();
-    const addon = await resolvePgDatabase(ctx, { appIdentity, input: addonIdentity, ...options });
-    return ctx.data.postgresCredential.list(addon.id);
-}
-export async function info(ctx, appIdentity, credName, addonIdentity, options = {}) {
-    options.signal?.throwIfAborted();
-    const addon = await resolvePgDatabase(ctx, { appIdentity, input: addonIdentity, ...options });
-    return ctx.data.postgresCredential.info(addon.id, credName);
-}
-export const postgresCredentialExtensions = extendResource('data', 'postgresCredential', ctx => ({
-    info: (appIdentity, credName, addonIdentity, options) => info(ctx, appIdentity, credName, addonIdentity, options),
-    list: (appIdentity, addonIdentity, options) => list(ctx, appIdentity, addonIdentity, options),
-}));

package/dist/resources/data/postgres.d.ts

@@ -1,9 +0,0 @@
-import type { PostgresInfoResult } from '@heroku/types/data';
-import type { ResourceCtx } from '../../core/extend-resource.js';
-export type PostgresOptions = {
-    signal?: AbortSignal;
-};
-export declare function info(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, options?: PostgresOptions): Promise<PostgresInfoResult>;
-export declare const postgresExtensions: import("../../index.js").ResourceExtension<"data", "postgres", {
-    info: (appIdentity: string, addonIdentity?: string, options?: PostgresOptions) => Promise<PostgresInfoResult>;
-}>;

package/dist/resources/data/postgres.js

@@ -1,10 +0,0 @@
-import { extendResource } from '../../core/extend-resource.js';
-import { resolvePgDatabase } from './internal/resolve-pg-database.js';
-export async function info(ctx, appIdentity, addonIdentity, options = {}) {
-    options.signal?.throwIfAborted();
-    const addon = await resolvePgDatabase(ctx, { appIdentity, input: addonIdentity, ...options });
-    return ctx.data.postgres.info(addon.id);
-}
-export const postgresExtensions = extendResource('data', 'postgres', ctx => ({
-    info: (appIdentity, addonIdentity, options) => info(ctx, appIdentity, addonIdentity, options),
-}));

package/dist/resources/data/transfer-schedule.d.ts

@@ -1,9 +0,0 @@
-import type { TransferScheduleListResult } from '@heroku/types/data';
-import type { ResourceCtx } from '../../core/extend-resource.js';
-export type TransferScheduleOptions = {
-    signal?: AbortSignal;
-};
-export declare function list(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, options?: TransferScheduleOptions): Promise<TransferScheduleListResult>;
-export declare const transferScheduleExtensions: import("../../index.js").ResourceExtension<"data", "transferSchedule", {
-    list: (appIdentity: string, addonIdentity?: string, options?: TransferScheduleOptions) => Promise<TransferScheduleListResult>;
-}>;

package/dist/resources/data/transfer-schedule.js

@@ -1,10 +0,0 @@
-import { extendResource } from '../../core/extend-resource.js';
-import { resolvePgDatabase } from './internal/resolve-pg-database.js';
-export async function list(ctx, appIdentity, addonIdentity, options = {}) {
-    options.signal?.throwIfAborted();
-    const addon = await resolvePgDatabase(ctx, { appIdentity, input: addonIdentity, ...options });
-    return ctx.data.transferSchedule.list(addon.id);
-}
-export const transferScheduleExtensions = extendResource('data', 'transferSchedule', ctx => ({
-    list: (appIdentity, addonIdentity, options) => list(ctx, appIdentity, addonIdentity, options),
-}));