@nice2dev/events 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,512 @@
+/**
+ * @nice2dev/events — Event management, party controls, rounds, music & attractions.
+ * @packageDocumentation
+ */
+
+import { default as default_2 } from 'react';
+
+/** Attraction category. */
+export declare type AttractionCategory = 'game' | 'music' | 'dance' | 'quiz' | 'karaoke' | 'photo' | 'custom';
+
+/** Event billing item. */
+export declare interface BillingItem {
+    id: string;
+    label: string;
+    amount: number;
+    currency: string;
+    paidById?: string;
+    paidByName?: string;
+    splitAmong?: string[];
+    isPaid?: boolean;
+}
+
+/** Chat message. */
+export declare interface ChatMessage {
+    id: string;
+    type: ChatMessageType;
+    senderId: string;
+    senderName: string;
+    senderAvatarUrl?: string;
+    content: string;
+    timestamp: string;
+    reactions?: Record<string, number>;
+    replyToId?: string;
+}
+
+/** Chat message type. */
+export declare type ChatMessageType = 'text' | 'image' | 'system' | 'reaction' | 'announcement';
+
+/** Event attraction. */
+export declare interface EventAttraction {
+    id: string;
+    name: string;
+    description?: string;
+    category: AttractionCategory;
+    imageUrl?: string;
+    durationMinutes?: number;
+    maxParticipants?: number;
+    votes?: number;
+    isSelected?: boolean;
+    order?: number;
+}
+
+/** Event location. */
+export declare interface EventLocation {
+    name: string;
+    address?: string;
+    lat?: number;
+    lng?: number;
+    virtualUrl?: string;
+    isVirtual?: boolean;
+}
+
+/** Media item (photo/video). */
+export declare interface EventMediaItem {
+    id: string;
+    type: 'photo' | 'video';
+    url: string;
+    thumbnailUrl?: string;
+    uploadedById: string;
+    uploadedByName: string;
+    uploadedAt: string;
+    caption?: string;
+    likes?: number;
+    tags?: string[];
+}
+
+/** Core event model. */
+export declare interface EventModel {
+    id: string;
+    title: string;
+    description?: string;
+    status: EventStatus;
+    hostId: string;
+    hostName: string;
+    startDate?: string;
+    endDate?: string;
+    location?: EventLocation;
+    coverImageUrl?: string;
+    maxParticipants?: number;
+    isPublic?: boolean;
+    tags?: string[];
+    settings?: Record<string, unknown>;
+    createdAt: string;
+    updatedAt?: string;
+}
+
+/** Event participant. */
+export declare interface EventParticipant {
+    id: string;
+    userId: string;
+    name: string;
+    avatarUrl?: string;
+    role: ParticipantRole;
+    status: ParticipantStatus;
+    joinedAt?: string;
+    checkedInAt?: string;
+    qrCode?: string;
+    score?: number;
+}
+
+/** Event round. */
+export declare interface EventRound {
+    id: string;
+    name: string;
+    description?: string;
+    order: number;
+    status: RoundStatus;
+    type?: string;
+    startedAt?: string;
+    endedAt?: string;
+    durationMinutes?: number;
+    scores?: RoundScore[];
+    winnerIds?: string[];
+}
+
+/**
+ * {@link EventService} — Abstract API interface for event backend integration.
+ *
+ * Implement this interface in your application to connect the event components
+ * to your API layer. Example:
+ *
+ * ```ts
+ * class MyEventService implements EventService {
+ *   async getEvent(id) { return fetch(`/api/events/${id}`).then(r => r.json()); }
+ *   // ...
+ * }
+ * ```
+ */
+export declare interface EventService {
+    getEvent(eventId: string): Promise<EventModel>;
+    createEvent(data: Partial<EventModel>): Promise<EventModel>;
+    updateEvent(eventId: string, data: Partial<EventModel>): Promise<EventModel>;
+    deleteEvent(eventId: string): Promise<void>;
+    getParticipants(eventId: string): Promise<EventParticipant[]>;
+    inviteParticipant(eventId: string, userId: string, role?: string): Promise<EventParticipant>;
+    updateParticipant(eventId: string, participantId: string, data: Partial<EventParticipant>): Promise<EventParticipant>;
+    removeParticipant(eventId: string, participantId: string): Promise<void>;
+    checkInParticipant(eventId: string, participantId: string): Promise<EventParticipant>;
+    getMessages(eventId: string, limit?: number, before?: string): Promise<ChatMessage[]>;
+    sendMessage(eventId: string, content: string, type?: string): Promise<ChatMessage>;
+    reactToMessage(eventId: string, messageId: string, reaction: string): Promise<void>;
+    getRounds(eventId: string): Promise<EventRound[]>;
+    createRound(eventId: string, data: Partial<EventRound>): Promise<EventRound>;
+    updateRound(eventId: string, roundId: string, data: Partial<EventRound>): Promise<EventRound>;
+    startRound(eventId: string, roundId: string): Promise<EventRound>;
+    endRound(eventId: string, roundId: string): Promise<EventRound>;
+    submitScore(eventId: string, roundId: string, participantId: string, score: number): Promise<void>;
+    getAttractions(eventId: string): Promise<EventAttraction[]>;
+    addAttraction(eventId: string, data: Partial<EventAttraction>): Promise<EventAttraction>;
+    voteAttraction(eventId: string, attractionId: string): Promise<void>;
+    removeAttraction(eventId: string, attractionId: string): Promise<void>;
+    getSongs(eventId: string): Promise<SongEntry[]>;
+    addSong(eventId: string, song: Partial<SongEntry>): Promise<SongEntry>;
+    removeSong(eventId: string, songId: string): Promise<void>;
+    voteSong(eventId: string, songId: string): Promise<void>;
+    getKaraokeSongs?(eventId: string): Promise<KaraokeSong[]>;
+    queueKaraokeSong?(eventId: string, songId: string, performerId: string): Promise<void>;
+    getMedia(eventId: string): Promise<EventMediaItem[]>;
+    uploadMedia(eventId: string, file: File, caption?: string): Promise<EventMediaItem>;
+    deleteMedia(eventId: string, mediaId: string): Promise<void>;
+    getSurveys?(eventId: string): Promise<EventSurvey[]>;
+    submitSurveyResponse?(eventId: string, surveyId: string, answer: string | string[] | number): Promise<void>;
+    getBillingItems?(eventId: string): Promise<BillingItem[]>;
+    addBillingItem?(eventId: string, item: Partial<BillingItem>): Promise<BillingItem>;
+}
+
+/** Event status. */
+export declare type EventStatus = 'draft' | 'planned' | 'active' | 'paused' | 'completed' | 'cancelled';
+
+/** Event survey. */
+export declare interface EventSurvey {
+    id: string;
+    question: string;
+    type: 'single' | 'multiple' | 'text' | 'rating';
+    options?: string[];
+    responses?: SurveyResponse[];
+    isActive?: boolean;
+}
+
+/** Karaoke song with lyrics. */
+export declare interface KaraokeSong extends SongEntry {
+    hasLyrics: boolean;
+    difficulty?: 'easy' | 'medium' | 'hard';
+    language?: string;
+    performerId?: string;
+    performerName?: string;
+}
+
+/**
+ * {@link NiceAttractionPicker} — Attraction selection grid with category filters.
+ */
+export declare const NiceAttractionPicker: default_2.ForwardRefExoticComponent<NiceAttractionPickerProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for {@link NiceAttractionPicker}. */
+export declare interface NiceAttractionPickerProps {
+    /** Available attractions. */
+    attractions: EventAttraction[];
+    /** Called when selecting an attraction. */
+    onSelect?: (attractionId: string) => void;
+    /** Called when deselecting. */
+    onDeselect?: (attractionId: string) => void;
+    /** Called when voting for an attraction. */
+    onVote?: (attractionId: string) => void;
+    /** Set of selected attraction IDs. */
+    selectedIds?: string[];
+    /** Maximum number of selections allowed. */
+    maxSelections?: number;
+    /** Whether to show vote counts. */
+    showVotes?: boolean;
+    /** Whether actions are allowed. */
+    readOnly?: boolean;
+    /** Display layout. */
+    layout?: 'grid' | 'list';
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+/**
+ * {@link NiceAttractionVoting} — Anonymous voting on attractions with rankings.
+ */
+export declare const NiceAttractionVoting: default_2.ForwardRefExoticComponent<NiceAttractionVotingProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for {@link NiceAttractionVoting}. */
+export declare interface NiceAttractionVotingProps {
+    /** Attractions available for voting. */
+    attractions: EventAttraction[];
+    /** Called when voting for an attraction. */
+    onVote?: (attractionId: string) => void;
+    /** Called when retracting a vote. */
+    onUnvote?: (attractionId: string) => void;
+    /** IDs of attractions the current user already voted for. */
+    votedIds?: string[];
+    /** Max votes per user. */
+    maxVotes?: number;
+    /** Whether voting is closed. */
+    closed?: boolean;
+    /** Sort order. */
+    sortBy?: 'votes' | 'name' | 'category';
+    /** Whether to show results (rankings). */
+    showResults?: boolean;
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+/**
+ * {@link NiceEventChat} — Real-time event chat with reactions and message types.
+ */
+export declare const NiceEventChat: default_2.ForwardRefExoticComponent<NiceEventChatProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for {@link NiceEventChat}. */
+export declare interface NiceEventChatProps {
+    /** Messages to display. */
+    messages: ChatMessage[];
+    /** Current user ID. */
+    currentUserId: string;
+    /** Called when sending a message. */
+    onSend?: (content: string, type?: ChatMessageType) => void;
+    /** Called when reacting to a message. */
+    onReact?: (messageId: string, reaction: string) => void;
+    /** Available reaction emojis. */
+    reactions?: string[];
+    /** Whether the chat is read-only. */
+    readOnly?: boolean;
+    /** Placeholder text. */
+    placeholder?: string;
+    /** Whether to auto-scroll to bottom on new messages. */
+    autoScroll?: boolean;
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+/**
+ * {@link NiceEventMedia} — Media gallery with upload, photos, and collages.
+ */
+export declare const NiceEventMedia: default_2.ForwardRefExoticComponent<NiceEventMediaProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for {@link NiceEventMedia}. */
+export declare interface NiceEventMediaProps {
+    /** Media items. */
+    items: EventMediaItem[];
+    /** Called when uploading new media. */
+    onUpload?: (file: File, caption?: string) => void;
+    /** Called when deleting media. */
+    onDelete?: (mediaId: string) => void;
+    /** Called when liking media. */
+    onLike?: (mediaId: string) => void;
+    /** Called when clicking on a media item. */
+    onItemClick?: (item: EventMediaItem) => void;
+    /** Display mode. */
+    layout?: 'grid' | 'masonry' | 'list';
+    /** Whether upload is allowed. */
+    uploadEnabled?: boolean;
+    /** Filter by type. */
+    typeFilter?: 'photo' | 'video' | 'all';
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+/**
+ * {@link NiceEventParticipants} — Participant list with roles, status, and QR codes.
+ */
+export declare const NiceEventParticipants: default_2.ForwardRefExoticComponent<NiceEventParticipantsProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for {@link NiceEventParticipants}. */
+export declare interface NiceEventParticipantsProps {
+    /** Participants. */
+    participants: EventParticipant[];
+    /** Current user's participant ID (for self-highlight). */
+    currentParticipantId?: string;
+    /** Called when inviting a participant. */
+    onInvite?: () => void;
+    /** Called when removing a participant. */
+    onRemove?: (participantId: string) => void;
+    /** Called when changing a participant's role. */
+    onRoleChange?: (participantId: string, role: ParticipantRole) => void;
+    /** Called when checking in a participant. */
+    onCheckIn?: (participantId: string) => void;
+    /** Called when clicking on a participant. */
+    onParticipantClick?: (participant: EventParticipant) => void;
+    /** Whether to show QR codes for check-in. */
+    showQR?: boolean;
+    /** Whether to allow management actions. */
+    editable?: boolean;
+    /** Max participants. */
+    maxParticipants?: number;
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+/**
+ * {@link NiceEventPlanning} — Event planning with dates, location, surveys, and billing.
+ */
+export declare const NiceEventPlanning: default_2.ForwardRefExoticComponent<NiceEventPlanningProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for {@link NiceEventPlanning}. */
+export declare interface NiceEventPlanningProps {
+    /** Event data. */
+    event: EventModel;
+    /** Surveys. */
+    surveys?: EventSurvey[];
+    /** Billing items. */
+    billing?: BillingItem[];
+    /** Called when updating event details. */
+    onUpdateEvent?: (data: Partial<EventModel>) => void;
+    /** Called when updating location. */
+    onUpdateLocation?: (location: EventLocation) => void;
+    /** Called when adding a survey. */
+    onAddSurvey?: (question: string, type: EventSurvey['type'], options?: string[]) => void;
+    /** Called when submitting survey response. */
+    onSurveyRespond?: (surveyId: string, answer: string | string[] | number) => void;
+    /** Called when adding a billing item. */
+    onAddBilling?: (item: Partial<BillingItem>) => void;
+    /** Whether editing is allowed. */
+    editable?: boolean;
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+/**
+ * {@link NiceKaraokePicker} — Karaoke song picker with queue management.
+ */
+export declare const NiceKaraokePicker: default_2.ForwardRefExoticComponent<NiceKaraokePickerProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for {@link NiceKaraokePicker}. */
+export declare interface NiceKaraokePickerProps {
+    /** Available karaoke songs. */
+    songs: KaraokeSong[];
+    /** Current karaoke queue (ordered). */
+    queue?: KaraokeSong[];
+    /** Called when a song is added to the queue. */
+    onEnqueue?: (songId: string, performerId?: string) => void;
+    /** Called when removing from queue. */
+    onDequeue?: (songId: string) => void;
+    /** Called when skipping to next performer. */
+    onNext?: () => void;
+    /** Current performing song id. */
+    nowPlayingId?: string;
+    /** Whether actions are allowed. */
+    readOnly?: boolean;
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+/**
+ * {@link NiceRoundCard} — Individual round card with actions, timer, and scoreboard.
+ */
+export declare const NiceRoundCard: default_2.ForwardRefExoticComponent<NiceRoundCardProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for {@link NiceRoundCard}. */
+export declare interface NiceRoundCardProps {
+    /** Round data. */
+    round: EventRound;
+    /** Whether the timer is running. */
+    timerRunning?: boolean;
+    /** Remaining seconds (for timer display). */
+    remainingSeconds?: number;
+    /** Called to submit a score for a participant. */
+    onSubmitScore?: (participantId: string, score: number) => void;
+    /** Called to start the round. */
+    onStart?: () => void;
+    /** Called to end the round. */
+    onEnd?: () => void;
+    /** Called to skip the round. */
+    onSkip?: () => void;
+    /** Whether management actions are visible. */
+    editable?: boolean;
+    /** Custom actions to render in the footer. */
+    footerActions?: default_2.ReactNode;
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+/**
+ * {@link NiceRoundList} — Round system list with status and actions.
+ */
+export declare const NiceRoundList: default_2.ForwardRefExoticComponent<NiceRoundListProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for {@link NiceRoundList}. */
+export declare interface NiceRoundListProps {
+    /** Rounds to display. */
+    rounds: EventRound[];
+    /** Currently active round ID. */
+    activeRoundId?: string;
+    /** Called when selecting a round. */
+    onSelect?: (round: EventRound) => void;
+    /** Called to start a round. */
+    onStart?: (roundId: string) => void;
+    /** Called to end a round. */
+    onEnd?: (roundId: string) => void;
+    /** Called to create a new round. */
+    onCreate?: () => void;
+    /** Whether management actions are allowed. */
+    editable?: boolean;
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+/**
+ * {@link NiceSongPicker} — Song selection for music events.
+ */
+export declare const NiceSongPicker: default_2.ForwardRefExoticComponent<NiceSongPickerProps & default_2.RefAttributes<HTMLDivElement>>;
+
+/** Props for {@link NiceSongPicker}. */
+export declare interface NiceSongPickerProps {
+    /** Available songs. */
+    songs: SongEntry[];
+    /** Called when adding a song to the queue/playlist. */
+    onAdd?: (songId: string) => void;
+    /** Called when removing a song. */
+    onRemove?: (songId: string) => void;
+    /** Called when voting for a song. */
+    onVote?: (songId: string) => void;
+    /** Called when searching for songs (external search). */
+    onSearch?: (query: string) => void;
+    /** Whether to show the queue. */
+    showQueue?: boolean;
+    /** Whether actions are allowed. */
+    readOnly?: boolean;
+    className?: string;
+    style?: default_2.CSSProperties;
+}
+
+/** Participant role. */
+export declare type ParticipantRole = 'host' | 'co-host' | 'moderator' | 'participant' | 'spectator' | 'vip';
+
+/** Participant status. */
+export declare type ParticipantStatus = 'invited' | 'confirmed' | 'declined' | 'checked-in' | 'no-show';
+
+/** Round score entry. */
+export declare interface RoundScore {
+    participantId: string;
+    participantName: string;
+    score: number;
+    rank?: number;
+}
+
+/** Round status. */
+export declare type RoundStatus = 'upcoming' | 'active' | 'voting' | 'scored' | 'completed' | 'skipped';
+
+/** Song entry. */
+export declare interface SongEntry {
+    id: string;
+    title: string;
+    artist: string;
+    albumArt?: string;
+    duration?: number;
+    previewUrl?: string;
+    addedById?: string;
+    addedByName?: string;
+    votes?: number;
+    isPlaying?: boolean;
+    isQueued?: boolean;
+}
+
+/** Survey response. */
+export declare interface SurveyResponse {
+    participantId: string;
+    participantName: string;
+    answer: string | string[] | number;
+}
+
+export { }