lumiverse-spindle-types 0.6.41 → 0.6.42

package/dist/api.d.ts

@@ -3333,7 +3333,7 @@ export interface ProviderManager {
         key: ProviderKeyDTO;
     }) => void): () => void;
 }
-export type WorkerToHost = import("./desktop-capture.js").DesktopCaptureWorkerMessage | {
+export type WorkerToHost = import("./file-transfers.js").FileTransferWorkerMessage | import("./desktop-capture.js").DesktopCaptureWorkerMessage | {
     type: "subscribe_event";
     event: string;
 } | {

package/dist/dom.d.ts

@@ -1,4 +1,5 @@
 import type { SpindleSTTAPI } from "./speech-to-text.js";
+import type { SpindleFileDownloadAPI } from "./file-transfers.js";
 import type { ChatDTO, ChatMessageDTO, ChatUpdateDTO, ConnectionProfileDTO, LlmMessageDTO, PromptBlockDTO, PromptVariableValuesDTO, RequestInitDTO, TokenCountOptionsDTO, TokenCountResultDTO, WorldBookCreateDTO, WorldBookDTO, WorldBookEntryCreateDTO, WorldBookEntryDTO, WorldBookEntryUpdateDTO, WorldBookUpdateDTO } from "./api.js";
 import type { SpindleComponentsHelper } from "./components.js";
 import type { SpindleHostDescriptorV1, SpindleHostLocaleAPI } from "./host.js";
@@ -1042,6 +1043,8 @@ export interface SpindleRecentChatsPage<TRow = SpindleRecentChat> {
 }
 /** Context object provided to frontend extension modules */
 export interface SpindleFrontendContext {
+    /** Native downloads of completed backend files. Available with file-transfers-v1. */
+    readonly files: SpindleFileDownloadAPI;
     /** Host-managed STT. Feature-detect speech-to-text-v1; unavailable on older hosts. */
     readonly stt?: SpindleSTTAPI;
     /** Per-document routing identity, available with frontend-session-origin-v1. */

package/dist/file-transfers.d.ts

@@ -0,0 +1,157 @@
+/** Maximum bytes in a worker read/write chunk; process one chunk at a time. */
+export declare const SPINDLE_FILE_CHUNK_BYTES: number;
+/** Per-file and per-installation/user aggregate staged storage ceiling. */
+export declare const SPINDLE_FILE_MAX_BYTES: number;
+/** Default disk reservation for downloads, generated files, and ZIP output. */
+export declare const SPINDLE_FILE_DEFAULT_MAX_BYTES: number;
+/** Inactivity lifetime; active readers and archive inputs are pinned. */
+export declare const SPINDLE_FILE_TTL_MS: number;
+/** Maximum staged file count per installation/user and archive entry count. */
+export declare const SPINDLE_FILE_MAX_COUNT = 10000;
+/** Opaque host-owned file reference. Paths and complete archive bytes stay on the host. */
+export interface SpindleFileRef {
+    fileId: string;
+    fileName: string;
+    size: number;
+    mimeType: string;
+}
+/** A completed staged file or tus upload owned by this extension and user. */
+export type SpindleFileSource = {
+    fileId: string;
+} | {
+    uploadId: string;
+};
+export interface FileOperationOptions {
+    /** Required for operator-scoped extensions; inferred for user-scoped extensions. */
+    userId?: string;
+    /** Cancels the producer and cleans up partial output; rejects with AbortError. */
+    signal?: AbortSignal;
+}
+export interface FileFetchOptions extends FileOperationOptions {
+    headers?: Record<string, string>;
+    /** Default: download.bin. */
+    fileName?: string;
+    /** Maximum actual response bytes and disk reservation. Default: 5 GiB; maximum: 100 GiB. */
+    maxBytes?: number;
+    /** Default: 30 minutes; maximum: 1 hour. Includes body consumption. */
+    timeoutMs?: number;
+}
+export interface SpindleFileCreateInput {
+    fileName: string;
+    /** Exact final byte length. Specify size or maxBytes, never both. */
+    size?: number;
+    /** Output budget for unknown-length producers. Default: 5 GiB. */
+    maxBytes?: number;
+    mimeType?: string;
+    userId?: string;
+}
+export interface SpindleFileChunk {
+    data: Uint8Array;
+    offset: number;
+    /** Total file length, not the length of this chunk. */
+    size: number;
+    eof: boolean;
+}
+export interface SpindleArchiveEntry {
+    /** Safe relative ZIP file name. Directory records and duplicate names reject. */
+    name: string;
+    source: SpindleFileSource;
+    /** Skip compression for already compressed assets. */
+    store?: boolean;
+}
+export interface ArchiveCreateOptions extends FileOperationOptions {
+    /** Default: export.zip. */
+    fileName?: string;
+    /** Output budget. Default: 5 GiB; maximum: 100 GiB. */
+    maxBytes?: number;
+}
+export interface ArchiveExtractOptions extends FileOperationOptions {
+    /** Exact ZIP file names to extract. Omit for all files; an empty list extracts none. */
+    entries?: string[];
+    /** Total expansion limit and disk reservation. Default/maximum: 20 GiB. */
+    maxDecompressedBytes?: number;
+}
+export interface SpindleArchiveExtractedEntry {
+    /** Original relative entry name, including its archive directories. */
+    name: string;
+    file: SpindleFileRef;
+}
+/** Available with file-transfers-v1. All files are scoped to the installation, user, and worker lifetime. */
+export interface SpindleFilesAPI {
+    /** GET through the host to disk. Requires cors_proxy; rejects non-success HTTP statuses. */
+    fetch(url: string, options?: FileFetchOptions): Promise<SpindleFileRef>;
+    /** Reserve a byte budget and create an incomplete file for sequential writes. */
+    create(input: SpindleFileCreateInput): Promise<SpindleFileRef>;
+    /** Write 1–SPINDLE_FILE_CHUNK_BYTES bytes at the current offset. Returns the next offset. */
+    writeChunk(fileId: string, offset: number, data: Uint8Array, userId?: string): Promise<number>;
+    /** Verify the byte budget/exact size, release unused capacity, and make the file immutable. */
+    finish(fileId: string, userId?: string): Promise<SpindleFileRef>;
+    /** Read at most SPINDLE_FILE_CHUNK_BYTES from a completed file or upload. */
+    readChunk(source: SpindleFileSource, offset: number, userId?: string): Promise<SpindleFileChunk>;
+    /** Delete an idle file. Unknown/expired/foreign ids return false; active files reject. */
+    delete(fileId: string, userId?: string): Promise<boolean>;
+    /** Relative attachment URL requiring the owning user's session cookie. */
+    getDownloadUrl(fileId: string, userId?: string): Promise<string>;
+}
+/** Host-side ZIP/ZIP64 processing with bounded memory and disk-backed output. */
+export interface SpindleArchivesAPI {
+    create(entries: SpindleArchiveEntry[], options?: ArchiveCreateOptions): Promise<SpindleFileRef>;
+    /** Validate safe names, expansion, entry sizes, and CRC32; return staged file references. */
+    extract(source: SpindleFileSource, options?: ArchiveExtractOptions): Promise<SpindleArchiveExtractedEntry[]>;
+}
+export interface SpindleFileDownloadAPI {
+    /** Start a native browser/WebView attachment download without assembling a JavaScript Blob. */
+    download(fileId: string): void;
+}
+/** Signals stay in the worker; cancellation crosses the wire by operation id. */
+export type FileTransferWorkerMessage = {
+    type: "files_fetch";
+    requestId: string;
+    url: string;
+    options: Omit<FileFetchOptions, "signal">;
+} | {
+    type: "files_create";
+    requestId: string;
+    input: SpindleFileCreateInput;
+} | {
+    type: "files_write_chunk";
+    requestId: string;
+    fileId: string;
+    offset: number;
+    data: Uint8Array;
+    userId?: string;
+} | {
+    type: "files_finish";
+    requestId: string;
+    fileId: string;
+    userId?: string;
+} | {
+    type: "files_delete";
+    requestId: string;
+    fileId: string;
+    userId?: string;
+} | {
+    type: "files_download_url";
+    requestId: string;
+    fileId: string;
+    userId?: string;
+} | {
+    type: "files_read_chunk";
+    requestId: string;
+    source: SpindleFileSource;
+    offset: number;
+    userId?: string;
+} | {
+    type: "archives_create";
+    requestId: string;
+    entries: SpindleArchiveEntry[];
+    options: Omit<ArchiveCreateOptions, "signal">;
+} | {
+    type: "archives_extract";
+    requestId: string;
+    source: SpindleFileSource;
+    options: Omit<ArchiveExtractOptions, "signal">;
+} | {
+    type: "files_cancel";
+    operationId: string;
+};

package/dist/file-transfers.js

@@ -0,0 +1,10 @@
+/** Maximum bytes in a worker read/write chunk; process one chunk at a time. */
+export const SPINDLE_FILE_CHUNK_BYTES = 1024 * 1024;
+/** Per-file and per-installation/user aggregate staged storage ceiling. */
+export const SPINDLE_FILE_MAX_BYTES = 100 * 1024 ** 3;
+/** Default disk reservation for downloads, generated files, and ZIP output. */
+export const SPINDLE_FILE_DEFAULT_MAX_BYTES = 5 * 1024 ** 3;
+/** Inactivity lifetime; active readers and archive inputs are pinned. */
+export const SPINDLE_FILE_TTL_MS = 30 * 60 * 1000;
+/** Maximum staged file count per installation/user and archive entry count. */
+export const SPINDLE_FILE_MAX_COUNT = 10_000;

package/dist/host.js

@@ -11,6 +11,7 @@ export const SPINDLE_HOST_CAPABILITIES = Object.freeze({
     "frontend-extensibility-v2": 1,
     "frontend-runtime-capabilities-v1": 1,
     "mcp-servers-v1": 1,
+    "file-transfers-v1": 1,
 });
 /** Structured error code returned when host compatibility validation fails. */
 export const SPINDLE_COMPATIBILITY_ERROR_CODE = "SPINDLE_COMPATIBILITY_ERROR";

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export type { SpindleManifest, SpindlePermission, SpindleCapability, } from "./manifest.js";
 export { IDENTIFIER_PATTERN, validateIdentifier, } from "./manifest.js";
 export type { SpindleHostDescriptorV1, SpindleHostLocale, SpindleHostLocaleAPI, } from "./host.js";
+export type { SpindleFileRef, SpindleFileSource, FileOperationOptions, FileFetchOptions, SpindleFileCreateInput, SpindleFileChunk, SpindleArchiveEntry, ArchiveCreateOptions, ArchiveExtractOptions, SpindleArchiveExtractedEntry, SpindleFilesAPI, SpindleArchivesAPI, SpindleFileDownloadAPI, FileTransferWorkerMessage, } from "./file-transfers.js";
+export { SPINDLE_FILE_CHUNK_BYTES, SPINDLE_FILE_MAX_BYTES, SPINDLE_FILE_DEFAULT_MAX_BYTES, SPINDLE_FILE_TTL_MS, SPINDLE_FILE_MAX_COUNT, } from "./file-transfers.js";
 export { SPINDLE_HOST_CAPABILITIES, SPINDLE_COMPATIBILITY_ERROR_CODE, } from "./host.js";
 export type { SpindleThemeAsset, SpindleThemeAssetUploadOptions, SpindleThemeAssetUpdate, SpindleThemePackComponentDraft, SpindleThemePackDraft, SpindleThemePackImportResult, SpindleThemePackInstallOptions, SpindleThemePackInstallResult, SpindleThemeComponentCatalogEntry, SpindleThemeVariableCatalogEntry, SpindleThemeEditorTarget, SpindleThemeEditorOptions, SpindleThemeAuthoringAPI, } from "./theme.js";
 export { SPINDLE_THEME_AUTHORING_HOST_CAPABILITIES } from "./theme.js";

package/dist/index.js

@@ -1,4 +1,5 @@
 export { IDENTIFIER_PATTERN, validateIdentifier, } from "./manifest.js";
+export { SPINDLE_FILE_CHUNK_BYTES, SPINDLE_FILE_MAX_BYTES, SPINDLE_FILE_DEFAULT_MAX_BYTES, SPINDLE_FILE_TTL_MS, SPINDLE_FILE_MAX_COUNT, } from "./file-transfers.js";
 export { SPINDLE_HOST_CAPABILITIES, SPINDLE_COMPATIBILITY_ERROR_CODE, } from "./host.js";
 export { SPINDLE_THEME_AUTHORING_HOST_CAPABILITIES } from "./theme.js";
 export { ALL_PERMISSIONS, isValidPermission } from "./permissions.js";

package/dist/spindle-api.d.ts

@@ -1,6 +1,7 @@
 import type { SpindleManifest } from "./manifest.js";
 import type { SpindleHostDescriptorV1 } from "./host.js";
 import type { SpindleDesktopAPI } from "./desktop-capture.js";
+import type { SpindleFilesAPI, SpindleArchivesAPI } from "./file-transfers.js";
 import type { SpindleTextEditorOptions, SpindleTextEditorResult } from "./dom.js";
 import type { CouncilMemberContext, CouncilSettings } from "./council.js";
 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, ActivationPatternsOptions, ActivationPatternsResult, DatabankDTO, DatabankCreateDTO, DatabankUpdateDTO, DatabankDocumentDTO, DatabankDocumentCreateDTO, DatabankDocumentUpdateDTO, PersonaDTO, GlobalAddonDTO, GlobalAddonUpdateDTO, LumiaItemDTO, LumiaDlcCatalogDTO, PersonaCreateDTO, PersonaUpdateDTO, ActivatedWorldInfoEntryDTO, DryRunRequestDTO, DryRunResultDTO, SavedBreakdownDTO, 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";
@@ -133,6 +134,10 @@ export interface SpindleConnectionsAPI {
 }
 /** The global `spindle` object available in backend extension workers */
 export interface SpindleAPI {
+    /** Disk-backed downloads and bounded reads/writes. Available with file-transfers-v1. */
+    readonly files: SpindleFilesAPI;
+    /** Streaming ZIP64 creation and validated disk-backed extraction. */
+    readonly archives: SpindleArchivesAPI;
     readonly desktop: SpindleDesktopAPI;
     /** Immutable host compatibility descriptor for this extension runtime. */
     readonly host: SpindleHostDescriptorV1;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lumiverse-spindle-types",
-  "version": "0.6.41",
+  "version": "0.6.42",
   "type": "module",
   "types": "./dist/index.d.ts",
   "keywords": [