@heroku/sdk 0.8.1 → 0.9.0

package/dist/resources/data/{backup → transfer}/capture-and-wait.d.ts

@@ -1,8 +1,15 @@
-import type { BackupCreateResult, TransferInfoByAppResult } from '@heroku/types/data';
+import type { TransferInfoByAppResult } from '@heroku/types/data';
 import type { ResourceCtx } from '../../../core/extend-resource.js';
 import type { ResolvedPgDatabase } from '../internal/resolve-pg-database.js';
-import type { WaitForTransferOptions } from '../wait-for-transfer.js';
+import type { WaitForTransferOptions } from './wait-for-transfer.js';
 import { Poller } from '../../../utils/poller.js';
+/**
+ * `data.backup.create`'s declared return type, `BackupCreateResult`, only
+ * lists `uuid`/`from_type`/`to_type`, but the actual response includes the
+ * full transfer record. Widen the type here so callers (e.g. `waitPoller`) can
+ * use the full transfer record.
+ */
+export type BackupCreateInfo = TransferInfoByAppResult;
 export type CaptureAndWaitOptions = WaitForTransferOptions & {
     /**
      * Progress hooks fired once before capturing the backup `poller.onStart(addon)`
@@ -14,6 +21,6 @@ export type CaptureAndWaitOptions = WaitForTransferOptions & {
      * complete `poller.onStart(backup)` and once after the transfer
      * finishes successfully `poller.onStop(backup)`.
      */
-    waitPoller?: Poller<BackupCreateResult>;
+    waitPoller?: Poller<BackupCreateInfo>;
 };
 export declare function captureAndWait(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity?: string, options?: CaptureAndWaitOptions): Promise<TransferInfoByAppResult>;

package/dist/resources/data/{backup → transfer}/capture-and-wait.js

@@ -1,5 +1,5 @@
 import { resolvePgDatabase } from '../internal/resolve-pg-database.js';
-import { waitForTransfer } from '../wait-for-transfer.js';
+import { waitForTransfer } from './wait-for-transfer.js';
 export async function captureAndWait(ctx, appIdentity, addonIdentity, options = {}) {
     const { capturePoller, signal, waitPoller } = options;
     signal?.throwIfAborted();

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

@@ -0,0 +1,11 @@
+import type { CaptureAndWaitOptions } from './capture-and-wait.js';
+import type { RestoreAndWaitOptions } from './restore-and-wait.js';
+export { captureAndWait, type CaptureAndWaitOptions } from './capture-and-wait.js';
+export { restoreAndWait, type RestoreAndWaitOptions } from './restore-and-wait.js';
+export { transferExtensions, TransferFailedError, TransferTimeoutError, type WaitForTransferOptions, } from './wait-for-transfer.js';
+export declare const restoreExtensions: import("../../../core/extend-resource.js").ResourceExtension<"data", "restore", {
+    restoreAndWait: (appIdentity: string, addonIdentity: string | undefined, backupUrl: string, options?: RestoreAndWaitOptions) => Promise<import("@heroku/types/data").TransferInfoByAppResult>;
+}>;
+export declare const backupExtensions: import("../../../core/extend-resource.js").ResourceExtension<"data", "backup", {
+    captureAndWait: (appIdentity: string, addonIdentity?: string, options?: CaptureAndWaitOptions) => Promise<import("@heroku/types/data").TransferInfoByAppResult>;
+}>;

package/dist/resources/data/transfer/index.js

@@ -0,0 +1,12 @@
+import { extendResource } from '../../../core/extend-resource.js';
+import { captureAndWait } from './capture-and-wait.js';
+import { restoreAndWait } from './restore-and-wait.js';
+export { captureAndWait } from './capture-and-wait.js';
+export { restoreAndWait } from './restore-and-wait.js';
+export { transferExtensions, TransferFailedError, TransferTimeoutError, } from './wait-for-transfer.js';
+export const restoreExtensions = extendResource('data', 'restore', ctx => ({
+    restoreAndWait: (appIdentity, addonIdentity, backupUrl, options) => restoreAndWait(ctx, appIdentity, addonIdentity, backupUrl, options),
+}));
+export const backupExtensions = extendResource('data', 'backup', ctx => ({
+    captureAndWait: (appIdentity, addonIdentity, options) => captureAndWait(ctx, appIdentity, addonIdentity, options),
+}));

package/dist/resources/data/{restore → transfer}/restore-and-wait.d.ts

@@ -1,8 +1,15 @@
-import type { RestoreCreateResult, TransferInfoByAppResult } from '@heroku/types/data';
+import type { TransferInfoByAppResult } from '@heroku/types/data';
 import type { ResourceCtx } from '../../../core/extend-resource.js';
 import type { ResolvedPgDatabase } from '../internal/resolve-pg-database.js';
-import type { WaitForTransferOptions } from '../wait-for-transfer.js';
+import type { WaitForTransferOptions } from './wait-for-transfer.js';
 import { Poller } from '../../../utils/poller.js';
+/**
+ * `data.restore.create`'s declared return type, `RestoreCreateResult`, only
+ * lists `uuid`/`from_type`/`to_type`, but the actual response includes the
+ * full transfer record. Widen the type here so callers (e.g. `waitPoller`) can
+ * use the full transfer record.
+ */
+export type RestoreCreateInfo = TransferInfoByAppResult;
 export type RestoreAndWaitOptions = WaitForTransferOptions & {
     /**
      * Extension names to preinstall on the restore target.
@@ -19,6 +26,6 @@ export type RestoreAndWaitOptions = WaitForTransferOptions & {
      * complete `poller.onStart(restore)` and once after the restore
      * reaches a terminal state `poller.onStop(restore)`.
      */
-    waitPoller?: Poller<RestoreCreateResult>;
+    waitPoller?: Poller<RestoreCreateInfo>;
 };
 export declare function restoreAndWait(ctx: Pick<ResourceCtx, 'data' | 'platform'>, appIdentity: string, addonIdentity: string | undefined, backupUrl: string, options?: RestoreAndWaitOptions): Promise<TransferInfoByAppResult>;

package/dist/resources/data/{restore → transfer}/restore-and-wait.js

@@ -1,5 +1,5 @@
 import { resolvePgDatabase } from '../internal/resolve-pg-database.js';
-import { waitForTransfer } from '../wait-for-transfer.js';
+import { waitForTransfer } from './wait-for-transfer.js';
 export async function restoreAndWait(ctx, appIdentity, addonIdentity, backupUrl, options = {}) {
     const { extensions, restorePoller, signal, waitPoller } = options;
     signal?.throwIfAborted();

package/dist/resources/data/{wait-for-transfer.d.ts → transfer/wait-for-transfer.d.ts}

@@ -1,5 +1,5 @@
 import type { TransferInfoByAppResult } from '@heroku/types/data';
-import type { ResourceCtx } from '../../core/extend-resource.js';
+import type { ResourceCtx } from '../../../core/extend-resource.js';
 /**
  * Thrown by `waitForTransfer` when the transfer reaches a terminal state
  * with `succeeded: false`.
@@ -59,6 +59,6 @@ export type WaitForTransferOptions = {
  * if the transfer does not finish before timeout.
  */
 export declare function waitForTransfer(ctx: Pick<ResourceCtx, 'data'>, appIdentity: string, transferId: string, options?: WaitForTransferOptions): Promise<TransferInfoByAppResult>;
-export declare const transferExtensions: import("../../core/extend-resource.js").ResourceExtension<"data", "transfer", {
+export declare const transferExtensions: import("../../../core/extend-resource.js").ResourceExtension<"data", "transfer", {
     waitForTransfer: (appIdentity: string, transferId: string, options?: WaitForTransferOptions) => Promise<TransferInfoByAppResult>;
 }>;

package/dist/resources/data/{wait-for-transfer.js → transfer/wait-for-transfer.js}

@@ -1,5 +1,5 @@
-import { extendResource } from '../../core/extend-resource.js';
-import { wait } from '../../utils/wait.js';
+import { extendResource } from '../../../core/extend-resource.js';
+import { wait } from '../../../utils/wait.js';
 const DEFAULT_INTERVAL_MS = 3000;
 const MAX_FAILURES = 20;
 /**

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

@@ -1,8 +1,6 @@
-export { backupExtensions } from '../data/backup/index.js';
 export { databaseExtensions } from '../data/database.js';
 export { maintenanceExtensions } from '../data/maintenance.js';
 export { postgresDatabaseExtensions } from '../data/postgres-database.js';
 export { redisExtensions } from '../data/redis/index.js';
-export { restoreExtensions } from '../data/restore/index.js';
 export { type TransferSchedule, transferScheduleExtensions } from '../data/transfer-schedule.js';
-export { transferExtensions, TransferFailedError, TransferTimeoutError, } from '../data/wait-for-transfer.js';
+export { backupExtensions, type CaptureAndWaitOptions, type RestoreAndWaitOptions, restoreExtensions, transferExtensions, TransferFailedError, TransferTimeoutError, type WaitForTransferOptions, } from '../data/transfer/index.js';

package/dist/resources/extensions/data.js

@@ -1,8 +1,6 @@
-export { backupExtensions } from '../data/backup/index.js';
 export { databaseExtensions } from '../data/database.js';
 export { maintenanceExtensions } from '../data/maintenance.js';
 export { postgresDatabaseExtensions } from '../data/postgres-database.js';
 export { redisExtensions } from '../data/redis/index.js';
-export { restoreExtensions } from '../data/restore/index.js';
 export { transferScheduleExtensions } from '../data/transfer-schedule.js';
-export { transferExtensions, TransferFailedError, TransferTimeoutError, } from '../data/wait-for-transfer.js';
+export { backupExtensions, restoreExtensions, transferExtensions, TransferFailedError, TransferTimeoutError, } from '../data/transfer/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heroku/sdk",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Heroku SDK",
   "author": "Heroku",
   "type": "module",
@@ -102,17 +102,13 @@
       "types": "./dist/resources/platform/vpn-connection/index.d.ts",
       "default": "./dist/resources/platform/vpn-connection/index.js"
     },
-    "./resources/data/backup": {
-      "types": "./dist/resources/data/backup/index.d.ts",
-      "default": "./dist/resources/data/backup/index.js"
-    },
     "./resources/data/redis": {
       "types": "./dist/resources/data/redis/index.d.ts",
       "default": "./dist/resources/data/redis/index.js"
     },
-    "./resources/data/restore": {
-      "types": "./dist/resources/data/restore/index.d.ts",
-      "default": "./dist/resources/data/restore/index.js"
+    "./resources/data/transfer": {
+      "types": "./dist/resources/data/transfer/index.d.ts",
+      "default": "./dist/resources/data/transfer/index.js"
     },
     "./resources/*": {
       "types": "./dist/resources/*.d.ts",

package/dist/resources/data/backup/index.d.ts

@@ -1,5 +0,0 @@
-import type { CaptureAndWaitOptions } from './capture-and-wait.js';
-export { captureAndWait, type CaptureAndWaitOptions } from './capture-and-wait.js';
-export declare const backupExtensions: import("../../../core/extend-resource.js").ResourceExtension<"data", "backup", {
-    captureAndWait: (appIdentity: string, addonIdentity?: string, options?: CaptureAndWaitOptions) => Promise<import("@heroku/types/data").TransferInfoByAppResult>;
-}>;

package/dist/resources/data/backup/index.js

@@ -1,6 +0,0 @@
-import { extendResource } from '../../../core/extend-resource.js';
-import { captureAndWait } from './capture-and-wait.js';
-export { captureAndWait } from './capture-and-wait.js';
-export const backupExtensions = extendResource('data', 'backup', ctx => ({
-    captureAndWait: (appIdentity, addonIdentity, options) => captureAndWait(ctx, appIdentity, addonIdentity, options),
-}));

package/dist/resources/data/restore/index.d.ts

@@ -1,5 +0,0 @@
-import type { RestoreAndWaitOptions } from './restore-and-wait.js';
-export { restoreAndWait, type RestoreAndWaitOptions } from './restore-and-wait.js';
-export declare const restoreExtensions: import("../../../core/extend-resource.js").ResourceExtension<"data", "restore", {
-    restoreAndWait: (appIdentity: string, addonIdentity: string | undefined, backupUrl: string, options?: RestoreAndWaitOptions) => Promise<import("@heroku/types/data").TransferInfoByAppResult>;
-}>;

package/dist/resources/data/restore/index.js

@@ -1,6 +0,0 @@
-import { extendResource } from '../../../core/extend-resource.js';
-import { restoreAndWait } from './restore-and-wait.js';
-export { restoreAndWait } from './restore-and-wait.js';
-export const restoreExtensions = extendResource('data', 'restore', ctx => ({
-    restoreAndWait: (appIdentity, addonIdentity, backupUrl, options) => restoreAndWait(ctx, appIdentity, addonIdentity, backupUrl, options),
-}));