@shop-os/modelkit 0.2.3 → 0.2.5

package/dist/index.d.cts

@@ -440,6 +440,7 @@ declare class Catalog {
     resolveId(idOrAlias: string): string | undefined;
     get(idOrAlias: string): CatalogModel | undefined;
     require(idOrAlias: string): CatalogModel;
+    /** Rows in picker order: `display.sortOrder` descending, then label. See `compareCatalogOrder`. */
     list(filter?: {
         type?: ModelType;
         lifecycle?: Lifecycle[];
@@ -450,6 +451,18 @@ declare class Catalog {
     replace(rows: CatalogModel[]): void;
 }
 
+/**
+ * Picker order for every surface: `display.sortOrder` descending (a higher
+ * number shows first), rows without one after the ordered ones, then `label`
+ * ascending (case-insensitive), then `id` so the order is total.
+ *
+ * pro-backend applies the same rule in SQL (`ORDER BY sortOrder DESC NULLS
+ * LAST, lower(label), id`); this comparator covers the snapshot and cache
+ * fallbacks and any consumer that sorts a subset.
+ */
+declare function compareCatalogOrder(a: CatalogModel, b: CatalogModel): number;
+declare function sortCatalogRows<T extends CatalogModel>(rows: readonly T[]): T[];
+
 /** Seeded from Cowork, Space Builder and trigger-workflows. See catalog/*.ts. */
 declare const MODELS: CatalogModel[];
 
@@ -748,4 +761,4 @@ declare function describeThrown(cause: unknown): ThrownErrorInfo;
 /** Add the AI SDK `GeneratedFile` accessors to adapter image bytes. base64 is computed on first read. */
 declare function toGeneratedImage(image: ImageBytes): GeneratedImage;
 
-export { ADAPTER_IDS, ADAPTER_KEYS, type Adapter, type AdapterContext, type AdapterEndpoints, type AdapterId, type AdapterRegistry, type AiTextProviderOptions, 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 CatalogTextModel, DEFAULT_ADAPTERS, type DefaultObjectOutput, type GeneratedImage, type ImageBytes, type ImageCallOptions, type ImageCallResult, type ImageQuality, type ImageRequest, type ImageResult, type ImageSafetySetting, type ImageSize, type JsonObject, JsonObjectSchema, type JsonPrimitive, type JsonValue, JsonValueSchema, type LanguageModelHandle, type Lifecycle, type LiveCatalogState, MODELS, type MediaPart, type MediaRef, type ModelConstraints, type ModelKit, type ModelKitConfig, ModelKitError, type ModelKitErrorCode, type ModelKitErrorInit, type ModelType, type ModelkitGenerateObjectOptions, type ModelkitGenerateTextOptions, type ModelkitStreamObjectOptions, type ModelkitStreamTextOptions, type ObjectOutput, type ObjectResult, 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, type TextMethods, type TextModelInstance, type UpscaleOptions, type UsageEvent, type UsageModality, type UsageUnit, type VideoCallJob, type VideoCallOptions, type VideoJob, type VideoModel, type VideoRequest, type VideoResolution, type VideoResult, type Warning, aiSdkTextAdapter, arkAdapter, aspectRatioToSize, classifyHttpError, createDefaultModelKit, createModelKit, describe, describeThrown, generateImage as experimental_generateImage, falAdapter, fileCatalogCache, generateAudio, generateImage, generateObject, generateText, generateVideo, googleGenaiAdapter, googleImageAdapter, higgsfieldAdapter, isModelKitError, keysFromEnv, languageModel, liveCatalog, liveState, mergeTextProviderOptions, nearestAspectRatio, openaiImageAdapter, passthroughTextModel, pollUntil, prepareMediaPart, primeCatalog, prodiaAdapter, readErrorBody, replicateAdapter, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveKeys, resolveVideoOptions, shouldRetry, sleep, streamObject, streamText, textUsageEvent, toGeneratedImage, withRetry, xaiVideoAdapter };
+export { ADAPTER_IDS, ADAPTER_KEYS, type Adapter, type AdapterContext, type AdapterEndpoints, type AdapterId, type AdapterRegistry, type AiTextProviderOptions, 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 CatalogTextModel, DEFAULT_ADAPTERS, type DefaultObjectOutput, type GeneratedImage, type ImageBytes, type ImageCallOptions, type ImageCallResult, type ImageQuality, type ImageRequest, type ImageResult, type ImageSafetySetting, type ImageSize, type JsonObject, JsonObjectSchema, type JsonPrimitive, type JsonValue, JsonValueSchema, type LanguageModelHandle, type Lifecycle, type LiveCatalogState, MODELS, type MediaPart, type MediaRef, type ModelConstraints, type ModelKit, type ModelKitConfig, ModelKitError, type ModelKitErrorCode, type ModelKitErrorInit, type ModelType, type ModelkitGenerateObjectOptions, type ModelkitGenerateTextOptions, type ModelkitStreamObjectOptions, type ModelkitStreamTextOptions, type ObjectOutput, type ObjectResult, 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, type TextMethods, type TextModelInstance, type UpscaleOptions, type UsageEvent, type UsageModality, type UsageUnit, type VideoCallJob, type VideoCallOptions, type VideoJob, type VideoModel, type VideoRequest, type VideoResolution, type VideoResult, type Warning, aiSdkTextAdapter, arkAdapter, aspectRatioToSize, classifyHttpError, compareCatalogOrder, createDefaultModelKit, createModelKit, describe, describeThrown, generateImage as experimental_generateImage, falAdapter, fileCatalogCache, generateAudio, generateImage, generateObject, generateText, generateVideo, googleGenaiAdapter, googleImageAdapter, higgsfieldAdapter, isModelKitError, keysFromEnv, languageModel, liveCatalog, liveState, mergeTextProviderOptions, nearestAspectRatio, openaiImageAdapter, passthroughTextModel, pollUntil, prepareMediaPart, primeCatalog, prodiaAdapter, readErrorBody, replicateAdapter, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveKeys, resolveVideoOptions, shouldRetry, sleep, sortCatalogRows, streamObject, streamText, textUsageEvent, toGeneratedImage, withRetry, xaiVideoAdapter };

package/dist/index.d.ts

@@ -440,6 +440,7 @@ declare class Catalog {
     resolveId(idOrAlias: string): string | undefined;
     get(idOrAlias: string): CatalogModel | undefined;
     require(idOrAlias: string): CatalogModel;
+    /** Rows in picker order: `display.sortOrder` descending, then label. See `compareCatalogOrder`. */
     list(filter?: {
         type?: ModelType;
         lifecycle?: Lifecycle[];
@@ -450,6 +451,18 @@ declare class Catalog {
     replace(rows: CatalogModel[]): void;
 }
 
+/**
+ * Picker order for every surface: `display.sortOrder` descending (a higher
+ * number shows first), rows without one after the ordered ones, then `label`
+ * ascending (case-insensitive), then `id` so the order is total.
+ *
+ * pro-backend applies the same rule in SQL (`ORDER BY sortOrder DESC NULLS
+ * LAST, lower(label), id`); this comparator covers the snapshot and cache
+ * fallbacks and any consumer that sorts a subset.
+ */
+declare function compareCatalogOrder(a: CatalogModel, b: CatalogModel): number;
+declare function sortCatalogRows<T extends CatalogModel>(rows: readonly T[]): T[];
+
 /** Seeded from Cowork, Space Builder and trigger-workflows. See catalog/*.ts. */
 declare const MODELS: CatalogModel[];
 
@@ -748,4 +761,4 @@ declare function describeThrown(cause: unknown): ThrownErrorInfo;
 /** Add the AI SDK `GeneratedFile` accessors to adapter image bytes. base64 is computed on first read. */
 declare function toGeneratedImage(image: ImageBytes): GeneratedImage;
 
-export { ADAPTER_IDS, ADAPTER_KEYS, type Adapter, type AdapterContext, type AdapterEndpoints, type AdapterId, type AdapterRegistry, type AiTextProviderOptions, 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 CatalogTextModel, DEFAULT_ADAPTERS, type DefaultObjectOutput, type GeneratedImage, type ImageBytes, type ImageCallOptions, type ImageCallResult, type ImageQuality, type ImageRequest, type ImageResult, type ImageSafetySetting, type ImageSize, type JsonObject, JsonObjectSchema, type JsonPrimitive, type JsonValue, JsonValueSchema, type LanguageModelHandle, type Lifecycle, type LiveCatalogState, MODELS, type MediaPart, type MediaRef, type ModelConstraints, type ModelKit, type ModelKitConfig, ModelKitError, type ModelKitErrorCode, type ModelKitErrorInit, type ModelType, type ModelkitGenerateObjectOptions, type ModelkitGenerateTextOptions, type ModelkitStreamObjectOptions, type ModelkitStreamTextOptions, type ObjectOutput, type ObjectResult, 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, type TextMethods, type TextModelInstance, type UpscaleOptions, type UsageEvent, type UsageModality, type UsageUnit, type VideoCallJob, type VideoCallOptions, type VideoJob, type VideoModel, type VideoRequest, type VideoResolution, type VideoResult, type Warning, aiSdkTextAdapter, arkAdapter, aspectRatioToSize, classifyHttpError, createDefaultModelKit, createModelKit, describe, describeThrown, generateImage as experimental_generateImage, falAdapter, fileCatalogCache, generateAudio, generateImage, generateObject, generateText, generateVideo, googleGenaiAdapter, googleImageAdapter, higgsfieldAdapter, isModelKitError, keysFromEnv, languageModel, liveCatalog, liveState, mergeTextProviderOptions, nearestAspectRatio, openaiImageAdapter, passthroughTextModel, pollUntil, prepareMediaPart, primeCatalog, prodiaAdapter, readErrorBody, replicateAdapter, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveKeys, resolveVideoOptions, shouldRetry, sleep, streamObject, streamText, textUsageEvent, toGeneratedImage, withRetry, xaiVideoAdapter };
+export { ADAPTER_IDS, ADAPTER_KEYS, type Adapter, type AdapterContext, type AdapterEndpoints, type AdapterId, type AdapterRegistry, type AiTextProviderOptions, 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 CatalogTextModel, DEFAULT_ADAPTERS, type DefaultObjectOutput, type GeneratedImage, type ImageBytes, type ImageCallOptions, type ImageCallResult, type ImageQuality, type ImageRequest, type ImageResult, type ImageSafetySetting, type ImageSize, type JsonObject, JsonObjectSchema, type JsonPrimitive, type JsonValue, JsonValueSchema, type LanguageModelHandle, type Lifecycle, type LiveCatalogState, MODELS, type MediaPart, type MediaRef, type ModelConstraints, type ModelKit, type ModelKitConfig, ModelKitError, type ModelKitErrorCode, type ModelKitErrorInit, type ModelType, type ModelkitGenerateObjectOptions, type ModelkitGenerateTextOptions, type ModelkitStreamObjectOptions, type ModelkitStreamTextOptions, type ObjectOutput, type ObjectResult, 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, type TextMethods, type TextModelInstance, type UpscaleOptions, type UsageEvent, type UsageModality, type UsageUnit, type VideoCallJob, type VideoCallOptions, type VideoJob, type VideoModel, type VideoRequest, type VideoResolution, type VideoResult, type Warning, aiSdkTextAdapter, arkAdapter, aspectRatioToSize, classifyHttpError, compareCatalogOrder, createDefaultModelKit, createModelKit, describe, describeThrown, generateImage as experimental_generateImage, falAdapter, fileCatalogCache, generateAudio, generateImage, generateObject, generateText, generateVideo, googleGenaiAdapter, googleImageAdapter, higgsfieldAdapter, isModelKitError, keysFromEnv, languageModel, liveCatalog, liveState, mergeTextProviderOptions, nearestAspectRatio, openaiImageAdapter, passthroughTextModel, pollUntil, prepareMediaPart, primeCatalog, prodiaAdapter, readErrorBody, replicateAdapter, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveKeys, resolveVideoOptions, shouldRetry, sleep, sortCatalogRows, streamObject, streamText, textUsageEvent, toGeneratedImage, withRetry, xaiVideoAdapter };

package/dist/index.js

@@ -27,6 +27,22 @@ function isModelKitError(err) {
   return err instanceof ModelKitError;
 }
 
+// src/catalog/order.ts
+function compareCatalogOrder(a, b) {
+  const sa = a.display?.sortOrder;
+  const sb = b.display?.sortOrder;
+  if (sa !== void 0 && sb !== void 0 && sa !== sb) return sb - sa;
+  if (sa !== void 0 && sb === void 0) return -1;
+  if (sa === void 0 && sb !== void 0) return 1;
+  return compareText(a.label.toLowerCase(), b.label.toLowerCase()) || compareText(a.id, b.id);
+}
+function compareText(a, b) {
+  return a < b ? -1 : a > b ? 1 : 0;
+}
+function sortCatalogRows(rows) {
+  return [...rows].sort(compareCatalogOrder);
+}
+
 // src/catalog/registry.ts
 var Catalog = class _Catalog {
   byId = /* @__PURE__ */ new Map();
@@ -83,11 +99,12 @@ var Catalog = class _Catalog {
     }
     return model;
   }
+  /** Rows in picker order: `display.sortOrder` descending, then label. See `compareCatalogOrder`. */
   list(filter = {}) {
     const lifecycles = filter.lifecycle ?? ["active"];
     return [...this.byId.values()].filter(
       (m) => (filter.type ? m.type === filter.type : true) && lifecycles.includes(m.lifecycle)
-    );
+    ).sort(compareCatalogOrder);
   }
   /** Merge rows by id. Used for catalogOverride. */
   withOverrides(rows) {
@@ -264,7 +281,6 @@ 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."
     }
   },
@@ -299,7 +315,6 @@ 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."
     }
   },
@@ -2057,13 +2072,14 @@ function toEnvelope(data) {
   if (data.revision !== void 0) envelope.revision = data.revision;
   return envelope;
 }
+function describeError(err) {
+  return err instanceof Error ? err.message : String(err);
+}
 function logPrimed(logger, result) {
-  const { origin: loggedOrigin, rowCount: loggedCount, revision: loggedRevision } = result;
-  logger.info("[modelkit] catalog primed", {
-    origin: loggedOrigin,
-    rowCount: loggedCount,
-    revision: loggedRevision
-  });
+  const revision = result.revision === void 0 ? "" : ` revision=${result.revision}`;
+  logger.info(
+    `[modelkit] catalog primed origin=${result.origin} rowCount=${result.rowCount}${revision}`
+  );
 }
 async function fetchRemote(source, logger) {
   const fetchImpl = source.fetch ?? globalThis.fetch;
@@ -2087,7 +2103,7 @@ async function writeCache(source, logger, rows, rev) {
   try {
     await source.cache.set(JSON.stringify({ rows, revision: rev }));
   } catch (err) {
-    logger.warn("[modelkit] catalog cache write failed", err);
+    logger.warn(`[modelkit] catalog cache write failed: ${describeError(err)}`);
   }
 }
 async function prime(source, logger) {
@@ -2108,8 +2124,8 @@ async function prime(source, logger) {
     logPrimed(logger, result);
     return result;
   } catch (err) {
-    logger.warn("[modelkit] catalog remote failed, trying cache", err);
-    const error = err instanceof Error ? err.message : String(err);
+    logger.warn(`[modelkit] catalog remote failed, trying cache: ${describeError(err)}`);
+    const error = describeError(err);
     try {
       const cached = await source.cache?.get();
       if (!cached) throw new Error("no cached catalog");
@@ -2128,7 +2144,9 @@ async function prime(source, logger) {
       logPrimed(logger, result);
       return result;
     } catch (cacheErr) {
-      logger.warn("[modelkit] catalog cache failed, using snapshot", cacheErr);
+      logger.warn(
+        `[modelkit] catalog cache failed, using snapshot: ${describeError(cacheErr)}`
+      );
       liveCatalog.replace([...MODELS]);
       liveState.origin = "snapshot";
       liveState.revision = void 0;
@@ -2151,7 +2169,9 @@ async function refresh(source, logger) {
     liveState.revision = fetched.revision;
     await writeCache(source, logger, fetched.rows, fetched.revision);
   } catch (err) {
-    logger.warn("[modelkit] catalog refresh failed, keeping current rows", err);
+    logger.warn(
+      `[modelkit] catalog refresh failed, keeping current rows: ${describeError(err)}`
+    );
   }
 }
 function primeCatalog(source) {
@@ -7335,6 +7355,7 @@ export {
   arkAdapter,
   aspectRatioToSize,
   classifyHttpError,
+  compareCatalogOrder,
   createDefaultModelKit,
   createModelKit,
   describe,
@@ -7372,6 +7393,7 @@ export {
   resolveVideoOptions,
   shouldRetry,
   sleep,
+  sortCatalogRows,
   streamObject,
   streamText,
   textUsageEvent,