Type Alias: CreateCardInput

type CreateCardInput = {
  assignees: {
     id: string;
     name: string;
    }[];
  column: string;
  description: string;
  issueType: string;
  labels: string[];
  title: string;
};

Input required to create a new roadmap card in the external provider.

Type declaration

Remarks

This interface captures the minimum data needed to create a card across any provider implementation. Providers should map these fields to their native data models (e.g., Jira issue fields, GitHub issue properties).

Provider-specific considerations:

• Column names must match one of the columns returned by the provider's getColumns() method
• Assignee IDs must be valid user identifiers in the provider's system
• Labels should follow the provider's naming conventions and constraints
• Issue type names must match one of the types returned by the provider's getIssueTypes() method
• If issue type is omitted, the provider's configured default issue type is used

Example

import type { CreateCardInput } from '@robojs/roadmap';

const input: CreateCardInput = {
  title: 'Add dark mode support',
  description: 'Implement dark mode theme across the application',
  column: 'Backlog',
  labels: ['enhancement', 'ui'],
  issueType: 'Task'
};