[CI-4335] Export all utils functions (#142)

* Export utils format

* Update imports

* Relocate util functions

* Update naming convention

---------

Co-authored-by: Evan Yan <evan.yan@constructor.io>

Author: evanyan13

src/types.ts

@@ -19,7 +19,6 @@ import {
   BrowseRequestType,
   FacetOption as ApiFacetOption,
 } from '@constructor-io/constructorio-client-javascript/lib/types';
-import { MakeOptional } from './utils/typeHelpers';
 
 export {
   Nullable,
@@ -328,3 +327,9 @@ export type IncludeRenderProps<ComponentProps, ChildrenFunctionProps> = Componen
 export type IncludeRawResponse<TransformedType, OriginalType> = TransformedType & {
   rawResponse?: OriginalType;
 };
+
+/**
+ * Given a Type T and a set of keys K (pipe-delimited string), make those keys optional.
+ */
+export type MakeOptional<Type, Keys extends string & keyof Partial<Type>> = Omit<Type, Keys> &
+  Partial<Pick<Type, Keys>>;

src/utils.tsx

@@ -0,0 +1,35 @@
+// Function to emulate pausing between interactions
+export function sleep(ms) {
+  // eslint-disable-next-line
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
+/* istanbul ignore next */
+export const logger = (error: any) => {
+  try {
+    if (typeof process !== 'undefined' && process?.env?.LOGGER) {
+      // eslint-disable-next-line no-console
+      console.log(error);
+    }
+  } catch (e) {
+    // process variable is not available and logger should not be active
+  }
+};
+
+// eslint-disable-next-line @cspell/spellchecker
+export function tryCatchify(func: Function) {
+  return (...args: any) => {
+    try {
+      return func(...args);
+    } catch (e) {
+      logger(e);
+    }
+    return undefined;
+  };
+}
+
+export function removeNullValuesFromObject(obj: Object) {
+  const filteredListOfEntries = Object.entries(obj).filter(([, val]) => val != null);
+
+  return Object.fromEntries(filteredListOfEntries);
+}

src/utils/common.ts

@@ -0,0 +1,8 @@
+export * from './formatters';
+export * from './itemFieldGetters';
+export * from './styleHelpers';
+export * from './transformers';
+export * from './typeHelpers';
+export * from './urlHelpers';
+export * from './requestConfigsHelpers';
+export * from './common';

src/utils/index.ts

@@ -0,0 +1,92 @@
+import { SearchParameters } from '@constructor-io/constructorio-client-javascript/lib/types';
+import {
+  RequestConfigs,
+  RequestQueryParams,
+  PlpSearchDataResults,
+  PlpSearchDataRedirect,
+  PlpBrowseData,
+} from '../types';
+import { removeNullValuesFromObject } from './common';
+import { isPlpBrowseDataResults, isPlpSearchDataResults } from './typeHelpers';
+
+export function getSearchParamsFromRequestConfigs(requestConfigs: RequestConfigs): {
+  query: string;
+  searchParams: SearchParameters;
+} {
+  const { query = '', filterValue, filterName, ...rest } = requestConfigs;
+  const searchParams = removeNullValuesFromObject(rest);
+
+  return { query, searchParams };
+}
+
+export function getBrowseParamsFromRequestConfigs(requestConfigs: RequestConfigs): {
+  filterName: string;
+  filterValue: string;
+  queryParams: RequestQueryParams;
+} {
+  const { query, filterValue = '', filterName = '', ...queryParams } = requestConfigs;
+
+  return { filterName, filterValue, queryParams: removeNullValuesFromObject(queryParams) };
+}
+
+export function checkIsSearchPage(requestConfigs: RequestConfigs) {
+  const { query } = getSearchParamsFromRequestConfigs(requestConfigs);
+
+  return !!query;
+}
+
+export function checkIsBrowsePage(requestConfigs: RequestConfigs) {
+  const { filterName, filterValue } = getBrowseParamsFromRequestConfigs(requestConfigs);
+
+  return !!filterName && !!filterValue;
+}
+
+export type PageType = 'search' | 'browse' | 'unknown';
+
+export function getPageType(requestConfigs: RequestConfigs): PageType {
+  if (checkIsSearchPage(requestConfigs)) {
+    return 'search';
+  }
+  if (checkIsBrowsePage(requestConfigs)) {
+    return 'browse';
+  }
+  return 'unknown';
+}
+
+export function getPlpContainerCnstrcDataAttributes(
+  data: PlpSearchDataResults | PlpSearchDataRedirect | PlpBrowseData | null,
+  requestConfigs: RequestConfigs,
+) {
+  if (!data || (!isPlpSearchDataResults(data) && !isPlpBrowseDataResults(data))) return {};
+
+  const { filterName, filterValue } = requestConfigs;
+  const pageType = getPageType(requestConfigs);
+  let dataCnstrc: Record<`data-cnstrc-${string}`, string | number | boolean> = {};
+
+  switch (pageType) {
+    case 'browse':
+      dataCnstrc = {
+        'data-cnstrc-browse': true,
+        'data-cnstrc-num-results': data.response.totalNumResults,
+        'data-cnstrc-filter-name': filterName!,
+        'data-cnstrc-filter-value': filterValue!,
+      };
+      break;
+
+    case 'search':
+      dataCnstrc = {
+        'data-cnstrc-search': true,
+        'data-cnstrc-num-results': data.response.totalNumResults,
+      };
+      break;
+
+    case 'unknown':
+      dataCnstrc = {};
+      break;
+
+    default:
+      break;
+  }
+
+  return dataCnstrc;
+}