Class MsGraphProvider

constructor

• new MsGraphProvider(options?: MsGraphProviderOptions): MsGraphProvider

  Parameters

  • Optionaloptions: MsGraphProviderOptions

  Returns MsGraphProvider

Readonlyauth

Readonlymanifest

download

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

  Downloads a file's bytes. Fetches the item's pre-signed @microsoft.graph.downloadUrl and retrieves that URL — never GET .../content directly.

  Per Microsoft Graph's own docs ("Download driveItem content", learn.microsoft.com/graph/api/driveitem-get-content, section "Downloading files in JavaScript apps", checked 2026-08-15): /content returns a 302 Found redirect to the same pre-signed URL, and "you can't use the /content API [in a JavaScript app], because this responds with a 302 redirect. A 302 redirect is explicitly prohibited when a [CORS] preflight is required, such as when providing the Authorization header." The docs' own fix is exactly this: "select the @microsoft.graph.downloadUrl property... requested directly using XMLHttpRequest. Because these URLs are preauthenticated, they can be retrieved without a CORS preflight" — i.e. with no Authorization header at all, which is why this goes through ctx.fetchPublic (strips every header except Accept/Range) rather than ctx.fetch.

  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
  • Optional_options: ListProjectsOptions

  Returns Promise<Page<SourceProject>>

listRevisions

• 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>>

searchFiles

• 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>>

testConnection

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

  Optional: test the connection and return a diagnostic message.

  Parameters

  • ctx: PluginContext

  Returns Promise<ConnectionTestResult>

watchRevisions

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

  Watches for changes via Graph's /delta change feed (GET /me/drive/root/delta) rather than polling the given refs — per the contract, "Providers with a delta or change-feed endpoint should use cursor and ignore refs, returning a fresh cursor each call."

  refs is still consulted, but only to decide which delta items are worth turning into an event: the feed reports every change across the whole drive, and a host tracking a handful of files should not be told about unrelated ones.

  Parameters

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

  Returns Promise<RevisionWatchResult>