@shopify/graphql-client/src/graphql-client/utilities.ts

Shopify GraphQL Client - A lightweight generic GraphQL JS client to interact with Shopify GraphQL APIs

import {CLIENT, MAX_RETRIES, MIN_RETRIES} from './constants';

export function formatErrorMessage(message: string, client = CLIENT) {
  return message.startsWith(`${client}`) ? message : `${client}: ${message}`;
}

export function getErrorMessage(error: any) {
  return error instanceof Error ? error.message : JSON.stringify(error);
}

export function getErrorCause(error: any): Record<string, any> | undefined {
  return error instanceof Error && error.cause ? error.cause : undefined;
}

export function combineErrors(dataArray: Record<string, any>[]) {
  return dataArray.flatMap(({errors}) => {
    return errors ?? [];
  });
}

export function validateRetries({
  client,
  retries,
}: {
  client: string;
  retries?: number;
}) {
  if (
    retries !== undefined &&
    (typeof retries !== 'number' ||
      retries < MIN_RETRIES ||
      retries > MAX_RETRIES)
  ) {
    throw new Error(
      `${client}: The provided "retries" value (${retries}) is invalid - it cannot be less than ${MIN_RETRIES} or greater than ${MAX_RETRIES}`,
    );
  }
}

export function getKeyValueIfValid(key: string, value?: any) {
  return value &&
    (typeof value !== 'object' ||
      Array.isArray(value) ||
      (typeof value === 'object' && Object.keys(value).length > 0))
    ? {[key]: value}
    : {};
}

export function buildDataObjectByPath(
  path: string[],
  data: any,
): Record<string | number, any> {
  if (path.length === 0) {
    return data;
  }

  const key = path.pop() as string | number;
  const newData = {
    [key]: data,
  };

  if (path.length === 0) {
    return newData;
  }

  return buildDataObjectByPath(path, newData);
}

function combineObjects(baseObject: any, newObject: any) {
  return Object.keys(newObject || {}).reduce(
    (acc: any, key: string | number) => {
      if (
        (typeof newObject[key] === 'object' || Array.isArray(newObject[key])) &&
        baseObject[key]
      ) {
        acc[key] = combineObjects(baseObject[key], newObject[key]);
        return acc;
      }

      acc[key] = newObject[key];
      return acc;
    },
    Array.isArray(baseObject) ? [...baseObject] : {...baseObject},
  );
}

export function buildCombinedDataObject([
  initialDatum,
  ...remainingData
]: any[]) {
  return remainingData.reduce(combineObjects, {...initialDatum});
}