@degreesign/chat 1.6.0 → 1.7.1

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { ChatModelId, ChatStatus, LlmBackend, LlmPhase, LlmRole, LlmStatus, WebSearchProvider } from './enums';
+import type { ChatModelId, ChatPreloadField, ChatStatus, DescriptionEnhancedStage, EstimateOperation, LlmBackend, LlmPhase, LlmRole, LlmStatus, WebSearchProvider } from './enums';
 /** Host-owned chat message */
 interface ChatMessage {
     role: LlmRole;
@@ -257,10 +257,99 @@ interface ChatInput {
     onStatus?: (snapshot: ChatStatusSnapshot) => void;
 }
 /** Model preload request */
-type ChatPreloadInput = Pick<ChatInput, `model` | `limits` | `logging` | `onStatus`>;
+type ChatPreloadInput = Pick<ChatInput, ChatPreloadField>;
 /** Stop request or model */
 type CancelChat = () => void;
-/** Described image result */
+/** Seconds estimated per operation */
+interface EstimateEntry {
+    operation: EstimateOperation;
+    /** Seconds */
+    est: number;
+}
+/** Estimate handed to the caller */
+interface EstimateReport {
+    /** Sum of breakdown, seconds */
+    totalEst: number;
+    /** Per-operation seconds, call order */
+    breakdown: EstimateEntry[];
+}
+/** Options shared by every call */
+interface CallOptions {
+    /** Stop request */
+    signal?: AbortSignal;
+    /** Budget overrides */
+    limits?: Partial<LlmLimits>;
+    /** Logging option, off */
+    logging?: boolean;
+    /** Status change callback */
+    onStatus?: (snapshot: ChatStatusSnapshot) => void;
+    /** Duration estimate callback */
+    onEstimate?: (estimate: EstimateReport) => void;
+}
+/** One image description request */
+interface DescribeImageInput extends CallOptions {
+    /** One image URL */
+    image: string;
+    /** Additional rules */
+    systemRulesOverride?: string;
+    /** Generation speed callback */
+    onSpeed?: (tokensPerSecond: number) => void;
+    /** Streamed text callback */
+    onText?: (text: string) => void;
+}
+/** English text enhancement request */
+interface DescriptionEnhancedInput extends CallOptions {
+    /** English description */
+    descriptionEN: string;
+    /** Target language name */
+    targetLanguage: string;
+    /** Target language code */
+    targetCode: string;
+    /** Whether tags are generated */
+    withTags?: boolean;
+    /** Whether description is translated */
+    withDescription?: boolean;
+    /** Text model override */
+    model?: ChatModelId;
+    /** Running stage callback */
+    onStage?: (stage: DescriptionEnhancedStage) => void;
+    /** Generation speed callback */
+    onSpeed?: (tokensPerSecond: number) => void;
+    /** Streamed text callback */
+    onText?: (text: string, stage: DescriptionEnhancedStage) => void;
+}
+/** Gallery tag with translations */
+interface ImageTag {
+    /** English tag */
+    en: string;
+    /** Translation keyed by language code */
+    [code: string]: string;
+}
+/** Stored tags translation request */
+interface TranslateTagsInput extends CallOptions {
+    /** Tags to translate */
+    tags: ImageTag[];
+    /** Target language name */
+    targetLanguage: string;
+    /** Target language code */
+    targetCode: string;
+    /** Text model override */
+    model?: ChatModelId;
+    /** Streamed text callback */
+    onText?: (text: string) => void;
+}
+/** Enhanced English description */
+interface DescriptionEnhanced {
+    /** Translated description, English fallback */
+    description: string;
+    /** Whether translation succeeded */
+    translated: boolean;
+    /** English and translated tags */
+    tags: ImageTag[];
+    /** Suggestive content flag, undefined unknown */
+    nsfw?: boolean;
+}
+/** @deprecated to be removed after Nov 2027 */
 interface ImageDescription {
     /** Vision description */
     descriptionEN: string;
@@ -269,7 +358,7 @@ interface ImageDescription {
     /** Description duration */
     durationMs: number;
 }
-/** One batch image description request */
+/** @deprecated to be removed after Nov 2027 */
 interface DescribeImagesInput {
     /** Target description language */
     targetLanguage: string;
@@ -292,7 +381,7 @@ interface DescribeImagesInput {
     /** Additional rules */
     additionalRules?: string;
 }
-/** Batch translation request */
+/** @deprecated to be removed after Nov 2027 */
 interface DescribeTranslatedInput {
     /** Ordered English descriptions */
     descriptions: string[];
@@ -745,4 +834,4 @@ interface ImageSize {
     width: number;
     height: number;
 }
-export type { ChatMessage, ChatTool, ChatToolCall, ChatToolResult, ChatToolSchema, ChatToolValue, WebSearchConfig, WebSearchResult, WebSearchSettings, FiatSnapshot, CryptoSnapshot, PriceSnapshot, PriceSections, PriceCoin, PriceFeed, CurrencyResult, CalculationResult, WikipediaPage, WikipediaResponse, DuckDuckGoTopic, DuckDuckGoResponse, ChatModel, LlmLimits, ChatStatusSnapshot, ChatInput, ChatPreloadInput, ChatState, CancelChat, ImageDescription, DescribeImagesInput, DescribeTranslatedInput, WllamaAssets, LitertAssets, GpuBuffer, GpuDevice, GpuWasm, GpuThrottleParams, GpuNavigator, MobileNavigator, ActiveCall, RuntimeDeps, RuntimeLoadParams, RuntimeLoadWaiter, RuntimeChatParams, StoredPart, StoredFilePart, StoredModel, StoredModelMeta, ResumePlan, StoreDownloadParams, ModelStore, Runtime, EngineChatParams, StartLlmParams, LlmRuntime, LlmEngine, EngineMessage, ImageSize, EngineContentPart, WllamaContentPart, WllamaMessage, LitertContentPart, LitertMessage, LitertEngine, LitertModule, LitertSettings, LitertSettingsParams, LitertSession, LitertChatParams, StreamLitertParams, EngineDelta, EngineTimings, EnginePromptProgress, EngineChunk, StreamReplyParams, EngineRunParams, };
+export type { ChatMessage, ChatTool, ChatToolCall, ChatToolResult, ChatToolSchema, ChatToolValue, WebSearchConfig, WebSearchResult, WebSearchSettings, FiatSnapshot, CryptoSnapshot, PriceSnapshot, PriceSections, PriceCoin, PriceFeed, CurrencyResult, CalculationResult, WikipediaPage, WikipediaResponse, DuckDuckGoTopic, DuckDuckGoResponse, ChatModel, LlmLimits, ChatStatusSnapshot, ChatInput, ChatPreloadInput, ChatState, CancelChat, CallOptions, EstimateEntry, EstimateReport, DescribeImageInput, DescriptionEnhancedInput, DescriptionEnhancedStage, DescriptionEnhanced, ImageTag, TranslateTagsInput, ImageDescription, DescribeImagesInput, DescribeTranslatedInput, WllamaAssets, LitertAssets, GpuBuffer, GpuDevice, GpuWasm, GpuThrottleParams, GpuNavigator, MobileNavigator, ActiveCall, RuntimeDeps, RuntimeLoadParams, RuntimeLoadWaiter, RuntimeChatParams, StoredPart, StoredFilePart, StoredModel, StoredModelMeta, ResumePlan, StoreDownloadParams, ModelStore, Runtime, EngineChatParams, StartLlmParams, LlmRuntime, LlmEngine, EngineMessage, ImageSize, EngineContentPart, WllamaContentPart, WllamaMessage, LitertContentPart, LitertMessage, LitertEngine, LitertModule, LitertSettings, LitertSettingsParams, LitertSession, LitertChatParams, StreamLitertParams, EngineDelta, EngineTimings, EnginePromptProgress, EngineChunk, StreamReplyParams, EngineRunParams, };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@degreesign/chat",
-    "version": "1.6.0",
+    "version": "1.7.1",
     "description": "Headless on-device AI chat for browsers and Node with wllama CPU and LiteRT WebGPU engines",
     "main": "dist/node/chat.node.min.js",
     "module": "dist/browser/chat.min.mjs",
@@ -64,6 +64,7 @@
         "dist/"
     ],
     "dependencies": {
+        "@degreesign/storage": "^1.1.6",
         "@degreesign/utils": "^1.0.5",
         "@litert-lm/core": "0.19.0-nightly.20261024",
         "@wllama/wllama": "^3.8.1",