@shop-os/modelkit 0.2.19 → 0.2.20

package/dist/catalog.d.cts

@@ -191,6 +191,15 @@ interface ReferenceLimits {
     /** Per-video length caps (min/max each) and combined total for reference videos. */
     videoSeconds?: VideoSecondsLimits;
 }
+/** Whether a video row's output has sound: always, switchable (`supports: generateAudio`), or silent. */
+type AudioOutput = "always" | "optional" | "never";
+/** How a prompt points at reference N: "image N" numbering, a caption beside each image, or prose. */
+type ReferenceSyntax = "numbered" | "caption" | "descriptive";
+interface PromptConventions {
+    referenceSyntax: ReferenceSyntax;
+    /** Provider-documented prompt length limit, in characters. */
+    maxChars?: number;
+}
 interface ModelConstraints {
     aspectRatios?: AspectRatio[];
     sizes?: ImageSize[];
@@ -224,6 +233,10 @@ interface ModelConstraints {
         segmentSeconds: number;
         maxTotalSeconds: number;
     };
+    /** Whether the output has sound. Read it through `outputAudio(row)`, which tolerates bad data. */
+    audio?: AudioOutput;
+    /** Prompt conventions. Read them through `promptConventions(row)`, which fills the default. */
+    prompt?: PromptConventions;
 }
 /** JSON-compatible value. Provider options and raw payloads carry these, never `unknown`. */
 type JsonPrimitive = string | number | boolean | null;
@@ -647,6 +660,8 @@ declare const CatalogModelSchemaBase: z.ZodObject<{
             segmentSeconds: z.ZodNumber;
             maxTotalSeconds: z.ZodNumber;
         }, z.core.$loose>>;
+        audio: z.ZodOptional<z.ZodUnknown>;
+        prompt: z.ZodOptional<z.ZodUnknown>;
     }, z.core.$loose>;
     defaults: z.ZodObject<{
         references: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
@@ -919,6 +934,15 @@ declare function resolveImageOptions(model: CatalogModel, request: ImageRequest,
 declare function resolveVideoOptions(model: CatalogModel, request: VideoRequest, onUnsupported?: OnUnsupported): ResolveResult<VideoRequest>;
 declare function resolveAudioOptions(model: CatalogModel, request: AudioRequest, onUnsupported?: OnUnsupported): ResolveResult<AudioRequest>;
 
+declare const AUDIO_OUTPUTS: ("always" | "optional" | "never")[];
+declare const REFERENCE_SYNTAXES: ("numbered" | "caption" | "descriptive")[];
+declare function outputAudio(row: {
+    constraints: unknown;
+}): AudioOutput | undefined;
+declare function promptConventions(row: {
+    constraints: unknown;
+}): PromptConventions;
+
 /** Provider body or the lifted detail (Gemini blockReason, fal body.detail). */
 type ProviderErrorBody = string | JsonValue;
 type ModelKitErrorCode = "unknown_model" | "unsupported_option" | "missing_input" | "content_blocked" | "provider_rejected" | "timeout" | "auth" | "network" | "rate_limited";
@@ -954,4 +978,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 CatalogEnvelope, type CatalogModel, CatalogModelSchema, CatalogModelSchemaBase, type CatalogOrigin, CatalogSchema, type CatalogSource, type Exposure, ExposureSchema, 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 QuarantineResult, type ReferenceLimits, type RequiredInput, type RequiredKeyName, type ResolveResult, type Routing, SURFACES, type SupportedOption, type Surface, SurfaceSchema, 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 VideoSecondsLimits, type Warning, compareCatalogOrder, hasAwsCredentials, isListed, isListedOn, isModelKitError, liveCatalog, liveState, nearestAspectRatio, normalizeExposure, primeCatalog, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions, sortCatalogRows, videoLengthViolation };
+export { ADAPTER_IDS, AUDIO_OUTPUTS, type AdapterEndpoints, type AdapterId, type AspectRatio, type AudioOutput, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogAuth, type CatalogCache, type CatalogCapabilities, type CatalogDisplay, type CatalogEnvelope, type CatalogModel, CatalogModelSchema, CatalogModelSchemaBase, type CatalogOrigin, CatalogSchema, type CatalogSource, type Exposure, ExposureSchema, 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 PromptConventions, type ProviderErrorBody, type ProviderKeyName, type ProviderKeys, type ProviderOptionValue, type ProviderOptions, type QuarantineResult, REFERENCE_SYNTAXES, type ReferenceLimits, type ReferenceSyntax, type RequiredInput, type RequiredKeyName, type ResolveResult, type Routing, SURFACES, type SupportedOption, type Surface, SurfaceSchema, 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 VideoSecondsLimits, type Warning, compareCatalogOrder, hasAwsCredentials, isListed, isListedOn, isModelKitError, liveCatalog, liveState, nearestAspectRatio, normalizeExposure, outputAudio, primeCatalog, promptConventions, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions, sortCatalogRows, videoLengthViolation };

package/dist/catalog.d.ts

@@ -191,6 +191,15 @@ interface ReferenceLimits {
     /** Per-video length caps (min/max each) and combined total for reference videos. */
     videoSeconds?: VideoSecondsLimits;
 }
+/** Whether a video row's output has sound: always, switchable (`supports: generateAudio`), or silent. */
+type AudioOutput = "always" | "optional" | "never";
+/** How a prompt points at reference N: "image N" numbering, a caption beside each image, or prose. */
+type ReferenceSyntax = "numbered" | "caption" | "descriptive";
+interface PromptConventions {
+    referenceSyntax: ReferenceSyntax;
+    /** Provider-documented prompt length limit, in characters. */
+    maxChars?: number;
+}
 interface ModelConstraints {
     aspectRatios?: AspectRatio[];
     sizes?: ImageSize[];
@@ -224,6 +233,10 @@ interface ModelConstraints {
         segmentSeconds: number;
         maxTotalSeconds: number;
     };
+    /** Whether the output has sound. Read it through `outputAudio(row)`, which tolerates bad data. */
+    audio?: AudioOutput;
+    /** Prompt conventions. Read them through `promptConventions(row)`, which fills the default. */
+    prompt?: PromptConventions;
 }
 /** JSON-compatible value. Provider options and raw payloads carry these, never `unknown`. */
 type JsonPrimitive = string | number | boolean | null;
@@ -647,6 +660,8 @@ declare const CatalogModelSchemaBase: z.ZodObject<{
             segmentSeconds: z.ZodNumber;
             maxTotalSeconds: z.ZodNumber;
         }, z.core.$loose>>;
+        audio: z.ZodOptional<z.ZodUnknown>;
+        prompt: z.ZodOptional<z.ZodUnknown>;
     }, z.core.$loose>;
     defaults: z.ZodObject<{
         references: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
@@ -919,6 +934,15 @@ declare function resolveImageOptions(model: CatalogModel, request: ImageRequest,
 declare function resolveVideoOptions(model: CatalogModel, request: VideoRequest, onUnsupported?: OnUnsupported): ResolveResult<VideoRequest>;
 declare function resolveAudioOptions(model: CatalogModel, request: AudioRequest, onUnsupported?: OnUnsupported): ResolveResult<AudioRequest>;
 
+declare const AUDIO_OUTPUTS: ("always" | "optional" | "never")[];
+declare const REFERENCE_SYNTAXES: ("numbered" | "caption" | "descriptive")[];
+declare function outputAudio(row: {
+    constraints: unknown;
+}): AudioOutput | undefined;
+declare function promptConventions(row: {
+    constraints: unknown;
+}): PromptConventions;
+
 /** Provider body or the lifted detail (Gemini blockReason, fal body.detail). */
 type ProviderErrorBody = string | JsonValue;
 type ModelKitErrorCode = "unknown_model" | "unsupported_option" | "missing_input" | "content_blocked" | "provider_rejected" | "timeout" | "auth" | "network" | "rate_limited";
@@ -954,4 +978,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 CatalogEnvelope, type CatalogModel, CatalogModelSchema, CatalogModelSchemaBase, type CatalogOrigin, CatalogSchema, type CatalogSource, type Exposure, ExposureSchema, 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 QuarantineResult, type ReferenceLimits, type RequiredInput, type RequiredKeyName, type ResolveResult, type Routing, SURFACES, type SupportedOption, type Surface, SurfaceSchema, 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 VideoSecondsLimits, type Warning, compareCatalogOrder, hasAwsCredentials, isListed, isListedOn, isModelKitError, liveCatalog, liveState, nearestAspectRatio, normalizeExposure, primeCatalog, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions, sortCatalogRows, videoLengthViolation };
+export { ADAPTER_IDS, AUDIO_OUTPUTS, type AdapterEndpoints, type AdapterId, type AspectRatio, type AudioOutput, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogAuth, type CatalogCache, type CatalogCapabilities, type CatalogDisplay, type CatalogEnvelope, type CatalogModel, CatalogModelSchema, CatalogModelSchemaBase, type CatalogOrigin, CatalogSchema, type CatalogSource, type Exposure, ExposureSchema, 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 PromptConventions, type ProviderErrorBody, type ProviderKeyName, type ProviderKeys, type ProviderOptionValue, type ProviderOptions, type QuarantineResult, REFERENCE_SYNTAXES, type ReferenceLimits, type ReferenceSyntax, type RequiredInput, type RequiredKeyName, type ResolveResult, type Routing, SURFACES, type SupportedOption, type Surface, SurfaceSchema, 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 VideoSecondsLimits, type Warning, compareCatalogOrder, hasAwsCredentials, isListed, isListedOn, isModelKitError, liveCatalog, liveState, nearestAspectRatio, normalizeExposure, outputAudio, primeCatalog, promptConventions, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions, sortCatalogRows, videoLengthViolation };