@cerebro-labs/agentnava-sdk 0.26.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,12 @@
+AgentNava SDK
+Copyright 2026 Cerebro Labs, Inc.
+
+This product includes software developed at Cerebro Labs, Inc.
+(https://agentnava.com).
+
+This NOTICE file is required by Section 4(d) of the Apache License 2.0 and
+must be carried in any redistribution of this software.
+
+"AgentNava" and "Cerebro Labs" are trademarks of Cerebro Labs, Inc. Section 6
+of the License grants no rights to use them: the code is free, the names are
+not.

package/README.md

@@ -0,0 +1,230 @@
+# @cerebro-labs/agentnava-sdk
+
+Configure an agent, start a conversation, work with it.
+
+```bash
+npm install @cerebro-labs/agentnava-sdk
+```
+
+Node 18 or later, or Bun, or any runtime with `fetch`. Both `import` and
+`require` work, and TypeScript types ship with it.
+
+```ts
+import { AgentNava } from '@cerebro-labs/agentnava-sdk';
+
+const ws = AgentNava.getWorkspace(); // reads AGENTNAVA_API_KEY
+
+const agent = await ws.agents.create({
+  name: 'Refund checker',
+  instructions: 'Decide whether a late delivery qualifies for a refund.',
+});
+
+const conversation = await agent.start();
+console.log(await conversation.ask('Order 4471 arrived nine days late.'));
+```
+
+The full reference is at https://docs.agentnava.com. (It used to point here at a
+file path inside our own repository, which nobody who installs this package
+has.) This README covers
+only the things that are easy to get wrong.
+
+## Connecting an account, end to end
+
+`authorize()` gives you a URL for your user to visit. `waitUntilReady()` tells
+you when they are done, so you do not have to write a polling loop or work out
+which field to believe.
+
+```ts
+const { url } = await conversation.authorize('gmail');
+showToUser(url);                      // popup, redirect, QR code, your choice
+await conversation.waitUntilReady();  // resolves once nothing required is outstanding
+```
+
+How you show the URL is yours: this SDK authenticates with an API key, so it
+runs on your server, and the browser half is your application's.
+
+An OPTIONAL requirement does not hold the wait up, for the same reason it does
+not make `ready` false: the conversation genuinely works without it.
+
+On timeout it throws `conversation_not_ready` and the message names what is
+still missing, e.g. `still waiting on: connection gmail`. It is safe to call
+again; someone who has not finished signing in may just need longer.
+
+```ts
+await conversation.waitUntilReady({ timeoutMs: 120_000, intervalMs: 2_000, signal });
+```
+
+## 0.2.0 is a breaking change. Upgrade from 0.1.1, do not stay on it.
+
+"session" is gone from everything you touch. It survives only in our storage,
+which you never see.
+
+| 0.1.1 | 0.2.0 |
+|---|---|
+| `GET /v1/sessions` | `GET /v1/conversations` (the old path now 404s) |
+| `ConnectionStatus.sessionId` | `ConnectionStatus.conversationId` |
+| `conversation.authorize()` sent `sessionId` | sends `conversationId` |
+| `scope: 'session'` came back from the API | `scope: 'conversation'`, the value the type always declared |
+
+**0.1.1 stops working** once these reach production, because the API reads only
+the new field names. There is no compatibility shim: this package is private and
+pre-launch, so the old spellings were removed rather than deprecated.
+
+If you are on 0.1.1 the change is mechanical: rename `sessionId` to
+`conversationId` wherever you read it or pass it. Nothing else about the shape
+moved.
+
+
+## Holding an object is free
+
+`ws.agent(id)`, `ws.conversation(id)` and `ws.project(id)` make **no network
+call**. You get something you can call methods on, and the first request happens
+when you call one.
+
+Store the `id`, not the object. A returned object is a handle, not JSON.
+
+## Asking: one method, two shapes
+
+```ts
+const reply = await conversation.ask('...');          // just the answer
+```
+
+```ts
+for await (const e of conversation.ask('...')) {      // as it happens
+  if (e.type === 'text') append(e.text);
+  if (e.type === 'done') save(e.reply);
+}
+```
+
+**The message is sent when you call `ask`**, not when you await or iterate it.
+Calling `ask` twice asks twice.
+
+You may await the same turn more than once; it is a promise, and you get the same
+answer. You may not iterate it twice, or mix the two, because the events are a
+live stream rather than a stored list and the second consumer would receive
+nothing at all. That throws instead.
+
+**The turn is not your request.** It runs on our side, so a dropped connection
+does not cancel it. Read the answer back with `conversation.messages()` rather
+than asking again.
+
+## Changing an agent publishes a version
+
+There is no separate save. `agent.update()`, `setWorkflow`, `removeWorkflow` and
+`setTriggers` each publish a new version.
+
+**Send only what changes.** Everything you do not send is inherited from the
+current version. That is what makes changing one field safe, and it is not a
+convenience: a caller that rebuilds and resends a whole configuration drops
+whatever it forgot, which has caused four separate data-loss bugs in this
+codebase.
+
+```ts
+await agent.update({ instructions: 'Be brief.' });    // keeps everything else
+```
+
+## A conversation pins its version
+
+It pins the agent's version when it starts and keeps it. Publishing afterwards
+does not move a conversation that is already open.
+
+Knowledge is the exception, and deliberately so: it is read **by reference**, so
+replacing a knowledge file changes what open conversations see on their next
+turn. A price list you could not correct without republishing the agent would be
+useless.
+
+## Two drives
+
+| | The agent sees | Belongs to | You write | The agent writes |
+|---|---|---|---|---|
+| Knowledge | `/knowledge` | the agent | yes | no |
+| Conversation | `/workspace` | one conversation | yes | yes |
+
+An application stages material by writing it in before asking about it:
+
+```ts
+await conversation.writeFile('/input/contract.pdf', bytes);
+await conversation.ask('What are the payment terms?');
+```
+
+Anywhere under the root works. `input/` is a convention here and nothing
+enforces it, because the agent and your application share one namespace.
+
+## Credentials have two tiers, and they do not substitute
+
+`fixed` is set once on the agent and used by every conversation. `conversation`
+is supplied per conversation, so each user brings their own account.
+
+An account connected on the agent does **not** satisfy a declaration scoped
+`conversation`, and a conversation cannot supply a `fixed` one. Check
+`conversation.ready` and `conversation.requires` to see what is outstanding.
+
+## Drafting tools from an API you already describe
+
+`importTools` turns an OpenAPI document, a Postman collection or a working curl
+command into draft `httpTools`, so nobody hand-writes one declaration per
+endpoint.
+
+```ts
+import { importTools } from '@cerebro-labs/agentnava-sdk';
+
+const draft = importTools({ openapi }, { include: (c) => !c.url.includes('/admin/') });
+await ws.agents.create({ id: 'support', instructions, httpTools: draft.tools });
+```
+
+It runs entirely on your machine. Nothing about the source is sent to
+AgentNava, which matters because these files routinely contain a live token:
+any credential found is replaced with a `{{secrets.NAME}}` placeholder and
+listed in `draft.secrets`, with no value carried across. Each drafted tool also
+declares the secrets it uses in its own `secrets` field, which is what lets the
+runtime load them for the turn.
+
+They are drafts. `draft.warnings` names what a human still has to decide, and
+the big one is `description-missing`: none of the three formats contains the
+sentence a model reads to pick a tool, and a bad description does not fail, it
+makes the agent call the wrong thing.
+
+## Errors
+
+Every failure throws `AgentNavaError`.
+
+```ts
+catch (err) {
+  if (err instanceof AgentNavaError) {
+    err.code;       // 'agent_not_found', branch on THIS
+    err.status;     // 404
+    err.retryable;  // 5xx, 429, and network failures
+    err.retryAfter; // seconds, on a 429
+  }
+}
+```
+
+Branch on `code`, not on `message`. Codes are stable; messages are written for a
+person reading a log.
+
+`retryable` is the only thing worth automating on: a 400 will fail identically
+forever, and a 404 will not become found.
+
+404 covers both "no such thing" and "not yours", so a caller probing ids cannot
+tell another customer's agent from one that never existed. There is no 403.
+
+## Configuration
+
+```ts
+AgentNava.getWorkspace();                                   // AGENTNAVA_API_KEY
+AgentNava.getWorkspace({ apiKey, baseURL, timeout });
+AgentNava.getWorkspace({ fetch: myFetch });                 // a proxy, or a test
+```
+
+Runs anywhere `fetch` exists: Node, Bun, Deno, Cloudflare Workers, the browser.
+`loadWorkflows` is the one exception; it reads a directory off disk and so needs
+Node or Bun.
+
+## Licence
+
+Apache License 2.0. See `LICENSE`, and `NOTICE` for the attribution that
+section 4(d) asks you to carry along.
+
+Free to use, modify and redistribute, including commercially, with an
+explicit patent grant. Section 6 grants no rights to the names: "AgentNava"
+and "Cerebro Labs" remain trademarks of Cerebro Labs, Inc.