dsh-gateway-provider 1.0.11 → 1.1.0

package/README.md

@@ -84,9 +84,11 @@ Everything lives in **Settings → Gateway Models**:
 
 ## Configuration reference
 
-Optional — everything below has a working default. Config lives in the
-`llm-newapi:` section of `~/.dsh/settings.yaml` (the settings page edits
-the same keys). The frequently used ones:
+Optional — everything below has a working default. With dsh ≥ 0.2 config
+lives in the `llm-newapi` entry of the profile
+(`~/.dsh/profiles/<name>/cordis.patch.yml`; the settings page edits the same
+data). A pre-0.2 `~/.dsh/settings.yaml` section is imported automatically on
+the first start where the plugin loads. The frequently used ones:
 
 | Key | Default | Meaning |
 | --- | --- | --- |

package/docs/README.zh.md

@@ -52,7 +52,7 @@ dsh --profile web
 
 ## 配置参考
 
-全部可选 —— 下表每项都有可用默认值。配置写在 `~/.dsh/settings.yaml` 的 `llm-newapi:` 段（设置页改的就是同一批键）。常用项：
+全部可选 —— 下表每项都有可用默认值。dsh ≥ 0.2 配置存在 profile 的 `llm-newapi` entry（`~/.dsh/profiles/<name>/cordis.patch.yml`，设置页改的就是同一份数据）；旧版 `~/.dsh/settings.yaml` 的 `llm-newapi:` 段会在插件可加载后的首次启动自动迁入。常用项：
 
 | 键 | 默认值 | 含义 |
 | --- | --- | --- |

package/index.js

@@ -39,7 +39,11 @@ import { DEFAULT_ENDPOINT_PRIORITY, deriveProtocolURLs } from "./lib/protocols.j
 export const name = "llm-newapi";
 export const inject = ["llm"];
 
-/** User-settings namespace whose section overrides this entry. */
+/**
+ * Settings namespace this plugin serves. dsh 0.2 keys settings (and model
+ * discovery) by the loader entry id; cordis.patch.yml declares the entry as
+ * `llm-newapi`, so the ids coincide and this remains the fallback name.
+ */
 const NS = "llm-newapi";
 /** The legacy single provider route (kept for backwards compatibility). */
 export const PROVIDER = "newapi";
@@ -60,7 +64,8 @@ const DEFAULT_STREAM_IDLE_TIMEOUT_MS = 600_000;
 const DEFAULT_CATALOG_TTL_MS = 30 * 60 * 1000;
 
 /**
- * String field tolerant of hand-edited YAML scalars. `settings.yaml` is a
+ * String field tolerant of hand-edited YAML scalars. The profile patch
+ * (`cordis.patch.yml`, and pre-0.2 `settings.yaml` imports) is a
  * user-editable document parsed with YAML 1.2 core semantics: an unquoted
  * `true` / `false` / `True` / `FALSE` round-trips as a boolean and an
  * unquoted digit run as a number, long before the value reaches a strict
@@ -183,7 +188,7 @@ export const Config = z.object({
   // ---- Additional gateways ----
   /** Additional gateways; each becomes a `gateway:<id>` provider route. */
   gateways: z.array(GatewaySchema).default([]),
-});
+}).volatile();
 
 /**
  * Normalize one gateway entry into the connection facts the adapter needs.
@@ -306,7 +311,12 @@ export function resolveGateways(config, environment) {
 }
 
 export function apply(ctx, config) {
-  let current = () => config;
+  /** Settings namespace this entry serves: the loader entry id, else the legacy name. */
+  const settingsNs = ctx.fiber.entry?.options.id ?? NS;
+  // dsh 0.2 hands apply() a volatile config reference (a frozen { get } whose
+  // snapshot updates after every settings write); plain objects from older
+  // harnesses pass through unchanged.
+  const current = () => (typeof config?.get === "function" ? config.get() : config);
   let lastRaw;
   let resolved = null;
   /** Resolve (and cache) the gateway list from the current config snapshot. */
@@ -376,7 +386,7 @@ export function apply(ctx, config) {
     const entries = gateways.map((g, i) => ({
       provider: g.provider,
       displayName: g.label,
-      settingsNs: NS,
+      settingsNs,
       settingsPath: i === 0 ? [] : ["gateways", String(g.id)],
       declared: i > 0,
     }));
@@ -390,7 +400,7 @@ export function apply(ctx, config) {
   ensureRegistration();
 
   /** Expose model discovery so the web UI can fetch a gateway's model list. */
-  ctx.llm.registerModelDiscovery(NS, async (request) => {
+  ctx.llm.registerModelDiscovery(settingsNs, async (request) => {
     const env = launchEnvironmentOf(ctx);
     const gateways = resolve();
     const gw = request.provider !== undefined ? gateways.find((g) => g.provider === request.provider) : gateways[0];
@@ -412,12 +422,18 @@ export function apply(ctx, config) {
     }
   });
 
-  ctx.inject(["settings"], (settingsCtx) => {
-    settingsCtx.settings.installSection(ctx, NS, Config, config, {
-      setSource: (source) => {
-        current = source;
-      },
-      onChange: ensureRegistration,
-    });
+  // dsh 0.2 settings contract: the volatile-marked Config schema is picked
+  // up by the settings service automatically (installSection is gone). Settings
+  // writes land in the profile and the loader emits loader/volatile-update;
+  // re-resolve and re-register then. resolve() holds the last good snapshot
+  // when an update arrives invalid, so the catch only guards registration
+  // races (e.g. a provider-route conflict on a mid-flight update).
+  ctx.on("loader/volatile-update", () => {
+    try {
+      ensureRegistration();
+    } catch (error) {
+      ctx.logger.error("llm-newapi: keeping the last good configuration after a settings update");
+      ctx.logger.error(error);
+    }
   });
 }

package/lib/catalog.js

@@ -121,15 +121,31 @@ async function fetchManagementModels(baseURL, apiKey, userId, signal) {
   return entries;
 }
 
+/**
+ * Strip trailing slashes and a trailing version segment (`/v1`, `/v2`, …)
+ * from a gateway base URL. The catalog always appends its own full paths
+ * (`/v1/models`, `/api/user/models`), so a user-supplied base that already
+ * carries `/v1` (the OpenAI-SDK convention, which the chat path also accepts)
+ * must not leak through as `/v1/v1/models`. Mirrors the derivation the custom
+ * (protocol-URL) template performs in `protocols.js`.
+ */
+function stripVersion(baseURL) {
+  return String(baseURL ?? "").replace(/\/+$/, "").replace(/\/v\d+$/, "");
+}
+
 /**
  * The base URL model discovery fetches `/v1/models` against. Gateways with
  * protocol URL fields (custom template) derive it from their OpenAI-style
  * URL; `null` means discovery is impossible (e.g. only an Anthropic address
  * is configured) and the catalog is exactly the user-declared models.
+ * The returned base is version-stripped: the catalog suffixes below always
+ * append the version segment themselves.
  */
 function discoveryBase(connection) {
   const base = connection.catalogBase !== undefined ? connection.catalogBase : connection.baseURL;
-  return typeof base === "string" && base.length > 0 ? base : null;
+  if (typeof base !== "string" || base.length === 0) return null;
+  const stripped = stripVersion(base);
+  return stripped.length > 0 ? stripped : null;
 }
 
 /**

package/lib/client.js

@@ -77,7 +77,7 @@ window.__ModuleLoader__.load({
 			responsesURLPlaceholder: "https://gw.example.com/v1/responses",
 			anthropicURLPlaceholder: "https://gw.example.com/v1/messages",
 			catalogHint: "auto：优先 /v1/models，鉴权失败时回退管理 API",
-			baseURLClearHint: "留空则回退到环境变量 NEWAPI_BASE_URL 或官方云端地址",
+			baseURLClearHint: "留空则回退到环境变量 NEWAPI_BASE_URL 或官方云端地址；结尾带不带 /v1 均可",
 			labelClearHint: "留空则回退为 gateway:<id>",
 			keyEnvHint: "留空则继承默认网关的 Key（NEWAPI_API_KEY）",
 			keyKeepHint: "留空保持不变；填写则覆盖存储的 Key",
@@ -137,7 +137,7 @@ window.__ModuleLoader__.load({
 			responsesURLPlaceholder: "https://gw.example.com/v1/responses",
 			anthropicURLPlaceholder: "https://gw.example.com/v1/messages",
 			catalogHint: "auto: prefer /v1/models, fall back to the management API on auth failure",
-			baseURLClearHint: "Empty falls back to NEWAPI_BASE_URL or the public cloud default",
+			baseURLClearHint: "Empty falls back to NEWAPI_BASE_URL or the public cloud default; a trailing /v1 is optional",
 			labelClearHint: "Empty falls back to gateway:<id>",
 			keyEnvHint: "Empty inherits the default gateway's key (NEWAPI_API_KEY)",
 			keyKeepHint: "Empty keeps the stored key; type to overwrite",
@@ -820,8 +820,8 @@ window.__ModuleLoader__.load({
 			var snapRef = React.useRef(null);
 
 			var load = React.useCallback(function () {
-				api.settings.describe({}).then(function (res) {
-					var nsList = res && res.result && res.result.ok ? (res.result.value.namespaces || []) : [];
+				api.settings.describe().then(function (res) {
+					var nsList = res && res.ok ? (res.value.namespaces || []) : [];
 					var desc = nsList.find(function (n) { return n.ns === NS; });
 					var snap = desc ? desc.value || {} : {};
 					setSnapshot(snap);
@@ -831,8 +831,8 @@ window.__ModuleLoader__.load({
 					(snap.gateways || []).forEach(function (gw) {
 						if (gw.apiKeyEnv && refs.indexOf(gw.apiKeyEnv) === -1) refs.push(gw.apiKeyEnv);
 					});
-					return api.credentials.describe({ refs: refs }).then(function (cres) {
-						var creds = (cres && cres.result && cres.result.ok) ? (cres.result.value.credentials || {}) : {};
+					return api.credentials.describe(refs).then(function (cres) {
+						var creds = (cres && cres.ok) ? (cres.value || {}) : {};
 						setCredentials(creds);
 					}).catch(function () { setCredentials({}); });
 				}).catch(function () { setSnapshot({}); });
@@ -849,9 +849,9 @@ window.__ModuleLoader__.load({
 			/** Mutate one path op into the settings namespace; always reload
 			  * afterwards (success resyncs the ref, failure rolls it back). */
 			var mutate = function (ops) {
-				return api.settings.mutate({ ns: NS, ops: ops }).then(function (res) {
-					if (!(res && res.result && res.result.ok)) {
-						console.warn("llm-newapi: settings write failed", res && res.result && res.result.error);
+				return api.settings.mutate(NS, ops, undefined).then(function (res) {
+					if (!(res && res.ok)) {
+						console.warn("llm-newapi: settings write failed", res && res.error);
 						load();
 						return false;
 					}
@@ -897,13 +897,13 @@ window.__ModuleLoader__.load({
 			  * An empty baseURL (URL-addressed custom gateway) is sent as
 			  * absent so the host uses its configured discovery base. */
 			var discover = function (gwIdx, baseURL, provider) {
-				return api.llm.discoverModels({ settingsNs: NS, provider: provider, baseURL: baseURL || undefined, apiKey: undefined }).then(function (res) {
-					if (!(res && res.result && res.result.ok)) {
-						var raw = res && res.result && res.result.error;
-						var msg = typeof raw === "string" ? raw : (raw && raw.message) || "";
+				return api.llm.discoverModels(NS, { provider: provider, baseURL: baseURL || undefined }).then(function (res) {
+					if (!(res && res.ok)) {
+						var raw = res && res.error;
+						var msg = (raw && raw.message) || "";
 						throw new Error(msg || T.testFail);
 					}
-					return (res.result.value.models || []);
+					return (res.value || []);
 				});
 			};
 
@@ -993,8 +993,8 @@ window.__ModuleLoader__.load({
 							? { op: "set", path: [k], value: changes[k] }
 							: { op: "unset", path: [k] });
 					});
-					if (ops.length > 0) writes.push(api.settings.mutate({ ns: NS, ops: ops }));
-					if (changes.apiKey !== undefined) writes.push(api.credentials.set({ ref: defaultEnv, value: changes.apiKey }));
+					if (ops.length > 0) writes.push(api.settings.mutate(NS, ops, undefined));
+					if (changes.apiKey !== undefined) writes.push(api.credentials.set(defaultEnv, changes.apiKey));
 					// Optimistically sync the ref; load() reconciles after settle.
 					var nextSnap = Object.assign({}, snap);
 					if (changes.baseURL !== undefined) { if (changes.baseURL.length > 0) nextSnap.baseURL = changes.baseURL; else delete nextSnap.baseURL; }
@@ -1033,16 +1033,16 @@ window.__ModuleLoader__.load({
 					if (touched) {
 						var nextGateways = gws.slice();
 						nextGateways[gwIdx] = updated;
-						writes.push(api.settings.mutate({ ns: NS, ops: [{ op: "set", path: ["gateways"], value: nextGateways }] }));
+						writes.push(api.settings.mutate(NS, [{ op: "set", path: ["gateways"], value: nextGateways }], undefined));
 						syncGateways(nextGateways);
 					}
 					if (changes.apiKey !== undefined) {
 						var keyRef = changes.apiKeyEnv || gw.apiKeyEnv || defaultEnv;
-						writes.push(api.credentials.set({ ref: keyRef, value: changes.apiKey }));
+						writes.push(api.credentials.set(keyRef, changes.apiKey));
 					}
 				}
 				return Promise.all(writes).then(function (results) {
-					var ok = results.every(function (r) { return r && r.result && r.result.ok; });
+					var ok = results.every(function (r) { return r === undefined || r === null || (r && r.ok) !== false; });
 					load(); // resync the ref with the persisted truth (success or not)
 					return { ok: ok, label: ok ? T.configSaved : T.configSaveFail };
 				}).catch(function () {
@@ -1068,14 +1068,14 @@ window.__ModuleLoader__.load({
 				var nextGateways = gws.concat([entry]);
 				syncGateways(nextGateways);
 				var writes = [
-					api.settings.mutate({ ns: NS, ops: [{ op: "set", path: ["gateways"], value: nextGateways }] }),
+					api.settings.mutate(NS, [{ op: "set", path: ["gateways"], value: nextGateways }], undefined),
 				];
 				if (spec.apiKey !== undefined && spec.apiKey.length > 0) {
 					var keyEnv = (snapRef.current && snapRef.current.apiKeyEnv) || "NEWAPI_API_KEY";
-					writes.push(api.credentials.set({ ref: spec.apiKeyEnv || keyEnv, value: spec.apiKey }));
+					writes.push(api.credentials.set(spec.apiKeyEnv || keyEnv, spec.apiKey));
 				}
 				return Promise.all(writes).then(function (results) {
-					var ok = results.every(function (r) { return r && r.result && r.result.ok; });
+					var ok = results.every(function (r) { return r === undefined || r === null || (r && r.ok) !== false; });
 					load();
 					return { ok: ok, label: ok ? T.configSaved : T.configSaveFail };
 				}).catch(function () {
@@ -1136,7 +1136,7 @@ window.__ModuleLoader__.load({
 			);
 		}
 
-		var inject = ["slots", "connection"];
+		var inject = ["slots", "remote", "remote.settings", "remote.credentials", "remote.llm"];
 
 		function apply(ctx) {
 			var slots = ctx.get("slots");
@@ -1147,7 +1147,15 @@ window.__ModuleLoader__.load({
 					id: "newapi-gateways",
 					order: 20,
 					label: function () { return T.nav; },
-					inject: function () { return { api: ctx.get("connection").api }; },
+					inject: function () {
+						// Typed Remote namespaces (dsh ≥ 0.1.2-rc.1): the old
+						// `ctx.get("connection").api` RPC facade was removed.
+						return { api: {
+							settings: ctx.get("remote.settings"),
+							credentials: ctx.get("remote.credentials"),
+							llm: ctx.get("remote.llm"),
+						} };
+					},
 				}, function (props) {
 					return React.createElement(GatewayModelsSection, { api: props.api });
 				});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-gateway-provider",
-  "version": "1.0.11",
+  "version": "1.1.0",
   "description": "Generic LLM gateway model provider plugin for DeepSeek Harness: mounts newapi / LiteLLM / Higress / any OpenAI-compatible gateway as provider routes, auto-discovers the model list, enriches every model with models.dev parameters, and dispatches each model over its native wire protocol (OpenAI / Anthropic / Gemini) via the pi-ai SDK",
   "repository": {
     "type": "git",
@@ -29,6 +29,7 @@
     "smoke": "node test/smoke.mjs",
     "test:session": "node test/session-affinity.mjs",
     "test:client": "node test/client-render.mjs",
+    "test:client-api": "node test/client-api.mjs",
     "test:urls": "node test/protocol-urls.mjs",
     "test:schema": "node test/schema-coercion.mjs",
     "test:errors": "node test/error-codes.mjs"
@@ -53,8 +54,10 @@
   "dsh": {
     "client": {
       "inject": [
-        "@deepseek-ai/dsh-client-runtime",
-        "@deepseek-ai/dsh-client-web-react"
+        "@deepseek-ai/dsh-client-connection",
+        "@deepseek-ai/dsh-api-gateway",
+        "@deepseek-ai/dsh-api-remotes",
+        "@deepseek-ai/dsh-client-ui-settings"
       ],
       "platform": "web"
     },
@@ -67,10 +70,10 @@
   },
   "peerDependencies": {
     "@deepseek-ai/cordis": "^4.0.2",
-    "@deepseek-ai/dsh-credentials": "^0.1.2-rc.1",
-    "@deepseek-ai/dsh-launch-environment": "^0.1.2-rc.1",
-    "@deepseek-ai/dsh-llm": "^0.1.2-rc.1",
-    "@deepseek-ai/dsh-timeout": "^0.1.2-rc.1",
+    "@deepseek-ai/dsh-credentials": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-launch-environment": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-llm": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-timeout": "0.2.0-rc.2",
     "@deepseek-ai/schemastery": "^3.18.1"
   }
 }