@intentgate-app/intentgate 0.3.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 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 2026 IntentGate contributors
+
+   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,160 @@
+# IntentGate TypeScript SDK
+
+[![CI](https://github.com/IntentGate-app/intentgate-sdk-typescript/actions/workflows/ci.yml/badge.svg)](https://github.com/IntentGate-app/intentgate-sdk-typescript/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/@intentgate-app/intentgate.svg)](https://www.npmjs.com/package/@intentgate-app/intentgate)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Node 18+](https://img.shields.io/badge/node-%3E=18-339933.svg)](package.json)
+
+TypeScript SDK for the [IntentGate](https://github.com/IntentGate-app/intentgate-gateway) authorization gateway.
+
+Three lines wraps any agent's tool call with capability + intent + policy + budget checks:
+
+```ts
+import { Gateway } from "@intentgate-app/intentgate";
+
+const gw = new Gateway("http://localhost:8080", {
+  token: process.env.INTENTGATE_TOKEN,
+});
+const result = await gw.toolCall("read_invoice", {
+  arguments: { id: "123" },
+  intentPrompt: "Process today's AP invoices",
+});
+```
+
+`toolCall` resolves with the tool's response when the gateway allows the call, and throws a typed exception (`CapabilityError`, `IntentError`, `PolicyError`, `BudgetError`) when it blocks. Network failures throw `GatewayError`.
+
+**Zero runtime dependencies.** The SDK uses Node's native `fetch` (Node 18+) and `node:crypto` for HMAC. No third-party packages in `dependencies`.
+
+---
+
+## Install
+
+```sh
+npm install @intentgate-app/intentgate
+# or
+pnpm add @intentgate-app/intentgate
+# or
+yarn add @intentgate-app/intentgate
+```
+
+Requires **Node 18+**. Works in browsers and edge runtimes that provide `fetch` and a `crypto.subtle`-equivalent (call sites that use `attenuate` need `node:crypto` so are Node-only today; `Gateway.toolCall` is portable).
+
+## What you get
+
+| Export | What it does |
+| --- | --- |
+| `Gateway` | HTTP client. `gw.toolCall(tool, opts)` invokes a tool through the gateway; throws typed errors on deny. |
+| `attenuate` | Pure-TS capability attenuation. Derive a strictly-narrower child token from a parent without touching the gateway's master key. |
+| `decodeToken` | Inspect a token's claims and caveats (no signature check; the gateway does that). |
+| `IntentGateError` family | Typed catch surface — `CapabilityError`, `IntentError`, `PolicyError`, `BudgetError`, plus `GatewayError` (transport) and `ProtocolError` (malformed JSON-RPC). |
+
+## Capability attenuation
+
+A parent agent can derive a narrower token for a sub-agent in one call. The chained-HMAC signature means the sub-agent can't widen the chain — only narrow it further:
+
+```ts
+import { attenuate } from "@intentgate-app/intentgate";
+
+// Parent token allows [search, read, email] for the next hour.
+// Child: only [search, read], one call max.
+const child = attenuate(parentToken, {
+  addTools: ["search", "read"],
+  maxCalls: 1,
+});
+
+// Hand `child` to the sub-agent. The gateway will reject any call
+// to `email` with a CapabilityError because the parent's tool_allow
+// caveat plus the child's tool_allow caveat intersect at [search, read].
+```
+
+Available narrowings:
+
+- `addTools: string[]` — `tool_allow` caveat (intersection)
+- `denyTools: string[]` — `tool_deny` caveat (additive blacklist)
+- `maxCalls: number` — `max_calls` caveat (the chain enforces the minimum)
+- `expiresAt: number` (Unix seconds) or `expiresInSeconds: number` — `exp` caveat
+- `extra: Caveat[]` — append arbitrary caveats (advanced)
+
+## Error handling
+
+```ts
+import { Gateway, CapabilityError, IntentError, GatewayError } from "@intentgate-app/intentgate";
+
+try {
+  const result = await gw.toolCall("delete_user", {
+    arguments: { id: "u-123" },
+    intentPrompt: "Onboard a new employee",
+  });
+  // ...
+} catch (err) {
+  if (err instanceof CapabilityError) {
+    // Token rejected (signature, expiry, agent lock, tool whitelist).
+  } else if (err instanceof IntentError) {
+    // The user's prompt didn't authorize this tool.
+  } else if (err instanceof GatewayError) {
+    // Could not reach the gateway, or non-JSON-RPC response.
+    console.error("gateway transport problem:", err.message);
+  } else {
+    throw err;
+  }
+}
+```
+
+Every error carries `code` (the JSON-RPC code: `-32010` capability, `-32011` intent, `-32012` policy, `-32013` budget) and `data` (the gateway's reason string).
+
+## Testing your integration
+
+The SDK accepts a custom `fetch` implementation via the `fetch` option, so you can drive `Gateway` from unit tests without standing up a real gateway:
+
+```ts
+import { vi } from "vitest";
+import { Gateway } from "@intentgate-app/intentgate";
+
+const fakeFetch = vi.fn().mockResolvedValue(
+  new Response(JSON.stringify({
+    jsonrpc: "2.0",
+    id: 1,
+    result: { content: [{ type: "text", text: "ok" }], isError: false },
+  })),
+);
+const gw = new Gateway("http://gw.test", { fetch: fakeFetch });
+```
+
+For higher fidelity, run the gateway in a container (`ghcr.io/intentgate-app/intentgate-gateway:latest`) and point the SDK at it.
+
+## Companion repositories
+
+| Repo | What |
+| --- | --- |
+| [intentgate-gateway](https://github.com/IntentGate-app/intentgate-gateway) | The Go gateway this SDK talks to |
+| [intentgate-sdk-python](https://github.com/IntentGate-app/intentgate-sdk-python) | Python equivalent (byte-compatible attenuation) |
+| [intentgate-helm](https://github.com/IntentGate-app/intentgate-helm) | Helm chart for cluster deployment |
+| [intentgate-extractor](https://github.com/IntentGate-app/intentgate-extractor) | Intent extractor service |
+
+## Compatibility
+
+| Gateway | SDK |
+| --- | --- |
+| `>= 1.1` (latest) | `0.1.x` (recommended) |
+| `1.0.x` | `0.1.x` (works; no `/v1/admin/tenants` for tenant switcher use cases) |
+| `< 0.9` | not supported (token v3 with signed tenant claim required) |
+
+## Development
+
+```sh
+npm install
+npm run typecheck
+npm run lint
+npm test
+npm run build
+```
+
+Pre-publish runs all of the above; `npm run build` produces `dist/index.js` (ESM), `dist/index.cjs` (CommonJS), and `dist/index.d.ts` (types).
+
+## Releasing
+
+Maintainers: see [`RELEASING.md`](RELEASING.md) for the one-time npm trusted-publisher setup and the tag-to-publish workflow.
+
+## License
+
+Apache 2.0. See [LICENSE](LICENSE).