file-upload

Interfaces

BeginUploadOptions

Defined in: packages/ui/build/file-upload/types.d.ts:13

Properties

onProgress?

optional onProgress?: (stage) => void;

Defined in: packages/ui/build/file-upload/types.d.ts:16

Parameters

Parameter	Type
stage	UploadStage

Returns

void

stream?

optional stream?: boolean;

Defined in: packages/ui/build/file-upload/types.d.ts:14

uploadId?

optional uploadId?: string;

Defined in: packages/ui/build/file-upload/types.d.ts:15

---

IFileUploadClient

Defined in: packages/ui/build/file-upload/types.d.ts:37

Properties

uploads

readonly uploads: UploadEntry[];

Defined in: packages/ui/build/file-upload/types.d.ts:38

Methods

beginUpload()

beginUpload(file, options?): object;

Defined in: packages/ui/build/file-upload/types.d.ts:41

Parameters

Parameter	Type
file	File
options?	BeginUploadOptions

Returns

object

id

id: string;

promise

promise: Promise<UploadResult>;

cancel()

cancel(entryId): void;

Defined in: packages/ui/build/file-upload/types.d.ts:46

Parameters

Parameter	Type
entryId	string

Returns

void

clear()

clear(entryId): void;

Defined in: packages/ui/build/file-upload/types.d.ts:48

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: packages/ui/build/file-upload/types.d.ts:49

Returns

void

delete()

delete(fileUrl): Promise<void>;

Defined in: packages/ui/build/file-upload/types.d.ts:45

Parameters

Parameter	Type
fileUrl	string

Returns

Promise<void>

upload()

upload(file, options?): Promise<UploadResult>;

Defined in: packages/ui/build/file-upload/types.d.ts:39

Parameters

Parameter	Type
file	File
options?	UploadOptions

Returns

Promise<UploadResult>

uploadMany()

uploadMany(files, options?): Promise<UploadResult[]>;

Defined in: packages/ui/build/file-upload/types.d.ts:40

Parameters

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

Returns

Promise<UploadResult[]>

---

UploadEntry

Defined in: packages/ui/build/file-upload/types.d.ts:29

Properties

error?

optional error?: string;

Defined in: packages/ui/build/file-upload/types.d.ts:35

file

file: File;

Defined in: packages/ui/build/file-upload/types.d.ts:31

id

id: string;

Defined in: packages/ui/build/file-upload/types.d.ts:30

percent?

optional percent?: number;

Defined in: packages/ui/build/file-upload/types.d.ts:33

result?

optional result?: UploadResult;

Defined in: packages/ui/build/file-upload/types.d.ts:34

stage

stage: UploadStage;

Defined in: packages/ui/build/file-upload/types.d.ts:32

---

UploadOptions

Defined in: packages/ui/build/file-upload/types.d.ts:7

Properties

onProgress?

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

Defined in: packages/ui/build/file-upload/types.d.ts:11

Parameters

Parameter	Type
stage	UploadStage
percent?	number

Returns

void

signal?

optional signal?: AbortSignal;

Defined in: packages/ui/build/file-upload/types.d.ts:8

stream?

optional stream?: boolean;

Defined in: packages/ui/build/file-upload/types.d.ts:10

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

---

UploadResult

Defined in: packages/ui/build/file-upload/types.d.ts:19

Result of a successful upload (matches app JSON + TFileValue).

Properties

indexed_error?

optional indexed_error?: string | null;

Defined in: packages/ui/build/file-upload/types.d.ts:27

indexed_status?

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

Defined in: packages/ui/build/file-upload/types.d.ts:26

metadata?

optional metadata?: Record<string, unknown>;

Defined in: packages/ui/build/file-upload/types.d.ts:25

name

name: string;

Defined in: packages/ui/build/file-upload/types.d.ts:22

norbital_id

norbital_id: string;

Defined in: packages/ui/build/file-upload/types.d.ts:20

size

size: number;

Defined in: packages/ui/build/file-upload/types.d.ts:24

type

type: string;

Defined in: packages/ui/build/file-upload/types.d.ts:23

url

url: string;

Defined in: packages/ui/build/file-upload/types.d.ts:21

Type Aliases

UploadStage

type UploadStage = 
  | "uploading"
  | "converting"
  | "summarizing"
  | "complete"
  | "error"
  | "aborted";

Defined in: packages/ui/build/file-upload/types.d.ts:4

Client-agnostic upload contract. Concrete implementation lives in the app (e.g. apps/core).

Variables

UPLOAD_STAGE_MESSAGES

const UPLOAD_STAGE_MESSAGES: Record<UploadStage, string>;

Defined in: packages/ui/build/file-upload/types.d.ts:5

Functions

isActiveUploadStage()

function isActiveUploadStage(stage): boolean;

Defined in: packages/ui/build/file-upload/types.d.ts:6

Parameters

Parameter	Type
stage	UploadStage

Returns

boolean