@navieo/types

Shared TypeScript interfaces for Navieo.

Installation

npm install @navieo/types

Usage

import type { SitemapData, GuideRequest, GuideResponse } from "@navieo/types";

Exported Types

| Interface | Description | |-----------|-------------| | ElementSelector | CSS selector, aria label, text, or test ID for targeting UI elements | | SitemapElement | An interactive element on a page (button, link, input, etc.) | | SitemapRoute | A route/page with its path, title, description, and elements | | SitemapFlow | A multi-step user flow across routes | | SitemapDoc | A documentation page with sections | | SitemapData | The complete sitemap containing routes, flows, and docs | | TourStep | A single step in a guided tour | | GuideRequest | Request payload for generating a guide | | GuideResponse | Response containing tour steps and an answer | | SyncRequest | Payload for syncing sitemap + docs to the backend | | DocFile | A documentation file with path and content |

License

MIT