@soba-so/react 0.0.27 → 0.0.28

package/dist/useModel.d.ts

@@ -1,4 +1,4 @@
-import type { ModelGroup, ModelOption } from "./types.js";
+import type { ModelChoice, ModelGroup, ModelLayout, ModelOption } from "./types.js";
 export interface UseModelOptions {
     /**
      * CONTROLLED. Pass both, or neither — a `value` without an `onChange` is a
@@ -10,7 +10,8 @@ export interface UseModelOptions {
      */
     value?: string;
     onChange?: (id: string) => void;
-    /** What a first-time visitor gets. `auto` unless you have a reason. */
+    /** What a first-time visitor gets. Left out: the default model starred on
+     *  Providers in the dashboard, else `auto`. */
     defaultValue?: string;
     /**
      * Remember the pick in this browser, per app and per person. Left on: the
@@ -28,6 +29,77 @@ export interface UseModelOptions {
      * somebody here prefers Haiku.
      */
     user?: string;
+    /**
+     * HOW THE APP'S PROVIDERS ARE LAID OUT. `providers` groups them under each
+     * provider's name and mark; `models` is one list, each row marked; `choices`
+     * shows only your own names — the ones set on Providers in the dashboard,
+     * and any in `choices` below. The person's own agents are listed the same
+     * way under all three.
+     *
+     * Left out, it is what the dashboard's Connect page says, so the layout can
+     * change without a deploy. Passing it here wins.
+     */
+    layout?: ModelLayout;
+    /**
+     * YOUR OWN ENTRIES — "Fast", "Smart" — each naming a model you expose on a
+     * provider (or one of the person's agents). Given these and no `layout`,
+     * the layout is `choices`. An entry whose model is not on offer is left out.
+     *
+     * Pass the same list everywhere `useModel` is called — in the menu and where
+     * the run is sent — or a pick of one of these is a name the other call site
+     * has never heard of. Names set on Providers need none of this.
+     *
+     * ```js
+     * useModel({ choices: [
+     *   { id: "fast", label: "Fast", model: "gpt-5-mini", provider: "openai" },
+     *   { id: "smart", label: "Smart", model: "claude-sonnet-5-5" },
+     * ] })
+     * ```
+     */
+    choices?: ModelChoice[];
+}
+/**
+ * ONE OF THE APP'S OWN PROVIDERS, with the models it exposes — the other half
+ * of the menu, for people answered on the app's provider keys rather than, or
+ * as well as, their own agents.
+ */
+export interface ModelProvider {
+    /** The supplier row's id. */
+    id: string;
+    /** What the app's owner called it: `OpenAI`, `Groq (fast)`. */
+    name: string;
+    /** Whose API it is — `openai`, `groq` — for `<ProviderMark provider={…} />`;
+     *  absent for an endpoint nobody recognised. */
+    mark?: string;
+    /** `frontier` or `open-weights`: which of the plan's classes it bills to. */
+    costClass: string;
+    /**
+     * WHY NONE OF IT CAN BE PICKED, or absent when it can. `plan`: the person's
+     * plan does not reach it — draw it as an upgrade, it is the one place a
+     * picker can say one exists. `allowance`: the plan stops at an allowance
+     * they have used; their own agents still answer.
+     */
+    locked?: "plan" | "allowance";
+    /** Every model the app exposes on it, the same objects as in `options`. */
+    options: ModelOption[];
+}
+/**
+ * ONE AGENT THE PERSON HAS CONNECTED, with the models it offers — the shape
+ * for a menu that lists agents first and opens each one onto its models.
+ */
+export interface ModelAgent {
+    /** `claude-code`, `codex`, `ollama`. */
+    id: string;
+    /** `Claude Code`, as the agent names itself. */
+    name: string;
+    /** Its mark, from `modelLogo`. */
+    logo?: string;
+    /**
+     * Its named models, the same objects as in `options`. EMPTY for an agent
+     * that advertises none — Codex — which is connected and answers Automatic,
+     * but has nothing to choose between.
+     */
+    options: ModelOption[];
 }
 export interface ModelView {
     /** Every model this person could be answered by, Automatic first. */
@@ -39,6 +111,23 @@ export interface ModelView {
      *  what was picked is not here. */
     selected: ModelOption;
     select: (id: string) => void;
+    /** Every connected agent, in the panel's own order, each with its models.
+     *  Agents that offer none are included; see `ModelAgent.options`. */
+    agents: ModelAgent[];
+    /** The app's own providers and every model it exposes on them, in the
+     *  gateway's order, locked ones included. Empty for an app with none. */
+    providers: ModelProvider[];
+    /** Every provider's models in one list, for the `models` layout. */
+    models: ModelOption[];
+    /** Your `choices`, resolved — the rows of the `choices` layout. */
+    choices: ModelOption[];
+    /** The layout in force. */
+    layout: ModelLayout;
+    /** Under `models`, whether their own agents' models are in the one list
+     *  too, as the app set it on Connect. */
+    ownInList: boolean;
+    /** Whether a long list gets a search field, as the app set it on Connect. */
+    search: boolean;
     /**
      * SPREAD THIS INTO THE RUN, and spread it rather than reading `model` off it.
      *
@@ -48,10 +137,17 @@ export interface ModelView {
      * is handed to whatever agent the broker finds first. An app that forwards
      * only `model` works until somebody with two agents picks a model from the
      * second one.
+     *
+     * For one of the app's providers it is `{ model, route: { allow: [class] } }`,
+     * which is what keeps `gpt-5` off the person's laptop: pass `route` through to
+     * `soba.run()` as well. It only narrows — the plan still decides.
      */
     run: {
         model: string;
         runtime?: string;
+        route?: {
+            allow: string[];
+        };
     };
     /**
      * WHAT THEY PICKED THAT IS NOT CURRENTLY ON OFFER — the laptop with Opus on
@@ -66,8 +162,9 @@ export interface ModelView {
     /** More than Automatic to choose between. False with nothing connected,
      *  which is when `<ModelPicker />` draws nothing. */
     pickable: boolean;
-    /** The first machines poll is still in flight. The list is Automatic only
-     *  until it lands, so a picker drawn on this is a picker that pops in. */
+    /** The first machines poll, or the first read of the app's providers, is
+     *  still in flight with nothing else to show. The list is Automatic only
+     *  until one lands, so a picker drawn on this is a picker that pops in. */
     loading: boolean;
 }
 /**
@@ -91,3 +188,19 @@ export interface ModelView {
  * rather than configured.
  */
 export declare function useModel(options?: UseModelOptions): ModelView;
+/**
+ * THE AGENT'S OWN MARK, for an app drawing `useModel()` in its own menu — a
+ * data URI, or undefined for Automatic and the sizes, which belong to no one
+ * agent, and for an agent this package has no mark for.
+ *
+ * Full colour and never to be tinted: an app icon recoloured is not that
+ * company's mark any more.
+ *
+ * ```jsx
+ * const logo = modelLogo(option)
+ * {logo && <img src={logo} alt="" width={16} height={16} />}
+ * ```
+ */
+export declare function modelLogo(option: {
+    runtime?: string;
+}): string | undefined;

package/dist/usePlans.d.ts

@@ -1,4 +1,4 @@
-import type { Plan } from "./types.js";
+import type { FeatureItem, Plan } from "./types.js";
 /**
  * THE PRICE LIST AS A DECISION, NOT AS MARKUP.
  *
@@ -86,6 +86,14 @@ export interface PlanOffer {
     /** What follows from it: `Included each month · then $0.02 a run · 14-day
      *  trial`. A consequence of the figure rather than a second fact beside it. */
     allowanceNote: string;
+    /** `Unlimited runs on your own AI`, or `50 runs a month on your own AI`:
+     *  the second allowance, which `allowance` above does not include. Null when
+     *  the plan never runs on their AI or both are unlimited. */
+    ownAllowance: string | null;
+    /** The plan's features as card lines — `Export to PDF`, `5 projects` —
+     *  each with whether the plan has it; a "no" is drawn crossed out. What the
+     *  vendor's app enforces, never Soba. */
+    features: FeatureItem[];
     /** Null `route_allow` is any compute, an empty one is none, and both are
      *  sentences rather than lists. Null here means `compute` below is the list. */
     computeLabel: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soba-so/react",
-  "version": "0.0.27",
+  "version": "0.0.28",
   "description": "Connect the AI your users already pay for, from your own React app.",
   "license": "UNLICENSED",
   "homepage": "https://soba.so/docs/components",