@pantechdynamic/sdk 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -4,6 +4,25 @@ A new version heading here (`## X.Y.Z (YYYY-MM-DD)`) pushed to main is
 tagged `vX.Y.Z` and published to npm. Add changes under `## Unreleased`
 until then.
 
+## 0.2.0 (2026-10-28)
+
+- `client.migrate`, for moving from another cloud: `migrate.connections`
+  (`list`, `listAll`, `create`, `get`, `update` for the name, role ARN or a retry, `delete`)
+  connects an AWS account through a read-only role; `migrate.scans` (`list`, `listAll`,
+  `start`, `get` with `{ include: "inventory" }`) reads what runs there; `migrate.migrations`
+  (`list`, `listAll`, `create`, `get`, `rename`, `delete`, `updateItem`, `exportTerraform`) plans
+  the move with a price comparison and a Terraform export.
+- `migrate.connections.wait()` and `migrate.scans.wait()`, which reject with the new
+  `CloudFailedError` when the connection or scan fails.
+- `examples/migrate-from-aws.ts`.
+- Types follow the current public API, including Kubernetes clusters' `node_health`,
+  `ready_nodes` and `nodes_checked_at`, and a load balancer's `protocol`.
+- Fixed: request fields the API defaults (`endpoint_access`, `control_nodes`, a firewall rule's
+  `direction` and `action`, `algorithm`, `purpose`, `admin_username`, `retention_count`,
+  `enabled`, `autoscaling_enabled`) are optional in the types, as they are in the API.
+- Agent sessions, which answer only AI apps connected through Pantech's MCP server, have no
+  methods yet; `scripts/not-in-sdk.json` lists them and `npm run generate` leaves out their types.
+
 ## 0.1.0 (2026-10-24)
 
 - First release: a client for every operation in the Pantech Dynamics public API

package/README.md

@@ -6,7 +6,7 @@
 
 The official client for the [Pantech Dynamics public API](https://docs.pantechdynamics.com/api):
 instances, VPC networks, firewalls, public IPs, load balancers, volumes, snapshots, managed
-databases, managed Kubernetes, SSH keys, webhooks, billing and usage.
+databases, managed Kubernetes, SSH keys, webhooks, billing, usage, and moving from another cloud.
 
 - Zero runtime dependencies. Uses the global `fetch` and Web Crypto, so it runs on Node.js 18+,
   Bun, Deno and edge runtimes.
@@ -75,9 +75,11 @@ Every method takes per-call options last: `{ signal, timeout, maxRetries, idempo
 | Databases | `databases.*`, `databases.snapshots.*`, `databaseOrders.wait(order)` |
 | SSH keys, webhooks | `sshKeys.*`, `webhooks.*`, `webhooks.deliveries.*` |
 | Billing and usage | `billing.credit.get()`, `billing.credit.purchases.create(...)`, `billing.receipts.getPdf(id)`, `usage.get()` |
+| Move from another cloud | `migrate.connections.*`, `migrate.scans.*`, `migrate.migrations.*` |
 | Operations | `operations.get(id)`, `operations.wait(id)`, `operations.stream(id)` |
 
-Every operation in the public spec has a method; `test/coverage.test.ts` fails if one is missing.
+Every operation in the public spec has a method, except agent sessions, which answer only AI apps
+connected through Pantech's MCP server; `test/coverage.test.ts` fails if one is missing.
 For anything else, `client.request({ method, path, query, body })` sends a raw request with the
 same auth, retries and errors.
 
@@ -101,7 +103,29 @@ for await (const o of client.operations.stream("op_…")) console.log(o.status);
 ```
 
 A failed operation rejects with `OperationFailedError` (`code`, `detail` from its `failure`), a
-failed or unpaid order with `OrderFailedError`, and a wait that runs out with `WaitTimeoutError`.
+failed or unpaid order with `OrderFailedError`, a failed cloud connection or scan with
+`CloudFailedError`, and a wait that runs out with `WaitTimeoutError`.
+
+## Move from another cloud
+
+`client.migrate` connects an AWS account through a read-only role that only Pantech can assume (no
+access keys are shared), scans what runs there, and plans the move with a price comparison and a
+Terraform export. Nothing is created on Pantech until you apply the Terraform.
+
+```ts
+let conn = await client.migrate.connections.create({ name: "Production AWS" });
+console.log(conn.setup.quick_create_url); // create the stack in AWS, then send its RoleArn output
+await client.migrate.connections.update(conn.id, { role_arn: "arn:aws:iam::…:role/…" });
+conn = await client.migrate.connections.wait(conn.id); // CloudFailedError if the role cannot be assumed
+
+const scan = await client.migrate.scans.wait((await client.migrate.scans.start(conn.id)).id);
+const plan = await client.migrate.migrations.create({ scan_id: scan.id, name: "Move to Pantech" });
+console.log(plan.estimate?.pantech_monthly_minor, plan.estimate?.source_monthly_minor);
+const { files } = await client.migrate.migrations.exportTerraform(plan.id); // main.tf, variables.tf
+```
+
+`migrate.migrations.updateItem(id, { key, excluded: true })` leaves an item out, or changes its
+plan, size, address range or role, before you export. See `examples/migrate-from-aws.ts`.
 
 ## Errors
 
@@ -156,7 +180,7 @@ the timestamp is too old. On Node.js 18, start node with `--experimental-global-
 
 ## Examples
 
-`examples/` has `create-instance.ts`, `list.ts` and `webhook-receiver.ts`. With Node.js 23.6+:
+`examples/` has `create-instance.ts`, `list.ts`, `webhook-receiver.ts` and `migrate-from-aws.ts`. With Node.js 23.6+:
 `npm run build && PANTECH_API_KEY=PAN_… node examples/list.ts`.
 
 ## Development

package/dist/index.cjs

@@ -88,6 +88,18 @@ var OrderFailedError = class extends PantechError {
     this.order = order;
   }
 };
+var CloudFailedError = class extends PantechError {
+  name = "CloudFailedError";
+  /** `connection` or `scan`. */
+  kind;
+  /** The failed connection or scan, as the API returned it. */
+  resource;
+  constructor(message, kind, resource, init = {}) {
+    super(message, init);
+    this.kind = kind;
+    this.resource = resource;
+  }
+};
 var WaitTimeoutError = class extends PantechError {
   name = "WaitTimeoutError";
 };
@@ -775,6 +787,136 @@ var MeResource = class extends APIResource {
   }
 };
 
+// src/resources/migrate.ts
+var CONNECTION_WAIT_MS = 10 * 6e4;
+var SCAN_WAIT_MS = 30 * 6e4;
+function cloudFailed(kind, id, failure, resource) {
+  const detail = failure?.message ?? `The ${kind} failed.`;
+  const code = failure?.code;
+  return new CloudFailedError(
+    code ? `Cloud ${kind} ${id} failed: ${detail} (${code})` : `Cloud ${kind} ${id} failed: ${detail}`,
+    kind,
+    resource,
+    { code, detail }
+  );
+}
+var Migrate = class extends APIResource {
+  /** Connections to AWS accounts through a read-only role only Pantech can assume. */
+  connections = new CloudConnections(this._client);
+  /** Reads of everything a connection's role can see. */
+  scans = new CloudScans(this._client);
+  /** Plans to move what a scan found to Pantech. Nothing is created until you apply the Terraform. */
+  migrations = new Migrations(this._client);
+};
+var CloudConnections = class extends APIResource {
+  list(params = {}, options) {
+    return this._get("/cloud-connections", params, options);
+  }
+  listAll(params = {}, options) {
+    return this._listAll("/cloud-connections", params, options);
+  }
+  /**
+   * Starts a connection. Its `setup` holds the CloudFormation template (and,
+   * when offered, a one-click `quick_create_url`) that creates the read-only
+   * role in your AWS account; send the stack's `RoleArn` output with `update`.
+   */
+  create(body, options) {
+    return this._post("/cloud-connections", body, options);
+  }
+  get(connectionId, options) {
+    return this._get(path`/cloud-connections/${connectionId}`, void 0, options);
+  }
+  /** Renames the connection, sets its `role_arn`, or retries a failed check (`retry: true`). */
+  update(connectionId, body, options) {
+    return this._patch(path`/cloud-connections/${connectionId}`, body, options);
+  }
+  /** Removes the connection and its scans; plans made from it stay. Delete the stack in AWS to revoke the role there. */
+  delete(connectionId, options) {
+    return this._delete(path`/cloud-connections/${connectionId}`, options);
+  }
+  /**
+   * Polls the connection until it is `connected` (resolves with it) or its
+   * check fails (rejects with CloudFailedError). Set the role ARN with
+   * `update` first. Default timeout 10 minutes, polling every 5 seconds.
+   */
+  wait(connectionId, options = {}) {
+    return poll(
+      () => this.get(connectionId, { signal: options.signal }),
+      (c) => {
+        if (c.status === "failed") throw cloudFailed("connection", c.id, c.failure, c);
+        return c.status === "connected";
+      },
+      `Cloud connection ${connectionId}`,
+      { timeoutMs: CONNECTION_WAIT_MS, pollIntervalMs: 5e3, ...options }
+    );
+  }
+};
+var CloudScans = class extends APIResource {
+  /** A connection's scans, newest first, without their inventories. */
+  list(connectionId, params = {}, options) {
+    return this._get(path`/cloud-connections/${connectionId}/scans`, params, options);
+  }
+  listAll(connectionId, params = {}, options) {
+    return this._listAll(path`/cloud-connections/${connectionId}/scans`, params, options);
+  }
+  /** Queues a scan of a connected account. Follow it with `wait`. */
+  start(connectionId, options) {
+    return this._post(path`/cloud-connections/${connectionId}/scans`, void 0, options);
+  }
+  /** A scan's status and counts. Pass `{ include: "inventory" }` for everything it found. */
+  get(scanId, params = {}, options) {
+    return this._get(path`/cloud-scans/${scanId}`, params, options);
+  }
+  /**
+   * Polls the scan until it `succeeded` (resolves with it, without its
+   * inventory) or failed (rejects with CloudFailedError). Default timeout 30
+   * minutes, polling every 10 seconds.
+   */
+  wait(scanId, options = {}) {
+    return poll(
+      () => this.get(scanId, {}, { signal: options.signal }),
+      (s) => {
+        if (s.status === "failed") throw cloudFailed("scan", s.id, s.failure, s);
+        return s.status === "succeeded";
+      },
+      `Cloud scan ${scanId}`,
+      { timeoutMs: SCAN_WAIT_MS, pollIntervalMs: 1e4, ...options }
+    );
+  }
+};
+var Migrations = class extends APIResource {
+  /** Your migration plans, newest first, without their items or estimate. */
+  list(params = {}, options) {
+    return this._get("/migrations", params, options);
+  }
+  listAll(params = {}, options) {
+    return this._listAll("/migrations", params, options);
+  }
+  /** Builds a plan, with a price comparison, from a scan that succeeded. Nothing is created on Pantech. */
+  create(body, options) {
+    return this._post("/migrations", body, options);
+  }
+  /** A plan with every item, and a price comparison computed now. */
+  get(migrationId, options) {
+    return this._get(path`/migrations/${migrationId}`, void 0, options);
+  }
+  rename(migrationId, body, options) {
+    return this._patch(path`/migrations/${migrationId}`, body, options);
+  }
+  /** Deletes the plan. Nothing on Pantech or in the other cloud is touched. */
+  delete(migrationId, options) {
+    return this._delete(path`/migrations/${migrationId}`, options);
+  }
+  /** Changes one item, named by its `key`: exclude it, or change its plan, size, range, role or email. */
+  updateItem(migrationId, body, options) {
+    return this._patch(path`/migrations/${migrationId}/items`, body, options);
+  }
+  /** The plan's planned items as Terraform: `main.tf` and `variables.tf`. */
+  exportTerraform(migrationId, options) {
+    return this._get(path`/migrations/${migrationId}/terraform`, void 0, options);
+  }
+};
+
 // src/resources/networks.ts
 var Networks = class extends APIResource {
   /** A network's subnets: `client.networks.subnets.list(networkId)`. */
@@ -1185,7 +1327,7 @@ var WebhookDeliveries = class extends APIResource {
 };
 
 // src/version.ts
-var VERSION = "0.1.0";
+var VERSION = "0.2.0";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://api.pantechdynamics.com/public/v1";
@@ -1230,6 +1372,8 @@ var Pantech = class {
   databaseOrders;
   sshKeys;
   webhooks;
+  /** Move from another cloud: connections, scans and migration plans. */
+  migrate;
   operations;
   constructor(options = {}) {
     const apiKey = options.apiKey ?? readEnv("PANTECH_API_KEY");
@@ -1271,6 +1415,7 @@ var Pantech = class {
     this.databaseOrders = new DatabaseOrders(this);
     this.sshKeys = new SshKeys(this);
     this.webhooks = new Webhooks(this);
+    this.migrate = new Migrate(this);
   }
   /**
    * Sends one request and returns its decoded body (undefined for an empty
@@ -1490,6 +1635,7 @@ exports.APIConnectionError = APIConnectionError;
 exports.APITimeoutError = APITimeoutError;
 exports.AuthenticationError = AuthenticationError;
 exports.BadRequestError = BadRequestError;
+exports.CloudFailedError = CloudFailedError;
 exports.ConflictError = ConflictError;
 exports.DEFAULT_BASE_URL = DEFAULT_BASE_URL;
 exports.DEFAULT_WEBHOOK_TOLERANCE_SECONDS = DEFAULT_WEBHOOK_TOLERANCE_SECONDS;