@usewind/node 0.1.1 → 0.1.2

package/dist/index.d.cts

@@ -84,11 +84,31 @@ interface ChatStreamChunk {
      * `.tool_calls`), JSON-parsed. `null` on the final, settlement-only chunk.
      */
     delta: unknown;
-    /** The final chunk of a stream carries the settled `wind` block; `null` on all others. */
+    /** The final chunk of a stream carries the settled `wind` block; `null` on all others, and on a final chunk that isn't `settled`. */
     wind: WindBlock | null;
-    /** Final token counts — on the final chunk only. */
+    /** Final token counts — on the final chunk only, when `settled`. */
     usage?: ChatUsage;
+    /** How the call's charge stands — on the final chunk only. */
+    settlement?: ChatSettlement;
+    /**
+     * The call's `Idempotency-Key` — on the final chunk only. A `pending` call's
+     * `request.settled` webhook carries it as `request_id`.
+     */
+    idempotencyKey?: string;
 }
+/**
+ * - `settled`: charged on the provider's own token counts; `wind` and `usage`
+ *   are filled in.
+ * - `estimated`: the stream ended before the provider reported usage, and it
+ *   keeps no record to fetch it from (OpenAI, Anthropic, Google direct), so it
+ *   was charged on Wind's count of the tokens with the provider's tokenizer.
+ *   `wind` and `usage` are filled in from that count.
+ * - `pending`: the stream ended before the provider reported usage, but the
+ *   provider keeps a record (OpenRouter), so the charge isn't known yet.
+ *   `wind` and `usage` are null; the user's hold stays reserved until Wind
+ *   settles it, and the result arrives as a `request.settled` webhook.
+ */
+type ChatSettlement = 'settled' | 'estimated' | 'pending';
 /** 'frozen' — Wind's own risk layer, independent of anything you or the user configured; clears when the user reconnects. */
 type ConnectionStatus = 'active' | 'exhausted' | 'revoked' | 'frozen';
 interface Connection {
@@ -640,4 +660,4 @@ declare function createWind(config?: Partial<WindConfig>): Wind;
  */
 declare const wind: Wind;
 
-export { type Account, AllocationExhaustedError, type AllocationRequest, type AllocationRequestParams, AppSuspendedError, type ChatMessage, type ChatParams, type ChatResult, type ChatStreamChunk, type ChatTool, type ChatToolChoice, type ChatUsage, type Chattable, type ConnectTransaction, type Connection, ConnectionFrozenError, ConnectionRevokedError, ConnectionScope, type ConnectionStatus, type Feature, FeatureCostExceededError, FeatureModelNotConfiguredError, FeatureScope, type Grant, type GrantStore, IdempotencyKeyReusedError, ModelNotAllowedError, ProviderError, RateLimitedError, type RevokeResult, RiskThrottledError, type RoutesOptions, TokenExpiredError, type TokenResponse, type TransactionStore, type WebhookEvent, Wind, WindApiError, type WindBlock, type WindConfig, WindConfigError, WindError, type WindErrorEnvelope, type WindErrorInit, WindNotConnectedError, WindNotImplementedError, WindSignatureError, createWind, memoryGrantStore, wind };
+export { type Account, AllocationExhaustedError, type AllocationRequest, type AllocationRequestParams, AppSuspendedError, type ChatMessage, type ChatParams, type ChatResult, type ChatSettlement, type ChatStreamChunk, type ChatTool, type ChatToolChoice, type ChatUsage, type Chattable, type ConnectTransaction, type Connection, ConnectionFrozenError, ConnectionRevokedError, ConnectionScope, type ConnectionStatus, type Feature, FeatureCostExceededError, FeatureModelNotConfiguredError, FeatureScope, type Grant, type GrantStore, IdempotencyKeyReusedError, ModelNotAllowedError, ProviderError, RateLimitedError, type RevokeResult, RiskThrottledError, type RoutesOptions, TokenExpiredError, type TokenResponse, type TransactionStore, type WebhookEvent, Wind, WindApiError, type WindBlock, type WindConfig, WindConfigError, WindError, type WindErrorEnvelope, type WindErrorInit, WindNotConnectedError, WindNotImplementedError, WindSignatureError, createWind, memoryGrantStore, wind };

package/dist/index.d.ts

@@ -84,11 +84,31 @@ interface ChatStreamChunk {
      * `.tool_calls`), JSON-parsed. `null` on the final, settlement-only chunk.
      */
     delta: unknown;
-    /** The final chunk of a stream carries the settled `wind` block; `null` on all others. */
+    /** The final chunk of a stream carries the settled `wind` block; `null` on all others, and on a final chunk that isn't `settled`. */
     wind: WindBlock | null;
-    /** Final token counts — on the final chunk only. */
+    /** Final token counts — on the final chunk only, when `settled`. */
     usage?: ChatUsage;
+    /** How the call's charge stands — on the final chunk only. */
+    settlement?: ChatSettlement;
+    /**
+     * The call's `Idempotency-Key` — on the final chunk only. A `pending` call's
+     * `request.settled` webhook carries it as `request_id`.
+     */
+    idempotencyKey?: string;
 }
+/**
+ * - `settled`: charged on the provider's own token counts; `wind` and `usage`
+ *   are filled in.
+ * - `estimated`: the stream ended before the provider reported usage, and it
+ *   keeps no record to fetch it from (OpenAI, Anthropic, Google direct), so it
+ *   was charged on Wind's count of the tokens with the provider's tokenizer.
+ *   `wind` and `usage` are filled in from that count.
+ * - `pending`: the stream ended before the provider reported usage, but the
+ *   provider keeps a record (OpenRouter), so the charge isn't known yet.
+ *   `wind` and `usage` are null; the user's hold stays reserved until Wind
+ *   settles it, and the result arrives as a `request.settled` webhook.
+ */
+type ChatSettlement = 'settled' | 'estimated' | 'pending';
 /** 'frozen' — Wind's own risk layer, independent of anything you or the user configured; clears when the user reconnects. */
 type ConnectionStatus = 'active' | 'exhausted' | 'revoked' | 'frozen';
 interface Connection {
@@ -640,4 +660,4 @@ declare function createWind(config?: Partial<WindConfig>): Wind;
  */
 declare const wind: Wind;
 
-export { type Account, AllocationExhaustedError, type AllocationRequest, type AllocationRequestParams, AppSuspendedError, type ChatMessage, type ChatParams, type ChatResult, type ChatStreamChunk, type ChatTool, type ChatToolChoice, type ChatUsage, type Chattable, type ConnectTransaction, type Connection, ConnectionFrozenError, ConnectionRevokedError, ConnectionScope, type ConnectionStatus, type Feature, FeatureCostExceededError, FeatureModelNotConfiguredError, FeatureScope, type Grant, type GrantStore, IdempotencyKeyReusedError, ModelNotAllowedError, ProviderError, RateLimitedError, type RevokeResult, RiskThrottledError, type RoutesOptions, TokenExpiredError, type TokenResponse, type TransactionStore, type WebhookEvent, Wind, WindApiError, type WindBlock, type WindConfig, WindConfigError, WindError, type WindErrorEnvelope, type WindErrorInit, WindNotConnectedError, WindNotImplementedError, WindSignatureError, createWind, memoryGrantStore, wind };
+export { type Account, AllocationExhaustedError, type AllocationRequest, type AllocationRequestParams, AppSuspendedError, type ChatMessage, type ChatParams, type ChatResult, type ChatSettlement, type ChatStreamChunk, type ChatTool, type ChatToolChoice, type ChatUsage, type Chattable, type ConnectTransaction, type Connection, ConnectionFrozenError, ConnectionRevokedError, ConnectionScope, type ConnectionStatus, type Feature, FeatureCostExceededError, FeatureModelNotConfiguredError, FeatureScope, type Grant, type GrantStore, IdempotencyKeyReusedError, ModelNotAllowedError, ProviderError, RateLimitedError, type RevokeResult, RiskThrottledError, type RoutesOptions, TokenExpiredError, type TokenResponse, type TransactionStore, type WebhookEvent, Wind, WindApiError, type WindBlock, type WindConfig, WindConfigError, WindError, type WindErrorEnvelope, type WindErrorInit, WindNotConnectedError, WindNotImplementedError, WindSignatureError, createWind, memoryGrantStore, wind };

package/dist/index.js

@@ -679,7 +679,7 @@ async function* billedStream(ctx, userId, params, call) {
   }
   if (!(res.body instanceof ReadableStream)) {
     const result = res.body;
-    yield { delta: result, wind: result.wind ?? null, usage: result.usage };
+    yield { delta: result, wind: result.wind ?? null, usage: result.usage, settlement: "settled", idempotencyKey };
     return;
   }
   for await (const event of sseEvents(res.body)) {
@@ -691,13 +691,13 @@ async function* billedStream(ctx, userId, params, call) {
       continue;
     }
     if (data?.wind_final) {
-      yield { delta: null, wind: data.wind_final.wind ?? null, usage: data.wind_final.usage };
+      yield finalChunk(data.wind_final, idempotencyKey);
     } else if (data?.error) {
       const err = data.error.error ?? data.error;
       const status = err.code === "provider_error" ? 502 : 403;
       throw WindError.fromResponse(status, { error: err }, { requestId: res.requestId });
-    } else if (data?.streamed && data.wind) {
-      yield { delta: null, wind: data.wind, usage: data.usage };
+    } else if (data?.streamed) {
+      yield finalChunk(data, idempotencyKey);
     } else {
       yield { delta: data, wind: null };
     }
@@ -723,6 +723,15 @@ async function* sseEvents(stream) {
     reader.releaseLock();
   }
 }
+function finalChunk(final, idempotencyKey) {
+  return {
+    delta: null,
+    wind: final.wind ?? null,
+    usage: final.usage ?? void 0,
+    settlement: final.settlement ?? "settled",
+    idempotencyKey
+  };
+}
 var TOLERANCE_S = 300;
 var WebhookVerifier = class {
   constructor(config) {