@sevn/elections-components 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,351 @@
+interface HeaderProps {
+    title: string;
+    description?: string;
+    tag?: string;
+    tagColor?: string;
+}
+
+interface CandidateSummary {
+    candidate_id: string;
+    name: string;
+    party_abbr: string;
+    party_color: string;
+    valid_votes_pct: number;
+    votes: number;
+    elected?: boolean;
+}
+interface StateResult {
+    state: string;
+    state_name: string;
+    status: string;
+    ballots_counted_pct: number;
+    leader: CandidateSummary;
+    runner_up: CandidateSummary;
+}
+interface StateResults {
+    office: string;
+    round: number;
+    last_updated: string;
+    states: StateResult[];
+    overview?: Overview;
+}
+interface Overview {
+    valid_votes: number;
+    null_votes: number;
+    blank_votes: number;
+}
+interface HeadToHeadCandidateMeta {
+    candidate_id: string;
+    name: string;
+    party_abbr: string;
+    party_color: string;
+}
+interface HeadToHeadLivePoint {
+    minute_offset: number;
+    timestamp: string;
+    ballots_counted_pct: number;
+    candidate_a_pct: number;
+    candidate_b_pct: number;
+    candidate_a_votes: number;
+    candidate_b_votes: number;
+}
+interface HeadToHeadLiveTimeline {
+    office: string;
+    round: number;
+    state: string | null;
+    interval_minutes: number;
+    started_at: string;
+    candidate_a: HeadToHeadCandidateMeta;
+    candidate_b: HeadToHeadCandidateMeta;
+    points: HeadToHeadLivePoint[];
+}
+
+/**
+ * Props públicas dos componentes.
+ *
+ * Este arquivo é a fonte única da superfície pública do pacote: os `.svelte`
+ * anotam o `$props()` com estas interfaces, e o `.d.ts` publicado é gerado a
+ * partir daqui. Assim o tipo que o consumidor vê não tem como divergir do que
+ * o componente realmente aceita.
+ */
+
+/** Props aceitas por todos os 25 componentes. */
+interface BaseComponentProps {
+    /** Renderiza com dados de exemplo, sem tocar na API. */
+    mock?: boolean;
+    /** Remove o cartão externo (borda, fundo, respiro) para encaixar em layout próprio. */
+    rawStyle?: boolean;
+    /** Título, descrição e tag exibidos no topo do componente. */
+    header?: HeaderProps;
+}
+interface FinalResultsProps extends BaseComponentProps {
+    /** Exibe o espaço publicitário do componente. */
+    showAd?: boolean;
+    /** Dados prontos, para pular a chamada de API. Use com `mock: false`. */
+    data?: any | null;
+    /** Resultados por estado prontos, para pular a chamada de API. */
+    stateResults?: StateResults | null;
+}
+interface StateWinnersProps extends BaseComponentProps {
+    /** Dados prontos, para pular a chamada de API. Use com `mock: false`. */
+    data?: any | null;
+}
+interface VoteCountingProgressProps extends BaseComponentProps {
+    /** Dados prontos, para pular a chamada de API. Use com `mock: false`. */
+    data?: HeadToHeadLiveTimeline | null;
+}
+interface VoteComparisonByRoundProps extends BaseComponentProps {
+    /** Cargo selecionado ao abrir. O usuário pode trocar no filtro. */
+    defaultOffice?: 'president' | 'governor';
+}
+interface CountingProgressProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+    /** Cargo selecionado ao abrir. O usuário pode trocar no filtro. */
+    defaultOffice?: 'president' | 'governor';
+}
+interface StateLeadersProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+    /** Cargo selecionado ao abrir. O usuário pode trocar no filtro. */
+    defaultOffice?: 'president' | 'governor';
+}
+interface CurrentLeaderProps extends BaseComponentProps {
+    /** Dados prontos, para pular a chamada de API. Use com `mock: false`. */
+    data?: any | null;
+}
+interface TopDisputeProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+}
+interface CandidateRankingProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+}
+interface LiveSummaryProps extends BaseComponentProps {
+    /** Dados prontos, para pular a chamada de API. Use com `mock: false`. */
+    data?: any | null;
+}
+interface CandidatePerformanceByMunicipalityProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+    /** Cargo selecionado ao abrir. O usuário pode trocar no filtro. */
+    defaultOffice?: 'president' | 'governor';
+}
+interface RoundResultsAnalysisProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+    /** Cargo selecionado ao abrir. O usuário pode trocar no filtro. */
+    defaultOffice?: 'president' | 'governor';
+}
+interface ElectionStatusProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+    /** Cargo selecionado ao abrir. O usuário pode trocar no filtro. */
+    defaultOffice?: 'president' | 'governor';
+}
+interface CandidateResultsByMunicipalityProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+}
+interface MunicipalityPerfomanceMapProps extends BaseComponentProps {
+    /** Dados prontos, para pular a chamada de API. Use com `mock: false`. */
+    data?: any | null;
+    /** Ano da eleição consultada. */
+    year?: number;
+}
+interface CandidateByStateProps extends BaseComponentProps {
+    /** Dados prontos, para pular a chamada de API. Use com `mock: false`. */
+    data?: any | null;
+    /** Ano da eleição consultada. */
+    year?: number;
+}
+interface CandidateCarrouselStateResultsViewerProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+    /** Cargo consultado. */
+    office?: string;
+}
+interface CandidateDuelStateResultViewerProps extends BaseComponentProps {
+    /** Dados prontos, para pular a chamada de API. Use com `mock: false`. */
+    data?: any | null;
+    /** Ano da eleição consultada. */
+    year?: number;
+    /** Exibe a tag de posição (1º, 2º…) ao lado do candidato. */
+    showPosition?: boolean;
+    /** Cor da tag de posição. Padrão: a cor do próprio candidato. */
+    positionTagColor?: string;
+}
+interface CandidateMapByStateProps extends BaseComponentProps {
+    /** Dados prontos, para pular a chamada de API. Use com `mock: false`. */
+    data?: any | null;
+}
+interface ElectionRoundAnalysisProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+}
+interface CandidateMultiRingChartPerformanceByMunicipalityProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+}
+interface ResultsByOfficeProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+    /** Cargo selecionado ao abrir. O usuário pode trocar no filtro. */
+    defaultOffice?: 'senator' | 'federal_deputy' | 'state_deputy';
+    /** Linhas por página na tabela. */
+    itemsPerPage?: number;
+}
+interface VotingMapProps extends BaseComponentProps {
+    /** Exibe o espaço publicitário do componente. */
+    showAd?: boolean;
+    /** Ano da eleição consultada. */
+    year?: number;
+    /** Turno da eleição. */
+    round?: number;
+}
+interface CandidateCountingProgressProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+}
+interface PartyPerformanceProps extends BaseComponentProps {
+    /** Ano da eleição consultada. */
+    year?: number;
+}
+
+/** Cores customizáveis pelo consumidor. Viram custom properties `--sevn-color-*`. */
+interface SevnTheme {
+    primary?: string;
+    secondary?: string;
+    tertiary?: string;
+    neutral?: string;
+    red?: string;
+    green?: string;
+    blue?: string;
+    yellow?: string;
+    textSecondary?: string;
+}
+interface SevnConfig {
+    /** Chave do cliente. É o subdomínio da API dele. */
+    key: string | null;
+    /** Hosts na ordem de tentativa. Derivado da key, ou definido à mão. */
+    apiHosts: string[];
+    /** Base da CDN de arquivos estáticos compartilhados (mapas, índice de cidades). */
+    assetsBase: string;
+    /** Versão do layout de arquivos na CDN estática. */
+    assetsVersion: string;
+    cache: {
+        storageKey: string;
+        maxEntries: number;
+    };
+    request: {
+        /** Timeout de cada tentativa individual. */
+        timeoutMs: number;
+        /** Tentativas por host antes de passar para o próximo. */
+        retriesPerHost: number;
+        /** Espera entre tentativas no mesmo host. */
+        retryDelayMs: number;
+        /** Por quanto tempo fica fixado num host secundário antes de retentar o primário. */
+        stickyWindowMs: number;
+    };
+    theme: SevnTheme | null;
+}
+interface ConfigureOptions extends Partial<Omit<SevnConfig, 'cache' | 'request'>> {
+    cache?: Partial<SevnConfig['cache']>;
+    request?: Partial<SevnConfig['request']>;
+}
+/**
+ * Aplica a chave do cliente. É o único passo obrigatório de configuração —
+ * a partir dela saem os hosts da API daquele cliente.
+ */
+declare function applyKey(key: string): void;
+/**
+ * Sobrescreve configuração. Existe para o showcase, staging e testes apontarem
+ * para outra API sem precisar inventar um subdomínio de cliente.
+ */
+declare function configure(options: ConfigureOptions): void;
+declare function getConfig(): Readonly<SevnConfig>;
+/** True quando há hosts resolvidos — via key ou via `configure({ apiHosts })`. */
+declare function isReady(): boolean;
+/** URL de um arquivo na CDN estática compartilhada. */
+declare function assetUrl(path: string): string;
+
+/** Host que respondeu por último. Útil para diagnóstico. */
+declare function activeHost(): string | null;
+
+/**
+ * Erro de integração: o consumidor não chamou `Core.applyKey()` antes de montar
+ * um componente. A mensagem é exibida direto na UI (cada componente já embrulha
+ * a chamada de API num `.catch`), então precisa ser legível por humanos.
+ */
+declare class SevnKeyMissingError extends Error {
+    constructor();
+}
+/** Erro de rede após esgotar todos os hosts (primário, secundário e failover). */
+declare class SevnNetworkError extends Error {
+    constructor(url: string, cause?: unknown);
+}
+
+/**
+ * Configuração global do pacote. O único passo obrigatório é `applyKey`.
+ *
+ * ```js
+ * import { Core } from '@sevn/elections-components';
+ * Core.applyKey('minha-chave');
+ * ```
+ *
+ * No UMD a chave é lida automaticamente do `?cid=` da própria tag `<script>`.
+ */
+declare const Core: {
+    applyKey: typeof applyKey;
+    configure(options: Parameters<typeof configure>[0]): void;
+    getConfig: typeof getConfig;
+    isReady: typeof isReady;
+    assetUrl: typeof assetUrl;
+    /** Cor(es) a sobrescrever, sem mexer no resto da configuração. */
+    setTheme(theme: SevnTheme): void;
+    /** Host que respondeu por último. Diagnóstico. */
+    activeHost: typeof activeHost;
+};
+
+/** Onde montar: um elemento, ou um seletor CSS resolvido no momento da criação. */
+type SevnTarget = Element | string;
+type SevnOptions<P> = P & {
+    target: SevnTarget;
+};
+interface SevnInstance {
+    /** Desmonta e remove o componente do DOM. */
+    destroy(): Promise<void>;
+}
+interface SevnComponent<P> {
+    new (options: SevnOptions<P>): SevnInstance;
+}
+
+declare const FinalResults: SevnComponent<FinalResultsProps>;
+declare const StateWinners: SevnComponent<StateWinnersProps>;
+declare const VoteCountingProgress: SevnComponent<VoteCountingProgressProps>;
+declare const VoteComparisonByRound: SevnComponent<VoteComparisonByRoundProps>;
+declare const CountingProgress: SevnComponent<CountingProgressProps>;
+declare const StateLeaders: SevnComponent<StateLeadersProps>;
+declare const CurrentLeader: SevnComponent<CurrentLeaderProps>;
+declare const TopDispute: SevnComponent<TopDisputeProps>;
+declare const CandidateRanking: SevnComponent<CandidateRankingProps>;
+declare const LiveSummary: SevnComponent<LiveSummaryProps>;
+declare const CandidatePerformanceByMunicipality: SevnComponent<CandidatePerformanceByMunicipalityProps>;
+declare const RoundResultsAnalysis: SevnComponent<RoundResultsAnalysisProps>;
+declare const ElectionStatus: SevnComponent<ElectionStatusProps>;
+declare const CandidateResultsByMunicipality: SevnComponent<CandidateResultsByMunicipalityProps>;
+declare const MunicipalityPerfomanceMap: SevnComponent<MunicipalityPerfomanceMapProps>;
+declare const CandidateByState: SevnComponent<CandidateByStateProps>;
+declare const CandidateCarrouselStateResultsViewer: SevnComponent<CandidateCarrouselStateResultsViewerProps>;
+declare const CandidateDuelStateResultViewer: SevnComponent<CandidateDuelStateResultViewerProps>;
+declare const CandidateMapByState: SevnComponent<CandidateMapByStateProps>;
+declare const ElectionRoundAnalysis: SevnComponent<ElectionRoundAnalysisProps>;
+declare const CandidateMultiRingChartPerformanceByMunicipality: SevnComponent<CandidateMultiRingChartPerformanceByMunicipalityProps>;
+declare const ResultsByOffice: SevnComponent<ResultsByOfficeProps>;
+declare const VotingMap: SevnComponent<VotingMapProps>;
+declare const CandidateCountingProgress: SevnComponent<CandidateCountingProgressProps>;
+declare const PartyPerformance: SevnComponent<PartyPerformanceProps>;
+
+export { CandidateByState, CandidateCarrouselStateResultsViewer, CandidateCountingProgress, CandidateDuelStateResultViewer, CandidateMapByState, CandidateMultiRingChartPerformanceByMunicipality, CandidatePerformanceByMunicipality, CandidateRanking, CandidateResultsByMunicipality, Core, CountingProgress, CurrentLeader, ElectionRoundAnalysis, ElectionStatus, FinalResults, LiveSummary, MunicipalityPerfomanceMap, PartyPerformance, ResultsByOffice, RoundResultsAnalysis, SevnKeyMissingError, SevnNetworkError, StateLeaders, StateWinners, TopDispute, VoteComparisonByRound, VoteCountingProgress, VotingMap };
+export type { BaseComponentProps, CandidateByStateProps, CandidateCarrouselStateResultsViewerProps, CandidateCountingProgressProps, CandidateDuelStateResultViewerProps, CandidateMapByStateProps, CandidateMultiRingChartPerformanceByMunicipalityProps, CandidatePerformanceByMunicipalityProps, CandidateRankingProps, CandidateResultsByMunicipalityProps, ConfigureOptions, CountingProgressProps, CurrentLeaderProps, ElectionRoundAnalysisProps, ElectionStatusProps, FinalResultsProps, HeaderProps, LiveSummaryProps, MunicipalityPerfomanceMapProps, PartyPerformanceProps, ResultsByOfficeProps, RoundResultsAnalysisProps, SevnComponent, SevnConfig, SevnInstance, SevnOptions, SevnTarget, SevnTheme, StateLeadersProps, StateWinnersProps, TopDisputeProps, VoteComparisonByRoundProps, VoteCountingProgressProps, VotingMapProps };