Interface StreamlitEndpoints

frontend/connection/src/types.ts:62–177

/** Exposes non-websocket endpoints used by the frontend. */
export interface StreamlitEndpoints {
  /**
   * Set the static config url for static connection media assets.
   *
   * @param url The URL to set.
   */
  setStaticConfigUrl(url: string): void

  /**
   * Send postMessage to host with client errors
   * @param component component causing the error
   * @param error error status code or message
   * @param message additional error info
   * @param source component src (url)
   * @param customComponentName If custom component, the component's name causing the error.
   */
  sendClientErrorToHost(
    component: string,
    error: string | number,
    message: string,
    source: string,
    customComponentName?: string
  ): void

  /**
   * Checks if the component src has successful response.
   * If not, sends CLIENT_ERROR message with error info.
   * @param sourceUrl The source to check.
   * @param componentName The component for which the source is being checked.
   * @param customComponentName If custom component, the component's name for which the source is being checked.
   */
  checkSourceUrlResponse(
    sourceUrl: string,
    componentName: string,
    customComponentName?: string
  ): Promise<void>

  /**
   * Return a URL to fetch data for the given custom component.
   * @param componentName The registered name of the component.
   * @param path The path of the component resource to fetch, e.g. "index.html".
   */
  buildComponentURL(componentName: string, path: string): string

  /**
   * Return a URL to fetch data for the given bidirectional component.
   * @param componentName The registered name of the component.
   * @param path The path of the component resource to fetch, e.g. "script.js".
   */
  buildBidiComponentURL(componentName: string, path: string): string

  /**
   * Construct a URL for a media file.
   * @param url a relative or absolute URL. If `url` is absolute, it will be
   * returned unchanged. Otherwise, the return value will be a URL for fetching
   * the media file from the connected Streamlit instance.
   */
  buildMediaURL(url: string): string