[WEB-3065] refactor: replace admin services with service packages (#6342)

* [WEB-3065] refactor: replace admin services with service packages

* chore: minor updates

* chore: error handling

admin/app/email/test-email-modal.tsx

@@ -1,9 +1,9 @@
 import React, { FC, useEffect, useState } from "react";
 import { Dialog, Transition } from "@headlessui/react";
+// plane imports
+import { InstanceService } from "@plane/services";
 // ui
 import { Button, Input } from "@plane/ui";
-// services
-import { InstanceService } from "@/services/instance.service";
 
 type Props = {
   isOpen: boolean;

admin/app/workspace/create/form.tsx

@@ -2,18 +2,16 @@ import { useState, useEffect } from "react";
 import Link from "next/link";
 import { useRouter } from "next/navigation";
 import { Controller, useForm } from "react-hook-form";
-// constants
+// plane imports
 import { WEB_BASE_URL, ORGANIZATION_SIZE, RESTRICTED_URLS } from "@plane/constants";
-// types
+import { InstanceWorkspaceService } from "@plane/services";
 import { IWorkspace } from "@plane/types";
 // components
 import { Button, CustomSelect, getButtonStyling, Input, setToast, TOAST_TYPE } from "@plane/ui";
 // hooks
 import { useWorkspace } from "@/hooks/store";
-// services
-import { WorkspaceService } from "@/services/workspace.service";
 
-const workspaceService = new WorkspaceService();
+const instanceWorkspaceService = new InstanceWorkspaceService();
 
 export const WorkspaceCreateForm = () => {
   // router
@@ -40,8 +38,8 @@ export const WorkspaceCreateForm = () => {
   const workspaceBaseURL = encodeURI(WEB_BASE_URL || window.location.origin + "/");
 
   const handleCreateWorkspace = async (formData: IWorkspace) => {
-    await workspaceService
-      .workspaceSlugCheck(formData.slug)
+    await instanceWorkspaceService
+      .slugCheck(formData.slug)
       .then(async (res) => {
         if (res.status === true && !RESTRICTED_URLS.includes(formData.slug)) {
           setSlugError(false);

admin/core/components/admin-sidebar/sidebar-dropdown.tsx

@@ -7,12 +7,11 @@ import { LogOut, UserCog2, Palette } from "lucide-react";
 import { Menu, Transition } from "@headlessui/react";
 // plane internal packages
 import { API_BASE_URL } from "@plane/constants";
+import  {AuthService } from "@plane/services";
 import { Avatar } from "@plane/ui";
 import { getFileURL, cn } from "@plane/utils";
 // hooks
 import { useTheme, useUser } from "@/hooks/store";
-// services
-import { AuthService } from "@/services/auth.service";
 
 // service initialization
 const authService = new AuthService();

admin/core/components/instance/setup-form.tsx

@@ -6,12 +6,11 @@ import { useSearchParams } from "next/navigation";
 import { Eye, EyeOff } from "lucide-react";
 // plane internal packages
 import { API_BASE_URL, E_PASSWORD_STRENGTH } from "@plane/constants";
+import { AuthService } from "@plane/services";
 import { Button, Checkbox, Input, Spinner } from "@plane/ui";
 import { getPasswordStrength } from "@plane/utils";
 // components
 import { Banner, PasswordStrengthMeter } from "@/components/common";
-// services
-import { AuthService } from "@/services/auth.service";
 
 // service initialization
 const authService = new AuthService();

admin/core/components/login/sign-in-form.tsx

@@ -5,13 +5,12 @@ import { useSearchParams } from "next/navigation";
 import { Eye, EyeOff } from "lucide-react";
 // plane internal packages
 import { API_BASE_URL, EAdminAuthErrorCodes, TAuthErrorInfo } from "@plane/constants";
+import { AuthService } from "@plane/services";
 import { Button, Input, Spinner } from "@plane/ui";
 // components
 import { Banner } from "@/components/common";
 // helpers
 import { authErrorHandler } from "@/lib/auth-helpers";
-// services
-import { AuthService } from "@/services/auth.service";
 // local components
 import { AuthBanner } from "../authentication";
 

admin/core/services/api.service.ts

@@ -1,53 +0,0 @@
-import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
-// store
-// import { rootStore } from "@/lib/store-context";
-
-export abstract class APIService {
-  protected baseURL: string;
-  private axiosInstance: AxiosInstance;
-
-  constructor(baseURL: string) {
-    this.baseURL = baseURL;
-    this.axiosInstance = axios.create({
-      baseURL,
-      withCredentials: true,
-    });
-
-    this.setupInterceptors();
-  }
-
-  private setupInterceptors() {
-    // this.axiosInstance.interceptors.response.use(
-    //   (response) => response,
-    //   (error) => {
-    //     const store = rootStore;
-    //     if (error.response && error.response.status === 401 && store.user.currentUser) store.user.reset();
-    //     return Promise.reject(error);
-    //   }
-    // );
-  }
-
-  get<ResponseType>(url: string, params = {}): Promise<AxiosResponse<ResponseType>> {
-    return this.axiosInstance.get(url, { params });
-  }
-
-  post<RequestType, ResponseType>(url: string, data: RequestType, config = {}): Promise<AxiosResponse<ResponseType>> {
-    return this.axiosInstance.post(url, data, config);
-  }
-
-  put<RequestType, ResponseType>(url: string, data: RequestType, config = {}): Promise<AxiosResponse<ResponseType>> {
-    return this.axiosInstance.put(url, data, config);
-  }
-
-  patch<RequestType, ResponseType>(url: string, data: RequestType, config = {}): Promise<AxiosResponse<ResponseType>> {
-    return this.axiosInstance.patch(url, data, config);
-  }
-
-  delete<RequestType>(url: string, data?: RequestType, config = {}) {
-    return this.axiosInstance.delete(url, { data, ...config });
-  }
-
-  request<T>(config: AxiosRequestConfig = {}): Promise<AxiosResponse<T>> {
-    return this.axiosInstance(config);
-  }
-}

admin/core/services/auth.service.ts

@@ -1,21 +0,0 @@
-import { API_BASE_URL } from "@plane/constants";
-// services
-import { APIService } from "@/services/api.service";
-
-type TCsrfTokenResponse = {
-  csrf_token: string;
-};
-
-export class AuthService extends APIService {
-  constructor() {
-    super(API_BASE_URL);
-  }
-
-  async requestCSRFToken(): Promise<TCsrfTokenResponse> {
-    return this.get<TCsrfTokenResponse>("/auth/get-csrf-token/")
-      .then((response) => response.data)
-      .catch((error) => {
-        throw error;
-      });
-  }
-}

admin/core/services/instance.service.ts

@@ -1,72 +0,0 @@
-// plane internal packages
-import { API_BASE_URL } from "@plane/constants";
-import type {
-  IFormattedInstanceConfiguration,
-  IInstance,
-  IInstanceAdmin,
-  IInstanceConfiguration,
-  IInstanceInfo,
-} from "@plane/types";
-// helpers
-import { APIService } from "@/services/api.service";
-
-export class InstanceService extends APIService {
-  constructor() {
-    super(API_BASE_URL);
-  }
-
-  async getInstanceInfo(): Promise<IInstanceInfo> {
-    return this.get<IInstanceInfo>("/api/instances/")
-      .then((response) => response.data)
-      .catch((error) => {
-        throw error?.response?.data;
-      });
-  }
-
-  async getInstanceAdmins(): Promise<IInstanceAdmin[]> {
-    return this.get<IInstanceAdmin[]>("/api/instances/admins/")
-      .then((response) => response.data)
-      .catch((error) => {
-        throw error;
-      });
-  }
-
-  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;
-      });
-  }
-
-  async getInstanceConfigurations() {
-    return this.get<IInstanceConfiguration[]>("/api/instances/configurations/")
-      .then((response) => response.data)
-      .catch((error) => {
-        throw error;
-      });
-  }
-
-  async updateInstanceConfigurations(
-    data: Partial<IFormattedInstanceConfiguration>
-  ): Promise<IInstanceConfiguration[]> {
-    return this.patch<Partial<IFormattedInstanceConfiguration>, IInstanceConfiguration[]>(
-      "/api/instances/configurations/",
-      data
-    )
-      .then((response) => response?.data)
-      .catch((error) => {
-        throw error?.response?.data;
-      });
-  }
-
-  async sendTestEmail(receiverEmail: string): Promise<undefined> {
-    return this.post<{ receiver_email: string }, undefined>("/api/instances/email-credentials-check/", {
-      receiver_email: receiverEmail,
-    })
-      .then((response) => response?.data)
-      .catch((error) => {
-        throw error?.response?.data;
-      });
-  }
-}

admin/core/services/user.service.ts

@@ -1,29 +0,0 @@
-// plane internal packages
-import { API_BASE_URL } from "@plane/constants";
-import type { IUser } from "@plane/types";
-// services
-import { APIService } from "@/services/api.service";
-
-interface IUserSession extends IUser {
-  isAuthenticated: boolean;
-}
-
-export class UserService extends APIService {
-  constructor() {
-    super(API_BASE_URL);
-  }
-
-  async authCheck(): Promise<IUserSession> {
-    return this.get<any>("/api/instances/admins/me/")
-      .then((response) => ({ ...response?.data, isAuthenticated: true }))
-      .catch(() => ({ isAuthenticated: false }));
-  }
-
-  async currentUser(): Promise<IUser> {
-    return this.get<IUser>("/api/instances/admins/me/")
-      .then((response) => response?.data)
-      .catch((error) => {
-        throw error?.response;
-      });
-  }
-}

admin/core/services/workspace.service.ts

@@ -1,52 +0,0 @@
-// plane internal packages
-import { API_BASE_URL } from "@plane/constants";
-import type { IWorkspace, TWorkspacePaginationInfo } from "@plane/types";
-// services
-import { APIService } from "@/services/api.service";
-
-export class WorkspaceService extends APIService {
-  constructor() {
-    super(API_BASE_URL);
-  }
-
-  /**
-   * @description Fetches all workspaces
-   * @returns Promise<TWorkspacePaginationInfo>
-   */
-  async getWorkspaces(nextPageCursor?: string): Promise<TWorkspacePaginationInfo> {
-    return this.get<TWorkspacePaginationInfo>("/api/instances/workspaces/", {
-      cursor: nextPageCursor,
-    })
-      .then((response) => response.data)
-      .catch((error) => {
-        throw error?.response?.data;
-      });
-  }
-
-  /**
-   * @description Checks if a slug is available
-   * @param slug - string
-   * @returns Promise<any>
-   */
-  async workspaceSlugCheck(slug: string): Promise<any> {
-    const params = new URLSearchParams({ slug });
-    return this.get(`/api/instances/workspace-slug-check/?${params.toString()}`)
-      .then((response) => response?.data)
-      .catch((error) => {
-        throw error?.response?.data;
-      });
-  }
-
-  /**
-   * @description Creates a new workspace
-   * @param data - IWorkspace
-   * @returns Promise<IWorkspace>
-   */
-  async createWorkspace(data: IWorkspace): Promise<IWorkspace> {
-    return this.post<IWorkspace, IWorkspace>("/api/instances/workspaces/", data)
-      .then((response) => response.data)
-      .catch((error) => {
-        throw error?.response?.data;
-      });
-  }
-}

admin/core/store/instance.store.ts

@@ -2,6 +2,7 @@ import set from "lodash/set";
 import { observable, action, computed, makeObservable, runInAction } from "mobx";
 // plane internal packages
 import { EInstanceStatus, TInstanceStatus } from "@plane/constants";
+import {InstanceService} from "@plane/services";
 import {
   IInstance,
   IInstanceAdmin,
@@ -10,8 +11,6 @@ import {
   IInstanceInfo,
   IInstanceConfig,
 } from "@plane/types";
-// services
-import { InstanceService } from "@/services/instance.service";
 // root store
 import { CoreRootStore } from "@/store/root.store";
 
@@ -96,7 +95,7 @@ export class InstanceStore implements IInstanceStore {
     try {
       if (this.instance === undefined) this.isLoading = true;
       this.error = undefined;
-      const instanceInfo = await this.instanceService.getInstanceInfo();
+      const instanceInfo = await this.instanceService.info();
       // handling the new user popup toggle
       if (this.instance === undefined && !instanceInfo?.instance?.workspaces_exist)
         this.store.theme.toggleNewUserPopup();
@@ -125,7 +124,7 @@ export class InstanceStore implements IInstanceStore {
    */
   updateInstanceInfo = async (data: Partial<IInstance>) => {
     try {
-      const instanceResponse = await this.instanceService.updateInstanceInfo(data);
+      const instanceResponse = await this.instanceService.update(data);
       if (instanceResponse) {
         runInAction(() => {
           if (this.instance) set(this.instance, "instance", instanceResponse);
@@ -144,7 +143,7 @@ export class InstanceStore implements IInstanceStore {
    */
   fetchInstanceAdmins = async () => {
     try {
-      const instanceAdmins = await this.instanceService.getInstanceAdmins();
+      const instanceAdmins = await this.instanceService.admins();
       if (instanceAdmins) runInAction(() => (this.instanceAdmins = instanceAdmins));
       return instanceAdmins;
     } catch (error) {
@@ -159,7 +158,7 @@ export class InstanceStore implements IInstanceStore {
    */
   fetchInstanceConfigurations = async () => {
     try {
-      const instanceConfigurations = await this.instanceService.getInstanceConfigurations();
+      const instanceConfigurations = await this.instanceService.configurations();
       if (instanceConfigurations) runInAction(() => (this.instanceConfigurations = instanceConfigurations));
       return instanceConfigurations;
     } catch (error) {
@@ -174,7 +173,7 @@ export class InstanceStore implements IInstanceStore {
    */
   updateInstanceConfigurations = async (data: Partial<IFormattedInstanceConfiguration>) => {
     try {
-      const response = await this.instanceService.updateInstanceConfigurations(data);
+      const response = await this.instanceService.updateConfigurations(data);
       runInAction(() => {
         this.instanceConfigurations = this.instanceConfigurations?.map((config) => {
           const item = response.find((item) => item.key === config.key);

admin/core/store/user.store.ts

@@ -1,10 +1,8 @@
 import { action, observable, runInAction, makeObservable } from "mobx";
 // plane internal packages
 import { EUserStatus, TUserStatus } from "@plane/constants";
+import { AuthService, UserService } from "@plane/services";
 import { IUser } from "@plane/types";
-// services
-import { AuthService } from "@/services/auth.service";
-import { UserService } from "@/services/user.service";
 // root store
 import { CoreRootStore } from "@/store/root.store";
 
@@ -58,7 +56,7 @@ export class UserStore implements IUserStore {
   fetchCurrentUser = async () => {
     try {
       if (this.currentUser === undefined) this.isLoading = true;
-      const currentUser = await this.userService.currentUser();
+      const currentUser = await this.userService.adminDetails();
       if (currentUser) {
         await this.store.instance.fetchInstanceAdmins();
         runInAction(() => {

admin/core/store/workspace.store.ts

@@ -1,8 +1,8 @@
 import set from "lodash/set";
 import { action, observable, runInAction, makeObservable, computed } from "mobx";
+// plane imports
+import { InstanceWorkspaceService } from "@plane/services";
 import { IWorkspace, TLoader, TPaginationInfo } from "@plane/types";
-// services
-import { WorkspaceService } from "@/services/workspace.service";
 // root store
 import { CoreRootStore } from "@/store/root.store";
 
@@ -29,7 +29,7 @@ export class WorkspaceStore implements IWorkspaceStore {
   workspaces: Record<string, IWorkspace> = {};
   paginationInfo: TPaginationInfo | undefined = undefined;
   // services
-  workspaceService;
+  instanceWorkspaceService;
 
   constructor(private store: CoreRootStore) {
     makeObservable(this, {
@@ -48,7 +48,7 @@ export class WorkspaceStore implements IWorkspaceStore {
       // curd actions
       createWorkspace: action,
     });
-    this.workspaceService = new WorkspaceService();
+    this.instanceWorkspaceService = new InstanceWorkspaceService();
   }
 
   // computed
@@ -84,7 +84,7 @@ export class WorkspaceStore implements IWorkspaceStore {
       } else {
         this.loader = "init-loader";
       }
-      const paginatedWorkspaceData = await this.workspaceService.getWorkspaces();
+      const paginatedWorkspaceData = await this.instanceWorkspaceService.list();
       runInAction(() => {
         const { results, ...paginationInfo } = paginatedWorkspaceData;
         results.forEach((workspace: IWorkspace) => {
@@ -109,7 +109,7 @@ export class WorkspaceStore implements IWorkspaceStore {
     if (!this.paginationInfo || this.paginationInfo.next_page_results === false) return [];
     try {
       this.loader = "pagination";
-      const paginatedWorkspaceData = await this.workspaceService.getWorkspaces(this.paginationInfo.next_cursor);
+      const paginatedWorkspaceData = await this.instanceWorkspaceService.list(this.paginationInfo.next_cursor);
       runInAction(() => {
         const { results, ...paginationInfo } = paginatedWorkspaceData;
         results.forEach((workspace: IWorkspace) => {
@@ -135,7 +135,7 @@ export class WorkspaceStore implements IWorkspaceStore {
   createWorkspace = async (data: IWorkspace): Promise<IWorkspace> => {
     try {
       this.loader = "mutation";
-      const workspace = await this.workspaceService.createWorkspace(data);
+      const workspace = await this.instanceWorkspaceService.create(data);
       runInAction(() => {
         set(this.workspaces, [workspace.id], workspace);
       });

admin/package.json

@@ -18,6 +18,7 @@
     "@plane/types": "*",
     "@plane/ui": "*",
     "@plane/utils": "*",
+    "@plane/services": "*",
     "@sentry/nextjs": "^8.32.0",
     "@tailwindcss/typography": "^0.5.9",
     "@types/lodash": "^4.17.0",