@theokit/sdk-budget 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog — @theokit/sdk-budget
+
+## [Unreleased]
+
+### Added (Phase 2 physical Stage 1 — iter 19, 2026-06-08)
+- Physically-extracted Budget internals into `sdk-budget/src/internal/`:
+  - `calendar-window` — UTC-aligned 1h/1d/1w/30d/365d window helpers.
+  - `enforcement` — `preflightCheck` + `chargeAndCheckThresholds` with
+    onThreshold + onExceed dispatch.
+  - `ledger` — `charge` + `spentIn` ledger ops (consumes the new public
+    `withCwdMutex` utility from `@theokit/sdk` per ADR-008).
+  - `normalize-usage` — `inferApiMode` + `normalizeUsage` (Anthropic /
+    OpenAI Chat / OpenAI Responses shape detection).
+  - `registry` — `createBudget` / `getBudget` / `listBudgets` /
+    `deleteBudget` / `snapshotAll` / `defaultMode` / `getBudgetOptionsRaw`.
+- Public exports added to the main barrel:
+  `createBudget, defaultMode, deleteBudget, getBudget, getBudgetOptionsRaw,
+  listBudgets, snapshotAll, chargeAndCheckThresholds, preflightCheck,
+  inferApiMode, normalizeUsage, startOfDayUtc, startOfWeekUtc,
+  windowStartMs, charge, spentIn`.
+
+### Changed (iter 19)
+- Package now ships ~568 LOC of canonical Budget logic (was 0 LOC pre-Stage-1).
+- Bundle size: 2.51 KB → 13.47 KB ESM (the extracted internals).
+- `peerDependency`: `@theokit/sdk >= 1.7.0` confirmed (ADR-008's
+  public `withCwdMutex` is required).
+
+## [0.1.0] — 2026-06-08
+
+### Added
+- Initial release. Consumes the `BudgetTracker` port from `@theokit/sdk@>=1.7.0`
+  (SDK 2.0 Phase 2 / T2.X).
+- `createUsdBudgetTracker({ maxTokens?, maxUsd?, pricing? })` — USD-cost-
+  aware tracker extending sdk-core's counter-based reference.
+  `check()` returns `cost_limit` reason when `maxUsd` is exceeded.
+- `BUILTIN_PRICING` (read-only) — built-in pricing table for 9 popular
+  models across OpenAI / Anthropic / Google (verified 2026-06).
+- `computeUsdCost(pricing, model, type, tokens)` — pure helper.
+
+### Notes
+- Live-rate fetching / ledger persistence / per-user aggregation deferred
+  to future versions. This release ships the package foundation + a
+  working USD impl so the SDK 2.0 cohort can publish (Phase 7).
+- `peerDependency`: `@theokit/sdk >= 1.7.0` (where the port shipped).

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 usetheo.dev
+
+   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,109 @@
+# @theokit/sdk-budget
+
+USD-cost-aware `BudgetTracker` impls for [`@theokit/sdk`](https://www.npmjs.com/package/@theokit/sdk).
+Consumes the kernel-facing `BudgetTracker` port (SDK 2.0 Phase 2 / T2.1 —
+ADR D1, interface inversion).
+
+```ts
+import { Agent } from "@theokit/sdk";
+import { createUsdBudgetTracker } from "@theokit/sdk-budget";
+
+const agent = await Agent.create({
+  agentId: "support-bot",
+  model: { id: "anthropic/claude-3-5-haiku-latest" },
+  budgetTracker: createUsdBudgetTracker({ maxUsd: 5 }), // hard $5 cap
+  // ...other options
+});
+
+// During the run, check spend from outside:
+const spent = (agent.budgetTracker as ReturnType<typeof createUsdBudgetTracker>).getTotalUsd();
+console.log(`Spent so far: $${spent.toFixed(4)}`);
+```
+
+## What ships today
+
+### USD-cost tracker (BudgetTracker port impl)
+
+- `createUsdBudgetTracker({ maxTokens?, maxUsd?, pricing? })` — extends
+  the counter-based reference from sdk-core with per-model USD cost
+  computation. Built-in pricing table covers the most-used
+  OpenAI / Anthropic / Google models; supply `pricing` to override or
+  add custom models.
+- `BUILTIN_PRICING` (read-only) — the static table powering the built-in
+  rates. Export so consumers can audit current values.
+- `computeUsdCost(pricing, model, type, tokens)` — pure helper for
+  ad-hoc cost calc outside the tracker.
+
+### Budget facade (Phase 2 physical Stage 1 — iter 19)
+
+The Budget facade primitives (registry, ledger, enforcement,
+normalize-usage, calendar-window) were physically extracted from sdk-core
+to this package:
+
+```ts
+import {
+  // Registry — manage named Budget instances
+  createBudget, getBudget, listBudgets, deleteBudget, snapshotAll,
+  defaultMode, getBudgetOptionsRaw,
+  // Enforcement — preflight + threshold callbacks
+  preflightCheck, chargeAndCheckThresholds,
+  // Usage normalization — Anthropic / OpenAI Chat / OpenAI Responses
+  inferApiMode, normalizeUsage,
+  // Calendar window helpers — UTC-aligned 1h/1d/1w/30d/365d
+  startOfDayUtc, startOfWeekUtc, windowStartMs,
+  // Low-level ledger ops
+  charge, spentIn,
+} from "@theokit/sdk-budget";
+```
+
+sdk-core retains its own copies for v1.x sync API back-compat. Consumers
+SHOULD migrate to importing from `@theokit/sdk-budget` directly before
+sdk-core v3.0 (which will drop the duplicated source).
+
+## When to use vs `createCounterBudgetTracker` (sdk-core)
+
+| Need | Use |
+|------|-----|
+| Cap iterations only | `createCounterBudgetTracker` from `@theokit/sdk` |
+| Cap raw token count | either (counter is lighter) |
+| Cap USD spend | **`createUsdBudgetTracker` from `@theokit/sdk-budget`** |
+| Need custom pricing logic | extend the contract directly — `BudgetTracker` is the port |
+
+## Architecture
+
+This package is a **port consumer**, not a kernel mod. The contract
+lives in `@theokit/sdk/internal/runtime/budget-tracker.ts` and is
+exposed to consumers via:
+
+```ts
+import type {
+  BudgetTracker,
+  BudgetUsageEvent,
+  BudgetCheck,
+  BudgetTotal,
+} from "@theokit/sdk";
+```
+
+The agent loop calls `tracker.track(...)` after each LLM completion and
+`tracker.check()` before each iteration. Your impl fulfills the
+contract; sdk-core never imports this package directly — that's the
+seam that makes the split possible.
+
+## Cross-package coupling
+
+sdk-budget's `ledger` consumes `withCwdMutex` from sdk-core via the
+main `@theokit/sdk` barrel (per ADR-008). The mutex's process-level
+Map is shared across all consumers via Node ESM's module-cache
+guarantee — `internal/budget/ledger.ts` in this package serializes
+writes against the SAME registry that sdk-core's `internal/memory`
+subsystem uses. No double-mutex hazard.
+
+## Roadmap
+
+- v0.2: Pluggable pricing source (fetch live rates).
+- v0.3: Ledger persistence (Postgres / SQLite adapters).
+- v0.4: Per-user / per-tenant budget aggregation.
+
+## License
+
+Apache-2.0 © useTheo