@stats-forge/github-stats-forge-core 0.3.0 → 0.5.0

package/src/api/organization.ts

@@ -0,0 +1,90 @@
+import * as z from 'zod/mini';
+
+import { renderOrganizationCard } from '../cards/organization/index.ts';
+import { fetchOrganization } from '../fetchers/organization.ts';
+
+import { cardHandler } from './handler.ts';
+import {
+  booleanParam,
+  listParam,
+  localeParam,
+  looseIntParam,
+  numberParam,
+  rawParam,
+  usernameParam,
+} from './params.ts';
+
+/** What the organization endpoint accepts, on top of the shared color params. */
+const orgQuery = z.object({
+  org: usernameParam,
+  hide: listParam,
+  show: listParam,
+  show_icons: booleanParam,
+  hide_title: booleanParam,
+  hide_border: booleanParam,
+  hide_description: booleanParam,
+  card_width: looseIntParam,
+  line_height: rawParam,
+  custom_title: rawParam,
+  disable_animations: booleanParam,
+  number_format: rawParam,
+  text_bold: booleanParam,
+  locale: localeParam,
+  border_radius: numberParam,
+});
+
+/**
+ * Render the organization card for a set of query params.
+ *
+ * @returns The rendered card, or a rendered error.
+ */
+const renderOrg = cardHandler(
+  orgQuery,
+  async (
+    {
+      org,
+      hide,
+      show,
+      show_icons,
+      hide_title,
+      hide_border,
+      hide_description,
+      card_width,
+      line_height,
+      custom_title,
+      disable_animations,
+      number_format,
+      text_bold,
+      locale,
+      border_radius,
+    },
+    colors,
+    config,
+  ) => {
+    const organizationData = await fetchOrganization({ org }, config);
+
+    return renderOrganizationCard(organizationData, {
+      ...colors,
+      hide,
+      show,
+      show_icons,
+      hide_title,
+      hide_border,
+      hide_description,
+      card_width,
+      line_height,
+      custom_title,
+      disable_animations,
+      number_format,
+      text_bold,
+      locale,
+      border_radius,
+    });
+  },
+);
+
+/**
+ * The card, and the values each of its options accepts, keyed by the option's own name.
+ * A UI reads them off the function it calls: `org.OPTIONS.show`.
+ */
+export const org = Object.assign(renderOrg, { OPTIONS: renderOrganizationCard.OPTIONS });

package/src/api/params.ts

@@ -5,8 +5,8 @@ import { COLOR_PARAM_KEYS, THEME_PARAM_KEYS, isValidColorInput } from '../common
 import { GITHUB_USERNAME_PATTERN } from '../common/constants.ts';
 import { getWidestRange, parseRangeDate } from '../common/date.ts';
 import { CardError } from '../common/error.ts';
+import { isLocaleAvailable } from '../common/localize.ts';
 import { parseArray, parseBoolean } from '../common/ops.ts';
-import { isLocaleAvailable } from '../translations.ts';
 
 /**
  * @file The api layer is the trust boundary:

package/src/api/pin.ts

@@ -1,6 +1,6 @@
 import * as z from 'zod/mini';
 
-import { renderRepoCard } from '../cards/repo.ts';
+import { renderRepoCard } from '../cards/repo/index.ts';
 import { fetchRepo } from '../fetchers/repo.ts';
 
 import { cardHandler } from './handler.ts';

package/src/api/stats.ts

@@ -1,6 +1,6 @@
 import * as z from 'zod/mini';
 
-import { renderStatsCard } from '../cards/stats.ts';
+import { renderStatsCard } from '../cards/stats/index.ts';
 import { OWNER_AFFILIATIONS } from '../common/constants.ts';
 import { fetchStats } from '../fetchers/stats.ts';
 

package/src/api/top-langs.ts

@@ -1,6 +1,6 @@
 import * as z from 'zod/mini';
 
-import { renderTopLanguages } from '../cards/top-languages.ts';
+import { renderTopLanguages } from '../cards/top-languages/index.ts';
 import { OWNER_AFFILIATIONS } from '../common/constants.ts';
 import { fetchTopLanguages } from '../fetchers/top-languages.ts';
 

package/src/api/wakatime.ts

@@ -1,6 +1,6 @@
 import * as z from 'zod/mini';
 
-import { renderWakatimeCard } from '../cards/wakatime.ts';
+import { renderWakatimeCard } from '../cards/wakatime/index.ts';
 import { fetchWakatimeStats } from '../fetchers/wakatime.ts';
 
 import { cardHandler } from './handler.ts';

package/src/cards/{contributed-to.ts → contributed-to/index.ts}

@@ -1,17 +1,18 @@
-import { CARD_ICON, CARD_WIDTH, FONT_SIZE, firefoxFontSize, font } from '../common/brand.ts';
-import { Card } from '../common/Card.ts';
-import { getLightDarkColors } from '../common/color.ts';
-import { formatYears } from '../common/date.ts';
-import { kFormatter } from '../common/fmt.ts';
-import { I18n } from '../common/I18n.ts';
-import { clampValue } from '../common/ops.ts';
-import { createProgressNode, measureText } from '../common/render.ts';
-import type { ContributedRepo, ContributedToData } from '../fetchers/types.ts';
-import type { Child } from '../markup/index.ts';
-import { atRule, el, rule } from '../markup/index.ts';
-import { contributedToCardLocales } from '../translations.ts';
+import { CARD_ICON, CARD_WIDTH, FONT_SIZE, firefoxFontSize, font } from '../../common/brand.ts';
+import { Card } from '../../common/Card.ts';
+import { getLightDarkColors } from '../../common/color.ts';
+import { formatYears } from '../../common/date.ts';
+import { kFormatter } from '../../common/fmt.ts';
+import type { Localized } from '../../common/localize.ts';
+import { localize } from '../../common/localize.ts';
+import { clampValue } from '../../common/ops.ts';
+import { createProgressNode, measureText } from '../../common/render.ts';
+import type { ContributedRepo, ContributedToData } from '../../fetchers/types.ts';
+import type { Child } from '../../markup/index.ts';
+import { atRule, el, rule } from '../../markup/index.ts';
+import type { CardOptions, CommonCardOptions } from '../options.ts';
 
-import type { CardOptions, CommonCardOptions } from './options.ts';
+import { contributedToCardLocales } from './locales.ts';
 
 const CARD_DEFAULT_WIDTH = CARD_WIDTH.wide;
 const MIN_CARD_WIDTH = 340;
@@ -53,9 +54,6 @@ interface ContributedToCardOptions extends CommonCardOptions {
   hide_years: boolean;
 }
 
-/** The card's own translation table, so `t` is checked against the keys it declares. */
-type ContributedToI18n = I18n<ReturnType<typeof contributedToCardLocales>>;
-
 /**
  * The title, naming the account unless that makes it too wide for the card.
  *
@@ -64,11 +62,13 @@ type ContributedToI18n = I18n<ReturnType<typeof contributedToCardLocales>>;
  *
  * @returns The default title, which `custom_title` still overrides.
  */
-const defaultTitleFor = (i18n: ContributedToI18n, contentWidth: number): string => {
-  const named = i18n.t('contributedtocard.title');
-  return measureText(named, TITLE_FONT_SIZE) <= contentWidth
-    ? named
-    : i18n.t('contributedtocard.title-unnamed');
+const defaultTitleFor = (
+  t: Localized<typeof contributedToCardLocales>,
+  login: string,
+  contentWidth: number,
+): string => {
+  const named = t.title({ login });
+  return measureText(named, TITLE_FONT_SIZE) <= contentWidth ? named : t.titleUnnamed();
 };
 
 /**
@@ -190,19 +190,21 @@ const createRepoRow = ({
  * @returns The footer text.
  */
 const footerText = ({
-  i18n,
+  t,
   shown,
   totalRepos,
   years,
 }: {
-  i18n: ContributedToI18n;
+  t: Localized<typeof contributedToCardLocales>;
   shown: number;
   totalRepos: number;
   /** Empty when the year marks are hidden, which is what puts the years on the card. */
   years: Array<number>;
 }): string => {
   const parts = [
-    i18n.t(shown < totalRepos ? 'contributedtocard.footer-top' : 'contributedtocard.footer-all'),
+    shown < totalRepos
+      ? t.footerTop({ shown, count: totalRepos })
+      : t.footerAll({ count: totalRepos }),
   ];
 
   const [firstYear] = years;
@@ -261,12 +263,9 @@ const renderContributedToCard = (
     }),
   );
 
-  const i18n = new I18n({
-    locale,
-    translations: contributedToCardLocales({ login, shown: repos.length, totalRepos }),
-  });
+  const t = localize(contributedToCardLocales, locale);
 
-  const footer = footerText({ i18n, shown: repos.length, totalRepos, years });
+  const footer = footerText({ t, shown: repos.length, totalRepos, years });
   const footerY = FIRST_ROW_Y + Math.max(repos.length, 1) * rowHeight + FOOTER_GAP;
   const height = BODY_OFFSET_Y + footerY + BOTTOM_PADDING;
 
@@ -274,7 +273,7 @@ const renderContributedToCard = (
 
   const card = new Card({
     customTitle: custom_title,
-    defaultTitle: defaultTitleFor(i18n, contentWidth - TITLE_ICON_COLUMN),
+    defaultTitle: defaultTitleFor(t, login, contentWidth - TITLE_ICON_COLUMN),
     titlePrefixIcon: CARD_ICON.contributedTo,
     width,
     height,
@@ -342,14 +341,18 @@ const renderContributedToCard = (
   card.setAccessibilityLabel({
     title: card.title,
     desc: [
-      ...repos.map((repo) => {
-        const inYears = hide_years
-          ? ''
-          : `, ${i18n.t('contributedtocard.years')}: ${repo.years.join(', ')}`;
-        return `${repo.nameWithOwner}: ${repo.contributions} ${i18n.t(
-          'contributedtocard.contributions',
-        )}${inYears}`;
-      }),
+      ...repos.map((repo) =>
+        hide_years
+          ? t.accessibilityRepo({
+              repo: repo.nameWithOwner,
+              count: repo.contributions,
+            })
+          : t.accessibilityRepoYears({
+              repo: repo.nameWithOwner,
+              count: repo.contributions,
+              years: repo.years.join(', '),
+            }),
+      ),
       footer,
     ].join('; '),
   });
@@ -362,7 +365,7 @@ const renderContributedToCard = (
         ? el(
             'text',
             { class: 'repo-name', 'data-testid': 'no-repos', x: 0, y: FIRST_ROW_Y },
-            i18n.t('contributedtocard.no-contributions'),
+            t.noContributions(),
           )
         : rows,
       el('text', { class: 'footer', 'data-testid': 'footer', x: 0, y: footerY }, footer),

package/src/cards/contributed-to/locales.ts

@@ -0,0 +1,41 @@
+import { defineLocales } from '../../common/localize.ts';
+
+/** The contributed-to card's labels in the locales they have been translated into. */
+const contributedToCardLocales = defineLocales({
+  title: {
+    en: 'Repositories {login} contributed to',
+  },
+  // Drawn instead of the title above when naming the account overruns the card.
+  titleUnnamed: {
+    en: 'Repositories contributed to',
+  },
+  noContributions: {
+    en: 'No contributions found',
+  },
+  footerAll: {
+    en: { one: '{count} repository', other: '{count} repositories' },
+  },
+  footerTop: {
+    en: {
+      one: 'top {shown} of {count} repository',
+      other: 'top {shown} of {count} repositories',
+    },
+  },
+  // One row of what an assistive reader gets in place of the card, whose inner text
+  // `role="img"` hides. The year marks carry information no other element does, so the
+  // row naming them is a wording of its own rather than a fragment appended to the other.
+  accessibilityRepo: {
+    en: {
+      one: '{repo}: {count} contribution',
+      other: '{repo}: {count} contributions',
+    },
+  },
+  accessibilityRepoYears: {
+    en: {
+      one: '{repo}: {count} contribution, years: {years}',
+      other: '{repo}: {count} contributions, years: {years}',
+    },
+  },
+});
+
+export { contributedToCardLocales };

package/src/cards/{gist.ts → gist/index.ts}

@@ -1,11 +1,11 @@
-import { CARD_ICON, CARD_WIDTH, FONT_SIZE, font } from '../common/brand.ts';
-import { Card } from '../common/Card.ts';
-import { getLightDarkColors } from '../common/color.ts';
-import { kFormatter } from '../common/fmt.ts';
-import { I18n } from '../common/I18n.ts';
-import { icons } from '../common/icons.ts';
-import { getLanguageColor } from '../common/languageColors.ts';
-import { parseEmojis } from '../common/ops.ts';
+import { CARD_ICON, CARD_WIDTH, FONT_SIZE, font } from '../../common/brand.ts';
+import { Card } from '../../common/Card.ts';
+import { getLightDarkColors } from '../../common/color.ts';
+import { kFormatter } from '../../common/fmt.ts';
+import { icons } from '../../common/icons.ts';
+import { getLanguageColor } from '../../common/languageColors.ts';
+import { localize } from '../../common/localize.ts';
+import { parseEmojis } from '../../common/ops.ts';
 import {
   countWrappedLines,
   wrapTextMultiline,
@@ -15,13 +15,13 @@ import {
   measureText,
   wrappedTextNode,
   wrappedTextStyles,
-} from '../common/render.ts';
-import type { GistData } from '../fetchers/types.ts';
-import type { Child } from '../markup/index.ts';
-import { el, rule } from '../markup/index.ts';
-import { gistCardLocales } from '../translations.ts';
+} from '../../common/render.ts';
+import type { GistData } from '../../fetchers/types.ts';
+import type { Child } from '../../markup/index.ts';
+import { el, rule } from '../../markup/index.ts';
+import type { CardOptions, CommonCardOptions } from '../options.ts';
 
-import type { CardOptions, CommonCardOptions } from './options.ts';
+import { gistCardLocales } from './locales.ts';
 
 const ICON_SIZE = 16;
 const CARD_DEFAULT_WIDTH = CARD_WIDTH.standard;
@@ -56,9 +56,9 @@ const renderGistCard = (gistData: GistData, options: CardOptions<GistCardOptions
 
   const { lightColors, darkColors } = getLightDarkColors({ ...options, theme });
 
-  const i18n = new I18n({ locale, translations: gistCardLocales });
+  const t = localize(gistCardLocales, locale);
 
-  const desc = parseEmojis(description || i18n.t('gistcard.no-description'));
+  const desc = parseEmojis(description || t.noDescription());
 
   let descriptionLines: number;
   let descriptionSvg: Child;
@@ -108,7 +108,7 @@ const renderGistCard = (gistData: GistData, options: CardOptions<GistCardOptions
   const svgStars = iconWithLabel(icons.star, totalStars, 'starsCount', ICON_SIZE);
   const svgForks = iconWithLabel(icons.fork, totalForks, 'forksCount', ICON_SIZE);
 
-  const languageName = language || i18n.t('gistcard.unspecified-language');
+  const languageName = language || t.unspecifiedLanguage();
   const languageColor = getLanguageColor(languageName);
 
   const svgLanguage = createLanguageNode(languageName, languageColor);
@@ -161,9 +161,12 @@ const renderGistCard = (gistData: GistData, options: CardOptions<GistCardOptions
   // shows has to be repeated here.
   card.setAccessibilityLabel({
     title: card.title,
-    desc: `${desc}. ${i18n.t('gistcard.language')}: ${languageName}, ${i18n.t(
-      'gistcard.stars',
-    )}: ${totalStars}, ${i18n.t('gistcard.forks')}: ${totalForks}`,
+    desc: t.accessibilityDesc({
+      desc,
+      language: languageName,
+      stars: totalStars,
+      forks: totalForks,
+    }),
   });
 
   return card.render([

package/src/cards/gist/locales.ts

@@ -0,0 +1,17 @@
+import { defineLocales } from '../../common/localize.ts';
+
+/** The gist card's labels in the locales they have been translated into. */
+const gistCardLocales = defineLocales({
+  noDescription: {
+    en: 'No description provided',
+  },
+  unspecifiedLanguage: {
+    en: 'Unspecified',
+  },
+  // What an assistive reader gets in place of the card, whose inner text `role="img"` hides.
+  accessibilityDesc: {
+    en: '{desc}. Language: {language}, Stars: {stars}, Forks: {forks}',
+  },
+});
+
+export { gistCardLocales };