@kindgi/adapter-model-shared 0.0.0-stage → 0.1.6

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or 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 Kindgi Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,58 @@
-# Temporary Holding Version
+# `@kindgi/adapter-model-shared`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Shared plumbing for Kindgi's model adapters: what every adapter needs to turn a vendor's API into a [`@kindgi/capabilities`](../../capabilities/) `ModelProvider` the same way.
+
+Today's engine for sending the requests is the [AI SDK](https://ai-sdk.dev)'s provider packages (`@ai-sdk/*`), called at the provider-spec level (`doGenerate`). It never uses the `ai` package, its agent loop or Vercel's gateway, so no request goes anywhere but the vendor's own API. The engine sits behind one module, `@kindgi/adapter-model-shared/ai-sdk`, the only entry point whose types are a library's. Swapping it later touches that module and the adapters that hand their models in, nothing else.
+
+`@kindgi/adapter-model-shared/ai-sdk` is for Kindgi's own adapters. It has no compatibility promise across a change of engine: an adapter you write yourself should implement `ModelProvider` from `@kindgi/capabilities`, which stays.
+
+## What every adapter gets
+
+- **Retries are Kindgi's.** One send makes one HTTP attempt. The provider makes up to `attempts` in all (default 3) on a retryable failure: 408, 409, 429, 5xx, or no response.
+  - It waits what the vendor asks (`retry-after-ms`, `retry-after`), or backs off exponentially with jitter.
+  - A vendor asking for more than 60 s ends the call at once, its wait in the message (`… (the vendor asks to wait 120 s)`), rather than retrying early into a limit it named.
+  - An answer the library can't read (a malformed 200, an empty body) is tried once more, not twice: each answer may be billed.
+  - Each attempt is counted (`@kindgi/capabilities/attempts`): a result's `attempts`, or `attemptsOf(error)` for a failed call.
+  - An abort, before the first attempt, in flight or during a wait, rejects with the caller's reason.
+- **Errors are typed.** A failed call throws `ModelProviderError` with a `kind`:
+  - `auth`: 401, 403;
+  - `rate-limited`: 429;
+  - `unavailable`: 408 (the vendor timing out), 409, 424 (Bedrock's model failure), 5xx, and an answer the library can't read;
+  - `context-too-long` and `content-filter`, read from the vendor's words on a 400, 413 or 422 ("maximum context length", "prompt is too long", not any mention of "context");
+  - `invalid-request`, including a request the library refuses before sending it;
+  - `network`: no response at all (`fetch failed`, a connection reset or refused, DNS, a socket timeout). A host refused before any connection (a system-style code that isn't a dropped connection's, such as the runtime's egress refusal `EKINDGIEGRESS`) is `network` too, never retried.
+  - A redirect the request won't follow (an adapter's credential goes to its endpoint only) is `unavailable`, never retried.
+  It also has the HTTP `status`. Its message is the vendor's own words after the status (`401 {"message":"…"}`), as other adapters' failed calls read.
+  - An adapter's own `ModelProviderError` (its sign-in failed, say) ends the call as it is, never retried, even when the library re-wrapped it as a connection failure.
+  - Anything else (a bug, ours or the library's) propagates as it is, not retried and not dressed as the vendor's answer.
+- **A stop the library has no unified reason for** is `error`, except running out of context (Bedrock's `model_context_window_exceeded`), which is `length`.
+- **The reasoning state survives a pause.** A provider's opaque state (reasoning with its signature or encrypted content, each text part with its own text and id, a tool call's thought signature) is kept, in order, in the first tool call's `signature`.
+  - It goes back on the next call to the same provider's same model, so a durable run can stop after a tool call, restart, and resume with no loss.
+  - Another model's state is never sent, nor another provider's for a model of the same name.
+  - When the trail's text no longer matches the answer's (a caller trimmed or redacted it), the trail's text goes back alone, where the first text part was, without the state that was about other words.
+- **Tool names:** `.` → `__` on send and back on receive, since vendors refuse dots. The system prompt names them as sent.
+- **Usage onto Kindgi's counters:** prompt (cache reads and writes included), completion, cache read and write, and reasoning tokens. The adapter's own cost formula prices them, and `rawUsage` is the vendor's usage as sent.
+- **Settings a model refuses are dropped, with a warning:** a temperature on a model registered `sampling: false` gives `sampling-unsupported`, never a 400. Lowest thinking is the engine's portable reasoning level.
+- **`traceparent`** is sent as a header only when the call has one.
+- **For audit:** the served model (`servedModel`) and the vendor's request id (`providerRequestId`).
+
+## Exports
+
+**`@kindgi/adapter-model-shared`, in Kindgi's terms:**
+- **`ModelProviderError`** (`kind`, `status`) and `ModelProviderErrorKind`;
+- `kindOf(failure)` and `modelProviderError(failure, cause)`: a failed response as a typed error;
+- `withRetries(send, policy)`, `backoffMs(headers, attempt)`, `vendorWaitMs(headers)`, `MAX_VENDOR_WAIT_MS`, `RetryPolicy`, `RetryableFailure`: the retry policy, library-free. A failure's `maxAttempts` caps its own attempts below the policy's; its `kind` says what it is when no status can.
+- **`tokenCostUsd(model, usage, options?)`**: a call's cost from the model's registered rates. It covers prompt and completion, cache reads and writes as multiples of the prompt rate, the long-context tier and the data-residency uplift. The arithmetic is the same as the OpenAI-compatible and Anthropic adapters' own: tests in those adapters hold them equal on the bundled presets, since this package never depends on an adapter. What a missing cache multiplier means is the adapter's to say: `cacheReadMultiplier` / `cacheWriteMultiplier`, default 1.
+
+**`@kindgi/adapter-model-shared/ai-sdk`, where an adapter hands its model in:** `createAiSdkModelProvider(options)` returns a `ModelProvider`. Its `options`:
+- `metadata`: the registration's `ProviderMetadata`;
+- `languageModel(name, fetch)`: the engine's model for a model name, sending with the `fetch` it's given (each HTTP attempt is counted through it);
+- `providerOptions?(model)`: provider options on every call (Azure: `{ azure: { store: false } }`);
+- `cost(model, usage)`: the adapter's cost formula;
+- `attempts?`: HTTP attempts in all on a retryable failure (default 3);
+- `beforeAttempt?(signal)`: run before each HTTP attempt, inside the retries, with the call's abort signal. An adapter signs in here (a token, a key, the runtime's identity) when its library would report a failure as a plain error, and throws a `ModelProviderError`. What it returns is that attempt's own: the adapter's code the library calls during the attempt (a credential provider, a fetch wrapper) reads it with `attemptPrepared()`, and calls running at once never see each other's;
+- `explain?(error)`: a sentence after a failed call's message, where the vendor's words don't say what to check (Bedrock's 403). The kind, status and attempts stay as they are.
+
+## Pins
+
+The engine's packages change often (two releases of one of them in a day during the evaluation). Every `@ai-sdk/*` dependency here, and in the adapters built on it, is **pinned exactly** and bumped on purpose, with the live cases re-run per bump. Kindgi keeps its own copy of the AI SDK's source and of the exact package files it pins.

package/dist/ai-sdk/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Today's engine, the AI SDK's provider packages: where an adapter hands its provider in.
+ * The only entry point of this package whose types are a library's.
+ */
+export { type AiSdkModelProviderOptions, attemptPrepared, createAiSdkModelProvider, } from './provider.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/ai-sdk/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ai-sdk/index.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,OAAO,EACL,KAAK,yBAAyB,EAC9B,eAAe,EACf,wBAAwB,GACzB,MAAM,eAAe,CAAC"}

package/dist/ai-sdk/index.js

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright (C) 2026 Kindgi Inc.
+/**
+ * Today's engine, the AI SDK's provider packages: where an adapter hands its provider in.
+ * The only entry point of this package whose types are a library's.
+ */
+export { attemptPrepared, createAiSdkModelProvider, } from './provider.js';
+//# sourceMappingURL=index.js.map

package/dist/ai-sdk/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/ai-sdk/index.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,iCAAiC;AAEjC;;;GAGG;AACH,OAAO,EAEL,eAAe,EACf,wBAAwB,GACzB,MAAM,eAAe,CAAC"}

package/dist/ai-sdk/provider.d.ts

@@ -0,0 +1,36 @@
+import type { LanguageModelV4, SharedV4ProviderOptions } from '@ai-sdk/provider';
+import type { ModelInfo, ModelProvider, ProviderMetadata, UsageCounters } from '@kindgi/capabilities';
+import { ModelProviderError } from '../errors.js';
+export interface AiSdkModelProviderOptions {
+    readonly metadata: ProviderMetadata;
+    /** The provider's model for a name, sending with `fetch` (it counts each HTTP attempt). */
+    readonly languageModel: (name: string, fetch: typeof globalThis.fetch) => LanguageModelV4;
+    /** Provider options on every call (OpenAI: `store: false`). */
+    readonly providerOptions?: (model: ModelInfo) => SharedV4ProviderOptions | undefined;
+    /** Our cost formula for this vendor, from its usage. */
+    readonly cost: (model: ModelInfo, usage: UsageCounters) => number;
+    /** HTTP attempts in all on a retryable failure (408, 409, 429, 5xx, network). Default 3. */
+    readonly attempts?: number;
+    /**
+     * Run before each HTTP attempt, inside the retries, with the call's abort signal: where an
+     * adapter signs in (the runtime's identity, a key) itself, so a failure is typed by the adapter
+     * rather than by its library. What it returns is this attempt's own (`attemptPrepared()`), for
+     * the adapter's code the library calls during the attempt. A `ModelProviderError` thrown here
+     * (or anywhere in the adapter's own code) ends the call as it is, never retried.
+     */
+    readonly beforeAttempt?: (signal: AbortSignal | undefined) => Promise<unknown>;
+    /**
+     * A sentence for a failed call's message, where the vendor's own words don't say what to
+     * check (Bedrock's 403: the IAM policy, or the account's access to the model). Undefined:
+     * the message as it is.
+     */
+    readonly explain?: (error: ModelProviderError) => string | undefined;
+}
+/**
+ * What this attempt's `beforeAttempt` returned, read from code the library calls during the
+ * attempt (a credential provider, a fetch wrapper); undefined outside one. Per attempt, so calls
+ * running at once never see each other's.
+ */
+export declare function attemptPrepared<T>(): T | undefined;
+export declare function createAiSdkModelProvider(options: AiSdkModelProviderOptions): ModelProvider;
+//# sourceMappingURL=provider.d.ts.map

package/dist/ai-sdk/provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/ai-sdk/provider.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EACV,eAAe,EAMf,uBAAuB,EACxB,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAIV,SAAS,EAET,aAAa,EAEb,gBAAgB,EAChB,aAAa,EACd,MAAM,sBAAsB,CAAC;AAI9B,OAAO,EAAE,kBAAkB,EAAsB,MAAM,cAAc,CAAC;AAGtE,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACpC,2FAA2F;IAC3F,QAAQ,CAAC,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,UAAU,CAAC,KAAK,KAAK,eAAe,CAAC;IAC1F,+DAA+D;IAC/D,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,uBAAuB,GAAG,SAAS,CAAC;IACrF,wDAAwD;IACxD,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,aAAa,KAAK,MAAM,CAAC;IAClE,4FAA4F;IAC5F,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,WAAW,GAAG,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/E;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,MAAM,GAAG,SAAS,CAAC;CACtE;AAKD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,CAAC,KAAK,CAAC,GAAG,SAAS,CAElD;AAKD,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,yBAAyB,GAAG,aAAa,CAsI1F"}