lumiverse-spindle-types 0.6.37 → 0.6.38
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/api.d.ts +95 -2
- package/dist/index.d.ts +1 -1
- package/dist/spindle-api.d.ts +14 -1
- package/package.json +1 -1
package/dist/api.d.ts
CHANGED
|
@@ -95,10 +95,24 @@ export interface InterceptorMatchDTO {
|
|
|
95
95
|
generationTypes?: InterceptorGenerationType[];
|
|
96
96
|
/** Terminal callbacks are never invoked for dry runs. */
|
|
97
97
|
isDryRun?: boolean;
|
|
98
|
+
/**
|
|
99
|
+
* Filter on this extension's own preset metadata namespace, the same value
|
|
100
|
+
* the callback receives as `InterceptorContextDTO.presetMetadata`
|
|
101
|
+
* (`preset.metadata[<manifest identifier>]` of the generation's preset).
|
|
102
|
+
* Another extension's or Loom's metadata is never visible to the filter.
|
|
103
|
+
*/
|
|
98
104
|
presetField?: {
|
|
105
|
+
/**
|
|
106
|
+
* Object keys walked from the namespace; an empty path tests the namespace
|
|
107
|
+
* itself. A missing key, an array, or a non-object along the way reads as
|
|
108
|
+
* `undefined`, as does a generation without a preset.
|
|
109
|
+
*/
|
|
99
110
|
path: string[];
|
|
111
|
+
/** `true` requires a value at `path` (`null` counts as a value); `false` requires none. */
|
|
100
112
|
exists?: boolean;
|
|
113
|
+
/** The value at `path` must be `Object.is`-equal to one of these scalars. */
|
|
101
114
|
oneOf?: InterceptorMatchScalar[];
|
|
115
|
+
/** The value at `path` must not be `Object.is`-equal to any of these scalars. */
|
|
102
116
|
notIn?: InterceptorMatchScalar[];
|
|
103
117
|
};
|
|
104
118
|
}
|
|
@@ -124,8 +138,18 @@ export interface InterceptorContextDTO {
|
|
|
124
138
|
readonly generationId: string;
|
|
125
139
|
readonly generationType: InterceptorGenerationType;
|
|
126
140
|
readonly isDryRun: boolean;
|
|
141
|
+
/**
|
|
142
|
+
* Preset that prompt assembly resolved for this generation, after request,
|
|
143
|
+
* profile, and binding resolution. `null` when the generation has no preset
|
|
144
|
+
* or skips assembly (an explicit `messages` request).
|
|
145
|
+
*/
|
|
127
146
|
readonly presetId: string | null;
|
|
128
|
-
/**
|
|
147
|
+
/**
|
|
148
|
+
* Deep clone of only this extension's own preset metadata namespace:
|
|
149
|
+
* `preset.metadata[<manifest identifier>]` of the preset in `presetId`, the
|
|
150
|
+
* key the preset editor's extension helper writes. `undefined` when that key
|
|
151
|
+
* is absent or there is no preset. Mutating it does not change the preset.
|
|
152
|
+
*/
|
|
129
153
|
readonly presetMetadata: unknown;
|
|
130
154
|
readonly personaId: string | null;
|
|
131
155
|
readonly characterId: string | null;
|
|
@@ -780,6 +804,43 @@ export type ImageGenCharacterLoraSelectionDTO = {
|
|
|
780
804
|
lora: ImageGenLoraEntryDTO;
|
|
781
805
|
base_tags?: string;
|
|
782
806
|
};
|
|
807
|
+
/** Saved native image prompt preset. Legacy entries without a kind are Main Presets. */
|
|
808
|
+
export interface ImageGenPromptPresetDTO {
|
|
809
|
+
id: string;
|
|
810
|
+
name: string;
|
|
811
|
+
mode: "custom" | "parsed_custom";
|
|
812
|
+
prompt: string;
|
|
813
|
+
negativePrompt?: string;
|
|
814
|
+
parserConnectionId?: string | null;
|
|
815
|
+
parserModel?: string;
|
|
816
|
+
parserParameters?: Record<string, unknown>;
|
|
817
|
+
kind?: "main" | "character" | "persona" | "captioning";
|
|
818
|
+
}
|
|
819
|
+
/** Read-only snapshot; discovery does not reconcile or change saved selections. */
|
|
820
|
+
export interface ImageGenPromptPresetsResultDTO {
|
|
821
|
+
activeId: string | null;
|
|
822
|
+
activeConnectionId: string | null;
|
|
823
|
+
/** Main Presets only, including legacy presets without a kind. */
|
|
824
|
+
presets: ImageGenPromptPresetDTO[];
|
|
825
|
+
}
|
|
826
|
+
/** Request-local ComfyUI mapped field values; unmapped node fields are ignored. */
|
|
827
|
+
export interface ImageGenComfyUIFieldValuesDTO extends Record<string, unknown> {
|
|
828
|
+
/** Custom field values keyed by `<nodeId>:<fieldName>`. */
|
|
829
|
+
custom?: Record<string, unknown>;
|
|
830
|
+
/**
|
|
831
|
+
* Primitive overrides keyed by `<nodeId>:<fieldName>`. Prompt and source-image
|
|
832
|
+
* injection take precedence. Mapped seed values of -1 are randomized per run.
|
|
833
|
+
*/
|
|
834
|
+
node_fields?: Record<string, string | number | boolean>;
|
|
835
|
+
}
|
|
836
|
+
/** Opt-in validation helper for native provider parameters and saved ComfyUI controls. */
|
|
837
|
+
export interface ImageGenNativeParametersDTO extends Record<string, unknown> {
|
|
838
|
+
/** Select a saved workflow for this request without changing the active workflow. */
|
|
839
|
+
workflow_id?: string;
|
|
840
|
+
/** Alias for workflow_id. */
|
|
841
|
+
workflowId?: string;
|
|
842
|
+
comfyui_field_values?: ImageGenComfyUIFieldValuesDTO;
|
|
843
|
+
}
|
|
783
844
|
/**
|
|
784
845
|
* Input for `spindle.imageGen.generateNative()`.
|
|
785
846
|
*
|
|
@@ -790,10 +851,19 @@ export type ImageGenCharacterLoraSelectionDTO = {
|
|
|
790
851
|
export interface ImageGenNativeRequestDTO {
|
|
791
852
|
/** Chat used for prompt/macro context and native generation lifecycle. */
|
|
792
853
|
chat_id: string;
|
|
854
|
+
/** Request-local connection override; does not change the user's active connection. */
|
|
855
|
+
connection_id?: string;
|
|
856
|
+
/** Persisted image owned by the user. ComfyUI workflows must map init_image. */
|
|
857
|
+
source_image_id?: string;
|
|
858
|
+
/** Video output selection requires a ComfyUI connection. Omit for legacy selection. */
|
|
859
|
+
output_media_type?: "image" | "video";
|
|
860
|
+
/** Select the ComfyUI output node for this request. */
|
|
861
|
+
output_node_id?: string;
|
|
793
862
|
/** Inline prompt. Optional when native settings/preset supply one. */
|
|
794
863
|
prompt?: string;
|
|
795
864
|
negativePrompt?: string;
|
|
796
865
|
promptMode?: "scene" | "custom" | "parsed_custom";
|
|
866
|
+
/** Use this preset's mode/parser configuration; a missing explicit preset is rejected. */
|
|
797
867
|
promptPresetId?: string | null;
|
|
798
868
|
/** Skip parser/scene rewriting and use the resolved prompt directly. */
|
|
799
869
|
skipParse?: boolean;
|
|
@@ -809,16 +879,35 @@ export interface ImageGenNativeRequestDTO {
|
|
|
809
879
|
extraBaseTags?: string;
|
|
810
880
|
/** Scale applied to the complete assembled LoRA stack. */
|
|
811
881
|
loraStrengthScale?: number;
|
|
812
|
-
/**
|
|
882
|
+
/**
|
|
883
|
+
* Provider parameters merged over the active native connection defaults.
|
|
884
|
+
* Use `satisfies ImageGenNativeParametersDTO` for opt-in ComfyUI validation.
|
|
885
|
+
*/
|
|
813
886
|
parameters?: Record<string, unknown>;
|
|
814
887
|
/** Omit the base64 payload while retaining persisted IDs/URL. */
|
|
815
888
|
includeDataUrl?: boolean;
|
|
889
|
+
/** Caller-chosen ID used to correlate progress and cancel an in-flight native job. */
|
|
816
890
|
clientJobId?: string;
|
|
817
891
|
promptGenerationTimeoutSeconds?: number;
|
|
818
892
|
generationTimeoutSeconds?: number;
|
|
819
893
|
/** For operator-scoped extensions. */
|
|
820
894
|
userId?: string;
|
|
821
895
|
}
|
|
896
|
+
/**
|
|
897
|
+
* Additional native image controls supported by QuickGen-capable hosts.
|
|
898
|
+
* Compose with WorkerToHost explicitly so existing exhaustive handlers remain valid.
|
|
899
|
+
* Both messages require image_gen permission and account scope.
|
|
900
|
+
*/
|
|
901
|
+
export type ImageGenNativeControlWorkerMessage = {
|
|
902
|
+
type: "image_gen_prompt_presets";
|
|
903
|
+
requestId: string;
|
|
904
|
+
userId?: string;
|
|
905
|
+
} | {
|
|
906
|
+
type: "image_gen_cancel_native";
|
|
907
|
+
requestId: string;
|
|
908
|
+
jobId: string;
|
|
909
|
+
userId?: string;
|
|
910
|
+
};
|
|
822
911
|
/** Result from `spindle.imageGen.generateNative()`. */
|
|
823
912
|
export interface ImageGenNativeResultDTO {
|
|
824
913
|
generated: boolean;
|
|
@@ -829,6 +918,10 @@ export interface ImageGenNativeResultDTO {
|
|
|
829
918
|
imageDataUrl?: string;
|
|
830
919
|
imageId?: string;
|
|
831
920
|
imageUrl?: string;
|
|
921
|
+
mediaType?: "image" | "video";
|
|
922
|
+
mimeType?: string;
|
|
923
|
+
/** Authenticated media URL; imageId/imageUrl remain available for compatibility. */
|
|
924
|
+
mediaUrl?: string;
|
|
832
925
|
jobId?: string;
|
|
833
926
|
}
|
|
834
927
|
/** Result from `spindle.imageGen.generate()` */
|
package/dist/index.d.ts
CHANGED
|
@@ -13,7 +13,7 @@ export { SpindleEvent, CoreEventType } from "./events.js";
|
|
|
13
13
|
export type { RuntimeStateRevisionDTO, RuntimeEventMetadataDTO, RuntimeCharacterDTO, RuntimeChatDTO, RuntimeMessageDTO, RuntimeStateSnapshotDTO, RuntimeStateCommandDTO, RuntimeStateAcknowledgementDTO, SpindleRuntimeStateAPI, } from "./runtime-state.js";
|
|
14
14
|
export type { SpindleFrontendRuntimeCapability } from "./frontend-capabilities.js";
|
|
15
15
|
export { ALL_FRONTEND_RUNTIME_CAPABILITIES, isValidFrontendRuntimeCapability, } from "./frontend-capabilities.js";
|
|
16
|
-
export type { LlmMessagePartDTO, LlmMessageDTO, LlmThinkingBlockDTO, SpindleUserRoleDTO, InterceptorGenerationType, InterceptorMatchScalar, InterceptorMatchDTO, InterceptorRegistrationMatchOptions, InterceptorRegistrationOptions, InterceptorContextDTO, InterceptorDisposer, InterceptorHandler, DeferredGuidanceDTO, InterceptorBreakdownEntryDTO, FinalResponseDTO, InterceptorResultDTO, MacroDefinitionDTO, MacroInvocationContextDTO, MacroResolveOptionsDTO, MacroResolveResultDTO, ToolRegistrationDTO, ToolSchemaDTO, ToolCallDTO, ToolDefinitionDTO, GenerationUsageDTO, GenerationResponseDTO, GenerationDispatchSourceDTO, ConnectionDispatchDescriptorDTO, GenerationRequestDTO, GenerationReasoningOverrideDTO, ReasoningEffortDTO, ReasoningSettingsDTO, ThinkingDisplayDTO, ConnectionReasoningBindingsDTO, ChatAppendGenerationOptionsDTO, ChatAppendMessageOptionsDTO, StreamChunkDTO, RequestInitDTO, ConnectionProfileDTO, PermissionDeniedDetail, PermissionChangedDetail, McpTransportTypeDTO, McpServerDTO, McpServerCreateDTO, McpToolDTO, McpServerStatusDTO, McpToolCallOptionsDTO, CharacterDTO, CharacterCreateDTO, CharacterAvatarUploadDTO, CharacterUpdateDTO, ChatDTO, ChatUpdateDTO, ChatSwitchedPayloadDTO, ChatChangedPayloadDTO, ChatForkedPayloadDTO, PromptVariableOptionDTO, PromptVariableDefDTO, PromptVariableTypeDTO, PromptVariableValueDTO, PromptVariableValuesDTO, PromptBlockRoleDTO, PromptBlockPositionDTO, PromptBlockCategoryModeDTO, PromptBlockPlacementDTO, PromptBlockPlacementBindingDTO, PromptBlockDTO, PromptBlockSnapshotDTO, PromptBlockCreateDTO, PromptBlockUpdateDTO, PromptBlockCategoryGroupDTO, HostResponseErrorDTO, UserPresetDTO, UserPresetCreateDTO, UserPresetUpdateDTO, WorldBookDTO, WorldBookCreateDTO, WorldBookUpdateDTO, WorldBookEntryDTO, WorldBookEntryCreateDTO, WorldBookEntryUpdateDTO, RegexPlacementDTO, RegexScopeDTO, RegexTargetDTO, RegexMacroModeDTO, RegexScriptDTO, RegexScriptCreateDTO, RegexScriptUpdateDTO, RegexScriptListOptionsDTO, RegexScriptActiveOptionsDTO, WorldInfoInterceptorEntryDTO, WorldInfoInterceptorMessageDTO, WorldInfoActivationSettingsDTO, WorldInfoActivationOverridesDTO, WorldInfoInterceptorRoleDTO, WorldInfoInterceptorPlacementDTO, WorldInfoInterceptorCtxDTO, WorldInfoInterceptorMutationDTO, WorldInfoInterceptorResultDTO, DatabankScopeDTO, DatabankDocumentStatusDTO, DatabankDTO, DatabankCreateDTO, DatabankUpdateDTO, DatabankDocumentDTO, DatabankDocumentCreateDTO, DatabankDocumentUpdateDTO, PersonaDTO, GlobalAddonDTO, GlobalAddonUpdateDTO, LumiaItemDTO, LoomItemCategoryDTO, LoomItemDTO, LoomToolDTO, LumiaDlcPackDTO, LumiaDlcCatalogDTO, PersonaCreateDTO, PersonaUpdateDTO, ActivatedWorldInfoEntryDTO, WorldBookSourceDTO, WorldInfoActivatedEventDTO, DryRunRequestDTO, DryRunResultDTO, AssembleRequestDTO, AssembleResultDTO, BoundPrefillAttachmentDTO, BoundAssembleRequestDTO, BoundAssemblySuccessDTO, BoundAssemblyFailureDTO, BoundAssemblyOutcomeDTO, QuietTrackedRequestDTO, QuietDispatchReceiptDTO, QuietTrackedResultDTO, AssemblyBreakdownEntryDTO, ActivationStatsDTO, MemoryStatsDTO, DryRunTokenCountDTO, ChatMemoryChunkDTO, ChatMemoryResultDTO, ImageGenConnectionDTO, ImageGenParameterSchemaDTO, ImageGenProviderDTO, ImageGenRequestDTO, ImageGenResultDTO, ImageGenLoraEntryDTO, ImageGenCharacterLoraSelectionDTO, ImageGenNativeRequestDTO, ImageGenNativeResultDTO, ImageGenStreamRequestDTO, ImageGenStreamStatusDTO, ImageGenStreamPreviewDTO, ImageGenStreamDoneDTO, ImageGenStreamEventDTO, ImageGetOptionsDTO, ImageDTO, ImageListOptionsDTO, ImageSpecificityDTO, ImageVideoCodecDTO, ImageUploadDTO, ImageUploadFromDataUrlOptionsDTO, MediaSourceDTO, MediaAudioFormatDTO, MediaVideoFormatDTO, MediaVideoCodecDTO, MediaAudioCodecDTO, MediaFitModeDTO, MediaTransformResultDTO, MediaConvertAudioRequestDTO, MediaConvertVideoRequestDTO, MediaTranscodeVideoRequestDTO, MediaRemoveAudioFromVideoRequestDTO, MediaAddAudioToVideoRequestDTO, MediaCreateVideoFromImageAndAudioRequestDTO, ThemeOverrideDTO, ThemeInfoDTO, ThemePaletteConfigDTO, ThemeVariablesConfigDTO, ColorExtractionResult, ColorRGB, ColorHSL, SpindleModalItemDTO, SpindleCommandDTO, SpindleCommandContextDTO, SpindleUIDrawerTabDTO, SpindleUISettingsTabDTO, FrontendProcessStateDTO, FrontendProcessExitReasonDTO, FrontendProcessSpawnOptionsDTO, FrontendProcessListOptionsDTO, FrontendProcessInfoDTO, FrontendProcessLifecycleEventDTO, FrontendProcessStopOptionsDTO, BackendProcessStateDTO, BackendProcessExitReasonDTO, BackendProcessSpawnOptionsDTO, BackendProcessListOptionsDTO, BackendProcessInfoDTO, BackendProcessLifecycleEventDTO, BackendProcessStopOptionsDTO, GenerationStartedPayloadDTO, StreamTokenPayloadDTO, GenerationEndedPayloadDTO, GenerationStoppedPayloadDTO, GenerationObserver, ChatMessageDTO, MessageSwipeAction, MessageSwipedPayloadDTO, SwipeEditedPayloadDTO, ToolInvocationPayloadDTO, TokenModelSourceDTO, TokenCountOptionsDTO, TokenCountResultDTO, SpindleUploadDTO, SharedRpcRequestContextDTO, SharedRpcEndpointPolicyDTO, MacroInterceptorPhase, MacroInterceptorCharacterEnvDTO, MacroInterceptorChatEnvDTO, MacroInterceptorEnvDTO, MacroInterceptorCtxDTO, MacroInterceptorResultDTO, MacroInterceptorRichResultDTO, MessageContentProcessorOrigin, MessageContentProcessorCtxDTO, MessageContentProcessorResultDTO, WebSearchProviderDTO, WebSearchSettingsDTO, WebSearchResultDTO, WebSearchDocumentDTO, WebSearchRequestDTO, WebSearchResponseDTO, WorkerToHost, HostToWorker, ProviderKind, ProviderDescriptor, ProviderBrokerSpec, ProviderKeyDTO, WorkerToHostProviderMessage, HostToWorkerProviderMessage, ProviderRuntimeMessage, BrokerRequest, BrokerResponse, ProviderManager, } from "./api.js";
|
|
16
|
+
export type { LlmMessagePartDTO, LlmMessageDTO, LlmThinkingBlockDTO, SpindleUserRoleDTO, InterceptorGenerationType, InterceptorMatchScalar, InterceptorMatchDTO, InterceptorRegistrationMatchOptions, InterceptorRegistrationOptions, InterceptorContextDTO, InterceptorDisposer, InterceptorHandler, DeferredGuidanceDTO, InterceptorBreakdownEntryDTO, FinalResponseDTO, InterceptorResultDTO, MacroDefinitionDTO, MacroInvocationContextDTO, MacroResolveOptionsDTO, MacroResolveResultDTO, ToolRegistrationDTO, ToolSchemaDTO, ToolCallDTO, ToolDefinitionDTO, GenerationUsageDTO, GenerationResponseDTO, GenerationDispatchSourceDTO, ConnectionDispatchDescriptorDTO, GenerationRequestDTO, GenerationReasoningOverrideDTO, ReasoningEffortDTO, ReasoningSettingsDTO, ThinkingDisplayDTO, ConnectionReasoningBindingsDTO, ChatAppendGenerationOptionsDTO, ChatAppendMessageOptionsDTO, StreamChunkDTO, RequestInitDTO, ConnectionProfileDTO, PermissionDeniedDetail, PermissionChangedDetail, McpTransportTypeDTO, McpServerDTO, McpServerCreateDTO, McpToolDTO, McpServerStatusDTO, McpToolCallOptionsDTO, CharacterDTO, CharacterCreateDTO, CharacterAvatarUploadDTO, CharacterUpdateDTO, ChatDTO, ChatUpdateDTO, ChatSwitchedPayloadDTO, ChatChangedPayloadDTO, ChatForkedPayloadDTO, PromptVariableOptionDTO, PromptVariableDefDTO, PromptVariableTypeDTO, PromptVariableValueDTO, PromptVariableValuesDTO, PromptBlockRoleDTO, PromptBlockPositionDTO, PromptBlockCategoryModeDTO, PromptBlockPlacementDTO, PromptBlockPlacementBindingDTO, PromptBlockDTO, PromptBlockSnapshotDTO, PromptBlockCreateDTO, PromptBlockUpdateDTO, PromptBlockCategoryGroupDTO, HostResponseErrorDTO, UserPresetDTO, UserPresetCreateDTO, UserPresetUpdateDTO, WorldBookDTO, WorldBookCreateDTO, WorldBookUpdateDTO, WorldBookEntryDTO, WorldBookEntryCreateDTO, WorldBookEntryUpdateDTO, RegexPlacementDTO, RegexScopeDTO, RegexTargetDTO, RegexMacroModeDTO, RegexScriptDTO, RegexScriptCreateDTO, RegexScriptUpdateDTO, RegexScriptListOptionsDTO, RegexScriptActiveOptionsDTO, WorldInfoInterceptorEntryDTO, WorldInfoInterceptorMessageDTO, WorldInfoActivationSettingsDTO, WorldInfoActivationOverridesDTO, WorldInfoInterceptorRoleDTO, WorldInfoInterceptorPlacementDTO, WorldInfoInterceptorCtxDTO, WorldInfoInterceptorMutationDTO, WorldInfoInterceptorResultDTO, DatabankScopeDTO, DatabankDocumentStatusDTO, DatabankDTO, DatabankCreateDTO, DatabankUpdateDTO, DatabankDocumentDTO, DatabankDocumentCreateDTO, DatabankDocumentUpdateDTO, PersonaDTO, GlobalAddonDTO, GlobalAddonUpdateDTO, LumiaItemDTO, LoomItemCategoryDTO, LoomItemDTO, LoomToolDTO, LumiaDlcPackDTO, LumiaDlcCatalogDTO, PersonaCreateDTO, PersonaUpdateDTO, ActivatedWorldInfoEntryDTO, WorldBookSourceDTO, WorldInfoActivatedEventDTO, DryRunRequestDTO, DryRunResultDTO, AssembleRequestDTO, AssembleResultDTO, BoundPrefillAttachmentDTO, BoundAssembleRequestDTO, BoundAssemblySuccessDTO, BoundAssemblyFailureDTO, BoundAssemblyOutcomeDTO, QuietTrackedRequestDTO, QuietDispatchReceiptDTO, QuietTrackedResultDTO, AssemblyBreakdownEntryDTO, ActivationStatsDTO, MemoryStatsDTO, DryRunTokenCountDTO, ChatMemoryChunkDTO, ChatMemoryResultDTO, ImageGenConnectionDTO, ImageGenParameterSchemaDTO, ImageGenProviderDTO, ImageGenRequestDTO, ImageGenResultDTO, ImageGenLoraEntryDTO, ImageGenCharacterLoraSelectionDTO, ImageGenNativeRequestDTO, ImageGenNativeResultDTO, ImageGenPromptPresetDTO, ImageGenPromptPresetsResultDTO, ImageGenComfyUIFieldValuesDTO, ImageGenNativeParametersDTO, ImageGenNativeControlWorkerMessage, ImageGenStreamRequestDTO, ImageGenStreamStatusDTO, ImageGenStreamPreviewDTO, ImageGenStreamDoneDTO, ImageGenStreamEventDTO, ImageGetOptionsDTO, ImageDTO, ImageListOptionsDTO, ImageSpecificityDTO, ImageVideoCodecDTO, ImageUploadDTO, ImageUploadFromDataUrlOptionsDTO, MediaSourceDTO, MediaAudioFormatDTO, MediaVideoFormatDTO, MediaVideoCodecDTO, MediaAudioCodecDTO, MediaFitModeDTO, MediaTransformResultDTO, MediaConvertAudioRequestDTO, MediaConvertVideoRequestDTO, MediaTranscodeVideoRequestDTO, MediaRemoveAudioFromVideoRequestDTO, MediaAddAudioToVideoRequestDTO, MediaCreateVideoFromImageAndAudioRequestDTO, ThemeOverrideDTO, ThemeInfoDTO, ThemePaletteConfigDTO, ThemeVariablesConfigDTO, ColorExtractionResult, ColorRGB, ColorHSL, SpindleModalItemDTO, SpindleCommandDTO, SpindleCommandContextDTO, SpindleUIDrawerTabDTO, SpindleUISettingsTabDTO, FrontendProcessStateDTO, FrontendProcessExitReasonDTO, FrontendProcessSpawnOptionsDTO, FrontendProcessListOptionsDTO, FrontendProcessInfoDTO, FrontendProcessLifecycleEventDTO, FrontendProcessStopOptionsDTO, BackendProcessStateDTO, BackendProcessExitReasonDTO, BackendProcessSpawnOptionsDTO, BackendProcessListOptionsDTO, BackendProcessInfoDTO, BackendProcessLifecycleEventDTO, BackendProcessStopOptionsDTO, GenerationStartedPayloadDTO, StreamTokenPayloadDTO, GenerationEndedPayloadDTO, GenerationStoppedPayloadDTO, GenerationObserver, ChatMessageDTO, MessageSwipeAction, MessageSwipedPayloadDTO, SwipeEditedPayloadDTO, ToolInvocationPayloadDTO, TokenModelSourceDTO, TokenCountOptionsDTO, TokenCountResultDTO, SpindleUploadDTO, SharedRpcRequestContextDTO, SharedRpcEndpointPolicyDTO, MacroInterceptorPhase, MacroInterceptorCharacterEnvDTO, MacroInterceptorChatEnvDTO, MacroInterceptorEnvDTO, MacroInterceptorCtxDTO, MacroInterceptorResultDTO, MacroInterceptorRichResultDTO, MessageContentProcessorOrigin, MessageContentProcessorCtxDTO, MessageContentProcessorResultDTO, WebSearchProviderDTO, WebSearchSettingsDTO, WebSearchResultDTO, WebSearchDocumentDTO, WebSearchRequestDTO, WebSearchResponseDTO, WorkerToHost, HostToWorker, ProviderKind, ProviderDescriptor, ProviderBrokerSpec, ProviderKeyDTO, WorkerToHostProviderMessage, HostToWorkerProviderMessage, ProviderRuntimeMessage, BrokerRequest, BrokerResponse, ProviderManager, } from "./api.js";
|
|
17
17
|
export { PERMISSION_DENIED_PREFIX } from "./api.js";
|
|
18
18
|
export type { ToolRegistration, JSONSchema } from "./tools.js";
|
|
19
19
|
export type { SpindleMessageElement, SpindleTextEditorOptions, SpindleTextEditorResult, SpindleDOMHelper, SpindleMountPoint, SpindleUploadFile, SpindleMessageTagIntercept, SpindleMessageTagInterceptorOptions, SpindleMessageWidgetOptions, PermissionRequestOptions, SpindleFrontendContext, SpindleFrontendContextV2, SpindleSettingsAPI, SpindleSettingsTabOptions, SpindleSettingsTabSection, SpindleSettingsTabHandle, SpindleStateSelectors, SpindleResizeController, SpindleGeometryAPI, SpindleHostSurfaceKind, SpindleHostSurfaceRef, SpindleHostActionJsonValue, SpindleHostActionParams, SpindleHostSurfaceInfo, SpindleHostSurfaceTarget, SpindleHostSurfaceTargetHandler, SpindleHostSurfaceAPI, SpindleComponentOverrideOptions, SpindleComponentOverrideHandle, SpindleDomDecoratorOptions, SpindleDomDecoratorHandle, SpindleMessageActionOptions, SpindleMessageActionHandle, SpindleFrontendWorldBooksAPI, SpindleFrontendTokensAPI, SpindleFrontendConnectionsAPI, SpindleFrontendChatsAPI, SpindleFrontendMessagesAPI, SpindleRecentChatsQuery, SpindleRecentChat, SpindleGroupedRecentChat, SpindleRecentChatsPage, SpindleFrontendModule, SpindleFrontendWidgetTarget, SpindleWidgetFrontendModule, SpindleFrontendTeardown, SpindleGuideDefinition, SpindleDrawerTabOptions, SpindleDrawerTabHandle, SpindleCharacterEditorTabOptions, SpindleCharacterEditorTabHandle, SpindleCharacterEditorState, SpindleCharacterEditorSaveOptions, SpindleCharacterEditorHelper, SpindlePresetEditorTabOptions, SpindlePresetEditorTabHandle, SpindlePresetEditorToolbarItemOptions, SpindlePresetEditorToolbarItemHandle, SpindlePresetEditorDraft, SpindlePresetEditorState, SpindlePresetEditorSaveOptions, SpindlePresetEditorHelper, SpindlePresetEditorBuiltinTabId, SpindlePresetEditorExtensionState, SpindlePresetEditorScopedHelper, SpindleFloatWidgetOptions, SpindleFloatWidgetHandle, SpindleDockEdge, SpindleDockPanelOptions, SpindleDockPanelHandle, SpindleAppMountOptions, SpindleAppMountHandle, SpindleInputBarActionOptions, SpindleInputBarActionHandle, SpindleSandboxFrameOptions, SpindleSandboxFrameHandle, SpindleSandboxMediaResource, SpindleSandboxAudioOptions, SpindleSandboxAudioHandle, SpindleSandboxAPI, SpindleContextMenuOptions, SpindleContextMenuItemDef, SpindleContextMenuResult, SpindleModalOptions, SpindleModalHandle, SpindleConfirmVariant, SpindleConfirmOptions, SpindleConfirmResult, SpindleUIDomActionEventType, SpindleUIKeyboardState, SpindleUIDrawerState, SpindleUISettingsState, SpindleUIDomActionDetail, SpindleUIDomActionBindingOptions, SpindleUIEventsHelper, SpindleFrontendProcessContext, SpindleFrontendProcessRegistry, SpindleDisplayResolver, SpindleDisplayResolverRegistry, SpindleDisplayContext, SpindleDisplayBodyArgs, SpindleDisplayTemplatesArgs, SpindleDisplayScriptsArgs, SpindleDisplayResolveResult, SpindleDisplayTemplatesResult, SpindleTabLocation, } from "./dom.js";
|
package/dist/spindle-api.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import type { SpindleHostDescriptorV1 } from "./host.js";
|
|
|
3
3
|
import type { SpindleDesktopAPI } from "./desktop-capture.js";
|
|
4
4
|
import type { SpindleTextEditorOptions, SpindleTextEditorResult } from "./dom.js";
|
|
5
5
|
import type { CouncilMemberContext, CouncilSettings } from "./council.js";
|
|
6
|
-
import type { LlmMessageDTO, InterceptorDisposer, InterceptorHandler, InterceptorRegistrationMatchOptions, InterceptorRegistrationOptions, MacroDefinitionDTO, MacroResolveOptionsDTO, MacroResolveResultDTO, ToolRegistrationDTO, GenerationRequestDTO, ChatAppendMessageOptionsDTO, RequestInitDTO, ConnectionProfileDTO, ConnectionDispatchDescriptorDTO, PermissionDeniedDetail, PermissionChangedDetail, CharacterDTO, CharacterCreateDTO, CharacterAvatarUploadDTO, CharacterUpdateDTO, ChatDTO, ChatUpdateDTO, UserPresetDTO, UserPresetCreateDTO, UserPresetUpdateDTO, PromptBlockSnapshotDTO, PromptBlockCreateDTO, PromptBlockUpdateDTO, PromptBlockCategoryGroupDTO, WorldBookDTO, WorldBookCreateDTO, WorldBookUpdateDTO, WorldBookEntryDTO, WorldBookEntryCreateDTO, WorldBookEntryUpdateDTO, RegexScriptDTO, RegexScriptCreateDTO, RegexScriptUpdateDTO, RegexScriptListOptionsDTO, RegexScriptActiveOptionsDTO, DatabankDTO, DatabankCreateDTO, DatabankUpdateDTO, DatabankDocumentDTO, DatabankDocumentCreateDTO, DatabankDocumentUpdateDTO, PersonaDTO, GlobalAddonDTO, GlobalAddonUpdateDTO, LumiaItemDTO, LumiaDlcCatalogDTO, PersonaCreateDTO, PersonaUpdateDTO, ActivatedWorldInfoEntryDTO, DryRunRequestDTO, DryRunResultDTO, AssembleRequestDTO, AssembleResultDTO, BoundAssembleRequestDTO, BoundAssemblyOutcomeDTO, QuietTrackedRequestDTO, QuietTrackedResultDTO, BrokerRequest, BrokerResponse, ChatMemoryResultDTO, ProviderManager, ImageGenRequestDTO, ImageGenResultDTO, ImageGenNativeRequestDTO, ImageGenNativeResultDTO, ImageGenStreamRequestDTO, ImageGenStreamEventDTO, ImageGenConnectionDTO, ImageGenProviderDTO, ImageGetOptionsDTO, ImageDTO, ImageListOptionsDTO, ImageUploadDTO, ImageUploadFromDataUrlOptionsDTO, MediaConvertAudioRequestDTO, MediaConvertVideoRequestDTO, MediaTranscodeVideoRequestDTO, MediaRemoveAudioFromVideoRequestDTO, MediaAddAudioToVideoRequestDTO, MediaCreateVideoFromImageAndAudioRequestDTO, MediaTransformResultDTO, ThemeOverrideDTO, ThemeInfoDTO, ThemePaletteConfigDTO, ThemeVariablesConfigDTO, ColorExtractionResult, SpindleUserRoleDTO, SpindleModalItemDTO, SpindleCommandDTO, SpindleCommandContextDTO, SpindleUIDrawerTabDTO, SpindleUISettingsTabDTO, FrontendProcessSpawnOptionsDTO, FrontendProcessListOptionsDTO, FrontendProcessInfoDTO, FrontendProcessLifecycleEventDTO, FrontendProcessStopOptionsDTO, BackendProcessSpawnOptionsDTO, BackendProcessListOptionsDTO, BackendProcessInfoDTO, BackendProcessLifecycleEventDTO, BackendProcessStopOptionsDTO, ChatChangedPayloadDTO, ChatForkedPayloadDTO, ChatMessageDTO, GenerationStartedPayloadDTO, StreamTokenPayloadDTO, GenerationEndedPayloadDTO, GenerationStoppedPayloadDTO, GenerationObserver, MessageSwipedPayloadDTO, SwipeEditedPayloadDTO, ToolInvocationPayloadDTO, StreamChunkDTO, TokenCountOptionsDTO, TokenCountResultDTO, SpindleUploadDTO, MacroInterceptorCtxDTO, MacroInterceptorResultDTO, WorldInfoInterceptorCtxDTO, WorldInfoInterceptorResultDTO, MessageContentProcessorCtxDTO, MessageContentProcessorResultDTO, SharedRpcRequestContextDTO, SharedRpcEndpointPolicyDTO, WebSearchRequestDTO, WebSearchResponseDTO, WebSearchSettingsDTO, McpServerDTO, McpServerCreateDTO, McpServerStatusDTO, McpToolDTO, McpToolCallOptionsDTO } from "./api.js";
|
|
6
|
+
import type { LlmMessageDTO, InterceptorDisposer, InterceptorHandler, InterceptorRegistrationMatchOptions, InterceptorRegistrationOptions, MacroDefinitionDTO, MacroResolveOptionsDTO, MacroResolveResultDTO, ToolRegistrationDTO, GenerationRequestDTO, ChatAppendMessageOptionsDTO, RequestInitDTO, ConnectionProfileDTO, ConnectionDispatchDescriptorDTO, PermissionDeniedDetail, PermissionChangedDetail, CharacterDTO, CharacterCreateDTO, CharacterAvatarUploadDTO, CharacterUpdateDTO, ChatDTO, ChatUpdateDTO, UserPresetDTO, UserPresetCreateDTO, UserPresetUpdateDTO, PromptBlockSnapshotDTO, PromptBlockCreateDTO, PromptBlockUpdateDTO, PromptBlockCategoryGroupDTO, WorldBookDTO, WorldBookCreateDTO, WorldBookUpdateDTO, WorldBookEntryDTO, WorldBookEntryCreateDTO, WorldBookEntryUpdateDTO, RegexScriptDTO, RegexScriptCreateDTO, RegexScriptUpdateDTO, RegexScriptListOptionsDTO, RegexScriptActiveOptionsDTO, DatabankDTO, DatabankCreateDTO, DatabankUpdateDTO, DatabankDocumentDTO, DatabankDocumentCreateDTO, DatabankDocumentUpdateDTO, PersonaDTO, GlobalAddonDTO, GlobalAddonUpdateDTO, LumiaItemDTO, LumiaDlcCatalogDTO, PersonaCreateDTO, PersonaUpdateDTO, ActivatedWorldInfoEntryDTO, DryRunRequestDTO, DryRunResultDTO, AssembleRequestDTO, AssembleResultDTO, BoundAssembleRequestDTO, BoundAssemblyOutcomeDTO, QuietTrackedRequestDTO, QuietTrackedResultDTO, BrokerRequest, BrokerResponse, ChatMemoryResultDTO, ProviderManager, ImageGenRequestDTO, ImageGenResultDTO, ImageGenNativeRequestDTO, ImageGenNativeResultDTO, ImageGenPromptPresetsResultDTO, ImageGenStreamRequestDTO, ImageGenStreamEventDTO, ImageGenConnectionDTO, ImageGenProviderDTO, ImageGetOptionsDTO, ImageDTO, ImageListOptionsDTO, ImageUploadDTO, ImageUploadFromDataUrlOptionsDTO, MediaConvertAudioRequestDTO, MediaConvertVideoRequestDTO, MediaTranscodeVideoRequestDTO, MediaRemoveAudioFromVideoRequestDTO, MediaAddAudioToVideoRequestDTO, MediaCreateVideoFromImageAndAudioRequestDTO, MediaTransformResultDTO, ThemeOverrideDTO, ThemeInfoDTO, ThemePaletteConfigDTO, ThemeVariablesConfigDTO, ColorExtractionResult, SpindleUserRoleDTO, SpindleModalItemDTO, SpindleCommandDTO, SpindleCommandContextDTO, SpindleUIDrawerTabDTO, SpindleUISettingsTabDTO, FrontendProcessSpawnOptionsDTO, FrontendProcessListOptionsDTO, FrontendProcessInfoDTO, FrontendProcessLifecycleEventDTO, FrontendProcessStopOptionsDTO, BackendProcessSpawnOptionsDTO, BackendProcessListOptionsDTO, BackendProcessInfoDTO, BackendProcessLifecycleEventDTO, BackendProcessStopOptionsDTO, ChatChangedPayloadDTO, ChatForkedPayloadDTO, ChatMessageDTO, GenerationStartedPayloadDTO, StreamTokenPayloadDTO, GenerationEndedPayloadDTO, GenerationStoppedPayloadDTO, GenerationObserver, MessageSwipedPayloadDTO, SwipeEditedPayloadDTO, ToolInvocationPayloadDTO, StreamChunkDTO, TokenCountOptionsDTO, TokenCountResultDTO, SpindleUploadDTO, MacroInterceptorCtxDTO, MacroInterceptorResultDTO, WorldInfoInterceptorCtxDTO, WorldInfoInterceptorResultDTO, MessageContentProcessorCtxDTO, MessageContentProcessorResultDTO, SharedRpcRequestContextDTO, SharedRpcEndpointPolicyDTO, WebSearchRequestDTO, WebSearchResponseDTO, WebSearchSettingsDTO, McpServerDTO, McpServerCreateDTO, McpServerStatusDTO, McpToolDTO, McpToolCallOptionsDTO } from "./api.js";
|
|
7
7
|
import type { ChatChunkDTO, ChatLinkAttachDTO, ChatLinkDTO, ChatMemoryWarmupResultDTO, CortexIngestionStatusDTO, CortexIngestionTelemetryDTO, CortexQueryDTO, CortexResultDTO, CortexUsageStatsDTO, LinkedCortexResultDTO, MemoryConsolidationDTO, MemoryCortexConfigDTO, MemoryEntityDTO, MemoryEntityStatusUpdateDTO, MemoryEntityUpsertDTO, MemoryRelationDTO, MemoryRelationUpsertDTO, MemorySalienceDTO, VaultChunkDTO, VaultCreateDTO, VaultDTO, VaultReindexResultDTO, VaultWithContentsDTO } from "./memories.js";
|
|
8
8
|
export interface FrontendProcessHandle {
|
|
9
9
|
/** Host-assigned process ID unique within the extension runtime. */
|
|
@@ -699,6 +699,19 @@ export interface SpindleAPI {
|
|
|
699
699
|
* connection-level generation semantics remain unchanged.
|
|
700
700
|
*/
|
|
701
701
|
generateNative(input: ImageGenNativeRequestDTO): Promise<ImageGenNativeResultDTO>;
|
|
702
|
+
/**
|
|
703
|
+
* Read Main Presets and active preset/connection IDs without changing settings.
|
|
704
|
+
* Requires image_gen permission and account scope. Optional because older
|
|
705
|
+
* hosts do not implement it; feature-detect before calling.
|
|
706
|
+
*/
|
|
707
|
+
getPromptPresets?(userId?: string): Promise<ImageGenPromptPresetsResultDTO>;
|
|
708
|
+
/**
|
|
709
|
+
* Cancel an in-flight native job owned by this extension and account.
|
|
710
|
+
* Returns false when no matching job exists. Requires image_gen permission;
|
|
711
|
+
* feature-detect on older hosts. Supply clientJobId when starting the job to
|
|
712
|
+
* know its ID before generateNative resolves.
|
|
713
|
+
*/
|
|
714
|
+
cancelNative?(jobId: string, userId?: string): Promise<boolean>;
|
|
702
715
|
/**
|
|
703
716
|
* Generate through a provider that supports WebSocket preview images and
|
|
704
717
|
* status updates (currently SwarmUI and ComfyUI). The terminal `done`
|