mkdocs.yml

site_name: UiPath TypeScript SDK
site_url: https://uipath.github.io/uipath-typescript/
site_author: UiPath

# Repository
repo_name: UiPath/uipath-typescript
repo_url: https://github.com/UiPath/uipath-typescript

# Copyright
copyright: Copyright © 2025 UiPath


# Configuration
theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo-light.svg
  custom_logo:
    light: assets/logo-light.svg
    dark: assets/logo-dark.svg
  favicon: assets/favicon.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  
  icon:
    repo: fontawesome/brands/github
    
  # Default values, taken from mkdocs_theme.yml
  language: en
  features:
    - announce.dismiss
    - content.code.annotate
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - navigation.expand
    - navigation.footer
    - navigation.sections
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - llmstxt:
      full_output: "coded-action-apps/llms.txt"
      sections:
        Coded Action Apps:
          - coded-action-apps/getting-started.md: Getting started with Coded Action Apps SDK
          - coded-action-apps/interfaces/CodedActionAppsServiceModel.md: Coded Action Apps service methods
  - llmstxt:
      full_output: "llms-full-content.txt"
      preprocess: "scripts/llms-preprocess.py"
      sections:
        Getting Started:
          - getting-started.md: Introduction to UiPath TypeScript SDK
          - authentication.md: Authentication setup
          - pagination.md: Pagination guide
        API Reference:
          - api/interfaces/AssetServiceModel.md: Asset service methods
          - api/interfaces/JobServiceModel.md: Job service methods
          - api/interfaces/ProcessServiceModel.md: Process service methods
          - api/interfaces/QueueServiceModel.md: Queue service methods
          - api/interfaces/BucketServiceModel.md: Bucket service methods
          - api/interfaces/TaskServiceModel.md: Task service methods
          - api/interfaces/attachments/index.md: Attachment service methods
          - api/interfaces/entity/index.md: Entity service methods
          - api/interfaces/ChoiceSetServiceModel.md: Choice set service methods
          - api/interfaces/MaestroProcessesServiceModel.md: Maestro process methods
          - api/interfaces/ProcessInstancesServiceModel.md: Process instance methods
          - api/interfaces/CasesServiceModel.md: Maestro Case methods
          - api/interfaces/CaseInstancesServiceModel.md: Maestro Case instance methods
          - api/interfaces/ConversationalAgentServiceModel.md: Conversational Agent main service
          - api/interfaces/ConversationServiceModel.md: Conversation service methods
          - api/interfaces/ExchangeServiceModel.md: Exchange service methods
          - api/interfaces/MessageServiceModel.md: Message service methods
          - api/interfaces/SessionStream.md: Real-time WebSocket session
          - api/interfaces/ExchangeStream.md: Exchange streaming events
          - api/interfaces/MessageStream.md: Message streaming events
          - api/interfaces/ContentPartStream.md: Content part streaming events
          - api/interfaces/ToolCallStream.md: Tool call streaming events
  - termynal:
      prompt_literal_start:
        - "$"
        - ">"

extra:
  status:
    new: Recently added
    deprecated: Deprecated

# Additional configuration
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - overrides/assets/javascripts/extra.js

# Extensions
markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - pymdownx.blocks.tab:
      alternate_style: true
  - pymdownx.blocks.admonition:
      types:
        - note
        - attention
        - caution
        - danger
        - error
        - tip
        - hint
        - warning
        - info
        - check
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.snippets
  - pymdownx.fancylists
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      title: On this page
      permalink: true
      toc_depth: 3
  

# Page tree
nav:
  - TypeScript SDK:
      - Getting Started: getting-started.md
      - Authentication: authentication.md
      - OAuth Scopes: oauth-scopes.md
      - Pagination: pagination.md
      - Error Handling: error-handling.md
  - API Reference:
      - Services:
          - Agents:
            - Conversational Agent:
              - conversational-agent/index.md
              - Conversations:
                - conversations/index.md
              - Session: api/interfaces/SessionStream.md
              - Exchanges: api/interfaces/ExchangeServiceModel.md
              - Messages: api/interfaces/MessageServiceModel.md
            - Feedback: api/interfaces/FeedbackServiceModel.md
          - Attachments:
            - api/interfaces/attachments/index.md
          - Assets: api/interfaces/AssetServiceModel.md
          - Buckets: api/interfaces/BucketServiceModel.md
          - Entities:
            - api/interfaces/entity/index.md
            - Choice Sets: api/interfaces/ChoiceSetServiceModel.md
          - Maestro:
            - Processes: api/interfaces/MaestroProcessesServiceModel.md
            - Process Instances: api/interfaces/ProcessInstancesServiceModel.md
            - Cases: api/interfaces/CasesServiceModel.md
            - Case Instances: api/interfaces/CaseInstancesServiceModel.md
          - Jobs: api/interfaces/JobServiceModel.md
          - Processes: api/interfaces/ProcessServiceModel.md
          - Queues: api/interfaces/QueueServiceModel.md
          - Tasks: api/interfaces/TaskServiceModel.md
  - Coded Apps:
      - Getting Started: coded-apps/getting-started.md
      - CLI Reference: coded-apps/cli-reference.md
  - Coded Action Apps SDK:
      - Getting Started: coded-action-apps/getting-started.md
      - Coded Action Apps: coded-action-apps/interfaces/CodedActionAppsServiceModel.md
  - Sample Application: https://github.com/UiPath/uipath-typescript/tree/main/samples
  - FAQ: FAQ.md
  - How To Contribute: CONTRIBUTING.md
  - Release Policy: release-policy.md
  - API Guide:
      - Data Fabric: https://docs.uipath.com/data-service/automation-cloud/latest/api-guide/get-entity-endpoint
      - Orchestrator: https://docs.uipath.com/orchestrator/automation-cloud/latest/api-guide/introduction