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

package/build/cards/top-languages.d.ts

@@ -1,11 +1,11 @@
-import type { Lang, TopLangData } from '../fetchers/types.js';
-import type { CardOptions, CommonCardOptions } from './options.js';
+import type { Lang, TopLangData } from '../fetchers/types.ts';
+import type { CardOptions, CommonCardOptions } from './options.ts';
 declare const MIN_CARD_WIDTH = 280;
 /** Layouts the card can draw; the api validates `layout` against this. */
-declare const TOP_LANG_LAYOUTS: readonly ["compact", "normal", "donut", "donut-vertical", "pie"];
+declare const TOP_LANG_LAYOUTS: readonly ['compact', 'normal', 'donut', 'donut-vertical', 'pie'];
 type TopLangLayout = (typeof TOP_LANG_LAYOUTS)[number];
 /** How a language's value is shown; the api validates `stats_format` against this. */
-declare const TOP_LANG_STATS_FORMATS: readonly ["percentages", "bytes"];
+declare const TOP_LANG_STATS_FORMATS: readonly ['percentages', 'bytes'];
 type TopLangStatsFormat = (typeof TOP_LANG_STATS_FORMATS)[number];
 interface TopLangOptions extends CommonCardOptions {
     locale: string;
@@ -24,31 +24,24 @@ interface TopLangOptions extends CommonCardOptions {
 /**
  * Retrieves the programming language whose name is the longest.
  *
- * @param arr Array of programming languages.
  * @returns Longest programming language object.
  */
-declare const getLongestLang: (arr: Array<Lang>) => Pick<Lang, "name" | "size" | "color">;
+declare const getLongestLang: (arr: Array<Lang>) => Pick<Lang, 'name' | 'size' | 'color'>;
 /**
  * Convert degrees to radians.
  *
- * @param angleInDegrees Angle in degrees.
  * @returns Angle in radians.
  */
 declare const degreesToRadians: (angleInDegrees: number) => number;
 /**
  * Convert radians to degrees.
  *
- * @param angleInRadians Angle in radians.
  * @returns Angle in degrees.
  */
 declare const radiansToDegrees: (angleInRadians: number) => number;
 /**
  * Convert polar coordinates to cartesian coordinates.
  *
- * @param centerX Center x coordinate.
- * @param centerY Center y coordinate.
- * @param radius Radius of the circle.
- * @param angleInDegrees Angle in degrees.
  * @returns Cartesian coordinates.
  */
 declare const polarToCartesian: (centerX: number, centerY: number, radius: number, angleInDegrees: number) => {
@@ -58,10 +51,6 @@ declare const polarToCartesian: (centerX: number, centerY: number, radius: numbe
 /**
  * Convert cartesian coordinates to polar coordinates.
  *
- * @param centerX Center x coordinate.
- * @param centerY Center y coordinate.
- * @param x Point x coordinate.
- * @param y Point y coordinate.
  * @returns Polar coordinates.
  */
 declare const cartesianToPolar: (centerX: number, centerY: number, x: number, y: number) => {
@@ -71,58 +60,48 @@ declare const cartesianToPolar: (centerX: number, centerY: number, x: number, y:
 /**
  * Calculates length of circle.
  *
- * @param radius Radius of the circle.
  * @returns The length of the circle.
  */
 declare const getCircleLength: (radius: number) => number;
 /**
  * Calculates height for the compact layout.
  *
- * @param totalLangs Total number of languages.
  * @returns Card height.
  */
 declare const calculateCompactLayoutHeight: (totalLangs: number) => number;
 /**
  * Calculates height for the normal layout.
  *
- * @param totalLangs Total number of languages.
  * @returns Card height.
  */
 declare const calculateNormalLayoutHeight: (totalLangs: number) => number;
 /**
  * Calculates height for the donut layout.
  *
- * @param totalLangs Total number of languages.
  * @returns Card height.
  */
 declare const calculateDonutLayoutHeight: (totalLangs: number) => number;
 /**
  * Calculates height for the donut vertical layout.
  *
- * @param totalLangs Total number of languages.
  * @returns Card height.
  */
 declare const calculateDonutVerticalLayoutHeight: (totalLangs: number) => number;
 /**
  * Calculates height for the pie layout.
  *
- * @param totalLangs Total number of languages.
  * @returns Card height.
  */
 declare const calculatePieLayoutHeight: (totalLangs: number) => number;
 /**
  * Calculates the center translation needed to keep the donut chart centred.
  *
- * @param totalLangs Total number of languages.
  * @returns Donut center translation.
  */
 declare const donutCenterTranslation: (totalLangs: number) => number;
 /**
  * Trim top languages to lang_count while also hiding certain languages.
  *
- * @param topLangs Top languages.
- * @param langs_count Number of languages to show.
- * @param hide Languages to hide.
  * @returns Trimmed top languages and total size.
  */
 declare const trimTopLanguages: (topLangs: TopLangData, langs_count: number, hide?: Array<string>) => {
@@ -132,9 +111,6 @@ declare const trimTopLanguages: (topLangs: TopLangData, langs_count: number, hid
 /**
  * Get default languages count for provided card layout.
  *
- * @param props Function properties.
- * @param props.layout Input layout string.
- * @param props.hide_progress Input hide_progress parameter value.
  * @returns Default languages count for input layout.
  */
 declare const getDefaultLanguagesCountByLayout: ({ layout, hide_progress, }: {
@@ -144,10 +120,19 @@ declare const getDefaultLanguagesCountByLayout: ({ layout, hide_progress, }: {
 /**
  * Renders card that display user's most frequently used programming languages.
  *
- * @param topLangs User's most frequently used programming languages.
- * @param options Card options.
  * @returns Language card SVG object.
  */
-declare const renderTopLanguages: (topLangs: TopLangData, options?: CardOptions<TopLangOptions>) => string;
-export { getLongestLang, degreesToRadians, radiansToDegrees, polarToCartesian, cartesianToPolar, getCircleLength, calculateCompactLayoutHeight, calculateNormalLayoutHeight, calculateDonutLayoutHeight, calculateDonutVerticalLayoutHeight, calculatePieLayoutHeight, donutCenterTranslation, trimTopLanguages, renderTopLanguages, MIN_CARD_WIDTH, getDefaultLanguagesCountByLayout, TOP_LANG_LAYOUTS, TOP_LANG_STATS_FORMATS, };
+declare const renderCard: (topLangs: TopLangData, options?: CardOptions<TopLangOptions>) => string;
+/**
+ * The card, and the values each of its options accepts, keyed by the option's own name.
+ * They ride on the renderer so a list cannot be found without what draws it;
+ * the api handler forwards them onto its own export, which is what a UI reads.
+ */
+declare const renderTopLanguages: typeof renderCard & {
+    OPTIONS: {
+        layout: readonly ["compact", "normal", "donut", "donut-vertical", "pie"];
+        stats_format: readonly ["percentages", "bytes"];
+    };
+};
+export { getLongestLang, degreesToRadians, radiansToDegrees, polarToCartesian, cartesianToPolar, getCircleLength, calculateCompactLayoutHeight, calculateNormalLayoutHeight, calculateDonutLayoutHeight, calculateDonutVerticalLayoutHeight, calculatePieLayoutHeight, donutCenterTranslation, trimTopLanguages, MIN_CARD_WIDTH, getDefaultLanguagesCountByLayout, renderTopLanguages, };
 //# sourceMappingURL=top-languages.d.ts.map

package/build/cards/top-languages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"top-languages.d.ts","sourceRoot":"","sources":["../../src/cards/top-languages.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAG9D,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGnE,QAAA,MAAM,cAAc,MAAM,CAAC;AAW3B,0EAA0E;AAC1E,QAAA,MAAM,gBAAgB,kEAAmE,CAAC;AAC1F,KAAK,aAAa,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD,sFAAsF;AACtF,QAAA,MAAM,sBAAsB,mCAAoC,CAAC;AACjE,KAAK,kBAAkB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,UAAU,cAAe,SAAQ,iBAAiB;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,kBAAkB,CAAC;CAClC;AAED;;;;;GAKG;AACH,QAAA,MAAM,cAAc,GAAI,KAAK,KAAK,CAAC,IAAI,CAAC,KAAG,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAI5E,CAAC;AAEJ;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB,GAAI,gBAAgB,MAAM,KAAG,MAA4C,CAAC;AAEhG;;;;;GAKG;AACH,QAAA,MAAM,gBAAgB,GAAI,gBAAgB,MAAM,KAAG,MAA4C,CAAC;AAEhG;;;;;;;;GAQG;AACH,QAAA,MAAM,gBAAgB,GACpB,SAAS,MAAM,EACf,SAAS,MAAM,EACf,QAAQ,MAAM,EACd,gBAAgB,MAAM,KACrB;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAMxB,CAAC;AAEF;;;;;;;;GAQG;AACH,QAAA,MAAM,gBAAgB,GACpB,SAAS,MAAM,EACf,SAAS,MAAM,EACf,GAAG,MAAM,EACT,GAAG,MAAM,KACR;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAO1C,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,eAAe,GAAI,QAAQ,MAAM,KAAG,MAEzC,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,4BAA4B,GAAI,YAAY,MAAM,KAAG,MAE1D,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,2BAA2B,GAAI,YAAY,MAAM,KAAG,MAEzD,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,0BAA0B,GAAI,YAAY,MAAM,KAAG,MAExD,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,kCAAkC,GAAI,YAAY,MAAM,KAAG,MAEhE,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,wBAAwB,GAAI,YAAY,MAAM,KAAG,MAEtD,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,sBAAsB,GAAI,YAAY,MAAM,KAAG,MAEpD,CAAC;AAEF;;;;;;;GAOG;AACH,QAAA,MAAM,gBAAgB,GACpB,UAAU,WAAW,EACrB,aAAa,MAAM,EACnB,OAAO,KAAK,CAAC,MAAM,CAAC,KACnB;IAAE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAAC,iBAAiB,EAAE,MAAM,CAAA;CAqBjD,CAAC;AAooBF;;;;;;;GAOG;AACH,QAAA,MAAM,gCAAgC,GAAI,4BAGvC;IACD,MAAM,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACnC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACrC,KAAG,MAYH,CAAC;AAEF;;;;;;GAMG;AACH,QAAA,MAAM,kBAAkB,GACtB,UAAU,WAAW,EACrB,UAAS,WAAW,CAAC,cAAc,CAAM,KACxC,MAqJF,CAAC;AAEF,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,4BAA4B,EAC5B,2BAA2B,EAC3B,0BAA0B,EAC1B,kCAAkC,EAClC,wBAAwB,EACxB,sBAAsB,EACtB,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,gCAAgC,EAChC,gBAAgB,EAChB,sBAAsB,GACvB,CAAC"}
+{"version":3,"file":"top-languages.d.ts","sourceRoot":"","sources":["../../src/cards/top-languages.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAK9D,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGnE,QAAA,MAAM,cAAc,MAAM,CAAC;AAa3B,0EAA0E;AAC1E,QAAA,MAAM,gBAAgB,YAAI,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,gBAAgB,EAAE,KAAK,CAAU,CAAC;AAC1F,KAAK,aAAa,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvD,sFAAsF;AACtF,QAAA,MAAM,sBAAsB,YAAI,aAAa,EAAE,OAAO,CAAU,CAAC;AACjE,KAAK,kBAAkB,GAAG,CAAC,OAAO,sBAAsB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,UAAU,cAAe,SAAQ,iBAAiB;IAChD,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,MAAM,EAAE,aAAa,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,OAAO,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,YAAY,EAAE,kBAAkB,CAAC;CAClC;AAED;;;;GAIG;AACH,QAAA,MAAM,cAAc,QAAS,KAAK,CAAC,IAAI,CAAC,KAAG,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAQ9E,CAAC;AAEF;;;;GAIG;AACH,QAAA,MAAM,gBAAgB,mBAAoB,MAAM,KAAG,MAA0C,CAAC;AAE9F;;;;GAIG;AACH,QAAA,MAAM,gBAAgB,mBAAoB,MAAM,KAAG,MAA0C,CAAC;AAE9F;;;;GAIG;AACH,QAAA,MAAM,gBAAgB,YACX,MAAM,WACN,MAAM,UACP,MAAM,kBACE,MAAM,KACrB;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAMxB,CAAC;AAEF;;;;GAIG;AACH,QAAA,MAAM,gBAAgB,YACX,MAAM,WACN,MAAM,KACZ,MAAM,KACN,MAAM,KACR;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAO1C,CAAC;AAEF;;;;GAIG;AACH,QAAA,MAAM,eAAe,WAAY,MAAM,KAAG,MAA8B,CAAC;AAEzE;;;;GAIG;AACH,QAAA,MAAM,4BAA4B,eAAgB,MAAM,KAAG,MACG,CAAC;AAE/D;;;;GAIG;AACH,QAAA,MAAM,2BAA2B,eAAgB,MAAM,KAAG,MAAoC,CAAC;AAE/F;;;;GAIG;AACH,QAAA,MAAM,0BAA0B,eAAgB,MAAM,KAAG,MACjB,CAAC;AAEzC;;;;GAIG;AACH,QAAA,MAAM,kCAAkC,eAAgB,MAAM,KAAG,MAC1B,CAAC;AAExC;;;;GAIG;AACH,QAAA,MAAM,wBAAwB,eAAgB,MAAM,KAAG,MAChB,CAAC;AAExC;;;;GAIG;AACH,QAAA,MAAM,sBAAsB,eAAgB,MAAM,KAAG,MACb,CAAC;AAEzC;;;;GAIG;AACH,QAAA,MAAM,gBAAgB,aACV,WAAW,eACR,MAAM,SACZ,KAAK,CAAC,MAAM,CAAC,KACnB;IAAE,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAAC,iBAAiB,EAAE,MAAM,CAAA;CAqBjD,CAAC;AA4jBF;;;;GAIG;AACH,QAAA,MAAM,gCAAgC,+BAGnC;IACD,MAAM,CAAC,EAAE,aAAa,GAAG,SAAS,CAAC;IACnC,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACrC,KAAG,MAcH,CAAC;AAEF;;;;GAIG;AACH,QAAA,MAAM,UAAU,aAAc,WAAW,YAAW,WAAW,CAAC,cAAc,CAAC,KAAQ,MAoItF,CAAC;AAEF;;;;GAIG;AACH,QAAA,MAAM,kBAAkB;;QAEpB,MAAM;QACN,YAAY;;CAEd,CAAC;AAEH,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,eAAe,EACf,4BAA4B,EAC5B,2BAA2B,EAC3B,0BAA0B,EAC1B,kCAAkC,EAClC,wBAAwB,EACxB,sBAAsB,EACtB,gBAAgB,EAChB,cAAc,EACd,gCAAgC,EAChC,kBAAkB,GACnB,CAAC"}