feat: Organization full page support

Author: abhishek305

__test__/organizationFullPage.test.ts

@@ -0,0 +1,48 @@
+import EventEmitter from "wolfy87-eventemitter";
+import OrganizationFullPage from "../src/OrganizationFullPage";
+import { IOrgFullPageLocationInitData, LocationType } from "../src/types";
+import { OrganizationDetails } from "../src/types/organization.types";
+
+describe("OrganizationFullPage", () => {
+    const mockConnection = {
+        sendToParent: jest.fn().mockReturnValue(Promise.resolve({})),
+    };
+    const mockEmitter: EventEmitter = new EventEmitter();
+    const mockData: IOrgFullPageLocationInitData = {
+        type: LocationType.ORGANIZATION_FULL_PAGE,
+        app_id: "app_id",
+        installation_uid: "installation_uid",
+        extension_uid: "extension_uid",
+        region: "NA",
+        stack: {} as any,
+        user: {} as any,
+        currentBranch: "currentBranch",
+        organization: {} as OrganizationDetails,
+    };
+    const organizationFullPage = new OrganizationFullPage(
+        mockData,
+        mockConnection as any,
+        mockEmitter
+    );
+
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+
+    it("should return organization details", () => {
+        expect(organizationFullPage.currentOrganization).toBe(mockData.organization);
+    });
+
+    it("should handle missing organization details", () => {
+        const invalidData: IOrgFullPageLocationInitData = {
+            ...mockData,
+            organization: null as any, // check missing organization details
+        };
+        const invalidOrganizationFullPage = new OrganizationFullPage(
+            invalidData,
+            mockConnection as any,
+            mockEmitter
+        );
+        expect(invalidOrganizationFullPage.currentOrganization).toBeNull();
+    });
+});

src/OrganizationFullPage/index.ts

@@ -0,0 +1,26 @@
+import postRobot from "post-robot";
+import EventEmitter from "wolfy87-eventemitter";
+import { OrganizationDetails } from "../types/organization.types";
+import { IOrgFullPageLocationInitData } from "../types";
+
+class OrganizationFullPage {
+    private _data: IOrgFullPageLocationInitData;
+    private _connection: typeof postRobot;
+    private _emitter: EventEmitter;
+
+    constructor(
+        data: IOrgFullPageLocationInitData,
+        connection: typeof postRobot,
+        emitter: EventEmitter
+    ) {
+        this._data = data;
+        this._connection = connection;
+        this._emitter = emitter;
+    }
+
+    get currentOrganization(): OrganizationDetails {
+        return this._data.organization;
+    }
+}
+
+export default OrganizationFullPage;

src/types.ts

@@ -6,8 +6,10 @@ import Stack from "./stack";
 import { GenericObjectType } from "./types/common.types";
 import { Entry } from "./types/entry.types";
 import { Asset, ContentType, Schema, StackDetail } from "./types/stack.types";
+import { OrganizationDetails } from "./types/organization.types";
 import { User } from "./types/user.types";
 import Window from "./window";
+import OrganizationFullPage from "./OrganizationFullPage";
 
 export declare interface IDashboardWidget {
     frame: Window;
@@ -67,6 +69,10 @@ export declare interface IAppConfigWidget {
     stack: Stack;
 }
 
+export declare interface IOrgFullPageLocation {
+    organization: OrganizationFullPage;
+}
+
 export enum DashboardWidth {
     FULL_WIDTH = "full_width",
     HALF_WIDTH = "half_width",
@@ -82,6 +88,7 @@ export enum LocationType {
     RTE = "RTE",
     WIDGET = "WIDGET",
     CONTENT_TYPE_SIDEBAR_WIDGET = "CONTENT_TYPE_SIDEBAR_WIDGET",
+    ORGANIZATION_FULL_PAGE = "ORGANIZATION_FULL_PAGE",
 }
 
 // Init data
@@ -98,6 +105,12 @@ declare interface ICommonInitData {
     manifest?: Manifest;
 }
 
+export declare interface IOrgFullPageLocationInitData extends ICommonInitData {
+    organization: OrganizationDetails;
+    config?: GenericObjectType;
+    type: LocationType.ORGANIZATION_FULL_PAGE;
+}
+
 export declare interface IDashboardInitData extends ICommonInitData {
     dashboard_width: DashboardWidth;
     config?: GenericObjectType;
@@ -202,7 +215,8 @@ export type InitializationData =
     | IFullPageLocationInitData
     | IRTEInitData
     | ISidebarInitData
-    | IContentTypeSidebarInitData;
+    | IContentTypeSidebarInitData
+    | IOrgFullPageLocationInitData;
 
 /**
  * installation details API response

src/types/organization.types.ts

@@ -0,0 +1,34 @@
+import { GenericObjectType } from "./common.types";
+
+export declare interface OrganizationDetails {
+    uid: string;
+    name: string;
+    plan_id: string;
+    owner_uid: string;
+    is_transfer_set: boolean;
+    expires_on: string;
+    enabled: boolean;
+    is_over_usage_allowed: boolean;
+    created_at: string;
+    updated_at: string;
+    settings: GenericObjectType;
+    tags: string[];
+    plan?: {
+        plan_id: string;
+        name: string;
+        message: string;
+        price: string;
+        features: {
+            uid: string;
+            name: string;
+            enabled: boolean;
+            limit: number;
+            max_limit: number;
+            is_required: boolean;
+            depends_on: string[];
+        }[];
+        created_at: string;
+        updated_at: string;
+        blockedAssetTypes: any[];
+    };
+}

src/uiLocation.ts

@@ -3,6 +3,7 @@ import EventEmitter from "wolfy87-eventemitter";
 
 import AssetSidebarWidget from "./AssetSidebarWidget";
 import ContentTypeSidebarWidget from "./ContentTypeSidebarWidget";
+import OrganizationFullPage from "./OrganizationFullPage";
 import { IRTEPluginInitializer } from "./RTE/types";
 import { AppConfig } from "./appConfig";
 import Entry from "./entry";
@@ -26,6 +27,7 @@ import {
     LocationType,
     Manifest,
     Region,
+    IOrgFullPageLocation,
 } from "./types";
 import { GenericObjectType } from "./types/common.types";
 import { User } from "./types/user.types";
@@ -117,6 +119,7 @@ class UiLocation {
         FullPage: IFullPageLocation | null;
         FieldModifierLocation: IFieldModifierLocation | null;
         ContentTypeSidebarWidget: ContentTypeSidebarWidget | null;
+        OrganizationFullPage: IOrgFullPageLocation | null;
     };
 
     constructor(initData: InitializationData) {
@@ -155,6 +158,7 @@ class UiLocation {
             FullPage: null,
             FieldModifierLocation: null,
             ContentTypeSidebarWidget: null,
+            OrganizationFullPage: null
         };
 
         window["postRobot"] = postRobot;
@@ -262,6 +266,17 @@ class UiLocation {
                 break;
             }
 
+            case LocationType.ORGANIZATION_FULL_PAGE: {
+                this.location.OrganizationFullPage = {
+                    organization: new OrganizationFullPage(
+                        initializationData,
+                        postRobot,
+                        emitter
+                    ),
+                };
+                break;
+            } 
+
             case LocationType.CONTENT_TYPE_SIDEBAR_WIDGET: {
                 this.location.ContentTypeSidebarWidget =
                     new ContentTypeSidebarWidget(