frontend/lib/src/components/widgets/FileUploader/UploadFileInfo.ts - develop - vshmidt/streamlit

frontend/lib/src/components/widgets/FileUploader/UploadFileInfo.ts

83 строки2 KB

Ken McGrady

Update copyright header to 2026 (#13491)

02 янв 2026, 16:21

02 янв 2026, 16:21374540a

/**
 * Copyright (c) Streamlit Inc. (2018-2022) Snowflake Inc. (2022-2026)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { IFileURLs } from "@streamlit/protobuf"

export interface UploadingStatus {
  type: "uploading"
  abortController: AbortController
  progress: number
}

export interface UploadedStatus {
  type: "uploaded"
  fileId: string
  fileUrls: IFileURLs
}

export interface ErrorStatus {
  type: "error"
  errorMessage: string
}

/** The various statuses that an UploadedFileInfo can have. */
export type FileStatus = UploadingStatus | UploadedStatus | ErrorStatus

/**
 * Wraps a File object with additional data used by FileUploader.
 * This class is immutable because it's used in within FileUploader.state.
 */
export class UploadFileInfo {
  public readonly name: string

  public readonly size: number

  public readonly status: FileStatus

  /**
   * ID used to refer to the file locally, for update operations.
   * If the file is uploaded, it will also have a serverID, which is
   * used to refer to the file on the server.
   */
  public readonly id: number

  /**
   * The original File object. Stored for retry functionality when uploads fail.
   * Optional because some existing code paths may not provide it.
   */
  public readonly file?: File

  /**
   * Create a clone of this UploadFileInfo with the given status.
   */
  public setStatus(status: FileStatus): UploadFileInfo {
    return new UploadFileInfo(this.name, this.size, this.id, status, this.file)
  }

  public constructor(
    name: string,
    size: number,
    id: number,
    status: FileStatus,
    file?: File
  ) {
    this.name = name
    this.size = size
    this.id = id
    this.status = status
    this.file = file
  }
}