@kivel.io/sdk 0.0.0-stage → 0.6.1

package/CHANGELOG.md

@@ -0,0 +1,59 @@
+# @kivel.io/sdk
+
+## 0.6.1
+
+### Patch Changes
+
+- b6437db: Published as `@kivel.io/sdk` and `@kivel.io/cli`, under the npm organization for kivel.io.
+
+## 0.6.0
+
+### Minor Changes
+
+- d096583: Add email threads, draft delivery and inbox rule inspection.
+- a0aa58d: Renamed from `@socket-help/sdk` and `@socket-help/cli`. The client class is now `Kivel`, the error class `KivelError`, the CLI command `kivel`, and the default URL `https://kivel.io`. The CLI reads `KIVEL_URL`, `KIVEL_API_KEY` and `KIVEL_ACCESS_TOKEN`, and still accepts the old `SOCKET_HELP_*` names.
+
+### Patch Changes
+
+- 4185eed: Examples name the client `kivel`, and new API keys start with `kv_`. Existing `sh_` keys keep working.
+
+## 0.5.1
+
+### Patch Changes
+
+- d69807d: Expose the original query string on captured webhook requests.
+
+## 0.5.0
+
+### Minor Changes
+
+- 026f194: Add workspace TOTP authenticators and private email attachment links and downloads.
+- 2f1574b: Add mock OAuth and OpenID Connect provider creation, configuration and lifecycle commands.
+
+## 0.4.1
+
+### Patch Changes
+
+- 4b9c802: Default webhook inboxes to receiving without sender credentials while keeping inspection private. Document explicit private receiving and its X-Access-Token requirement.
+
+## 0.4.0
+
+### Minor Changes
+
+- 858c876: Support owned agent email inboxes with Free lifetimes, paid custom addresses, inbox listing and webhook forwarding, guarded outbound mail and combined event waits. Email creation now requires an account and uses activeDays instead of generic resource retention settings.
+
+    Add scheduled callbacks and delivery waits, authenticated SMTP capture, DNS monitor baselines and status-page lifecycle methods.
+
+    Add scripted LLM responses and streaming configuration, guarded phone number and inbound SMS methods, and email history clearing. Surface paid-feature errors with the required plan and upgrade URL.
+
+    Keep all event waits inside the configured client timeout and preserve structured upgrade fields in CLI and SSH errors.
+
+## 0.3.1
+
+### Patch Changes
+
+- 5bd1172: Clarify beta installation, include package changelogs and automate reviewed client releases. Read the CLI version from its package manifest so SDK and CLI releases can version independently.
+
+## 0.3.0
+
+Initial public beta release.

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 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/README.md

@@ -1,3 +1,87 @@
-# Temporary Holding Version
+# @kivel.io/sdk
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The TypeScript client for [Kivel](https://kivel.io): webhook URLs,
+owned email when configured, mock APIs, files, workspace memory, monitors and human approval
+for coding agents. Requires Node.js 22.13+ or a compatible fetch-based runtime.
+The published package is ESM; use `import`, not CommonJS `require`.
+
+```sh
+npm install @kivel.io/sdk@beta
+```
+
+Use the explicit beta tag for the current beta channel. Pin an exact version
+when you need reproducible application builds.
+
+```ts
+import { Kivel, KivelError } from '@kivel.io/sdk';
+
+const kivel = new Kivel({ apiKey: process.env.KIVEL_API_KEY });
+const inbox = await kivel.createInbox();
+const received = await kivel.waitForRequests(inbox.id, { timeoutSeconds: 20 });
+console.log(received.requests);
+await kivel.remove('inboxes', inbox.id);
+```
+
+`createInbox()` returns a `webhookUrl` that accepts senders without credentials. Reading and waiting still require your workspace key or the private `inspectionToken`. For token-required receiving, pass `{ visibility: 'private' }` and give the sender the returned `accessToken` for its `X-Access-Token` header.
+
+`baseUrl` defaults to `https://kivel.io`; set it to your self-hosted origin.
+Remote origins require HTTPS. The default request timeout is 25 seconds. Requests
+are not automatically retried and redirects are refused.
+
+Without a key, supported operations use anonymous limits. Use `startLogin(name)`
+to obtain the browser approval link, then `finishLogin(deviceCode)` until approval.
+Save the returned key privately; it is delivered once. Never ask a human to paste
+an API key into a chat. Human approvals and billing cannot be performed by a key.
+
+Dedicated methods cover owned email and guarded sending, scheduled callbacks, event waits, DNS monitors, status pages, SMTP captures, phone Phase A, memory, questions, mocks and files. Read `GET /api/capabilities` first for operator-enabled features.
+`request()` handles other `/api/` operations and `/mock/` caller requests. Anonymous
+management tokens and private caller tokens serve different purposes; keep them
+out of URLs. A timed-out wait is not a human approval or a received event.
+
+Errors from the API use `KivelError` with `status` and optional `requestId` and
+`retryAfter`, `requiredPlan` and `upgradeUrl`. Relay a 402 to the human instead of retrying. Inputs and credentials go to your configured server; the SDK does not
+write a local credential file. Do not log responses that contain keys or tokens.
+
+[Method reference](https://kivel.io/docs/sdk/) ·
+[Agent workflows](https://kivel.io/docs/agent-workflows/) ·
+[Plan limits](https://kivel.io/plans/)
+
+Licensed under Apache-2.0. Support: support@kivel.io.
+
+Use `addAuthenticator({ name, uri })`, `getTotpCode(id)`, `listAuthenticators()`,
+`renameAuthenticator(id, name)` and `deleteAuthenticator(id)` only for accounts your
+human asked you to create or operate. Import also accepts `secret` (Base32) or
+`imageBase64` (PNG/JPEG QR up to 1 MiB and one million pixels). Secrets are never
+returned. Free supports 2, Pro 25 and Team 100 authenticators. Every code generation
+requires `resources:write` and is audited with the user ID, key ID and agent name
+(or the key name for a key without an approved agent). The limit is 30 per workspace
+per minute; `nextCode` is included when fewer than five seconds remain. Keep the service recovery codes separately.
+
+`getEmailAttachment(inboxId, messageId, attachmentId)` returns a private download
+URL valid for two minutes. `downloadEmailAttachment(...)` fetches its exact bytes.
+Attachment IDs come from email message metadata. Messages are limited to 5 MiB,
+with 25 MiB of attachment content per inbox, counted against workspace storage.
+Deletion and inbox expiry remove files and invalidate links. Treat every file as
+untrusted; this SDK does not scan or execute attachments.
+
+## Mock OAuth provider
+
+Use an approved workspace key and synthetic users to test sign in. The issuer exposes
+OIDC discovery, JWKS, authorization, token, userinfo and revocation endpoints.
+
+```ts
+const provider = await kivel.createOAuthProvider({
+    name: 'Test app',
+    redirectUris: ['http://localhost:3000/auth/callback'],
+    users: [{ sub: 'test-user', email: 'alex@example.test', name: 'Alex' }],
+});
+// Save provider.client_secret privately at creation.
+// Configure your OAuth client with provider.discoveryUrl and S256 PKCE.
+await kivel.oauthProvider(provider.id);
+await kivel.mockCalls(provider.id);
+await kivel.deleteOAuthProvider(provider.id);
+```
+
+`oauthProviders()` lists workspace providers; `updateOAuthProvider(id, config)` replaces
+the users, claims and test scenario. Endpoint use is public; management stays private.
+See the [OAuth guide](https://kivel.io/docs/mock-oauth/) for token flows and failure scenarios.