@kaitencloud/server 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 reasonable and customary use in 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 choose to offer,
+      and charge a fee for, 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 [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,2 @@
+Kaiten
+Copyright 2026 KAITEN INC

package/README.md

@@ -0,0 +1,171 @@
+# @kaitencloud/server
+
+Server SDK for Kaiten — for **Node/TS backends** authenticating with a **secret API token
+(Bearer)**. Exposes the **full typed contract** as resource classes generated from the
+same OpenAPI snapshot as [`@kaitencloud/client`](../client), so coverage tracks the contract
+automatically.
+
+> **In the browser?** Use **[`@kaitencloud/client`](../client)**, which never holds a secret
+> there. This package runs on servers only, and its secret token must never reach a browser
+> bundle.
+
+## Install
+
+```bash
+npm install @kaitencloud/server
+```
+
+**Requires Node 20.19 or newer.** This package ships both ESM and CommonJS, so it works
+from either module system — `import` and `require` both resolve, and the types follow:
+
+```js
+const { createKaitenClient } = require("@kaitencloud/server"); // CommonJS
+```
+
+It is the only package here that is dual-built, because it is the only one meant to run on
+a backend. The browser package, `@kaitencloud/client`, is **ESM-only and requires Node 22.12+**
+when used outside a bundler — 22.12 is the release where Node can `require()` an ES module.
+Every bundler handles it regardless of your app's module format.
+
+## Quick start
+
+```ts
+import { createKaitenClient, Customers, Licenses } from "@kaitencloud/server";
+
+const client = createKaitenClient({
+  baseUrl: process.env.KAITEN_API_URL!, // the URL of your Kaiten API
+  token: process.env.KAITEN_API_TOKEN!, // secret key, sent as Bearer
+});
+
+const customers = await Customers.listCustomers({ client });
+const license = await Licenses.getLicense({ client, path: { licenseSlug: "pro" } });
+```
+
+`createKaitenClient({ baseUrl, token, fetch? })` returns a Bearer-authenticated client you
+pass to each resource call via `{ client }`. `token` may be a string or a (sync/async)
+function, and each factory call yields an independent client — so one process can talk to
+the API with several tokens.
+
+`baseUrl` is the URL of your Kaiten API, and it is required: there is no default. The
+contract is served under `/api` (`servers: - url: /api`), so that prefix is appended when
+your value does not already end with it: `https://kaiten.example.com`,
+`https://kaiten.example.com/` and `https://kaiten.example.com/api` all resolve the same way.
+A missing or non-absolute value throws.
+
+## Errors
+
+**Failed calls throw.** Errors are normalized to `KaitenError` (the API answered with a
+failure status) or `KaitenNetworkError` (the request never got there), both real `Error`
+subclasses carrying a `kind` discriminant:
+
+```ts
+import { Instances, isThresholdExceeded, KaitenError } from "@kaitencloud/server";
+
+try {
+  await Instances.reportEntitlementUsageMetric({
+    client,
+    path: { instanceSlug, entitlementSlug: "seats" },
+    body: { value: { type: "number", value: 1 }, behavior: "append" },
+  });
+} catch (error) {
+  // The increment would cross the license limit: the enforcement signal.
+  if (isThresholdExceeded(error)) return denyAndPromptUpgrade();
+  if (error instanceof KaitenError) {
+    log.warn({ status: error.status, code: error.code, errorId: error.errorId }, error.detail);
+  }
+  throw error;
+}
+```
+
+`isThresholdExceeded` recognizes that refusal by its code,
+`ReportEntitlementUsageMetric.ThresholdExceeded`. Other operations answer 409 for other
+conflicts, such as a slug already taken, so the predicate is safe in a shared error handler.
+That refusal is the single most important response this package can return, and the easiest
+one to miss.
+
+Every `KaitenError` also carries the problem's `code`, a stable machine-readable identifier
+such as `License.NotFound`, and its `errorId`, the correlation id of the API's log entry for
+the failure: quote it when you report a problem.
+
+## Webhooks
+
+The contract declares 49 `com.kaiten.*` events and this package ships a typed payload for
+each — but a payload alone says nothing about **who sent it**. Verify the signature before
+acting on one; until you do, the endpoint is unauthenticated and it drives licences and usage.
+
+```ts
+import express from "express";
+import { verifyKaitenWebhook } from "@kaitencloud/server";
+
+app.post("/kaiten", express.raw({ type: "application/json" }), async (req, res) => {
+  let event;
+  try {
+    event = await verifyKaitenWebhook({
+      payload: req.body, // the RAW bytes — see below
+      headers: req.headers,
+      secret: process.env.KAITEN_WEBHOOK_SECRET!, // the endpoint's `whsec_…`
+    });
+  } catch {
+    return res.sendStatus(401);
+  }
+
+  switch (event.type) {
+    case "com.kaiten.customer.v1.created":
+      // narrowed to the customer-created payload here
+      break;
+  }
+
+  res.sendStatus(204);
+});
+```
+
+> **Pass the raw body.** The signature covers the bytes on the wire, so a body that has been
+> parsed and re-serialized — which is exactly what `express.json()` gives you — will not
+> verify even when it is genuine: key order, whitespace and Unicode escaping all change the
+> bytes. Use `express.raw()`, `await request.text()`, or your framework's raw-body hook.
+
+Kaiten does not sign its webhooks itself: delivery goes through **Svix**, so this implements
+the Svix / Standard Webhooks format (`svix-id` / `svix-timestamp` / `svix-signature`, with the
+unbranded `webhook-*` names accepted too; HMAC-SHA256 over `id.timestamp.payload`; a 5-minute
+timestamp tolerance; several signatures in one header so a secret can be rotated without
+dropping deliveries). It is checked against the reference implementation's own golden vector.
+
+Verification uses WebCrypto rather than `node:crypto`, so this package still runs unchanged on
+Deno, Bun and edge runtimes.
+
+## Resources
+
+Generated and grouped by tag: `Customers`, `Instances`, `Licenses`, `Entitlements`,
+`EntitlementGroups`, `Components`, `DeploymentZones`, `MetadataFields`, `Releases`,
+`ServiceAccounts`, `Connectors`, `Integrations`, `Featureflags`, `OfrepCore`,
+`OpenFeature`.
+
+These cover the Core API. Organization and user administration belongs to a separate API,
+under `/api/platform/**`, with its own credentials; this SDK does not model it (see
+[ARCHITECTURE.md](../../ARCHITECTURE.md)).
+
+### Token lifetime
+
+A token stops being honoured exactly at its `expires_at`, with no grace period: plan the
+renewal of a short-lived token before that instant.
+
+## Development
+
+```bash
+vp install
+vp run generate   # regenerate from contracts/openapi.yaml
+vp check
+vp test
+vp pack
+```
+
+The resource classes are generated and must not be edited by hand; contract parity is
+enforced by the OpenAPI drift gate and the `generated-sdk` CI job (which regenerates both
+`@kaitencloud/client` and `@kaitencloud/server`).
+
+## License
+
+Apache-2.0. See `LICENSE` and `NOTICE`, and `THIRD_PARTY_NOTICES.md` for the
+third-party code this package bundles. The license does not grant permission to use
+the Kaiten name or logos: see the
+[trademark policy](https://github.com/kaitencloud/sdk-js/blob/main/TRADEMARKS.md).

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,95 @@
+# Third-Party Notices
+
+This file is reserved for attribution notices that must accompany third-party
+materials distributed with Kaiten.
+
+Do not add every dependency automatically.
+
+Add an entry here when Kaiten directly distributes, copies, embeds, or vendors
+third-party material whose license requires preservation of an attribution,
+notice, copyright statement, or similar information.
+
+For each applicable item, record:
+
+- component or material name;
+- source/project;
+- version or commit where useful;
+- copyright holder(s);
+- applicable license;
+- required attribution or notice;
+- location of the corresponding license text.
+
+Third-party license obligations must also be reflected in distributed artifacts
+where required by the applicable license.
+
+## Notices
+
+### HTTP client runtime of `@hey-api/openapi-ts`
+
+- **Material:** the `client/` and `core/` directories that `@hey-api/openapi-ts`
+  writes next to the generated code, in `packages/client/src/core/generated/` and
+  `packages/server/src/generated/`.
+- **Distributed in:** `@kaitencloud/client` and `@kaitencloud/server`, bundled into
+  their `dist/`.
+- **Source:** https://github.com/hey-api/hey-api, at the version `pnpm-lock.yaml`
+  pins.
+- **Copyright:** Copyright (c) Hey API
+- **License:** MIT, reproduced below.
+
+```text
+MIT License
+
+Copyright (c) Hey API
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+### `TypedDocumentString` of GraphQL Code Generator
+
+- **Material:** the `TypedDocumentString` class that the GraphQL Code Generator
+  client preset writes into `packages/client/src/graphql/generated/graphql.ts`.
+- **Distributed in:** `@kaitencloud/client`, bundled into its `dist/`.
+- **Source:** https://github.com/dotansimha/graphql-code-generator, at the version
+  `pnpm-lock.yaml` pins.
+- **Copyright:** Copyright (c) 2016 Dotan Simha
+- **License:** MIT, reproduced below.
+
+```text
+The MIT License (MIT)
+
+Copyright (c) 2016 Dotan Simha
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```