plane/web/ee/services/workspace.service.ts

// plane imports
import { EViewAccess } from "@plane/constants";
import { ISearchIssueResponse, TWorkspaceEpicsSearchParams } from "@plane/types";
// helpers
import { API_BASE_URL } from "@/helpers/common.helper";
// types
import { TWorkspaceWithProductDetails } from "@/plane-web/types";
// services
import { WorkspaceService as CoreWorkspaceService } from "@/services/workspace.service";

export class WorkspaceService extends CoreWorkspaceService {
  constructor() {
    super(API_BASE_URL);
  }

  async updateViewAccess(workspaceSlug: string, viewId: string, access: EViewAccess): Promise<any> {
    return this.post(`/api/workspaces/${workspaceSlug}/views/${viewId}/access/`, { access }).catch((error) => {
      throw error?.response?.data;
    });
  }

  async lockView(workspaceSlug: string, viewId: string): Promise<any> {
    return this.post(`/api/workspaces/${workspaceSlug}/views/${viewId}/lock/`).catch((error) => {
      throw error?.response?.data;
    });
  }

  async unLockView(workspaceSlug: string, viewId: string): Promise<any> {
    return this.delete(`/api/workspaces/${workspaceSlug}/views/${viewId}/lock/`).catch((error) => {
      throw error?.response?.data;
    });
  }

  async getWorkspacesWithPlanDetails(): Promise<TWorkspaceWithProductDetails[]> {
    return this.get(`/api/payments/website/workspaces/`)
      .then((response) => response?.data)
      .catch((error) => {
        throw error?.response;
      });
  }

  async searchAcrossWorkspace(
    workspaceSlug: string,
    params: { search: string; workspace_search?: boolean; projectId?: string }
  ) {
    return this.get(`/api/workspaces/${workspaceSlug}/search/`, { params }).then((response) => response?.data);
  }

  /**
   * Enhanced search across workspace. This endpoint is similar to searchAcrossWorkspace
   * but it returns more detailed results for each item. It is used in the search bar.
   *
   * @param {string} workspaceSlug - The workspace slug.
   * @param {Object} params - The search params.
   * @param {string} params.search - The search string.
   * @param {boolean} [params.workspace_search=false] - If true, search in the whole workspace.
   * @param {string} [params.projectId] - The project id to search in.
   * @returns {Promise<Object[]>} - The search results.
   */
  async enhancedSearchAcrossWorkspace(
    workspaceSlug: string,
    params: { search: string; workspace_search?: boolean; projectId?: string }
  ) {
    return this.get(`/api/workspaces/${workspaceSlug}/enhanced-search/`, { params }).then((response) => response?.data);
  }

  async fetchWorkspaceEpics(
    workspaceSlug: string,
    params: TWorkspaceEpicsSearchParams
  ): Promise<ISearchIssueResponse[]> {
    return this.get(`/api/workspaces/${workspaceSlug}/epics/`, { params }).then((response) => response?.data);
  }
}