ns-omp-provider 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 0.3.0
+
+- **Breaking: `kiro` is now opt-in.** By default only `devin` and `grok` (+ `grok-sdk`)
+  are registered, so this package no longer shadows the dedicated
+  [`ns-omp-provider-kiro`](https://www.npmjs.com/package/ns-omp-provider-kiro) plugin
+  (the recommended Kiro path in OMP). Opt in with `NS_OMP_PROVIDER_ENABLE=kiro` or by
+  listing it in `NS_OMP_PROVIDERS` (e.g. `NS_OMP_PROVIDERS=devin,grok,kiro`).
+  `NS_OMP_PROVIDER_DISABLE` still works and is applied last; the old
+  `NS_OMP_PROVIDER_DISABLE=kiro` workaround is no longer needed.
+- Bundles `@ngosangns/ns-pi-provider@0.2.1`: Kiro now honours `metadataEvent` stop
+  reasons — `MAX_TOKENS` → `length` (OMP skips truncated tool calls instead of running
+  them with partial arguments), `CONTENT_FILTERED` / `MODEL_CONTEXT_WINDOW_EXCEEDED` /
+  `PAUSE_TURN` and mid-stream exception frames end as errors, and reported token usage
+  is read. Only relevant when `kiro` is opted in.
+
 ## 0.2.0
 
 Bundles `@ngosangns/ns-pi-provider@0.2.0` (was 0.1.7).

package/README.md

@@ -10,7 +10,7 @@ compat layer.
 
 | Provider | Auth | Notes |
 |----------|------|-------|
-| `kiro` | OAuth (`/login kiro`) + `KIRO_API_KEY` / SSO cache | Overlaps with [`ns-omp-provider-kiro`](https://www.npmjs.com/package/ns-omp-provider-kiro) — see below |
+| `kiro` (**opt-in**) | OAuth (`/login kiro`) + `KIRO_API_KEY` / SSO cache | Off by default — use [`ns-omp-provider-kiro`](https://www.npmjs.com/package/ns-omp-provider-kiro); see below |
 | `devin` | OAuth (`/login devin`) + `credentials.toml` / env | Swe-2 catalog when authenticated |
 | `grok` (+ `grok-sdk` alias) | Local `grok` CLI / `~/.grok` / `XAI_API_KEY` | Commands: `/grok status \| models \| refresh` |
 
@@ -36,17 +36,24 @@ omp -e ./dist/index.js ...
 Then `/login kiro` or `/login devin` as needed. Grok uses the local `grok`
 CLI / `~/.grok` auth (or `XAI_API_KEY`).
 
-### Avoiding a duplicate `kiro` provider
+### Choosing providers (`kiro` is opt-in)
 
-If you already use [`ns-omp-provider-kiro`](https://www.npmjs.com/package/ns-omp-provider-kiro),
-disable this package's kiro registration:
+By default this package registers **`devin`** and **`grok`** (+ `grok-sdk`) only.
+For Kiro in OMP, the recommended path is the dedicated
+[`ns-omp-provider-kiro`](https://www.npmjs.com/package/ns-omp-provider-kiro) plugin;
+this package's `kiro` stays off so it never shadows that plugin.
 
 ```bash
-# in the shell that launches omp, or via your shell profile / omp env
-export NS_OMP_PROVIDER_DISABLE=kiro
+# opt in to this package's kiro (in the environment that launches omp)
+export NS_OMP_PROVIDER_ENABLE=kiro
+# or allow-list exactly what you want
+export NS_OMP_PROVIDERS=devin,grok,kiro
+# deny-list, applied last (e.g. drop grok)
+export NS_OMP_PROVIDER_DISABLE=grok
 ```
 
-Or allow-list only what you want: `NS_OMP_PROVIDERS=devin,grok`.
+Don't opt in to `kiro` while `ns-omp-provider-kiro` is installed — both would
+register the same `kiro` provider id.
 
 ## How the wrapper works
 
@@ -72,16 +79,16 @@ Or allow-list only what you want: `NS_OMP_PROVIDERS=devin,grok`.
 
 - **`session_info_changed`** — OMP has no equivalent; the grok handler is a
   documented no-op (name changes do not re-key the agent pool).
-- **Duplicate `kiro`** — see `NS_OMP_PROVIDER_DISABLE` above.
+- **Duplicate `kiro`** — `kiro` is opt-in; don't enable it alongside `ns-omp-provider-kiro`.
 - **Unauthenticated catalogs** — without credentials, OMP may hide a provider's
   models from `omp models` even though the provider is registered. After
   `/login` (or with CLI creds present) the live catalog, including Devin
   `swe-2-*`, appears via `fetchDynamicModels`.
-- **Kiro catalog** — models come only from Kiro's `ListAvailableModels`
+- **Kiro catalog** (when opted in) — models come only from Kiro's `ListAvailableModels`
   (since ns-pi-provider 0.2.0): with no Kiro credential and no saved catalog
   snapshot, `kiro` registers zero models, and `-1m` long-context variants are
   not offered.
-- **Upstream pin** — this release bundles `@ngosangns/ns-pi-provider@0.2.0`.
+- **Upstream pin** — this release bundles `@ngosangns/ns-pi-provider@0.2.1`.
   Bumping it is a deliberate change (rebuild + retest).
 
 ## Development
@@ -99,14 +106,14 @@ your real `~/.omp`.
 
 ## Publish
 
-Push a tag matching `package.json` (e.g. `v0.2.0`) to run
+Push a tag matching `package.json` (e.g. `v0.3.0`) to run
 [`.github/workflows/publish.yml`](.github/workflows/publish.yml), which
 publishes with **provenance** from a GitHub-hosted runner:
 
 ```bash
 # bump "version" in package.json first, then
 npm run check
-git tag v0.2.0 && git push origin v0.2.0
+git tag v0.3.0 && git push origin v0.3.0
 ```
 
 Auth, in the order npm tries it:

package/dist/config.d.ts

@@ -3,8 +3,17 @@ export declare const PROVIDER_KEYS: readonly ["kiro", "devin", "grok"];
 export type ProviderKey = (typeof PROVIDER_KEYS)[number];
 export type ProviderSelection = Record<ProviderKey, boolean>;
 /**
- * - `NS_OMP_PROVIDERS=devin,grok` — allow-list (only these are registered).
- * - `NS_OMP_PROVIDER_DISABLE=kiro` — deny-list, applied after the allow-list.
- * Default: all three.
+ * Providers that stay off unless explicitly requested. `kiro` is opt-in because
+ * the dedicated `ns-omp-provider-kiro` plugin is the recommended Kiro path in
+ * OMP; registering a second `kiro` here would shadow it.
+ */
+export declare const OPT_IN_PROVIDERS: ReadonlySet<ProviderKey>;
+/**
+ * - `NS_OMP_PROVIDERS=devin,grok,kiro` — allow-list (only these are registered;
+ *   listing `kiro` here opts it in).
+ * - `NS_OMP_PROVIDER_ENABLE=kiro` — opt in to opt-in providers on top of the
+ *   default set (or the allow-list).
+ * - `NS_OMP_PROVIDER_DISABLE=grok` — deny-list, applied last.
+ * Default: `devin` and `grok`; `kiro` is opt-in.
  */
 export declare function resolveProviderSelection(env?: NodeJS.ProcessEnv): ProviderSelection;

package/dist/index.js

@@ -1,4 +1,4 @@
-// ns-omp-provider 0.2.0 — bundles @ngosangns/ns-pi-provider@0.2.0 (MIT). See NOTICE.
+// ns-omp-provider 0.3.0 — bundles @ngosangns/ns-pi-provider@0.2.1 (MIT). See NOTICE.
 import { createRequire as __nsOmpCreateRequire } from 'node:module';
 const require = __nsOmpCreateRequire(import.meta.url);
 var __defProp = Object.defineProperty;
@@ -882,6 +882,65 @@ function buildUsage(model, tokens) {
   calculateCost(model, usage);
   return usage;
 }
+function optionalCount(value2) {
+  return typeof value2 === "number" && Number.isFinite(value2) && value2 >= 0 ? value2 : void 0;
+}
+function firstCount(record2, keys) {
+  for (const key of keys) {
+    const value2 = optionalCount(record2[key]);
+    if (value2 !== void 0) return value2;
+  }
+  return void 0;
+}
+function applyKiroMetadata(state2, model, payload) {
+  const metadata = isRecord(payload.metadataEvent) ? payload.metadataEvent : payload;
+  const stopReason = nonEmptyString(metadata.stopReason);
+  if (stopReason) state2.wireStopReason = stopReason;
+  if (isRecord(metadata.stopDetails)) state2.wireStopDetails = metadata.stopDetails;
+  const tokenUsage = isRecord(metadata.tokenUsage) ? metadata.tokenUsage : void 0;
+  if (!tokenUsage) return;
+  const percentage2 = numberFrom(tokenUsage.contextUsagePercentage);
+  if (percentage2 > 0) state2.contextUsagePercentage = percentage2;
+  const next = {
+    input: optionalCount(tokenUsage.uncachedInputTokens) ?? optionalCount(tokenUsage.inputTokens),
+    output: optionalCount(tokenUsage.outputTokens),
+    cacheRead: firstCount(tokenUsage, CACHE_READ_KEYS),
+    cacheWrite: firstCount(tokenUsage, CACHE_WRITE_KEYS)
+  };
+  const merged = { ...state2.wireTokens ?? {} };
+  for (const [key, value2] of Object.entries(next)) {
+    if (value2 !== void 0) merged[key] = value2;
+  }
+  state2.wireTokens = merged;
+  const tokens = { input: merged.input ?? 0, output: merged.output ?? 0, cacheRead: merged.cacheRead ?? 0, cacheWrite: merged.cacheWrite ?? 0 };
+  if (tokens.input > 0 || tokens.output > 0 || tokens.cacheRead > 0 || tokens.cacheWrite > 0) {
+    state2.usage = buildUsage(model, tokens);
+  }
+}
+function clampForDiagnostic(text2) {
+  return text2.length <= DIAGNOSTIC_QUOTE_LIMIT ? text2 : `${text2.slice(0, DIAGNOSTIC_QUOTE_LIMIT)}\u2026 (truncated)`;
+}
+function throwOnTerminalWireStop(state2) {
+  switch (state2.wireStopReason) {
+    case "MODEL_CONTEXT_WINDOW_EXCEEDED":
+      throw new Error("Kiro API error: context_length_exceeded (MODEL_CONTEXT_WINDOW_EXCEEDED): the model context window exceeded its limit");
+    case "CONTENT_FILTERED":
+      throw new Error(`Kiro content filtered (CONTENT_FILTERED): ${clampForDiagnostic(redactSensitiveString(JSON.stringify(state2.wireStopDetails ?? {})))}`);
+    case "PAUSE_TURN":
+      throw new Error("Kiro paused the turn (PAUSE_TURN); automatic continuation is not supported");
+  }
+}
+function resolveStopReason(state2) {
+  if (state2.wireStopReason === "MAX_TOKENS") return "length";
+  return state2.hasToolCalls ? "toolUse" : "stop";
+}
+function throwOnExceptionFrame(headers, payload) {
+  const messageType = headers[":message-type"];
+  if (messageType !== "exception" && messageType !== "error") return;
+  const kind = headers[":exception-type"] ?? headers[":error-code"] ?? "error";
+  const message2 = (payload ? nonEmptyString(payload.message) ?? nonEmptyString(payload.Message) ?? nonEmptyString(payload.error) : void 0) ?? headers[":error-message"] ?? "";
+  throw new Error(`Kiro stream ${kind}: ${clampForDiagnostic(redactSensitiveString(message2 || "no details"))}`);
+}
 function usageFromMetrics(model, metrics) {
   const input = numberFrom(metrics.inputTokens);
   const output = numberFrom(metrics.outputTokens);
@@ -1065,6 +1124,10 @@ function handleEvent(stream, output, state2, model, eventType, payload) {
     if (percentage2 > 0) state2.contextUsagePercentage = percentage2;
     return;
   }
+  if (eventType === "metadataEvent") {
+    applyKiroMetadata(state2, model, payload);
+    return;
+  }
   if (eventType === "metricsEvent") {
     const metrics = isRecord(payload.metricsEvent) ? payload.metricsEvent : payload;
     state2.usage = usageFromMetrics(model, metrics);
@@ -1092,15 +1155,17 @@ async function consumeKiroEventStream(response, stream, output, model, logger) {
       if (!frameBytes) break;
       const frame = parseEventFrame(frameBytes, logger);
       if (!frame) continue;
+      throwOnExceptionFrame(frame.headers, frame.payload);
       handleEvent(stream, output, state2, model, frame.headers[":event-type"] ?? "", frame.payload);
     }
     if (iterations >= 1e3) logger.warn("eventstream_iteration_limit_reached", { remainingBytes: queue.length });
   }
+  throwOnTerminalWireStop(state2);
   closeThinkingBlock(stream, output, state2);
   closeTextBlock(stream, output, state2);
   closeToolCalls(stream, output, state2);
   output.usage = state2.usage ?? estimatedUsage(model, state2) ?? output.usage;
-  output.stopReason = state2.hasToolCalls ? "toolUse" : "stop";
+  output.stopReason = resolveStopReason(state2);
   stream.push({ type: "done", reason: output.stopReason, message: output });
   stream.end(output);
 }
@@ -1147,7 +1212,7 @@ function createKiroStream(config, _runtime, logger) {
     return stream;
   };
 }
-var ENV_VAR_PATTERN, DEFAULT_MAX_OUTPUT_TOKENS, API_MAX_OUTPUT_TOKENS, KIRO_NAMESPACE, KIRO_STREAMING_TARGET, KIRO_CODEWHISPERER_SDK_USER_AGENT, KIRO_CODEWHISPERER_AMZ_USER_AGENT, KIRO_Q_SDK_USER_AGENT, KIRO_Q_AMZ_USER_AGENT, KIRO_CLI_CONTEXT_BLOCK_PATTERN, KIRO_CLI_USER_MESSAGE_PATTERN, KiroAuthFailureError;
+var ENV_VAR_PATTERN, DEFAULT_MAX_OUTPUT_TOKENS, API_MAX_OUTPUT_TOKENS, KIRO_NAMESPACE, KIRO_STREAMING_TARGET, KIRO_CODEWHISPERER_SDK_USER_AGENT, KIRO_CODEWHISPERER_AMZ_USER_AGENT, KIRO_Q_SDK_USER_AGENT, KIRO_Q_AMZ_USER_AGENT, KIRO_CLI_CONTEXT_BLOCK_PATTERN, KIRO_CLI_USER_MESSAGE_PATTERN, KiroAuthFailureError, CACHE_READ_KEYS, CACHE_WRITE_KEYS, DIAGNOSTIC_QUOTE_LIMIT;
 var init_stream_oauth = __esm({
   "node_modules/@ngosangns/ns-pi-provider/src/kiro/stream-oauth.ts"() {
     init_pi_ai();
@@ -1174,6 +1239,9 @@ var init_stream_oauth = __esm({
         this.kiroAuth = { ...metadata };
       }
     };
+    CACHE_READ_KEYS = ["cacheReadInputTokens", "cache_read_input_tokens", "cacheReadTokens"];
+    CACHE_WRITE_KEYS = ["cacheWriteInputTokens", "cache_creation_input_tokens", "cacheCreationInputTokens", "cacheCreationTokens"];
+    DIAGNOSTIC_QUOTE_LIMIT = 500;
   }
 });
 
@@ -5196,12 +5264,15 @@ function parseList(value2) {
     value2.split(/[\s,]+/).map((item) => item.trim().toLowerCase()).filter(Boolean)
   );
 }
+var OPT_IN_PROVIDERS = /* @__PURE__ */ new Set(["kiro"]);
 function resolveProviderSelection(env = process.env) {
   const allow = parseList(env.NS_OMP_PROVIDERS);
+  const enable = parseList(env.NS_OMP_PROVIDER_ENABLE) ?? /* @__PURE__ */ new Set();
   const deny = parseList(env.NS_OMP_PROVIDER_DISABLE) ?? /* @__PURE__ */ new Set();
   const selection = {};
   for (const key of PROVIDER_KEYS) {
-    selection[key] = (allow ? allow.has(key) : true) && !deny.has(key);
+    const base = allow ? allow.has(key) : !OPT_IN_PROVIDERS.has(key);
+    selection[key] = (base || enable.has(key)) && !deny.has(key);
   }
   return selection;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ns-omp-provider",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "OMP (oh-my-pi) plugin: Kiro, Devin, and Grok providers from @ngosangns/ns-pi-provider, wrapped for OMP's provider/extension API.",
   "type": "module",
   "license": "MIT",
@@ -70,7 +70,7 @@
     }
   },
   "devDependencies": {
-    "@ngosangns/ns-pi-provider": "0.2.0",
+    "@ngosangns/ns-pi-provider": "0.2.1",
     "@types/node": "^22.18.6",
     "esbuild": "^0.28.2",
     "typescript": "^5.9.2",