contrib-graphs 0.0.0-stage → 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,232 @@
+
+/**
+ * `contrib-graphs`: los componentes. El build antepone "use client" a este
+ * archivo para que se puedan importar desde Server Components (Next.js).
+ * En código de servidor usa `contrib-graphs/data`.
+ */
+import { A as ThemePalette, C as ContributionDay, D as GraphTheme, E as MonthLabel, M as themeNames, N as themeVars, O as LevelColors, P as themes, S as ColorMode, T as LevelScale, _ as formatDate, a as fromDates, b as Calendar, c as mergeSources, d as sampleProfiles, f as CalendarOptions, g as cropCalendar, h as computeStats, i as fetchGitLabContributions, j as resolveTheme, k as ThemeName, l as SampleProfile, m as buildCalendar, n as GitHubCalendarResponse, o as fromGitHub, p as GraphStats, r as fetchGitHubContributions, s as fromGitLab, t as GITHUB_CONTRIBUTIONS_QUERY, u as generateSampleData, v as makeLevelFn, w as Level, x as CalendarDay, y as BaseGraphProps } from "./data-DptvXfjH.cjs";
+/** Props of `ClassicGraph` and `DotsGraph`. */
+interface GridGraphProps extends BaseGraphProps {
+  /**
+   * Size of each cell in px.
+   * @default 11
+   */
+  cellSize?: number;
+  /**
+   * Space between cells in px.
+   * @default 3
+   */
+  gap?: number;
+  /**
+   * Corner radius in px; use `cellSize / 2` for circles. Classic only.
+   * @default 2
+   */
+  radius?: number;
+  /**
+   * Show Mon/Wed/Fri labels.
+   * @default true
+   */
+  showWeekdays?: boolean;
+  /**
+   * Show month labels.
+   * @default true
+   */
+  showMonths?: boolean;
+  /**
+   * Add a glow to the busiest days.
+   * @default false
+   */
+  glow?: boolean;
+  /**
+   * On narrow screens, `crop` drops the oldest weeks and `scale` shrinks the SVG.
+   * @default 'crop'
+   */
+  fit?: 'crop' | 'scale';
+}
+/** The classic weeks × days grid. */
+export declare function ClassicGraph(props: GridGraphProps): import("react").JSX.Element;
+/** Circles whose size also encodes intensity, so it still reads in monochrome. */
+export declare function DotsGraph(props: GridGraphProps): import("react").JSX.Element;
+/** Props of `IsometricGraph`. */
+interface IsometricGraphProps extends BaseGraphProps {
+  /**
+   * Width of each tile in px.
+   * @default 12
+   */
+  tileSize?: number;
+  /**
+   * Height of the tallest column in px.
+   * @default 48
+   */
+  maxHeight?: number;
+  /**
+   * `count` scales columns by the actual count; `level` uses five fixed heights.
+   * @default 'count'
+   */
+  heightBy?: 'count' | 'level';
+  /**
+   * Show longest streak, current streak and best day in the header.
+   * @default true
+   */
+  showStats?: boolean;
+  /**
+   * Labels of the three stats.
+   * @default ['longest streak', 'current streak', 'best day']
+   */
+  statLabels?: readonly [string, string, string];
+}
+/** Isometric columns whose height shows each day's activity. */
+export declare function IsometricGraph(props: IsometricGraphProps): import("react").JSX.Element;
+/** Props of `RadialGraph`. */
+interface RadialGraphProps extends BaseGraphProps {
+  /**
+   * Diameter in px.
+   * @default 320
+   */
+  size?: number;
+  /**
+   * Inner radius as a fraction of the outer radius.
+   * @default 0.38
+   */
+  innerRadius?: number;
+  /**
+   * Show month labels around the ring.
+   * @default true
+   */
+  showMonths?: boolean;
+  /**
+   * Show the header with the total. The total is already in the center of the ring.
+   * @default false
+   */
+  showTotal?: boolean;
+}
+/** The year as a ring: each week is a slice and each weekday a band. */
+export declare function RadialGraph(props: RadialGraphProps): import("react").JSX.Element;
+/** Props of `SkylineGraph`. It works by week, so it takes `onWeekClick` instead of `onDayClick`. */
+interface SkylineGraphProps extends Omit<BaseGraphProps, 'onDayClick'> {
+  /**
+   * Height of the tallest building in px.
+   * @default 110
+   */
+  height?: number;
+  /**
+   * Width of each building in px.
+   * @default 9
+   */
+  barWidth?: number;
+  /**
+   * Space between buildings in px.
+   * @default 3
+   */
+  gap?: number;
+  /**
+   * Draw seven windows per building, lit on the days with activity.
+   * @default true
+   */
+  windows?: boolean;
+  /**
+   * On narrow screens, `crop` drops the oldest weeks and `scale` shrinks the SVG.
+   * @default 'crop'
+   */
+  fit?: 'crop' | 'scale';
+  /** Called when a week is clicked, or with Enter or Space while it is focused. */
+  onWeekClick?: (week: SkylineWeek) => void;
+}
+/** A week as passed to `onWeekClick`. */
+interface SkylineWeek {
+  index: number;
+  days: CalendarDay[];
+  total: number;
+  activeDays: number;
+  level: Level;
+}
+/** One building per week: your year as a city skyline. */
+export declare function SkylineGraph(props: SkylineGraphProps): import("react").JSX.Element;
+export declare const terminalCharsets: {
+  readonly blocks: readonly ["··", "░░", "▒▒", "▓▓", "██"];
+  readonly squares: readonly ["□ ", "▪ ", "■ ", "■ ", "■ "];
+  readonly ascii: readonly [". ", ": ", "+ ", "# ", "@ "];
+  readonly dots: readonly ["· ", "• ", "• ", "● ", "● "];
+};
+type TerminalCharset = keyof typeof terminalCharsets;
+/** Props of `TerminalGraph`. */
+interface TerminalGraphProps extends BaseGraphProps {
+  /**
+   * Characters for each level: `blocks` (░▒▓█), `squares`, `ascii` or `dots`.
+   * @default 'blocks'
+   */
+  charset?: TerminalCharset;
+  /**
+   * Command shown in the first prompt line.
+   * @default "git log --since='1 year ago' | heatmap"
+   */
+  command?: string;
+  /**
+   * Text before the command.
+   * @default '~ $'
+   */
+  prompt?: string;
+  /**
+   * Color the characters with the theme; `false` is monochrome.
+   * @default true
+   */
+  colored?: boolean;
+  /**
+   * On narrow screens, `crop` drops the oldest weeks and `scale` shrinks the text (down to 6px, then crops).
+   * @default 'crop'
+   */
+  fit?: 'crop' | 'scale';
+  /**
+   * Labels at both ends of the legend.
+   * @default ['less', 'more']
+   */
+  legendLabels?: readonly [string, string];
+}
+/** Real monospace text, for portfolios with a terminal look. */
+export declare function TerminalGraph(props: TerminalGraphProps): import("react").JSX.Element;
+/** Props of `CompactGraph`. It shows days rather than weeks, so `weeks`, `weekStart` and `periodLabel` don't apply. */
+interface CompactGraphProps extends Omit<BaseGraphProps, 'weeks' | 'weekStart' | 'periodLabel'> {
+  /**
+   * Number of days to show.
+   * @default 30
+   */
+  days?: number;
+  /**
+   * Size of each cell in px.
+   * @default 10
+   */
+  cellSize?: number;
+  /**
+   * Space between cells in px.
+   * @default 3
+   */
+  gap?: number;
+  /**
+   * Corner radius in px.
+   * @default 2
+   */
+  radius?: number;
+  /**
+   * Show the current streak next to the total.
+   * @default true
+   */
+  showStreak?: boolean;
+  /**
+   * Streak text, given the number of days.
+   * @default (n) => `${n} day streak`
+   */
+  streakLabel?: (n: number) => string;
+  /**
+   * Text after the total, given the number of days.
+   * @default (days) => `in the last ${days} days`
+   */
+  rangeLabel?: (days: number) => string;
+  /**
+   * Show the Less–More legend.
+   * @default false
+   */
+  showLegend?: boolean;
+}
+/** A single row with the last N days, for headers, cards and footers. */
+export declare function CompactGraph(props: CompactGraphProps): import("react").JSX.Element;
+export { type BaseGraphProps, type Calendar, type CalendarDay, type CalendarOptions, type ColorMode, type CompactGraphProps, type ContributionDay, GITHUB_CONTRIBUTIONS_QUERY, GitHubCalendarResponse, type GraphStats, type GraphTheme, type GridGraphProps, type IsometricGraphProps, type Level, type LevelColors, type LevelScale, type MonthLabel, type RadialGraphProps, type SampleProfile, type SkylineGraphProps, type SkylineWeek, type TerminalCharset, type TerminalGraphProps, type ThemeName, type ThemePalette, buildCalendar, computeStats, cropCalendar, fetchGitHubContributions, fetchGitLabContributions, formatDate, fromDates, fromGitHub, fromGitLab, generateSampleData, makeLevelFn, mergeSources, resolveTheme, sampleProfiles, themeNames, themeVars, themes };

package/dist/index.d.ts

@@ -0,0 +1,232 @@
+
+/**
+ * `contrib-graphs`: los componentes. El build antepone "use client" a este
+ * archivo para que se puedan importar desde Server Components (Next.js).
+ * En código de servidor usa `contrib-graphs/data`.
+ */
+import { A as ThemePalette, C as ContributionDay, D as GraphTheme, E as MonthLabel, M as themeNames, N as themeVars, O as LevelColors, P as themes, S as ColorMode, T as LevelScale, _ as formatDate, a as fromDates, b as Calendar, c as mergeSources, d as sampleProfiles, f as CalendarOptions, g as cropCalendar, h as computeStats, i as fetchGitLabContributions, j as resolveTheme, k as ThemeName, l as SampleProfile, m as buildCalendar, n as GitHubCalendarResponse, o as fromGitHub, p as GraphStats, r as fetchGitHubContributions, s as fromGitLab, t as GITHUB_CONTRIBUTIONS_QUERY, u as generateSampleData, v as makeLevelFn, w as Level, x as CalendarDay, y as BaseGraphProps } from "./data-DptvXfjH.js";
+/** Props of `ClassicGraph` and `DotsGraph`. */
+interface GridGraphProps extends BaseGraphProps {
+  /**
+   * Size of each cell in px.
+   * @default 11
+   */
+  cellSize?: number;
+  /**
+   * Space between cells in px.
+   * @default 3
+   */
+  gap?: number;
+  /**
+   * Corner radius in px; use `cellSize / 2` for circles. Classic only.
+   * @default 2
+   */
+  radius?: number;
+  /**
+   * Show Mon/Wed/Fri labels.
+   * @default true
+   */
+  showWeekdays?: boolean;
+  /**
+   * Show month labels.
+   * @default true
+   */
+  showMonths?: boolean;
+  /**
+   * Add a glow to the busiest days.
+   * @default false
+   */
+  glow?: boolean;
+  /**
+   * On narrow screens, `crop` drops the oldest weeks and `scale` shrinks the SVG.
+   * @default 'crop'
+   */
+  fit?: 'crop' | 'scale';
+}
+/** The classic weeks × days grid. */
+export declare function ClassicGraph(props: GridGraphProps): import("react").JSX.Element;
+/** Circles whose size also encodes intensity, so it still reads in monochrome. */
+export declare function DotsGraph(props: GridGraphProps): import("react").JSX.Element;
+/** Props of `IsometricGraph`. */
+interface IsometricGraphProps extends BaseGraphProps {
+  /**
+   * Width of each tile in px.
+   * @default 12
+   */
+  tileSize?: number;
+  /**
+   * Height of the tallest column in px.
+   * @default 48
+   */
+  maxHeight?: number;
+  /**
+   * `count` scales columns by the actual count; `level` uses five fixed heights.
+   * @default 'count'
+   */
+  heightBy?: 'count' | 'level';
+  /**
+   * Show longest streak, current streak and best day in the header.
+   * @default true
+   */
+  showStats?: boolean;
+  /**
+   * Labels of the three stats.
+   * @default ['longest streak', 'current streak', 'best day']
+   */
+  statLabels?: readonly [string, string, string];
+}
+/** Isometric columns whose height shows each day's activity. */
+export declare function IsometricGraph(props: IsometricGraphProps): import("react").JSX.Element;
+/** Props of `RadialGraph`. */
+interface RadialGraphProps extends BaseGraphProps {
+  /**
+   * Diameter in px.
+   * @default 320
+   */
+  size?: number;
+  /**
+   * Inner radius as a fraction of the outer radius.
+   * @default 0.38
+   */
+  innerRadius?: number;
+  /**
+   * Show month labels around the ring.
+   * @default true
+   */
+  showMonths?: boolean;
+  /**
+   * Show the header with the total. The total is already in the center of the ring.
+   * @default false
+   */
+  showTotal?: boolean;
+}
+/** The year as a ring: each week is a slice and each weekday a band. */
+export declare function RadialGraph(props: RadialGraphProps): import("react").JSX.Element;
+/** Props of `SkylineGraph`. It works by week, so it takes `onWeekClick` instead of `onDayClick`. */
+interface SkylineGraphProps extends Omit<BaseGraphProps, 'onDayClick'> {
+  /**
+   * Height of the tallest building in px.
+   * @default 110
+   */
+  height?: number;
+  /**
+   * Width of each building in px.
+   * @default 9
+   */
+  barWidth?: number;
+  /**
+   * Space between buildings in px.
+   * @default 3
+   */
+  gap?: number;
+  /**
+   * Draw seven windows per building, lit on the days with activity.
+   * @default true
+   */
+  windows?: boolean;
+  /**
+   * On narrow screens, `crop` drops the oldest weeks and `scale` shrinks the SVG.
+   * @default 'crop'
+   */
+  fit?: 'crop' | 'scale';
+  /** Called when a week is clicked, or with Enter or Space while it is focused. */
+  onWeekClick?: (week: SkylineWeek) => void;
+}
+/** A week as passed to `onWeekClick`. */
+interface SkylineWeek {
+  index: number;
+  days: CalendarDay[];
+  total: number;
+  activeDays: number;
+  level: Level;
+}
+/** One building per week: your year as a city skyline. */
+export declare function SkylineGraph(props: SkylineGraphProps): import("react").JSX.Element;
+export declare const terminalCharsets: {
+  readonly blocks: readonly ["··", "░░", "▒▒", "▓▓", "██"];
+  readonly squares: readonly ["□ ", "▪ ", "■ ", "■ ", "■ "];
+  readonly ascii: readonly [". ", ": ", "+ ", "# ", "@ "];
+  readonly dots: readonly ["· ", "• ", "• ", "● ", "● "];
+};
+type TerminalCharset = keyof typeof terminalCharsets;
+/** Props of `TerminalGraph`. */
+interface TerminalGraphProps extends BaseGraphProps {
+  /**
+   * Characters for each level: `blocks` (░▒▓█), `squares`, `ascii` or `dots`.
+   * @default 'blocks'
+   */
+  charset?: TerminalCharset;
+  /**
+   * Command shown in the first prompt line.
+   * @default "git log --since='1 year ago' | heatmap"
+   */
+  command?: string;
+  /**
+   * Text before the command.
+   * @default '~ $'
+   */
+  prompt?: string;
+  /**
+   * Color the characters with the theme; `false` is monochrome.
+   * @default true
+   */
+  colored?: boolean;
+  /**
+   * On narrow screens, `crop` drops the oldest weeks and `scale` shrinks the text (down to 6px, then crops).
+   * @default 'crop'
+   */
+  fit?: 'crop' | 'scale';
+  /**
+   * Labels at both ends of the legend.
+   * @default ['less', 'more']
+   */
+  legendLabels?: readonly [string, string];
+}
+/** Real monospace text, for portfolios with a terminal look. */
+export declare function TerminalGraph(props: TerminalGraphProps): import("react").JSX.Element;
+/** Props of `CompactGraph`. It shows days rather than weeks, so `weeks`, `weekStart` and `periodLabel` don't apply. */
+interface CompactGraphProps extends Omit<BaseGraphProps, 'weeks' | 'weekStart' | 'periodLabel'> {
+  /**
+   * Number of days to show.
+   * @default 30
+   */
+  days?: number;
+  /**
+   * Size of each cell in px.
+   * @default 10
+   */
+  cellSize?: number;
+  /**
+   * Space between cells in px.
+   * @default 3
+   */
+  gap?: number;
+  /**
+   * Corner radius in px.
+   * @default 2
+   */
+  radius?: number;
+  /**
+   * Show the current streak next to the total.
+   * @default true
+   */
+  showStreak?: boolean;
+  /**
+   * Streak text, given the number of days.
+   * @default (n) => `${n} day streak`
+   */
+  streakLabel?: (n: number) => string;
+  /**
+   * Text after the total, given the number of days.
+   * @default (days) => `in the last ${days} days`
+   */
+  rangeLabel?: (days: number) => string;
+  /**
+   * Show the Less–More legend.
+   * @default false
+   */
+  showLegend?: boolean;
+}
+/** A single row with the last N days, for headers, cards and footers. */
+export declare function CompactGraph(props: CompactGraphProps): import("react").JSX.Element;
+export { type BaseGraphProps, type Calendar, type CalendarDay, type CalendarOptions, type ColorMode, type CompactGraphProps, type ContributionDay, GITHUB_CONTRIBUTIONS_QUERY, GitHubCalendarResponse, type GraphStats, type GraphTheme, type GridGraphProps, type IsometricGraphProps, type Level, type LevelColors, type LevelScale, type MonthLabel, type RadialGraphProps, type SampleProfile, type SkylineGraphProps, type SkylineWeek, type TerminalCharset, type TerminalGraphProps, type ThemeName, type ThemePalette, buildCalendar, computeStats, cropCalendar, fetchGitHubContributions, fetchGitLabContributions, formatDate, fromDates, fromGitHub, fromGitLab, generateSampleData, makeLevelFn, mergeSources, resolveTheme, sampleProfiles, themeNames, themeVars, themes };