Interface FileSourceProvider

Optional Readonlyauth

Readonlymanifest

download

• download(
      ctx: PluginContext,
      ref: SourceFileRef,
      options?: DownloadOptions,
  ): Promise<ArrayBuffer>

  Download file content.

  Parameters

  • ctx: PluginContext
  • ref: SourceFileRef
  • Optionaloptions: DownloadOptions

  Returns Promise<ArrayBuffer>

listContainers

• listContainers(
      ctx: PluginContext,
      projectId: string,
      parentId?: string,
      options?: ListOptions,
  ): Promise<Page<SourceContainer>>

  List containers within a project. parentId omitted means top level.

  The shape of the result is governed by capabilities.containerListing: direct-children returns only immediate children, flat-subtree returns the whole descendant set flattened with parentId links intact.

  Parameters

  • ctx: PluginContext
  • projectId: string
  • OptionalparentId: string
  • Optionaloptions: ListOptions

  Returns Promise<Page<SourceContainer>>

listFiles

• listFiles(
      ctx: PluginContext,
      projectId: string,
      containerId: string,
      filter?: FileFilter,
      options?: ListOptions,
  ): Promise<Page<SourceFile>>

  List files in a container. Whether descendants are included is governed by capabilities.listFilesIsRecursive.

  Parameters

  • ctx: PluginContext
  • projectId: string
  • containerId: string
  • Optionalfilter: FileFilter
  • Optionaloptions: ListOptions

  Returns Promise<Page<SourceFile>>

listProjects

• listProjects(
      ctx: PluginContext,
      options?: ListProjectsOptions,
  ): Promise<Page<SourceProject>>

  List projects visible to the authenticated identity.

  Providers reporting projectsAreDiscoverableOnly may return a partial or empty page when query is absent; the host then prompts the user to search or paste a URL rather than presenting the result as complete.

  Parameters

  • ctx: PluginContext
  • Optionaloptions: ListProjectsOptions

  Returns Promise<Page<SourceProject>>

OptionallistRevisions

• listRevisions?(
      ctx: PluginContext,
      ref: SourceFileRef,
      options?: ListOptions,
  ): Promise<Page<SourceRevision>>

  Optional: revision history for one file, newest first.

  Parameters

  • ctx: PluginContext
  • ref: SourceFileRef
  • Optionaloptions: ListOptions

  Returns Promise<Page<SourceRevision>>

OptionalsearchFiles

• searchFiles?(
      ctx: PluginContext,
      projectId: string,
      query: string,
      filter?: FileFilter,
      options?: ListOptions,
  ): Promise<Page<SourceFile>>

  Optional: server-side file search within a project.

  Parameters

  • ctx: PluginContext
  • projectId: string
  • query: string
  • Optionalfilter: FileFilter
  • Optionaloptions: ListOptions

  Returns Promise<Page<SourceFile>>

OptionaltestConnection

• testConnection?(ctx: PluginContext): Promise<ConnectionTestResult>

  Optional: test the connection and return a diagnostic message.

  Parameters

  • ctx: PluginContext

  Returns Promise<ConnectionTestResult>

OptionalwatchRevisions

• watchRevisions?(
      ctx: PluginContext,
      refs: readonly SourceFileRef[],
      cursor?: string,
      options?: ListOptions,
  ): Promise<RevisionWatchResult>

  Optional: detect new revisions.

  Providers with a delta or change-feed endpoint should use cursor and ignore refs, returning a fresh cursor each call. Providers without one poll the given refs. Either way the host passes both, and the cost of the call is the provider's business rather than the host's guess.

  Parameters

  • ctx: PluginContext
  • refs: readonly SourceFileRef[]
  • Optionalcursor: string
  • Optionaloptions: ListOptions

  Returns Promise<RevisionWatchResult>