@robojs/roadmap

API reference documentation for @robojs/roadmap.

Classes

• JiraProvider - Jira provider that connects to Jira Cloud instances via REST API v3.
• RoadmapProvider - Base class for roadmap data providers (Jira, GitHub Projects, Linear).
• SyncCanceledError - Error thrown when a sync is canceled via AbortSignal.

Interfaces

• CreateRoadmapForumsOptions - Options for creating roadmap category and forum channels.
• JiraProviderConfig - Configuration shape for the JiraProvider.
• RoadmapPluginOptions - Plugin options interface.
• RoadmapSettings - Guild-specific roadmap configuration settings.
• SyncOptions - Options for synchronizing roadmap data to Discord.
• SyncProgressUpdate - Progress update data sent during sync operations.

Type Aliases

• CreateCardInput - Input required to create a new roadmap card in the external provider.
• CreateCardResult - Result of a card creation operation.
• DateRangeFilter - Specifies filtering criteria for fetching roadmap cards by date range.
• ForumPermissionMode - Forum permission modes.
• ProviderConfig - Identifies the provider implementation and its raw configuration.
• ProviderInfo - Metadata describing a roadmap provider implementation.
• RoadmapCard - Represents a unit of work surfaced by the roadmap.
• RoadmapColumn - Describes a column or lane used to organize roadmap cards.
• SyncResult - Captures the result of a synchronization run between a provider and the roadmap surface.
• ThreadOperation - Type of operation to perform on a thread.
• UpdateCardInput - Input required to update an existing roadmap card in the external provider.
• UpdateCardResult - Result of a card update operation.

Functions

• AddThreadToHistory - Appends a new thread entry to a card's history.
• CanUserCreateCards - Checks if a user is authorized to create roadmap cards.
• CreateOrGetRoadmapCategory - Creates or retrieves the roadmap category with forum channels for each column (idempotent).
• FormatCardContentV2 - Formats a roadmap card into Discord Components v2 structure with rich presentation.
• FormatCardContent - Formats a roadmap card into Discord message content with automatic truncation.
• FormatThreadName - Formats a roadmap card title for use as a Discord thread name.
• GetAllForumChannels - Retrieves all forum channels for a guild, mapped by column name.
• GetAssigneeMapping - Retrieves the assignee mapping for a guild.
• GetAuthorizedCreatorRoles - Retrieves the list of role IDs authorized to create roadmap cards.
• GetCardsFromDateRange - Fetches cards within a custom date range.
• GetCardsFromLastDays - Fetches cards from the last N days (inclusive of today).
• GetCardsFromLastMonth - Fetches cards from the previous calendar month.
• GetCardsFromLastWeek - Fetches cards from the last 7 days (inclusive of today).
• GetCategoryId - Gets the roadmap category ID for a guild.
• GetColumnMapping - Retrieves the column mapping for a guild.
• GetCurrentThreadInfo - Retrieves the current thread ID and its column information for a card.
• GetCustomColumns - Retrieves custom columns for a guild.
• GetDiscordUserIdForJiraName - Looks up the Discord user ID for a Jira assignee name.
• GetForumChannelForColumn - Retrieves a specific forum channel for a column.
• GetForumChannelIdForColumn - Gets the forum channel ID for a specific column.
• GetProvider - Get the initialized provider instance.
• GetRoadmapCategory - Retrieves the roadmap category for a guild.
• GetSettings - Retrieves roadmap settings for a guild.
• GetSyncedPostId - Retrieves the Discord thread ID for a synced provider card.
• GetThreadForColumn - Retrieves the most recent thread entry for a specific column.
• GetThreadHistory - Retrieves the thread history array for a specific card.
• IsForumPublic - Checks if the forum is configured as public.
• IsProviderReady - Check if the provider is initialized and ready to use.
• MoveThreadToNewForum - Moves a roadmap card's discussion thread to a new forum when the column changes.
• RemoveAssigneeMapping - Removes a mapping for a Jira assignee name.
• RemoveColumnMapping - Removes a mapping for a provider status name.
• SetAssigneeMapping - Sets a mapping between a Jira assignee name and a Discord user ID.
• SetAuthorizedCreatorRoles - Sets the list of role IDs authorized to create roadmap cards.
• SetColumnMapping - Sets a mapping between a provider status name and a column name (or null for no forum).
• SetCustomColumns - Sets custom columns for a guild.
• SetSyncedPost - Records a synced post mapping between a provider card and Discord thread.
• SyncRoadmap - Synchronizes roadmap data from a provider to Discord forum posts.
• SyncSingleCard - Synchronizes a single roadmap card to Discord and returns thread metadata.
• ToggleForumAccess - Toggles roadmap category between private (admin/mod only) and public (everyone can view/comment).
• UpdateForumTagsForColumn - Updates forum tags for a column by merging new tags with existing ones (max 20 tags).
• UpdateSettings - Updates roadmap settings for a guild (merges with existing).

Variables

• Buttons - Button component IDs used in interactive messages.
• Id_namespace - Namespace prefix for all component IDs and settings storage.
• Options - Resolved plugin options from config or defaults.
• Selects - Select menu component IDs used in interactive messages.