@openhoo/hoopilot 0.7.3 → 0.7.5

package/dist/index.d.cts

@@ -126,10 +126,16 @@ interface RequestObservation {
 /** One quota category (chat, completions, or premium_interactions/credits). */
 interface CopilotQuota {
     entitlement?: number;
+    hasQuota?: boolean;
     overageCount?: number;
+    overageEntitlement?: number;
     overagePermitted?: boolean;
     percentRemaining?: number;
+    quotaId?: string;
+    quotaResetAt?: string;
     remaining?: number;
+    timestampUtc?: string;
+    tokenBasedBilling?: boolean;
     unlimited?: boolean;
     used?: number;
 }

package/dist/index.d.ts

@@ -126,10 +126,16 @@ interface RequestObservation {
 /** One quota category (chat, completions, or premium_interactions/credits). */
 interface CopilotQuota {
     entitlement?: number;
+    hasQuota?: boolean;
     overageCount?: number;
+    overageEntitlement?: number;
     overagePermitted?: boolean;
     percentRemaining?: number;
+    quotaId?: string;
+    quotaResetAt?: string;
     remaining?: number;
+    timestampUtc?: string;
+    tokenBasedBilling?: boolean;
     unlimited?: boolean;
     used?: number;
 }

package/dist/index.js

@@ -329,22 +329,31 @@ function normalizeCopilotUsage(body) {
 }
 function normalizeQuotaDetail(detail) {
   const entitlement = numberOrUndefined(detail.entitlement);
+  const overageCount = numberOrUndefined(detail.overage_count);
   const remaining = numberOrUndefined(detail.remaining) ?? numberOrUndefined(detail.quota_remaining);
   return removeUndefinedQuota({
     entitlement,
-    overageCount: numberOrUndefined(detail.overage_count),
+    hasQuota: typeof detail.has_quota === "boolean" ? detail.has_quota : void 0,
+    overageCount,
+    overageEntitlement: numberOrUndefined(detail.overage_entitlement),
     overagePermitted: typeof detail.overage_permitted === "boolean" ? detail.overage_permitted : void 0,
     percentRemaining: numberOrUndefined(detail.percent_remaining),
+    quotaId: stringOrUndefined(detail.quota_id),
+    quotaResetAt: stringOrUndefined(detail.quota_reset_at),
     remaining,
+    timestampUtc: stringOrUndefined(detail.timestamp_utc),
+    tokenBasedBilling: typeof detail.token_based_billing === "boolean" ? detail.token_based_billing : void 0,
     unlimited: typeof detail.unlimited === "boolean" ? detail.unlimited : void 0,
-    used: usedFrom(entitlement, remaining)
+    used: usedFrom(entitlement, remaining, overageCount)
   });
 }
-function usedFrom(entitlement, remaining) {
+function usedFrom(entitlement, remaining, overageCount) {
   if (entitlement === void 0 || remaining === void 0) {
     return void 0;
   }
-  return Math.max(0, entitlement - remaining);
+  const base = entitlement - remaining;
+  const overage = remaining === 0 ? overageCount ?? 0 : 0;
+  return Math.max(0, base + overage);
 }
 function numberOrUndefined(value) {
   return typeof value === "number" && Number.isFinite(value) ? value : void 0;
@@ -607,6 +616,12 @@ function isLogLevel(value) {
 
 // src/openai.ts
 var DEFAULT_MODEL = "gpt-4.1";
+var OpenAICompatibilityError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "OpenAICompatibilityError";
+  }
+};
 function responsesRequestToChatCompletion(request) {
   const messages = [];
   const instructions = contentToText(request.instructions);
@@ -640,13 +655,22 @@ function normalizeChatCompletionRequest(request) {
   });
 }
 function completionsRequestToChatCompletion(request) {
+  assertSupportedLegacyCompletionRequest(request);
   return removeUndefined({
+    frequency_penalty: request.frequency_penalty,
+    logit_bias: request.logit_bias,
     max_tokens: request.max_tokens,
-    messages: [{ content: promptToText(request.prompt), role: "user" }],
+    messages: [{ content: legacyPromptToText(request.prompt), role: "user" }],
     model: normalizeRequestedModel(request.model),
+    n: request.n,
+    presence_penalty: request.presence_penalty,
+    seed: request.seed,
+    stop: request.stop,
     stream: request.stream === true,
+    stream_options: request.stream_options,
     temperature: request.temperature,
-    top_p: request.top_p
+    top_p: request.top_p,
+    user: request.user
   });
 }
 function normalizeRequestedModel(model) {
@@ -682,21 +706,21 @@ function chatCompletionToResponse(completion, responseId) {
   });
 }
 function chatCompletionToCompletion(completion) {
-  const choice = firstChoice(completion);
-  const message = asRecord(choice.message);
   return removeUndefined({
-    choices: [
-      {
+    choices: completionChoices(completion).map((choice, index) => {
+      const message = asRecord(choice.message);
+      return {
         finish_reason: choice.finish_reason ?? "stop",
-        index: 0,
-        logprobs: null,
-        text: contentToText(message.content)
-      }
-    ],
+        index: typeof choice.index === "number" ? choice.index : index,
+        logprobs: choice.logprobs ?? null,
+        text: contentToText(choice.text) || contentToText(message.content)
+      };
+    }),
     created: completion.created ?? epochSeconds(),
     id: completion.id ?? `cmpl_${randomId()}`,
     model: completion.model ?? DEFAULT_MODEL,
     object: "text_completion",
+    system_fingerprint: completion.system_fingerprint,
     usage: completion.usage
   });
 }
@@ -960,7 +984,8 @@ function inputToMessages(input) {
   const messages = [];
   for (const item of input) {
     const record = asRecord(item);
-    if (record.type === "function_call_output") {
+    const type = contentToText(record.type);
+    if (type === "function_call_output") {
       messages.push({
         content: contentToText(record.output),
         role: "tool",
@@ -968,7 +993,7 @@ function inputToMessages(input) {
       });
       continue;
     }
-    if (record.type === "function_call") {
+    if (type === "function_call") {
       messages.push({
         role: "assistant",
         tool_calls: [
@@ -984,7 +1009,10 @@ function inputToMessages(input) {
       });
       continue;
     }
-    const role = roleToChatRole(contentToText(record.role));
+    if (type && type !== "message") {
+      unsupportedResponsesFeature(`input item type "${type}"`);
+    }
+    const role = responsesRoleToChatRole(contentToText(record.role));
     const content = chatMessageContent(record.content);
     if (role && content !== void 0) {
       messages.push({ content, role });
@@ -997,7 +1025,10 @@ function chatMessageContent(content) {
     return content;
   }
   if (!Array.isArray(content)) {
-    return contentToText(content) || void 0;
+    if (content === void 0 || content === null) {
+      return void 0;
+    }
+    unsupportedResponsesFeature("non-array message content objects");
   }
   const parts = [];
   for (const part of content) {
@@ -1005,13 +1036,31 @@ function chatMessageContent(content) {
     const type = contentToText(record.type);
     if (type === "input_text" || type === "output_text" || type === "text") {
       parts.push({ text: contentToText(record.text), type: "text" });
+      continue;
     }
     if (type === "input_image") {
+      if (contentToText(record.file_id)) {
+        unsupportedResponsesFeature("input_image file_id parts");
+      }
       const imageUrl = contentToText(record.image_url);
-      if (imageUrl) {
-        parts.push({ image_url: { url: imageUrl }, type: "image_url" });
+      if (!imageUrl) {
+        unsupportedResponsesFeature("input_image parts without image_url");
+      }
+      const image = { url: imageUrl };
+      const detail = contentToText(record.detail);
+      if (detail) {
+        image.detail = detail;
       }
+      parts.push({ image_url: image, type: "image_url" });
+      continue;
+    }
+    if (type === "input_file") {
+      unsupportedResponsesFeature("input_file parts");
+    }
+    if (type === "input_audio") {
+      unsupportedResponsesFeature("input_audio parts");
     }
+    unsupportedResponsesFeature(`content part type "${type || "unknown"}"`);
   }
   if (parts.length === 0) {
     return void 0;
@@ -1021,11 +1070,38 @@ function chatMessageContent(content) {
   }
   return parts;
 }
-function promptToText(prompt) {
-  if (Array.isArray(prompt)) {
-    return prompt.map((item) => contentToText(item)).join("\n");
+function legacyPromptToText(prompt) {
+  if (typeof prompt === "string") {
+    return prompt;
+  }
+  if (Array.isArray(prompt) && prompt.length === 1 && typeof prompt[0] === "string") {
+    return prompt[0];
+  }
+  throw new OpenAICompatibilityError(
+    "Hoopilot legacy completions compatibility supports exactly one string prompt per request."
+  );
+}
+function assertSupportedLegacyCompletionRequest(request) {
+  if (request.echo === true) {
+    throw new OpenAICompatibilityError(
+      "Hoopilot legacy completions compatibility does not support echo=true."
+    );
+  }
+  if (typeof request.best_of === "number" && request.best_of > 1) {
+    throw new OpenAICompatibilityError(
+      "Hoopilot legacy completions compatibility does not support best_of greater than 1."
+    );
+  }
+  if (typeof request.logprobs === "number" && request.logprobs > 0) {
+    throw new OpenAICompatibilityError(
+      "Hoopilot legacy completions compatibility does not support legacy logprobs."
+    );
+  }
+  if (contentToText(request.suffix)) {
+    throw new OpenAICompatibilityError(
+      "Hoopilot legacy completions compatibility does not support suffix."
+    );
   }
-  return contentToText(prompt);
 }
 function contentToText(content) {
   if (typeof content === "string") {
@@ -1049,25 +1125,35 @@ function contentToText(content) {
   }
   return "";
 }
-function roleToChatRole(role) {
-  if (role === "assistant" || role === "developer" || role === "system" || role === "tool") {
+function responsesRoleToChatRole(role) {
+  if (!role) {
+    return "user";
+  }
+  if (role === "assistant" || role === "developer" || role === "system" || role === "tool" || role === "user") {
     return role === "developer" ? "system" : role;
   }
-  return "user";
+  unsupportedResponsesFeature(`message role "${role}"`);
 }
 function chatTools(tools) {
   if (!Array.isArray(tools)) {
     return void 0;
   }
-  const converted = tools.map((tool) => asRecord(tool)).filter((tool) => tool.type === "function").map((tool) => ({
-    function: removeUndefined({
-      description: tool.description,
-      name: tool.name,
-      parameters: tool.parameters,
-      strict: tool.strict
-    }),
-    type: "function"
-  }));
+  const converted = tools.map((tool) => {
+    const record = asRecord(tool);
+    const type = contentToText(record.type);
+    if (type !== "function") {
+      unsupportedResponsesFeature(`tool type "${type || "unknown"}"`);
+    }
+    return {
+      function: removeUndefined({
+        description: record.description,
+        name: record.name,
+        parameters: record.parameters,
+        strict: record.strict
+      }),
+      type: "function"
+    };
+  });
   return converted.length > 0 ? converted : void 0;
 }
 function chatToolChoice(toolChoice) {
@@ -1075,10 +1161,16 @@ function chatToolChoice(toolChoice) {
     return toolChoice;
   }
   const record = asRecord(toolChoice);
-  if (record.type === "function" && typeof record.name === "string") {
+  const type = contentToText(record.type);
+  if (type === "function" && typeof record.name === "string") {
     return { function: { name: record.name }, type: "function" };
   }
-  return toolChoice;
+  unsupportedResponsesFeature(`tool_choice type "${type || "unknown"}"`);
+}
+function unsupportedResponsesFeature(feature) {
+  throw new OpenAICompatibilityError(
+    `Hoopilot Responses-to-chat compatibility does not support ${feature}.`
+  );
 }
 function outputItemsFromMessage(message) {
   const output = [];
@@ -1193,8 +1285,11 @@ function firstNumber(...values) {
   return void 0;
 }
 function firstChoice(completion) {
+  return completionChoices(completion)[0] ?? {};
+}
+function completionChoices(completion) {
   const choices = Array.isArray(completion.choices) ? completion.choices : [];
-  return asRecord(choices[0]);
+  return choices.map((choice) => asRecord(choice));
 }
 function processCompletionSseBlock(block, enqueue, markTerminal) {
   let event = "message";
@@ -1226,25 +1321,28 @@ function processCompletionSseBlock(block, enqueue, markTerminal) {
     enqueue({ error });
     return;
   }
-  const choice = firstChoice(parsed);
-  const delta = asRecord(choice.delta);
-  const text = contentToText(delta.content);
-  const finishReason = choice.finish_reason ?? null;
+  const choices = completionChoices(parsed).map((choice, index) => {
+    const delta = asRecord(choice.delta);
+    const text = contentToText(delta.content);
+    const finishReason = choice.finish_reason ?? null;
+    if (!text && finishReason === null) {
+      return void 0;
+    }
+    return {
+      finish_reason: finishReason,
+      index: typeof choice.index === "number" ? choice.index : index,
+      logprobs: choice.logprobs ?? null,
+      text
+    };
+  }).filter((choice) => choice !== void 0);
   const usage = asRecord(parsed.usage);
   const hasUsage = Object.keys(usage).length > 0;
-  if (!text && finishReason === null && !hasUsage) {
+  if (choices.length === 0 && !hasUsage) {
     return;
   }
   enqueue(
     removeUndefined({
-      choices: text || finishReason !== null ? [
-        {
-          finish_reason: finishReason,
-          index: typeof choice.index === "number" ? choice.index : 0,
-          logprobs: null,
-          text
-        }
-      ] : [],
+      choices,
       created: typeof parsed.created === "number" ? parsed.created : epochSeconds(),
       id: contentToText(parsed.id) || `cmpl_${randomId()}`,
       model: contentToText(parsed.model) || DEFAULT_MODEL,
@@ -1553,11 +1651,43 @@ var MetricsRegistry = class {
     gauge("remaining", "Remaining quota for the Copilot category.", (q) => q.remaining);
     gauge("entitlement", "Quota entitlement for the Copilot category.", (q) => q.entitlement);
     gauge("used", "Used quota (entitlement minus remaining) for the category.", (q) => q.used);
+    gauge("overage_count", "Overage count for the Copilot category.", (q) => q.overageCount);
+    gauge(
+      "overage_entitlement",
+      "Overage entitlement for the Copilot category.",
+      (q) => q.overageEntitlement
+    );
     gauge(
       "percent_remaining",
       "Percent of quota remaining for the Copilot category.",
       (q) => q.percentRemaining
     );
+    booleanGauge(
+      "unlimited",
+      "Whether the Copilot quota category is unlimited.",
+      (q) => q.unlimited
+    );
+    booleanGauge(
+      "overage_permitted",
+      "Whether overage is permitted for the Copilot category.",
+      (q) => q.overagePermitted
+    );
+    booleanGauge("has_quota", "Whether the Copilot quota category has a quota.", (q) => q.hasQuota);
+    booleanGauge(
+      "token_based_billing",
+      "Whether the Copilot quota category uses token-based billing.",
+      (q) => q.tokenBasedBilling
+    );
+    dateGauge(
+      "category_reset_timestamp_seconds",
+      "Unix epoch of the Copilot category-specific quota reset.",
+      (q) => q.quotaResetAt
+    );
+    dateGauge(
+      "category_snapshot_timestamp_seconds",
+      "Unix epoch of the Copilot category quota snapshot.",
+      (q) => q.timestampUtc
+    );
     const resetMs = usage.quotaResetDate ? Date.parse(usage.quotaResetDate) : Number.NaN;
     if (Number.isFinite(resetMs)) {
       lines.push(
@@ -1576,6 +1706,30 @@ var MetricsRegistry = class {
         })} 1`
       );
     }
+    function booleanGauge(suffix, help, pick) {
+      const present = categories.filter(([, quota]) => pick(quota) !== void 0);
+      if (present.length === 0) {
+        return;
+      }
+      lines.push(`# HELP hoopilot_copilot_quota_${suffix} ${help}`);
+      lines.push(`# TYPE hoopilot_copilot_quota_${suffix} gauge`);
+      for (const [category, quota] of present) {
+        lines.push(
+          `hoopilot_copilot_quota_${suffix}${labels({ category })} ${pick(quota) ? 1 : 0}`
+        );
+      }
+    }
+    function dateGauge(suffix, help, pick) {
+      const present = categories.map(([category, quota]) => [category, Date.parse(pick(quota) ?? "")]).filter(([, timestamp]) => Number.isFinite(timestamp));
+      if (present.length === 0) {
+        return;
+      }
+      lines.push(`# HELP hoopilot_copilot_quota_${suffix} ${help}`);
+      lines.push(`# TYPE hoopilot_copilot_quota_${suffix} gauge`);
+      for (const [category, timestamp] of present) {
+        lines.push(`hoopilot_copilot_quota_${suffix}${labels({ category })} ${timestamp / 1e3}`);
+      }
+    }
   }
 };
 function observeResponseUsage(response, fallbackModel, onUsage, signal) {
@@ -1816,6 +1970,12 @@ function createHoopilotHandler(options = {}) {
           "request body was invalid json"
         );
         return finish(jsonError(400, "invalid_request_error", message));
+      } else if (error instanceof OpenAICompatibilityError) {
+        requestLogger.warn(
+          { err: errorDetails(error), event: "http.request.failed" },
+          "request body used unsupported OpenAI compatibility fields"
+        );
+        return finish(jsonError(400, "invalid_request_error", message));
       } else if (error instanceof RequestBodyTooLargeError) {
         requestLogger.warn(
           { err: errorDetails(error), event: "http.request.failed" },
@@ -2267,8 +2427,8 @@ function metricsResponse(metrics) {
   });
 }
 async function handleUsage(metrics, readUsage, signal) {
-  const proxy = metrics.snapshot();
   const { copilot, error } = await readUsage(signal);
+  const proxy = metrics.snapshot();
   const body = { copilot: copilot ?? null, object: "usage", proxy };
   if (error) {
     body.copilot_error = error;
@@ -2293,10 +2453,10 @@ function createUsageReader(client, metrics, now = Date.now, ttlMs = USAGE_CACHE_
       metrics.recordCopilotQuota(value);
       return { copilot: value };
     } catch (error) {
-      metrics.recordUpstream(usagePath, false);
       if (error instanceof CopilotAuthError) {
         return { error: error.message };
       }
+      metrics.recordUpstream(usagePath, false);
       return { error: errorMessage(error) };
     }
   };