react-native-moengage-cards 1.0.0

package/src/model/DisplayControl.ts

@@ -0,0 +1,70 @@
+import ShowTime from "./ShowTime";
+
+/**
+ * Delivery Controls defined during campaign creation.
+ *
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class DisplayControl {
+
+    /**
+     * Absolute time at which the card should be expired.
+     *
+     * Value in seconds.
+     * @since 1.0.0
+     */
+    expireAt: number;
+
+    /**
+     * Time duration after which card should be expired once it is seen.
+     *
+     * Value in seconds.
+     * @since 1.0.0
+     */
+    expireAfterSeen: number;
+
+    /**
+     * Time duration after which the card should be expired once it is delivered on the device.
+     *
+     * Value in seconds.
+     * @since 1.0.0
+     */
+    expireAfterDelivered: number;
+
+    /**
+     * Maximum number of times a campaign should be shown to the user across devices.
+     * @since 1.0.0
+     */
+    maxCount: number;
+
+    /**
+     * True if the campaign is pinned on top, else false.
+     * @since 1.0.0
+     */
+    isPinned: boolean;
+
+    /**
+     * Time during the day when the campaign should be shown.
+     * @since 1.0.0
+     */
+    showTime: ShowTime;
+
+    constructor(
+        expireAt: number,
+        expireAfterSeen: number,
+        expireAfterDelivered: number,
+        maxCount: number,
+        isPinned: boolean,
+        showTime: ShowTime
+    ) {
+        this.expireAt = expireAt;
+        this.expireAfterSeen = expireAfterSeen;
+        this.expireAfterDelivered = expireAfterDelivered;
+        this.maxCount = maxCount;
+        this.isPinned = isPinned;
+        this.showTime = showTime;
+    }
+}
+
+export default DisplayControl;

package/src/model/MetaData.ts

@@ -0,0 +1,90 @@
+import CampaignState from "./CampaignState";
+import DisplayControl from "./DisplayControl";
+
+/**
+ * Meta data related to a campaign.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class MetaData {
+
+    /**
+     * True if the campaign should be pinned to the top else false.
+     * @since 1.0.0
+     */
+    isPinned: boolean;
+
+    /**
+     * True if the campaign hasn't been delivered to the inbox, else false.
+     * @since 1.0.0
+     */
+    isNewCard: boolean;
+
+    /**
+     * Current state of the campaign.
+     * @since 1.0.0
+     */
+    campaignState: CampaignState;
+
+    /**
+     * Time at which the campaign would be deleted from local store.
+     * @since 1.0.0
+     */
+    deletionTime: number;
+
+    /**
+     * Delivery Controls defined during campaign creation.
+     * @since 1.0.0
+     */
+    displayControl: DisplayControl;
+
+    /**
+     * Additional meta data regarding campaign used for tracking purposes.
+     * @since 1.0.0
+     */
+    metaData: { [k: string]: any };
+
+    /**
+     * Creation time for the campaign.
+     * Notes: Available in iOS, default value is -1
+     * @since 1.0.0
+     */
+    createdAt: number;
+
+    /**
+     * Last time the campaign was updated.
+     * @since 1.0.0
+     */
+    updatedTime: number;
+
+    /**
+     * Complete Campaign payload.
+     * @since 1.0.0
+     */
+    campaignPayload: { [k: string]: any };
+
+    constructor(
+        isPinned: boolean,
+        isNewCard: boolean,
+        campaignState: CampaignState,
+        deletionTime: number,
+        displayControl: DisplayControl,
+        metaData: { [k: string]: any },
+        createdAt: number,
+        updatedTime: number,
+        campaignPayload: { [k: string]: any }
+    ) {
+        this.isPinned = isPinned;
+        this.isNewCard = isNewCard;
+        this.campaignState = campaignState;
+        this.deletionTime = deletionTime;
+        this.displayControl = displayControl;
+        this.metaData = metaData;
+        this.createdAt = createdAt;
+        this.updatedTime = updatedTime;
+        this.campaignPayload = campaignPayload;
+    }
+}
+
+export default MetaData;

package/src/model/ShowTime.ts

@@ -0,0 +1,27 @@
+/**
+ * Time span during card can be shown
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class ShowTime {
+
+    /**
+     * Start time for the time range.
+     * @since 1.0.0
+     */
+    startTime: string;
+
+    /**
+     * End time for the time range.
+     * @since 1.0.0
+     */
+    endTime: string;
+
+    constructor(startTime: string, endTime: string) {
+        this.startTime = startTime;
+        this.endTime = endTime;
+    }
+}
+
+export default ShowTime;

package/src/model/SyncData.ts

@@ -0,0 +1,30 @@
+import SyncType from "./enums/SyncType";
+
+/**
+ * Data on API sync complete.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class SyncCompleteData {
+
+    /**
+     * Indicating if there were any updates in the cards post sync. true if there are any new
+     * updates present else false. This value is true even if card(s) are deleted.
+     * @since 1.0.0
+     */
+    hasUpdates: boolean;
+
+    /**
+     * Condition under which sync was triggered. Refer to {@link SyncType}
+     * @since 1.0.0
+     */
+    syncType: SyncType;
+
+    constructor(hasUpdates: boolean, syncType: SyncType) {
+        this.hasUpdates = hasUpdates;
+        this.syncType = syncType;
+    }
+}
+
+export default SyncCompleteData;

package/src/model/Template.ts

@@ -0,0 +1,37 @@
+import Container from "./Container";
+import TemplateType from "./enums/TemplateType";
+
+/**
+ * Card Template data.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class Template {
+
+    /**
+     * Type of Template.
+     * @since 1.0.0
+     */
+    templateType: TemplateType;
+
+    /**
+     * Containers in the template.
+     * @since 1.0.0
+     */
+    containers: Array<Container>;
+
+    /**
+     * Additional data associated to the template
+     * @since 1.0.0
+     */
+    kvPairs: { [k: string]: any };
+
+    constructor(templateType: TemplateType, containers: Array<Container>, kvPairs: { [k: string]: any }) {
+        this.templateType = templateType;
+        this.containers = containers;
+        this.kvPairs = kvPairs;
+    }
+}
+
+export default Template;

package/src/model/Widget.ts

@@ -0,0 +1,59 @@
+import Action from "./action/Action";
+import WidgetType from "./enums/WidgetType";
+import WidgetStyle from "./styles/WidgetStyle";
+
+/**
+ * UI element in a card.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class Widget {
+
+    /**
+     * Identifier for the widget.
+     * @since 1.0.0
+     */
+    id: number;
+
+    /**
+     * Type of widget
+     * @since 1.0.0
+     */
+    widgetType: WidgetType;
+
+    /**
+     * Content to be loaded in the widget.
+     * @since 1.0.0
+     */
+    content: string;
+
+    /**
+     * Style associated with the widget
+     * @since 1.0.0
+     */
+    style: WidgetStyle | undefined;
+
+    /**
+     * Actions to be performed on widget click
+     * @since 1.0.0
+     */
+    actionList: Array<Action>;
+
+    constructor(
+        id: number,
+        widgetType: WidgetType,
+        content: string,
+        style: WidgetStyle | undefined,
+        actionList: Array<Action>
+    ) {
+        this.id = id;
+        this.widgetType = widgetType;
+        this.content = content;
+        this.style = style;
+        this.actionList = actionList;
+    }
+}
+
+
+export default Widget;

package/src/model/action/Action.ts

@@ -0,0 +1,22 @@
+import ActionType from "../enums/ActionType";
+
+/**
+ * Base class for actions.
+ *
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+abstract class Action {
+
+    /**
+     * Action type
+     * @since 1.0.0
+     */
+    actionType: ActionType;
+
+    constructor(actionType: ActionType) {
+        this.actionType = actionType;
+    }
+}
+
+export default Action;

package/src/model/action/NavigationAction.ts

@@ -0,0 +1,39 @@
+import ActionType from "../enums/ActionType";
+import NavigationType from "../enums/NavigationType";
+import Action from "./Action";
+
+/**
+ * Navigation Action object.
+ *
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class NavigationAction extends Action {
+
+    /**
+     * Type of Navigation action.
+     * @since 1.0.0
+     */
+    navigationType: NavigationType;
+
+    /**
+     * Url/Screen-name to which the user should be navigated.
+     * @since 1.0.0
+     */
+    value: string;
+
+    /**
+     * Key-Value pair added on the MoEngage Platform for navigation action.
+     * @since 1.0.0
+     */
+    kvPairs: { [k: string]: any };
+
+    constructor(actionType: ActionType, navigationType: NavigationType, value: string, kvPairs: { [k: string]: any }) {
+        super(actionType);
+        this.navigationType = navigationType;
+        this.value = value;
+        this.kvPairs = kvPairs;
+    }
+}
+
+export default NavigationAction;

package/src/model/enums/ActionType.ts

@@ -0,0 +1,16 @@
+/**
+ * Supported action types on card click.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+enum ActionType {
+
+    /**
+     * Action to navigate user to a different screen.
+     * @since 1.0.0
+     */
+    NAVIGATE = "NAVIGATE"
+}
+
+export default ActionType;

package/src/model/enums/NavigationType.ts

@@ -0,0 +1,28 @@
+/**
+ * Types of navigation action.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+enum NavigationType {
+
+    /**
+     * Navigation is done using a deep-link Url or http(s) url.
+     * @since 1.0.0
+     */
+    DEEPLINK = "DEEPLINK",
+
+    /**
+     * Navigation to a rich-landing url
+     * @since 1.0.0
+     */
+    RICHLANDING = "RICHLANDING",
+
+    /**
+     * Navigation is done using activity name or screen name.
+     * @since 1.0.0
+     */
+    SCREENNAME = "SCREENNAME"
+}
+
+export default NavigationType;

package/src/model/enums/SyncType.ts

@@ -0,0 +1,28 @@
+/**
+ * Condition/Situation when sync
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+enum SyncType {
+
+    /**
+     * Sync when application comes to foreground.
+     * @since 1.0.0
+     */
+    APP_OPEN = "APP_OPEN",
+
+    /**
+     * Sync when inbox screen opened.
+     * @since 1.0.0
+     */
+    INBOX_OPEN = "INBOX_OPEN",
+
+    /**
+     * Sync when SwipeToRefresh widget is pulled.
+     * @since 1.0.0
+     */
+    PULL_TO_REFRESH = "PULL_TO_REFRESH"
+}
+
+export default SyncType;

package/src/model/enums/TemplateType.ts

@@ -0,0 +1,22 @@
+/**
+ * Supported template types.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+enum TemplateType {
+
+    /**
+     * Basic Template
+     * @since 1.0.0
+     */
+    BASIC = "BASIC",
+
+    /**
+     * Illustration Template
+     * @since 1.0.0
+     */
+    ILLUSTRATION = "ILLUSTRATION"
+}
+
+export default TemplateType;

package/src/model/enums/WidgetType.ts

@@ -0,0 +1,28 @@
+/**
+ * Types of UI widgets supported.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+enum WidgetType {
+
+    /**
+     * Widget that loads an image or gif
+     * @since 1.0.0
+     */
+    IMAGE = "IMAGE",
+
+    /**
+     * Widget that loads text content.
+     * @since 1.0.0
+     */
+    TEXT = "TEXT",
+
+    /**
+     * Widget that loads button content.
+     * @since 1.0.0
+     */
+    BUTTON = "BUTTON"
+}
+
+export default WidgetType;

package/src/model/styles/ButtonStyle.ts

@@ -0,0 +1,23 @@
+import WidgetStyle from "./WidgetStyle";
+
+/**
+ * Style attributes for a Button Widget.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class ButtonStyle extends WidgetStyle {
+
+    /**
+     * Font size of the button text.
+     * @since 1.0.0
+     */
+    fontSize: number;
+
+    constructor(backgroundColor: string, fontSize: number) {
+        super(backgroundColor);
+        this.fontSize = fontSize;
+    }
+}
+
+export default ButtonStyle;

package/src/model/styles/ContainerStyle.ts

@@ -0,0 +1,20 @@
+/**
+ * Style attributes of a [Container]
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class ContainerStyle {
+
+    /**
+     * Background color of the container.
+     * @since 1.0.0
+     */
+    backgroundColor: string;
+
+    constructor(backgroundColor: string) {
+        this.backgroundColor = backgroundColor;
+    }
+}
+
+export default ContainerStyle;

package/src/model/styles/ImageStyle.ts

@@ -0,0 +1,16 @@
+import WidgetStyle from "./WidgetStyle";
+
+/**
+ * Style attributes for an Image Widget.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class ImageStyle extends WidgetStyle {
+
+    constructor(backgroundColor: string) {
+        super(backgroundColor);
+    }
+}
+
+export default ImageStyle;

package/src/model/styles/TextStyle.ts

@@ -0,0 +1,19 @@
+import WidgetStyle from "./WidgetStyle";
+
+/**
+ * Style attributes for the Text widget.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+class TextStyle extends WidgetStyle {
+
+    fontSize: number;
+
+    constructor(backgroundColor: string, fontSize: number) {
+        super(backgroundColor);
+        this.fontSize = fontSize;
+    }
+}
+
+export default TextStyle;

package/src/model/styles/WidgetStyle.ts

@@ -0,0 +1,19 @@
+/**
+ * Base style for all widgets.
+ * 
+ * @author Abhishek Kumar
+ * @since 1.0.0
+ */
+abstract class WidgetStyle {
+
+    /**
+     * Background color of the Button.
+     */
+    backgroundColor: string;
+
+    constructor(backgroundColor: string) {
+        this.backgroundColor = backgroundColor;
+    }
+}
+
+export default WidgetStyle;