@stats-forge/github-stats-forge-core 0.0.2 → 0.2.0

package/build/api/pin.js

@@ -1,11 +1,11 @@
 import * as z from 'zod/mini';
 import { renderRepoCard } from '../cards/repo.js';
 import { fetchRepo } from '../fetchers/repo.js';
-import { errorResult } from './api-result.js';
-import { booleanParam, listParam, localeParam, looseIntParam, numberParam, parseColorParams, parseParams, rawParam, safeParam, } from './params.js';
+import { cardHandler } from './handler.js';
+import { booleanParam, listParam, localeParam, looseIntParam, numberParam, rawParam, safeParam, usernameParam, } from './params.js';
 /** What the pin endpoint accepts, on top of the shared color params. */
 const pinQuery = z.object({
-    username: safeParam,
+    username: usernameParam,
     repo: safeParam,
     hide_border: booleanParam,
     card_width: looseIntParam,
@@ -23,65 +23,37 @@ const pinQuery = z.object({
 /**
  * Render the repository card for a set of query params.
  *
- * @param query Raw query params, plus any of the shared color params.
- * @param query.username GitHub username the repository belongs to.
- * @param query.repo Repository name.
- * @param query.hide_border Whether to hide the card border.
- * @param query.card_width Card width.
- * @param query.show_owner Whether to show the repository owner.
- * @param query.browser_rendering Whether the browser wraps the description text.
- * @param query.show Comma-separated extra stats to show.
- * @param query.show_icons Whether to show the stat icons.
- * @param query.number_format How numbers are abbreviated.
- * @param query.text_bold Whether the stat values are bold.
- * @param query.line_height Line height between the stats.
- * @param query.locale Language the card is rendered in.
- * @param query.border_radius Card border radius.
- * @param query.description_lines_count Lines the description is wrapped to.
- * @param config Deployment config supplying the PAT pool.
  * @returns The rendered card, or a rendered error.
  */
-export const pin = async (query, config) => {
-    let colors;
-    try {
-        colors = parseColorParams(query);
-    }
-    catch (err) {
-        // A rejected color cannot be used to draw its own error card.
-        return errorResult(err);
-    }
-    try {
-        const { username, repo, hide_border, card_width, show_owner, browser_rendering, show, show_icons, number_format, text_bold, line_height, locale, border_radius, description_lines_count, } = parseParams(pinQuery, query);
-        const repoData = await fetchRepo({
-            username,
-            reponame: repo,
-            include_prs_authored: show.includes('prs_authored'),
-            include_prs_commented: show.includes('prs_commented'),
-            include_prs_reviewed: show.includes('prs_reviewed'),
-            include_issues_authored: show.includes('issues_authored'),
-            include_issues_commented: show.includes('issues_commented'),
-        }, config);
-        return {
-            status: 'success',
-            content: renderRepoCard(repoData, {
-                ...colors,
-                hide_border,
-                border_radius,
-                card_width_input: card_width,
-                show_owner,
-                browser_rendering,
-                show,
-                show_icons,
-                number_format,
-                text_bold,
-                line_height,
-                username,
-                locale,
-                description_lines_count,
-            }),
-        };
-    }
-    catch (err) {
-        return errorResult(err, colors);
-    }
-};
+const renderPin = cardHandler(pinQuery, async ({ username, repo, hide_border, card_width, show_owner, browser_rendering, show, show_icons, number_format, text_bold, line_height, locale, border_radius, description_lines_count, }, colors, config) => {
+    const repoData = await fetchRepo({
+        username,
+        reponame: repo,
+        include_prs_authored: show.includes('prs_authored'),
+        include_prs_commented: show.includes('prs_commented'),
+        include_prs_reviewed: show.includes('prs_reviewed'),
+        include_issues_authored: show.includes('issues_authored'),
+        include_issues_commented: show.includes('issues_commented'),
+    }, config);
+    return renderRepoCard(repoData, {
+        ...colors,
+        hide_border,
+        border_radius,
+        card_width_input: card_width,
+        show_owner,
+        browser_rendering,
+        show,
+        show_icons,
+        number_format,
+        text_bold,
+        line_height,
+        username,
+        locale,
+        description_lines_count,
+    });
+});
+/**
+ * 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: `pin.OPTIONS.show`.
+ */
+export const pin = Object.assign(renderPin, { OPTIONS: renderRepoCard.OPTIONS });

package/build/api/stats.d.ts

@@ -1,9 +1,9 @@
 import * as z from 'zod/mini';
-import type { CardConfig } from '../common/config.js';
-import type { ApiResult } from './api-result.js';
-import type { ApiQuery } from './params.js';
-/** What the stats endpoint accepts, on top of the shared color params. */
-declare const statsQuery: z.ZodMiniObject<{
+/**
+ * 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: `stats.OPTIONS.rank_icon`.
+ */
+export declare const stats: ((query: import("./params.ts").ApiQuery<z.ZodMiniObject<{
     username: z.ZodMiniType<string | undefined, string | undefined, z.core.$ZodTypeInternals<string | undefined, string | undefined>>;
     repo: z.ZodMiniType<string[], string | undefined, z.core.$ZodTypeInternals<string[], string | undefined>>;
     owner: z.ZodMiniType<string[], string | undefined, z.core.$ZodTypeInternals<string[], string | undefined>>;
@@ -14,7 +14,8 @@ declare const statsQuery: z.ZodMiniObject<{
     hide_rank: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
     show_icons: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
     include_all_commits: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
-    commits_year: z.ZodMiniType<number | undefined, string | undefined, z.core.$ZodTypeInternals<number | undefined, string | undefined>>;
+    from: z.ZodMiniType<Date | undefined, string | undefined, z.core.$ZodTypeInternals<Date | undefined, string | undefined>>;
+    to: z.ZodMiniType<Date | undefined, string | undefined, z.core.$ZodTypeInternals<Date | undefined, string | undefined>>;
     line_height: z.ZodMiniOptional<z.ZodMiniString<string>>;
     text_bold: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
     exclude_repo: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<string[], string | undefined>>;
@@ -28,15 +29,13 @@ declare const statsQuery: z.ZodMiniObject<{
     rank_icon: z.ZodMiniType<"default" | "github" | "percentile" | undefined, string | undefined, z.core.$ZodTypeInternals<"default" | "github" | "percentile" | undefined, string | undefined>>;
     show: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<string[], string | undefined>>;
     contribs_include_own_repos: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
-}, z.core.$strip>;
-/** The query this endpoint accepts, checked against the schema above. */
-type StatsApiQuery = ApiQuery<typeof statsQuery>;
-/**
- * The card, with the values its enum params accept.
- * A UI reads them off the function it calls, e.g. `stats.LAYOUTS`.
- */
-export declare const stats: ((query: StatsApiQuery, config: CardConfig) => Promise<ApiResult>) & {
-    RANK_ICONS: readonly ["default", "github", "percentile"];
+}, z.core.$strip>>, config: import("./index.ts").CardConfig) => Promise<import("./api-result.ts").ApiResult>) & {
+    OPTIONS: {
+        rank_icon: readonly ["default", "github", "percentile"];
+        show: readonly ["contributions", "prs_merged", "prs_merged_percentage", "reviews", "discussions_started", "discussions_answered", "prs_authored", "prs_commented", "prs_reviewed", "issues_authored", "issues_commented", "all_time_contribs"];
+        hide: readonly ["stars", "commits", "prs", "issues", "contribs"];
+        number_format: readonly ["short", "long"];
+        role: import("../graphql/generated/common.ts").RepositoryAffiliation[];
+    };
 };
-export {};
 //# sourceMappingURL=stats.d.ts.map

package/build/api/stats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../src/api/stats.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAG9B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAgB5C,0EAA0E;AAC1E,QAAA,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;iBAyBd,CAAC;AAEH,yEAAyE;AACzE,KAAK,aAAa,GAAG,QAAQ,CAAC,OAAO,UAAU,CAAC,CAAC;AAuIjD;;;GAGG;AACH,eAAO,MAAM,KAAK,WA1GgB,aAAa,UAAU,UAAU,KAAG,OAAO,CAAC,SAAS,CAAC;;CA4GtF,CAAC"}
+{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../src/api/stats.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAuJ9B;;;GAGG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAEhB,CAAC"}

package/build/api/stats.js

@@ -1,11 +1,13 @@
 import * as z from 'zod/mini';
-import { RANK_ICONS, renderStatsCard } from '../cards/stats.js';
+import { renderStatsCard } from '../cards/stats.js';
+import { OWNER_AFFILIATIONS } from '../common/constants.js';
 import { fetchStats } from '../fetchers/stats.js';
-import { errorResult } from './api-result.js';
-import { booleanParam, enumParam, listParam, localeParam, looseIntParam, numberParam, parseColorParams, parseParams, rawParam, safeListParam, safeParam, yearParam, } from './params.js';
+import { cardHandler } from './handler.js';
+import { booleanParam, enumParam, fromParam, listParam, localeParam, looseIntParam, numberParam, ORDERED_RANGE, rawParam, safeListParam, toParam, usernameParam, } from './params.js';
 /** What the stats endpoint accepts, on top of the shared color params. */
-const statsQuery = z.object({
-    username: safeParam,
+const statsQuery = z
+    .object({
+    username: usernameParam,
     repo: safeListParam,
     owner: safeListParam,
     hide: listParam,
@@ -15,7 +17,8 @@ const statsQuery = z.object({
     hide_rank: booleanParam,
     show_icons: booleanParam,
     include_all_commits: booleanParam,
-    commits_year: yearParam,
+    from: fromParam,
+    to: toParam,
     line_height: rawParam,
     text_bold: booleanParam,
     exclude_repo: listParam,
@@ -26,107 +29,65 @@ const statsQuery = z.object({
     number_format: rawParam,
     role: listParam,
     number_precision: looseIntParam,
-    rank_icon: enumParam(RANK_ICONS),
+    rank_icon: enumParam(renderStatsCard.OPTIONS.rank_icon),
     show: listParam,
     contribs_include_own_repos: booleanParam,
-});
+})
+    .check(ORDERED_RANGE);
 /**
  * Render the stats card for a set of query params.
  *
- * @param query Raw query params, plus any of the shared color params.
- * @param query.username GitHub username.
- * @param query.repo Comma-separated repositories the search-based stats are scoped to.
- * @param query.owner Comma-separated owners the search-based stats are scoped to.
- * @param query.hide Comma-separated stats to hide.
- * @param query.hide_title Whether to hide the card title.
- * @param query.hide_border Whether to hide the card border.
- * @param query.card_width Card width.
- * @param query.hide_rank Whether to hide the rank circle.
- * @param query.show_icons Whether to show the stat icons.
- * @param query.include_all_commits Whether to count commits of all time.
- * @param query.commits_year Year the commits are counted for.
- * @param query.line_height Line height between the stats.
- * @param query.text_bold Whether the stat values are bold.
- * @param query.exclude_repo Comma-separated repositories to exclude.
- * @param query.custom_title Card title.
- * @param query.locale Language the card is rendered in.
- * @param query.disable_animations Whether to disable the card animations.
- * @param query.border_radius Card border radius.
- * @param query.number_format How numbers are abbreviated.
- * @param query.role Comma-separated owner affiliations to include.
- * @param query.number_precision Decimals kept when a number is abbreviated.
- * @param query.rank_icon Which rank indicator to draw.
- * @param query.show Comma-separated extra stats to show.
- * @param query.contribs_include_own_repos Whether the contributed-to counts include the user's own repositories.
- * @param config Deployment config supplying the PAT pool.
  * @returns The rendered card, or a rendered error.
  */
-const renderStats = async (query, config) => {
-    let colors;
-    try {
-        colors = parseColorParams(query);
-    }
-    catch (err) {
-        // A rejected color cannot be used to draw its own error card.
-        return errorResult(err);
-    }
-    try {
-        const { username, repo, owner, hide, hide_title, hide_border, card_width, hide_rank, show_icons, include_all_commits, commits_year, line_height, text_bold, exclude_repo, custom_title, locale, disable_animations, border_radius, number_format, role, number_precision, rank_icon, show, contribs_include_own_repos, } = parseParams(statsQuery, query);
-        // A bare repo name is scoped to the user whose card this is.
-        const repository = repo.map((name) => name.includes('/') ? name : `${username ?? ''}/${name}`);
-        const stats = await fetchStats({
-            username,
-            include_all_commits,
-            exclude_repo,
-            include_merged_pull_requests: show.includes('prs_merged') || show.includes('prs_merged_percentage'),
-            include_discussions: show.includes('discussions_started'),
-            include_discussions_answers: show.includes('discussions_answered'),
-            commits_year,
-            repo: repository,
-            owner,
-            include_prs_authored: show.includes('prs_authored'),
-            include_prs_commented: show.includes('prs_commented'),
-            include_prs_reviewed: show.includes('prs_reviewed'),
-            include_issues_authored: show.includes('issues_authored'),
-            include_issues_commented: show.includes('issues_commented'),
-            ownerAffiliations: role,
-            include_contributions: show.includes('contributions'),
-            include_all_time_contribs: show.includes('all_time_contribs'),
-            contribs_include_own_repos,
-        }, config);
-        return {
-            status: 'success',
-            content: renderStatsCard(stats, {
-                ...colors,
-                hide,
-                show_icons,
-                hide_title,
-                hide_border,
-                card_width,
-                hide_rank,
-                include_all_commits,
-                commits_year,
-                line_height,
-                text_bold,
-                custom_title,
-                border_radius,
-                number_format,
-                number_precision,
-                locale,
-                disable_animations,
-                rank_icon,
-                show,
-            }, username, repository, owner),
-        };
-    }
-    catch (err) {
-        return errorResult(err, colors);
-    }
-};
+const renderStats = cardHandler(statsQuery, async ({ username, repo, owner, hide, hide_title, hide_border, card_width, hide_rank, show_icons, include_all_commits, from, to, line_height, text_bold, exclude_repo, custom_title, locale, disable_animations, border_radius, number_format, role, number_precision, rank_icon, show, contribs_include_own_repos, }, colors, config) => {
+    // A bare repo name is scoped to the user whose card this is.
+    const repository = repo.map((name) => name.includes('/') ? name : `${username ?? ''}/${name}`);
+    const stats = await fetchStats({
+        username,
+        include_all_commits,
+        exclude_repo,
+        include_merged_pull_requests: show.includes('prs_merged') || show.includes('prs_merged_percentage'),
+        include_discussions: show.includes('discussions_started'),
+        include_discussions_answers: show.includes('discussions_answered'),
+        from,
+        to,
+        repo: repository,
+        owner,
+        include_prs_authored: show.includes('prs_authored'),
+        include_prs_commented: show.includes('prs_commented'),
+        include_prs_reviewed: show.includes('prs_reviewed'),
+        include_issues_authored: show.includes('issues_authored'),
+        include_issues_commented: show.includes('issues_commented'),
+        ownerAffiliations: role,
+        include_contributions: show.includes('contributions'),
+        include_all_time_contribs: show.includes('all_time_contribs'),
+        contribs_include_own_repos,
+    }, config);
+    return renderStatsCard(stats, {
+        ...colors,
+        hide,
+        show_icons,
+        hide_title,
+        hide_border,
+        card_width,
+        hide_rank,
+        include_all_commits,
+        line_height,
+        text_bold,
+        custom_title,
+        border_radius,
+        number_format,
+        number_precision,
+        locale,
+        disable_animations,
+        rank_icon,
+        show,
+    }, username, repository, owner);
+});
 /**
- * The card, with the values its enum params accept.
- * A UI reads them off the function it calls, e.g. `stats.LAYOUTS`.
+ * 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: `stats.OPTIONS.rank_icon`.
  */
 export const stats = Object.assign(renderStats, {
-    RANK_ICONS,
+    OPTIONS: { ...renderStatsCard.OPTIONS, role: OWNER_AFFILIATIONS },
 });

package/build/api/top-langs.d.ts

@@ -1,15 +1,15 @@
 import * as z from 'zod/mini';
-import type { CardConfig } from '../common/config.js';
-import type { ApiResult } from './api-result.js';
-import type { ApiQuery } from './params.js';
-/** What the top-languages endpoint accepts, on top of the shared color params. */
-declare const topLangsQuery: z.ZodMiniObject<{
+/**
+ * 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: `topLangs.OPTIONS.layout`.
+ */
+export declare const topLangs: ((query: import("./params.ts").ApiQuery<z.ZodMiniObject<{
     username: z.ZodMiniType<string | undefined, string | undefined, z.core.$ZodTypeInternals<string | undefined, string | undefined>>;
     hide: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<string[], string | undefined>>;
     hide_title: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
     hide_border: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
     card_width: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<number | undefined, string | undefined>>;
-    layout: z.ZodMiniType<"compact" | "normal" | "donut" | "donut-vertical" | "pie" | undefined, string | undefined, z.core.$ZodTypeInternals<"compact" | "normal" | "donut" | "donut-vertical" | "pie" | undefined, string | undefined>>;
+    layout: z.ZodMiniType<"compact" | "donut" | "donut-vertical" | "normal" | "pie" | undefined, string | undefined, z.core.$ZodTypeInternals<"compact" | "donut" | "donut-vertical" | "normal" | "pie" | undefined, string | undefined>>;
     langs_count: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<number | undefined, string | undefined>>;
     exclude_repo: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<string[], string | undefined>>;
     size_weight: z.ZodMiniType<number | undefined, string | undefined, z.core.$ZodTypeInternals<number | undefined, string | undefined>>;
@@ -21,17 +21,12 @@ declare const topLangsQuery: z.ZodMiniObject<{
     disable_animations: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
     hide_progress: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
     hide_values: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
-    stats_format: z.ZodMiniType<"percentages" | "bytes" | undefined, string | undefined, z.core.$ZodTypeInternals<"percentages" | "bytes" | undefined, string | undefined>>;
-}, z.core.$strip>;
-/** The query this endpoint accepts, checked against the schema above. */
-type TopLangsApiQuery = ApiQuery<typeof topLangsQuery>;
-/**
- * The card, with the values its enum params accept.
- * A UI reads them off the function it calls, e.g. `topLangs.LAYOUTS`.
- */
-export declare const topLangs: ((query: TopLangsApiQuery, config: CardConfig) => Promise<ApiResult>) & {
-    LAYOUTS: readonly ["compact", "normal", "donut", "donut-vertical", "pie"];
-    STATS_FORMATS: readonly ["percentages", "bytes"];
+    stats_format: z.ZodMiniType<"bytes" | "percentages" | undefined, string | undefined, z.core.$ZodTypeInternals<"bytes" | "percentages" | undefined, string | undefined>>;
+}, z.core.$strip>>, config: import("./index.ts").CardConfig) => Promise<import("./api-result.ts").ApiResult>) & {
+    OPTIONS: {
+        layout: readonly ["compact", "normal", "donut", "donut-vertical", "pie"];
+        stats_format: readonly ["percentages", "bytes"];
+        role: import("../graphql/generated/common.ts").RepositoryAffiliation[];
+    };
 };
-export {};
 //# sourceMappingURL=top-langs.d.ts.map

package/build/api/top-langs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"top-langs.d.ts","sourceRoot":"","sources":["../../src/api/top-langs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAO9B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAc5C,kFAAkF;AAClF,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;iBAmBjB,CAAC;AAEH,yEAAyE;AACzE,KAAK,gBAAgB,GAAG,QAAQ,CAAC,OAAO,aAAa,CAAC,CAAC;AA6FvD;;;GAGG;AACH,eAAO,MAAM,QAAQ,WAtEgB,gBAAgB,UAAU,UAAU,KAAG,OAAO,CAAC,SAAS,CAAC;;;CAyE5F,CAAC"}
+{"version":3,"file":"top-langs.d.ts","sourceRoot":"","sources":["../../src/api/top-langs.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAqG9B;;;GAGG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;CAEnB,CAAC"}

package/build/api/top-langs.js

@@ -1,16 +1,17 @@
 import * as z from 'zod/mini';
-import { TOP_LANG_LAYOUTS, TOP_LANG_STATS_FORMATS, renderTopLanguages, } from '../cards/top-languages.js';
+import { renderTopLanguages } from '../cards/top-languages.js';
+import { OWNER_AFFILIATIONS } from '../common/constants.js';
 import { fetchTopLanguages } from '../fetchers/top-languages.js';
-import { errorResult } from './api-result.js';
-import { booleanParam, enumParam, listParam, localeParam, looseIntParam, numberParam, parseColorParams, parseParams, rawParam, safeParam, } from './params.js';
+import { cardHandler } from './handler.js';
+import { booleanParam, enumParam, listParam, localeParam, looseIntParam, numberParam, rawParam, usernameParam, } from './params.js';
 /** What the top-languages endpoint accepts, on top of the shared color params. */
 const topLangsQuery = z.object({
-    username: safeParam,
+    username: usernameParam,
     hide: listParam,
     hide_title: booleanParam,
     hide_border: booleanParam,
     card_width: looseIntParam,
-    layout: enumParam(TOP_LANG_LAYOUTS),
+    layout: enumParam(renderTopLanguages.OPTIONS.layout),
     langs_count: looseIntParam,
     exclude_repo: listParam,
     size_weight: numberParam,
@@ -22,80 +23,42 @@ const topLangsQuery = z.object({
     disable_animations: booleanParam,
     hide_progress: booleanParam,
     hide_values: booleanParam,
-    stats_format: enumParam(TOP_LANG_STATS_FORMATS),
+    stats_format: enumParam(renderTopLanguages.OPTIONS.stats_format),
 });
 /**
  * Render the top languages card for a set of query params.
  *
- * @param query Raw query params, plus any of the shared color params.
- * @param query.username GitHub username.
- * @param query.hide Comma-separated languages to hide.
- * @param query.hide_title Whether to hide the card title.
- * @param query.hide_border Whether to hide the card border.
- * @param query.card_width Card width.
- * @param query.layout How the languages are laid out.
- * @param query.langs_count Number of languages to show.
- * @param query.exclude_repo Comma-separated repositories to exclude.
- * @param query.size_weight Weight given to a language's size.
- * @param query.count_weight Weight given to a language's repository count.
- * @param query.custom_title Card title.
- * @param query.locale Language the card is rendered in.
- * @param query.border_radius Card border radius.
- * @param query.role Comma-separated owner affiliations to include.
- * @param query.disable_animations Whether to disable the card animations.
- * @param query.hide_progress Whether to hide the progress bars.
- * @param query.hide_values Whether to hide the language values.
- * @param query.stats_format Whether values are shown as bytes or percentages.
- * @param config Deployment config supplying the PAT pool.
  * @returns The rendered card, or a rendered error.
  */
-const renderTopLangs = async (query, config) => {
-    let colors;
-    try {
-        colors = parseColorParams(query);
-    }
-    catch (err) {
-        // A rejected color cannot be used to draw its own error card.
-        return errorResult(err);
-    }
-    try {
-        const { username, hide, hide_title, hide_border, card_width, layout, langs_count, exclude_repo, size_weight, count_weight, custom_title, locale, border_radius, role, disable_animations, hide_progress, hide_values, stats_format, } = parseParams(topLangsQuery, query);
-        const topLangs = await fetchTopLanguages({
-            username,
-            exclude_repo,
-            size_weight,
-            count_weight,
-            ownerAffiliations: role,
-        }, config);
-        return {
-            status: 'success',
-            content: renderTopLanguages(topLangs, {
-                ...colors,
-                custom_title,
-                hide_title,
-                hide_border,
-                card_width,
-                hide,
-                layout,
-                langs_count,
-                border_radius,
-                locale,
-                disable_animations,
-                hide_progress,
-                hide_values,
-                stats_format,
-            }),
-        };
-    }
-    catch (err) {
-        return errorResult(err, colors);
-    }
-};
+const renderTopLangs = cardHandler(topLangsQuery, async ({ username, hide, hide_title, hide_border, card_width, layout, langs_count, exclude_repo, size_weight, count_weight, custom_title, locale, border_radius, role, disable_animations, hide_progress, hide_values, stats_format, }, colors, config) => {
+    const topLangs = await fetchTopLanguages({
+        username,
+        exclude_repo,
+        size_weight,
+        count_weight,
+        ownerAffiliations: role,
+    }, config);
+    return renderTopLanguages(topLangs, {
+        ...colors,
+        custom_title,
+        hide_title,
+        hide_border,
+        card_width,
+        hide,
+        layout,
+        langs_count,
+        border_radius,
+        locale,
+        disable_animations,
+        hide_progress,
+        hide_values,
+        stats_format,
+    });
+});
 /**
- * The card, with the values its enum params accept.
- * A UI reads them off the function it calls, e.g. `topLangs.LAYOUTS`.
+ * 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: `topLangs.OPTIONS.layout`.
  */
 export const topLangs = Object.assign(renderTopLangs, {
-    LAYOUTS: TOP_LANG_LAYOUTS,
-    STATS_FORMATS: TOP_LANG_STATS_FORMATS,
+    OPTIONS: { ...renderTopLanguages.OPTIONS, role: OWNER_AFFILIATIONS },
 });

package/build/api/wakatime.d.ts

@@ -1,9 +1,9 @@
 import * as z from 'zod/mini';
-import type { CardConfig } from '../common/config.js';
-import type { ApiResult } from './api-result.js';
-import type { ApiQuery } from './params.js';
-/** What the wakatime endpoint accepts, on top of the shared color params. */
-declare const wakatimeQuery: z.ZodMiniObject<{
+/**
+ * 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: `wakatime.OPTIONS.layout`.
+ */
+export declare const wakatime: ((query: import("./params.ts").ApiQuery<z.ZodMiniObject<{
     username: z.ZodMiniType<string | undefined, string | undefined, z.core.$ZodTypeInternals<string | undefined, string | undefined>>;
     hide_border: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
     card_width: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<number | undefined, string | undefined>>;
@@ -17,18 +17,12 @@ declare const wakatimeQuery: z.ZodMiniObject<{
     hide: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<string[], string | undefined>>;
     api_domain: z.ZodMiniOptional<z.ZodMiniString<string>>;
     border_radius: z.ZodMiniType<number | undefined, string | undefined, z.core.$ZodTypeInternals<number | undefined, string | undefined>>;
-    display_format: z.ZodMiniType<"time" | "percent" | undefined, string | undefined, z.core.$ZodTypeInternals<"time" | "percent" | undefined, string | undefined>>;
+    display_format: z.ZodMiniType<"percent" | "time" | undefined, string | undefined, z.core.$ZodTypeInternals<"percent" | "time" | undefined, string | undefined>>;
     disable_animations: z.ZodMiniPipe<z.ZodMiniOptional<z.ZodMiniString<string>>, z.ZodMiniTransform<boolean | undefined, string | undefined>>;
-}, z.core.$strip>;
-/** The query this endpoint accepts, checked against the schema above. */
-type WakatimeApiQuery = ApiQuery<typeof wakatimeQuery>;
-/**
- * The card, with the values its enum params accept.
- * A UI reads them off the function it calls, e.g. `wakatime.LAYOUTS`.
- */
-export declare const wakatime: ((query: WakatimeApiQuery, config: CardConfig) => Promise<ApiResult>) & {
-    LAYOUTS: readonly ["compact", "normal"];
-    DISPLAY_FORMATS: readonly ["time", "percent"];
+}, z.core.$strip>>, config: import("./index.ts").CardConfig) => Promise<import("./api-result.ts").ApiResult>) & {
+    OPTIONS: {
+        layout: readonly ["compact", "normal"];
+        display_format: readonly ["time", "percent"];
+    };
 };
-export {};
 //# sourceMappingURL=wakatime.d.ts.map

package/build/api/wakatime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wakatime.d.ts","sourceRoot":"","sources":["../../src/api/wakatime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAG9B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAc5C,6EAA6E;AAC7E,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;iBAgBjB,CAAC;AAEH,yEAAyE;AACzE,KAAK,gBAAgB,GAAG,QAAQ,CAAC,OAAO,aAAa,CAAC,CAAC;AAgFvD;;;GAGG;AACH,eAAO,MAAM,QAAQ,WA1DgB,gBAAgB,UAAU,UAAU,KAAG,OAAO,CAAC,SAAS,CAAC;;;CA6D5F,CAAC"}
+{"version":3,"file":"wakatime.d.ts","sourceRoot":"","sources":["../../src/api/wakatime.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAuF9B;;;GAGG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;CAAyE,CAAC"}