@billkit-eu/sdk 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,71 @@
+# Changelog
+
+All notable changes to the BillKit Node SDK will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Versioning is independent of the Python SDK; the two ship on their own cadence,
+so the numbers will diverge after this first release.
+
+## [Unreleased]
+
+## [0.1.0]
+
+First public release.
+
+### Added
+- `BillKit` client, async-first, works in Node 20+, Bun, Deno, Cloudflare
+  Workers, and the browser (Web Crypto API only, no Node-specific deps).
+- Full resource coverage: Customers, Products, Prices, CheckoutSessions,
+  Subscriptions, Refunds, WebhookEndpoints, Coupons, TaxRates, Invoices,
+  AuditLogs, Payments, Events, Tenant, BillingPortalSessions.
+- Async iterator pagination (`for await (const c of client.customers.iter())`).
+- Typed error hierarchy (`APIConnectionError`, `AuthenticationError`,
+  `PermissionError`, `ResourceMissingError`, `InvalidRequestError`,
+  `ConflictError`, `RateLimitError`, `ServerError`) matching the BillKit
+  error envelope.
+- Automatic `Idempotency-Key` header on mutating calls; overridable per-call.
+- Retry policy: 4 attempts, jittered exponential backoff, network + 5xx +
+  429 with `Retry-After`.
+- Configurable `timeoutMs` (default 30_000). The timeout covers the **response
+  body read**, not just time-to-headers, so a server that streams headers and
+  then stalls the body cannot hang a call indefinitely. Built on
+  `AbortSignal.timeout()`, and reports a `timed out after <n>ms` message.
+- `verifyWebhookSignature({ payload, signatureHeader, secret })` for
+  verifying `BillKit-Signature` webhooks (HMAC-SHA256 via Web Crypto,
+  5-min replay protection). Multiple `v1` signatures in one header are accepted
+  and pass if any matches, which is what keeps inbound webhooks verifying
+  through a signing-secret rotation.
+- **Opt-in logging.** Pass a `logger` to see the request/retry lifecycle:
+
+  ```ts
+  const client = new BillKit({ apiKey: "sk_test_...", logger: console });
+  ```
+
+  Omitted (the default) the SDK is silent: it ships no logger, no transport
+  and no destination, so it can't take over your application's output. The
+  `BillKitLogger` interface is two methods (`debug`/`warn`) that `console` and
+  a pino/winston child logger already satisfy without an adapter.
+
+  `debug` fires once per HTTP attempt and once per response (`method`, `url`,
+  `attempt`, `status`, `durationMs`, `requestId`); `warn` fires once per retry
+  with the reason and delay. Exported: `BillKitLogger`, `LogContext`,
+  `NOOP_LOGGER`.
+
+  API keys, request/response bodies and query strings are never passed to the
+  logger, and the final failure is thrown rather than logged so you never get a
+  duplicate entry.
+- ESM + CJS dual-package via `tsup`; `.d.ts` types shipped.
+
+### Notes
+- `giropay` is absent from the one-shot `method` union. Paydirekt wound the
+  scheme down: Mollie stopped processing it on 2024-06-30 and giropay shut down
+  entirely on 2024-12-31, so the API rejects `method: "giropay"` with a `422`.
+  The union keeps its `(string & {})` tail, so this narrows editor autocomplete
+  rather than constraining anyone passing a `string`-typed variable. Reading
+  back a one-shot paid with giropay before the shutdown works;
+  `OneShotPayment.method` is a plain `string`.
+
+[Unreleased]: https://github.com/billkit-eu/billkit-node/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/billkit-eu/billkit-node/releases/tag/v0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may accept and charge a
+      fee for the acceptance of support, warranty, indemnity, or other
+      liability obligations and/or rights consistent with this License.
+      However, in accepting such obligations, You may act only on Your
+      own behalf and on Your sole responsibility, not on behalf of any
+      other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by,
+      or claims asserted against, such Contributor by reason of your
+      accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 BillKit
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

package/README.md

@@ -0,0 +1,299 @@
+# BillKit Node.js SDK
+
+TypeScript-first client for [BillKit](https://billkit.eu), the Stripe-Billing-shape multi-tenant SaaS API on Mollie. Works in Node 20+, Bun, Deno, Cloudflare Workers, and any modern browser runtime.
+
+## Install
+
+```bash
+npm install @billkit-eu/sdk
+# or pnpm add @billkit-eu/sdk / yarn add @billkit-eu/sdk / bun add @billkit-eu/sdk
+```
+
+Requires Node 20+ (or any runtime with native `fetch` + `crypto.subtle`).
+
+## Quick start
+
+```ts
+import { BillKit } from "@billkit-eu/sdk";
+
+const client = new BillKit({ apiKey: process.env.BILLKIT_API_KEY });
+
+interface Customer {
+  id: string;
+}
+
+interface Product {
+  id: string;
+}
+
+interface Price {
+  id: string;
+}
+
+interface CheckoutSession {
+  url: string;
+}
+
+const customer = await client.customers.create<Customer>({
+  email: "ada@example.com",
+  name: "Ada Lovelace",
+});
+
+const product = await client.products.create<Product>({
+  name: "Pro",
+  description: "Hosted billing for SaaS",
+  marketing_features: ["Checkout", "Subscriptions"],
+});
+
+const price = await client.prices.create<Price>({
+  product_id: product.id,
+  amount_cents: 999,
+  currency: "EUR",
+  interval: "month",
+  trial_days: 14,
+  payment_methods: ["creditcard", "directdebit"],
+});
+
+const session = await client.checkoutSessions.create<CheckoutSession>({
+  customer_id: customer.id,
+  price_id: price.id,
+  success_url: "https://app.example.com/success",
+  cancel_url: "https://app.example.com/cancel",
+});
+
+console.log(session.url); // redirect the user here
+```
+
+### One-shot (mandate-less) payments
+
+A one-shot is a single charge with no subscription, mandate or renewals: the Stripe PaymentIntent shape, mapped onto Mollie. Create it, redirect to `redirect_url`, and settle terminal state via the `one_shot_payment.succeeded` / `.failed` webhook events.
+
+```ts
+const payment = await client.oneShotPayments.create({
+  customer_id: customer.id,
+  amount_cents: 2500,
+  currency: "EUR",
+  method: "ideal",
+  success_url: "https://shop.example.com/thanks",
+  refund_window_days: 14, // optional; 0 disables refunds, default is 30
+});
+
+console.log(payment.redirect_url); // redirect the payer here
+
+// Later, refund it within its window (omit amount_cents for a full refund):
+await client.refunds.create({ one_shot_payment_id: payment.id });
+// ...or refund part of it. A charge can carry several partials:
+await client.refunds.create({ one_shot_payment_id: payment.id, amount_cents: 500 });
+```
+
+## Resources
+
+The client exposes one accessor per resource family. Each mirrors the verbs from `/v1/<resource>` 1:1:
+
+| Accessor | Verbs |
+| --- | --- |
+| `client.customers` | `create`, `retrieve`, `update`, `delete`, `list`, `iter` |
+| `client.products` | `create`, `retrieve`, `update`, `delete`, `list`, `iter` |
+| `client.prices` | `create`, `retrieve`, `list`, `iter` |
+| `client.checkoutSessions` | `create`, `retrieve` |
+| `client.oneShotPayments` | `create`, `retrieve` |
+| `client.subscriptions` | `retrieve`, `list`, `iter`, `cancel`, `pause`, `resume`, `previewUpdate`, `update`, `reauthorizePaymentMethod` |
+| `client.refunds` | `create`, `retrieve`, `list`, `iter` |
+| `client.webhookEndpoints` | `create`, `retrieve`, `update`, `delete`, `rotateSecret`, `list`, `iter`, `listDeliveries`, `iterDeliveries`, `getDelivery`, `redeliver` |
+| `client.events` | `retrieve`, `list`, `iter` (filter by `type`) |
+| `client.tenant` | `capabilities`, `portalBranding`, `setPortalBranding`, `rotateProviderCredential` |
+| `client.coupons` | `create`, `retrieve`, `update`, `delete`, `validate`, `list`, `iter` |
+| `client.taxRates` | `create`, `retrieve`, `update`, `delete`, `list`, `iter` |
+| `client.invoices` | `retrieve`, `list`, `iter` |
+| `client.auditLogs` | `retrieve`, `list`, `iter` (filter by `action`, `resource_type`, `actor_id`) |
+| `client.payments` | `retrieve`, `list`, `iter` |
+| `client.billingPortalSessions` | `create`, `revoke` |
+
+## Auto-pagination
+
+Every list-returning resource ships an `iter()` async iterator that walks the Stripe-shape `has_more` + `starting_after` cursor protocol for you. No more manual cursor loops:
+
+```ts
+for await (const customer of client.customers.iter()) {
+  console.log(customer);
+}
+
+// Filter at the server, raise the page size to cut round-trips:
+for await (const evt of client.events.iter({ type: "subscription.created", pageSize: 100 })) {
+  await handle(evt);
+}
+
+// Audit walk scoped to one actor:
+for await (const row of client.auditLogs.iter({ actor_id: "act_1" })) {
+  await archive(row);
+}
+```
+
+## Configuration
+
+```ts
+import { BillKit } from "@billkit-eu/sdk";
+
+const client = new BillKit({
+  apiKey: "sk_test_...",                  // or set BILLKIT_API_KEY
+  baseUrl: "https://api.billkit.eu",   // override for self-hosted
+  timeoutMs: 30_000,
+  retryPolicy: {
+    maxAttempts: 5,
+    initialBackoffMs: 500,
+    backoffMultiplier: 2,
+    maxBackoffMs: 8000,
+    maxRetryAfterMs: 10_000,
+    jitter: 0.25,
+  },
+  fetch: customFetch, // inject for tests / proxies
+  logger: console,     // opt-in; omitted = silent (see Logging)
+});
+```
+
+The SDK auto-generates an `Idempotency-Key` for every mutating call, so 5xx and short `Retry-After` 429 retries are safe: the server replays the original response when an earlier attempt completed. Pass `idempotencyKey` to coalesce retries across process restarts.
+
+## Errors
+
+```ts
+import {
+  BillKit,
+  ResourceMissingError,
+  RateLimitError,
+  BillKitError,
+} from "@billkit-eu/sdk";
+
+try {
+  const customer = await client.customers.retrieve("cus_doesnt_exist");
+} catch (err) {
+  if (err instanceof ResourceMissingError) {
+    console.log("Customer is gone");
+  } else if (err instanceof RateLimitError) {
+    console.log(`Rate limited; retry in ${err.retryAfter}s`);
+  } else if (err instanceof BillKitError) {
+    console.log(`BillKit error ${err.statusCode}: ${err.message}`);
+  } else {
+    throw err;
+  }
+}
+```
+
+All errors inherit from `BillKitError`. Subclasses: `APIConnectionError`, `APIError`, `ServerError`, `AuthenticationError`, `PermissionError`, `ResourceMissingError`, `InvalidRequestError`, `ConflictError`, `RateLimitError`.
+
+## Logging
+
+The SDK is **silent by default**. It ships no logger, no transport and no destination, so it can't take over your application's output because it never picks one. Hand it a logger to opt in:
+
+```ts
+const client = new BillKit({ apiKey: "sk_test_...", logger: console });
+```
+
+```
+BillKit request  { method: 'POST', url: 'https://api.billkit.eu/v1/customers', attempt: 1, maxAttempts: 3 }
+BillKit response { method: 'POST', url: '.../v1/customers', status: 503, durationMs: 84, requestId: 'req_9f2a' }
+BillKit retrying { method: 'POST', url: '.../v1/customers', reason: 'HTTP 503', attempt: 1, delayMs: 500 }
+BillKit response { method: 'POST', url: '.../v1/customers', status: 200, durationMs: 91, requestId: 'req_9f2b' }
+```
+
+- **`debug`**: one call per attempt, one per response (`status`, `durationMs`, `requestId`; quote that id to support).
+- **`warn`**: one call per retry, with the reason and the delay before the next attempt.
+
+`console` satisfies the interface as-is, and so does a pino/winston/bunyan child logger. It's deliberately two methods:
+
+```ts
+interface BillKitLogger {
+  debug(message: string, context?: Record<string, unknown>): void;
+  warn(message: string, context?: Record<string, unknown>): void;
+}
+```
+
+If your logger takes context first, wrap it:
+
+```ts
+const client = new BillKit({
+  apiKey: "sk_test_...",
+  logger: {
+    debug: (m, c) => pino.debug(c, m),
+    warn: (m, c) => pino.warn(c, m),
+  },
+});
+```
+
+**Never logged:** your API key or the `Authorization` header; request and response **bodies** (they carry customer PII); the **query string** (list filters carry values like `email=`); only the path is logged. The final failure isn't logged either: it's thrown as a typed `BillKitError` carrying the status, request id and retry-after, and logging it here too would hand you a duplicate you can't suppress.
+
+## Webhook verification
+
+Works in Node, Bun, Deno, Cloudflare Workers and the browser, anywhere `globalThis.crypto.subtle` exists.
+
+```ts
+import { verifyWebhookSignature, WebhookVerificationError } from "@billkit-eu/sdk";
+
+// Hono / Express / Bun.serve / Workers fetch handler:
+try {
+  const event = await verifyWebhookSignature({
+    payload: rawBody,                          // string or Uint8Array
+    signatureHeader: request.headers.get("BillKit-Signature"),
+    secret: process.env.BILLKIT_WEBHOOK_SECRET,
+  });
+
+  if (event.type === "subscription.created") {
+    await handleNewSubscription(event.data);
+  }
+
+  return new Response("ok");
+} catch (err) {
+  if (err instanceof WebhookVerificationError) {
+    return new Response("invalid signature", { status: 400 });
+  }
+  throw err;
+}
+```
+
+The verifier enforces a 5-minute timestamp tolerance (replay protection) and constant-time HMAC compare. Pass `toleranceSeconds` to customise.
+
+## TypeScript
+
+Every method is generic so you can hand in your own response type:
+
+```ts
+interface Customer {
+  id: string;
+  email: string;
+  created_at: string;
+}
+
+const customer = await client.customers.retrieve<Customer>("cus_1");
+//    ^ Customer
+```
+
+The SDK doesn't ship runtime schemas (zod / valibot). The API is Stripe-shape and most callers forward the JSON through to their own data layer unchanged. Bring your own validator if you need one.
+
+Per-call param shapes are exported for callers who want to type their inputs ahead of time:
+
+```ts
+import type {
+  CreateCouponParams,
+  CreateBillingPortalSessionParams,
+} from "@billkit-eu/sdk";
+
+const couponParams: CreateCouponParams = {
+  code: "WELCOME10",
+  discount_type: "percentage",
+  discount_value: 10,
+  duration: "once",
+};
+await client.coupons.create(couponParams);
+```
+
+## Development
+
+```bash
+npm install
+npm run typecheck
+npm test
+npm run build
+```
+
+## License
+
+Proprietary.