Merge pull request #68 from contentstack/develop

v1.5.0

Author: Kaushik Shetty

__test__/extension.test.ts

@@ -1,5 +1,7 @@
+import postRobot from "post-robot";
+
 import Extension from "../src/extension";
-import { IAppConfigInitData } from "../src/types";
+import { IAppConfigInitData, Region } from "../src/types";
 
 jest.mock("post-robot", () => ({
     sendToParent: jest.fn(),
@@ -12,6 +14,7 @@ const initData: IAppConfigInitData = {
         app_id: "app_id",
         installation_uid: "installation_uid",
         extension_uid: "extension_uid",
+        region: "NA",
         stack: {
             created_at: "created_at",
             updated_at: "updated_at",
@@ -30,17 +33,11 @@ const initData: IAppConfigInitData = {
     },
 };
 
-describe("Main extension", () => {
-
+describe("Extension", () => {
     afterEach(() => {
         window["postRobot"] = undefined;
         window["iframeRef"] = undefined;
-    })
-
-    it("should have modal property", () => {
-        const extension = new Extension(initData);
-        expect(extension.modal).toBeDefined();
-    })
+    });
 
     describe("Properties in the window object", () => {
         it("should have postRobot property", () => {
@@ -54,4 +51,36 @@ describe("Main extension", () => {
             );
         });
     });
+
+    it("should have modal property", () => {
+        const extension = new Extension(initData);
+        expect(extension.modal).toBeDefined();
+    });
+
+    it("pulse should invoke post robot method with type analytics", () => {
+        const extensionObj = new Extension(initData);
+        const eventName = "Sample Event";
+        const metadata = { foo: "bar" };
+        extensionObj.pulse(eventName, metadata);
+        expect((postRobot as any).sendToParent).toHaveBeenCalledWith(
+            "analytics",
+            {
+                eventName,
+                metadata,
+            }
+        );
+    });
+
+    describe("getCurrentRegion", () => {
+        it("should have getCurrentRegion method", () => {
+            const extensionObj = new Extension(initData);
+            expect(extensionObj.getCurrentLocation).toBeDefined();
+        });
+
+        it("should return a valid region", () => {
+            const extensionObj = new Extension(initData);
+            const region = extensionObj.getCurrentRegion();
+            expect(region).toBe(Region.NA);
+        });
+    });
 });

__test__/extenstion.test.ts

@@ -30,6 +30,7 @@ describe("FieldModifierLocationEntry", () => {
                 currentBranch: "master",
                 extension_uid: "extension_uid",
                 installation_uid: "installation_uid",
+                region: 'NA',
                 stack: {
                     api_key: "api_key",
                     created_at: "created_at",

__test__/fieldModifierLocation/entry.test.ts

@@ -0,0 +1,83 @@
+import * as Utils from "../src/stack/utils";
+
+describe("Utils", () => {
+    it("merge", () => {
+        const source = {
+            name: "Molecule Man",
+            age: 29,
+            secretIdentity: "Dan Jukes",
+            powers: ["Radiation resistance", "Turning tiny", "Radiation blast"],
+            new: {
+                id: "0001",
+                type: "donut",
+                name: "Cake",
+                image: {
+                    url: "images/0001.jpg",
+                    width: 200,
+                    height: 200,
+                },
+                thumbnail: {
+                    url: "images/thumbnails/0001.jpg",
+                    width: 32,
+                    height: 32,
+                },
+            },
+        };
+
+        const target = {
+            name: "Madame Uppercut",
+            age: 39,
+            secretIdentity: "Jane Wilson",
+            powers: [
+                "Million tonne punch",
+                "Damage resistance",
+                "Superhuman reflexes",
+            ],
+            new: {
+                id: "0001",
+                type: "donut",
+                name: "Cake",
+                image: {
+                    url: "images/0001.jpg",
+                    width: 200,
+                    height: 200,
+                },
+                thumbnail: {
+                    url: "images/thumbnails/0001.jpg",
+                    width: 32,
+                    height: 32,
+                },
+            },
+        };
+
+        const merged = Utils.mergeDeep(target, source);
+        const expected = {
+            name: "Molecule Man",
+            age: 29,
+            secretIdentity: "Dan Jukes",
+            powers: [
+                "Million tonne punch",
+                "Damage resistance",
+                "Superhuman reflexes",
+                "Radiation resistance",
+                "Turning tiny",
+                "Radiation blast",
+            ],
+            new: {
+                id: "0001",
+                type: "donut",
+                name: "Cake",
+                image: { url: "images/0001.jpg", width: 200, height: 200 },
+                thumbnail: {
+                    url: "images/thumbnails/0001.jpg",
+                    width: 32,
+                    height: 32,
+                },
+            },
+        };
+        expect(merged).toEqual(expected);
+        // @ts-ignore
+        expect(Utils.merge({})).toEqual({});
+        expect(Utils.merge({ x: "x" }, { z: "z" })).toEqual({ x: "x", z: "z" });
+    });
+});

__test__/stackUtils.test.ts

@@ -1,83 +1,24 @@
-import * as Utils from "../src/stack/utils";
+import { Region } from "../src/types";
+import { formatAppRegion } from "../src/utils/utils";
 
-describe("Utils", () => {
-    it("merge", () => {
-        const source = {
-            name: "Molecule Man",
-            age: 29,
-            secretIdentity: "Dan Jukes",
-            powers: ["Radiation resistance", "Turning tiny", "Radiation blast"],
-            new: {
-                id: "0001",
-                type: "donut",
-                name: "Cake",
-                image: {
-                    url: "images/0001.jpg",
-                    width: 200,
-                    height: 200,
-                },
-                thumbnail: {
-                    url: "images/thumbnails/0001.jpg",
-                    width: 32,
-                    height: 32,
-                },
-            },
-        };
+describe("formatAppRegion", () => {
+    it('should return NA for "NA"', () => {
+        expect(formatAppRegion("NA")).toBe(Region.NA);
+    });
+
+    it('should return EU for "EU"', () => {
+        expect(formatAppRegion("EU")).toBe(Region.EU);
+    });
 
-        const target = {
-            name: "Madame Uppercut",
-            age: 39,
-            secretIdentity: "Jane Wilson",
-            powers: [
-                "Million tonne punch",
-                "Damage resistance",
-                "Superhuman reflexes",
-            ],
-            new: {
-                id: "0001",
-                type: "donut",
-                name: "Cake",
-                image: {
-                    url: "images/0001.jpg",
-                    width: 200,
-                    height: 200,
-                },
-                thumbnail: {
-                    url: "images/thumbnails/0001.jpg",
-                    width: 32,
-                    height: 32,
-                },
-            },
-        };
+    it('should return AZURE_NA for "AZURE_NA"', () => {
+        expect(formatAppRegion("AZURE_NA")).toBe(Region.AZURE_NA);
+    });
+
+    it('should return AZURE_EU for "AZURE_EU"', () => {
+        expect(formatAppRegion("AZURE_EU")).toBe(Region.AZURE_EU);
+    });
 
-        const merged = Utils.mergeDeep(target, source);
-        const expected = {
-            name: "Molecule Man",
-            age: 29,
-            secretIdentity: "Dan Jukes",
-            powers: [
-                "Million tonne punch",
-                "Damage resistance",
-                "Superhuman reflexes",
-                "Radiation resistance",
-                "Turning tiny",
-                "Radiation blast",
-            ],
-            new: {
-                id: "0001",
-                type: "donut",
-                name: "Cake",
-                image: { url: "images/0001.jpg", width: 200, height: 200 },
-                thumbnail: {
-                    url: "images/thumbnails/0001.jpg",
-                    width: 32,
-                    height: 32,
-                },
-            },
-        };
-        expect(merged).toEqual(expected);
-        // @ts-ignore
-        expect(Utils.merge({})).toEqual({});
-        expect(Utils.merge({ x: "x" }, { z: "z" })).toEqual({ x: "x", z: "z" });
+    it("should return unknown for any invalid region", () => {
+        expect(formatAppRegion("invalid")).toBe(Region.UNKNOWN);
     });
 });

__test__/utils.test.ts

@@ -4,7 +4,7 @@ import Metadata from "./metadata";
 import Modal from "./modal";
 import Stack from "./stack";
 import Store from "./store";
-import { IAppConfigInitData, IAppConfigWidget, IAssetSidebarInitData, ICustomField, IDashboardInitData, IDashboardWidget, IEntryFieldLocation, IEntryFieldLocationInitData, IFieldInitData, IFieldModifierLocation, IFieldModifierLocationInitData, IFullPageLocation, IFullPageLocationInitData, ILocation, IPageWidget, IRTEInitData, ISidebarInitData, ISidebarWidget, IUser } from "./types";
+import { IAppConfigInitData, IAppConfigWidget, IAssetSidebarInitData, ICustomField, IDashboardInitData, IDashboardWidget, IEntryFieldLocation, IEntryFieldLocationInitData, IFieldInitData, IFieldModifierLocation, IFieldModifierLocationInitData, IFullPageLocation, IFullPageLocationInitData, ILocation, IPageWidget, IRTEInitData, ISidebarInitData, ISidebarWidget, IUser, Region } from "./types";
 /** Class representing an extension from Contentstack App Framework SDK. */
 declare class Extension {
     /**
@@ -21,6 +21,7 @@ declare class Extension {
     metadata: Metadata;
     locationUID: string;
     modal: Modal;
+    readonly region: Region;
     location: {
         DashboardWidget: IDashboardWidget | null;
         SidebarWidget: ISidebarWidget | null;
@@ -41,6 +42,7 @@ declare class Extension {
         [key: string]: any;
     }>;
     getCurrentLocation: () => ILocation;
+    getCurrentRegion: () => Region;
     static initialize(version: string): any;
     setReady(): any;
 }

dist/index.js

@@ -58,6 +58,7 @@ declare interface ICommonInitData {
     stack: StackDetail;
     user: IUser;
     currentBranch: string;
+    region: string;
 }
 export declare interface IDashboardInitData {
     data: ICommonInitData & {
@@ -209,5 +210,12 @@ export declare interface IManagementTokenDetails {
     uid: string;
     name: string;
 }
+export declare enum Region {
+    UNKNOWN = "UNKNOWN",
+    NA = "NA",
+    EU = "EU",
+    AZURE_NA = "AZURE_NA",
+    AZURE_EU = "AZURE_EU"
+}
 export {};
 //# sourceMappingURL=types.d.ts.map