react-native-moengage-cards 1.0.0

package/src/internal/utils/ModelToJsonMapper.ts

@@ -0,0 +1,250 @@
+/**
+ * @file contains the function to convert the model to json
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+
+import CampaignState from "../../model/CampaignState";
+import Card from "../../model/Card";
+import CardInfo from "../../model/CardInfo";
+import CardsData from "../../model/CardsData";
+import Container from "../../model/Container";
+import DisplayControl from "../../model/DisplayControl";
+import MetaData from "../../model/MetaData";
+import ShowTime from "../../model/ShowTime";
+import SyncCompleteData from "../../model/SyncData";
+import Template from "../../model/Template";
+import Widget from "../../model/Widget";
+import Action from "../../model/action/Action";
+import NavigationAction from "../../model/action/NavigationAction";
+import SyncType from "../../model/enums/SyncType";
+import TemplateType from "../../model/enums/TemplateType";
+import WidgetType from "../../model/enums/WidgetType";
+import ButtonStyle from "../../model/styles/ButtonStyle";
+import ContainerStyle from "../../model/styles/ContainerStyle";
+import ImageStyle from "../../model/styles/ImageStyle";
+import TextStyle from "../../model/styles/TextStyle";
+import WidgetStyle from "../../model/styles/WidgetStyle";
+import {
+    keyActionType,
+    keyActionValue,
+    keyActions,
+    keyAdditionalMetaData,
+    keyBackgroundColor,
+    keyCampaignPayload,
+    keyCampaignState,
+    keyCardId,
+    keyCards,
+    keyCategories,
+    keyCategory,
+    keyContainerId,
+    keyContainerStyle,
+    keyContainers,
+    keyCreatedAt,
+    keyDeletionTime,
+    keyDisplayControl,
+    keyEndTime,
+    keyExpireAfterDelivered,
+    keyExpireAfterSeen,
+    keyExpireAt,
+    keyFirstReceived,
+    keyFirstSeen,
+    keyFontSize,
+    keyHasUpdates,
+    keyId,
+    keyIsClicked,
+    keyIsNewCard,
+    keyIsPinned,
+    keyKVPairs,
+    keyLocalShowCount,
+    keyMaxCount,
+    keyMetaData,
+    keyNavigationType,
+    keyShouldShowAllTab,
+    keyShowTime,
+    keyStartTime,
+    keySyncType,
+    keyTemplateData,
+    keyTemplateType,
+    keyTotalShowCount,
+    keyUpdatedAt,
+    keyWidgetContent,
+    keyWidgetId,
+    keyWidgetStyle,
+    keyWidgetType,
+    keyWidgets
+} from "../Constants";
+import { assertUnsupportedError } from "../utils/Util";
+
+export function actionToJson(action: Action): { [k: string]: any } {
+    if (action instanceof NavigationAction) {
+        return navigationActionToJson(action);
+    }
+
+    assertUnsupportedError("Action Instance Not Supported");
+}
+
+export function navigationActionToJson(navigationAction: NavigationAction): { [k: string]: any } {
+    return {
+        [keyActionType]: navigationAction.actionType,
+        [keyNavigationType]: navigationAction.navigationType,
+        [keyActionValue]: navigationAction.value,
+        [keyKVPairs]: navigationAction.kvPairs
+    };
+}
+
+export function buttonStyleToJson(buttonStyle: ButtonStyle): { [k: string]: any } {
+    return {
+        [keyBackgroundColor]: buttonStyle.backgroundColor,
+        [keyFontSize]: buttonStyle.fontSize
+    };
+}
+
+export function containerStyleToJson(containerStyle: ContainerStyle | undefined): { [k: string]: any } | undefined {
+    if (containerStyle === undefined) return undefined;
+    return {
+        [keyBackgroundColor]: containerStyle.backgroundColor
+    };
+}
+
+export function imageStyleToJson(imageStyle: ImageStyle): { [k: string]: any } {
+    return {
+        [keyBackgroundColor]: imageStyle.backgroundColor,
+    };
+}
+
+export function textStyleToJson(textStyle: TextStyle): { [k: string]: any } {
+    return {
+        [keyBackgroundColor]: textStyle.backgroundColor,
+        [keyFontSize]: textStyle.fontSize
+    };
+}
+
+export function widgetStyleToJson(widgetStyle: WidgetStyle | undefined): { [k: string]: any } | undefined {
+    if (widgetStyle === undefined) return undefined;
+    if (widgetStyle instanceof ButtonStyle) {
+        return buttonStyleToJson(widgetStyle);
+    } else if (widgetStyle instanceof ContainerStyle) {
+        return containerStyleToJson(widgetStyle);
+    } else if (widgetStyle instanceof ImageStyle) {
+        return imageStyleToJson(widgetStyle);
+    } else if (widgetStyle instanceof TextStyle) {
+        return textStyleToJson(widgetStyle);
+    }
+
+    assertUnsupportedError("WidgetStyle Instance Not Supported");
+}
+
+export function campaignStateToJson(campaignState: CampaignState): { [k: string]: any } {
+    return {
+        [keyLocalShowCount]: campaignState.localShowCount,
+        [keyIsClicked]: campaignState.isClicked,
+        [keyFirstReceived]: campaignState.firstReceived,
+        [keyFirstSeen]: campaignState.firstSeen,
+        [keyTotalShowCount]: campaignState.totalShowCount
+    };
+}
+
+export function cardToJson(card: Card): { [k: string]: any } {
+    return {
+        [keyId]: card.id,
+        [keyCardId]: card.cardId,
+        [keyCategory]: card.category,
+        [keyTemplateData]: templateToJson(card.template),
+        [keyMetaData]: metaDataToJson(card.metaData)
+    };
+}
+
+export function cardInfoToJson(cardInfo: CardInfo): { [k: string]: any } {
+    return {
+        [keyShouldShowAllTab]: cardInfo.shouldShowAllTab,
+        [keyCategories]: cardInfo.categories,
+        [keyCards]: cardInfo.cards.map((card) => {
+            return cardToJson(card);
+        })
+    };
+}
+
+export function cardsDataToJson(cardsData: CardsData): { [k: string]: any } {
+    return {
+        [keyCategory]: cardsData.category,
+        [keyCards]: cardsData.cards.map((card) => {
+            return cardToJson(card);
+        })
+    };
+}
+
+export function containerToJson(container: Container): { [k: string]: any } {
+    return {
+        [keyContainerId]: container.id,
+        [keyTemplateType]: TemplateType[container.templateType],
+        [keyContainerStyle]: containerStyleToJson(container.style),
+        [keyWidgets]: container.widgets.map((widget) => {
+            return widgetToJson(widget);
+        }),
+        [keyActions]: container.actionList.map((action) => {
+            return actionToJson(action);
+        })
+    };
+}
+
+export function displayControlToJson(displayControl: DisplayControl): { [k: string]: any } {
+    return {
+        [keyExpireAt]: displayControl.expireAt,
+        [keyExpireAfterSeen]: displayControl.expireAfterSeen,
+        [keyExpireAfterDelivered]: displayControl.expireAfterDelivered,
+        [keyMaxCount]: displayControl.maxCount,
+        [keyIsPinned]: displayControl.isPinned,
+        [keyShowTime]: showTimeToJson(displayControl.showTime)
+    };
+}
+
+export function metaDataToJson(metaData: MetaData): { [k: string]: any } {
+    return {
+        [keyIsPinned]: metaData.isPinned,
+        [keyIsNewCard]: metaData.isNewCard,
+        [keyCampaignState]: campaignStateToJson(metaData.campaignState),
+        [keyDeletionTime]: metaData.deletionTime,
+        [keyDisplayControl]: displayControlToJson(metaData.displayControl),
+        [keyAdditionalMetaData]: metaData.metaData,
+        [keyUpdatedAt]: metaData.updatedTime,
+        [keyCreatedAt]: metaData.createdAt,
+        [keyCampaignPayload]: metaData.campaignPayload
+    };
+}
+
+export function showTimeToJson(showTime: ShowTime): { [k: string]: any } {
+    return {
+        [keyStartTime]: showTime.startTime,
+        [keyEndTime]: showTime.endTime
+    };
+}
+
+export function syncDataToJson(syncData: SyncCompleteData): { [k: string]: any } {
+    return {
+        [keyHasUpdates]: syncData.hasUpdates,
+        [keySyncType]: SyncType[syncData.syncType]
+    };
+}
+
+export function templateToJson(template: Template): { [k: string]: any } {
+    return {
+        [keyTemplateType]: TemplateType[template.templateType],
+        [keyContainers]: template.containers.map((container) => {
+            return containerToJson(container);
+        }),
+        [keyKVPairs]: template.kvPairs
+    };
+}
+
+export function widgetToJson(widget: Widget): { [k: string]: any } {
+    return {
+        [keyWidgetId]: widget.id,
+        [keyWidgetContent]: widget.content,
+        [keyWidgetType]: WidgetType[widget.widgetType],
+        [keyWidgetStyle]: widgetStyleToJson(widget.style),
+        [keyActions]: widget.actionList.map((action) => {
+            return actionToJson(action);
+        })
+    };
+}

package/src/internal/utils/PayloadBuilder.ts

@@ -0,0 +1,68 @@
+/**
+ * @file contains the function to build the payload to communicate with native bridge
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+
+import Card from "../../model/Card";
+import {
+    keyAccountMeta,
+    keyAppId,
+    keyCard,
+    keyCards,
+    keyCategory,
+    keyData,
+    keyWidgetIdentifier
+} from "../Constants";
+import { cardToJson } from "./ModelToJsonMapper";
+
+export function getAccountMetaPayload(appId: string): { [k: string]: any } {
+    return {
+        [keyAccountMeta]: getAppIdPayload(appId)
+    };
+}
+
+export function getCardClickedPayload(card: Card, widgetId: number, appId: string): { [k: string]: any } {
+    return {
+        [keyAccountMeta]: getAppIdPayload(appId),
+        [keyData]: {
+            [keyCard]: cardToJson(card),
+            [keyWidgetIdentifier]: widgetId
+        }
+    };
+}
+
+export function getCardShownPayload(card: Card, appId: string): { [k: string]: any } {
+    return {
+        [keyAccountMeta]: getAppIdPayload(appId),
+        [keyData]: {
+            [keyCard]: cardToJson(card)
+        }
+    };
+}
+
+export function getCardsForCategoriesPayload(category: string, appId: string): { [k: string]: any } {
+    return {
+        [keyAccountMeta]: getAppIdPayload(appId),
+        [keyData]: {
+            [keyCategory]: category
+        }
+    };
+}
+
+export function getDeleteCardsPayload(cards: Array<Card>, appId: string): { [k: string]: any } {
+    return {
+        [keyAccountMeta]: getAppIdPayload(appId),
+        [keyData]: {
+            [keyCards]: cards.map((card) => {
+                return cardToJson(card);
+            })
+        }
+    };
+}
+
+function getAppIdPayload(appId: string): { [k: string]: any } {
+    return {
+        [keyAppId]: appId
+    };
+}

package/src/internal/utils/PayloadParser.ts

@@ -0,0 +1,53 @@
+/**
+ * @file contains the function to build the object from json
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+
+import CardInfo from "../../model/CardInfo";
+import CardsData from "../../model/CardsData";
+import {
+    keyCategories,
+    keyCategory,
+    keyData,
+    keyIsAllCategoryEnabled,
+    keyNewCardsCount,
+    keyUnClickedCardsCount
+} from "../Constants";
+import { cardInfoFromJson, cardsDataFromJson } from "./JsonToModelMapper";
+
+export function getCardsCategoriesFromPayload(payload: string): Array<string> {
+    const categoriesJson = JSON.parse(payload)[keyData];
+    return categoriesJson[keyCategories];
+}
+
+export function getCardInfoFromPayload(payload: string): CardInfo {
+    const cardsInfoJson = JSON.parse(payload)[keyData];
+    return cardInfoFromJson(cardsInfoJson);
+}
+
+export function getCardsDataFromPayload(payload: string): CardsData {
+    const cardsDataJson = JSON.parse(payload)[keyData];
+    return cardsDataFromJson(cardsDataJson);
+}
+
+export function getCardsDataFromPayloadWithDefaultCategory(payload: string): CardsData {
+    const cardsDataJson = JSON.parse(payload)[keyData];
+    cardsDataJson[keyCategory] = "All";
+    return cardsDataFromJson(cardsDataJson);
+}
+
+export function getAllCategoryStatusFromPayload(payload: string): boolean {
+    const statusJson = JSON.parse(payload)[keyData];
+    return statusJson[keyIsAllCategoryEnabled];
+}
+
+export function getNewCardCountFromPayload(payload: string): number {
+    const cardCountJson = JSON.parse(payload)[keyData];
+    return cardCountJson[keyNewCardsCount];
+}
+
+export function getUnclickedCountFromPayload(payload: string): number {
+    const unclickedCountJson = JSON.parse(payload)[keyData];
+    return unclickedCountJson[keyUnClickedCardsCount];
+}

package/src/internal/utils/PlatformPayloadBuilder.ts

@@ -0,0 +1,81 @@
+import Card from "../../model/Card";
+import {
+    getAccountMetaPayload,
+    getCardClickedPayload,
+    getCardShownPayload,
+    getCardsForCategoriesPayload,
+    getDeleteCardsPayload
+} from "./PayloadBuilder";
+
+const PLATFORM_ANDROID = "android";
+const PLATFORM_iOS = "ios";
+
+/**
+ * Class to build the Platform specific payload to communicate with the bridge
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class PlatformPayloadBuilder {
+
+    private platform: string;
+    private appId: string;
+
+    constructor(platform: string, appId: string) {
+        this.platform = platform;
+        this.appId = appId;
+    }
+
+    getAccountMetaPayload(): string | { [k: string]: any } {
+        if (this.platform === PLATFORM_ANDROID) {
+            return JSON.stringify(getAccountMetaPayload(this.appId));
+        } else if (this.platform === PLATFORM_iOS) {
+            return getAccountMetaPayload(this.appId);
+        } else {
+            throw new Error("Platform Not Supported");
+        }
+    }
+
+    getCardClickedPayload(card: Card, widgetId: number): string | { [k: string]: any } {
+        if (this.platform === PLATFORM_ANDROID) {
+            return JSON.stringify(getCardClickedPayload(card, widgetId, this.appId));
+        } else if (this.platform === PLATFORM_iOS) {
+            return getCardClickedPayload(card, widgetId, this.appId);
+        } else {
+            throw new Error("Platform Not Supported");
+        }
+    }
+
+    getCardShowPayload(card: Card): string | { [k: string]: any } {
+        if (this.platform === PLATFORM_ANDROID) {
+            return JSON.stringify(getCardShownPayload(card, this.appId));
+        } else if (this.platform === PLATFORM_iOS) {
+            return getCardShownPayload(card, this.appId);
+        } else {
+            throw new Error("Platform Not Supported");
+        }
+    }
+
+    getCardsForCategoriesPayload(category: string): string | { [k: string]: any } {
+        if (this.platform === PLATFORM_ANDROID) {
+            return JSON.stringify(getCardsForCategoriesPayload(category, this.appId));
+        } else if (this.platform === PLATFORM_iOS) {
+            return getCardsForCategoriesPayload(category, this.appId);
+        } else {
+            throw new Error("Platform Not Supported");
+        }
+
+    }
+
+    getDeleteCardsPayload(cards: Array<Card>): string | { [k: string]: any } {
+        if (this.platform === PLATFORM_ANDROID) {
+            return JSON.stringify(getDeleteCardsPayload(cards, this.appId));
+        } else if (this.platform === PLATFORM_iOS) {
+            return getDeleteCardsPayload(cards, this.appId);
+        } else {
+            throw new Error("Platform Not Supported");
+        }
+    }
+}
+
+export default PlatformPayloadBuilder;

package/src/internal/utils/Util.ts

@@ -0,0 +1,16 @@
+/**
+ * @file contains the utility function
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+
+export function getEnumByName<T>(enumType: any, enumValue: string): T {
+    enumValue = enumValue.toUpperCase();
+    const typedEnumValue = enumValue as unknown as T;
+    const enumIndex = enumType[typedEnumValue]
+    return enumType[enumIndex];
+}
+
+export function assertUnsupportedError(errorMessage: string): never {
+    throw new Error(errorMessage);
+}

package/src/model/CampaignState.ts

@@ -0,0 +1,54 @@
+/**
+ * State of the card.
+ *
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class CampaignState {
+
+    /**
+     * Number of times card shown on the current device
+     * @since 1.0.0
+     */
+    localShowCount: number;
+
+    /**
+     * True if the user has clicked the card, else false.
+     * @since 1.0.0
+     */
+    isClicked: boolean;
+
+    /**
+     * First Time the card was received.
+     * @since 1.0.0
+     */
+    firstReceived: number;
+
+    /**
+     * First Time the card was seen by the user.
+     * @since 1.0.0
+     */
+    firstSeen: number;
+
+    /**
+     * Total number of times campaign has been seen by the user across devices.
+     * @since 1.0.0
+     */
+    totalShowCount: number;
+
+    constructor(
+        localShowCount: number,
+        isClicked: boolean,
+        firstReceived: number,
+        firstSeen: number,
+        totalShowCount: number
+    ) {
+        this.localShowCount = localShowCount;
+        this.isClicked = isClicked;
+        this.firstReceived = firstReceived;
+        this.firstSeen = firstSeen;
+        this.totalShowCount = totalShowCount;
+    }
+}
+
+export default CampaignState;

package/src/model/Card.ts

@@ -0,0 +1,51 @@
+import MetaData from "./MetaData";
+import Template from "./Template";
+
+/**
+ * Card data
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class Card {
+
+    /**
+     * Internal SDK identifier.
+     * @since 1.0.0
+     */
+    id: number;
+
+    /**
+     * Unique identifier for the campaign
+     * @since 1.0.0
+     */
+    cardId: string;
+
+    /**
+     * Category to which the campaign belongs.
+     * @since 1.0.0
+     */
+    category: string;
+
+    /**
+     * Template payload for the campaign.
+     * @since 1.0.0
+     */
+    template: Template;
+
+    /**
+     * Meta data related to the campaign like status, delivery control etc.
+     * @since 1.0.0
+     */
+    metaData: MetaData;
+
+    constructor(id: number, cardId: string, category: string, template: Template, metaData: MetaData) {
+        this.id = id;
+        this.cardId = cardId;
+        this.category = category;
+        this.template = template;
+        this.metaData = metaData;
+    }
+}
+
+export default Card;

package/src/model/CardInfo.ts

@@ -0,0 +1,36 @@
+import Card from "./Card";
+
+/**
+ * All data for cards.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class CardInfo {
+
+    /**
+     * True is showing ALL tabs is enabled else false.
+     * @since 1.0.0
+     */
+    shouldShowAllTab: boolean;
+
+    /**
+     * All configured categories for cards.
+     * @since 1.0.0
+     */
+    categories: Array<string>;
+
+    /**
+     * All cards which are eligible for display currently.
+     * @since 1.0.0
+     */
+    cards: Array<Card>;
+
+    constructor(shouldShowAllTab: boolean, categories: Array<string>, cards: Array<Card>) {
+        this.shouldShowAllTab = shouldShowAllTab;
+        this.categories = categories;
+        this.cards = cards;
+    }
+}
+
+export default CardInfo;

package/src/model/CardsData.ts

@@ -0,0 +1,29 @@
+import Card from "./Card";
+
+/**
+ * Data for cards
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class CardsData {
+
+    /**
+     * Category for the cards
+     * @since 1.0.0
+     */
+    category: string;
+
+    /**
+     * [List] of [Card]
+     * @since 1.0.0
+     */
+    cards: Array<Card>;
+
+    constructor(category: string, cards: Array<Card>) {
+        this.category = category;
+        this.cards = cards;
+    }
+}
+
+export default CardsData;

package/src/model/Container.ts

@@ -0,0 +1,59 @@
+import Widget from "./Widget";
+import Action from "./action/Action";
+import TemplateType from "./enums/TemplateType";
+import ContainerStyle from "./styles/ContainerStyle";
+
+/**
+ * Container to hold UI widget
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class Container {
+
+    /**
+     * Unique identifier for a template
+     * @since 1.0.0
+     */
+    id: number;
+
+    /**
+     * Type of container.
+     * @since 1.0.0
+     */
+    templateType: TemplateType;
+
+    /**
+     * Style associated to the Container
+     * @since 1.0.0
+     */
+    style: ContainerStyle | undefined;
+
+    /**
+     * Widget list associated to the Container
+     * @since 1.0.0
+     */
+    widgets: Array<Widget>;
+
+    /**
+     * Actions to be performed on widget click
+     * @since 1.0.0
+     */
+    actionList: Array<Action>;
+
+    constructor(
+        id: number,
+        templateType: TemplateType,
+        style: ContainerStyle | undefined,
+        widgets: Array<Widget>,
+        actionList: Array<Action>
+    ) {
+        this.id = id;
+        this.templateType = templateType;
+        this.style = style;
+        this.widgets = widgets;
+        this.actionList = actionList;
+    }
+}
+
+export default Container;