Skip to content

armgit / plane

Public Imported from GitHub
0

πŸ”₯πŸ”₯πŸ”₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.

fix: instance admin layout

sriram veeraghanta69ce0031d057
diff --git a/admin/app/ai/layout.tsx b/admin/app/ai/layout.tsx
index e3fd537bce..0a0bacac1f 100644
--- a/admin/app/ai/layout.tsx
+++ b/admin/app/ai/layout.tsx
@@ -1,9 +1,11 @@
-"use client";
-
import { ReactNode } from "react";
-// layouts
+import { Metadata } from "next";
import { AdminLayout } from "@/layouts/admin-layout";
+export const metadata: Metadata = {
+ title: "AI Settings - God Mode",
+};
+
export default function AILayout({ children }: { children: ReactNode }) {
return <AdminLayout>{children}</AdminLayout>;
}
diff --git a/admin/app/authentication/layout.tsx b/admin/app/authentication/layout.tsx
index 2568859db3..64506ddb4e 100644
--- a/admin/app/authentication/layout.tsx
+++ b/admin/app/authentication/layout.tsx
@@ -1,9 +1,11 @@
-"use client";
-
import { ReactNode } from "react";
-// layouts
+import { Metadata } from "next";
import { AdminLayout } from "@/layouts/admin-layout";
+export const metadata: Metadata = {
+ title: "Authentication Settings - God Mode",
+};
+
export default function AuthenticationLayout({ children }: { children: ReactNode }) {
return <AdminLayout>{children}</AdminLayout>;
}
diff --git a/admin/app/email/layout.tsx b/admin/app/email/layout.tsx
index 626c5d5573..64f019ec95 100644
--- a/admin/app/email/layout.tsx
+++ b/admin/app/email/layout.tsx
@@ -1,13 +1,15 @@
-"use client";
-
import { ReactNode } from "react";
-// layouts
+import { Metadata } from "next";
import { AdminLayout } from "@/layouts/admin-layout";
interface EmailLayoutProps {
children: ReactNode;
}
+export const metadata: Metadata = {
+ title: "Email Settings - God Mode",
+};
+
const EmailLayout = ({ children }: EmailLayoutProps) => <AdminLayout>{children}</AdminLayout>;
export default EmailLayout;
diff --git a/admin/app/general/form.tsx b/admin/app/general/form.tsx
index 09079028d6..5646084e2a 100644
--- a/admin/app/general/form.tsx
+++ b/admin/app/general/form.tsx
@@ -13,7 +13,7 @@ import { ControllerInput } from "@/components/common";
import { useInstance } from "@/hooks/store";
export interface IGeneralConfigurationForm {
- instance: IInstance["instance"];
+ instance: IInstance;
instanceAdmins: IInstanceAdmin[];
}
@@ -26,15 +26,15 @@ export const GeneralConfigurationForm: FC<IGeneralConfigurationForm> = observer(
handleSubmit,
control,
formState: { errors, isSubmitting },
- } = useForm<Partial<IInstance["instance"]>>({
+ } = useForm<Partial<IInstance>>({
defaultValues: {
instance_name: instance?.instance_name,
is_telemetry_enabled: instance?.is_telemetry_enabled,
},
});
- const onSubmit = async (formData: Partial<IInstance["instance"]>) => {
- const payload: Partial<IInstance["instance"]> = { ...formData };
+ const onSubmit = async (formData: Partial<IInstance>) => {
+ const payload: Partial<IInstance> = { ...formData };
console.log("payload", payload);
diff --git a/admin/app/general/layout.tsx b/admin/app/general/layout.tsx
index 371264e92e..fabbe3640e 100644
--- a/admin/app/general/layout.tsx
+++ b/admin/app/general/layout.tsx
@@ -1,6 +1,5 @@
import { ReactNode } from "react";
import { Metadata } from "next";
-// components
import { AdminLayout } from "@/layouts/admin-layout";
export const metadata: Metadata = {
diff --git a/admin/app/general/page.tsx b/admin/app/general/page.tsx
index 399482ea6e..bab2a94fcf 100644
--- a/admin/app/general/page.tsx
+++ b/admin/app/general/page.tsx
@@ -7,7 +7,7 @@ import { GeneralConfigurationForm } from "./form";
function GeneralPage() {
const { instance, instanceAdmins } = useInstance();
- console.log("instance", instanceAdmins);
+ console.log("instance", instance);
return (
<>
<div className="relative container mx-auto w-full h-full p-8 py-4 space-y-6 flex flex-col">
@@ -19,8 +19,8 @@ function GeneralPage() {
</div>
</div>
<div className="flex-grow overflow-hidden overflow-y-auto">
- {instance?.instance && instanceAdmins && (
- <GeneralConfigurationForm instance={instance.instance} instanceAdmins={instanceAdmins} />
+ {instance && instanceAdmins && (
+ <GeneralConfigurationForm instance={instance} instanceAdmins={instanceAdmins} />
)}
</div>
</div>
diff --git a/admin/app/image/layout.tsx b/admin/app/image/layout.tsx
index 039c10202b..18e9343b52 100644
--- a/admin/app/image/layout.tsx
+++ b/admin/app/image/layout.tsx
@@ -1,11 +1,15 @@
import { ReactNode } from "react";
-// layouts
+import { Metadata } from "next";
import { AdminLayout } from "@/layouts/admin-layout";
interface ImageLayoutProps {
children: ReactNode;
}
+export const metadata: Metadata = {
+ title: "Images Settings - God Mode",
+};
+
const ImageLayout = ({ children }: ImageLayoutProps) => <AdminLayout>{children}</AdminLayout>;
export default ImageLayout;
diff --git a/admin/app/layout.tsx b/admin/app/layout.tsx
index e2879a565f..865eb23f9d 100644
--- a/admin/app/layout.tsx
+++ b/admin/app/layout.tsx
@@ -1,40 +1,20 @@
+"use client";
+
import { ReactNode } from "react";
-import { Metadata } from "next";
-// components
-import { InstanceFailureView, InstanceSetupForm } from "@/components/instance";
+import { ThemeProvider } from "next-themes";
+import { SWRConfig } from "swr";
+// constants
+import { SWR_CONFIG } from "@/constants/swr-config";
// helpers
import { ASSET_PREFIX } from "@/helpers/common.helper";
-// layout
-import { DefaultLayout } from "@/layouts/default-layout";
// lib
-import { AppProvider } from "@/lib/app-providers";
+import { InstanceProvider } from "@/lib/instance-provider";
+import { StoreProvider } from "@/lib/store-provider";
+import { UserProvider } from "@/lib/user-provider";
// styles
import "./globals.css";
-// services
-import { InstanceService } from "@/services/instance.service";
-
-const instanceService = new InstanceService();
-
-export const metadata: Metadata = {
- title: "Plane | Simple, extensible, open-source project management tool.",
- description:
- "Open-source project management tool to manage issues, sprints, and product roadmaps with peace of mind.",
- openGraph: {
- title: "Plane | Simple, extensible, open-source project management tool.",
- description:
- "Open-source project management tool to manage issues, sprints, and product roadmaps with peace of mind.",
- url: "https://plane.so/",
- },
- keywords:
- "software development, customer feedback, software, accelerate, code management, release management, project management, issue tracking, agile, scrum, kanban, collaboration",
- twitter: {
- site: "@planepowers",
- },
-};
-
-export default async function RootLayout({ children }: { children: ReactNode }) {
- const instanceDetails = await instanceService.getInstanceInfo().catch(() => null);
+function RootLayout({ children }: { children: ReactNode }) {
return (
<html lang="en">
<head>
@@ -45,28 +25,18 @@ export default async function RootLayout({ children }: { children: ReactNode })
<link rel="shortcut icon" href={`${ASSET_PREFIX}/favicon/favicon.ico`} />
</head>
<body className={`antialiased`}>
- <AppProvider initialState={{ instance: instanceDetails }}>
- {instanceDetails ? (
- <>
- {instanceDetails?.instance?.is_setup_done ? (
- <>{children}</>
- ) : (
- <DefaultLayout>
- <div className="relative w-screen min-h-screen overflow-y-auto px-5 py-10 mx-auto flex justify-center items-center">
- <InstanceSetupForm />
- </div>
- </DefaultLayout>
- )}
- </>
- ) : (
- <DefaultLayout>
- <div className="relative w-screen min-h-[500px] overflow-y-auto px-5 mx-auto flex justify-center items-center">
- <InstanceFailureView />
- </div>
- </DefaultLayout>
- )}
- </AppProvider>
+ <ThemeProvider themes={["light", "dark"]} defaultTheme="system" enableSystem>
+ <SWRConfig value={SWR_CONFIG}>
+ <StoreProvider>
+ <InstanceProvider>
+ <UserProvider>{children}</UserProvider>
+ </InstanceProvider>
+ </StoreProvider>
+ </SWRConfig>
+ </ThemeProvider>
</body>
</html>
);
}
+
+export default RootLayout;
diff --git a/admin/app/page.tsx b/admin/app/page.tsx
index c7e6b975e2..b402fc44d3 100644
--- a/admin/app/page.tsx
+++ b/admin/app/page.tsx
@@ -1,7 +1,26 @@
+import { Metadata } from "next";
+// components
import { InstanceSignInForm } from "@/components/login";
// layouts
import { DefaultLayout } from "@/layouts/default-layout";
+export const metadata: Metadata = {
+ title: "Plane | Simple, extensible, open-source project management tool.",
+ description:
+ "Open-source project management tool to manage issues, sprints, and product roadmaps with peace of mind.",
+ openGraph: {
+ title: "Plane | Simple, extensible, open-source project management tool.",
+ description:
+ "Open-source project management tool to manage issues, sprints, and product roadmaps with peace of mind.",
+ url: "https://plane.so/",
+ },
+ keywords:
+ "software development, customer feedback, software, accelerate, code management, release management, project management, issue tracking, agile, scrum, kanban, collaboration",
+ twitter: {
+ site: "@planepowers",
+ },
+};
+
export default async function LoginPage() {
return (
<DefaultLayout>
diff --git a/admin/components/common/index.ts b/admin/components/common/index.ts
index 005711a623..c810cac69b 100644
--- a/admin/components/common/index.ts
+++ b/admin/components/common/index.ts
@@ -6,3 +6,4 @@ export * from "./password-strength-meter";
export * from "./banner";
export * from "./empty-state";
export * from "./logo-spinner";
+export * from "./toast";
diff --git a/admin/components/common/logo-spinner.tsx b/admin/components/common/logo-spinner.tsx
index 69bb9423d1..621b685b8b 100644
--- a/admin/components/common/logo-spinner.tsx
+++ b/admin/components/common/logo-spinner.tsx
@@ -11,7 +11,7 @@ export const LogoSpinner = () => {
return (
<div className="flex items-center justify-center">
- <Image src={logoSrc} alt="logo" className="w-[82px] h-[82px] mr-2" />
+ <Image src={logoSrc} alt="logo" className="w-[82px] h-[82px] mr-2" priority={false} />
</div>
);
};
diff --git a/admin/components/common/password-strength-meter.tsx b/admin/components/common/password-strength-meter.tsx
index 5cdba30b7a..004a927b2d 100644
--- a/admin/components/common/password-strength-meter.tsx
+++ b/admin/components/common/password-strength-meter.tsx
@@ -43,7 +43,7 @@ export const PasswordStrengthMeter: React.FC<Props> = (props: Props) => {
];
return (
- <div className="w-full p-1">
+ <div className="w-full">
<div className="flex w-full gap-1.5">
{bars.map((color, index) => (
<div key={index} className={cn("w-full h-1 rounded-full", color)} />
diff --git a/admin/components/common/toast.tsx b/admin/components/common/toast.tsx
new file mode 100644
index 0000000000..fe4983db6e
--- /dev/null
+++ b/admin/components/common/toast.tsx
@@ -0,0 +1,11 @@
+import { useTheme } from "next-themes";
+// ui
+import { Toast as ToastComponent } from "@plane/ui";
+// helpers
+import { resolveGeneralTheme } from "@/helpers/common.helper";
+
+export const Toast = () => {
+ const { theme } = useTheme();
+
+ return <ToastComponent theme={resolveGeneralTheme(theme)} />;
+};
diff --git a/admin/components/new-user-popup.tsx b/admin/components/new-user-popup.tsx
index 6b4cea340c..73a405d4a8 100644
--- a/admin/components/new-user-popup.tsx
+++ b/admin/components/new-user-popup.tsx
@@ -17,11 +17,11 @@ import TakeoffIconDark from "/public/logos/takeoff-icon-dark.svg";
export const NewUserPopup: React.FC = observer(() => {
// hooks
const { isNewUserPopup, toggleNewUserPopup } = useTheme();
- const { instance } = useInstance();
+ const { config } = useInstance();
// theme
const { resolvedTheme } = nextUseTheme();
- const redirectionLink = `${instance?.config?.app_base_url ? `${instance?.config?.app_base_url}/create-workspace` : `/god-mode/`}`;
+ const redirectionLink = `${config?.app_base_url ? `${config?.app_base_url}/create-workspace` : `/god-mode/`}`;
if (!isNewUserPopup) return <></>;
return (
diff --git a/admin/hooks/store/use-instance.tsx b/admin/hooks/store/use-instance.tsx
index 15fdaf84f7..cf2edc39fa 100644
--- a/admin/hooks/store/use-instance.tsx
+++ b/admin/hooks/store/use-instance.tsx
@@ -1,6 +1,6 @@
import { useContext } from "react";
// store
-import { StoreContext } from "@/lib/app-providers";
+import { StoreContext } from "@/lib/store-provider";
import { IInstanceStore } from "@/store/instance.store";
export const useInstance = (): IInstanceStore => {
diff --git a/admin/hooks/store/use-theme.tsx b/admin/hooks/store/use-theme.tsx
index 95d2aa05ea..bad89cfeeb 100644
--- a/admin/hooks/store/use-theme.tsx
+++ b/admin/hooks/store/use-theme.tsx
@@ -1,6 +1,6 @@
import { useContext } from "react";
// store
-import { StoreContext } from "@/lib/app-providers";
+import { StoreContext } from "@/lib/store-provider";
import { IThemeStore } from "@/store/theme.store";
export const useTheme = (): IThemeStore => {
diff --git a/admin/hooks/store/use-user.tsx b/admin/hooks/store/use-user.tsx
index c8cb45250d..8230031447 100644
--- a/admin/hooks/store/use-user.tsx
+++ b/admin/hooks/store/use-user.tsx
@@ -1,6 +1,6 @@
import { useContext } from "react";
// store
-import { StoreContext } from "@/lib/app-providers";
+import { StoreContext } from "@/lib/store-provider";
import { IUserStore } from "@/store/user.store";
export const useUser = (): IUserStore => {
diff --git a/admin/layouts/admin-layout.tsx b/admin/layouts/admin-layout.tsx
index f7f8289543..6da5653451 100644
--- a/admin/layouts/admin-layout.tsx
+++ b/admin/layouts/admin-layout.tsx
@@ -2,14 +2,13 @@
import { FC, ReactNode, useEffect } from "react";
import { observer } from "mobx-react-lite";
import { useRouter } from "next/navigation";
-import useSWR from "swr";
// components
import { InstanceSidebar } from "@/components/admin-sidebar";
import { InstanceHeader } from "@/components/auth-header";
import { LogoSpinner } from "@/components/common";
import { NewUserPopup } from "@/components/new-user-popup";
// hooks
-import { useInstance, useUser } from "@/hooks/store";
+import { useUser } from "@/hooks/store";
type TAdminLayout = {
children: ReactNode;
@@ -19,15 +18,7 @@ export const AdminLayout: FC<TAdminLayout> = observer((props) => {
const { children } = props;
// router
const router = useRouter();
- // hooks
- const { fetchInstanceAdmins } = useInstance();
- const { fetchCurrentUser, isUserLoggedIn } = useUser();
-
- useSWR("INSTANCE_ADMINS", () => fetchInstanceAdmins());
-
- useSWR("CURRENT_USER", () => fetchCurrentUser(), {
- shouldRetryOnError: false,
- });
+ const { isUserLoggedIn } = useUser();
useEffect(() => {
if (isUserLoggedIn === false) {
@@ -48,8 +39,8 @@ export const AdminLayout: FC<TAdminLayout> = observer((props) => {
<InstanceSidebar />
<main className="relative flex h-full w-full flex-col overflow-hidden bg-custom-background-100">
<InstanceHeader />
- <div className="h-full w-full overflow-hidden">{children}</div>
</main>
+ <div className="h-full w-full overflow-hidden">{children}</div>
<NewUserPopup />
</div>
);
diff --git a/admin/lib/app-wrapper.tsx b/admin/lib/app-wrapper.tsx
deleted file mode 100644
index daf030a5c9..0000000000
--- a/admin/lib/app-wrapper.tsx
+++ /dev/null
@@ -1,36 +0,0 @@
-"use client";
-
-import { FC, ReactNode, useEffect, Suspense } from "react";
-import { observer } from "mobx-react-lite";
-import { SWRConfig } from "swr";
-// ui
-import { Toast } from "@plane/ui";
-// constants
-import { SWR_CONFIG } from "@/constants/swr-config";
-// helpers
-import { resolveGeneralTheme } from "@/helpers/common.helper";
-// hooks
-import { useTheme, useUser } from "@/hooks/store";
-
-interface IAppWrapper {
- children: ReactNode;
-}
-
-export const AppWrapper: FC<IAppWrapper> = observer(({ children }) => {
- // hooks
- const { theme, isSidebarCollapsed, toggleSidebar } = useTheme();
- const { currentUser } = useUser();
-
- useEffect(() => {
- const localValue = localStorage && localStorage.getItem("god_mode_sidebar_collapsed");
- const localBoolValue = localValue ? (localValue === "true" ? true : false) : false;
- if (isSidebarCollapsed === undefined && localBoolValue != isSidebarCollapsed) toggleSidebar(localBoolValue);
- }, [isSidebarCollapsed, currentUser, toggleSidebar]);
-
- return (
- <Suspense>
- <Toast theme={resolveGeneralTheme(theme)} />
- <SWRConfig value={SWR_CONFIG}>{children}</SWRConfig>
- </Suspense>
- );
-});
diff --git a/admin/lib/instance-provider.tsx b/admin/lib/instance-provider.tsx
new file mode 100644
index 0000000000..194fea4dcf
--- /dev/null
+++ b/admin/lib/instance-provider.tsx
@@ -0,0 +1,55 @@
+import { FC, ReactNode } from "react";
+import { observer } from "mobx-react-lite";
+import useSWR from "swr";
+// components
+import { LogoSpinner } from "@/components/common";
+import { InstanceSetupForm, InstanceFailureView } from "@/components/instance";
+// hooks
+import { useInstance } from "@/hooks/store";
+// layout
+import { DefaultLayout } from "@/layouts/default-layout";
+
+type InstanceProviderProps = {
+ children: ReactNode;
+};
+
+export const InstanceProvider: FC<InstanceProviderProps> = observer((props) => {
+ const { children } = props;
+ // store hooks
+ const { instance, error, fetchInstanceInfo } = useInstance();
+ // fetching instance details
+ useSWR("INSTANCE_DETAILS", () => fetchInstanceInfo(), {
+ revalidateOnFocus: false,
+ revalidateIfStale: false,
+ errorRetryCount: 0,
+ });
+
+ if (!instance && !error)
+ return (
+ <div className="flex h-screen min-h-[500px] w-full justify-center items-center">
+ <LogoSpinner />
+ </div>
+ );
+
+ if (error) {
+ return (
+ <DefaultLayout>
+ <div className="relative w-screen min-h-[500px] overflow-y-auto px-5 mx-auto flex justify-center items-center">
+ <InstanceFailureView />
+ </div>
+ </DefaultLayout>
+ );
+ }
+
+ if (!instance?.is_setup_done) {
+ return (
+ <DefaultLayout>
+ <div className="relative w-screen min-h-screen overflow-y-auto px-5 py-10 mx-auto flex justify-center items-center">
+ <InstanceSetupForm />
+ </div>
+ </DefaultLayout>
+ );
+ }
+
+ return <>{children}</>;
+});
diff --git a/admin/lib/app-providers.tsx b/admin/lib/store-provider.tsx
similarity index 63%
rename from admin/lib/app-providers.tsx
rename to admin/lib/store-provider.tsx
index c52b4455e4..8425138600 100644
--- a/admin/lib/app-providers.tsx
+++ b/admin/lib/store-provider.tsx
@@ -1,11 +1,8 @@
"use client";
import { ReactNode, createContext } from "react";
-import { ThemeProvider } from "next-themes";
// store
import { RootStore } from "@/store/root.store";
-// store initialization
-import { AppWrapper } from "./app-wrapper";
let rootStore = new RootStore();
@@ -25,19 +22,13 @@ function initializeStore(initialData = {}) {
return singletonRootStore;
}
-export type AppProviderProps = {
+export type StoreProviderProps = {
children: ReactNode;
- initialState: any;
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ initialState?: any;
};
-export const AppProvider = ({ children, initialState = {} }: AppProviderProps) => {
+export const StoreProvider = ({ children, initialState = {} }: StoreProviderProps) => {
const store = initializeStore(initialState);
-
- return (
- <ThemeProvider themes={["light", "dark"]} defaultTheme="system" enableSystem>
- <StoreContext.Provider value={store}>
- <AppWrapper>{children}</AppWrapper>
- </StoreContext.Provider>
- </ThemeProvider>
- );
+ return <StoreContext.Provider value={store}>{children}</StoreContext.Provider>;
};
diff --git a/admin/lib/user-provider.tsx b/admin/lib/user-provider.tsx
new file mode 100644
index 0000000000..d8448d13ee
--- /dev/null
+++ b/admin/lib/user-provider.tsx
@@ -0,0 +1,31 @@
+"use client";
+
+import { FC, ReactNode, useEffect } from "react";
+import { observer } from "mobx-react-lite";
+import useSWR from "swr";
+// hooks
+import { useInstance, useTheme, useUser } from "@/hooks/store";
+
+interface IUserProvider {
+ children: ReactNode;
+}
+
+export const UserProvider: FC<IUserProvider> = observer(({ children }) => {
+ // hooks
+ const { isSidebarCollapsed, toggleSidebar } = useTheme();
+ const { currentUser, fetchCurrentUser } = useUser();
+ const { fetchInstanceAdmins } = useInstance();
+
+ useSWR("CURRENT_USER", () => fetchCurrentUser(), {
+ shouldRetryOnError: false,
+ });
+ useSWR("INSTANCE_ADMINS", () => fetchInstanceAdmins());
+
+ useEffect(() => {
+ const localValue = localStorage && localStorage.getItem("god_mode_sidebar_collapsed");
+ const localBoolValue = localValue ? (localValue === "true" ? true : false) : false;
+ if (isSidebarCollapsed === undefined && localBoolValue != isSidebarCollapsed) toggleSidebar(localBoolValue);
+ }, [isSidebarCollapsed, currentUser, toggleSidebar]);
+
+ return <>{children}</>;
+});
diff --git a/admin/services/instance.service.ts b/admin/services/instance.service.ts
index 13431a834f..feb94ceea4 100644
--- a/admin/services/instance.service.ts
+++ b/admin/services/instance.service.ts
@@ -1,5 +1,11 @@
// types
-import type { IFormattedInstanceConfiguration, IInstance, IInstanceAdmin, IInstanceConfiguration } from "@plane/types";
+import type {
+ IFormattedInstanceConfiguration,
+ IInstance,
+ IInstanceAdmin,
+ IInstanceConfiguration,
+ IInstanceInfo,
+} from "@plane/types";
// helpers
import { API_BASE_URL } from "@/helpers/common.helper";
import { APIService } from "@/services/api.service";
@@ -9,8 +15,8 @@ export class InstanceService extends APIService {
super(API_BASE_URL);
}
- async getInstanceInfo(): Promise<IInstance> {
- return this.get<IInstance>("/api/instances/")
+ async getInstanceInfo(): Promise<IInstanceInfo> {
+ return this.get<IInstanceInfo>("/api/instances/")
.then((response) => response.data)
.catch((error) => {
throw error?.response?.data;
@@ -25,8 +31,8 @@ export class InstanceService extends APIService {
});
}
- async updateInstanceInfo(data: Partial<IInstance["instance"]>): Promise<IInstance["instance"]> {
- return this.patch<Partial<IInstance["instance"]>, IInstance["instance"]>("/api/instances/", data)
+ async updateInstanceInfo(data: Partial<IInstance>): Promise<IInstance> {
+ return this.patch<Partial<IInstance>, IInstance>("/api/instances/", data)
.then((response) => response?.data)
.catch((error) => {
throw error?.response?.data;
diff --git a/admin/store/instance.store.ts b/admin/store/instance.store.ts
index e168b15b62..a99cd808c5 100644
--- a/admin/store/instance.store.ts
+++ b/admin/store/instance.store.ts
@@ -1,6 +1,13 @@
import set from "lodash/set";
import { observable, action, computed, makeObservable, runInAction } from "mobx";
-import { IInstance, IInstanceAdmin, IInstanceConfiguration, IFormattedInstanceConfiguration } from "@plane/types";
+import {
+ IInstance,
+ IInstanceAdmin,
+ IInstanceConfiguration,
+ IFormattedInstanceConfiguration,
+ IInstanceInfo,
+ IInstanceConfig,
+} from "@plane/types";
// helpers
import { EInstanceStatus, TInstanceStatus } from "@/helpers";
// services
@@ -11,16 +18,18 @@ import { RootStore } from "@/store/root.store";
export interface IInstanceStore {
// issues
isLoading: boolean;
+ error: any;
instanceStatus: TInstanceStatus | undefined;
instance: IInstance | undefined;
+ config: IInstanceConfig | undefined;
instanceAdmins: IInstanceAdmin[] | undefined;
instanceConfigurations: IInstanceConfiguration[] | undefined;
// computed
formattedConfig: IFormattedInstanceConfiguration | undefined;
// action
- hydrate: (data: any) => void;
- fetchInstanceInfo: () => Promise<IInstance | undefined>;
- updateInstanceInfo: (data: Partial<IInstance["instance"]>) => Promise<IInstance["instance"] | undefined>;
+ hydrate: (data: IInstanceInfo) => void;
+ fetchInstanceInfo: () => Promise<IInstanceInfo | undefined>;
+ updateInstanceInfo: (data: Partial<IInstance>) => Promise<IInstance | undefined>;
fetchInstanceAdmins: () => Promise<IInstanceAdmin[] | undefined>;
fetchInstanceConfigurations: () => Promise<IInstanceConfiguration[] | undefined>;
updateInstanceConfigurations: (data: Partial<IFormattedInstanceConfiguration>) => Promise<IInstanceConfiguration[]>;
@@ -28,8 +37,10 @@ export interface IInstanceStore {
export class InstanceStore implements IInstanceStore {
isLoading: boolean = true;
+ error: any = undefined;
instanceStatus: TInstanceStatus | undefined = undefined;
instance: IInstance | undefined = undefined;
+ config: IInstanceConfig | undefined = undefined;
instanceAdmins: IInstanceAdmin[] | undefined = undefined;
instanceConfigurations: IInstanceConfiguration[] | undefined = undefined;
// service
@@ -39,6 +50,7 @@ export class InstanceStore implements IInstanceStore {
makeObservable(this, {
// observable
isLoading: observable.ref,
+ error: observable.ref,
instanceStatus: observable,
instance: observable,
instanceAdmins: observable,
@@ -57,8 +69,11 @@ export class InstanceStore implements IInstanceStore {
this.instanceService = new InstanceService();
}
- hydrate = (data: any) => {
- if (data) this.instance = data;
+ hydrate = (data: IInstanceInfo) => {
+ if (data) {
+ this.instance = data.instance;
+ this.config = data.config;
+ }
};
/**
@@ -80,17 +95,22 @@ export class InstanceStore implements IInstanceStore {
fetchInstanceInfo = async () => {
try {
if (this.instance === undefined) this.isLoading = true;
- const instance = await this.instanceService.getInstanceInfo();
+ this.error = undefined;
+ const instanceInfo = await this.instanceService.getInstanceInfo();
// handling the new user popup toggle
- if (this.instance === undefined && !instance?.instance?.workspaces_exist) this.store.theme.toggleNewUserPopup();
+ if (this.instance === undefined && !instanceInfo?.instance?.workspaces_exist)
+ this.store.theme.toggleNewUserPopup();
runInAction(() => {
+ console.log("instanceInfo: ", instanceInfo);
this.isLoading = false;
- this.instance = instance;
+ this.instance = instanceInfo.instance;
+ this.config = instanceInfo.config;
});
- return instance;
+ return instanceInfo;
} catch (error) {
console.error("Error fetching the instance info");
this.isLoading = false;
+ this.error = { message: "Failed to fetch the instance info" };
this.instanceStatus = {
status: EInstanceStatus.ERROR,
};
@@ -100,10 +120,10 @@ export class InstanceStore implements IInstanceStore {
/**
* @description updating instance information
- * @param {Partial<IInstance["instance"]>} data
+ * @param {Partial<IInstance>} data
* @returns void
*/
- updateInstanceInfo = async (data: Partial<IInstance["instance"]>) => {
+ updateInstanceInfo = async (data: Partial<IInstance>) => {
try {
const instanceResponse = await this.instanceService.updateInstanceInfo(data);
if (instanceResponse) {
diff --git a/packages/types/src/instance/base.d.ts b/packages/types/src/instance/base.d.ts
index efc47b15d7..d51978c067 100644
--- a/packages/types/src/instance/base.d.ts
+++ b/packages/types/src/instance/base.d.ts
@@ -6,47 +6,51 @@ import {
TInstanceAuthenticationKeys,
} from "./";
+export interface IInstanceInfo {
+ instance: IInstance;
+ config: IInstanceConfig;
+}
+
export interface IInstance {
- instance: {
- id: string;
- created_at: string;
- updated_at: string;
- instance_name: string | undefined;
- whitelist_emails: string | undefined;
- instance_id: string | undefined;
- license_key: string | undefined;
- api_key: string | undefined;
- version: string | undefined;
- last_checked_at: string | undefined;
- namespace: string | undefined;
- is_telemetry_enabled: boolean;
- is_support_required: boolean;
- is_activated: boolean;
- is_setup_done: boolean;
- is_signup_screen_visited: boolean;
- user_count: number | undefined;
- is_verified: boolean;
- created_by: string | undefined;
- updated_by: string | undefined;
- workspaces_exist: boolean;
- };
- config: {
- is_google_enabled: boolean;
- is_github_enabled: boolean;
- is_magic_login_enabled: boolean;
- is_email_password_enabled: boolean;
- github_app_name: string | undefined;
- slack_client_id: string | undefined;
- posthog_api_key: string | undefined;
- posthog_host: string | undefined;
- has_unsplash_configured: boolean;
- has_openai_configured: boolean;
- file_size_limit: number | undefined;
- is_smtp_configured: boolean;
- app_base_url: string | undefined;
- space_base_url: string | undefined;
- admin_base_url: string | undefined;
- };
+ id: string;
+ created_at: string;
+ updated_at: string;
+ instance_name: string | undefined;
+ whitelist_emails: string | undefined;
+ instance_id: string | undefined;
+ license_key: string | undefined;
+ api_key: string | undefined;
+ version: string | undefined;
+ last_checked_at: string | undefined;
+ namespace: string | undefined;
+ is_telemetry_enabled: boolean;
+ is_support_required: boolean;
+ is_activated: boolean;
+ is_setup_done: boolean;
+ is_signup_screen_visited: boolean;
+ user_count: number | undefined;
+ is_verified: boolean;
+ created_by: string | undefined;
+ updated_by: string | undefined;
+ workspaces_exist: boolean;
+}
+
+export interface IInstanceConfig {
+ is_google_enabled: boolean;
+ is_github_enabled: boolean;
+ is_magic_login_enabled: boolean;
+ is_email_password_enabled: boolean;
+ github_app_name: string | undefined;
+ slack_client_id: string | undefined;
+ posthog_api_key: string | undefined;
+ posthog_host: string | undefined;
+ has_unsplash_configured: boolean;
+ has_openai_configured: boolean;
+ file_size_limit: number | undefined;
+ is_smtp_configured: boolean;
+ app_base_url: string | undefined;
+ space_base_url: string | undefined;
+ admin_base_url: string | undefined;
}
export interface IInstanceAdmin {