strapi-plugin-comments 2.0.0-beta.3 → 2.0.0-beta.7

package/admin/src/pages/{Details/utils → utils}/api.js

@@ -1,9 +1,13 @@
-import { getApiURL, axiosInstance, handleAPIError } from '../../../utils';
+import { stringify } from 'qs';
+import { isEmpty } from 'lodash';
+
+import { getApiURL, axiosInstance, handleAPIError } from '../../utils';
 
 // eslint-disable-next-line import/prefer-default-export
-export const fetchDetailsData = async (id, toggleNotification) => {
+export const fetchDetailsData = async (id, queryParams, toggleNotification) => {
   try {
-    const { data } = await axiosInstance.get(getApiURL(`moderate/single/${id}`));
+    const stringifiedProps = !isEmpty(queryParams) ? `?${stringify(queryParams, { encode: false })}` : '';
+    const { data } = await axiosInstance.get(getApiURL(`moderate/single/${id}${stringifiedProps}`));
 
     return data;
   } catch (err) {
@@ -28,6 +32,14 @@ export const unblockItem = id => {
   return axiosInstance.patch(getApiURL(`moderate/single/${id}/unblock`));
 };
 
+export const approveItem = id => {
+  return axiosInstance.patch(getApiURL(`moderate/single/${id}/approve`));
+};
+
+export const rejectItem = id => {
+  return axiosInstance.patch(getApiURL(`moderate/single/${id}/reject`));
+};
+
 export const blockItemThread = id => {
   return axiosInstance.patch(getApiURL(`moderate/thread/${id}/block`));
 };

package/admin/src/permissions.js

@@ -1,14 +1,16 @@
+const permissions = require('./../../permissions');
+
 const pluginPermissions = {
     access: [
-      { action: 'plugin::comments.read', subject: null },
-      { action: 'plugin::comments.reports.read', subject: null },
-      { action: 'plugin::comments.discovery.read', subject: null },
-      { action: 'plugin::comments.settings.read', subject: null },
+      { action: permissions.render(permissions.comments.read), subject: null },
+      { action: permissions.render(permissions.reports.read), subject: null },
+      // { action: 'plugin::comments.discover.read', subject: null },
+      { action: permissions.render(permissions.settings.read), subject: null },
     ],
-    discover: [{ action: 'plugin::comments.read', subject: null }],
-    moderate: [{ action: 'plugin::comments.moderate', subject: null }],
-    reports: [{ action: 'plugin::comments.reports.read', subject: null }],
-    reportsReview: [{ action: 'plugin::comments.reports.action', subject: null }],
+    // discover: [{ action: 'plugin::comments.discover.read', subject: null }],
+    moderate: [{ action: permissions.render(permissions.comments.moderate), subject: null }],
+    reports: [{ action: permissions.render(permissions.reports.read), subject: null }],
+    reportsReview: [{ action: permissions.render(permissions.reports.action), subject: null }],
   };
   
   export default pluginPermissions;

package/admin/src/translations/en.json

@@ -7,18 +7,24 @@
     "nav.item.discover": "Discover",
     "nav.item.reports": "Reports",
     "nav.item.settings": "Settings",
+    "page.common.item.status.OPEN": "OPEN",
+    "page.common.item.status.BLOCKED": "BLOCKED",
+    "page.common.item.status.APPROVED": "APPROVED",
+    "page.common.item.status.TO_REVIEW": "TO REVIEW ({count, number})",
+    "page.common.item.status.REJECTED": "REJECTED",
+    "page.common.item.status.REMOVED": "REMOVED BY AUTHOR",
     "page.updates.header": "Recent updates",
     "page.discover.header": "Discover threads",
     "page.discover.header.count": "entries found",
+    "page.discover.table.header.id": "ID",
+    "page.discover.table.header.author": "Author",
     "page.discover.table.header.message": "Message",
     "page.discover.table.header.thread": "Thread of",
     "page.discover.table.header.entry": "Entry",
     "page.discover.table.header.lastUpdate": "Last update",
     "page.discover.table.header.status": "Status",
-    "page.discover.table.header.status.OPEN": "OPEN",
-    "page.discover.table.header.status.BLOCKED": "BLOCKED",
-    "page.discover.table.header.status.TO_REVIEW": "TO REVIEW ({count, number})",
-    "page.discover.table.header.actions": "Status",
+    "page.discover.table.header.actions": "Actions",
+    "page.discover.table.cell.thread": "Comment #{id}",
     "page.discover.table.action.display": "Display",
     "page.discover.table.action.reports": "Reports",
     "page.discover.table.empty": "You don't have any comments yet.",
@@ -52,6 +58,7 @@
     "page.details.panel.status.open": "OPEN",
     "page.details.panel.status.blocked": "BLOCKED",
     "page.details.panel.status.pending": "PENDING",
+    "page.details.panel.loading": "Fetching entity...",
     "page.details.actions.comment.block": "Block comment",
     "page.details.actions.comment.block.confirmation.header": "Moderation: Block comment",
     "page.details.actions.comment.block.confirmation.description": "Do you really want to block this comment?",
@@ -67,6 +74,12 @@
     "page.details.actions.thread.block.confirmation.success": "Thread has been blocked",
     "page.details.actions.thread.unblock": "Unblock thread",
     "page.details.actions.thread.unblock.confirmation.success": "Thread has been unblocked",
+    "page.details.actions.comment.approve.confirmation.success": "Comment has been approved",
+    "page.details.actions.comment.reject.confirmation.success": "Comment has been rejected",
+    "page.details.filters.label": "View",
+    "page.details.filters.removed.visibility": "Comments visibility",
+    "page.details.filters.removed.show": "Show removed",
+    "page.details.filters.removed.hide": "Hide removed",
     "page.coming.soon": "Wait for what is coming soon...",
     "compontents.confirmation.dialog.header": "Confirmation",
     "compontents.confirmation.dialog.description": "Do you really want to perform this action?",

package/admin/src/utils/constants.js

@@ -16,13 +16,10 @@ export const REPORT_REASON = {
 };
 
 export const COMMENT_STATUS = {
+  'UNKNOWN': 'UNKNOWN',
   'BLOCKED': 'BLOCKED',
   'OPEN': 'OPEN',
+  'REMOVED': 'REMOVED',
   'TO_REVIEW': 'TO_REVIEW',
-};
-
-export const REGEX = {
-  uid: new RegExp(/^(?<type>[a-z]+)\:{2}(?<api>[a-z]+)\.{1}(?<contentType>[a-z]+)$/gmi),
-  relatedUid: new RegExp(/^(?<uid>[a-z]+\:{2}[a-z]+\.[a-z]+)\:{1}(?<id>[0-9]+)$/gmi),
-  email: new RegExp(/\S+@\S+\.\S+/),
+  ...APPROVAL_STATUS,
 };

package/admin/src/utils/getMessage.js

@@ -4,7 +4,7 @@ import { isString } from 'lodash';
 
 import pluginId from '../pluginId';
 
-const getMessage = (input, defaultMessage, inPluginScope = true) => {
+const getMessage = (input, defaultMessage = '', inPluginScope = true) => {
     const { formatMessage } = useIntl();
     let formattedId = ''
     if (isString(input)) {

package/admin/src/utils/getRelatedGroups.js

@@ -1,5 +1,3 @@
-import { REGEX } from "./constants";
-
-const getRelatedGroups = related => related.split(REGEX.relatedUid).filter(s => s && s.length > 0);
+const getRelatedGroups = (related, config) => related.split(config.regex.relatedUid).filter(s => s && s.length > 0);
 
 export default getRelatedGroups;

package/admin/src/utils/index.js

@@ -1,6 +1,10 @@
 export { default as axiosInstance } from './axiosInstance';
-export { default as getApiURL } from './getApiURL';
+export { default as getApiURL } from './getApiUrl';
 export { default as getUrl } from './getUrl';
 export { default as getMessage } from './getMessage';
 export { default as handleAPIError } from './handleAPIError';
-export { default as getRelatedGroups } from './getRelatedGroups';
+export { default as getRelatedGroups } from './getRelatedGroups';
+export { default as renderEntryTitle } from './renderEntryTitle';
+export { default as renderInitials } from './renderInitials';
+export { default as resolveCommentStatus } from './resolveCommentStatus';
+export { default as resolveCommentStatusColor } from './resolveCommentStatusColor';

package/admin/src/utils/renderEntryTitle.js

@@ -0,0 +1,14 @@
+import { first } from 'lodash';
+
+const renderEntryTitle = (entry, config = {}) => {
+    const { entryLabel } = config;
+    const rule = entry.uid in entryLabel ? entryLabel[entry.uid] : entryLabel['*'];
+    return first(
+      Object.keys(entry)
+        .filter(_ => (rule === _) || rule.includes(_))
+        .map(_ => entry[_])
+        .filter(_ => _)
+    );
+  };
+
+export default renderEntryTitle;

package/admin/src/utils/renderInitials.js

@@ -0,0 +1,5 @@
+import { first } from 'lodash';
+
+const renderInitials = (value = '') => value.split(' ').map(_ => first(_)).join('').toUpperCase();
+
+export default renderInitials;

package/admin/src/utils/resolveCommentStatus.js

@@ -0,0 +1,30 @@
+import { isNil } from 'lodash';
+import { COMMENT_STATUS } from './constants';
+
+const resolveCommentStatus = ({ removed, blocked, blockedThread, approvalStatus, reviewFlowEnabled }) => {
+    const gotApprovalFlow = !isNil(approvalStatus);
+
+    if (reviewFlowEnabled) {
+        return COMMENT_STATUS.TO_REVIEW;
+    }
+
+    if (removed) {
+        return COMMENT_STATUS.REMOVED;
+    } 
+    
+    if (blocked || blockedThread) {
+        return COMMENT_STATUS.BLOCKED;
+    } 
+    
+    if (gotApprovalFlow) {
+        const status = approvalStatus.toUpperCase();
+        if (Object.keys(COMMENT_STATUS).includes(status)) {
+            return status;
+        }
+        return COMMENT_STATUS.UNKNOWN;
+    }
+
+    return COMMENT_STATUS.OPEN;
+}
+
+export default resolveCommentStatus;

package/admin/src/utils/resolveCommentStatusColor.js

@@ -0,0 +1,22 @@
+import { isNil } from 'lodash';
+import { COMMENT_STATUS } from './constants';
+
+const resolveCommentStatusColor = (status) => {
+    if (Object.keys(COMMENT_STATUS).includes(status)) {
+        switch (status) {
+            case COMMENT_STATUS.REMOVED:
+                return 'secondary';
+            case COMMENT_STATUS.TO_REVIEW:
+            case COMMENT_STATUS.REJECTED:
+                return 'warning';
+            case COMMENT_STATUS.BLOCKED:
+                return 'danger';
+            case COMMENT_STATUS.OPEN:
+            case COMMENT_STATUS.APPROVED:
+                return 'success';
+        };
+    }
+    return 'secondary';
+}
+
+export default resolveCommentStatusColor;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-comments",
-  "version": "2.0.0-beta.3",
+  "version": "2.0.0-beta.7",
   "description": "Strapi - Comments plugin",
   "strapi": {
     "name": "comments",
@@ -15,6 +15,8 @@
     "url": "https://github.com/VirtusLab-Open-Source/strapi-plugin-comments"
   },
   "dependencies": {
+    "@strapi/utils": "^4.0.5",
+    "@strapi/plugin-graphql": "^4.0.5",
     "bad-words": "^3.0.4"
   },
   "devDependencies": {
@@ -23,6 +25,9 @@
     "jest-cli": "^26.0.1",
     "jest-styled-components": "^7.0.2"
   },
+  "peerDependencies": {
+    "@strapi/strapi": "4.x"
+  },
   "author": {
     "name": "VirtusLab // Mateusz Ziarko",
     "email": "mziarko@virtuslab.com",
@@ -41,8 +46,8 @@
     }
   ],
   "engines": {
-    "node": ">=12.x. <=16.x.x",
-    "npm": ">=6.0.0"
+    "node": ">=14.x.x <=17.x.x",
+    "npm": ">=7.x.x"
   },
   "keywords": ["strapi", "plugin", "comments"],
   "license": "MIT"

package/permissions.js

@@ -0,0 +1,19 @@
+'use strict';
+
+module.exports = {
+    render: function(uid) {
+        return `plugin::comments.${uid}`;
+    },
+    comments: {
+        read: 'read',
+        moderate: 'moderate',
+    },
+    reports: {
+        read: 'reports.read',
+        action: 'reports.action',
+    },
+    settings: {
+        read: 'settings.read',
+        change: 'settings.change',
+    },
+};

package/server/bootstrap.js

@@ -1,5 +1,41 @@
 'use strict';
 
-module.exports = ({ strapi }) => {
-  // bootstrap phase
+const permissions = require('./../permissions');
+
+module.exports = async ({ strapi }) => {
+  // Check if the plugin users-permissions is installed because the navigation needs it
+  if (Object.keys(strapi.plugins).indexOf("users-permissions") === -1) {
+    throw new Error(
+      "In order to make the comments plugin work the users-permissions plugin is required",
+    );
+  }
+  // Add permissions
+  const actions = [
+    {
+      section: "plugins",
+      displayName: "Comments: Read",
+      uid: permissions.comments.read,
+      pluginName: "comments",
+    },
+    {
+      section: "plugins",
+      displayName: "Comments: Moderate",
+      uid: permissions.comments.moderate,
+      pluginName: "comments",
+    },
+    {
+      section: "plugins",
+      displayName: "Reports: Read",
+      uid: permissions.reports.read,
+      pluginName: "comments",
+    },
+    {
+      section: "plugins",
+      displayName: "Reports: Moderate",
+      uid: permissions.reports.action,
+      pluginName: "comments",
+    },
+  ];
+
+  await strapi.admin.services.permission.actionProvider.registerMany(actions);
 };

package/server/config/index.js

@@ -2,9 +2,15 @@
 
 module.exports = {
   default: {
+    moderatorRoles: [],
+    approvalFlow: [],
     entryLabel: {
       '*': ['Title', 'title', 'Name', 'name', 'Subject', 'subject']
-    }
-  },
-  validator() {},
+    },
+    reportReasons: {
+      'BAD_LANGUAGE': 'BAD_LANGUAGE',
+      'DISCRIMINATION': 'DISCRIMINATION',
+      'OTHER': 'OTHER',
+    },
+  }
 };

package/server/controllers/admin.js

@@ -16,11 +16,11 @@ module.exports = {
   },
 
   async findOne(ctx) {
-    const { params = {} } = ctx;
+    const { params = {}, query } = ctx;
     const { id } = parseParams(params);
     try {
       return await this.getService()
-        .findOneAndThread(id);
+        .findOneAndThread(id, query);
     } catch (e) {
       throwError(ctx, e);
     }
@@ -101,7 +101,7 @@ module.exports = {
     }
   },
 
-  async config() {
+  async config(ctx) {
     try {
       return await this.getService().config();
     } catch (e) {

package/server/controllers/client.js

@@ -2,7 +2,7 @@
 
 const { getPluginService } = require('./../utils/functions');
 const { parseParams, throwError } = require('./utils/functions');
-const _ = require('lodash');
+const { flatInput } = require('./utils/parsers');
 
 module.exports = {
 
@@ -15,15 +15,7 @@ module.exports = {
     const { relation } = parseParams(params);
     try {
       return this.getService('common')
-        .findAllFlat({
-          query: {
-            ...query,
-            related: relation,
-          },
-          populate: {
-            threadOf: true,
-          },
-        });
+        .findAllFlat(flatInput(relation, query));
     } catch (e) {
       throwError(ctx, e);
     }
@@ -35,13 +27,7 @@ module.exports = {
     try {
       return await this.getService('common')
         .findAllInHierarchy({
-          query: {
-            ...query,
-            related: relation,
-          },
-          populate: {
-            threadOf: true,
-          },
+          ...flatInput(relation, query),
           dropBlockedThreads: true,
         });
     } catch (e) {
@@ -101,8 +87,8 @@ module.exports = {
       try {
         return await this.getService()
           .markAsRemoved(
-            relationId,
             commentId,
+            relationId,
             authorId,
           );
       } catch (e) {

package/server/controllers/utils/parsers.js

@@ -0,0 +1,17 @@
+'use strict'
+
+module.exports = {
+    flatInput(relation, query) {
+        return {
+            query: {
+              ...query,
+              $or: [{ removed: { $null: true } }, { removed: false }],
+              related: relation,
+            },
+            populate: {
+              threadOf: true,
+            },
+          };
+    },
+  
+};

package/server/graphql/index.js

@@ -0,0 +1,26 @@
+'use strict'
+
+const getTypes = require('./types');
+const getQueries = require('./queries');
+const getMutations = require('./mutations');
+const getResolversConfig = require('./resolvers-config');
+const { getModelUid } = require('../services/utils/functions');
+
+module.exports = () => {
+	const extensionService = strapi.plugin('graphql').service('extension');
+
+	extensionService.shadowCRUD(getModelUid('comment')).disable();
+	extensionService.shadowCRUD(getModelUid('comment-report')).disable();
+
+	extensionService.use(({ nexus }) => {
+		const types = getTypes({ strapi, nexus });
+		const queries = getQueries({ strapi, nexus });
+		const mutations = getMutations({ strapi, nexus });
+		const resolversConfig = getResolversConfig({ strapi });
+
+		return {
+			types: [types, queries, mutations],
+			resolversConfig,
+		}
+	});
+}

package/server/graphql/mutations/createAbuseReport.js

@@ -0,0 +1,20 @@
+'use strict'
+
+const { getPluginService } = require('../../utils/functions');
+
+module.exports = ({ nexus }) => {
+	const { nonNull } = nexus;
+
+	return {
+		type: nonNull('Report'),
+		args: {
+			input: nonNull('CreateReport'),
+		},
+		async resolve(obj, args) {
+			const { input } = args;
+			const { commentId, relation, ...body } = input;
+			return await getPluginService('client')
+				.reportAbuse(commentId, relation, body);
+		},
+	};
+}

package/server/graphql/mutations/createComment.js

@@ -0,0 +1,20 @@
+'use strict'
+
+const { getPluginService } = require('../../utils/functions');
+
+module.exports = ({ nexus }) => {
+	const { nonNull } = nexus;
+
+	return {
+		type: nonNull('CommentSingle'),
+		args: {
+			input: nonNull('CreateComment'),
+		},
+		async resolve(obj, args) {
+			const { input } = args;
+			const { relation, ...body } = input;
+			return await getPluginService('client')
+				.create(relation, body);
+		},
+	};
+}

package/server/graphql/mutations/index.js

@@ -0,0 +1,21 @@
+'use strict'
+
+module.exports = (context) => {
+	const mutations = {
+		createComment: require('./createComment'),
+		updateComment: require('./updateComment'),
+		removeComment: require('./removeComment'),
+		createAbuseReport: require('./createAbuseReport'),
+	};
+
+  return context.nexus.extendType({
+    type: 'Mutation',
+		definition(t) {
+			for (const [name, configFactory] of Object.entries(mutations)) {
+				const config = configFactory(context);
+
+				t.field(name, config);
+			}
+    },
+  });
+};

package/server/graphql/mutations/removeComment.js

@@ -0,0 +1,20 @@
+'use strict'
+
+const { getPluginService } = require('../../utils/functions');
+
+module.exports = ({ nexus }) => {
+	const { nonNull } = nexus;
+
+	return {
+		type: nonNull('CommentSingle'),
+		args: {
+			input: nonNull('RemoveComment'),
+		},
+		async resolve(obj, args) {
+			const { input } = args;
+			const { id, relation, author } = input;
+			return await getPluginService('client')
+				.markAsRemoved(id, relation, author?.id);
+		},
+	};
+}

package/server/graphql/mutations/updateComment.js

@@ -0,0 +1,20 @@
+'use strict'
+
+const { getPluginService } = require('../../utils/functions');
+
+module.exports = ({ nexus }) => {
+	const { nonNull } = nexus;
+
+	return {
+		type: nonNull('CommentSingle'),
+		args: {
+			input: nonNull('UpdateComment'),
+		},
+		async resolve(obj, args) {
+			const { input } = args;
+			const { id, relation, ...body } = input;
+			return await getPluginService('client')
+				.update(id, relation, body);
+		},
+	};
+}

package/server/graphql/queries/findAllFlat.js

@@ -0,0 +1,29 @@
+'use strict'
+
+const contentType = require('../../../content-types/comment');
+const { flatInput } = require('../../controllers/utils/parsers');
+const { getPluginService } = require('../../utils/functions');
+
+module.exports = ({ strapi, nexus }) => {
+	const { nonNull, list, stringArg } = nexus;
+	const { service: getService } = strapi.plugin('graphql');
+	const { args } = getService('internals');
+
+	return {
+		type: nonNull(list('CommentSingle')),
+		args: {
+			relation: nonNull(stringArg()),
+			filters: getPluginService('gql').buildContentTypeFilters(contentType),
+			pagination: args.PaginationArg,
+			sort: args.SortArg,
+		},
+		async resolve(obj, args) {
+			const { relation, filters } = args;
+			return await getPluginService('common')
+				.findAllFlat(flatInput(
+					relation, 
+					getPluginService('gql').graphQLFiltersToStrapiQuery(filters, contentType)
+				), undefined);
+		},
+	};
+}

package/server/graphql/queries/findAllInHierarchy.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const contentType = require('../../../content-types/comment');
+const { flatInput } = require('../../controllers/utils/parsers');
+const { getPluginService } = require('../../utils/functions');
+
+module.exports = ({ strapi, nexus }) => {
+	const { nonNull, list, stringArg } = nexus;
+	const { service: getService } = strapi.plugin('graphql');
+	const { args } = getService('internals');
+
+	return {
+		type: nonNull(list('CommentNested')),
+		args: {
+			relation: nonNull(stringArg()),
+			// filters: filtersArg,
+			sort: args.SortArg,
+		},
+		async resolve(obj, args) {
+			const { relation, filters } = args;
+			return await getPluginService('common')
+				.findAllInHierarchy({
+					...flatInput(
+						relation, 
+						getPluginService('gql').graphQLFiltersToStrapiQuery(filters, contentType)
+					),
+					dropBlockedThreads: true,
+				});
+		},
+	};
+}

package/server/graphql/queries/index.js

@@ -0,0 +1,19 @@
+'use strict'
+
+module.exports = (context) => {
+	const queries = {
+		findAllFlat: require('./findAllFlat'),
+		findAllInHierarchy: require('./findAllInHierarchy'),
+	};
+
+  return context.nexus.extendType({
+    type: 'Query',
+		definition(t) {
+			for (const [name, configFactory] of Object.entries(queries)) {
+				const config = configFactory(context);
+
+				t.field(name, config);
+			}
+    },
+  });
+};