@telemai/sdk 0.1.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/README.md

@@ -0,0 +1,332 @@
+# Telem JavaScript SDK
+
+Full documentation: [docs.telem.ai](https://docs.telem.ai/sdks/javascript/).
+
+
+
+> **Fastest install: [the one-line curl](https://docs.telem.ai/).** It finds the agent frameworks you have
+> and installs Telem into the ones you select. The steps below are the manual path.
+
+`@telemai/sdk` is a typed TypeScript client for the Telem search API. It searches the
+web across providers and returns the results in the same shape for every provider.
+It also reads pages, lists the providers, and carries query lineage for agents.
+
+The package has no runtime dependencies. It uses the platform `fetch`, and you can
+supply your own. So the package runs on Node, in an edge worker, inside another CLI,
+and in tests.
+
+## Install
+
+```bash
+npm install @telemai/sdk
+```
+
+The package ships ESM and CommonJS builds with type definitions. Node 20.16 or later
+is necessary to read the credentials file. On other runtimes that have `fetch`, such
+as edge workers and browsers, pass the API key in code.
+
+## Authentication
+
+Create an API key under **API keys** in the [Telem console](https://app.telem.ai/).
+The guided installer writes it to `~/.telem/credentials.json`. You can also set it
+as an environment variable, or pass it in code.
+
+The client resolves `apiKey` and `baseUrl` in this order. The first value found wins:
+
+1. A constructor argument.
+2. The `TELEM_API_KEY` and `TELEM_BASE_URL` environment variables.
+3. `~/.telem/credentials.json`.
+4. The defaults: no key, and `https://router.telem.ai` for `baseUrl`.
+
+See [Authentication](https://docs.telem.ai/authentication/) for the full rules.
+
+```ts
+
+const telem = new Telem()          // environment, then ~/.telem/credentials.json
+const telem = new Telem("tlm_...") // just a key
+const telem = new Telem({
+  apiKey: "tlm_...",
+  baseUrl: "https://router.telem.ai",
+  timeoutMs: 60_000,  // per attempt
+  maxRetries: 2,      // on 5xx, network errors and 429
+  tier: "extended",   // client-wide search defaults go here
+})
+```
+
+The credentials file is the only file the client opens. The client never reads
+`.telem/telem.json`, the file the other Telem tools use for
+[search options](https://docs.telem.ai/resources/config-reference/). A library must not let a
+checked-out repository control the spend of a program. Set search defaults as
+constructor options or call arguments. The `TELEM_*` variables apply below them.
+
+## Search
+
+One call searches every provider in the default set. The results come back in one
+list, in the same shape for every provider:
+
+```ts
+const response = await telem.search("best typescript http client")
+for (const result of response.results) {
+  console.log(result.provider, result.title, result.url)
+}
+```
+
+Every option applies to one call. An option you do not set uses the client default,
+then the server default:
+
+```ts
+const response = await telem.search("climate policy 2026", {
+  tier: "extended",            // minimalist | default | extended | max
+  providersInclude: ["exa"],   // allow-list; omit for the default provider set
+  numResults: 10,              // rows per provider (server default 5, maximum 20)
+  includeFullContent: true,    // the full page content, not only a summary
+  goal: "brief the user",      // recorded with the search; shown in the console
+  context: "the user wants the 2026 amendments, not the original 2024 text",
+})
+```
+
+The full option set is `tier`, `fields`, `providersInclude`, `providersExclude`,
+`providerOverrides`, `numResults`, `includeRaw`, `includeFullContent` and `rerank`,
+plus `goal`, `context`, `session` and `metadata`. An `undefined` value is unset. `[]`
+and `false` are explicit values. `tier` and `fields` do not go together, and the
+client sends one of them. When you set both provider lists, the client removes the
+excluded names from the allow-list. The client does not validate values. An unknown
+tier, field or provider name comes back as an error from the server. See
+[Errors](#errors).
+
+**[Full parameter reference →](https://docs.telem.ai/resources/config-reference/)** lists every key, its
+environment variable and the precedence. `numResults`, `includeRaw`, `rerank` and
+`providerOverrides` are call arguments only. As client defaults they do nothing.
+
+### `goal` and `context`
+
+Telem records both with the search and shows them in the trajectory view in the
+console. A reader of the trace then sees why the search happened. For an agent, use
+the reasoning of the model for this step as `context`: two or three sentences.
+`goal` and `context` change the result order only when you also set
+[rerank](#rerank).
+
+### Multi-query batching
+
+Pass an array of queries. They run at the same time, as one request. Each provider
+run carries the query it served:
+
+```ts
+const response = await telem.search([
+  "EU AI Act obligations for general-purpose models 2026",
+  "how the amended EU AI Act timeline changed",
+])
+for (const run of response.byProvider) {
+  console.log(run.batchIndex, run.query, run.provider, run.results.length)
+}
+```
+
+`response.results` is the flat list across every run. An array with one query
+behaves the same as a plain string.
+
+### `SearchResponse` shape
+
+```ts
+response.results       // flat SearchResult[]: providers in run order, rows in provider order
+response.byProvider    // ProviderRun[]: one entry per provider, failed providers included
+response.sessionId     // the session this call belongs to
+response.interactionId // the id of this request
+response.status        // "succeeded" | "partially_succeeded" | "failed"
+```
+
+`byProvider` has one run for each provider that ran. A provider that failed is still
+in the list, with `status` and `error` set and `results` empty. Each result has
+`url`, `title`, `summary`, `excerpt`, `fullContent`, `publishDate`, `rank`,
+`thumbnail`, `favicon`, `source`, `enrichments` and `fetchMeta`, plus `provider` and
+`raw`. `raw` is the row exactly as the server sent it.
+
+### Rerank
+
+Set `rerank: true` and the server sorts the results by relevance to your `context`.
+If there is no `context`, it uses your `goal`. Rerank is off by default, and it is
+metered. Set it for one call, not as a client default:
+
+```ts
+const response = await telem.search("Nintendo Museum New Year closure dates", {
+  context: "planning a late-December visit; need official closure dates, not reviews",
+  rerank: true,
+})
+```
+
+## Fetch a page
+
+Read the content of a URL you already have. Pass one URL or a list. The results come
+back in the order you asked for, including the URLs that failed:
+
+```ts
+const page = await telem.fetch("https://example.com/article", {
+  inlineContent: true,
+  inlineMaxChars: 20_000,
+  contentFormat: "markdown",
+})
+const { status, content } = page.results[0]
+```
+
+A URL that failed still returns a result. Check `result.status` and `result.error`.
+Do not expect a shorter list. The options are on the
+[fetch parameters](https://docs.telem.ai/resources/fetch-parameters/) page.
+
+## Providers
+
+List the providers the deployment can run:
+
+```ts
+for (const provider of await telem.providers()) {
+  console.log(provider.name, provider.activeByDefault, provider.tiers)
+}
+```
+
+## Sessions
+
+Every search belongs to a session. The response carries its id as `sessionId`. Read
+your sessions back to see what an agent searched for. Both methods require an API key:
+
+```ts
+for (const session of await telem.sessions.list()) {
+  console.log(session.id, session.interactionCount, session.latestInteractionAt)
+}
+
+const summary = await telem.sessions.results(sessionId)
+console.log(summary.query, summary.goal, summary.context)
+```
+
+`results` returns the query, the goal and the context of the session, plus the
+results of each search step.
+
+## Query lineage
+
+Every search and fetch from an agent can carry **lineage data**. Lineage data tells
+Telem which conversation made the call, and where in the conversation it happened.
+The console then shows all the calls of one conversation together, in order, and
+shows which turn made each call. When an agent delegates to other agents, the
+console shows their calls under the agent that started them. You build the lineage
+data from four ids you already have. The model never sees them.
+
+The example column uses Codex, which has all four ids:
+
+| Id | What it is | Example |
+|---|---|---|
+| `conversationId` | One id for one agent conversation. Make it when the conversation starts, and keep it. A subagent gets its own. | Codex: the thread id. One thread is one conversation. |
+| `windowId` | The id of the current context window. It changes when you trim or summarize the start of the history. | Codex: the window id. Codex makes a new one when it compacts the context. |
+| `messageId` | The id of the model turn that makes the call. All the tool calls in one turn share it. | Codex: the turn id. |
+| `toolCallId` | The id of this tool call. | Codex: the id of the tool call in that turn. |
+
+In your own code the ids come from your agent loop. This example uses the OpenAI
+Node SDK, where the completion id is the turn and each tool call has its own id:
+
+```ts
+
+const telem = new Telem()
+const openai = new OpenAI()
+const messages = [{ role: "user" as const, content: "Is the Nintendo Museum open over New Year?" }]
+const tools = [
+  {
+    type: "function" as const,
+    function: {
+      name: "telem_search",
+      description: "Search the public web.",
+      parameters: {
+        type: "object",
+        properties: { query: { type: "string" }, goal: { type: "string" }, context: { type: "string" } },
+        required: ["query", "goal", "context"],
+      },
+    },
+  },
+]
+
+const conversationId = crypto.randomUUID()     // once, when the conversation starts
+const windowId = await windowAnchor(messages)  // once, from the first message
+
+const completion = await openai.chat.completions.create({ model: "gpt-4o", messages, tools })
+for (const call of completion.choices[0].message.tool_calls ?? []) {
+  if (call.type !== "function") continue
+  const lineage = await buildMetadata({
+    harness: "my-app",         // a stable name for your integration
+    conversationId,
+    windowId,
+    messageId: completion.id,  // this model turn
+    toolCallId: call.id,       // this tool call
+    history: messages,         // [{ role, content }]: the conversation so far
+    ancestors: [],             // the parent snapshot; [] for the first agent
+  })
+  const { query, goal, context } = JSON.parse(call.function.arguments)
+  const response = await telem.search(query, withTrajectory({ goal, context }, lineage))
+}
+```
+
+`withTrajectory` attaches the lineage data to one call. Use it the same way with
+`telem.fetch`. When lineage data is present, the client ignores a `session` id.
+
+When an agent delegates a task, it makes a **snapshot** of itself with
+`buildSnapshot`. The snapshot is a record of the parent at that moment. The subagent
+carries the snapshot in its own `ancestors`. Subagents that start in the same turn
+share the snapshot, and the console shows them side by side under the parent:
+
+```ts
+
+const parent = await buildSnapshot({
+  harness: "my-app",
+  conversationId,
+  windowId,
+  messageId: completion.id,  // the turn that delegates
+  context: messages,         // the conversation at that moment
+  ancestors: [],
+})
+// in the subagent: ancestors: [parent]
+```
+
+**Without lineage data**, pass the `sessionId` from the response back as `session`
+on each later call. The console then shows the calls together, but not which turn
+made each one. Make the first call alone. Until its response returns, there is no
+id to share, and two calls that start together end up in two separate sessions.
+
+## Errors
+
+The client throws exactly two error classes. Branch on `status` and `code`. Do not
+branch on the message text:
+
+```ts
+
+try {
+  await telem.search("climate policy 2026")
+} catch (error) {
+  if (error instanceof TimeoutError) {
+    // error.code === "timeout": one attempt took longer than timeoutMs
+  } else if (error instanceof TelemError) {
+    error.status  // the HTTP status, or undefined when nothing was sent
+    error.code    // "invalid_request" | "unsupported_server_version" | "connection_error", or a server code
+    error.details // the parsed response body, or the raw text
+  }
+}
+```
+
+| Situation | Result |
+|---|---|
+| Bad input (empty query, empty URL list) | `TelemError`, `code: "invalid_request"`, nothing sent |
+| Network failure | `TelemError`, `code: "connection_error"`, after the retries |
+| 5xx or 429 | Retried with backoff (`Retry-After` applies), then `TelemError` with the status |
+| Other 4xx | `TelemError` with the status and the code from the server, not retried |
+| Attempt longer than `timeoutMs` | `TimeoutError`, not retried |
+
+See [Resources → Errors](https://docs.telem.ai/resources/errors/) for how the plugins show a failed call.
+
+## Embedding and edge runtimes
+
+The client has no HTTP dependency, and it accepts your own `fetch`. This is how it
+runs inside another platform, in an edge worker, and in tests without a network:
+
+```ts
+const telem = new Telem({
+  apiKey: env.TELEM_API_KEY,
+  fetch: (input, init) => myFetch(input, init), // a worker, a proxy, a recording stub
+})
+```
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).