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

package/src/common/ops.ts

@@ -1,14 +1,12 @@
-import toEmoji from 'emoji-name-map';
+import type { RepositoryAffiliation } from '../graphql/generated/common.ts';
 
-import type { RepositoryAffiliation } from '../graphql/generated/common.js';
-
-import { OWNER_AFFILIATIONS } from './constants.js';
-import { CardError, INVALID_AFFILIATION } from './error.js';
+import { OWNER_AFFILIATIONS } from './constants.ts';
+import { getEmoji } from './emojiMap.ts';
+import { CardError, INVALID_AFFILIATION } from './error.ts';
 
 /**
  * Returns boolean if value is either "true" or "false" else the value as it is.
  *
- * @param value The value to parse; `undefined` when the param was not sent.
  * @returns The parsed value.
  */
 const parseBoolean = (value: string | boolean | undefined): boolean | undefined => {
@@ -19,7 +17,8 @@ const parseBoolean = (value: string | boolean | undefined): boolean | undefined
   if (typeof value === 'string') {
     if (value.toLowerCase() === 'true') {
       return true;
-    } else if (value.toLowerCase() === 'false') {
+    }
+    if (value.toLowerCase() === 'false') {
       return false;
     }
   }
@@ -29,7 +28,6 @@ const parseBoolean = (value: string | boolean | undefined): boolean | undefined
 /**
  * Parse string to array of strings.
  *
- * @param str The string to parse; `undefined` when the param was not sent.
  * @returns The array of strings.
  */
 const parseArray = (str: string | undefined): Array<string> => {
@@ -42,22 +40,14 @@ const parseArray = (str: string | undefined): Array<string> => {
 /**
  * Clamp the given number between the given range.
  *
- * @param number The number to clamp.
- * @param min The minimum value.
- * @param max The maximum value.
- * @returns The clamped number.
+ * @returns The clamped number; `min` for `NaN`.
  */
-const clampValue = (number: string | number, min: number, max: number): number => {
-  if (Number.isNaN(parseInt(String(number), 10))) {
-    return min;
-  }
-  return Math.max(min, Math.min(Number(number), max));
-};
+const clampValue = (number: number, min: number, max: number): number =>
+  Number.isNaN(number) ? min : Math.max(min, Math.min(number, max));
 
 /**
  * Lowercase and trim string.
  *
- * @param name String to lowercase and trim.
  * @returns Lowercased and trimmed string.
  */
 const lowercaseTrim = (name: string): string => name.toLowerCase().trim();
@@ -65,34 +55,33 @@ const lowercaseTrim = (name: string): string => name.toLowerCase().trim();
 /**
  * Split array of languages in two columns.
  *
- * @template T Language object.
- * @param arr Array of languages.
- * @param perChunk Number of languages per column.
  * @returns Array of languages split in two columns.
  */
 const chunkArray = <T>(arr: Array<T>, perChunk: number): Array<Array<T>> => {
-  return arr.reduce<Array<Array<T>>>((resultArray, item, index) => {
+  const chunks: Array<Array<T>> = [];
+  for (const [index, item] of arr.entries()) {
     const chunkIndex = Math.floor(index / perChunk);
-    const chunk = resultArray[chunkIndex] ?? [];
+    const chunk = chunks[chunkIndex] ?? [];
     chunk.push(item);
-    resultArray[chunkIndex] = chunk;
-    return resultArray;
-  }, []);
+    chunks[chunkIndex] = chunk;
+  }
+  return chunks;
 };
 
 /**
  * Parse emoji from string.
  *
- * @param str String to parse emoji from.
  * @returns String with emoji parsed.
  */
 const parseEmojis = (str: string): string => {
   if (!str) {
     throw new Error('[parseEmoji]: str argument not provided');
   }
-  return str.replace(/:\w+:/gm, (emoji) => {
-    return toEmoji.get(emoji) || '';
-  });
+  // `+` and `-` are part of a shortcode: `:+1:`, `:non-potable_water:`.
+  return str.replaceAll(
+    /:(?<shortcode>[\w+-]+):/g,
+    (_match, shortcode: string) => getEmoji(shortcode) ?? '',
+  );
 };
 
 const isOwnerAffiliation = (value: string): value is RepositoryAffiliation =>
@@ -101,37 +90,31 @@ const isOwnerAffiliation = (value: string): value is RepositoryAffiliation =>
 /**
  * Parse owner affiliations.
  *
- * @param affiliations input affiliations to be parsed.
- * @returns Parsed affiliations.
- *
  * @throws {CardError} If affiliations contains invalid values.
+ *
+ * @returns Parsed affiliations.
  */
 const parseOwnerAffiliations = (affiliations: Array<string>): Array<RepositoryAffiliation> => {
-  // Set default value for ownerAffiliations.
-  // NOTE: Done here since parseArray() will always return an empty array even nothing
-  //was specified.
+  // `parseArray` returns an empty array for an absent param, so the default lands here.
   const normalized =
     affiliations.length > 0
       ? affiliations.map((affiliation) => affiliation.toUpperCase())
       : ['OWNER'];
 
   // Check if ownerAffiliations contains valid values.
-  if (!normalized.every(isOwnerAffiliation)) {
+  if (!normalized.every((value) => isOwnerAffiliation(value))) {
     throw CardError.invalidParam('role', INVALID_AFFILIATION);
   }
   return normalized;
 };
 
-const buildSearchFilter = (
-  repos: Array<string> | string = [],
-  owners: Array<string> | string = [],
-): string => {
-  const repoFilter =
-    Array.isArray(repos) && repos.length > 0 ? repos.map((r) => `repo:${r} `).join('') : '';
-  const orgFilter =
-    Array.isArray(owners) && owners.length > 0 ? owners.map((o) => `owner:${o} `).join('') : '';
-  return repoFilter + orgFilter;
-};
+/**
+ * The qualifiers that scope a REST search to repositories and owners.
+ *
+ * @returns e.g. `repo:a/b owner:c `, each qualifier followed by a space; empty when both lists are.
+ */
+const buildSearchFilter = (repos: Array<string>, owners: Array<string>): string =>
+  [...repos.map((repo) => `repo:${repo} `), ...owners.map((owner) => `owner:${owner} `)].join('');
 
 export {
   parseBoolean,