@stats-forge/github-stats-forge-core 0.0.1

package/src/common/log.ts

@@ -0,0 +1,12 @@
+/**
+ * Return console instance based on the environment.
+ */
+const logger: {
+  log: (...args: Array<unknown>) => void;
+  error: (...args: Array<unknown>) => void;
+} = {
+  log: console.log,
+  error: console.error,
+};
+
+export { logger };

package/src/common/ops.ts

@@ -0,0 +1,145 @@
+import toEmoji from 'emoji-name-map';
+
+import type { RepositoryAffiliation } from '../graphql/generated/common.js';
+
+import { OWNER_AFFILIATIONS } from './constants.js';
+import { CardError, INVALID_AFFILIATION } from './error.js';
+
+/**
+ * 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 => {
+  if (typeof value === 'boolean') {
+    return value;
+  }
+
+  if (typeof value === 'string') {
+    if (value.toLowerCase() === 'true') {
+      return true;
+    } else if (value.toLowerCase() === 'false') {
+      return false;
+    }
+  }
+  return 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> => {
+  if (!str) {
+    return [];
+  }
+  return str.split(',');
+};
+
+/**
+ * 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.
+ */
+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));
+};
+
+/**
+ * Lowercase and trim string.
+ *
+ * @param name String to lowercase and trim.
+ * @returns Lowercased and trimmed string.
+ */
+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 chunkIndex = Math.floor(index / perChunk);
+    const chunk = resultArray[chunkIndex] ?? [];
+    chunk.push(item);
+    resultArray[chunkIndex] = chunk;
+    return resultArray;
+  }, []);
+};
+
+/**
+ * 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) || '';
+  });
+};
+
+const isOwnerAffiliation = (value: string): value is RepositoryAffiliation =>
+  OWNER_AFFILIATIONS.some((affiliation) => affiliation === value);
+
+/**
+ * Parse owner affiliations.
+ *
+ * @param affiliations input affiliations to be parsed.
+ * @returns Parsed affiliations.
+ *
+ * @throws {CardError} If affiliations contains invalid values.
+ */
+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.
+  const normalized =
+    affiliations.length > 0
+      ? affiliations.map((affiliation) => affiliation.toUpperCase())
+      : ['OWNER'];
+
+  // Check if ownerAffiliations contains valid values.
+  if (!normalized.every(isOwnerAffiliation)) {
+    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;
+};
+
+export {
+  parseBoolean,
+  parseArray,
+  clampValue,
+  lowercaseTrim,
+  chunkArray,
+  parseEmojis,
+  parseOwnerAffiliations,
+  buildSearchFilter,
+};