@nimble-way/ai-sdk 0.1.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 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 2026 Nimble
+
+   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,132 @@
+# @nimble-way/ai-sdk
+
+Nimble Web Search as a ready-made [Vercel AI SDK](https://ai-sdk.dev) tool. Give any AI SDK agent the ability to search the web with [Nimble](https://nimbleway.com) in a few lines.
+
+## Features
+
+- **Web Search** — a `nimbleSearch()` tool the model can call to retrieve ranked, real-time web results and ground its answers in them.
+- **Model- and gateway-agnostic** — an app-side `tool()`; works the same with the Vercel AI Gateway or a direct provider.
+- **Typed** — typed config and normalized output; an injectable client for testing.
+
+> Extract, Map, and Crawl tools are planned follow-ups.
+
+## Install
+
+```bash
+npm install @nimble-way/ai-sdk ai
+# pnpm add @nimble-way/ai-sdk ai
+# yarn add @nimble-way/ai-sdk ai
+```
+
+`ai` (v6) and `zod` are peer dependencies — you provide your app's copy.
+
+## Prerequisites
+
+A Nimble API key (get one at [app.nimbleway.com](https://app.nimbleway.com)):
+
+```bash
+export NIMBLE_API_KEY=...      # picked up automatically
+```
+
+Or pass it directly: `nimbleSearch({ apiKey: '...' })`.
+
+## Usage
+
+```ts
+import { generateText, stepCountIs } from 'ai';
+import { nimbleSearch } from '@nimble-way/ai-sdk';
+
+const { text } = await generateText({
+  model: 'openai/gpt-4o-mini',
+  prompt: 'What are the latest developments in agentic web search? Cite sources.',
+  tools: {
+    webSearch: nimbleSearch({ searchDepth: 'lite', maxResults: 5 }),
+  },
+  stopWhen: stepCountIs(3),
+});
+
+console.log(text);
+```
+
+`streamText` works the same way — register the tool under `tools`.
+
+### Next.js route handler
+
+```ts
+// app/api/chat/route.ts
+import { convertToModelMessages, streamText, stepCountIs, type UIMessage } from 'ai';
+import { nimbleSearch } from '@nimble-way/ai-sdk';
+
+export async function POST(req: Request) {
+  const { messages }: { messages: UIMessage[] } = await req.json();
+
+  const result = streamText({
+    model: 'openai/gpt-4o-mini',
+    messages: await convertToModelMessages(messages),
+    tools: {
+      webSearch: nimbleSearch({ searchDepth: 'lite', maxResults: 5 }),
+    },
+    stopWhen: stepCountIs(5),
+  });
+
+  return result.toUIMessageStreamResponse();
+}
+```
+
+### With or without the Vercel AI Gateway
+
+The tool runs **in your app** (an app-side `tool()`, not a provider/server-executed search). It is therefore **gateway-agnostic**: it behaves identically whether you route your model through the [Vercel AI Gateway](https://vercel.com/docs/ai-gateway) (plain-string model IDs like `'openai/gpt-4o-mini'`) or call a provider SDK directly. The gateway, if present, only routes the *model* call.
+
+## Options
+
+`nimbleSearch(config)` — all fields optional:
+
+| Option | Type | Default | Notes |
+|---|---|---|---|
+| `apiKey` | `string` | `process.env.NIMBLE_API_KEY` | Nimble API key. |
+| `client` | `NimbleSearchClient` | — | Inject a pre-built/mock client (tests, advanced use). |
+| `maxResults` | `number` | `5` | Results when the model doesn't specify. |
+| `maxResultsCap` | `number` | `10` | Hard upper bound, regardless of model request. |
+| `searchDepth` | `'lite' \| 'deep'` | `'lite'` | `lite` = fast metadata; `deep` = full page content. |
+| `country` | `string` | `'US'` | Result localization. |
+| `locale` | `string` | `'en'` | Result localization. |
+| `maxContentLength` | `number` | `10_000` | Truncate each result body. |
+
+The **model-facing input** is just `{ query: string, maxResults?: number }` — all policy above is developer-controlled, not model-controlled.
+
+## Output shape
+
+```ts
+{
+  query: string;
+  requestId?: string;
+  totalResults?: number;
+  results: Array<{
+    title: string;
+    url: string;
+    description?: string;
+    content?: string;     // present in `deep`
+    position?: number;
+    entityType?: string;
+  }>;
+}
+```
+
+## Limitations
+
+- **Search only.** Extract / Map / Crawl / Agents are follow-ups.
+- **No answer generation.** `include_answer` is intentionally not exposed.
+- **`searchDepth: 'fast'` is not available** (enterprise-gated).
+- **Runtime:** targets the **Node.js runtime** (Node ≥ 18). Edge/serverless is expected to work but not yet verified — prefer the Node runtime.
+
+## Troubleshooting
+
+| Symptom | Fix |
+|---|---|
+| `NimbleConfigError: missing API key` | Set `NIMBLE_API_KEY` or pass `apiKey`. |
+| `NimbleSearchError` with a status | The Nimble API returned an error; the HTTP status is on `err.status`. |
+| Tool never called | Ensure your prompt invites tool use and `stopWhen` allows multiple steps. |
+
+## License
+
+Apache-2.0

package/dist/index.cjs

@@ -0,0 +1,144 @@
+'use strict';
+
+var ai = require('ai');
+var nimbleJs = require('@nimble-way/nimble-js');
+var zod = require('zod');
+
+// src/nimble-search.ts
+var nimbleSearchInputSchema = zod.z.object({
+  query: zod.z.string().min(1).describe("The web search query."),
+  maxResults: zod.z.number().int().positive().optional().describe("How many results to return (clamped to the developer-configured cap).")
+});
+
+// src/normalize.ts
+function isSerpMetadata(metadata) {
+  return "position" in metadata;
+}
+function truncate(text, max) {
+  return text.length > max ? text.slice(0, max) : text;
+}
+function normalizeSearchResponse(response, options) {
+  const results = [];
+  response.results.forEach((raw, index) => {
+    if (!raw.url) return;
+    const item = {
+      title: raw.title ?? "",
+      url: raw.url
+    };
+    if (raw.description) item.description = raw.description;
+    if (raw.content && raw.content.trim().length > 0) {
+      item.content = truncate(raw.content, options.maxContentLength);
+    }
+    if (isSerpMetadata(raw.metadata)) {
+      item.position = raw.metadata.position;
+      item.entityType = raw.metadata.entity_type;
+    } else {
+      item.position = index + 1;
+    }
+    results.push(item);
+  });
+  return {
+    query: options.query,
+    requestId: response.request_id,
+    totalResults: response.total_results,
+    results
+  };
+}
+
+// src/errors.ts
+var NimbleConfigError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "NimbleConfigError";
+  }
+};
+var NimbleSearchError = class extends Error {
+  status;
+  constructor(message, options) {
+    super(message, options?.cause !== void 0 ? { cause: options.cause } : void 0);
+    this.name = "NimbleSearchError";
+    this.status = options?.status;
+  }
+};
+
+// src/nimble-search.ts
+var NIMBLE_SEARCH_DEFAULTS = {
+  maxResults: 5,
+  maxResultsCap: 10,
+  searchDepth: "lite",
+  country: "US",
+  locale: "en",
+  maxContentLength: 1e4,
+  focus: "general"
+};
+function clamp(value, min, max) {
+  return Math.min(Math.max(value, min), max);
+}
+function readStatus(err) {
+  if (typeof err === "object" && err !== null && "status" in err) {
+    const status = err.status;
+    return typeof status === "number" ? status : void 0;
+  }
+  return void 0;
+}
+function toSearchError(err) {
+  if (err instanceof NimbleSearchError) return err;
+  const message = err instanceof Error ? err.message : String(err);
+  return new NimbleSearchError(`Nimble search failed: ${message}`, {
+    status: readStatus(err),
+    cause: err
+  });
+}
+function resolveClient(config) {
+  if (config.client) return config.client;
+  const apiKey = config.apiKey ?? process.env.NIMBLE_API_KEY;
+  if (!apiKey) {
+    throw new NimbleConfigError(
+      "Missing Nimble API key: set NIMBLE_API_KEY or pass { apiKey } to nimbleSearch()."
+    );
+  }
+  return new nimbleJs.Nimble({ apiKey });
+}
+function nimbleSearch(config = {}) {
+  const maxResults = config.maxResults ?? NIMBLE_SEARCH_DEFAULTS.maxResults;
+  const maxResultsCap = config.maxResultsCap ?? NIMBLE_SEARCH_DEFAULTS.maxResultsCap;
+  const searchDepth = config.searchDepth ?? NIMBLE_SEARCH_DEFAULTS.searchDepth;
+  const country = config.country ?? NIMBLE_SEARCH_DEFAULTS.country;
+  const locale = config.locale ?? NIMBLE_SEARCH_DEFAULTS.locale;
+  const maxContentLength = config.maxContentLength ?? NIMBLE_SEARCH_DEFAULTS.maxContentLength;
+  return ai.tool({
+    description: "Search the web with Nimble and return ranked results (title, url, snippet, and page content) for answering questions about current or factual information.",
+    inputSchema: nimbleSearchInputSchema,
+    execute: async (input) => {
+      const client = resolveClient(config);
+      const params = {
+        query: input.query,
+        max_results: clamp(input.maxResults ?? maxResults, 1, maxResultsCap),
+        search_depth: searchDepth,
+        focus: NIMBLE_SEARCH_DEFAULTS.focus,
+        // fixed 'general' in v1
+        country,
+        locale
+      };
+      let raw;
+      try {
+        raw = await client.search(params);
+      } catch (err) {
+        throw toSearchError(err);
+      }
+      return normalizeSearchResponse(raw, {
+        query: input.query,
+        maxContentLength
+      });
+    }
+  });
+}
+
+exports.NIMBLE_SEARCH_DEFAULTS = NIMBLE_SEARCH_DEFAULTS;
+exports.NimbleConfigError = NimbleConfigError;
+exports.NimbleSearchError = NimbleSearchError;
+exports.nimbleSearch = nimbleSearch;
+exports.nimbleSearchInputSchema = nimbleSearchInputSchema;
+exports.normalizeSearchResponse = normalizeSearchResponse;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/schemas.ts","../src/normalize.ts","../src/errors.ts","../src/nimble-search.ts"],"names":["z","Nimble","tool"],"mappings":";;;;;;;AAQO,IAAM,uBAAA,GAA0BA,MAAE,MAAA,CAAO;AAAA,EAC9C,KAAA,EAAOA,MAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,SAAS,uBAAuB,CAAA;AAAA,EACzD,UAAA,EAAYA,KAAA,CACT,MAAA,EAAO,CACP,GAAA,EAAI,CACJ,QAAA,EAAS,CACT,QAAA,EAAS,CACT,QAAA,CAAS,uEAAuE;AACrF,CAAC;;;ACFD,SAAS,eACP,QAAA,EACgC;AAChC,EAAA,OAAO,UAAA,IAAc,QAAA;AACvB;AAEA,SAAS,QAAA,CAAS,MAAc,GAAA,EAAqB;AACnD,EAAA,OAAO,KAAK,MAAA,GAAS,GAAA,GAAM,KAAK,KAAA,CAAM,CAAA,EAAG,GAAG,CAAA,GAAI,IAAA;AAClD;AAaO,SAAS,uBAAA,CACd,UACA,OAAA,EACoB;AACpB,EAAA,MAAM,UAAoC,EAAC;AAE3C,EAAA,QAAA,CAAS,OAAA,CAAQ,OAAA,CAAQ,CAAC,GAAA,EAAK,KAAA,KAAU;AACvC,IAAA,IAAI,CAAC,IAAI,GAAA,EAAK;AAEd,IAAA,MAAM,IAAA,GAA+B;AAAA,MACnC,KAAA,EAAO,IAAI,KAAA,IAAS,EAAA;AAAA,MACpB,KAAK,GAAA,CAAI;AAAA,KACX;AACA,IAAA,IAAI,GAAA,CAAI,WAAA,EAAa,IAAA,CAAK,WAAA,GAAc,GAAA,CAAI,WAAA;AAC5C,IAAA,IAAI,IAAI,OAAA,IAAW,GAAA,CAAI,QAAQ,IAAA,EAAK,CAAE,SAAS,CAAA,EAAG;AAChD,MAAA,IAAA,CAAK,OAAA,GAAU,QAAA,CAAS,GAAA,CAAI,OAAA,EAAS,QAAQ,gBAAgB,CAAA;AAAA,IAC/D;AAEA,IAAA,IAAI,cAAA,CAAe,GAAA,CAAI,QAAQ,CAAA,EAAG;AAChC,MAAA,IAAA,CAAK,QAAA,GAAW,IAAI,QAAA,CAAS,QAAA;AAC7B,MAAA,IAAA,CAAK,UAAA,GAAa,IAAI,QAAA,CAAS,WAAA;AAAA,IACjC,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,WAAW,KAAA,GAAQ,CAAA;AAAA,IAC1B;AAEA,IAAA,OAAA,CAAQ,KAAK,IAAI,CAAA;AAAA,EACnB,CAAC,CAAA;AAED,EAAA,OAAO;AAAA,IACL,OAAO,OAAA,CAAQ,KAAA;AAAA,IACf,WAAW,QAAA,CAAS,UAAA;AAAA,IACpB,cAAc,QAAA,CAAS,aAAA;AAAA,IACvB;AAAA,GACF;AACF;;;AC/DO,IAAM,iBAAA,GAAN,cAAgC,KAAA,CAAM;AAAA,EAC3C,YAAY,OAAA,EAAiB;AAC3B,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,mBAAA;AAAA,EACd;AACF;AAOO,IAAM,iBAAA,GAAN,cAAgC,KAAA,CAAM;AAAA,EAClC,MAAA;AAAA,EAET,WAAA,CAAY,SAAiB,OAAA,EAAgD;AAC3E,IAAA,KAAA,CAAM,OAAA,EAAS,SAAS,KAAA,KAAU,MAAA,GAAY,EAAE,KAAA,EAAO,OAAA,CAAQ,KAAA,EAAM,GAAI,MAAS,CAAA;AAClF,IAAA,IAAA,CAAK,IAAA,GAAO,mBAAA;AACZ,IAAA,IAAA,CAAK,SAAS,OAAA,EAAS,MAAA;AAAA,EACzB;AACF;;;ACbO,IAAM,sBAAA,GAAyB;AAAA,EACpC,UAAA,EAAY,CAAA;AAAA,EACZ,aAAA,EAAe,EAAA;AAAA,EACf,WAAA,EAAa,MAAA;AAAA,EACb,OAAA,EAAS,IAAA;AAAA,EACT,MAAA,EAAQ,IAAA;AAAA,EACR,gBAAA,EAAkB,GAAA;AAAA,EAClB,KAAA,EAAO;AACT;AAEA,SAAS,KAAA,CAAM,KAAA,EAAe,GAAA,EAAa,GAAA,EAAqB;AAC9D,EAAA,OAAO,KAAK,GAAA,CAAI,IAAA,CAAK,IAAI,KAAA,EAAO,GAAG,GAAG,GAAG,CAAA;AAC3C;AAEA,SAAS,WAAW,GAAA,EAAkC;AACpD,EAAA,IAAI,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,KAAQ,IAAA,IAAQ,YAAY,GAAA,EAAK;AAC9D,IAAA,MAAM,SAAU,GAAA,CAA6B,MAAA;AAC7C,IAAA,OAAO,OAAO,MAAA,KAAW,QAAA,GAAW,MAAA,GAAS,MAAA;AAAA,EAC/C;AACA,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,cAAc,GAAA,EAAiC;AACtD,EAAA,IAAI,GAAA,YAAe,mBAAmB,OAAO,GAAA;AAC7C,EAAA,MAAM,UAAU,GAAA,YAAe,KAAA,GAAQ,GAAA,CAAI,OAAA,GAAU,OAAO,GAAG,CAAA;AAC/D,EAAA,OAAO,IAAI,iBAAA,CAAkB,CAAA,sBAAA,EAAyB,OAAO,CAAA,CAAA,EAAI;AAAA,IAC/D,MAAA,EAAQ,WAAW,GAAG,CAAA;AAAA,IACtB,KAAA,EAAO;AAAA,GACR,CAAA;AACH;AAEA,SAAS,cAAc,MAAA,EAAoD;AACzE,EAAA,IAAI,MAAA,CAAO,MAAA,EAAQ,OAAO,MAAA,CAAO,MAAA;AACjC,EAAA,MAAM,MAAA,GAAS,MAAA,CAAO,MAAA,IAAU,OAAA,CAAQ,GAAA,CAAI,cAAA;AAC5C,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,MAAM,IAAI,iBAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AACA,EAAA,OAAO,IAAIC,eAAA,CAAO,EAAE,MAAA,EAAQ,CAAA;AAC9B;AAqBO,SAAS,YAAA,CAAa,MAAA,GAAiC,EAAC,EAAG;AAChE,EAAA,MAAM,UAAA,GAAa,MAAA,CAAO,UAAA,IAAc,sBAAA,CAAuB,UAAA;AAC/D,EAAA,MAAM,aAAA,GAAgB,MAAA,CAAO,aAAA,IAAiB,sBAAA,CAAuB,aAAA;AACrE,EAAA,MAAM,WAAA,GAAc,MAAA,CAAO,WAAA,IAAe,sBAAA,CAAuB,WAAA;AACjE,EAAA,MAAM,OAAA,GAAU,MAAA,CAAO,OAAA,IAAW,sBAAA,CAAuB,OAAA;AACzD,EAAA,MAAM,MAAA,GAAS,MAAA,CAAO,MAAA,IAAU,sBAAA,CAAuB,MAAA;AACvD,EAAA,MAAM,gBAAA,GAAmB,MAAA,CAAO,gBAAA,IAAoB,sBAAA,CAAuB,gBAAA;AAE3E,EAAA,OAAOC,OAAA,CAAK;AAAA,IACV,WAAA,EACE,4JAAA;AAAA,IAGF,WAAA,EAAa,uBAAA;AAAA,IACb,OAAA,EAAS,OAAO,KAAA,KAAuC;AACrD,MAAA,MAAM,MAAA,GAAS,cAAc,MAAM,CAAA;AAEnC,MAAA,MAAM,MAAA,GAA6B;AAAA,QACjC,OAAO,KAAA,CAAM,KAAA;AAAA,QACb,aAAa,KAAA,CAAM,KAAA,CAAM,UAAA,IAAc,UAAA,EAAY,GAAG,aAAa,CAAA;AAAA,QACnE,YAAA,EAAc,WAAA;AAAA,QACd,OAAO,sBAAA,CAAuB,KAAA;AAAA;AAAA,QAC9B,OAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,IAAI,GAAA;AACJ,MAAA,IAAI;AACF,QAAA,GAAA,GAAM,MAAM,MAAA,CAAO,MAAA,CAAO,MAAM,CAAA;AAAA,MAClC,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,cAAc,GAAG,CAAA;AAAA,MACzB;AAEA,MAAA,OAAO,wBAAwB,GAAA,EAAK;AAAA,QAClC,OAAO,KAAA,CAAM,KAAA;AAAA,QACb;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH","file":"index.cjs","sourcesContent":["import { z } from 'zod';\n\n/**\n * The tool input the model fills in. Kept deliberately small: the model only\n * chooses the query and (optionally) how many results it wants. All policy\n * (depth, focus, region, caps) is fixed by the developer via the factory\n * config, not by the model.\n */\nexport const nimbleSearchInputSchema = z.object({\n  query: z.string().min(1).describe('The web search query.'),\n  maxResults: z\n    .number()\n    .int()\n    .positive()\n    .optional()\n    .describe('How many results to return (clamped to the developer-configured cap).'),\n});\n\nexport type NimbleSearchInput = z.infer<typeof nimbleSearchInputSchema>;\n\n/**\n * v1 exposes only the two non-enterprise depths. `fast` is enterprise-gated and\n * intentionally not offered here.\n */\nexport type SearchDepth = 'lite' | 'deep';\n\n/**\n * Developer-facing factory config. `focus` is fixed to `general` in v1 and is\n * not exposed. `include_answer` and `search_depth: 'fast'` are intentionally\n * absent (enterprise / unverified-entitlement surface).\n */\nexport interface NimbleSearchToolConfig {\n  /** Nimble API key. Defaults to `process.env.NIMBLE_API_KEY`. */\n  apiKey?: string;\n  /** Inject a pre-built / mock Nimble client (tests, advanced users). */\n  client?: NimbleSearchClient;\n  /** Default number of results when the model doesn't specify. Default 5. */\n  maxResults?: number;\n  /** Hard upper bound on results, regardless of model request. Default 10. */\n  maxResultsCap?: number;\n  /** Search depth. Default `lite`. */\n  searchDepth?: SearchDepth;\n  /** ISO country for result localization. Default `US`. */\n  country?: string;\n  /** Locale for result localization. Default `en`. */\n  locale?: string;\n  /** Truncate each result's body to this many characters. Default 10_000. */\n  maxContentLength?: number;\n}\n\n/**\n * Structural surface of `@nimble-way/nimble-js`'s `client.search()` that this\n * package relies on. Declared structurally so the scaffold typechecks without\n * pinning to the SDK's generated type names, and so tests can inject a mock.\n *\n * Phase B: reconcile field casing/names against\n * `sdks/nimble-js/checkout/src/` after `./tools/sync-sdk.sh nimble-js`.\n */\nexport interface NimbleSearchParams {\n  query: string;\n  max_results?: number;\n  search_depth?: SearchDepth;\n  focus?: string;\n  country?: string;\n  locale?: string;\n}\n\n/** Metadata for SERP-based results (general/news/location focus). */\nexport interface NimbleSerpMetadata {\n  country: string;\n  entity_type: string;\n  locale: string;\n  position: number;\n  driver?: string | null;\n}\n\n/** Metadata for WSA-based results (shopping/social/geo focus). */\nexport interface NimbleWsaMetadata {\n  agent_name: string;\n}\n\nexport interface NimbleRawSearchResult {\n  /** Full page text in `deep`; may be empty in `lite`. */\n  content: string;\n  description: string;\n  title: string;\n  url: string;\n  /** SERP focus (v1 `general`) yields {@link NimbleSerpMetadata}. */\n  metadata: NimbleSerpMetadata | NimbleWsaMetadata;\n  /** Platform-specific extras (price, publish_date, …); omitted when none. */\n  additional_data?: Record<string, unknown> | null;\n}\n\nexport interface NimbleRawSearchResponse {\n  request_id: string;\n  results: NimbleRawSearchResult[];\n  total_results: number;\n  /** Intentionally never surfaced in v1 (include_answer is off). */\n  answer?: string | null;\n}\n\nexport interface NimbleSearchClient {\n  search(params: NimbleSearchParams): Promise<NimbleRawSearchResponse>;\n}\n\n/** A single normalized result item returned to the model. */\nexport interface NimbleSearchResultItem {\n  title: string;\n  url: string;\n  description?: string;\n  content?: string;\n  position?: number;\n  entityType?: string;\n}\n\n/** The normalized tool output. `answer` is intentionally omitted in v1. */\nexport interface NimbleSearchOutput {\n  query: string;\n  requestId?: string;\n  totalResults?: number;\n  results: NimbleSearchResultItem[];\n}\n","import type {\n  NimbleRawSearchResponse,\n  NimbleRawSearchResult,\n  NimbleSearchOutput,\n  NimbleSearchResultItem,\n  NimbleSerpMetadata,\n} from './schemas';\n\nexport interface NormalizeOptions {\n  query: string;\n  maxContentLength: number;\n}\n\n/** SERP focus (v1 `general`) carries position + entity_type; WSA does not. */\nfunction isSerpMetadata(\n  metadata: NimbleRawSearchResult['metadata'],\n): metadata is NimbleSerpMetadata {\n  return 'position' in metadata;\n}\n\nfunction truncate(text: string, max: number): string {\n  return text.length > max ? text.slice(0, max) : text;\n}\n\n/**\n * Map a raw `/v1/search` response into the package's normalized output shape.\n *\n * - `description` is the snippet (always present when the API returns one).\n * - `content` is the full page text, present only in `deep` depth (empty in\n *   `lite`), truncated to `maxContentLength`.\n * - `position` / `entityType` come from SERP metadata; for WSA results\n *   `position` falls back to the array index and `entityType` is omitted.\n * - Results without a URL are dropped (defensive).\n * - `response.answer` is never surfaced in v1.\n */\nexport function normalizeSearchResponse(\n  response: NimbleRawSearchResponse,\n  options: NormalizeOptions,\n): NimbleSearchOutput {\n  const results: NimbleSearchResultItem[] = [];\n\n  response.results.forEach((raw, index) => {\n    if (!raw.url) return;\n\n    const item: NimbleSearchResultItem = {\n      title: raw.title ?? '',\n      url: raw.url,\n    };\n    if (raw.description) item.description = raw.description;\n    if (raw.content && raw.content.trim().length > 0) {\n      item.content = truncate(raw.content, options.maxContentLength);\n    }\n\n    if (isSerpMetadata(raw.metadata)) {\n      item.position = raw.metadata.position;\n      item.entityType = raw.metadata.entity_type;\n    } else {\n      item.position = index + 1;\n    }\n\n    results.push(item);\n  });\n\n  return {\n    query: options.query,\n    requestId: response.request_id,\n    totalResults: response.total_results,\n    results,\n  };\n}\n","/**\n * Thrown when the tool is invoked without a resolvable API key (no `apiKey`\n * config and no `NIMBLE_API_KEY` in the environment) and no injected client.\n * Raised at execute time, not at factory-construction time, so the tool can be\n * constructed in environments without a key (e.g. unit tests, type-checking).\n */\nexport class NimbleConfigError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = 'NimbleConfigError';\n  }\n}\n\n/**\n * Wraps an error surfaced by the Nimble client / API during a search call,\n * preserving the HTTP status when available. The AI SDK surfaces a thrown\n * tool error back to the model as a tool-call failure.\n */\nexport class NimbleSearchError extends Error {\n  readonly status?: number;\n\n  constructor(message: string, options?: { status?: number; cause?: unknown }) {\n    super(message, options?.cause !== undefined ? { cause: options.cause } : undefined);\n    this.name = 'NimbleSearchError';\n    this.status = options?.status;\n  }\n}\n","import { tool } from 'ai';\nimport { Nimble } from '@nimble-way/nimble-js';\nimport { nimbleSearchInputSchema } from './schemas';\nimport type {\n  NimbleSearchClient,\n  NimbleSearchOutput,\n  NimbleSearchParams,\n  NimbleSearchToolConfig,\n} from './schemas';\nimport { normalizeSearchResponse } from './normalize';\nimport { NimbleConfigError, NimbleSearchError } from './errors';\n\n/** v1 factory defaults. `focus` is fixed to `general` and not user-exposed. */\nexport const NIMBLE_SEARCH_DEFAULTS = {\n  maxResults: 5,\n  maxResultsCap: 10,\n  searchDepth: 'lite',\n  country: 'US',\n  locale: 'en',\n  maxContentLength: 10_000,\n  focus: 'general',\n} as const;\n\nfunction clamp(value: number, min: number, max: number): number {\n  return Math.min(Math.max(value, min), max);\n}\n\nfunction readStatus(err: unknown): number | undefined {\n  if (typeof err === 'object' && err !== null && 'status' in err) {\n    const status = (err as { status?: unknown }).status;\n    return typeof status === 'number' ? status : undefined;\n  }\n  return undefined;\n}\n\nfunction toSearchError(err: unknown): NimbleSearchError {\n  if (err instanceof NimbleSearchError) return err;\n  const message = err instanceof Error ? err.message : String(err);\n  return new NimbleSearchError(`Nimble search failed: ${message}`, {\n    status: readStatus(err),\n    cause: err,\n  });\n}\n\nfunction resolveClient(config: NimbleSearchToolConfig): NimbleSearchClient {\n  if (config.client) return config.client;\n  const apiKey = config.apiKey ?? process.env.NIMBLE_API_KEY;\n  if (!apiKey) {\n    throw new NimbleConfigError(\n      'Missing Nimble API key: set NIMBLE_API_KEY or pass { apiKey } to nimbleSearch().',\n    );\n  }\n  return new Nimble({ apiKey }) as unknown as NimbleSearchClient;\n}\n\n/**\n * Create a ready-made Vercel AI SDK web-search tool backed by Nimble Search\n * (`@nimble-way/nimble-js` → `POST /v1/search`).\n *\n * The model only chooses `{ query, maxResults? }`; all policy (depth, focus,\n * region, caps) is fixed by `config` — mirroring the Exa `webSearch()` shape.\n *\n * @example\n * ```ts\n * import { generateText } from 'ai';\n * import { nimbleSearch } from '@nimble-way/ai-sdk';\n *\n * const { text } = await generateText({\n *   model: 'anthropic/claude-sonnet-4.6',\n *   prompt: 'What are the latest Nimble release notes?',\n *   tools: { webSearch: nimbleSearch({ searchDepth: 'lite', maxResults: 5 }) },\n * });\n * ```\n */\nexport function nimbleSearch(config: NimbleSearchToolConfig = {}) {\n  const maxResults = config.maxResults ?? NIMBLE_SEARCH_DEFAULTS.maxResults;\n  const maxResultsCap = config.maxResultsCap ?? NIMBLE_SEARCH_DEFAULTS.maxResultsCap;\n  const searchDepth = config.searchDepth ?? NIMBLE_SEARCH_DEFAULTS.searchDepth;\n  const country = config.country ?? NIMBLE_SEARCH_DEFAULTS.country;\n  const locale = config.locale ?? NIMBLE_SEARCH_DEFAULTS.locale;\n  const maxContentLength = config.maxContentLength ?? NIMBLE_SEARCH_DEFAULTS.maxContentLength;\n\n  return tool({\n    description:\n      'Search the web with Nimble and return ranked results (title, url, ' +\n      'snippet, and page content) for answering questions about current or ' +\n      'factual information.',\n    inputSchema: nimbleSearchInputSchema,\n    execute: async (input): Promise<NimbleSearchOutput> => {\n      const client = resolveClient(config);\n\n      const params: NimbleSearchParams = {\n        query: input.query,\n        max_results: clamp(input.maxResults ?? maxResults, 1, maxResultsCap),\n        search_depth: searchDepth,\n        focus: NIMBLE_SEARCH_DEFAULTS.focus, // fixed 'general' in v1\n        country,\n        locale,\n      };\n\n      let raw;\n      try {\n        raw = await client.search(params);\n      } catch (err) {\n        throw toSearchError(err);\n      }\n\n      return normalizeSearchResponse(raw, {\n        query: input.query,\n        maxContentLength,\n      });\n    },\n  });\n}\n"]}

package/dist/index.d.cts

@@ -0,0 +1,188 @@
+import * as ai from 'ai';
+import { z } from 'zod';
+
+/**
+ * The tool input the model fills in. Kept deliberately small: the model only
+ * chooses the query and (optionally) how many results it wants. All policy
+ * (depth, focus, region, caps) is fixed by the developer via the factory
+ * config, not by the model.
+ */
+declare const nimbleSearchInputSchema: z.ZodObject<{
+    query: z.ZodString;
+    maxResults: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    query: string;
+    maxResults?: number | undefined;
+}, {
+    query: string;
+    maxResults?: number | undefined;
+}>;
+type NimbleSearchInput = z.infer<typeof nimbleSearchInputSchema>;
+/**
+ * v1 exposes only the two non-enterprise depths. `fast` is enterprise-gated and
+ * intentionally not offered here.
+ */
+type SearchDepth = 'lite' | 'deep';
+/**
+ * Developer-facing factory config. `focus` is fixed to `general` in v1 and is
+ * not exposed. `include_answer` and `search_depth: 'fast'` are intentionally
+ * absent (enterprise / unverified-entitlement surface).
+ */
+interface NimbleSearchToolConfig {
+    /** Nimble API key. Defaults to `process.env.NIMBLE_API_KEY`. */
+    apiKey?: string;
+    /** Inject a pre-built / mock Nimble client (tests, advanced users). */
+    client?: NimbleSearchClient;
+    /** Default number of results when the model doesn't specify. Default 5. */
+    maxResults?: number;
+    /** Hard upper bound on results, regardless of model request. Default 10. */
+    maxResultsCap?: number;
+    /** Search depth. Default `lite`. */
+    searchDepth?: SearchDepth;
+    /** ISO country for result localization. Default `US`. */
+    country?: string;
+    /** Locale for result localization. Default `en`. */
+    locale?: string;
+    /** Truncate each result's body to this many characters. Default 10_000. */
+    maxContentLength?: number;
+}
+/**
+ * Structural surface of `@nimble-way/nimble-js`'s `client.search()` that this
+ * package relies on. Declared structurally so the scaffold typechecks without
+ * pinning to the SDK's generated type names, and so tests can inject a mock.
+ *
+ * Phase B: reconcile field casing/names against
+ * `sdks/nimble-js/checkout/src/` after `./tools/sync-sdk.sh nimble-js`.
+ */
+interface NimbleSearchParams {
+    query: string;
+    max_results?: number;
+    search_depth?: SearchDepth;
+    focus?: string;
+    country?: string;
+    locale?: string;
+}
+/** Metadata for SERP-based results (general/news/location focus). */
+interface NimbleSerpMetadata {
+    country: string;
+    entity_type: string;
+    locale: string;
+    position: number;
+    driver?: string | null;
+}
+/** Metadata for WSA-based results (shopping/social/geo focus). */
+interface NimbleWsaMetadata {
+    agent_name: string;
+}
+interface NimbleRawSearchResult {
+    /** Full page text in `deep`; may be empty in `lite`. */
+    content: string;
+    description: string;
+    title: string;
+    url: string;
+    /** SERP focus (v1 `general`) yields {@link NimbleSerpMetadata}. */
+    metadata: NimbleSerpMetadata | NimbleWsaMetadata;
+    /** Platform-specific extras (price, publish_date, …); omitted when none. */
+    additional_data?: Record<string, unknown> | null;
+}
+interface NimbleRawSearchResponse {
+    request_id: string;
+    results: NimbleRawSearchResult[];
+    total_results: number;
+    /** Intentionally never surfaced in v1 (include_answer is off). */
+    answer?: string | null;
+}
+interface NimbleSearchClient {
+    search(params: NimbleSearchParams): Promise<NimbleRawSearchResponse>;
+}
+/** A single normalized result item returned to the model. */
+interface NimbleSearchResultItem {
+    title: string;
+    url: string;
+    description?: string;
+    content?: string;
+    position?: number;
+    entityType?: string;
+}
+/** The normalized tool output. `answer` is intentionally omitted in v1. */
+interface NimbleSearchOutput {
+    query: string;
+    requestId?: string;
+    totalResults?: number;
+    results: NimbleSearchResultItem[];
+}
+
+/** v1 factory defaults. `focus` is fixed to `general` and not user-exposed. */
+declare const NIMBLE_SEARCH_DEFAULTS: {
+    readonly maxResults: 5;
+    readonly maxResultsCap: 10;
+    readonly searchDepth: "lite";
+    readonly country: "US";
+    readonly locale: "en";
+    readonly maxContentLength: 10000;
+    readonly focus: "general";
+};
+/**
+ * Create a ready-made Vercel AI SDK web-search tool backed by Nimble Search
+ * (`@nimble-way/nimble-js` → `POST /v1/search`).
+ *
+ * The model only chooses `{ query, maxResults? }`; all policy (depth, focus,
+ * region, caps) is fixed by `config` — mirroring the Exa `webSearch()` shape.
+ *
+ * @example
+ * ```ts
+ * import { generateText } from 'ai';
+ * import { nimbleSearch } from '@nimble-way/ai-sdk';
+ *
+ * const { text } = await generateText({
+ *   model: 'anthropic/claude-sonnet-4.6',
+ *   prompt: 'What are the latest Nimble release notes?',
+ *   tools: { webSearch: nimbleSearch({ searchDepth: 'lite', maxResults: 5 }) },
+ * });
+ * ```
+ */
+declare function nimbleSearch(config?: NimbleSearchToolConfig): ai.Tool<{
+    query: string;
+    maxResults?: number | undefined;
+}, NimbleSearchOutput>;
+
+interface NormalizeOptions {
+    query: string;
+    maxContentLength: number;
+}
+/**
+ * Map a raw `/v1/search` response into the package's normalized output shape.
+ *
+ * - `description` is the snippet (always present when the API returns one).
+ * - `content` is the full page text, present only in `deep` depth (empty in
+ *   `lite`), truncated to `maxContentLength`.
+ * - `position` / `entityType` come from SERP metadata; for WSA results
+ *   `position` falls back to the array index and `entityType` is omitted.
+ * - Results without a URL are dropped (defensive).
+ * - `response.answer` is never surfaced in v1.
+ */
+declare function normalizeSearchResponse(response: NimbleRawSearchResponse, options: NormalizeOptions): NimbleSearchOutput;
+
+/**
+ * Thrown when the tool is invoked without a resolvable API key (no `apiKey`
+ * config and no `NIMBLE_API_KEY` in the environment) and no injected client.
+ * Raised at execute time, not at factory-construction time, so the tool can be
+ * constructed in environments without a key (e.g. unit tests, type-checking).
+ */
+declare class NimbleConfigError extends Error {
+    constructor(message: string);
+}
+/**
+ * Wraps an error surfaced by the Nimble client / API during a search call,
+ * preserving the HTTP status when available. The AI SDK surfaces a thrown
+ * tool error back to the model as a tool-call failure.
+ */
+declare class NimbleSearchError extends Error {
+    readonly status?: number;
+    constructor(message: string, options?: {
+        status?: number;
+        cause?: unknown;
+    });
+}
+
+export { NIMBLE_SEARCH_DEFAULTS, NimbleConfigError, type NimbleRawSearchResponse, type NimbleRawSearchResult, type NimbleSearchClient, NimbleSearchError, type NimbleSearchInput, type NimbleSearchOutput, type NimbleSearchParams, type NimbleSearchResultItem, type NimbleSearchToolConfig, type NimbleSerpMetadata, type NimbleWsaMetadata, type NormalizeOptions, type SearchDepth, nimbleSearch, nimbleSearchInputSchema, normalizeSearchResponse };

package/dist/index.d.ts

@@ -0,0 +1,188 @@
+import * as ai from 'ai';
+import { z } from 'zod';
+
+/**
+ * The tool input the model fills in. Kept deliberately small: the model only
+ * chooses the query and (optionally) how many results it wants. All policy
+ * (depth, focus, region, caps) is fixed by the developer via the factory
+ * config, not by the model.
+ */
+declare const nimbleSearchInputSchema: z.ZodObject<{
+    query: z.ZodString;
+    maxResults: z.ZodOptional<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    query: string;
+    maxResults?: number | undefined;
+}, {
+    query: string;
+    maxResults?: number | undefined;
+}>;
+type NimbleSearchInput = z.infer<typeof nimbleSearchInputSchema>;
+/**
+ * v1 exposes only the two non-enterprise depths. `fast` is enterprise-gated and
+ * intentionally not offered here.
+ */
+type SearchDepth = 'lite' | 'deep';
+/**
+ * Developer-facing factory config. `focus` is fixed to `general` in v1 and is
+ * not exposed. `include_answer` and `search_depth: 'fast'` are intentionally
+ * absent (enterprise / unverified-entitlement surface).
+ */
+interface NimbleSearchToolConfig {
+    /** Nimble API key. Defaults to `process.env.NIMBLE_API_KEY`. */
+    apiKey?: string;
+    /** Inject a pre-built / mock Nimble client (tests, advanced users). */
+    client?: NimbleSearchClient;
+    /** Default number of results when the model doesn't specify. Default 5. */
+    maxResults?: number;
+    /** Hard upper bound on results, regardless of model request. Default 10. */
+    maxResultsCap?: number;
+    /** Search depth. Default `lite`. */
+    searchDepth?: SearchDepth;
+    /** ISO country for result localization. Default `US`. */
+    country?: string;
+    /** Locale for result localization. Default `en`. */
+    locale?: string;
+    /** Truncate each result's body to this many characters. Default 10_000. */
+    maxContentLength?: number;
+}
+/**
+ * Structural surface of `@nimble-way/nimble-js`'s `client.search()` that this
+ * package relies on. Declared structurally so the scaffold typechecks without
+ * pinning to the SDK's generated type names, and so tests can inject a mock.
+ *
+ * Phase B: reconcile field casing/names against
+ * `sdks/nimble-js/checkout/src/` after `./tools/sync-sdk.sh nimble-js`.
+ */
+interface NimbleSearchParams {
+    query: string;
+    max_results?: number;
+    search_depth?: SearchDepth;
+    focus?: string;
+    country?: string;
+    locale?: string;
+}
+/** Metadata for SERP-based results (general/news/location focus). */
+interface NimbleSerpMetadata {
+    country: string;
+    entity_type: string;
+    locale: string;
+    position: number;
+    driver?: string | null;
+}
+/** Metadata for WSA-based results (shopping/social/geo focus). */
+interface NimbleWsaMetadata {
+    agent_name: string;
+}
+interface NimbleRawSearchResult {
+    /** Full page text in `deep`; may be empty in `lite`. */
+    content: string;
+    description: string;
+    title: string;
+    url: string;
+    /** SERP focus (v1 `general`) yields {@link NimbleSerpMetadata}. */
+    metadata: NimbleSerpMetadata | NimbleWsaMetadata;
+    /** Platform-specific extras (price, publish_date, …); omitted when none. */
+    additional_data?: Record<string, unknown> | null;
+}
+interface NimbleRawSearchResponse {
+    request_id: string;
+    results: NimbleRawSearchResult[];
+    total_results: number;
+    /** Intentionally never surfaced in v1 (include_answer is off). */
+    answer?: string | null;
+}
+interface NimbleSearchClient {
+    search(params: NimbleSearchParams): Promise<NimbleRawSearchResponse>;
+}
+/** A single normalized result item returned to the model. */
+interface NimbleSearchResultItem {
+    title: string;
+    url: string;
+    description?: string;
+    content?: string;
+    position?: number;
+    entityType?: string;
+}
+/** The normalized tool output. `answer` is intentionally omitted in v1. */
+interface NimbleSearchOutput {
+    query: string;
+    requestId?: string;
+    totalResults?: number;
+    results: NimbleSearchResultItem[];
+}
+
+/** v1 factory defaults. `focus` is fixed to `general` and not user-exposed. */
+declare const NIMBLE_SEARCH_DEFAULTS: {
+    readonly maxResults: 5;
+    readonly maxResultsCap: 10;
+    readonly searchDepth: "lite";
+    readonly country: "US";
+    readonly locale: "en";
+    readonly maxContentLength: 10000;
+    readonly focus: "general";
+};
+/**
+ * Create a ready-made Vercel AI SDK web-search tool backed by Nimble Search
+ * (`@nimble-way/nimble-js` → `POST /v1/search`).
+ *
+ * The model only chooses `{ query, maxResults? }`; all policy (depth, focus,
+ * region, caps) is fixed by `config` — mirroring the Exa `webSearch()` shape.
+ *
+ * @example
+ * ```ts
+ * import { generateText } from 'ai';
+ * import { nimbleSearch } from '@nimble-way/ai-sdk';
+ *
+ * const { text } = await generateText({
+ *   model: 'anthropic/claude-sonnet-4.6',
+ *   prompt: 'What are the latest Nimble release notes?',
+ *   tools: { webSearch: nimbleSearch({ searchDepth: 'lite', maxResults: 5 }) },
+ * });
+ * ```
+ */
+declare function nimbleSearch(config?: NimbleSearchToolConfig): ai.Tool<{
+    query: string;
+    maxResults?: number | undefined;
+}, NimbleSearchOutput>;
+
+interface NormalizeOptions {
+    query: string;
+    maxContentLength: number;
+}
+/**
+ * Map a raw `/v1/search` response into the package's normalized output shape.
+ *
+ * - `description` is the snippet (always present when the API returns one).
+ * - `content` is the full page text, present only in `deep` depth (empty in
+ *   `lite`), truncated to `maxContentLength`.
+ * - `position` / `entityType` come from SERP metadata; for WSA results
+ *   `position` falls back to the array index and `entityType` is omitted.
+ * - Results without a URL are dropped (defensive).
+ * - `response.answer` is never surfaced in v1.
+ */
+declare function normalizeSearchResponse(response: NimbleRawSearchResponse, options: NormalizeOptions): NimbleSearchOutput;
+
+/**
+ * Thrown when the tool is invoked without a resolvable API key (no `apiKey`
+ * config and no `NIMBLE_API_KEY` in the environment) and no injected client.
+ * Raised at execute time, not at factory-construction time, so the tool can be
+ * constructed in environments without a key (e.g. unit tests, type-checking).
+ */
+declare class NimbleConfigError extends Error {
+    constructor(message: string);
+}
+/**
+ * Wraps an error surfaced by the Nimble client / API during a search call,
+ * preserving the HTTP status when available. The AI SDK surfaces a thrown
+ * tool error back to the model as a tool-call failure.
+ */
+declare class NimbleSearchError extends Error {
+    readonly status?: number;
+    constructor(message: string, options?: {
+        status?: number;
+        cause?: unknown;
+    });
+}
+
+export { NIMBLE_SEARCH_DEFAULTS, NimbleConfigError, type NimbleRawSearchResponse, type NimbleRawSearchResult, type NimbleSearchClient, NimbleSearchError, type NimbleSearchInput, type NimbleSearchOutput, type NimbleSearchParams, type NimbleSearchResultItem, type NimbleSearchToolConfig, type NimbleSerpMetadata, type NimbleWsaMetadata, type NormalizeOptions, type SearchDepth, nimbleSearch, nimbleSearchInputSchema, normalizeSearchResponse };

package/dist/index.js

@@ -0,0 +1,137 @@
+import { tool } from 'ai';
+import { Nimble } from '@nimble-way/nimble-js';
+import { z } from 'zod';
+
+// src/nimble-search.ts
+var nimbleSearchInputSchema = z.object({
+  query: z.string().min(1).describe("The web search query."),
+  maxResults: z.number().int().positive().optional().describe("How many results to return (clamped to the developer-configured cap).")
+});
+
+// src/normalize.ts
+function isSerpMetadata(metadata) {
+  return "position" in metadata;
+}
+function truncate(text, max) {
+  return text.length > max ? text.slice(0, max) : text;
+}
+function normalizeSearchResponse(response, options) {
+  const results = [];
+  response.results.forEach((raw, index) => {
+    if (!raw.url) return;
+    const item = {
+      title: raw.title ?? "",
+      url: raw.url
+    };
+    if (raw.description) item.description = raw.description;
+    if (raw.content && raw.content.trim().length > 0) {
+      item.content = truncate(raw.content, options.maxContentLength);
+    }
+    if (isSerpMetadata(raw.metadata)) {
+      item.position = raw.metadata.position;
+      item.entityType = raw.metadata.entity_type;
+    } else {
+      item.position = index + 1;
+    }
+    results.push(item);
+  });
+  return {
+    query: options.query,
+    requestId: response.request_id,
+    totalResults: response.total_results,
+    results
+  };
+}
+
+// src/errors.ts
+var NimbleConfigError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "NimbleConfigError";
+  }
+};
+var NimbleSearchError = class extends Error {
+  status;
+  constructor(message, options) {
+    super(message, options?.cause !== void 0 ? { cause: options.cause } : void 0);
+    this.name = "NimbleSearchError";
+    this.status = options?.status;
+  }
+};
+
+// src/nimble-search.ts
+var NIMBLE_SEARCH_DEFAULTS = {
+  maxResults: 5,
+  maxResultsCap: 10,
+  searchDepth: "lite",
+  country: "US",
+  locale: "en",
+  maxContentLength: 1e4,
+  focus: "general"
+};
+function clamp(value, min, max) {
+  return Math.min(Math.max(value, min), max);
+}
+function readStatus(err) {
+  if (typeof err === "object" && err !== null && "status" in err) {
+    const status = err.status;
+    return typeof status === "number" ? status : void 0;
+  }
+  return void 0;
+}
+function toSearchError(err) {
+  if (err instanceof NimbleSearchError) return err;
+  const message = err instanceof Error ? err.message : String(err);
+  return new NimbleSearchError(`Nimble search failed: ${message}`, {
+    status: readStatus(err),
+    cause: err
+  });
+}
+function resolveClient(config) {
+  if (config.client) return config.client;
+  const apiKey = config.apiKey ?? process.env.NIMBLE_API_KEY;
+  if (!apiKey) {
+    throw new NimbleConfigError(
+      "Missing Nimble API key: set NIMBLE_API_KEY or pass { apiKey } to nimbleSearch()."
+    );
+  }
+  return new Nimble({ apiKey });
+}
+function nimbleSearch(config = {}) {
+  const maxResults = config.maxResults ?? NIMBLE_SEARCH_DEFAULTS.maxResults;
+  const maxResultsCap = config.maxResultsCap ?? NIMBLE_SEARCH_DEFAULTS.maxResultsCap;
+  const searchDepth = config.searchDepth ?? NIMBLE_SEARCH_DEFAULTS.searchDepth;
+  const country = config.country ?? NIMBLE_SEARCH_DEFAULTS.country;
+  const locale = config.locale ?? NIMBLE_SEARCH_DEFAULTS.locale;
+  const maxContentLength = config.maxContentLength ?? NIMBLE_SEARCH_DEFAULTS.maxContentLength;
+  return tool({
+    description: "Search the web with Nimble and return ranked results (title, url, snippet, and page content) for answering questions about current or factual information.",
+    inputSchema: nimbleSearchInputSchema,
+    execute: async (input) => {
+      const client = resolveClient(config);
+      const params = {
+        query: input.query,
+        max_results: clamp(input.maxResults ?? maxResults, 1, maxResultsCap),
+        search_depth: searchDepth,
+        focus: NIMBLE_SEARCH_DEFAULTS.focus,
+        // fixed 'general' in v1
+        country,
+        locale
+      };
+      let raw;
+      try {
+        raw = await client.search(params);
+      } catch (err) {
+        throw toSearchError(err);
+      }
+      return normalizeSearchResponse(raw, {
+        query: input.query,
+        maxContentLength
+      });
+    }
+  });
+}
+
+export { NIMBLE_SEARCH_DEFAULTS, NimbleConfigError, NimbleSearchError, nimbleSearch, nimbleSearchInputSchema, normalizeSearchResponse };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/schemas.ts","../src/normalize.ts","../src/errors.ts","../src/nimble-search.ts"],"names":[],"mappings":";;;;;AAQO,IAAM,uBAAA,GAA0B,EAAE,MAAA,CAAO;AAAA,EAC9C,KAAA,EAAO,EAAE,MAAA,EAAO,CAAE,IAAI,CAAC,CAAA,CAAE,SAAS,uBAAuB,CAAA;AAAA,EACzD,UAAA,EAAY,CAAA,CACT,MAAA,EAAO,CACP,GAAA,EAAI,CACJ,QAAA,EAAS,CACT,QAAA,EAAS,CACT,QAAA,CAAS,uEAAuE;AACrF,CAAC;;;ACFD,SAAS,eACP,QAAA,EACgC;AAChC,EAAA,OAAO,UAAA,IAAc,QAAA;AACvB;AAEA,SAAS,QAAA,CAAS,MAAc,GAAA,EAAqB;AACnD,EAAA,OAAO,KAAK,MAAA,GAAS,GAAA,GAAM,KAAK,KAAA,CAAM,CAAA,EAAG,GAAG,CAAA,GAAI,IAAA;AAClD;AAaO,SAAS,uBAAA,CACd,UACA,OAAA,EACoB;AACpB,EAAA,MAAM,UAAoC,EAAC;AAE3C,EAAA,QAAA,CAAS,OAAA,CAAQ,OAAA,CAAQ,CAAC,GAAA,EAAK,KAAA,KAAU;AACvC,IAAA,IAAI,CAAC,IAAI,GAAA,EAAK;AAEd,IAAA,MAAM,IAAA,GAA+B;AAAA,MACnC,KAAA,EAAO,IAAI,KAAA,IAAS,EAAA;AAAA,MACpB,KAAK,GAAA,CAAI;AAAA,KACX;AACA,IAAA,IAAI,GAAA,CAAI,WAAA,EAAa,IAAA,CAAK,WAAA,GAAc,GAAA,CAAI,WAAA;AAC5C,IAAA,IAAI,IAAI,OAAA,IAAW,GAAA,CAAI,QAAQ,IAAA,EAAK,CAAE,SAAS,CAAA,EAAG;AAChD,MAAA,IAAA,CAAK,OAAA,GAAU,QAAA,CAAS,GAAA,CAAI,OAAA,EAAS,QAAQ,gBAAgB,CAAA;AAAA,IAC/D;AAEA,IAAA,IAAI,cAAA,CAAe,GAAA,CAAI,QAAQ,CAAA,EAAG;AAChC,MAAA,IAAA,CAAK,QAAA,GAAW,IAAI,QAAA,CAAS,QAAA;AAC7B,MAAA,IAAA,CAAK,UAAA,GAAa,IAAI,QAAA,CAAS,WAAA;AAAA,IACjC,CAAA,MAAO;AACL,MAAA,IAAA,CAAK,WAAW,KAAA,GAAQ,CAAA;AAAA,IAC1B;AAEA,IAAA,OAAA,CAAQ,KAAK,IAAI,CAAA;AAAA,EACnB,CAAC,CAAA;AAED,EAAA,OAAO;AAAA,IACL,OAAO,OAAA,CAAQ,KAAA;AAAA,IACf,WAAW,QAAA,CAAS,UAAA;AAAA,IACpB,cAAc,QAAA,CAAS,aAAA;AAAA,IACvB;AAAA,GACF;AACF;;;AC/DO,IAAM,iBAAA,GAAN,cAAgC,KAAA,CAAM;AAAA,EAC3C,YAAY,OAAA,EAAiB;AAC3B,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,mBAAA;AAAA,EACd;AACF;AAOO,IAAM,iBAAA,GAAN,cAAgC,KAAA,CAAM;AAAA,EAClC,MAAA;AAAA,EAET,WAAA,CAAY,SAAiB,OAAA,EAAgD;AAC3E,IAAA,KAAA,CAAM,OAAA,EAAS,SAAS,KAAA,KAAU,MAAA,GAAY,EAAE,KAAA,EAAO,OAAA,CAAQ,KAAA,EAAM,GAAI,MAAS,CAAA;AAClF,IAAA,IAAA,CAAK,IAAA,GAAO,mBAAA;AACZ,IAAA,IAAA,CAAK,SAAS,OAAA,EAAS,MAAA;AAAA,EACzB;AACF;;;ACbO,IAAM,sBAAA,GAAyB;AAAA,EACpC,UAAA,EAAY,CAAA;AAAA,EACZ,aAAA,EAAe,EAAA;AAAA,EACf,WAAA,EAAa,MAAA;AAAA,EACb,OAAA,EAAS,IAAA;AAAA,EACT,MAAA,EAAQ,IAAA;AAAA,EACR,gBAAA,EAAkB,GAAA;AAAA,EAClB,KAAA,EAAO;AACT;AAEA,SAAS,KAAA,CAAM,KAAA,EAAe,GAAA,EAAa,GAAA,EAAqB;AAC9D,EAAA,OAAO,KAAK,GAAA,CAAI,IAAA,CAAK,IAAI,KAAA,EAAO,GAAG,GAAG,GAAG,CAAA;AAC3C;AAEA,SAAS,WAAW,GAAA,EAAkC;AACpD,EAAA,IAAI,OAAO,GAAA,KAAQ,QAAA,IAAY,GAAA,KAAQ,IAAA,IAAQ,YAAY,GAAA,EAAK;AAC9D,IAAA,MAAM,SAAU,GAAA,CAA6B,MAAA;AAC7C,IAAA,OAAO,OAAO,MAAA,KAAW,QAAA,GAAW,MAAA,GAAS,MAAA;AAAA,EAC/C;AACA,EAAA,OAAO,MAAA;AACT;AAEA,SAAS,cAAc,GAAA,EAAiC;AACtD,EAAA,IAAI,GAAA,YAAe,mBAAmB,OAAO,GAAA;AAC7C,EAAA,MAAM,UAAU,GAAA,YAAe,KAAA,GAAQ,GAAA,CAAI,OAAA,GAAU,OAAO,GAAG,CAAA;AAC/D,EAAA,OAAO,IAAI,iBAAA,CAAkB,CAAA,sBAAA,EAAyB,OAAO,CAAA,CAAA,EAAI;AAAA,IAC/D,MAAA,EAAQ,WAAW,GAAG,CAAA;AAAA,IACtB,KAAA,EAAO;AAAA,GACR,CAAA;AACH;AAEA,SAAS,cAAc,MAAA,EAAoD;AACzE,EAAA,IAAI,MAAA,CAAO,MAAA,EAAQ,OAAO,MAAA,CAAO,MAAA;AACjC,EAAA,MAAM,MAAA,GAAS,MAAA,CAAO,MAAA,IAAU,OAAA,CAAQ,GAAA,CAAI,cAAA;AAC5C,EAAA,IAAI,CAAC,MAAA,EAAQ;AACX,IAAA,MAAM,IAAI,iBAAA;AAAA,MACR;AAAA,KACF;AAAA,EACF;AACA,EAAA,OAAO,IAAI,MAAA,CAAO,EAAE,MAAA,EAAQ,CAAA;AAC9B;AAqBO,SAAS,YAAA,CAAa,MAAA,GAAiC,EAAC,EAAG;AAChE,EAAA,MAAM,UAAA,GAAa,MAAA,CAAO,UAAA,IAAc,sBAAA,CAAuB,UAAA;AAC/D,EAAA,MAAM,aAAA,GAAgB,MAAA,CAAO,aAAA,IAAiB,sBAAA,CAAuB,aAAA;AACrE,EAAA,MAAM,WAAA,GAAc,MAAA,CAAO,WAAA,IAAe,sBAAA,CAAuB,WAAA;AACjE,EAAA,MAAM,OAAA,GAAU,MAAA,CAAO,OAAA,IAAW,sBAAA,CAAuB,OAAA;AACzD,EAAA,MAAM,MAAA,GAAS,MAAA,CAAO,MAAA,IAAU,sBAAA,CAAuB,MAAA;AACvD,EAAA,MAAM,gBAAA,GAAmB,MAAA,CAAO,gBAAA,IAAoB,sBAAA,CAAuB,gBAAA;AAE3E,EAAA,OAAO,IAAA,CAAK;AAAA,IACV,WAAA,EACE,4JAAA;AAAA,IAGF,WAAA,EAAa,uBAAA;AAAA,IACb,OAAA,EAAS,OAAO,KAAA,KAAuC;AACrD,MAAA,MAAM,MAAA,GAAS,cAAc,MAAM,CAAA;AAEnC,MAAA,MAAM,MAAA,GAA6B;AAAA,QACjC,OAAO,KAAA,CAAM,KAAA;AAAA,QACb,aAAa,KAAA,CAAM,KAAA,CAAM,UAAA,IAAc,UAAA,EAAY,GAAG,aAAa,CAAA;AAAA,QACnE,YAAA,EAAc,WAAA;AAAA,QACd,OAAO,sBAAA,CAAuB,KAAA;AAAA;AAAA,QAC9B,OAAA;AAAA,QACA;AAAA,OACF;AAEA,MAAA,IAAI,GAAA;AACJ,MAAA,IAAI;AACF,QAAA,GAAA,GAAM,MAAM,MAAA,CAAO,MAAA,CAAO,MAAM,CAAA;AAAA,MAClC,SAAS,GAAA,EAAK;AACZ,QAAA,MAAM,cAAc,GAAG,CAAA;AAAA,MACzB;AAEA,MAAA,OAAO,wBAAwB,GAAA,EAAK;AAAA,QAClC,OAAO,KAAA,CAAM,KAAA;AAAA,QACb;AAAA,OACD,CAAA;AAAA,IACH;AAAA,GACD,CAAA;AACH","file":"index.js","sourcesContent":["import { z } from 'zod';\n\n/**\n * The tool input the model fills in. Kept deliberately small: the model only\n * chooses the query and (optionally) how many results it wants. All policy\n * (depth, focus, region, caps) is fixed by the developer via the factory\n * config, not by the model.\n */\nexport const nimbleSearchInputSchema = z.object({\n  query: z.string().min(1).describe('The web search query.'),\n  maxResults: z\n    .number()\n    .int()\n    .positive()\n    .optional()\n    .describe('How many results to return (clamped to the developer-configured cap).'),\n});\n\nexport type NimbleSearchInput = z.infer<typeof nimbleSearchInputSchema>;\n\n/**\n * v1 exposes only the two non-enterprise depths. `fast` is enterprise-gated and\n * intentionally not offered here.\n */\nexport type SearchDepth = 'lite' | 'deep';\n\n/**\n * Developer-facing factory config. `focus` is fixed to `general` in v1 and is\n * not exposed. `include_answer` and `search_depth: 'fast'` are intentionally\n * absent (enterprise / unverified-entitlement surface).\n */\nexport interface NimbleSearchToolConfig {\n  /** Nimble API key. Defaults to `process.env.NIMBLE_API_KEY`. */\n  apiKey?: string;\n  /** Inject a pre-built / mock Nimble client (tests, advanced users). */\n  client?: NimbleSearchClient;\n  /** Default number of results when the model doesn't specify. Default 5. */\n  maxResults?: number;\n  /** Hard upper bound on results, regardless of model request. Default 10. */\n  maxResultsCap?: number;\n  /** Search depth. Default `lite`. */\n  searchDepth?: SearchDepth;\n  /** ISO country for result localization. Default `US`. */\n  country?: string;\n  /** Locale for result localization. Default `en`. */\n  locale?: string;\n  /** Truncate each result's body to this many characters. Default 10_000. */\n  maxContentLength?: number;\n}\n\n/**\n * Structural surface of `@nimble-way/nimble-js`'s `client.search()` that this\n * package relies on. Declared structurally so the scaffold typechecks without\n * pinning to the SDK's generated type names, and so tests can inject a mock.\n *\n * Phase B: reconcile field casing/names against\n * `sdks/nimble-js/checkout/src/` after `./tools/sync-sdk.sh nimble-js`.\n */\nexport interface NimbleSearchParams {\n  query: string;\n  max_results?: number;\n  search_depth?: SearchDepth;\n  focus?: string;\n  country?: string;\n  locale?: string;\n}\n\n/** Metadata for SERP-based results (general/news/location focus). */\nexport interface NimbleSerpMetadata {\n  country: string;\n  entity_type: string;\n  locale: string;\n  position: number;\n  driver?: string | null;\n}\n\n/** Metadata for WSA-based results (shopping/social/geo focus). */\nexport interface NimbleWsaMetadata {\n  agent_name: string;\n}\n\nexport interface NimbleRawSearchResult {\n  /** Full page text in `deep`; may be empty in `lite`. */\n  content: string;\n  description: string;\n  title: string;\n  url: string;\n  /** SERP focus (v1 `general`) yields {@link NimbleSerpMetadata}. */\n  metadata: NimbleSerpMetadata | NimbleWsaMetadata;\n  /** Platform-specific extras (price, publish_date, …); omitted when none. */\n  additional_data?: Record<string, unknown> | null;\n}\n\nexport interface NimbleRawSearchResponse {\n  request_id: string;\n  results: NimbleRawSearchResult[];\n  total_results: number;\n  /** Intentionally never surfaced in v1 (include_answer is off). */\n  answer?: string | null;\n}\n\nexport interface NimbleSearchClient {\n  search(params: NimbleSearchParams): Promise<NimbleRawSearchResponse>;\n}\n\n/** A single normalized result item returned to the model. */\nexport interface NimbleSearchResultItem {\n  title: string;\n  url: string;\n  description?: string;\n  content?: string;\n  position?: number;\n  entityType?: string;\n}\n\n/** The normalized tool output. `answer` is intentionally omitted in v1. */\nexport interface NimbleSearchOutput {\n  query: string;\n  requestId?: string;\n  totalResults?: number;\n  results: NimbleSearchResultItem[];\n}\n","import type {\n  NimbleRawSearchResponse,\n  NimbleRawSearchResult,\n  NimbleSearchOutput,\n  NimbleSearchResultItem,\n  NimbleSerpMetadata,\n} from './schemas';\n\nexport interface NormalizeOptions {\n  query: string;\n  maxContentLength: number;\n}\n\n/** SERP focus (v1 `general`) carries position + entity_type; WSA does not. */\nfunction isSerpMetadata(\n  metadata: NimbleRawSearchResult['metadata'],\n): metadata is NimbleSerpMetadata {\n  return 'position' in metadata;\n}\n\nfunction truncate(text: string, max: number): string {\n  return text.length > max ? text.slice(0, max) : text;\n}\n\n/**\n * Map a raw `/v1/search` response into the package's normalized output shape.\n *\n * - `description` is the snippet (always present when the API returns one).\n * - `content` is the full page text, present only in `deep` depth (empty in\n *   `lite`), truncated to `maxContentLength`.\n * - `position` / `entityType` come from SERP metadata; for WSA results\n *   `position` falls back to the array index and `entityType` is omitted.\n * - Results without a URL are dropped (defensive).\n * - `response.answer` is never surfaced in v1.\n */\nexport function normalizeSearchResponse(\n  response: NimbleRawSearchResponse,\n  options: NormalizeOptions,\n): NimbleSearchOutput {\n  const results: NimbleSearchResultItem[] = [];\n\n  response.results.forEach((raw, index) => {\n    if (!raw.url) return;\n\n    const item: NimbleSearchResultItem = {\n      title: raw.title ?? '',\n      url: raw.url,\n    };\n    if (raw.description) item.description = raw.description;\n    if (raw.content && raw.content.trim().length > 0) {\n      item.content = truncate(raw.content, options.maxContentLength);\n    }\n\n    if (isSerpMetadata(raw.metadata)) {\n      item.position = raw.metadata.position;\n      item.entityType = raw.metadata.entity_type;\n    } else {\n      item.position = index + 1;\n    }\n\n    results.push(item);\n  });\n\n  return {\n    query: options.query,\n    requestId: response.request_id,\n    totalResults: response.total_results,\n    results,\n  };\n}\n","/**\n * Thrown when the tool is invoked without a resolvable API key (no `apiKey`\n * config and no `NIMBLE_API_KEY` in the environment) and no injected client.\n * Raised at execute time, not at factory-construction time, so the tool can be\n * constructed in environments without a key (e.g. unit tests, type-checking).\n */\nexport class NimbleConfigError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = 'NimbleConfigError';\n  }\n}\n\n/**\n * Wraps an error surfaced by the Nimble client / API during a search call,\n * preserving the HTTP status when available. The AI SDK surfaces a thrown\n * tool error back to the model as a tool-call failure.\n */\nexport class NimbleSearchError extends Error {\n  readonly status?: number;\n\n  constructor(message: string, options?: { status?: number; cause?: unknown }) {\n    super(message, options?.cause !== undefined ? { cause: options.cause } : undefined);\n    this.name = 'NimbleSearchError';\n    this.status = options?.status;\n  }\n}\n","import { tool } from 'ai';\nimport { Nimble } from '@nimble-way/nimble-js';\nimport { nimbleSearchInputSchema } from './schemas';\nimport type {\n  NimbleSearchClient,\n  NimbleSearchOutput,\n  NimbleSearchParams,\n  NimbleSearchToolConfig,\n} from './schemas';\nimport { normalizeSearchResponse } from './normalize';\nimport { NimbleConfigError, NimbleSearchError } from './errors';\n\n/** v1 factory defaults. `focus` is fixed to `general` and not user-exposed. */\nexport const NIMBLE_SEARCH_DEFAULTS = {\n  maxResults: 5,\n  maxResultsCap: 10,\n  searchDepth: 'lite',\n  country: 'US',\n  locale: 'en',\n  maxContentLength: 10_000,\n  focus: 'general',\n} as const;\n\nfunction clamp(value: number, min: number, max: number): number {\n  return Math.min(Math.max(value, min), max);\n}\n\nfunction readStatus(err: unknown): number | undefined {\n  if (typeof err === 'object' && err !== null && 'status' in err) {\n    const status = (err as { status?: unknown }).status;\n    return typeof status === 'number' ? status : undefined;\n  }\n  return undefined;\n}\n\nfunction toSearchError(err: unknown): NimbleSearchError {\n  if (err instanceof NimbleSearchError) return err;\n  const message = err instanceof Error ? err.message : String(err);\n  return new NimbleSearchError(`Nimble search failed: ${message}`, {\n    status: readStatus(err),\n    cause: err,\n  });\n}\n\nfunction resolveClient(config: NimbleSearchToolConfig): NimbleSearchClient {\n  if (config.client) return config.client;\n  const apiKey = config.apiKey ?? process.env.NIMBLE_API_KEY;\n  if (!apiKey) {\n    throw new NimbleConfigError(\n      'Missing Nimble API key: set NIMBLE_API_KEY or pass { apiKey } to nimbleSearch().',\n    );\n  }\n  return new Nimble({ apiKey }) as unknown as NimbleSearchClient;\n}\n\n/**\n * Create a ready-made Vercel AI SDK web-search tool backed by Nimble Search\n * (`@nimble-way/nimble-js` → `POST /v1/search`).\n *\n * The model only chooses `{ query, maxResults? }`; all policy (depth, focus,\n * region, caps) is fixed by `config` — mirroring the Exa `webSearch()` shape.\n *\n * @example\n * ```ts\n * import { generateText } from 'ai';\n * import { nimbleSearch } from '@nimble-way/ai-sdk';\n *\n * const { text } = await generateText({\n *   model: 'anthropic/claude-sonnet-4.6',\n *   prompt: 'What are the latest Nimble release notes?',\n *   tools: { webSearch: nimbleSearch({ searchDepth: 'lite', maxResults: 5 }) },\n * });\n * ```\n */\nexport function nimbleSearch(config: NimbleSearchToolConfig = {}) {\n  const maxResults = config.maxResults ?? NIMBLE_SEARCH_DEFAULTS.maxResults;\n  const maxResultsCap = config.maxResultsCap ?? NIMBLE_SEARCH_DEFAULTS.maxResultsCap;\n  const searchDepth = config.searchDepth ?? NIMBLE_SEARCH_DEFAULTS.searchDepth;\n  const country = config.country ?? NIMBLE_SEARCH_DEFAULTS.country;\n  const locale = config.locale ?? NIMBLE_SEARCH_DEFAULTS.locale;\n  const maxContentLength = config.maxContentLength ?? NIMBLE_SEARCH_DEFAULTS.maxContentLength;\n\n  return tool({\n    description:\n      'Search the web with Nimble and return ranked results (title, url, ' +\n      'snippet, and page content) for answering questions about current or ' +\n      'factual information.',\n    inputSchema: nimbleSearchInputSchema,\n    execute: async (input): Promise<NimbleSearchOutput> => {\n      const client = resolveClient(config);\n\n      const params: NimbleSearchParams = {\n        query: input.query,\n        max_results: clamp(input.maxResults ?? maxResults, 1, maxResultsCap),\n        search_depth: searchDepth,\n        focus: NIMBLE_SEARCH_DEFAULTS.focus, // fixed 'general' in v1\n        country,\n        locale,\n      };\n\n      let raw;\n      try {\n        raw = await client.search(params);\n      } catch (err) {\n        throw toSearchError(err);\n      }\n\n      return normalizeSearchResponse(raw, {\n        query: input.query,\n        maxContentLength,\n      });\n    },\n  });\n}\n"]}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@nimble-way/ai-sdk",
+  "version": "0.1.0",
+  "description": "Nimble Web Search as a ready-made tool for the Vercel AI SDK.",
+  "type": "module",
+  "license": "Apache-2.0",
+  "author": "Nimble",
+  "homepage": "https://github.com/Nimbleway/ai-sdk",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Nimbleway/ai-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Nimbleway/ai-sdk/issues"
+  },
+  "keywords": [
+    "nimble",
+    "vercel",
+    "ai-sdk",
+    "ai",
+    "web-search",
+    "search",
+    "tool",
+    "llm",
+    "agent"
+  ],
+  "sideEffects": false,
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "pnpm run build"
+  },
+  "dependencies": {
+    "@nimble-way/nimble-js": "^0.14.0"
+  },
+  "peerDependencies": {
+    "ai": "^6",
+    "zod": "^3.25.76 || ^4.1.8"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "ai": "^6.0.0",
+    "tsup": "^8.3.0",
+    "tsx": "^4.19.0",
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0",
+    "zod": "^3.25.76"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  }
+}