[WEB-1397] chore: update project publish types (#4841)

* chore: update project publish types

* chore: added additional entity name

* chore: updated types

packages/types/src/publish.d.ts

@@ -1,6 +1,6 @@
 import { IProject, IProjectLite, IWorkspaceLite } from "@plane/types";
 
-export type TPublishEntityType = "project";
+export type TPublishEntityType = "project" | "page";
 
 export type TProjectPublishLayouts =
   | "calendar"
@@ -9,7 +9,7 @@ export type TProjectPublishLayouts =
   | "list"
   | "spreadsheet";
 
-export type TPublishViewProps = {
+export type TProjectPublishViewProps = {
   calendar?: boolean;
   gantt?: boolean;
   kanban?: boolean;
@@ -20,22 +20,25 @@ export type TPublishViewProps = {
 export type TProjectDetails = IProjectLite &
   Pick<IProject, "cover_image" | "logo_props" | "description">;
 
-export type TPublishSettings = {
+type TPublishSettings = {
   anchor: string | undefined;
-  is_comments_enabled: boolean;
   created_at: string | undefined;
   created_by: string | undefined;
   entity_identifier: string | undefined;
   entity_name: TPublishEntityType | undefined;
   id: string | undefined;
   inbox: unknown;
+  is_comments_enabled: boolean;
+  is_reactions_enabled: boolean;
+  is_votes_enabled: boolean;
   project: string | undefined;
   project_details: TProjectDetails | undefined;
-  is_reactions_enabled: boolean;
   updated_at: string | undefined;
   updated_by: string | undefined;
-  view_props: TViewProps | undefined;
-  is_votes_enabled: boolean;
   workspace: string | undefined;
   workspace_detail: IWorkspaceLite | undefined;
 };
+
+export type TProjectPublishSettings = TPublishSettings & {
+  view_props: TProjectPublishViewProps | undefined;
+};

space/app/[workspaceSlug]/[projectId]/page.ts

@@ -1,6 +1,6 @@
 import { notFound, redirect } from "next/navigation";
 // types
-import { TPublishSettings } from "@plane/types";
+import { TProjectPublishSettings } from "@plane/types";
 // services
 import PublishService from "@/services/publish.service";
 
@@ -20,7 +20,7 @@ export default async function IssuesPage(props: Props) {
   const { workspaceSlug, projectId } = params;
   const { board, peekId } = searchParams;
 
-  let response: TPublishSettings | undefined = undefined;
+  let response: TProjectPublishSettings | undefined = undefined;
   try {
     response = await publishService.fetchAnchorFromProjectDetails(workspaceSlug, projectId);
   } catch (error) {

space/services/publish.service.ts

@@ -1,5 +1,5 @@
 // types
-import { TPublishSettings } from "@plane/types";
+import { TProjectPublishSettings } from "@plane/types";
 // helpers
 import { API_BASE_URL } from "@/helpers/common.helper";
 // services
@@ -10,7 +10,7 @@ class PublishService extends APIService {
     super(API_BASE_URL);
   }
 
-  async fetchPublishSettings(anchor: string): Promise<TPublishSettings> {
+  async fetchPublishSettings(anchor: string): Promise<TProjectPublishSettings> {
     return this.get(`/api/public/anchor/${anchor}/settings/`)
       .then((response) => response?.data)
       .catch((error) => {
@@ -18,7 +18,7 @@ class PublishService extends APIService {
       });
   }
 
-  async fetchAnchorFromProjectDetails(workspaceSlug: string, projectID: string): Promise<TPublishSettings> {
+  async fetchAnchorFromProjectDetails(workspaceSlug: string, projectID: string): Promise<TProjectPublishSettings> {
     return this.get(`/api/public/workspaces/${workspaceSlug}/projects/${projectID}/anchor/`)
       .then((response) => response?.data)
       .catch((error) => {

space/store/publish/publish.store.ts

@@ -1,10 +1,16 @@
 import { observable, makeObservable, computed } from "mobx";
 // types
-import { IWorkspaceLite, TProjectDetails, TPublishEntityType, TPublishSettings, TPublishViewProps } from "@plane/types";
+import {
+  IWorkspaceLite,
+  TProjectDetails,
+  TPublishEntityType,
+  TProjectPublishSettings,
+  TProjectPublishViewProps,
+} from "@plane/types";
 // store types
 import { RootStore } from "@/store/root.store";
 
-export interface IPublishStore extends TPublishSettings {
+export interface IPublishStore extends TProjectPublishSettings {
   // computed
   workspaceSlug: string | undefined;
   canComment: boolean;
@@ -27,14 +33,14 @@ export class PublishStore implements IPublishStore {
   is_reactions_enabled: boolean;
   updated_at: string | undefined;
   updated_by: string | undefined;
-  view_props: TPublishViewProps | undefined;
+  view_props: TProjectPublishViewProps | undefined;
   is_votes_enabled: boolean;
   workspace: string | undefined;
   workspace_detail: IWorkspaceLite | undefined;
 
   constructor(
     private store: RootStore,
-    publishSettings: TPublishSettings
+    publishSettings: TProjectPublishSettings
   ) {
     this.anchor = publishSettings.anchor;
     this.is_comments_enabled = publishSettings.is_comments_enabled;

space/store/publish/publish_list.store.ts

@@ -1,7 +1,7 @@
 import set from "lodash/set";
 import { makeObservable, observable, runInAction, action } from "mobx";
 // types
-import { TPublishSettings } from "@plane/types";
+import { TProjectPublishSettings } from "@plane/types";
 // services
 import PublishService from "@/services/publish.service";
 // store
@@ -13,7 +13,7 @@ export interface IPublishListStore {
   // observables
   publishMap: Record<string, PublishStore>; // anchor => PublishStore
   // actions
-  fetchPublishSettings: (pageId: string) => Promise<TPublishSettings>;
+  fetchPublishSettings: (pageId: string) => Promise<TProjectPublishSettings>;
 }
 
 export class PublishListStore implements IPublishListStore {
@@ -42,7 +42,13 @@ export class PublishListStore implements IPublishListStore {
       const response = await this.publishService.fetchPublishSettings(anchor);
       runInAction(() => {
         if (response.anchor && response.view_props) {
-          this.store.issueFilter.updateLayoutOptions(response?.view_props);
+          this.store.issueFilter.updateLayoutOptions({
+            list: !!response.view_props.list,
+            kanban: !!response.view_props.kanban,
+            calendar: !!response.view_props.calendar,
+            gantt: !!response.view_props.gantt,
+            spreadsheet: !!response.view_props.spreadsheet,
+          });
           set(this.publishMap, [response.anchor], new PublishStore(this.store, response));
         }
       });

space/types/publish.d.ts

@@ -1,24 +0,0 @@
-import { IWorkspaceLite } from "@plane/types";
-import { TProjectDetails, TViewDetails } from "@/types/project";
-
-export type TPublishEntityType = "project";
-
-export type TPublishSettings = {
-  anchor: string | undefined;
-  is_comments_enabled: boolean;
-  created_at: string | undefined;
-  created_by: string | undefined;
-  entity_identifier: string | undefined;
-  entity_name: TPublishEntityType | undefined;
-  id: string | undefined;
-  inbox: unknown;
-  project: string | undefined;
-  project_details: TProjectDetails | undefined;
-  is_reactions_enabled: boolean;
-  updated_at: string | undefined;
-  updated_by: string | undefined;
-  view_props: TViewDetails | undefined;
-  is_votes_enabled: boolean;
-  workspace: string | undefined;
-  workspace_detail: IWorkspaceLite | undefined;
-};

web/core/components/project/publish-project/modal.tsx

@@ -6,7 +6,7 @@ import { useParams } from "next/navigation";
 import { Controller, useForm } from "react-hook-form";
 import { Check, ExternalLink, Globe2 } from "lucide-react";
 // types
-import { IProject, TProjectPublishLayouts, TPublishSettings } from "@plane/types";
+import { IProject, TProjectPublishLayouts, TProjectPublishSettings } from "@plane/types";
 // ui
 import { Button, Loader, ToggleSwitch, TOAST_TYPE, setToast, CustomSelect, ModalCore, EModalWidth } from "@plane/ui";
 // helpers
@@ -21,7 +21,7 @@ type Props = {
   onClose: () => void;
 };
 
-const defaultValues: Partial<TPublishSettings> = {
+const defaultValues: Partial<TProjectPublishSettings> = {
   is_comments_enabled: false,
   is_reactions_enabled: false,
   is_votes_enabled: false,
@@ -81,12 +81,12 @@ export const PublishProjectModal: React.FC<Props> = observer((props) => {
     }
   }, [fetchPublishSettings, isOpen, project, projectPublishSettings, workspaceSlug]);
 
-  const handlePublishProject = async (payload: Partial<TPublishSettings>) => {
+  const handlePublishProject = async (payload: Partial<TProjectPublishSettings>) => {
     if (!workspaceSlug) return;
     await publishProject(workspaceSlug.toString(), project.id, payload);
   };
 
-  const handleUpdatePublishSettings = async (payload: Partial<TPublishSettings>) => {
+  const handleUpdatePublishSettings = async (payload: Partial<TProjectPublishSettings>) => {
     if (!workspaceSlug || !payload.id) return;
 
     await updatePublishSettings(workspaceSlug.toString(), project.id, payload.id, payload).then((res) => {
@@ -124,7 +124,7 @@ export const PublishProjectModal: React.FC<Props> = observer((props) => {
     .map(([key, value]) => key)
     .filter((l) => VIEW_OPTIONS.find((o) => o.key === l));
 
-  const handleFormSubmit = async (formData: Partial<TPublishSettings>) => {
+  const handleFormSubmit = async (formData: Partial<TProjectPublishSettings>) => {
     if (!selectedLayouts || selectedLayouts.length === 0) {
       setToast({
         type: TOAST_TYPE.ERROR,
@@ -134,7 +134,7 @@ export const PublishProjectModal: React.FC<Props> = observer((props) => {
       return;
     }
 
-    const payload: Partial<TPublishSettings> = {
+    const payload: Partial<TProjectPublishSettings> = {
       id: formData.id,
       is_comments_enabled: formData.is_comments_enabled,
       is_reactions_enabled: formData.is_reactions_enabled,

web/core/services/project/project-publish.service.ts

@@ -1,5 +1,5 @@
 // types
-import { TPublishSettings } from "@plane/types";
+import { TProjectPublishSettings } from "@plane/types";
 // helpers
 import { API_BASE_URL } from "@/helpers/common.helper";
 // services
@@ -10,7 +10,7 @@ export class ProjectPublishService extends APIService {
     super(API_BASE_URL);
   }
 
-  async fetchPublishSettings(workspaceSlug: string, projectID: string): Promise<TPublishSettings> {
+  async fetchPublishSettings(workspaceSlug: string, projectID: string): Promise<TProjectPublishSettings> {
     return this.get(`/api/workspaces/${workspaceSlug}/projects/${projectID}/project-deploy-boards/`)
       .then((response) => response?.data)
       .catch((error) => {
@@ -21,8 +21,8 @@ export class ProjectPublishService extends APIService {
   async publishProject(
     workspaceSlug: string,
     projectID: string,
-    data: Partial<TPublishSettings>
+    data: Partial<TProjectPublishSettings>
-  ): Promise<TPublishSettings> {
+  ): Promise<TProjectPublishSettings> {
     return this.post(`/api/workspaces/${workspaceSlug}/projects/${projectID}/project-deploy-boards/`, data)
       .then((response) => response?.data)
       .catch((error) => {
@@ -34,8 +34,8 @@ export class ProjectPublishService extends APIService {
     workspaceSlug: string,
     projectID: string,
     project_publish_id: string,
-    data: Partial<TPublishSettings>
+    data: Partial<TProjectPublishSettings>
-  ): Promise<TPublishSettings> {
+  ): Promise<TProjectPublishSettings> {
     return this.patch(
       `/api/workspaces/${workspaceSlug}/projects/${projectID}/project-deploy-boards/${project_publish_id}/`,
       data

web/core/store/project/project-publish.store.ts

@@ -2,7 +2,7 @@ import set from "lodash/set";
 import unset from "lodash/unset";
 import { observable, action, makeObservable, runInAction } from "mobx";
 // types
-import { TPublishSettings } from "@plane/types";
+import { TProjectPublishSettings } from "@plane/types";
 // services
 import { ProjectPublishService } from "@/services/project";
 // store
@@ -13,22 +13,22 @@ export interface IProjectPublishStore {
   generalLoader: boolean;
   fetchSettingsLoader: boolean;
   // observables
-  publishSettingsMap: Record<string, TPublishSettings>; // projectID => TPublishSettings
+  publishSettingsMap: Record<string, TProjectPublishSettings>; // projectID => TProjectPublishSettings
   // helpers
-  getPublishSettingsByProjectID: (projectID: string) => TPublishSettings | undefined;
+  getPublishSettingsByProjectID: (projectID: string) => TProjectPublishSettings | undefined;
   // actions
-  fetchPublishSettings: (workspaceSlug: string, projectID: string) => Promise<TPublishSettings>;
+  fetchPublishSettings: (workspaceSlug: string, projectID: string) => Promise<TProjectPublishSettings>;
   updatePublishSettings: (
     workspaceSlug: string,
     projectID: string,
     projectPublishId: string,
-    data: Partial<TPublishSettings>
+    data: Partial<TProjectPublishSettings>
-  ) => Promise<TPublishSettings>;
+  ) => Promise<TProjectPublishSettings>;
   publishProject: (
     workspaceSlug: string,
     projectID: string,
-    data: Partial<TPublishSettings>
+    data: Partial<TProjectPublishSettings>
-  ) => Promise<TPublishSettings>;
+  ) => Promise<TProjectPublishSettings>;
   unPublishProject: (workspaceSlug: string, projectID: string, projectPublishId: string) => Promise<void>;
 }
 
@@ -37,7 +37,7 @@ export class ProjectPublishStore implements IProjectPublishStore {
   generalLoader: boolean = false;
   fetchSettingsLoader: boolean = false;
   // observables
-  publishSettingsMap: Record<string, TPublishSettings> = {};
+  publishSettingsMap: Record<string, TProjectPublishSettings> = {};
   // root store
   projectRootStore: ProjectRootStore;
   // services
@@ -65,9 +65,9 @@ export class ProjectPublishStore implements IProjectPublishStore {
   /**
    * @description returns the publish settings of a particular project
    * @param {string} projectID
-   * @returns {TPublishSettings | undefined}
+   * @returns {TProjectPublishSettings | undefined}
    */
-  getPublishSettingsByProjectID = (projectID: string): TPublishSettings | undefined =>
+  getPublishSettingsByProjectID = (projectID: string): TProjectPublishSettings | undefined =>
     this.publishSettingsMap?.[projectID] ?? undefined;
 
   /**
@@ -103,7 +103,7 @@ export class ProjectPublishStore implements IProjectPublishStore {
    * @param data
    * @returns
    */
-  publishProject = async (workspaceSlug: string, projectID: string, data: Partial<TPublishSettings>) => {
+  publishProject = async (workspaceSlug: string, projectID: string, data: Partial<TProjectPublishSettings>) => {
     try {
       runInAction(() => {
         this.generalLoader = true;
@@ -135,7 +135,7 @@ export class ProjectPublishStore implements IProjectPublishStore {
     workspaceSlug: string,
     projectID: string,
     projectPublishId: string,
-    data: Partial<TPublishSettings>
+    data: Partial<TProjectPublishSettings>
   ) => {
     try {
       runInAction(() => {