@shop-os/modelkit 0.1.10 → 0.2.0

package/dist/catalog.d.cts

@@ -1,4 +1,5 @@
 import { ImageModel, experimental_generateVideo } from 'ai';
+import { z } from 'zod';
 
 /**
  * Canonical vocabulary shared by every adapter. Adapters translate these
@@ -35,7 +36,7 @@ interface UpscaleOptions {
     faceEnhancementStrength?: number;
 }
 type ModelType = "text" | "image" | "video" | "audio" | "upscale" | "bg-remove";
-type Lifecycle = "active" | "hidden" | "deprecated" | "retired";
+type Lifecycle = "active" | "deprecated" | "retired";
 type AdapterId = "ai-sdk-text" | "google-image" | "openai-image" | "google-genai" | "ark" | "fal" | "replicate" | "prodia" | "higgsfield" | "xai-video";
 /** Gemini image safety threshold, per category, sent only when the caller opts in. */
 type ImageSafetySetting = {
@@ -234,10 +235,6 @@ interface CatalogDisplay {
 }
 /** 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. */
@@ -245,8 +242,6 @@ interface CatalogCapabilities {
     /** Text rows. `reasoning`: the model streams reasoning the UI should surface. */
     reasoning?: boolean;
     vision?: boolean;
-    tools?: boolean;
-    structuredOutput?: boolean;
     contextWindow?: number;
 }
 interface CatalogModel {
@@ -276,7 +271,6 @@ interface CatalogModel {
      */
     usage: {
         unit: UsageUnit;
-        modality: UsageModality;
         slug?: string;
         providerLabel?: string;
     };
@@ -424,11 +418,50 @@ declare class Catalog {
     }): CatalogModel[];
     /** Merge rows by id. Used for catalogOverride. */
     withOverrides(rows: CatalogModel[]): Catalog;
+    /** Atomically swap every row. Builds the maps first so a bad batch throws before anything changes. */
+    replace(rows: CatalogModel[]): void;
 }
 
 /** Seeded from Cowork, Space Builder and trigger-workflows. See catalog/*.ts. */
 declare const MODELS: CatalogModel[];
 
+declare const ADAPTER_IDS: readonly ["ai-sdk-text", "google-image", "openai-image", "google-genai", "ark", "fal", "replicate", "prodia", "higgsfield", "xai-video"];
+declare const CatalogModelSchema: z.ZodType<CatalogModel>;
+declare const CatalogSchema: z.ZodType<CatalogModel[]>;
+
+declare const liveCatalog: Catalog;
+
+interface CatalogCache {
+    get(): Promise<string | null>;
+    set(json: string): Promise<void>;
+}
+type CatalogAuth = {
+    bearer: string;
+} | {
+    apiKey: string;
+};
+interface CatalogSource {
+    baseUrl: string;
+    auth: CatalogAuth;
+    ttlMs?: number;
+    /** Abort a fetch after this many ms. Default 10 s. */
+    timeoutMs?: number;
+    cache?: CatalogCache;
+    fetch?: typeof fetch;
+    logger?: Pick<Console, "debug" | "info" | "warn" | "error">;
+}
+type CatalogOrigin = "remote" | "last-good" | "snapshot";
+interface PrimeCatalogResult {
+    origin: CatalogOrigin;
+    rowCount: number;
+    revision?: string;
+    error?: string;
+}
+/** Fetch, validate, swap into liveCatalog. Never throws. Second call returns the same promise. */
+declare function primeCatalog(source: CatalogSource): Promise<PrimeCatalogResult>;
+/** Test seam: stop the refresh timer and reset liveCatalog to MODELS and clear the memo. */
+declare function resetLiveCatalog(): void;
+
 declare const IMAGE_MODELS: CatalogModel[];
 
 declare const VIDEO_MODELS: CatalogModel[];
@@ -483,4 +516,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 { type AdapterEndpoints, type AdapterId, type AspectRatio, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogCapabilities, type CatalogDisplay, type CatalogModel, 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, 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 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, nearestAspectRatio, 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 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, 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, nearestAspectRatio, primeCatalog, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions };

package/dist/catalog.d.ts

@@ -1,4 +1,5 @@
 import { ImageModel, experimental_generateVideo } from 'ai';
+import { z } from 'zod';
 
 /**
  * Canonical vocabulary shared by every adapter. Adapters translate these
@@ -35,7 +36,7 @@ interface UpscaleOptions {
     faceEnhancementStrength?: number;
 }
 type ModelType = "text" | "image" | "video" | "audio" | "upscale" | "bg-remove";
-type Lifecycle = "active" | "hidden" | "deprecated" | "retired";
+type Lifecycle = "active" | "deprecated" | "retired";
 type AdapterId = "ai-sdk-text" | "google-image" | "openai-image" | "google-genai" | "ark" | "fal" | "replicate" | "prodia" | "higgsfield" | "xai-video";
 /** Gemini image safety threshold, per category, sent only when the caller opts in. */
 type ImageSafetySetting = {
@@ -234,10 +235,6 @@ interface CatalogDisplay {
 }
 /** 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. */
@@ -245,8 +242,6 @@ interface CatalogCapabilities {
     /** Text rows. `reasoning`: the model streams reasoning the UI should surface. */
     reasoning?: boolean;
     vision?: boolean;
-    tools?: boolean;
-    structuredOutput?: boolean;
     contextWindow?: number;
 }
 interface CatalogModel {
@@ -276,7 +271,6 @@ interface CatalogModel {
      */
     usage: {
         unit: UsageUnit;
-        modality: UsageModality;
         slug?: string;
         providerLabel?: string;
     };
@@ -424,11 +418,50 @@ declare class Catalog {
     }): CatalogModel[];
     /** Merge rows by id. Used for catalogOverride. */
     withOverrides(rows: CatalogModel[]): Catalog;
+    /** Atomically swap every row. Builds the maps first so a bad batch throws before anything changes. */
+    replace(rows: CatalogModel[]): void;
 }
 
 /** Seeded from Cowork, Space Builder and trigger-workflows. See catalog/*.ts. */
 declare const MODELS: CatalogModel[];
 
+declare const ADAPTER_IDS: readonly ["ai-sdk-text", "google-image", "openai-image", "google-genai", "ark", "fal", "replicate", "prodia", "higgsfield", "xai-video"];
+declare const CatalogModelSchema: z.ZodType<CatalogModel>;
+declare const CatalogSchema: z.ZodType<CatalogModel[]>;
+
+declare const liveCatalog: Catalog;
+
+interface CatalogCache {
+    get(): Promise<string | null>;
+    set(json: string): Promise<void>;
+}
+type CatalogAuth = {
+    bearer: string;
+} | {
+    apiKey: string;
+};
+interface CatalogSource {
+    baseUrl: string;
+    auth: CatalogAuth;
+    ttlMs?: number;
+    /** Abort a fetch after this many ms. Default 10 s. */
+    timeoutMs?: number;
+    cache?: CatalogCache;
+    fetch?: typeof fetch;
+    logger?: Pick<Console, "debug" | "info" | "warn" | "error">;
+}
+type CatalogOrigin = "remote" | "last-good" | "snapshot";
+interface PrimeCatalogResult {
+    origin: CatalogOrigin;
+    rowCount: number;
+    revision?: string;
+    error?: string;
+}
+/** Fetch, validate, swap into liveCatalog. Never throws. Second call returns the same promise. */
+declare function primeCatalog(source: CatalogSource): Promise<PrimeCatalogResult>;
+/** Test seam: stop the refresh timer and reset liveCatalog to MODELS and clear the memo. */
+declare function resetLiveCatalog(): void;
+
 declare const IMAGE_MODELS: CatalogModel[];
 
 declare const VIDEO_MODELS: CatalogModel[];
@@ -483,4 +516,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 { type AdapterEndpoints, type AdapterId, type AspectRatio, type AudioRequest, type AudioResult, type CallContext, Catalog, type CatalogCapabilities, type CatalogDisplay, type CatalogModel, 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, 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 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, nearestAspectRatio, 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 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, 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, nearestAspectRatio, primeCatalog, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions };