ui/build/file-upload/types

Interfaces

BeginUploadOptions

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:15

Properties

onProgress?

optional onProgress?: (stage) => void;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:18

Parameters

Parameter	Type
stage	| "error" | "uploading" | "converting" | "summarizing" | "complete" | "aborted"

Returns

void

stream?

optional stream?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:16

uploadId?

optional uploadId?: string;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:17

---

IFileUploadClient

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:51

Properties

uploads

readonly uploads: UploadEntry[];

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:52

Methods

beginUpload()

beginUpload(file, options?): object;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:55

Parameters

Parameter	Type
file	File
options?	BeginUploadOptions

Returns

object

effect

effect: Effect<{
  id: string;
  indexed_error?: string | null;
  indexed_status?: "pending" | "indexing" | "ready" | "failed" | "not_indexable";
  metadata?: {
     structure_hint: string;
     summary: string;
  };
  name: string;
  size: number;
  storageKey: string;
  type: string;
  url: string;
}, unknown>;

id

id: string;

cancel()

cancel(entryId): void;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:60

Parameters

Parameter	Type
entryId	string

Returns

void

clear()

clear(entryId): void;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:62

Remove a finished or errored entry from the uploads list (cancels if still in flight).

Parameters

Parameter	Type
entryId	string

Returns

void

clearAllUploads()

clearAllUploads(): void;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:63

Returns

void

delete()

delete(fileUrl): Effect<void, unknown>;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:59

Parameters

Parameter	Type
fileUrl	string

Returns

Effect<void, unknown>

upload()

upload(file, options?): Effect<{
  id: string;
  indexed_error?: string | null;
  indexed_status?: "pending" | "indexing" | "ready" | "failed" | "not_indexable";
  metadata?: {
     structure_hint: string;
     summary: string;
  };
  name: string;
  size: number;
  storageKey: string;
  type: string;
  url: string;
}, unknown>;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:53

Parameters

Parameter	Type
file	File
options?	UploadOptions

Returns

Effect<{ id: string; indexed_error?: string | null; indexed_status?: "pending" | "indexing" | "ready" | "failed" | "not_indexable"; metadata?: { structure_hint: string; summary: string; }; name: string; size: number; storageKey: string; type: string; url: string; }, unknown>

uploadMany()

uploadMany(files, options?): Effect<object[], unknown>;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:54

Parameters

Parameter	Type
files	File[]
options?	Pick<UploadOptions, "stream">

Returns

Effect<object[], unknown>

---

UploadEntry

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:43

Properties

error?

optional error?: string;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:49

file

file: File;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:45

id

id: string;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:44

percent?

optional percent?: number;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:47

result?

optional result?: object;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:48

id

readonly id: string;

indexed_error?

readonly optional indexed_error?: string | null;

indexed_status?

readonly optional indexed_status?: "pending" | "indexing" | "ready" | "failed" | "not_indexable";

metadata?

readonly optional metadata?: object;

metadata.structure_hint

readonly structure_hint: string;

metadata.summary

readonly summary: string;

name

readonly name: string;

size

readonly size: number;

storageKey

readonly storageKey: string;

The object store's key for these bytes, which is what a file() column persists.

Not the same string as id: the workspace client stores under <uuid><extension> and returns the bare uuid as the id. Reconstructing one from the other by string surgery is how a read lands on a key nothing was ever written under, so the key is carried.

type

readonly type: string;

url

readonly url: string;

stage

stage:
  | "error"
  | "uploading"
  | "converting"
  | "summarizing"
  | "complete"
  | "aborted";

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:46

---

UploadOptions

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:9

Properties

onProgress?

optional onProgress?: (stage, percent?) => void;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:13

Parameters

Parameter	Type
stage	| "error" | "uploading" | "converting" | "summarizing" | "complete" | "aborted"
percent?	number

Returns

void

signal?

optional signal?: AbortSignal;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:10

stream?

optional stream?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:12

Streaming multipart + SSE progress (default true in app implementation).

Type Aliases

UploadResult

type UploadResult = typeof UploadResultSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:42

---

UploadStage

type UploadStage = typeof UploadStageSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:6

Variables

UPLOAD_STAGE_MESSAGES

const UPLOAD_STAGE_MESSAGES: Record<UploadStage, string>;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:7

Functions

isActiveUploadStage()

function isActiveUploadStage(stage): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/file-upload/types.d.ts:8

Parameters

Parameter	Type
stage	| "error" | "uploading" | "converting" | "summarizing" | "complete" | "aborted"

Returns

boolean