mirror of
https://github.com/makeplane/plane.git
synced 2025-12-25 16:19:43 +01:00
366 lines
11 KiB
TypeScript
366 lines
11 KiB
TypeScript
// services
|
|
import {
|
|
IWorkspace,
|
|
IWorkspaceMemberMe,
|
|
IWorkspaceMember,
|
|
IWorkspaceMemberInvitation,
|
|
ILastActiveWorkspaceDetails,
|
|
IWorkspaceSearchResults,
|
|
IProductUpdateResponse,
|
|
IWorkspaceBulkInviteFormData,
|
|
IWorkspaceViewProps,
|
|
IUserProjectsRole,
|
|
IWorkspaceView,
|
|
TIssuesResponse,
|
|
TLink,
|
|
TSearchResponse,
|
|
TSearchEntityRequestPayload,
|
|
TWidgetEntityData,
|
|
TActivityEntityData,
|
|
} from "@plane/types";
|
|
import { APIService } from "@/services/api.service";
|
|
// helpers
|
|
// types
|
|
|
|
export class WorkspaceService extends APIService {
|
|
constructor(baseUrl: string) {
|
|
super(baseUrl);
|
|
}
|
|
|
|
async userWorkspaces(): Promise<IWorkspace[]> {
|
|
return this.get("/api/users/me/workspaces/")
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getWorkspace(workspaceSlug: string): Promise<IWorkspace> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response;
|
|
});
|
|
}
|
|
|
|
async createWorkspace(data: Partial<IWorkspace>): Promise<IWorkspace> {
|
|
return this.post("/api/workspaces/", data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async updateWorkspace(workspaceSlug: string, data: Partial<IWorkspace>): Promise<IWorkspace> {
|
|
return this.patch(`/api/workspaces/${workspaceSlug}/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async deleteWorkspace(workspaceSlug: string): Promise<any> {
|
|
return this.delete(`/api/workspaces/${workspaceSlug}/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async inviteWorkspace(workspaceSlug: string, data: IWorkspaceBulkInviteFormData): Promise<any> {
|
|
return this.post(`/api/workspaces/${workspaceSlug}/invitations/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async joinWorkspace(workspaceSlug: string, invitationId: string, data: any): Promise<any> {
|
|
return this.post(`/api/workspaces/${workspaceSlug}/invitations/${invitationId}/join/`, data, {
|
|
headers: {},
|
|
})
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async joinWorkspaces(data: any): Promise<any> {
|
|
return this.post("/api/users/me/workspaces/invitations/", data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getLastActiveWorkspaceAndProjects(): Promise<ILastActiveWorkspaceDetails> {
|
|
return this.get("/api/users/last-visited-workspace/")
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async userWorkspaceInvitations(): Promise<IWorkspaceMemberInvitation[]> {
|
|
return this.get("/api/users/me/workspaces/invitations/")
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async workspaceMemberMe(workspaceSlug: string): Promise<IWorkspaceMemberMe> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/workspace-members/me/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response;
|
|
});
|
|
}
|
|
|
|
async updateWorkspaceView(workspaceSlug: string, data: { view_props: IWorkspaceViewProps }): Promise<any> {
|
|
return this.post(`/api/workspaces/${workspaceSlug}/workspace-views/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async fetchWorkspaceMembers(workspaceSlug: string): Promise<IWorkspaceMember[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/members/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async updateWorkspaceMember(
|
|
workspaceSlug: string,
|
|
memberId: string,
|
|
data: Partial<IWorkspaceMember>
|
|
): Promise<IWorkspaceMember> {
|
|
return this.patch(`/api/workspaces/${workspaceSlug}/members/${memberId}/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async deleteWorkspaceMember(workspaceSlug: string, memberId: string): Promise<any> {
|
|
return this.delete(`/api/workspaces/${workspaceSlug}/members/${memberId}/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async workspaceInvitations(workspaceSlug: string): Promise<IWorkspaceMemberInvitation[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/invitations/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getWorkspaceInvitation(workspaceSlug: string, invitationId: string): Promise<IWorkspaceMemberInvitation> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/invitations/${invitationId}/join/`, { headers: {} })
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async updateWorkspaceInvitation(
|
|
workspaceSlug: string,
|
|
invitationId: string,
|
|
data: Partial<IWorkspaceMember>
|
|
): Promise<any> {
|
|
return this.patch(`/api/workspaces/${workspaceSlug}/invitations/${invitationId}/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async deleteWorkspaceInvitations(workspaceSlug: string, invitationId: string): Promise<any> {
|
|
return this.delete(`/api/workspaces/${workspaceSlug}/invitations/${invitationId}/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async workspaceSlugCheck(slug: string): Promise<any> {
|
|
return this.get(`/api/workspace-slug-check/?slug=${slug}`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async searchWorkspace(
|
|
workspaceSlug: string,
|
|
params: {
|
|
project_id?: string;
|
|
search: string;
|
|
workspace_search: boolean;
|
|
}
|
|
): Promise<IWorkspaceSearchResults> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/search/`, {
|
|
params,
|
|
})
|
|
.then((res) => res?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
async getProductUpdates(): Promise<IProductUpdateResponse[]> {
|
|
return this.get("/api/release-notes/")
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async createView(workspaceSlug: string, data: Partial<IWorkspaceView>): Promise<IWorkspaceView> {
|
|
return this.post(`/api/workspaces/${workspaceSlug}/views/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async updateView(workspaceSlug: string, viewId: string, data: Partial<IWorkspaceView>): Promise<IWorkspaceView> {
|
|
return this.patch(`/api/workspaces/${workspaceSlug}/views/${viewId}/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async deleteView(workspaceSlug: string, viewId: string): Promise<any> {
|
|
return this.delete(`/api/workspaces/${workspaceSlug}/views/${viewId}/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getAllViews(workspaceSlug: string): Promise<IWorkspaceView[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/views/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getViewDetails(workspaceSlug: string, viewId: string): Promise<IWorkspaceView> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/views/${viewId}/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getViewIssues(workspaceSlug: string, params: any, config = {}): Promise<TIssuesResponse> {
|
|
return this.get(
|
|
`/api/workspaces/${workspaceSlug}/issues/`,
|
|
{
|
|
params,
|
|
},
|
|
config
|
|
)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getWorkspaceUserProjectsRole(workspaceSlug: string): Promise<IUserProjectsRole> {
|
|
return this.get(`/api/users/me/workspaces/${workspaceSlug}/project-roles/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
// quicklinks
|
|
async fetchWorkspaceLinks(workspaceSlug: string): Promise<TLink[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/quick-links/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response;
|
|
});
|
|
}
|
|
|
|
async createWorkspaceLink(workspaceSlug: string, data: Partial<TLink>): Promise<TLink> {
|
|
return this.post(`/api/workspaces/${workspaceSlug}/quick-links/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response;
|
|
});
|
|
}
|
|
|
|
async updateWorkspaceLink(workspaceSlug: string, linkId: string, data: Partial<TLink>): Promise<TLink> {
|
|
return this.patch(`/api/workspaces/${workspaceSlug}/quick-links/${linkId}/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response;
|
|
});
|
|
}
|
|
|
|
async deleteWorkspaceLink(workspaceSlug: string, linkId: string): Promise<void> {
|
|
return this.delete(`/api/workspaces/${workspaceSlug}/quick-links/${linkId}/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async searchEntity(workspaceSlug: string, params: TSearchEntityRequestPayload): Promise<TSearchResponse> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/entity-search/`, {
|
|
params: {
|
|
...params,
|
|
query_type: params.query_type.join(","),
|
|
},
|
|
})
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
// recents
|
|
async fetchWorkspaceRecents(workspaceSlug: string, entity_name?: string): Promise<TActivityEntityData[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/recent-visits/`, {
|
|
params: {
|
|
entity_name,
|
|
},
|
|
})
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response;
|
|
});
|
|
}
|
|
|
|
// widgets
|
|
async fetchWorkspaceWidgets(workspaceSlug: string): Promise<TWidgetEntityData[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/home-preferences/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response;
|
|
});
|
|
}
|
|
|
|
async updateWorkspaceWidget(
|
|
workspaceSlug: string,
|
|
widgetKey: string,
|
|
data: Partial<TWidgetEntityData>
|
|
): Promise<TWidgetEntityData> {
|
|
return this.patch(`/api/workspaces/${workspaceSlug}/home-preferences/${widgetKey}/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response;
|
|
});
|
|
}
|
|
}
|