@pliuz/sdk 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to `@pliuz/sdk` (TypeScript SDK) are 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).
+
+## [0.1.0] — 2026-05-21
+
+### Added
+
+- **`gated(options, fn)`** — the headline wrapper. Pauses any function for
+  human approval via Pliuz before executing. Always returns
+  `Promise<TResult>`. Auto-generates deterministic idempotency keys.
+- **`PliuzClient`** — low-level client for the 3 SDK-facing endpoints
+  (`POST /approvals`, `GET /:id`, `POST /:id/execution`). Uses native
+  `fetch` + `AbortController`. Configurable retries, timeouts, custom
+  fetch injection for testing.
+- **`applyRedaction(payload, paths)`** — client-side field redaction with
+  dotted-path + `[*]` array-wildcard syntax. Sensitive fields never
+  leave the caller's process plaintext.
+- **Typed error hierarchy** — `PliuzError` base + 12 specific subclasses
+  (`PliuzAuthError`, `PliuzPolicyError`, `PliuzRejectedError`,
+  `PliuzApprovalExpiredError`, `PliuzApprovalTimeoutError`, etc.).
+  Each preserves `instanceof` correctness across ESM and CJS targets.
+- **`gatedTool()`** (Vercel AI SDK adapter, optional) — wraps `tool({...})`
+  from `ai` so any Vercel AI agent can gate execution. Surfaces input
+  dict directly as Pliuz `tool_args` for clean audit logs.
+- **Dual ESM/CJS output** via tsup, with `.d.ts` + `.d.cts` for both.
+- **Cross-language idempotency** — same algorithm as the Python SDK,
+  so a call from Python and TS with same args produces the same key.
+- **49 unit/contract/retry tests + 3 integration tests**.
+
+### Requirements
+
+- Node ≥ 18.17 (uses native `fetch` + `AbortController`)
+- Optional peer: `ai >= 4.0` for the Vercel AI SDK adapter
+
+### Stability
+
+- `gated`, `PliuzClient`, `errors.*` — stable across 0.x patches
+- `adapters/*` — experimental, may shift before 1.0
+
+## [0.0.1] — 2026-05-21
+
+Placeholder release — reserved the `@pliuz/sdk` name on npm. Not functional.

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 Support. 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 support.
+
+   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 Pliuz
+
+   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,332 @@
+# @pliuz/sdk — TypeScript SDK
+
+[![npm](https://img.shields.io/npm/v/@pliuz/sdk)](https://www.npmjs.com/package/@pliuz/sdk)
+[![Node](https://img.shields.io/node/v/@pliuz/sdk)](https://www.npmjs.com/package/@pliuz/sdk)
+[![License](https://img.shields.io/npm/l/@pliuz/sdk)](https://github.com/mwhitex/pliuz/blob/main/sdk-typescript/LICENSE)
+
+> **Human-in-the-loop approval gates for AI agents.** Wrap any function in `gated()` to pause execution, route the call to a human approver via Pliuz, then resume — or abort — based on the decision. Every call is audited.
+
+```typescript
+import { gated } from '@pliuz/sdk'
+
+const issueRefund = gated(
+  {
+    policy: 'refund',
+    redact: ['customer.ssn'],
+    toolArgs: (customerId: string, amountCents: number) => ({
+      customer_id: customerId,
+      amount_cents: amountCents,
+    }),
+  },
+  async (customerId: string, amountCents: number) => {
+    return stripe.refunds.create({ customer: customerId, amount: amountCents })
+  },
+)
+
+// Pauses. A human gets a Slack card. They click approve.
+// Then your code runs — and Pliuz records the outcome.
+const result = await issueRefund('cus_123', 5000)
+```
+
+---
+
+## Install
+
+```bash
+npm install @pliuz/sdk
+# or, with the Vercel AI SDK adapter
+npm install @pliuz/sdk ai
+```
+
+Requires Node ≥ 18.17 (uses native `fetch` + `AbortController`).
+
+## Quickstart
+
+### 1. Get an API key
+
+Sign up at [pliuz.dev](https://pliuz.dev), create an agent in the dashboard, copy the key.
+
+### 2. Set the env var
+
+```bash
+export PLIUZ_API_KEY=pli_live_...
+```
+
+### 3. Gate a function
+
+```typescript
+import { gated } from '@pliuz/sdk'
+
+const runSql = gated(
+  { policy: 'risky_query' },
+  async (query: string) => db.execute(query),
+)
+
+// Blocks until a human approves (or rejects, or it expires).
+const rows = await runSql("DELETE FROM users WHERE created_at < '2024-01-01'")
+```
+
+That's it. Pliuz handles the rest: idempotency, retries, audit logging, hash-chained event log.
+
+## What `gated()` does
+
+```
+yourFn(...args)                                  yourFn(...args)
+     │                                                  │
+     ▼                                                  ▼
+ ┌──────────┐  POST /approvals                    ┌──────────┐
+ │  gated   │ ───────────────►  ┌─────────────┐  │  gated   │
+ │ wrapper  │                   │   Pliuz API  │  │ wrapper  │
+ │          │  ◄─────────────── └─────────────┘  │          │
+ └──────────┘     status=pending          ▲      └──────────┘
+     │                                    │           │
+     │              poll every 2s         │           ▼
+     │ ────────────────────────────────► humans  ┌──────────┐
+     ▼                                    │      │ original │
+ ┌──────────┐  status=approved            │      │   fn()   │
+ │ execute  │ ◄──────────────────────────┘      └──────────┘
+ │ original │                                         │
+ │   fn()   │  POST /:id/execution                    ▼
+ └──────────┘ ─────────────────────────►       audit log
+     │
+     ▼
+   result
+```
+
+## Features
+
+- **Zero dependencies** — uses native `fetch` + `AbortController`
+- **Dual ESM/CJS** — works in any modern Node project
+- **First-class TypeScript** — fully typed, including narrow error subclasses
+- **Idempotency** via deterministic key hashing — safe to retry from anywhere
+- **Client-side redaction** — sensitive fields never leave your process plaintext
+- **Cancellable** via `AbortSignal` (pass `timeoutMs`)
+- **Single-shot execution reporting** — closes the audit loop automatically
+- **Typed errors** — `PliuzRejectedError`, `PliuzApprovalExpiredError`, `PliuzPolicyError`, etc.
+- **Vercel AI SDK adapter** — `gatedTool()` wraps `tool({...})` from `ai` so existing AI SDK agents gate transparently
+
+---
+
+## API
+
+### `gated()` — the headline
+
+```typescript
+import { gated } from '@pliuz/sdk'
+
+const wrapped = gated(
+  {
+    policy: 'refund',                  // Pliuz policy slug (optional)
+    redact: ['customer.ssn'],          // Dotted paths to strip BEFORE sending
+    timeoutMs: 300_000,                // Max polling duration (5 min default)
+    pollIntervalMs: 2000,              // Time between status checks
+    toolName: 'custom_name',           // Override fn.name
+    toolArgs: (...args) => ({ ... }),  // Map positional args → tool_args object
+    client: pliuz,                     // Reuse a client (default: lazy from env)
+    contextMessages: ['extra info for the human'],
+    sessionId: 'trace-abc',
+    originator: { type: 'user', id: 'user-42' },
+  },
+  async (...args) => { ... },
+)
+```
+
+**Why `toolArgs`**: JS lacks named-parameter introspection. By default, all positional args go to `{ args: [...] }`. Provide a `toolArgs` mapper to get cleaner audit logs.
+
+### Errors
+
+```typescript
+import {
+  PliuzError,                     // base
+  PliuzApiError,                  // any 4xx/5xx from Pliuz API
+  PliuzAuthError,                 // 401 — bad/missing key
+  PliuzForbiddenError,            // 403 — agent mismatch
+  PliuzNotFoundError,             // 404
+  PliuzConflictError,             // 409 — duplicate execution report
+  PliuzValidationError,           // 400 — invalid body
+  PliuzPolicyError,               // 422 — no policy matched
+  PliuzRateLimitError,            // 429
+  PliuzServerError,               // 5xx
+  PliuzNetworkError,              // connection failed
+  PliuzTimeoutError,              // request timed out
+  PliuzRejectedError,             // human said no
+  PliuzApprovalExpiredError,      // SLA expired before human decided
+  PliuzApprovalTimeoutError,      // SDK polling gave up
+} from '@pliuz/sdk'
+
+try {
+  await issueRefund(...)
+} catch (e) {
+  if (e instanceof PliuzRejectedError) {
+    console.log('Human rejected:', e.reason)
+    return
+  }
+  if (e instanceof PliuzApprovalTimeoutError) {
+    // Poll later via client.getApproval(e.approvalId)
+  }
+  throw e
+}
+```
+
+### Low-level client
+
+```typescript
+import { PliuzClient } from '@pliuz/sdk'
+
+const pliuz = new PliuzClient()  // reads PLIUZ_API_KEY
+
+const created = await pliuz.createApproval({
+  tool_name: 'refund',
+  tool_args: { amount: 100 },
+  idempotency_key: 'abc-123',
+})
+
+const fetched = await pliuz.getApproval(created.id)
+
+await pliuz.reportExecution(created.id, {
+  status: 'success',
+  latency_ms: 42,
+})
+```
+
+### Redaction
+
+```typescript
+import { applyRedaction } from '@pliuz/sdk'
+
+const clean = applyRedaction(
+  { customer: { ssn: '123-45-6789', id: 'cus_x' } },
+  ['customer.ssn'],
+)
+// { customer: { ssn: '<redacted>', id: 'cus_x' } }
+```
+
+Supports dotted paths and `[*]` for array wildcards:
+
+```typescript
+applyRedaction({ items: [{ card: '...' }] }, ['items[*].card'])
+```
+
+Input is never mutated — returns a deep clone.
+
+### Vercel AI SDK integration (optional)
+
+```bash
+npm install ai
+```
+
+```typescript
+import { tool, generateText } from 'ai'
+import { z } from 'zod'
+import { gatedTool } from '@pliuz/sdk/adapters/ai'
+
+const issueRefund = gatedTool(
+  { policy: 'refund', redact: ['customer.ssn'] },
+  tool({
+    description: 'Issue a refund to a customer',
+    parameters: z.object({
+      customer_id: z.string(),
+      amount_cents: z.number().int().positive(),
+    }),
+    execute: async ({ customer_id, amount_cents }) =>
+      stripe.refunds.create({ customer: customer_id, amount: amount_cents }),
+  }),
+)
+
+const { text } = await generateText({
+  model: openai('gpt-4o'),
+  tools: { issueRefund },
+  prompt: 'Refund cus_123 for $50',
+})
+```
+
+The wrapped tool preserves `description` and `parameters` — the LLM sees it identically. Only the execution path is gated.
+
+---
+
+## Configuration
+
+| Env var | Default | Purpose |
+|---|---|---|
+| `PLIUZ_API_KEY` | _(required)_ | Per-agent API key. `pli_live_...` format. |
+| `PLIUZ_BASE_URL` | `https://pliuz-dev.vercel.app` | Override for self-hosted or staging. |
+
+All env vars can be passed as `PliuzClient` constructor options:
+
+```typescript
+new PliuzClient({ apiKey: 'pli_live_...', baseUrl: 'https://pliuz.mycompany.com' })
+```
+
+---
+
+## Production tips
+
+### Idempotency
+
+`gated()` automatically generates a deterministic `idempotency_key` per call — same args → same key. The backend dedupes within 24 h, so safe to retry from anywhere (queues, retry loops, agent restarts).
+
+```typescript
+const refund = gated({ policy: 'refund' }, async (id: string, cents: number) => {
+  // ...
+})
+
+// Calling twice in a 24h window → only 1 approval request created.
+// Same human decision applies to both. No duplicate refunds.
+await refund('cus_123', 5000)
+await refund('cus_123', 5000)
+```
+
+### Cross-language idempotency
+
+The idempotency hash algorithm is identical to the [Python SDK](https://pypi.org/project/pliuz/). A call from Python + a call from TypeScript with the same `tool_name`, `tool_args`, and `sessionId` produces the same key.
+
+### Custom timeouts per call
+
+- **Live user-facing**: `timeoutMs: 30_000`
+- **Background jobs**: `timeoutMs: 86_400_000` (24 h)
+- **Critical security gates**: don't use `gated()` — use a synchronous Pliuz dashboard flow
+
+### When `gated()` rejects mid-execution
+
+If polling exceeds `timeoutMs`, you get `PliuzApprovalTimeoutError`. **Your wrapped function never runs.** The approval may still resolve later server-side — handle the retry with `pliuz.getApproval(e.approvalId)`.
+
+### Edge / Bun / Deno
+
+The SDK uses only `fetch` + `AbortController` + `crypto.createHash`. Should work in any modern runtime that exposes these (Bun, Deno via `npm:` specifier, Vercel Edge, Cloudflare Workers). Not tested in CI — file an issue if you hit anything.
+
+---
+
+## Versioning
+
+This SDK follows [SemVer](https://semver.org). The current line is `0.x.y` — minor versions may include breaking changes until `1.0.0`.
+
+| Surface | Stability |
+|---|---|
+| `gated`, `PliuzClient` | Stable across 0.x patches |
+| `errors.*` | Stable across 0.x patches |
+| `adapters/*` | Experimental — may shift before 1.0 |
+
+---
+
+## Examples
+
+See [`examples/`](./examples) for runnable scripts:
+
+- [`basic.ts`](./examples/basic.ts) — bare `PliuzClient` (no wrapper)
+- [`gated-basic.ts`](./examples/gated-basic.ts) — `gated()` happy path
+- [`vercel-ai-agent.ts`](./examples/vercel-ai-agent.ts) — Vercel AI SDK agent with gated tools
+
+---
+
+## Links
+
+- **Docs**: https://pliuz.dev/docs
+- **GitHub**: https://github.com/mwhitex/pliuz
+- **Issues**: https://github.com/mwhitex/pliuz/issues
+- **Python SDK**: [`pliuz`](https://pypi.org/project/pliuz/)
+
+---
+
+## License
+
+[Apache 2.0](./LICENSE). The Pliuz platform itself is proprietary — this SDK is the public client only.