break up tag utils

Author: fadi-george

package.json

@@ -84,7 +84,7 @@
     },
     {
       "path": "./build/releases/OneSignalSDK.page.es6.js",
-      "limit": "47.44 kB",
+      "limit": "47.33 kB",
       "gzip": true
     },
     {

src/page/managers/slidedownManager/SlidedownManager.ts

@@ -18,6 +18,10 @@ import {
 } from 'src/shared/prompts/constants';
 import { isSlidedownPushDependent } from 'src/shared/prompts/helpers';
 import type { DelayedPromptTypeValue } from 'src/shared/prompts/types';
+import {
+  convertTagsApiToBooleans,
+  markAllTagsAsSpecified,
+} from 'src/shared/utils/tags';
 import { logMethodCall } from 'src/shared/utils/utils';
 import { CoreModuleDirector } from '../../../core/CoreModuleDirector';
 import {
@@ -26,7 +30,6 @@ import {
 } from '../../../shared/helpers/DismissHelper';
 import Log from '../../../shared/libraries/Log';
 import type { PushSubscriptionState } from '../../../shared/models/PushSubscriptionState';
-import TagUtils from '../../../shared/utils/TagUtils';
 import { DismissPrompt } from '../../models/Dismiss';
 import ChannelCaptureContainer from '../../slidedown/ChannelCaptureContainer';
 import ConfirmationToast from '../../slidedown/ConfirmationToast';
@@ -307,12 +310,12 @@ export class SlidedownManager {
         this._context._tagManager._storeRemotePlayerTags(
           existingTags as TagsObjectForApi,
         );
-        tagsForComponent = TagUtils.convertTagsApiToBooleans(
+        tagsForComponent = convertTagsApiToBooleans(
           existingTags as TagsObjectForApi,
         );
       } else {
         // first subscription or no existing tags
-        TagUtils.markAllTagsAsSpecified(categories, true);
+        markAllTagsAsSpecified(categories, true);
       }
 
       taggingContainer._mount(categories, tagsForComponent);

src/page/managers/tagManager/TagManager.ts

@@ -3,8 +3,12 @@ import type {
   TagsObjectWithBoolean,
 } from 'src/page/tags/types';
 import type { ContextInterface } from 'src/shared/context/types';
+import {
+  convertTagsBooleansToApi,
+  getObjectDifference,
+  isTagObjectEmpty,
+} from 'src/shared/utils/tags';
 import Log from '../../../shared/libraries/Log';
-import TagUtils from '../../../shared/utils/TagUtils';
 import type { ITagManager } from './types';
 
 /**
@@ -26,15 +30,15 @@ export default class TagManager implements ITagManager {
   public async _sendTags(): Promise<TagsObjectForApi> {
     Log._info('Category Slidedown Local Tags:', this._tagsFromTaggingContainer);
 
-    const localTagsConvertedToApi = TagUtils.convertTagsBooleansToApi(
+    const localTagsConvertedToApi = convertTagsBooleansToApi(
       this._tagsFromTaggingContainer,
     );
-    const finalTagsObject = TagUtils.getObjectDifference(
+    const finalTagsObject = getObjectDifference(
       localTagsConvertedToApi,
       this._remoteTags,
     );
 
-    const shouldSendUpdate = !TagUtils.isTagObjectEmpty(finalTagsObject);
+    const shouldSendUpdate = !isTagObjectEmpty(finalTagsObject);
     if (shouldSendUpdate) {
       await OneSignal.User.addTags(finalTagsObject);
       return finalTagsObject;

src/page/slidedown/TaggingContainer.ts

@@ -6,6 +6,7 @@ import {
   removeCssClass,
   removeDomElement,
 } from 'src/shared/helpers/dom';
+import { getCheckedTagCategories } from 'src/shared/utils/tags';
 import {
   COLORS,
   SLIDEDOWN_CSS_CLASSES,
@@ -14,7 +15,6 @@ import {
   TAGGING_CONTAINER_CSS_IDS,
   TAGGING_CONTAINER_STRINGS,
 } from '../../shared/slidedown/constants';
-import TagUtils from '../../shared/utils/TagUtils';
 import type { TagsObjectWithBoolean } from '../tags/types';
 import { getLoadingIndicatorWithColor } from './LoadingIndicator';
 
@@ -79,7 +79,7 @@ export default class TaggingContainer {
     remoteTagCategories: TagCategory[],
     existingPlayerTags?: TagsObjectWithBoolean,
   ): Element {
-    const checkedTagCategories = TagUtils.getCheckedTagCategories(
+    const checkedTagCategories = getCheckedTagCategories(
       remoteTagCategories,
       existingPlayerTags,
     );

src/shared/utils/TagUtils.ts

@@ -3,7 +3,7 @@ import type {
   TagsObjectForApi,
   TagsObjectWithBoolean,
 } from 'src/page/tags/types';
-import TagUtils from './TagUtils';
+import * as TagUtils from './tags';
 
 describe('TagUtils', () => {
   test('should convert api tags to boolean format', () => {

src/shared/utils/TagUtils.test.ts src/shared/utils/tags.test.tssrc/shared/utils/TagUtils.test.ts renamed to src/shared/utils/tags.test.ts

@@ -0,0 +1,104 @@
+import type {
+  TagCategory,
+  TagsObjectForApi,
+  TagsObjectWithBoolean,
+} from 'src/page/tags/types';
+
+export function convertTagsApiToBooleans(
+  tags: TagsObjectForApi,
+): TagsObjectWithBoolean {
+  const convertedTags: TagsObjectWithBoolean = {};
+  Object.keys(tags).forEach((key) => {
+    convertedTags[key] = tags[key] === '1' ? true : false;
+  });
+  return convertedTags;
+}
+
+export function convertTagsBooleansToApi(
+  tags: TagsObjectWithBoolean,
+): TagsObjectForApi {
+  const convertedTags: TagsObjectForApi = {};
+  Object.keys(tags).forEach((key) => {
+    convertedTags[key] = tags[key] === true ? '1' : '0';
+  });
+  return convertedTags;
+}
+
+/**
+ * Used in determining what Tag/Category preferences changed in order
+ * to only update what is necessary
+ * @param  {TagsObject} localTags - tags from taggingContainer with values of type "number"
+ * @param  {TagsObject} remoteTags - remote player tags with values of type "number"
+ * @returns array of keys of corresponding different values (finds difference)
+ */
+export function getObjectDifference(
+  localTags: TagsObjectForApi,
+  remoteTags: TagsObjectForApi,
+): TagsObjectForApi {
+  const finalTags: TagsObjectForApi = {};
+
+  // Going off local tags since it's our categories. Trying to find only changed tags and returning those
+  // as a final object.
+  Object.keys(localTags).forEach((key) => {
+    // only if user's tag value did not change, skip it
+    if (remoteTags[key] === localTags[key]) {
+      return;
+    }
+
+    finalTags[key] = localTags[key];
+  });
+  return finalTags;
+}
+
+export function markAllTagsAsSpecified(
+  categoryArray: TagCategory[],
+  checked: boolean,
+): void {
+  categoryArray.forEach((category) => {
+    category.checked = checked;
+  });
+}
+
+export function isTagObjectEmpty(
+  tags: TagsObjectForApi | TagsObjectWithBoolean,
+): boolean {
+  return Object.keys(tags).length === 0;
+}
+/**
+ * Uses configured categories and remote player tags to calculate which boxes should be checked
+ * @param  {TagCategory[]} categories
+ * @param  {TagsObjectWithBoolean} existingPlayerTags?
+ */
+export function getCheckedTagCategories(
+  categories: TagCategory[],
+  existingPlayerTags?: TagsObjectWithBoolean,
+): TagCategory[] {
+  if (!existingPlayerTags) {
+    return categories;
+  }
+
+  const isExistingPlayerTagsEmpty = isTagObjectEmpty(existingPlayerTags);
+  if (isExistingPlayerTagsEmpty) {
+    const categoriesCopy = structuredClone(categories);
+    markAllTagsAsSpecified(categoriesCopy, true);
+    return categoriesCopy;
+  }
+
+  const categoriesCopy = structuredClone<TagCategory[]>(categories);
+  return categoriesCopy.map((category) => {
+    const existingTagValue: boolean = existingPlayerTags[category.tag];
+    category.checked = getCheckedStatusForTagValue(existingTagValue);
+    return category;
+  });
+}
+
+export function getCheckedStatusForTagValue(
+  tagValue: boolean | undefined,
+): boolean {
+  // If user does not have tag assigned to them, consider it selected
+  if (tagValue === undefined) {
+    return true;
+  }
+
+  return tagValue;
+}