@shop-os/modelkit 0.1.6 → 0.1.8

package/dist/index.d.cts

@@ -171,6 +171,10 @@ interface ModelConstraints {
         min: number;
         max: number;
     } | number[];
+    /** Curated UI choices when `durations` is a range; `resolveOptions` ignores it. */
+    durationPresets?: number[];
+    /** Curated quality choices for rows whose `supports` includes "quality". */
+    qualityOptions?: string[];
     references?: ReferenceLimits;
     requires?: RequiredInput[];
     supports?: SupportedOption[];
@@ -200,6 +204,35 @@ type ProviderOptions = {
 type UsageUnit = "tokens" | "images" | "seconds" | "reported_cost_usd" | "compute_seconds";
 type UsageModality = "TEXT" | "IMAGE" | "VIDEO" | "AUDIO";
 type PricingKind = "token" | "image_size" | "video_per_second" | "flat";
+/** What a model picker shows for a row. Free of any surface-specific ids. */
+interface CatalogDisplay {
+    /** Vendor as the UI names it: "google", "openai", "meta", "bytedance", "xai", "kuaishou", ... */
+    provider: string;
+    /** One or two sentences for the picker card. */
+    description: string;
+    /** CDN URL of the vendor or model logo. */
+    logo?: string;
+    /** Chat picker cost bucket: 1 = cheapest tier (Haiku/Flash/mini), 2 = Sonnet class, 3 = Opus/Pro/frontier. */
+    costTier?: 1 | 2 | 3;
+    /** Chat picker highlight flag. */
+    recommended?: boolean;
+}
+/** Capability flags a UI keys off. Absent means false / unknown. */
+interface CatalogCapabilities {
+    /** Image rows: generates from a prompt alone. */
+    imageGenerate?: boolean;
+    /** Image rows: edits or conditions on reference images. */
+    imageEdit?: boolean;
+    /** Video rows: takes an existing video as the thing to edit or extend. */
+    acceptsSourceVideo?: boolean;
+    /** Video rows: first/last frames and reference images are mutually exclusive inputs. */
+    framesExcludeReferences?: boolean;
+    /** Text rows. */
+    vision?: boolean;
+    tools?: boolean;
+    structuredOutput?: boolean;
+    contextWindow?: number;
+}
 interface CatalogModel {
     /** Canonical id. Equals the pricing key in pro-backend credit_pricing_* tables. */
     id: string;
@@ -211,6 +244,11 @@ interface CatalogModel {
     providerModelId: string;
     lifecycle: Lifecycle;
     replacedBy?: string;
+    /**
+     * "catalog" = offered in product pickers (Creative Studio, chat, Space Builder);
+     * "internal" = callable by id only.
+     */
+    exposure: "catalog" | "internal";
     constraints: ModelConstraints;
     defaults: Partial<Omit<ImageRequest, "model" | "prompt"> & Omit<VideoRequest, "model" | "prompt"> & Omit<AudioRequest, "model" | "prompt">>;
     providerOptions?: ProviderOptions;
@@ -219,6 +257,9 @@ interface CatalogModel {
         modality: UsageModality;
     };
     pricingKind: PricingKind;
+    /** Required on every `active` row so a picker can render it without a hand-written catalog. */
+    display?: CatalogDisplay;
+    capabilities?: CatalogCapabilities;
 }
 interface Warning {
     code: "ratio_coerced" | "ratio_dropped" | "size_coerced" | "resolution_coerced" | "duration_coerced" | "references_trimmed" | "option_ignored";
@@ -629,4 +670,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_KEYS, type Adapter, type AdapterContext, type AdapterEndpoints, type AdapterId, type AdapterRegistry, type AiTextProviderOptions, type AspectRatio, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogModel, 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, 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 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, generateAudio, generateImage, generateObject, generateText, generateVideo, googleGenaiAdapter, googleImageAdapter, higgsfieldAdapter, isModelKitError, keysFromEnv, languageModel, mergeTextProviderOptions, nearestAspectRatio, openaiImageAdapter, passthroughTextModel, pollUntil, prepareMediaPart, prodiaAdapter, readErrorBody, replicateAdapter, resolveAudioOptions, resolveImageOptions, resolveKeys, resolveVideoOptions, shouldRetry, sleep, streamObject, streamText, textUsageEvent, toGeneratedImage, withRetry, xaiVideoAdapter };
+export { ADAPTER_KEYS, type Adapter, type AdapterContext, type AdapterEndpoints, type AdapterId, type AdapterRegistry, type AiTextProviderOptions, type AspectRatio, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogCapabilities, type CatalogDisplay, type CatalogModel, 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, 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 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, generateAudio, generateImage, generateObject, generateText, generateVideo, googleGenaiAdapter, googleImageAdapter, higgsfieldAdapter, isModelKitError, keysFromEnv, languageModel, mergeTextProviderOptions, nearestAspectRatio, openaiImageAdapter, passthroughTextModel, pollUntil, prepareMediaPart, prodiaAdapter, readErrorBody, replicateAdapter, resolveAudioOptions, resolveImageOptions, resolveKeys, resolveVideoOptions, shouldRetry, sleep, streamObject, streamText, textUsageEvent, toGeneratedImage, withRetry, xaiVideoAdapter };

package/dist/index.d.ts

@@ -171,6 +171,10 @@ interface ModelConstraints {
         min: number;
         max: number;
     } | number[];
+    /** Curated UI choices when `durations` is a range; `resolveOptions` ignores it. */
+    durationPresets?: number[];
+    /** Curated quality choices for rows whose `supports` includes "quality". */
+    qualityOptions?: string[];
     references?: ReferenceLimits;
     requires?: RequiredInput[];
     supports?: SupportedOption[];
@@ -200,6 +204,35 @@ type ProviderOptions = {
 type UsageUnit = "tokens" | "images" | "seconds" | "reported_cost_usd" | "compute_seconds";
 type UsageModality = "TEXT" | "IMAGE" | "VIDEO" | "AUDIO";
 type PricingKind = "token" | "image_size" | "video_per_second" | "flat";
+/** What a model picker shows for a row. Free of any surface-specific ids. */
+interface CatalogDisplay {
+    /** Vendor as the UI names it: "google", "openai", "meta", "bytedance", "xai", "kuaishou", ... */
+    provider: string;
+    /** One or two sentences for the picker card. */
+    description: string;
+    /** CDN URL of the vendor or model logo. */
+    logo?: string;
+    /** Chat picker cost bucket: 1 = cheapest tier (Haiku/Flash/mini), 2 = Sonnet class, 3 = Opus/Pro/frontier. */
+    costTier?: 1 | 2 | 3;
+    /** Chat picker highlight flag. */
+    recommended?: boolean;
+}
+/** Capability flags a UI keys off. Absent means false / unknown. */
+interface CatalogCapabilities {
+    /** Image rows: generates from a prompt alone. */
+    imageGenerate?: boolean;
+    /** Image rows: edits or conditions on reference images. */
+    imageEdit?: boolean;
+    /** Video rows: takes an existing video as the thing to edit or extend. */
+    acceptsSourceVideo?: boolean;
+    /** Video rows: first/last frames and reference images are mutually exclusive inputs. */
+    framesExcludeReferences?: boolean;
+    /** Text rows. */
+    vision?: boolean;
+    tools?: boolean;
+    structuredOutput?: boolean;
+    contextWindow?: number;
+}
 interface CatalogModel {
     /** Canonical id. Equals the pricing key in pro-backend credit_pricing_* tables. */
     id: string;
@@ -211,6 +244,11 @@ interface CatalogModel {
     providerModelId: string;
     lifecycle: Lifecycle;
     replacedBy?: string;
+    /**
+     * "catalog" = offered in product pickers (Creative Studio, chat, Space Builder);
+     * "internal" = callable by id only.
+     */
+    exposure: "catalog" | "internal";
     constraints: ModelConstraints;
     defaults: Partial<Omit<ImageRequest, "model" | "prompt"> & Omit<VideoRequest, "model" | "prompt"> & Omit<AudioRequest, "model" | "prompt">>;
     providerOptions?: ProviderOptions;
@@ -219,6 +257,9 @@ interface CatalogModel {
         modality: UsageModality;
     };
     pricingKind: PricingKind;
+    /** Required on every `active` row so a picker can render it without a hand-written catalog. */
+    display?: CatalogDisplay;
+    capabilities?: CatalogCapabilities;
 }
 interface Warning {
     code: "ratio_coerced" | "ratio_dropped" | "size_coerced" | "resolution_coerced" | "duration_coerced" | "references_trimmed" | "option_ignored";
@@ -629,4 +670,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_KEYS, type Adapter, type AdapterContext, type AdapterEndpoints, type AdapterId, type AdapterRegistry, type AiTextProviderOptions, type AspectRatio, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogModel, 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, 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 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, generateAudio, generateImage, generateObject, generateText, generateVideo, googleGenaiAdapter, googleImageAdapter, higgsfieldAdapter, isModelKitError, keysFromEnv, languageModel, mergeTextProviderOptions, nearestAspectRatio, openaiImageAdapter, passthroughTextModel, pollUntil, prepareMediaPart, prodiaAdapter, readErrorBody, replicateAdapter, resolveAudioOptions, resolveImageOptions, resolveKeys, resolveVideoOptions, shouldRetry, sleep, streamObject, streamText, textUsageEvent, toGeneratedImage, withRetry, xaiVideoAdapter };
+export { ADAPTER_KEYS, type Adapter, type AdapterContext, type AdapterEndpoints, type AdapterId, type AdapterRegistry, type AiTextProviderOptions, type AspectRatio, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogCapabilities, type CatalogDisplay, type CatalogModel, 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, 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 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, generateAudio, generateImage, generateObject, generateText, generateVideo, googleGenaiAdapter, googleImageAdapter, higgsfieldAdapter, isModelKitError, keysFromEnv, languageModel, mergeTextProviderOptions, nearestAspectRatio, openaiImageAdapter, passthroughTextModel, pollUntil, prepareMediaPart, prodiaAdapter, readErrorBody, replicateAdapter, resolveAudioOptions, resolveImageOptions, resolveKeys, resolveVideoOptions, shouldRetry, sleep, streamObject, streamText, textUsageEvent, toGeneratedImage, withRetry, xaiVideoAdapter };