@heroku/sdk 0.12.1 → 0.12.2

package/README.md

@@ -133,6 +133,7 @@ const favorites = await dashboardBackend.favorite.list({ type: 'app' })
 | `createRepositoriesClient`, `RepositoriesClient` | `@heroku/sdk/repositories` |
 | `createRepositoriesApiClient`, `RepositoriesApiClient` | `@heroku/sdk/repositories-api` |
 | `appExtensions`, `dynoExtensions`, …     | `@heroku/sdk/extensions/platform` |
+| `favoriteExtensions`, `addByAppName`, `removeByAppName`, favorite errors and types | `@heroku/sdk/extensions/dashboard-backend` |
 | `databaseExtensions`, …                  | `@heroku/sdk/extensions/data`     |
 
 ## Development

package/dist/core/dispatcher.js

@@ -7,11 +7,22 @@ function hasCallerRangeHeader(requestOptions) {
         return false;
     return Object.keys(requestOptions.headers).some(k => k.toLowerCase() === 'range');
 }
+function redactEmailPathSegments(path) {
+    return path.split('/').map(segment => {
+        try {
+            return decodeURIComponent(segment).includes('@') ? '[REDACTED]' : segment;
+        }
+        catch {
+            return segment;
+        }
+    }).join('/');
+}
 export async function dispatch(client, route, args, invocation, requestOptions) {
     const placeholderCount = countPlaceholders(route.path);
     const pathParams = args.slice(0, placeholderCount);
     const remaining = args.slice(placeholderCount);
     const path = interpolatePath(route.path, pathParams);
+    const debugPath = redactEmailPathSegments(path);
     let body;
     if (route.hasRequestBody && remaining.length > 0) {
         body = remaining[0];
@@ -30,7 +41,7 @@ export async function dispatch(client, route, args, invocation, requestOptions)
             effectiveOptions = { ...requestOptions, searchParams };
         }
     }
-    debug('%s %s %s -> %s hasBody=%s', invocation ?? 'dispatch', route.method, route.path, path, body !== undefined);
+    debug('%s %s %s -> %s hasBody=%s', invocation ?? 'dispatch', route.method, route.path, debugPath, body !== undefined);
     const response = await callMethod(client, route.method, path, body, effectiveOptions);
     const contentLength = response.headers.get('content-length');
     if (response.status === 204 || contentLength === '0') {
@@ -87,7 +98,7 @@ function callMethod(client, method, path, body, requestOptions) {
             return requestOptions ? client.put(path, body, requestOptions) : client.put(path, body);
         }
         default: {
-            debug('unsupported HTTP method=%s path=%s', method, path);
+            debug('unsupported HTTP method=%s path=%s', method, redactEmailPathSegments(path));
             throw new Error(`Unsupported HTTP method: ${method}`);
         }
     }

package/dist/resources/dashboard-backend/favorite/add-by-app-name.d.ts

@@ -0,0 +1,7 @@
+import type { FavoriteCreateResult } from '@heroku/types/dashboard-backend';
+import type { ResourceCtx } from '../../../core/extend-resource.js';
+export type FavoriteOptions = {
+    signal?: AbortSignal;
+};
+/** Add an app to the current user's favorites by its exact app name. */
+export declare function addByAppName(ctx: Pick<ResourceCtx, 'dashboardBackend'>, appName: string, options?: FavoriteOptions): Promise<FavoriteCreateResult | void>;

package/dist/resources/dashboard-backend/favorite/add-by-app-name.js

@@ -0,0 +1,33 @@
+import { withSignal } from '../../../core/with-signal.js';
+import { isAbortError } from '../../../utils/is-abort-error.js';
+import { AlreadyFavoriteError, AppNotFoundError, FavoriteCreateError } from './errors.js';
+/** Add an app to the current user's favorites by its exact app name. */
+export async function addByAppName(ctx, appName, options = {}) {
+    const { signal } = options;
+    signal?.throwIfAborted();
+    const dashboardBackend = withSignal(ctx.dashboardBackend, signal);
+    const favorites = await dashboardBackend.favorite.list({ type: 'app' });
+    signal?.throwIfAborted();
+    if (favorites.some(favorite => favorite.resource_name === appName)) {
+        throw new AlreadyFavoriteError(appName);
+    }
+    try {
+        return await dashboardBackend.favorite.create({ resource_id: appName, type: 'app' });
+    }
+    catch (error) {
+        // Preserve request cancellation, including custom abort reasons, but don't
+        // let an unrelated abort race mask the create request's actual failure.
+        if (isAbortError(error) || (signal?.aborted && error === signal.reason))
+            throw error;
+        if (isNotFound(error)) {
+            throw new AppNotFoundError(appName, error);
+        }
+        throw new FavoriteCreateError(appName, error);
+    }
+}
+function isNotFound(error) {
+    return (typeof error === 'object'
+        && error !== null
+        && 'statusCode' in error
+        && error.statusCode === 404);
+}

package/dist/resources/dashboard-backend/favorite/errors.d.ts

@@ -0,0 +1,16 @@
+export declare class AlreadyFavoriteError extends Error {
+    readonly appName: string;
+    constructor(appName: string);
+}
+export declare class NotFavoriteError extends Error {
+    readonly appName: string;
+    constructor(appName: string);
+}
+export declare class AppNotFoundError extends Error {
+    readonly appName: string;
+    constructor(appName: string, cause: unknown);
+}
+export declare class FavoriteCreateError extends Error {
+    readonly appName: string;
+    constructor(appName: string, cause: unknown);
+}

package/dist/resources/dashboard-backend/favorite/errors.js

@@ -0,0 +1,32 @@
+export class AlreadyFavoriteError extends Error {
+    appName;
+    constructor(appName) {
+        super(`App ${appName} is already a favorite.`);
+        this.appName = appName;
+        this.name = 'AlreadyFavoriteError';
+    }
+}
+export class NotFavoriteError extends Error {
+    appName;
+    constructor(appName) {
+        super(`App ${appName} is not a favorite.`);
+        this.appName = appName;
+        this.name = 'NotFavoriteError';
+    }
+}
+export class AppNotFoundError extends Error {
+    appName;
+    constructor(appName, cause) {
+        super(`Couldn't find app ${appName}.`, { cause });
+        this.appName = appName;
+        this.name = 'AppNotFoundError';
+    }
+}
+export class FavoriteCreateError extends Error {
+    appName;
+    constructor(appName, cause) {
+        super(`Failed to add app ${appName} as a favorite.`, { cause });
+        this.appName = appName;
+        this.name = 'FavoriteCreateError';
+    }
+}

package/dist/resources/dashboard-backend/favorite/index.d.ts

@@ -0,0 +1,8 @@
+import type { FavoriteOptions } from './add-by-app-name.js';
+export { addByAppName, type FavoriteOptions } from './add-by-app-name.js';
+export { AlreadyFavoriteError, AppNotFoundError, FavoriteCreateError, NotFavoriteError, } from './errors.js';
+export { removeByAppName } from './remove-by-app-name.js';
+export declare const favoriteExtensions: import("../../../core/extend-resource.js").ResourceExtension<"dashboardBackend", "favorite", {
+    addByAppName: (appName: string, options?: FavoriteOptions) => Promise<void | import("@heroku/types/dashboard-backend").FavoriteCreateResult>;
+    removeByAppName: (appName: string, options?: FavoriteOptions) => Promise<void>;
+}>;

package/dist/resources/dashboard-backend/favorite/index.js

@@ -0,0 +1,10 @@
+import { extendResource } from '../../../core/extend-resource.js';
+import { addByAppName } from './add-by-app-name.js';
+import { removeByAppName } from './remove-by-app-name.js';
+export { addByAppName } from './add-by-app-name.js';
+export { AlreadyFavoriteError, AppNotFoundError, FavoriteCreateError, NotFavoriteError, } from './errors.js';
+export { removeByAppName } from './remove-by-app-name.js';
+export const favoriteExtensions = extendResource('dashboardBackend', 'favorite', ctx => ({
+    addByAppName: (appName, options) => addByAppName(ctx, appName, options),
+    removeByAppName: (appName, options) => removeByAppName(ctx, appName, options),
+}));

package/dist/resources/dashboard-backend/favorite/remove-by-app-name.d.ts

@@ -0,0 +1,4 @@
+import type { ResourceCtx } from '../../../core/extend-resource.js';
+import type { FavoriteOptions } from './add-by-app-name.js';
+/** Remove an app from the current user's favorites by its exact app name. */
+export declare function removeByAppName(ctx: Pick<ResourceCtx, 'dashboardBackend'>, appName: string, options?: FavoriteOptions): Promise<void>;

package/dist/resources/dashboard-backend/favorite/remove-by-app-name.js

@@ -0,0 +1,15 @@
+import { withSignal } from '../../../core/with-signal.js';
+import { NotFavoriteError } from './errors.js';
+/** Remove an app from the current user's favorites by its exact app name. */
+export async function removeByAppName(ctx, appName, options = {}) {
+    const { signal } = options;
+    signal?.throwIfAborted();
+    const dashboardBackend = withSignal(ctx.dashboardBackend, signal);
+    const favorites = await dashboardBackend.favorite.list({ type: 'app' });
+    signal?.throwIfAborted();
+    const favorite = favorites.find(candidate => candidate.resource_name === appName);
+    if (!favorite) {
+        throw new NotFavoriteError(appName);
+    }
+    await dashboardBackend.favorite.delete(favorite.id);
+}

package/dist/resources/extensions/dashboard-backend.d.ts

@@ -0,0 +1 @@
+export { addByAppName, AlreadyFavoriteError, AppNotFoundError, FavoriteCreateError, favoriteExtensions, type FavoriteOptions, NotFavoriteError, removeByAppName, } from '../dashboard-backend/favorite/index.js';

package/dist/resources/extensions/dashboard-backend.js

@@ -0,0 +1 @@
+export { addByAppName, AlreadyFavoriteError, AppNotFoundError, FavoriteCreateError, favoriteExtensions, NotFavoriteError, removeByAppName, } from '../dashboard-backend/favorite/index.js';

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

@@ -1,6 +1,7 @@
 export { accountExtensions, type AccountWithDelinquency, type GetAccountWithDelinquencyOptions } from '../platform/account.js';
 export { addOnAttachmentExtensions } from '../platform/add-on-attachment/index.js';
 export { addOnExtensions } from '../platform/add-on/index.js';
+export { appCollaboratorExtensions, type BeforeRemove, type RemoveSelfOptions, } from '../platform/app-collaborator/index.js';
 export { appExtensions, type AppInfo, type DiffAppsOptions, type DiffRow, type PipelineCouplingDetail, } from '../platform/app/index.js';
 export { containerExtensions, type DockerReleasesBatchUpdateOpts, NotAContainerAppError, type ReleaseDockerImagesResult, type RemoveProcessTypesOpts, } from '../platform/container/index.js';
 export { type DelinquencyResource, type DelinquencySchedule, formatDelinquencyWarning, } from '../platform/delinquency.js';
@@ -14,6 +15,7 @@ export { type ResolveRepoNameOptions, reviewAppConfigExtensions } from '../platf
 export { privateToShield, shieldToPrivate } from '../platform/shield.js';
 export { createAndAssociate, type CreateAndAssociateOptions, sniEndpointExtensions } from '../platform/sni-endpoint/index.js';
 export { spaceExtensions, SpaceNotAllocatedError, SpaceNotReadyError, type SpaceOptions, type SpaceWithNat, waitForAllocated, type WaitForAllocatedOptions, } from '../platform/space/index.js';
+export { type JoinSelfOptions, teamAppExtensions } from '../platform/team-app/index.js';
 export { type GetTeamWithDelinquencyOptions, teamExtensions, type TeamWithDelinquency } from '../platform/team.js';
 export { telemetryDrainExtensions, type TelemetryDrainOptions, type TelemetryDrainTarget } from '../platform/telemetry-drain/index.js';
 export { testRunExtensions, TestRunNotReadyError, type TestRunStatus, waitForState, type WaitForStateOptions, } from '../platform/test-run/index.js';

package/dist/resources/extensions/platform.js

@@ -1,6 +1,7 @@
 export { accountExtensions } from '../platform/account.js';
 export { addOnAttachmentExtensions } from '../platform/add-on-attachment/index.js';
 export { addOnExtensions } from '../platform/add-on/index.js';
+export { appCollaboratorExtensions, } from '../platform/app-collaborator/index.js';
 export { appExtensions, } from '../platform/app/index.js';
 export { containerExtensions, NotAContainerAppError, } from '../platform/container/index.js';
 export { formatDelinquencyWarning, } from '../platform/delinquency.js';
@@ -14,6 +15,7 @@ export { reviewAppConfigExtensions } from '../platform/review-app-config/index.j
 export { privateToShield, shieldToPrivate } from '../platform/shield.js';
 export { createAndAssociate, sniEndpointExtensions } from '../platform/sni-endpoint/index.js';
 export { spaceExtensions, SpaceNotAllocatedError, SpaceNotReadyError, waitForAllocated, } from '../platform/space/index.js';
+export { teamAppExtensions } from '../platform/team-app/index.js';
 export { teamExtensions } from '../platform/team.js';
 export { telemetryDrainExtensions } from '../platform/telemetry-drain/index.js';
 export { testRunExtensions, TestRunNotReadyError, waitForState, } from '../platform/test-run/index.js';

package/dist/resources/platform/app-collaborator/index.d.ts

@@ -0,0 +1,5 @@
+import type { RemoveSelfOptions } from './remove-self.js';
+export { type BeforeRemove, removeSelf, type RemoveSelfOptions } from './remove-self.js';
+export declare const appCollaboratorExtensions: import("../../../core/extend-resource.js").ResourceExtension<"platform", "appCollaborator", {
+    removeSelf: (appIdentity: string, options?: RemoveSelfOptions) => Promise<import("@heroku/types/3.sdk").Collaborator>;
+}>;

package/dist/resources/platform/app-collaborator/index.js

@@ -0,0 +1,6 @@
+import { extendResource } from '../../../core/extend-resource.js';
+import { removeSelf } from './remove-self.js';
+export { removeSelf } from './remove-self.js';
+export const appCollaboratorExtensions = extendResource('platform', 'appCollaborator', ctx => ({
+    removeSelf: (appIdentity, options) => removeSelf(ctx, appIdentity, options),
+}));

package/dist/resources/platform/app-collaborator/remove-self.d.ts

@@ -0,0 +1,10 @@
+import type { Collaborator } from '@heroku/types/3.sdk';
+import type { ResourceCtx } from '../../../core/extend-resource.js';
+import type { AccountWithDelinquency } from '../account.js';
+export type BeforeRemove = (details: AccountWithDelinquency) => Promise<void> | void;
+export type RemoveSelfOptions = {
+    beforeRemove?: BeforeRemove;
+    signal?: AbortSignal;
+};
+/** Remove the authenticated account from an app's collaborator list. */
+export declare function removeSelf(ctx: Pick<ResourceCtx, 'platform'>, appIdentity: string, options?: RemoveSelfOptions): Promise<Collaborator>;

package/dist/resources/platform/app-collaborator/remove-self.js

@@ -0,0 +1,21 @@
+import { withSignal } from '../../../core/with-signal.js';
+import { getAccountWithDelinquency } from '../account.js';
+/** Remove the authenticated account from an app's collaborator list. */
+export async function removeSelf(ctx, appIdentity, options = {}) {
+    options.signal?.throwIfAborted();
+    let account;
+    if (options.beforeRemove) {
+        const details = await getAccountWithDelinquency(ctx, options.signal ? { signal: options.signal } : {});
+        options.signal?.throwIfAborted();
+        await options.beforeRemove(details);
+        options.signal?.throwIfAborted();
+        account = details.account;
+    }
+    else {
+        const platform = withSignal(ctx.platform, options.signal);
+        account = await platform.account.info();
+        options.signal?.throwIfAborted();
+    }
+    // Keep the email raw: the generated route encodes path parameters once.
+    return withSignal(ctx.platform, options.signal).collaborator.delete(appIdentity, account.email);
+}

package/dist/resources/platform/team-app/index.d.ts

@@ -0,0 +1,5 @@
+import type { JoinSelfOptions } from './join-self.js';
+export { joinSelf, type JoinSelfOptions } from './join-self.js';
+export declare const teamAppExtensions: import("../../../core/extend-resource.js").ResourceExtension<"platform", "teamApp", {
+    joinSelf: (appIdentity: string, options?: JoinSelfOptions) => Promise<import("@heroku/types/3.sdk").TeamAppCollaborator>;
+}>;

package/dist/resources/platform/team-app/index.js

@@ -0,0 +1,6 @@
+import { extendResource } from '../../../core/extend-resource.js';
+import { joinSelf } from './join-self.js';
+export { joinSelf } from './join-self.js';
+export const teamAppExtensions = extendResource('platform', 'teamApp', ctx => ({
+    joinSelf: (appIdentity, options) => joinSelf(ctx, appIdentity, options),
+}));

package/dist/resources/platform/team-app/join-self.d.ts

@@ -0,0 +1,7 @@
+import type { TeamAppCollaborator } from '@heroku/types/3.sdk';
+import type { ResourceCtx } from '../../../core/extend-resource.js';
+export type JoinSelfOptions = {
+    signal?: AbortSignal;
+};
+/** Add the authenticated account as a collaborator on a team app. */
+export declare function joinSelf(ctx: Pick<ResourceCtx, 'platform'>, appIdentity: string, options?: JoinSelfOptions): Promise<TeamAppCollaborator>;

package/dist/resources/platform/team-app/join-self.js

@@ -0,0 +1,9 @@
+import { withSignal } from '../../../core/with-signal.js';
+/** Add the authenticated account as a collaborator on a team app. */
+export async function joinSelf(ctx, appIdentity, options = {}) {
+    options.signal?.throwIfAborted();
+    const platform = withSignal(ctx.platform, options.signal);
+    const account = await platform.account.info();
+    options.signal?.throwIfAborted();
+    return platform.teamAppCollaborator.create(appIdentity, { user: account.email });
+}

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.12.1";
+export declare const SDK_VERSION = "0.12.2";

package/dist/version.js

@@ -1,2 +1,2 @@
 // Generated from package.json by scripts/write-version.mjs (build prebuild). Do not edit.
-export const SDK_VERSION = '0.12.1';
+export const SDK_VERSION = '0.12.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heroku/sdk",
-  "version": "0.12.1",
+  "version": "0.12.2",
   "description": "Heroku SDK",
   "author": "Heroku",
   "type": "module",
@@ -42,6 +42,10 @@
       "types": "./dist/resources/extensions/platform.d.ts",
       "default": "./dist/resources/extensions/platform.js"
     },
+    "./extensions/dashboard-backend": {
+      "types": "./dist/resources/extensions/dashboard-backend.d.ts",
+      "default": "./dist/resources/extensions/dashboard-backend.js"
+    },
     "./extensions/data": {
       "types": "./dist/resources/extensions/data.d.ts",
       "default": "./dist/resources/extensions/data.js"