@shop-os/modelkit 0.2.2 → 0.2.3

package/dist/catalog.d.cts

@@ -219,8 +219,9 @@ interface CatalogDisplay {
     /** Chat picker highlight flag. */
     recommended?: boolean;
     /**
-     * Picker position: lower comes first; rows without one keep catalog order
-     * after the ordered ones. Set it to surface a new model at the top.
+     * Picker position: higher comes first; rows without one keep catalog order
+     * after the ordered ones. Give a new model the next number up to surface
+     * it at the top.
      */
     sortOrder?: number;
     /**
@@ -430,10 +431,18 @@ declare const CatalogModelSchema: z.ZodType<CatalogModel>;
 declare const CatalogSchema: z.ZodType<CatalogModel[]>;
 
 type CatalogOrigin = "remote" | "last-good" | "snapshot";
+interface PrimeCatalogResult {
+    origin: CatalogOrigin;
+    rowCount: number;
+    revision?: string;
+    error?: string;
+}
 interface LiveCatalogState {
     catalog: Catalog;
-    memo: Promise<unknown> | undefined;
-    timer: ReturnType<typeof setInterval> | undefined;
+    memo: Promise<PrimeCatalogResult> | undefined;
+    timer: (ReturnType<typeof setInterval> & {
+        unref?: () => void;
+    }) | undefined;
     revision: string | undefined;
     origin: CatalogOrigin;
 }
@@ -460,11 +469,9 @@ interface CatalogSource {
     logger?: Pick<Console, "debug" | "info" | "warn" | "error">;
 }
 
-interface PrimeCatalogResult {
-    origin: CatalogOrigin;
-    rowCount: number;
+interface CatalogEnvelope {
+    rows: CatalogModel[];
     revision?: string;
-    error?: string;
 }
 /** Fetch, validate, swap into liveCatalog. Never throws. Second call returns the same promise. */
 declare function primeCatalog(source: CatalogSource): Promise<PrimeCatalogResult>;
@@ -525,4 +532,4 @@ declare function isModelKitError(err: unknown): err is ModelKitError;
 /** Resolve caller options against a catalog row, dispatching on `model.type`. */
 declare function resolveOptions(model: CatalogModel, request: ImageRequest | VideoRequest | AudioRequest, onUnsupported?: OnUnsupported): ResolveResult<ImageRequest | VideoRequest | AudioRequest>;
 
-export { ADAPTER_IDS, type AdapterEndpoints, type AdapterId, type AspectRatio, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogAuth, type CatalogCache, type CatalogCapabilities, type CatalogDisplay, type CatalogModel, CatalogModelSchema, type CatalogOrigin, CatalogSchema, type CatalogSource, type GeneratedImage, IMAGE_MODELS, type ImageBytes, type ImageCallOptions, type ImageCallResult, type ImageQuality, type ImageRequest, type ImageResult, type ImageSafetySetting, type ImageSize, type JsonObject, type JsonPrimitive, type JsonValue, type Lifecycle, type LiveCatalogState, MODELS, type MediaPart, type MediaRef, type ModelConstraints, type ModelKitConfig, ModelKitError, type ModelKitErrorCode, type ModelKitErrorInit, type ModelType, OTHER_MODELS, type OnUnsupported, type OutputFormat, type PricingKind, type PrimeCatalogResult, type ProviderErrorBody, type ProviderKeyName, type ProviderKeys, type ProviderOptionValue, type ProviderOptions, type ReferenceLimits, type RequiredInput, type ResolveResult, type Routing, type SupportedOption, TEXT_MODELS, type UpscaleOptions, type UsageEvent, type UsageModality, type UsageUnit, VIDEO_MODELS, type VideoCallJob, type VideoCallOptions, type VideoJob, type VideoModel, type VideoRequest, type VideoResolution, type VideoResult, type Warning, isModelKitError, liveCatalog, liveState, nearestAspectRatio, primeCatalog, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions };
+export { ADAPTER_IDS, type AdapterEndpoints, type AdapterId, type AspectRatio, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogAuth, type CatalogCache, type CatalogCapabilities, type CatalogDisplay, type CatalogEnvelope, type CatalogModel, CatalogModelSchema, type CatalogOrigin, CatalogSchema, type CatalogSource, type GeneratedImage, IMAGE_MODELS, type ImageBytes, type ImageCallOptions, type ImageCallResult, type ImageQuality, type ImageRequest, type ImageResult, type ImageSafetySetting, type ImageSize, type JsonObject, type JsonPrimitive, type JsonValue, type Lifecycle, type LiveCatalogState, MODELS, type MediaPart, type MediaRef, type ModelConstraints, type ModelKitConfig, ModelKitError, type ModelKitErrorCode, type ModelKitErrorInit, type ModelType, OTHER_MODELS, type OnUnsupported, type OutputFormat, type PricingKind, type PrimeCatalogResult, type ProviderErrorBody, type ProviderKeyName, type ProviderKeys, type ProviderOptionValue, type ProviderOptions, type ReferenceLimits, type RequiredInput, type ResolveResult, type Routing, type SupportedOption, TEXT_MODELS, type UpscaleOptions, type UsageEvent, type UsageModality, type UsageUnit, VIDEO_MODELS, type VideoCallJob, type VideoCallOptions, type VideoJob, type VideoModel, type VideoRequest, type VideoResolution, type VideoResult, type Warning, isModelKitError, liveCatalog, liveState, nearestAspectRatio, primeCatalog, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions };

package/dist/catalog.d.ts

@@ -219,8 +219,9 @@ interface CatalogDisplay {
     /** Chat picker highlight flag. */
     recommended?: boolean;
     /**
-     * Picker position: lower comes first; rows without one keep catalog order
-     * after the ordered ones. Set it to surface a new model at the top.
+     * Picker position: higher comes first; rows without one keep catalog order
+     * after the ordered ones. Give a new model the next number up to surface
+     * it at the top.
      */
     sortOrder?: number;
     /**
@@ -430,10 +431,18 @@ declare const CatalogModelSchema: z.ZodType<CatalogModel>;
 declare const CatalogSchema: z.ZodType<CatalogModel[]>;
 
 type CatalogOrigin = "remote" | "last-good" | "snapshot";
+interface PrimeCatalogResult {
+    origin: CatalogOrigin;
+    rowCount: number;
+    revision?: string;
+    error?: string;
+}
 interface LiveCatalogState {
     catalog: Catalog;
-    memo: Promise<unknown> | undefined;
-    timer: ReturnType<typeof setInterval> | undefined;
+    memo: Promise<PrimeCatalogResult> | undefined;
+    timer: (ReturnType<typeof setInterval> & {
+        unref?: () => void;
+    }) | undefined;
     revision: string | undefined;
     origin: CatalogOrigin;
 }
@@ -460,11 +469,9 @@ interface CatalogSource {
     logger?: Pick<Console, "debug" | "info" | "warn" | "error">;
 }
 
-interface PrimeCatalogResult {
-    origin: CatalogOrigin;
-    rowCount: number;
+interface CatalogEnvelope {
+    rows: CatalogModel[];
     revision?: string;
-    error?: string;
 }
 /** Fetch, validate, swap into liveCatalog. Never throws. Second call returns the same promise. */
 declare function primeCatalog(source: CatalogSource): Promise<PrimeCatalogResult>;
@@ -525,4 +532,4 @@ declare function isModelKitError(err: unknown): err is ModelKitError;
 /** Resolve caller options against a catalog row, dispatching on `model.type`. */
 declare function resolveOptions(model: CatalogModel, request: ImageRequest | VideoRequest | AudioRequest, onUnsupported?: OnUnsupported): ResolveResult<ImageRequest | VideoRequest | AudioRequest>;
 
-export { ADAPTER_IDS, type AdapterEndpoints, type AdapterId, type AspectRatio, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogAuth, type CatalogCache, type CatalogCapabilities, type CatalogDisplay, type CatalogModel, CatalogModelSchema, type CatalogOrigin, CatalogSchema, type CatalogSource, type GeneratedImage, IMAGE_MODELS, type ImageBytes, type ImageCallOptions, type ImageCallResult, type ImageQuality, type ImageRequest, type ImageResult, type ImageSafetySetting, type ImageSize, type JsonObject, type JsonPrimitive, type JsonValue, type Lifecycle, type LiveCatalogState, MODELS, type MediaPart, type MediaRef, type ModelConstraints, type ModelKitConfig, ModelKitError, type ModelKitErrorCode, type ModelKitErrorInit, type ModelType, OTHER_MODELS, type OnUnsupported, type OutputFormat, type PricingKind, type PrimeCatalogResult, type ProviderErrorBody, type ProviderKeyName, type ProviderKeys, type ProviderOptionValue, type ProviderOptions, type ReferenceLimits, type RequiredInput, type ResolveResult, type Routing, type SupportedOption, TEXT_MODELS, type UpscaleOptions, type UsageEvent, type UsageModality, type UsageUnit, VIDEO_MODELS, type VideoCallJob, type VideoCallOptions, type VideoJob, type VideoModel, type VideoRequest, type VideoResolution, type VideoResult, type Warning, isModelKitError, liveCatalog, liveState, nearestAspectRatio, primeCatalog, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions };
+export { ADAPTER_IDS, type AdapterEndpoints, type AdapterId, type AspectRatio, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogAuth, type CatalogCache, type CatalogCapabilities, type CatalogDisplay, type CatalogEnvelope, type CatalogModel, CatalogModelSchema, type CatalogOrigin, CatalogSchema, type CatalogSource, type GeneratedImage, IMAGE_MODELS, type ImageBytes, type ImageCallOptions, type ImageCallResult, type ImageQuality, type ImageRequest, type ImageResult, type ImageSafetySetting, type ImageSize, type JsonObject, type JsonPrimitive, type JsonValue, type Lifecycle, type LiveCatalogState, MODELS, type MediaPart, type MediaRef, type ModelConstraints, type ModelKitConfig, ModelKitError, type ModelKitErrorCode, type ModelKitErrorInit, type ModelType, OTHER_MODELS, type OnUnsupported, type OutputFormat, type PricingKind, type PrimeCatalogResult, type ProviderErrorBody, type ProviderKeyName, type ProviderKeys, type ProviderOptionValue, type ProviderOptions, type ReferenceLimits, type RequiredInput, type ResolveResult, type Routing, type SupportedOption, TEXT_MODELS, type UpscaleOptions, type UsageEvent, type UsageModality, type UsageUnit, VIDEO_MODELS, type VideoCallJob, type VideoCallOptions, type VideoJob, type VideoModel, type VideoRequest, type VideoResolution, type VideoResult, type Warning, isModelKitError, liveCatalog, liveState, nearestAspectRatio, primeCatalog, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions };

package/dist/catalog.js

@@ -119,6 +119,12 @@ var GEMINI_RATIOS = [
   "adaptive"
 ];
 function geminiImage(id, label, aliases, sizes, display, exposure, references) {
+  const constraints = {
+    aspectRatios: [...GEMINI_RATIOS],
+    sizes,
+    supports: ["safetySettings", "temperature"]
+  };
+  if (references !== void 0) constraints.references = references;
   const model = {
     id,
     aliases,
@@ -128,12 +134,7 @@ function geminiImage(id, label, aliases, sizes, display, exposure, references) {
     providerModelId: id,
     lifecycle: "active",
     exposure,
-    constraints: {
-      aspectRatios: [...GEMINI_RATIOS],
-      sizes,
-      supports: ["safetySettings", "temperature"],
-      ...references ? { references } : {}
-    },
+    constraints,
     defaults: { size: "1K", aspectRatio: "1:1" },
     usage: { ...IMAGE_USAGE, slug: "gemini" },
     pricingKind: "image_size",
@@ -260,6 +261,7 @@ var IMAGE_MODELS = [
     pricingKind: "image_size",
     display: {
       provider: "openai",
+      sortOrder: 20,
       description: "OpenAI's most capable GPT Image 2.5 tier, built for editing precision; takes text and image input and outputs images in low, medium, high, xhigh, or max quality."
     }
   },
@@ -294,6 +296,7 @@ var IMAGE_MODELS = [
     pricingKind: "image_size",
     display: {
       provider: "openai",
+      sortOrder: 10,
       description: "OpenAI's fastest GPT Image 2.5 tier for high-quality everyday image generation and editing; takes text and image input and outputs images."
     }
   },
@@ -2034,23 +2037,22 @@ var liveState = store[KEY] ??= {
 var liveCatalog = liveState.catalog;
 
 // src/catalog/load.ts
+import { z as z2 } from "zod";
 function rowCount() {
   return liveCatalog.list({ lifecycle: ["active", "deprecated", "retired"] }).length;
 }
 function authHeaders(auth) {
   return "bearer" in auth ? { Authorization: `Bearer ${auth.bearer}` } : { "x-api-key": auth.apiKey };
 }
-function describeError(err) {
-  return err instanceof Error ? err.message : String(err);
-}
-function parseEnvelope(json) {
-  if (typeof json !== "object" || json === null || !("rows" in json)) {
-    throw new Error("invalid catalog response: missing rows");
-  }
-  const rows = CatalogSchema.parse(json.rows);
-  const rev = json.revision;
-  if (typeof rev === "string") return { rows, revision: rev };
-  return { rows };
+var EnvelopeSchema = z2.object({
+  rows: CatalogSchema,
+  revision: z2.string().optional()
+});
+function toEnvelope(data) {
+  if (data.rows.length === 0) throw new Error("invalid catalog response: no rows");
+  const envelope = { rows: data.rows };
+  if (data.revision !== void 0) envelope.revision = data.revision;
+  return envelope;
 }
 function logPrimed(logger, result) {
   const { origin: loggedOrigin, rowCount: loggedCount, revision: loggedRevision } = result;
@@ -2071,7 +2073,9 @@ async function fetchRemote(source, logger) {
   if (res.status === 304) return { kept: true };
   if (!res.ok) throw new Error(`catalog fetch failed with status ${res.status}`);
   const json = await res.json();
-  const { rows, revision: rev } = parseEnvelope(json);
+  const parsed = EnvelopeSchema.safeParse(json);
+  if (!parsed.success) throw new Error("invalid catalog response: missing rows");
+  const { rows, revision: rev } = toEnvelope(parsed.data);
   if (rev === void 0) return { rows, fromCache: false };
   return { rows, revision: rev, fromCache: false };
 }
@@ -2102,11 +2106,13 @@ async function prime(source, logger) {
     return result;
   } catch (err) {
     logger.warn("[modelkit] catalog remote failed, trying cache", err);
-    const error = describeError(err);
+    const error = err instanceof Error ? err.message : String(err);
     try {
       const cached = await source.cache?.get();
       if (!cached) throw new Error("no cached catalog");
-      const { rows, revision: rev } = parseEnvelope(JSON.parse(cached));
+      const cachedParsed = EnvelopeSchema.safeParse(JSON.parse(cached));
+      if (!cachedParsed.success) throw new Error("invalid catalog response: missing rows");
+      const { rows, revision: rev } = toEnvelope(cachedParsed.data);
       liveCatalog.replace(rows);
       liveState.origin = "last-good";
       liveState.revision = rev;
@@ -2146,19 +2152,18 @@ async function refresh(source, logger) {
   }
 }
 function primeCatalog(source) {
-  const memo = liveState.memo;
-  if (memo) return memo;
+  if (liveState.memo) return liveState.memo;
   const logger = source.logger ?? console;
-  liveState.memo = prime(source, logger).then((result) => {
+  const pending = prime(source, logger).then((result) => {
     const ttlMs = source.ttlMs ?? 3e5;
     if (ttlMs > 0 && liveState.timer === void 0) {
       liveState.timer = setInterval(() => void refresh(source, logger), ttlMs);
-      const maybeUnref = liveState.timer;
-      maybeUnref.unref?.();
+      liveState.timer.unref?.();
     }
     return result;
   });
-  return liveState.memo;
+  liveState.memo = pending;
+  return pending;
 }
 function resetLiveCatalog() {
   if (liveState.timer !== void 0) {