@shop-os/modelkit 0.2.24 → 0.2.25

package/CHANGELOG.md

@@ -9,6 +9,12 @@ header in the release PR.
 
 ## [Unreleased]
 
+## [0.2.25] - Unreleased
+
+### Added
+- Third key set `sloosh` (ENG-2990). `CallContext.tier` is now `KeyTier = "pro" | "enterprise" | "sloosh"` and `ModelKitConfig.keys.sloosh` holds the keys (`keysFromEnv(env, "SLOOSH_")`). A `sloosh` call uses `keys.sloosh` only: a missing key throws `ModelKitError` code `auth` and never falls back to the pro key. Enterprise keeps its fall-back-to-pro rule. `createDefaultModelKit` gives the sloosh key set the pro AWS credentials when it has none of its own (one shared Bedrock identity), for keys read from the environment and for keys passed in `config.keys`.
+- `missingTierKeys(config, tier, names)`; `missingEnterpriseKeys` delegates to it.
+
 ## [0.2.24] - Unreleased
 
 ### Added

package/README.md

@@ -51,7 +51,7 @@ await kit.generateText({
 await clip.cleanup?.();
 ```
 
-Keys come from `process.env` by default: bare names for pro (`OPENAI_API_KEY`, `FAL_KEY`, `ARK_API_KEY` ...) and the `ENTERPRISE_` prefix for enterprise. Pass `keys: { pro, enterprise }` to override.
+Keys come from `process.env` by default: bare names for pro (`OPENAI_API_KEY`, `FAL_KEY`, `ARK_API_KEY` ...), the `ENTERPRISE_` prefix for enterprise and the `SLOOSH_` prefix for sloosh. Pass `keys: { pro, enterprise, sloosh }` to override. `tier: "sloosh"` uses the sloosh keys only: a missing key is a `ModelKitError` with code `auth`, never a fallback to pro.
 
 ## Browser-safe catalog
 

package/dist/catalog.d.cts

@@ -437,6 +437,8 @@ type ProviderKeys = Partial<Record<ProviderKeyName, string>> & {
         }>;
     };
 };
+/** Which key set a call uses. Enterprise falls back to pro; sloosh never falls back. */
+type KeyTier = "pro" | "enterprise" | "sloosh";
 /** Key names a call can require, including the Bedrock credentials object. */
 type RequiredKeyName = ProviderKeyName | "aws";
 /** True when region is set AND (apiKey OR credentialProvider OR both static keys). */
@@ -468,6 +470,7 @@ interface ModelKitConfig {
     keys: {
         pro: ProviderKeys;
         enterprise?: ProviderKeys;
+        sloosh?: ProviderKeys;
     };
     routing?: Routing;
     /** Provider base-url overrides; unset entries use each adapter's documented default. */
@@ -480,8 +483,8 @@ interface ModelKitConfig {
     logger?: Pick<Console, "debug" | "info" | "warn" | "error">;
 }
 interface CallContext {
-    /** "enterprise" picks keys.enterprise when every key for the provider is set, else falls back to pro. */
-    tier?: "pro" | "enterprise";
+    /** "enterprise" picks keys.enterprise when every key for the provider is set, else falls back to pro. "sloosh" uses keys.sloosh only and never falls back. */
+    tier?: KeyTier;
     signal?: AbortSignal;
     /** Media retries after the initial request. Set 0 when a durable host owns recovery.
      * Unset preserves adapter defaults. Successful pending-job polls are not retries.
@@ -992,4 +995,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, 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, billedAudio, compareCatalogOrder, hasAwsCredentials, isListed, isListedOn, isModelKitError, liveCatalog, liveState, nearestAspectRatio, normalizeExposure, outputAudio, primeCatalog, promptConventions, 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 KeyTier, 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, billedAudio, compareCatalogOrder, hasAwsCredentials, isListed, isListedOn, isModelKitError, liveCatalog, liveState, nearestAspectRatio, normalizeExposure, outputAudio, primeCatalog, promptConventions, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions, sortCatalogRows, videoLengthViolation };

package/dist/catalog.d.ts

@@ -437,6 +437,8 @@ type ProviderKeys = Partial<Record<ProviderKeyName, string>> & {
         }>;
     };
 };
+/** Which key set a call uses. Enterprise falls back to pro; sloosh never falls back. */
+type KeyTier = "pro" | "enterprise" | "sloosh";
 /** Key names a call can require, including the Bedrock credentials object. */
 type RequiredKeyName = ProviderKeyName | "aws";
 /** True when region is set AND (apiKey OR credentialProvider OR both static keys). */
@@ -468,6 +470,7 @@ interface ModelKitConfig {
     keys: {
         pro: ProviderKeys;
         enterprise?: ProviderKeys;
+        sloosh?: ProviderKeys;
     };
     routing?: Routing;
     /** Provider base-url overrides; unset entries use each adapter's documented default. */
@@ -480,8 +483,8 @@ interface ModelKitConfig {
     logger?: Pick<Console, "debug" | "info" | "warn" | "error">;
 }
 interface CallContext {
-    /** "enterprise" picks keys.enterprise when every key for the provider is set, else falls back to pro. */
-    tier?: "pro" | "enterprise";
+    /** "enterprise" picks keys.enterprise when every key for the provider is set, else falls back to pro. "sloosh" uses keys.sloosh only and never falls back. */
+    tier?: KeyTier;
     signal?: AbortSignal;
     /** Media retries after the initial request. Set 0 when a durable host owns recovery.
      * Unset preserves adapter defaults. Successful pending-job polls are not retries.
@@ -992,4 +995,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, 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, billedAudio, compareCatalogOrder, hasAwsCredentials, isListed, isListedOn, isModelKitError, liveCatalog, liveState, nearestAspectRatio, normalizeExposure, outputAudio, primeCatalog, promptConventions, 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 KeyTier, 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, billedAudio, compareCatalogOrder, hasAwsCredentials, isListed, isListedOn, isModelKitError, liveCatalog, liveState, nearestAspectRatio, normalizeExposure, outputAudio, primeCatalog, promptConventions, resetLiveCatalog, resolveAudioOptions, resolveImageOptions, resolveOptions, resolveVideoOptions, sortCatalogRows, videoLengthViolation };

package/dist/index.cjs

@@ -81,6 +81,7 @@ __export(index_exports, {
   liveCatalog: () => liveCatalog,
   liveState: () => liveState,
   mergeTextProviderOptions: () => mergeTextProviderOptions,
+  missingTierKeys: () => missingTierKeys,
   nearestAspectRatio: () => nearestAspectRatio,
   normalizeExposure: () => normalizeExposure,
   openaiImageAdapter: () => openaiImageAdapter,
@@ -8095,10 +8096,22 @@ function hasAll(keys, names) {
 function hasKey(keys, name) {
   return hasAll(keys, [name]);
 }
+function missingTierKeys(config, tier, names) {
+  return names.filter((name) => !hasAll(config.keys[tier], [name]));
+}
 function missingEnterpriseKeys(config, names) {
-  return names.filter((name) => !hasAll(config.keys.enterprise, [name]));
+  return missingTierKeys(config, "enterprise", names);
 }
 function resolveKeys(config, names, tier = "pro") {
+  if (tier === "sloosh") {
+    if (names.length === 0) return config.keys.sloosh ?? {};
+    if (hasAll(config.keys.sloosh, names)) return config.keys.sloosh;
+    throw new ModelKitError({
+      code: "auth",
+      message: `Missing Sloosh API key for ${names.join(", ")}`,
+      retryable: false
+    });
+  }
   if (tier === "enterprise" && hasAll(config.keys.enterprise, names))
     return config.keys.enterprise;
   if (names.length > 0 && !hasAll(config.keys.pro, names)) {
@@ -8287,6 +8300,7 @@ function resolveAnthropicTransport(model, config, tier, warn) {
   const preferred = preferredAnthropicTransport(model, config.routing ?? {});
   const usable = (transport) => {
     const name = transport === "bedrock" ? "aws" : "anthropic";
+    if (tier === "sloosh") return hasKey(config.keys.sloosh, name);
     return hasKey(config.keys.pro, name) || tier === "enterprise" && hasKey(config.keys.enterprise, name);
   };
   if (usable(preferred)) return preferred;
@@ -8868,11 +8882,19 @@ function createModelKit(config, adapters) {
 }
 
 // src/default.ts
+function withSharedAws(keys) {
+  const { pro, sloosh } = keys;
+  if (!sloosh || sloosh.aws || !pro.aws) return keys;
+  return { ...keys, sloosh: { ...sloosh, aws: pro.aws } };
+}
 function createDefaultModelKit(config = {}) {
-  const keys = config.keys ?? {
-    pro: keysFromEnv(process.env),
-    enterprise: keysFromEnv(process.env, "ENTERPRISE_")
-  };
+  const keys = withSharedAws(
+    config.keys ?? {
+      pro: keysFromEnv(process.env),
+      enterprise: keysFromEnv(process.env, "ENTERPRISE_"),
+      sloosh: keysFromEnv(process.env, "SLOOSH_")
+    }
+  );
   return createModelKit({ ...config, keys }, DEFAULT_ADAPTERS);
 }
 var generateText2 = (options, call) => createDefaultModelKit().generateText(options, call);
@@ -8937,6 +8959,7 @@ var describe = (modelId) => createDefaultModelKit().describe(modelId);
   liveCatalog,
   liveState,
   mergeTextProviderOptions,
+  missingTierKeys,
   nearestAspectRatio,
   normalizeExposure,
   openaiImageAdapter,