Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt

Use this file to discover all available pages before exploring further.

GSlidesResource exposes Slides decks as .gslides.json files containing the deck structure, slides, and text content. Setup steps for OAuth credentials live at Google Workspace Credentials.

Node

pnpm add @struktoai/mirage-node
import { GSlidesResource, MountMode, Workspace } from '@struktoai/mirage-node'

const slides = new GSlidesResource({
  clientId: process.env.GOOGLE_CLIENT_ID!,
  clientSecret: process.env.GOOGLE_CLIENT_SECRET!,
  refreshToken: process.env.GOOGLE_REFRESH_TOKEN!,
})

const ws = new Workspace({ '/slides': slides }, { mode: MountMode.READ })
await ws.execute('ls /slides/owned/')

Browser

pnpm add @struktoai/mirage-browser
import { GSlidesResource, MountMode, Workspace } from '@struktoai/mirage-browser'

const slides = new GSlidesResource({
  clientId: GOOGLE_CLIENT_ID,
  clientSecret: GOOGLE_CLIENT_SECRET,
  refreshToken: localStorage.getItem('gslides.refresh_token')!,
})

Config

FieldDefaultNotes
clientIdrequiredGoogle OAuth client ID.
clientSecretrequiredGoogle OAuth client secret. Redacted in snapshots.
refreshTokenrequiredUser’s refresh token. Redacted in snapshots.
refreshFnbuilt-inOptional override for the access-token refresh callback.

Mount mode

read, partial write (text element replacements). For the JSON structure (slides, layouts, text frames) see the Python Slides docs.