mirror of
https://github.com/makeplane/plane
synced 2024-06-14 14:31:34 +00:00
d0f6ca3bac
* chore: Updated Setup Script for Splitting Env File * chore: updated dockerfile for using inproject env varaibles * chore: removed husky replacement script * chore: updated shell script using sed * chore: updated dockerfiles with removed cp statement * chore: added example env for apiserver * chore: refactored secret generation for backend * chore: removed replacement script * chore: updated docker-compose with removed env variables * chore: resolved comments in setup.sh and docker-compose * chore: removed secret key placeholder in apiserver example env * chore: updated root env for project less env variables * chore: removed project level env update from root env logic * chore: updated API_BASE_URL in .env.example * chore: restored docker argument as env NEXT_PUBLIC_API_BASE_URL * chore: added pg missing env variables * [chore] Updated web and deploy backend configuration for reverse proxy & decoupled Plane Deploy URL generation for web (#2135) * chore: removed api url build arg from compose * chore: set public api default argument to black string for self hosted * chore: updated web services to accept blank string as API URL * chore: added env variables for pg compose service * chore: modified space app services to use accept empty string as api base * chore: conditionally trigger web url value based on argument * fix: made web to use identical host with spaces suffix on absense of Deploy URL for deploy * chore: added example env for PUBLIC_DEPLOY Env * chore: updated web dockerfile with addition as PLANE_DEPLOY Argument * API BASE URL global update * API BASE URL replace with api server * api base url fixes * typo fixes --------- Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com> * dev: remove API_BASE_URL from environment variable --------- Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com> Co-authored-by: pablohashescobar <nikhilschacko@gmail.com>
391 lines
11 KiB
TypeScript
391 lines
11 KiB
TypeScript
import { API_BASE_URL } from "helpers/common.helper";
|
|
// services
|
|
import APIService from "services/api.service";
|
|
import trackEventServices from "services/track-event.service";
|
|
// types
|
|
import type {
|
|
GithubRepositoriesResponse,
|
|
ICurrentUserResponse,
|
|
IProject,
|
|
IProjectBulkInviteFormData,
|
|
IProjectMember,
|
|
IProjectMemberInvitation,
|
|
ISearchIssueResponse,
|
|
ProjectPreferences,
|
|
IProjectViewProps,
|
|
TProjectIssuesSearchParams,
|
|
} from "types";
|
|
|
|
const trackEvent =
|
|
process.env.NEXT_PUBLIC_TRACK_EVENTS === "true" || process.env.NEXT_PUBLIC_TRACK_EVENTS === "1";
|
|
|
|
export class ProjectServices extends APIService {
|
|
constructor() {
|
|
super(API_BASE_URL);
|
|
}
|
|
|
|
async createProject(
|
|
workspaceSlug: string,
|
|
data: Partial<IProject>,
|
|
user: ICurrentUserResponse | undefined
|
|
): Promise<IProject> {
|
|
return this.post(`/api/workspaces/${workspaceSlug}/projects/`, data)
|
|
.then((response) => {
|
|
if (trackEvent) trackEventServices.trackProjectEvent(response.data, "CREATE_PROJECT", user);
|
|
return response?.data;
|
|
})
|
|
.catch((error) => {
|
|
throw error?.response;
|
|
});
|
|
}
|
|
|
|
async checkProjectIdentifierAvailability(workspaceSlug: string, data: string): Promise<any> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/project-identifiers`, {
|
|
params: {
|
|
name: data,
|
|
},
|
|
})
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getProjects(
|
|
workspaceSlug: string,
|
|
params: {
|
|
is_favorite: "all" | boolean;
|
|
}
|
|
): Promise<IProject[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/projects/`, {
|
|
params,
|
|
})
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getProject(workspaceSlug: string, projectId: string): Promise<IProject> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectId}/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async updateProject(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
data: Partial<IProject>,
|
|
user: ICurrentUserResponse | undefined
|
|
): Promise<IProject> {
|
|
return this.patch(`/api/workspaces/${workspaceSlug}/projects/${projectId}/`, data)
|
|
.then((response) => {
|
|
if (trackEvent) trackEventServices.trackProjectEvent(response.data, "UPDATE_PROJECT", user);
|
|
return response?.data;
|
|
})
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async deleteProject(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
user: ICurrentUserResponse | undefined
|
|
): Promise<any> {
|
|
return this.delete(`/api/workspaces/${workspaceSlug}/projects/${projectId}/`)
|
|
.then((response) => {
|
|
if (trackEvent) trackEventServices.trackProjectEvent({ projectId }, "DELETE_PROJECT", user);
|
|
return response?.data;
|
|
})
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async inviteProject(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
data: IProjectBulkInviteFormData,
|
|
user: ICurrentUserResponse | undefined
|
|
): Promise<any> {
|
|
return this.post(`/api/workspaces/${workspaceSlug}/projects/${projectId}/members/add/`, data)
|
|
.then((response) => {
|
|
if (trackEvent)
|
|
trackEventServices.trackProjectEvent(
|
|
{
|
|
workspaceId: response?.data?.workspace?.id,
|
|
workspaceSlug,
|
|
projectId,
|
|
projectName: response?.data?.project?.name,
|
|
memberEmail: response?.data?.member?.email,
|
|
},
|
|
"PROJECT_MEMBER_INVITE",
|
|
user
|
|
);
|
|
return response?.data;
|
|
})
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async joinProject(workspaceSlug: string, data: any): Promise<any> {
|
|
return this.post(`/api/workspaces/${workspaceSlug}/projects/join/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async leaveProject(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
user: ICurrentUserResponse
|
|
): Promise<any> {
|
|
return this.delete(`/api/workspaces/${workspaceSlug}/projects/${projectId}/members/leave/`)
|
|
.then((response) => {
|
|
if (trackEvent)
|
|
trackEventServices.trackProjectEvent(
|
|
"PROJECT_MEMBER_LEAVE",
|
|
{
|
|
workspaceSlug,
|
|
projectId,
|
|
...response?.data,
|
|
},
|
|
user
|
|
);
|
|
return response?.data;
|
|
})
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async joinProjects(data: any): Promise<any> {
|
|
return this.post("/api/users/me/invitations/projects/", data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async projectMembers(workspaceSlug: string, projectId: string): Promise<IProjectMember[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectId}/project-members/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async projectMembersWithEmail(
|
|
workspaceSlug: string,
|
|
projectId: string
|
|
): Promise<IProjectMember[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectId}/members/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async projectMemberMe(workspaceSlug: string, projectId: string): Promise<IProjectMember> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectId}/project-members/me/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response;
|
|
});
|
|
}
|
|
|
|
async getProjectMember(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
memberId: string
|
|
): Promise<IProjectMember> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectId}/members/${memberId}/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async updateProjectMember(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
memberId: string,
|
|
data: Partial<IProjectMember>
|
|
): Promise<IProjectMember> {
|
|
return this.patch(
|
|
`/api/workspaces/${workspaceSlug}/projects/${projectId}/members/${memberId}/`,
|
|
data
|
|
)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async deleteProjectMember(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
memberId: string
|
|
): Promise<any> {
|
|
return this.delete(
|
|
`/api/workspaces/${workspaceSlug}/projects/${projectId}/members/${memberId}/`
|
|
)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async projectInvitations(
|
|
workspaceSlug: string,
|
|
projectId: string
|
|
): Promise<IProjectMemberInvitation[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectId}/invitations/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async projectInvitationsWithEmail(
|
|
workspaceSlug: string,
|
|
projectId: string
|
|
): Promise<IProjectMemberInvitation[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectId}/invitations/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async updateProjectInvitation(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
invitationId: string
|
|
): Promise<any> {
|
|
return this.put(
|
|
`/api/workspaces/${workspaceSlug}/projects/${projectId}/invitations/${invitationId}/`
|
|
)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async deleteProjectInvitation(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
invitationId: string
|
|
): Promise<any> {
|
|
return this.delete(
|
|
`/api/workspaces/${workspaceSlug}/projects/${projectId}/invitations/${invitationId}/`
|
|
)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async setProjectView(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
data: {
|
|
view_props?: IProjectViewProps;
|
|
default_props?: IProjectViewProps;
|
|
preferences?: ProjectPreferences;
|
|
sort_order?: number;
|
|
}
|
|
): Promise<any> {
|
|
await this.post(`/api/workspaces/${workspaceSlug}/projects/${projectId}/project-views/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getGithubRepositories(url: string): Promise<GithubRepositoriesResponse> {
|
|
return this.getWithoutBase(url)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async syncGithubRepository(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
workspaceIntegrationId: string,
|
|
data: {
|
|
name: string;
|
|
owner: string;
|
|
repository_id: string;
|
|
url: string;
|
|
}
|
|
): Promise<any> {
|
|
return this.post(
|
|
`/api/workspaces/${workspaceSlug}/projects/${projectId}/workspace-integrations/${workspaceIntegrationId}/github-repository-sync/`,
|
|
data
|
|
)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async getProjectGithubRepository(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
integrationId: string
|
|
): Promise<any> {
|
|
return this.get(
|
|
`/api/workspaces/${workspaceSlug}/projects/${projectId}/workspace-integrations/${integrationId}/github-repository-sync/`
|
|
)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async addProjectToFavorites(
|
|
workspaceSlug: string,
|
|
data: {
|
|
project: string;
|
|
}
|
|
): Promise<any> {
|
|
return this.post(`/api/workspaces/${workspaceSlug}/user-favorite-projects/`, data)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async removeProjectFromFavorites(workspaceSlug: string, projectId: string): Promise<any> {
|
|
return this.delete(`/api/workspaces/${workspaceSlug}/user-favorite-projects/${projectId}/`)
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
|
|
async projectIssuesSearch(
|
|
workspaceSlug: string,
|
|
projectId: string,
|
|
params: TProjectIssuesSearchParams
|
|
): Promise<ISearchIssueResponse[]> {
|
|
return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectId}/search-issues/`, {
|
|
params,
|
|
})
|
|
.then((response) => response?.data)
|
|
.catch((error) => {
|
|
throw error?.response?.data;
|
|
});
|
|
}
|
|
}
|
|
|
|
export default new ProjectServices();
|