Merge pull request #143 from contentstack/staging

Staging --> Main

Author: Amitkanswal

.eslintrc

@@ -12,11 +12,6 @@
         "plugin:@typescript-eslint/eslint-recommended",
         "plugin:@typescript-eslint/recommended"
     ],
-    "env": {
-        "browser": true,
-        "node": true
-    },
-
     "rules": {
         "@typescript-eslint/no-explicit-any": 0,
         "@typescript-eslint/prefer-const": 0,

.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x]
+        node-version: [18.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

.github/workflows/npm-publish-github-packages.yml

@@ -14,7 +14,7 @@ jobs:
             - uses: actions/checkout@v3
             - uses: actions/setup-node@v3
               with:
-                  node-version: 14
+                  node-version: 18
             - run: npm ci
             - run: npm test
 
@@ -28,7 +28,7 @@ jobs:
             - uses: actions/checkout@v3
             - uses: actions/setup-node@v3
               with:
-                  node-version: 14
+                  node-version: 18
                   registry-url: https://npm.pkg.github.com/
             - run: npm ci
             - run: npm publish

.github/workflows/npm-publish.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: 18
       - run: npm ci
       - run: npm test
 
@@ -25,7 +25,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: 16
+          node-version: 18
           registry-url: https://registry.npmjs.org/
       - run: npm ci
       - run: npm publish

.github/workflows/unit-test.yml

@@ -16,18 +16,18 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [18.x]
 
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
         with:
-          node-version: '14.x'
+          node-version: '18.x'
 
       - name: Use Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: '14.x'
+          node-version: '18.x'
 
       - name: Install deps
         run: npm ci

__test__/assetSidebarWidget.test.ts

@@ -25,6 +25,7 @@ describe("AssetSidebarWidget", () => {
         user: {} as any,
         currentBranch: "mock_branch",
         region: "region",
+        endpoints: { CMA: "", APP: "",DEVELOPER_HUB:"" },
     };
 
     let connection: { sendToParent: (...props: any[]) => any };

__test__/fieldModifierLocation/entry.test.ts

@@ -47,6 +47,7 @@ describe("FieldModifierLocationEntry", () => {
             extension_uid: "extension_uid",
             installation_uid: "installation_uid",
             region: "NA",
+            endpoints: { CMA: "", APP: "",DEVELOPER_HUB:"" },
             stack: {
                 api_key: "api_key",
                 created_at: "created_at",

__test__/init.test.ts

@@ -3,6 +3,7 @@ import UiLocation from "../src/uiLocation";
 import { version } from "../package.json";
 
 jest.mock("../src/uiLocation");
+jest.mock("axios");
 
 describe("ContentstackAppSDK", () => {
     describe("init", () => {

__test__/organizationFullPage.test.ts

@@ -0,0 +1,39 @@
+import { IGlobalFullPageLocationInitData, LocationType } from "../src/types";
+import { OrganizationDetails } from "../src/types/organization.types";
+
+const mockData: IGlobalFullPageLocationInitData = {
+    type: LocationType.GLOBAL_FULL_PAGE_LOCATION,
+    app_id: "app_id",
+    installation_uid: "installation_uid",
+    extension_uid: "extension_uid",
+    region: "NA",
+    endpoints: { CMA: "", APP: "", DEVELOPER_HUB: "" },
+    stack: {} as any,
+    user: {} as any,
+    currentBranch: "currentBranch",
+    organization: {} as OrganizationDetails,
+};
+const organizationFullPage = {
+    currentOrganization: mockData.organization,
+};
+
+afterEach(() => {
+    jest.clearAllMocks();
+});
+
+test("should return organization details", () => {
+    expect(organizationFullPage.currentOrganization).toBe(
+        mockData.organization
+    );
+});
+
+test("should handle missing organization details", () => {
+    const invalidData: IGlobalFullPageLocationInitData = {
+        ...mockData,
+        organization: null as any, // check missing organization details
+    };
+    const invalidOrganizationFullPage = {
+        currentOrganization: invalidData.organization,
+    };
+    expect(invalidOrganizationFullPage.currentOrganization).toBeNull();
+});

__test__/uiLocation.test.ts

@@ -1,3 +1,5 @@
+import { AxiosRequestConfig, AxiosResponse } from "axios";
+
 import postRobot from "post-robot";
 
 import UiLocation from "../src/uiLocation";
@@ -12,6 +14,8 @@ import {
     LocationType,
     Region,
 } from "../src/types";
+import { RequestOption } from "../src/types/common.types";
+import { RequestConfig } from "../src/types/api.type";
 
 jest.mock("post-robot");
 jest.mock("wolfy87-eventemitter");
@@ -57,6 +61,11 @@ const initData: IAppConfigInitData = {
     installation_uid: "installation_uid",
     extension_uid: "extension_uid",
     region: "NA",
+    endpoints: {
+        CMA: "https://api.contentstack.io",
+        APP: "https://app.contentstack.app",
+        DEVELOPER_HUB: "",
+    },
     stack: mockStackData,
     user: {} as any,
     currentBranch: "currentBranch",
@@ -131,6 +140,154 @@ describe("UI Location", () => {
         });
     });
 
+    describe("dispatchPostRobotRequest", () => {
+        let mockPostRobot: typeof postRobot;
+        let opts: RequestOption;
+        let uiLocationInstance: UiLocation;
+        let onError: jest.Mock;
+
+        beforeEach(() => {
+            mockPostRobot = postRobot;
+            opts = { method: "GET" };
+            uiLocationInstance = new UiLocation(initData);
+            onError = jest.fn();
+            uiLocationInstance.api = jest.fn().mockResolvedValue({
+                method: "GET",
+                url: "https://test.com/test?limit=10&skip=0",
+            });
+        });
+
+        it("should call sendToParent with the correct arguments and resolve with data", async () => {
+            const mockData = { success: true };
+            // Call the method that uses uiLocationInstance.api
+            const result = await uiLocationInstance.api(
+                "https://test.com/test?limit=10&skip=0",
+                {
+                    method: "GET",
+                }
+            );
+
+            // Assertions
+            expect(uiLocationInstance.api).toHaveBeenCalledWith(
+                "https://test.com/test?limit=10&skip=0",
+                {
+                    method: "GET",
+                }
+            );
+            expect(result).toEqual({
+                method: "GET",
+                url: "https://test.com/test?limit=10&skip=0",
+            });
+        });
+
+        it("should call onError if sendToParent rejects", async () => {
+            const mockError = new Error("Test error");
+
+            // Mock the api method to reject with an error
+            uiLocationInstance.api = jest.fn().mockRejectedValue(mockError);
+
+            // Mock the onError implementation
+            onError.mockImplementation((error) => {
+                throw error;
+            });
+
+            // Call the method that uses uiLocationInstance.api and expect it to throw an error
+            await expect(
+                uiLocationInstance.api(
+                    "https://test.com/test?limit=10&skip=0",
+                    {
+                        method: "GET",
+                    }
+                )
+            ).rejects.toThrow("Test error");
+        });
+    });
+
+    describe("createSDKAdapter", () => {
+        let mockPostRobot: typeof postRobot;
+        let opts: RequestConfig;
+        let uiLocationInstance: UiLocation;
+        let onError: jest.Mock;
+
+        beforeEach(() => {
+            mockPostRobot = postRobot;
+            opts = {
+                method: "GET",
+                baseURL: "https://test.com",
+                url: "/test?limit10&skip=0",
+            };
+            uiLocationInstance = new UiLocation(initData);
+            onError = jest.fn();
+            uiLocationInstance.createAdapter = jest
+                .fn()
+                .mockImplementation(
+                    () => async (config: AxiosRequestConfig) => {
+                        return {
+                            method: "GET",
+                            url: "/test?limit=10&skip=0",
+                            baseURL: "https://test.com",
+                            data: {},
+                        } as unknown as AxiosResponse;
+                    }
+                );
+        });
+
+        afterEach(() => {
+            postRobotOnMock.mockClear();
+            postRobotSendToParentMock.mockClear();
+
+            jest.clearAllMocks();
+            window["postRobot"] = undefined;
+            window["iframeRef"] = undefined;
+        });
+
+        it("should call createAdapter with the correct arguments and resolve with data", async () => {
+            const mockData = { success: true };
+            // Call the method that uses uiLocationInstance.createAdapter
+            const result = await uiLocationInstance.createAdapter()({
+                method: "GET",
+                url: "/test?limit=10&skip=0",
+                baseURL: "https://test.com",
+                data: {},
+            });
+
+            expect(result).toEqual({
+                method: "GET",
+                url: "/test?limit=10&skip=0",
+                baseURL: "https://test.com",
+                data: {},
+            });
+        });
+
+        it("should call onError if createAdapter rejects", async () => {
+            const mockError = new Error("Test error");
+
+            // Mock the createAdapter method to reject with an error
+            uiLocationInstance.createAdapter = jest
+                .fn()
+                .mockImplementation(
+                    () => async (config: AxiosRequestConfig) => {
+                        throw mockError;
+                    }
+                );
+
+            // Mock the onError implementation
+            onError.mockImplementation((error) => {
+                throw error;
+            });
+
+            // Call the method that uses uiLocationInstance.createAdapter and expect it to throw an error
+            await expect(
+                uiLocationInstance.createAdapter()({
+                    method: "GET",
+                    url: "/test?limit=10&skip=0",
+                    baseURL: "https://test.com",
+                    data: {},
+                })
+            ).rejects.toThrow("Test error");
+        });
+    });
+
     describe("getConfig", () => {
         it("should return config if no installation uid present", async () => {
             const uiLocation = new UiLocation(initDataJsonRte as any);