convex-weflayr 0.0.0-stage → 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 [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,3 +1,346 @@
-# Temporary Holding Version
+# convex-weflayr
 
-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.
+A Convex component that sends your app's model calls through the
+[Weflayr](https://weflayr.com) gateway, and saves what each call cost, per
+customer, in your own database.
+
+Weflayr can show cost, run benchmarks and compare models, but only if every
+request says which feature, which call and which customer it belongs to. In a
+Convex app you would build that header by hand on every call, and the cost data
+would stay in Weflayr's dashboard, out of reach of your own code. This component
+adds the header for you and writes each call's usage into tables your app can
+query. So your app can act on cost: show a customer their usage, warn at 80% of
+a plan, stop at 100%.
+
+```mermaid
+flowchart LR
+  A["Convex action<br/>(your AI feature)"] -->|"1. model call + header<br/>feature, call, customer"| G["Weflayr gateway"]
+  G -->|"2. answer + usage"| A
+  A -->|"3. track() saves the call"| C[("convex-weflayr tables<br/>calls, daily totals, budgets")]
+  C -->|"4. cost per customer,<br/>call, feature, day"| Q["Your queries and UI"]
+  C -->|"5. assertWithinBudget()"| A
+```
+
+## What you get
+
+- **Cost per customer.** Every call is saved with its customer, call name,
+  feature, plan, model, tokens, cost, latency and status. Totals by customer,
+  call, feature and day are one query away, and they update live in your UI.
+- **Budgets.** Give a customer a monthly dollar budget. Their next call is
+  stopped before the model runs, and other customers carry on.
+- **Agent runs.** Give every step of a run the same run id. You see what the run
+  cost, step by step, and you can stop it part way.
+- **Cheaper models, with proof.** Each call has a fixed name, so Weflayr can
+  replay your real calls on other models and score the answers.
+- **Calls that survive a gateway failure.** `withFallback()` can run the call
+  direct if the gateway fails. This is optional.
+- **A Vercel AI SDK model** for the gateway, if you use the AI SDK.
+
+## Try the demo
+
+The `example/` folder is a small app that uses every part of the component. It
+makes real calls, so you bring your own Weflayr key: sign up at
+[app.weflayr.com](https://app.weflayr.com), create an API key, and paste it into
+the app. You do not need a key from any model provider.
+
+```sh
+npm install
+npx convex dev   # asks you to log in, then creates a project
+npm run dev
+```
+
+`npx convex dev` writes `CONVEX_URL` to `.env.local`. The Vite app reads
+`VITE_CONVEX_URL`, so add a line with the same address:
+
+```sh
+VITE_CONVEX_URL=https://your-deployment.convex.cloud
+```
+
+Open the app and paste your key. Then:
+
+- **Send calls** sends one call, or runs a four-step agent and shows its cost
+  step by step.
+- **Customers** shows spend per customer, call and day.
+- **Budgets** sets a monthly budget and stops a customer who has used it.
+- **Calls** lists every saved call.
+
+### What it looks like
+
+An agent run. Four steps share one run id, so the cost of the run is the sum of
+its steps:
+
+![An agent run with the cost of each step](docs/images/agent-run.jpg)
+
+A budget. After three calls the customer has used $0.000021 of a $0.00002
+budget, and the fourth call is stopped before the model runs:
+
+![A customer stopped at their monthly budget](docs/images/budget-block.jpg)
+
+Spend by customer and by call, and every saved call:
+
+![Spend by customer](docs/images/customers.jpg)
+
+![The call log](docs/images/calls.jpg)
+
+The same calls in the Weflayr dashboard, grouped by the feature names the
+component sent:
+
+![Cost per feature in Weflayr](docs/images/weflayr-dashboard.jpg)
+
+About your key: it is saved in your browser's localStorage and sent with each
+call so the call can be made. It is never saved in the database. Each browser
+gets a random id, so you only see your own calls. The database holds the
+customer name, call name, model, token counts, cost, latency and status of each
+call, and no prompt or answer text.
+
+## Install
+
+```sh
+npm install convex-weflayr
+```
+
+Add the component to `convex/convex.config.ts`:
+
+```ts
+import { defineApp } from "convex/server";
+import weflayr from "convex-weflayr/convex.config";
+
+const app = defineApp();
+app.use(weflayr);
+
+export default app;
+```
+
+Set your Weflayr key and the customers that may use the gateway:
+
+```sh
+npx convex env set WEFLAYR_API_KEY <your Weflayr key>
+npx convex env set WEFLAYR_CUSTOMERS "*"
+```
+
+`WEFLAYR_CUSTOMERS` is a comma separated list of customer ids, or `*` for all.
+When it is empty, no customer goes through the gateway.
+
+## Use it
+
+Create one `Weflayr` instance. Name your calls and the feature each one belongs
+to. A benchmark in Weflayr is set up per call name, so keep the names stable.
+
+```ts
+import { Weflayr } from "convex-weflayr";
+import { components } from "./_generated/api";
+
+export const weflayr = new Weflayr(components.weflayr, {
+  features: {
+    "draft-reply": "support-replies",
+    "classify-ticket": "support-replies",
+    "summarise-thread": "thread-summaries",
+  },
+  // Dollars per million tokens, from your provider's price list.
+  prices: {
+    "claude-haiku-5-5": { inputPerMillion: 0.1, outputPerMillion: 0.5 },
+  },
+});
+```
+
+Call a model through the gateway with the AI SDK:
+
+```ts
+import { generateText } from "ai";
+import { weflayrModel } from "convex-weflayr/ai-sdk";
+
+const meta = { customer: workspace.name, plan: workspace.plan, call: "classify-ticket" };
+
+const result = await weflayr.track(
+  ctx,
+  { ...meta, model: "claude-haiku-5-5" },
+  () =>
+    generateText({
+      model: weflayrModel(weflayr, "claude-haiku-5-5"),
+      headers: weflayr.headers(meta),
+      prompt,
+    }),
+);
+```
+
+`ctx` is any action context. `track` times the call and saves it. If the call
+fails, it saves the failure and throws the error again. Without the AI SDK,
+`weflayr.connection()` returns the base URL and key for any OpenAI compatible
+client.
+
+### Streaming
+
+`track` reads token usage from the result of `generateText`. A `streamText`
+result only has its usage when the stream ends, so record the call yourself in
+`onFinish`:
+
+```ts
+const started = Date.now();
+const result = streamText({
+  model: weflayrModel(weflayr, "claude-haiku-5-5"),
+  headers: weflayr.headers(meta),
+  prompt,
+  onFinish: async ({ usage }) => {
+    await weflayr.record(ctx, {
+      ...meta,
+      model: "claude-haiku-5-5",
+      inputTokens: usage.inputTokens ?? 0,
+      outputTokens: usage.outputTokens ?? 0,
+      latencyMs: Date.now() - started,
+      status: "ok",
+    });
+  },
+});
+```
+
+### Keep a call alive if the gateway fails
+
+`withFallback` tries the gateway first. If it fails, it runs the same call
+direct, so your customer still gets an answer. You supply the direct call, with
+your own provider key.
+
+```ts
+const result = await weflayr.withFallback(
+  ctx,
+  { ...meta, model },
+  {
+    gateway: () => generateText({ model: weflayrModel(weflayr, model), headers: weflayr.headers(meta), prompt }),
+    direct: () => generateText({ model: yourProvider(model), prompt }),
+  },
+);
+```
+
+The failed attempt is saved as `error` and the direct run as `fallback`. A
+customer who is not on the allow list runs the direct call, and that call is not
+saved.
+
+### Group the calls of one job
+
+Pass the same `runId` (`newRunId()` makes one) to every call of one job. It is
+saved with each call and sent to Weflayr as the `run_id` tag.
+`weflayr.runCost(ctx, runId)` returns the cost of the whole job and of each
+step.
+
+Weflayr also runs an MCP server at `https://mcp.weflayr.com/`, so an agent can
+read cost and margin as a tool.
+
+### Budgets
+
+```ts
+await weflayr.setBudget(ctx, "acme", 25); // 25 dollars a month, UTC calendar month
+await weflayr.assertWithinBudget(ctx, "acme"); // throws WeflayrBudgetError once spent
+const status = await weflayr.budget(ctx, "acme"); // { limitUsd, spentUsd, remainingUsd, allowed }
+```
+
+A customer without a budget always passes. Spend is the sum of saved cost for
+the month. A call already running when the limit is reached can still finish.
+
+### Read the numbers
+
+```ts
+const range = lastDays(30);
+await weflayr.usageByCustomer(ctx, range);
+await weflayr.usageByCall(ctx, range, "acme");
+await weflayr.usageByFeature(ctx, range);
+await weflayr.usageByDay(ctx, range, "acme");
+await weflayr.recentCalls(ctx, { customer: "acme", limit: 20 });
+```
+
+Each row has `calls`, `errors`, `fallbacks`, `inputTokens`, `outputTokens`,
+`costUsd` and `averageLatencyMs`. Inside a Convex query, call
+`ctx.runQuery(components.weflayr.lib.usageByCustomer, range)` and the result
+updates live in your UI.
+
+## How cost is worked out
+
+The gateway does not send a price back with each response, so the component
+uses, in order:
+
+1. A cost you pass: `costUsd` in the call details, or from `extract` in `track`.
+   Saved as `reported`.
+2. An estimate from your `prices` table. Saved as `estimated`.
+3. Zero, saved as `none`, when neither is available.
+
+Weflayr's dashboard is the source of truth for what you were billed. Use the
+saved cost to compare customers and enforce budgets, and fill `prices` from your
+provider's price list.
+
+## What is saved
+
+| Table     | One row per                | Kept                                       |
+| --------- | -------------------------- | ------------------------------------------ |
+| `calls`   | model call                 | until you run `weflayr.purge(ctx, before)` |
+| `daily`   | customer, call and UTC day | always                                     |
+| `budgets` | customer                   | until cleared                              |
+
+Queries read the `daily` rows, so they stay fast as `calls` grows. Days and
+months are UTC.
+
+## Notes
+
+- Saving a call never fails the call. If the write fails, the component logs a
+  warning and returns your answer.
+- The `plan`, `runId` and any `tags` you pass are sent to Weflayr as tags on the
+  request.
+- Customer names go to Weflayr as written. Use an id or a name you are happy to
+  see in its dashboard.
+
+## Limitations
+
+- Cost is an estimate from your `prices` table unless you pass the cost of a
+  call.
+- A budget compares saved cost with the limit before a call starts, so a call
+  already running can push a customer past it.
+- A customer who is not on the allow list runs the direct call, and that call is
+  not saved.
+- `usageByCustomer` and the other reports read one `daily` row per customer,
+  call and day in the range. With many customers, keep the range short or pass a
+  customer, so a query stays inside Convex's read limits.
+- `track` cannot read usage from a stream. Record streamed calls in `onFinish`,
+  as shown under Streaming.
+
+## Troubleshooting
+
+**No calls are saved.** The customer is not allowed through the gateway. Set
+`WEFLAYR_CUSTOMERS` to the customer id, or `*`, and check that
+`WEFLAYR_API_KEY` is set in the same Convex deployment.
+
+**Cost shows $0.** The model is missing from `prices`. Add it, in dollars per
+million tokens.
+
+**A budget never stops anyone.** A budget compares saved cost, so it needs
+`prices`, or a `costUsd` on each call.
+
+**The gateway returns 402.** Your Weflayr balance is empty. Add credit in the
+Weflayr dashboard.
+
+## Test
+
+```ts
+import { convexTest } from "convex-test";
+import { register } from "convex-weflayr/test";
+
+const t = convexTest(schema, modules);
+register(t); // or register(t, "myName") if you named the component yourself
+```
+
+## Contributing
+
+```sh
+npm install
+npm test
+npm run lint
+npm run typecheck
+npm run build
+```
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md). To publish, see
+[PUBLISHING.md](./PUBLISHING.md).
+
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md).
+
+## License
+
+Apache-2.0

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

@@ -0,0 +1,4 @@
+import type { Weflayr } from "../client/index.js";
+/** A Vercel AI SDK model that sends its request through the Weflayr gateway. Pass `weflayr.headers(meta)` as the request headers. */
+export declare function weflayrModel(weflayr: Weflayr, modelId: string): import("@ai-sdk/provider").LanguageModelV4;
+//# 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":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAElD,qIAAqI;AACrI,wBAAgB,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,8CAG7D"}

package/dist/ai-sdk/index.js

@@ -0,0 +1,7 @@
+import { createOpenAI } from "@ai-sdk/openai";
+/** A Vercel AI SDK model that sends its request through the Weflayr gateway. Pass `weflayr.headers(meta)` as the request headers. */
+export function weflayrModel(weflayr, modelId) {
+    const { baseURL, apiKey } = weflayr.connection();
+    return createOpenAI({ baseURL, apiKey, name: "weflayr" }).chat(modelId);
+}
+//# 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,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,qIAAqI;AACrI,MAAM,UAAU,YAAY,CAAC,OAAgB,EAAE,OAAe;IAC5D,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IACjD,OAAO,YAAY,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AAC1E,CAAC"}