@heroku/sdk 0.6.1 → 0.6.3

package/dist/core/extend-resource.d.ts

@@ -1,14 +1,16 @@
 import type { DashboardBackendClient } from '../services/dashboard-backend.js';
 import type { DataClient } from '../services/data.js';
 import type { MetricsClient } from '../services/metrics.js';
+import type { NotificationsClient } from '../services/notifications.js';
 import type { PlatformClient } from '../services/platform.js';
 import type { RepositoriesApiClient } from '../services/repositories-api.js';
 import type { RepositoriesClient } from '../services/repositories.js';
-export type ServiceName = 'dashboardBackend' | 'data' | 'metrics' | 'platform' | 'repositories' | 'repositoriesApi';
+export type ServiceName = 'dashboardBackend' | 'data' | 'metrics' | 'notifications' | 'platform' | 'repositories' | 'repositoriesApi';
 type BaseResourceCtx = {
     dashboardBackend: DashboardBackendClient;
     data: DataClient;
     metrics: MetricsClient;
+    notifications: NotificationsClient;
     platform: PlatformClient;
     repositories: RepositoriesClient;
 };

package/dist/core/heroku-sdk.d.ts

@@ -2,6 +2,7 @@ import type { HerokuApiClientOptions } from '@heroku/heroku-fetch';
 import type { DashboardBackendClient } from '../services/dashboard-backend.js';
 import type { DataClient } from '../services/data.js';
 import type { MetricsClient } from '../services/metrics.js';
+import type { NotificationsClient } from '../services/notifications.js';
 import type { PlatformClient } from '../services/platform.js';
 import type { RepositoriesApiClient } from '../services/repositories-api.js';
 import type { RepositoriesClient } from '../services/repositories.js';
@@ -21,6 +22,7 @@ export declare class HerokuSDK<const Exts extends readonly ResourceExtension[] =
     get dashboardBackend(): ApplyExtensions<DashboardBackendClient, ExtensionsFor<Exts, 'dashboardBackend'>>;
     get data(): ApplyExtensions<DataClient, ExtensionsFor<Exts, 'data'>>;
     get metrics(): ApplyExtensions<MetricsClient, ExtensionsFor<Exts, 'metrics'>>;
+    get notifications(): ApplyExtensions<NotificationsClient, ExtensionsFor<Exts, 'notifications'>>;
     get platform(): ApplyExtensions<PlatformClient, ExtensionsFor<Exts, 'platform'>>;
     get repositories(): ApplyExtensions<RepositoriesClient, ExtensionsFor<Exts, 'repositories'>>;
     get repositoriesApi(): ApplyExtensions<RepositoriesApiClient, ExtensionsFor<Exts, 'repositoriesApi'>>;

package/dist/core/heroku-sdk.js

@@ -1,6 +1,7 @@
 import { createDashboardBackendClient } from '../services/dashboard-backend.js';
 import { createDataClient } from '../services/data.js';
 import { createMetricsClient } from '../services/metrics.js';
+import { createNotificationsClient } from '../services/notifications.js';
 import { createPlatformClient } from '../services/platform.js';
 import { createRepositoriesApiClient } from '../services/repositories-api.js';
 import { createRepositoriesClient } from '../services/repositories.js';
@@ -22,10 +23,12 @@ export class HerokuSDK {
     #data;
     #extensionsByService;
     #metrics;
+    #notifications;
     #platform;
     #rawDashboardBackend;
     #rawData;
     #rawMetrics;
+    #rawNotifications;
     #rawPlatform;
     #rawRepositories;
     #rawRepositoriesApi;
@@ -48,6 +51,10 @@ export class HerokuSDK {
         this.#metrics ??= mergeExtensions(this.#getRawMetrics(), this.#extensionsByService.get('metrics') ?? [], this.#getCtx());
         return this.#metrics;
     }
+    get notifications() {
+        this.#notifications ??= mergeExtensions(this.#getRawNotifications(), this.#extensionsByService.get('notifications') ?? [], this.#getCtx());
+        return this.#notifications;
+    }
     get platform() {
         this.#platform ??= mergeExtensions(this.#getRawPlatform(), this.#extensionsByService.get('platform') ?? [], this.#getCtx());
         return this.#platform;
@@ -83,6 +90,10 @@ export class HerokuSDK {
                 enumerable: true,
                 get: () => this.#getRawMetrics(),
             },
+            notifications: {
+                enumerable: true,
+                get: () => this.#getRawNotifications(),
+            },
             platform: {
                 enumerable: true,
                 get: () => this.#getRawPlatform(),
@@ -110,6 +121,10 @@ export class HerokuSDK {
         this.#rawMetrics ??= createMetricsClient(this.#getClientOptions('metrics'));
         return this.#rawMetrics;
     }
+    #getRawNotifications() {
+        this.#rawNotifications ??= createNotificationsClient(this.#clientOptions);
+        return this.#rawNotifications;
+    }
     #getRawPlatform() {
         this.#rawPlatform ??= createPlatformClient(this.#getClientOptions('platform'));
         return this.#rawPlatform;

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

@@ -1,11 +1,8 @@
-import type { DatabaseInfoResult } from '@heroku/types/data';
+import type { DatabaseCancelUpgradeResult, DatabaseDryRunUpgradeOpts, DatabaseDryRunUpgradeResult, DatabaseInfoResult, DatabasePrepareUpgradeOpts, DatabasePrepareUpgradeResult, DatabaseRunUpgradeOpts, DatabaseRunUpgradeResult, DatabaseUpgradeWaitStatusResult } from '@heroku/types/data';
 import type { ResourceCtx } from '../../core/extend-resource.js';
 export type DatabaseOptions = {
     signal?: AbortSignal;
 };
-export type DatabaseUpgradeBody = {
-    version?: string;
-};
 export type DatabaseDescribeResult = DatabaseInfoResult & {
     following?: string;
     'hot_standby?'?: boolean;
@@ -14,41 +11,17 @@ export type DatabaseDescribeResult = DatabaseInfoResult & {
     postgres_version?: string;
     'standalone?'?: boolean;
 };
-export type DatabaseUpgradeWaitResult = {
-    'error?': boolean;
-    message: string;
-    step: string;
-    'waiting?': boolean;
-};
-export type DatabaseUpgradeResponse = {
-    message: string;
-};
-type DatabaseDataClient = {
-    database: {
-        cancelUpgrade(name: string): Promise<DatabaseUpgradeResponse>;
-        dryRunUpgrade(name: string, body: DatabaseUpgradeBody): Promise<DatabaseUpgradeResponse>;
-        info(name: string): Promise<DatabaseDescribeResult>;
-        prepareUpgrade(name: string, body: DatabaseUpgradeBody): Promise<DatabaseUpgradeResponse>;
-        runUpgrade(name: string, body: DatabaseUpgradeBody): Promise<DatabaseUpgradeResponse>;
-        upgradeWaitStatus(name: string): Promise<DatabaseUpgradeWaitResult>;
-    };
-};
-type DatabaseCtx = {
-    data: DatabaseDataClient;
-    platform: ResourceCtx['platform'];
-};
-export declare function describe(ctx: DatabaseCtx, appIdentity: string, addonIdentity?: string, options?: DatabaseOptions): Promise<DatabaseDescribeResult>;
-export declare function upgradeWaitStatus(ctx: DatabaseCtx, appIdentity: string, addonIdentity?: string, options?: DatabaseOptions): Promise<DatabaseUpgradeWaitResult>;
-export declare function dryRunUpgrade(ctx: DatabaseCtx, appIdentity: string, addonIdentity?: string, body?: DatabaseUpgradeBody, options?: DatabaseOptions): Promise<DatabaseUpgradeResponse>;
-export declare function runUpgrade(ctx: DatabaseCtx, appIdentity: string, addonIdentity?: string, body?: DatabaseUpgradeBody, options?: DatabaseOptions): Promise<DatabaseUpgradeResponse>;
-export declare function prepareUpgrade(ctx: DatabaseCtx, appIdentity: string, addonIdentity?: string, body?: DatabaseUpgradeBody, options?: DatabaseOptions): Promise<DatabaseUpgradeResponse>;
-export declare function cancelUpgrade(ctx: DatabaseCtx, appIdentity: string, addonIdentity?: string, options?: DatabaseOptions): Promise<DatabaseUpgradeResponse>;
+export declare function describe(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, options?: DatabaseOptions): Promise<DatabaseDescribeResult>;
+export declare function upgradeWaitStatus(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, options?: DatabaseOptions): Promise<DatabaseUpgradeWaitStatusResult>;
+export declare function dryRunUpgrade(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, body?: DatabaseDryRunUpgradeOpts, options?: DatabaseOptions): Promise<DatabaseDryRunUpgradeResult>;
+export declare function runUpgrade(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, body?: DatabaseRunUpgradeOpts, options?: DatabaseOptions): Promise<DatabaseRunUpgradeResult>;
+export declare function prepareUpgrade(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, body?: DatabasePrepareUpgradeOpts, options?: DatabaseOptions): Promise<DatabasePrepareUpgradeResult>;
+export declare function cancelUpgrade(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, options?: DatabaseOptions): Promise<DatabaseCancelUpgradeResult>;
 export declare const databaseExtensions: import("../../core/extend-resource.js").ResourceExtension<"data", "database", {
-    cancelUpgrade: (appIdentity: string, addonIdentity?: string, options?: DatabaseOptions) => Promise<DatabaseUpgradeResponse>;
+    cancelUpgrade: (appIdentity: string, addonIdentity?: string, options?: DatabaseOptions) => Promise<DatabaseCancelUpgradeResult>;
     describe: (appIdentity: string, addonIdentity?: string, options?: DatabaseOptions) => Promise<DatabaseDescribeResult>;
-    dryRunUpgrade: (appIdentity: string, addonIdentity?: string, body?: DatabaseUpgradeBody, options?: DatabaseOptions) => Promise<DatabaseUpgradeResponse>;
-    prepareUpgrade: (appIdentity: string, addonIdentity?: string, body?: DatabaseUpgradeBody, options?: DatabaseOptions) => Promise<DatabaseUpgradeResponse>;
-    runUpgrade: (appIdentity: string, addonIdentity?: string, body?: DatabaseUpgradeBody, options?: DatabaseOptions) => Promise<DatabaseUpgradeResponse>;
-    upgradeWaitStatus: (appIdentity: string, addonIdentity?: string, options?: DatabaseOptions) => Promise<DatabaseUpgradeWaitResult>;
+    dryRunUpgrade: (appIdentity: string, addonIdentity?: string, body?: DatabaseDryRunUpgradeOpts, options?: DatabaseOptions) => Promise<DatabaseDryRunUpgradeResult>;
+    prepareUpgrade: (appIdentity: string, addonIdentity?: string, body?: DatabasePrepareUpgradeOpts, options?: DatabaseOptions) => Promise<DatabasePrepareUpgradeResult>;
+    runUpgrade: (appIdentity: string, addonIdentity?: string, body?: DatabaseRunUpgradeOpts, options?: DatabaseOptions) => Promise<DatabaseRunUpgradeResult>;
+    upgradeWaitStatus: (appIdentity: string, addonIdentity?: string, options?: DatabaseOptions) => Promise<DatabaseUpgradeWaitStatusResult>;
 }>;
-export {};

package/dist/resources/data/database.js

@@ -30,15 +30,11 @@ export async function cancelUpgrade(ctx, appIdentity, addonIdentity, options = {
     const addon = await resolvePgDatabase(ctx, { appIdentity, input: addonIdentity, ...options });
     return ctx.data.database.cancelUpgrade(addon.id);
 }
-export const databaseExtensions = extendResource('data', 'database', rawCtx => {
-    // Bridge heroku-types' loose client types to the adapter's strongly-typed contract
-    const ctx = rawCtx;
-    return {
-        cancelUpgrade: (appIdentity, addonIdentity, options) => cancelUpgrade(ctx, appIdentity, addonIdentity, options),
-        describe: (appIdentity, addonIdentity, options) => describe(ctx, appIdentity, addonIdentity, options),
-        dryRunUpgrade: (appIdentity, addonIdentity, body, options) => dryRunUpgrade(ctx, appIdentity, addonIdentity, body, options),
-        prepareUpgrade: (appIdentity, addonIdentity, body, options) => prepareUpgrade(ctx, appIdentity, addonIdentity, body, options),
-        runUpgrade: (appIdentity, addonIdentity, body, options) => runUpgrade(ctx, appIdentity, addonIdentity, body, options),
-        upgradeWaitStatus: (appIdentity, addonIdentity, options) => upgradeWaitStatus(ctx, appIdentity, addonIdentity, options),
-    };
-});
+export const databaseExtensions = extendResource('data', 'database', ctx => ({
+    cancelUpgrade: (appIdentity, addonIdentity, options) => cancelUpgrade(ctx, appIdentity, addonIdentity, options),
+    describe: (appIdentity, addonIdentity, options) => describe(ctx, appIdentity, addonIdentity, options),
+    dryRunUpgrade: (appIdentity, addonIdentity, body, options) => dryRunUpgrade(ctx, appIdentity, addonIdentity, body, options),
+    prepareUpgrade: (appIdentity, addonIdentity, body, options) => prepareUpgrade(ctx, appIdentity, addonIdentity, body, options),
+    runUpgrade: (appIdentity, addonIdentity, body, options) => runUpgrade(ctx, appIdentity, addonIdentity, body, options),
+    upgradeWaitStatus: (appIdentity, addonIdentity, options) => upgradeWaitStatus(ctx, appIdentity, addonIdentity, options),
+}));

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

@@ -16,17 +16,7 @@ export type CredentialInfo = {
     state: string;
     uuid: string;
 };
-type CredentialsDataClient = {
-    postgresDatabase: {
-        listCredentials(name: string): Promise<CredentialInfo[]>;
-    };
-};
-type CredentialsCtx = {
-    data: CredentialsDataClient;
-    platform: ResourceCtx['platform'];
-};
-export declare function listCredentials(ctx: CredentialsCtx, appIdentity: string, addonIdentity?: string, options?: ListCredentialsOptions): Promise<CredentialInfo[]>;
+export declare function listCredentials(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, options?: ListCredentialsOptions): Promise<CredentialInfo[]>;
 export declare const postgresDatabaseExtensions: import("../../core/extend-resource.js").ResourceExtension<"data", "postgresDatabase", {
     listCredentials: (appIdentity: string, addonIdentity?: string, options?: ListCredentialsOptions) => Promise<CredentialInfo[]>;
 }>;
-export {};

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

@@ -5,10 +5,6 @@ export async function listCredentials(ctx, appIdentity, addonIdentity, options =
     const addon = await resolvePgDatabase(ctx, { appIdentity, input: addonIdentity, ...options });
     return ctx.data.postgresDatabase.listCredentials(addon.id);
 }
-export const postgresDatabaseExtensions = extendResource('data', 'postgresDatabase', rawCtx => {
-    // Bridge heroku-types' loose client types to the adapter's strongly-typed contract
-    const ctx = rawCtx;
-    return {
-        listCredentials: (appIdentity, addonIdentity, options) => listCredentials(ctx, appIdentity, addonIdentity, options),
-    };
-});
+export const postgresDatabaseExtensions = extendResource('data', 'postgresDatabase', ctx => ({
+    listCredentials: (appIdentity, addonIdentity, options) => listCredentials(ctx, appIdentity, addonIdentity, options),
+}));

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

@@ -1,49 +1,9 @@
+import type { TransferListByAppResult } from '@heroku/types/data';
 import type { ResourceCtx } from '../../core/extend-resource.js';
 export type TransferOptions = {
     signal?: AbortSignal;
 };
-export type BackupTransfer = {
-    canceled_at: string;
-    created_at: string;
-    deleted_at: string;
-    finished_at: string;
-    from_name: string;
-    from_type: string;
-    from_url: string;
-    logs: Array<{
-        created_at: string;
-        level: string;
-        message: string;
-    }>;
-    num: number;
-    num_keep: number;
-    options: Record<string, unknown>;
-    processed_bytes: number;
-    purged_at: string;
-    schedule?: {
-        uuid: string;
-    };
-    source_bytes: number;
-    started_at: string;
-    succeeded: boolean;
-    to_name: string;
-    to_type: string;
-    to_url: string;
-    updated_at: string;
-    uuid: string;
-    warnings: number;
-};
-type TransferDataClient = {
-    transfer: {
-        listByApp(name: string): Promise<BackupTransfer[]>;
-    };
-};
-type TransferCtx = {
-    data: TransferDataClient;
-    platform: ResourceCtx['platform'];
-};
-export declare function listByApp(ctx: TransferCtx, appIdentity: string, addonIdentity?: string, options?: TransferOptions): Promise<BackupTransfer[]>;
+export declare function listByApp(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, options?: TransferOptions): Promise<TransferListByAppResult>;
 export declare const transferExtensions: import("../../core/extend-resource.js").ResourceExtension<"data", "transfer", {
-    listByApp: (appIdentity: string, addonIdentity?: string, options?: TransferOptions) => Promise<BackupTransfer[]>;
+    listByApp: (appIdentity: string, addonIdentity?: string, options?: TransferOptions) => Promise<TransferListByAppResult>;
 }>;
-export {};

package/dist/resources/data/transfer.js

@@ -14,10 +14,6 @@ export async function listByApp(ctx, appIdentity, addonIdentity, options = {}) {
     }
     return ctx.data.transfer.listByApp(addon.id);
 }
-export const transferExtensions = extendResource('data', 'transfer', rawCtx => {
-    // Bridge heroku-types' loose client types to the adapter's strongly-typed contract
-    const ctx = rawCtx;
-    return {
-        listByApp: (appIdentity, addonIdentity, options) => listByApp(ctx, appIdentity, addonIdentity, options),
-    };
-});
+export const transferExtensions = extendResource('data', 'transfer', ctx => ({
+    listByApp: (appIdentity, addonIdentity, options) => listByApp(ctx, appIdentity, addonIdentity, options),
+}));

package/dist/resources/platform/domain/test-utils.js

@@ -19,6 +19,7 @@ export function buildCtx(stubs = {}) {
         dashboardBackend: {},
         data: {},
         metrics: {},
+        notifications: {},
         platform: platform,
         repositories: {},
     };

package/dist/services/notifications.d.ts

@@ -0,0 +1,5 @@
+import type { HerokuApiClientOptions } from '@heroku/heroku-fetch';
+import type { HerokuClient } from '@heroku/types/notifications';
+import type { RoutesClientExtras } from '../core/create-client.js';
+export type NotificationsClient = HerokuClient & RoutesClientExtras<HerokuClient>;
+export declare function createNotificationsClient(options?: HerokuApiClientOptions): NotificationsClient;

package/dist/services/notifications.js

@@ -0,0 +1,11 @@
+import * as routes from '@heroku/types/notifications/routes';
+import { createClient } from '../core/create-client.js';
+const DEFAULT_NOTIFICATIONS_BASE_URL = 'https://telex.heroku.com';
+export function createNotificationsClient(options = {}) {
+    const baseUrl = process.env.HEROKU_NOTIFICATIONS_HOST ?? DEFAULT_NOTIFICATIONS_BASE_URL;
+    return createClient(routes, {
+        baseUrl,
+        service: 'custom',
+        ...options,
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heroku/sdk",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "description": "Heroku SDK",
   "author": "Heroku",
   "type": "module",
@@ -34,6 +34,10 @@
       "types": "./dist/services/repositories-api.d.ts",
       "default": "./dist/services/repositories-api.js"
     },
+    "./notifications": {
+      "types": "./dist/services/notifications.d.ts",
+      "default": "./dist/services/notifications.js"
+    },
     "./extensions/platform": {
       "types": "./dist/resources/extensions/platform.d.ts",
       "default": "./dist/resources/extensions/platform.js"
@@ -141,7 +145,7 @@
   },
   "dependencies": {
     "@heroku/heroku-fetch": "^0.1.4",
-    "@heroku/types": "^4.7.0",
+    "@heroku/types": "^5.0.0",
     "debug": "^4.4.0"
   }
 }