strapi-plugin-comments 2.0.0-beta.6 → 2.0.0

package/admin/src/translations/en.json

@@ -7,16 +7,17 @@
     "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.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",
@@ -46,17 +47,17 @@
     "page.details.panel.discussion.warnings.reports.dialog.content": "Content",
     "page.details.panel.discussion.warnings.reports.dialog.createdAt": "Issue date",
     "page.details.panel.discussion.warnings.reports.dialog.status": "Status",
-    "page.details.panel.discussion.warnings.reports.dialog.status.OPEN": "OPEN",
-    "page.details.panel.discussion.warnings.reports.dialog.status.RESOLVED": "RESOLVED",
+    "page.details.panel.discussion.warnings.reports.dialog.status.OPEN": "Open",
+    "page.details.panel.discussion.warnings.reports.dialog.status.RESOLVED": "Resolved",
     "page.details.panel.discussion.warnings.reports.dialog.actions": "Actions",
     "page.details.panel.discussion.warnings.reports.dialog.actions.resolve": "Resolve",
     "page.details.panel.discussion.warnings.reports.dialog.confirmation.success": "Open report has been resolved",
-    "page.details.panel.discussion.status.blocked": "BLOCKED",
+    "page.details.panel.discussion.status.blocked": "Blocked",
     "page.details.panel.entity": "Entity details",
     "page.details.panel.status": "Discussion is",
-    "page.details.panel.status.open": "OPEN",
-    "page.details.panel.status.blocked": "BLOCKED",
-    "page.details.panel.status.pending": "PENDING",
+    "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",
@@ -76,9 +77,7 @@
     "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.details.filters.removed.visibility": "Show removed comments",
     "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/index.js

@@ -4,5 +4,7 @@ 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 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/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

@@ -4,10 +4,6 @@ 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;
     } 
@@ -15,6 +11,10 @@ const resolveCommentStatus = ({ removed, blocked, blockedThread, approvalStatus,
     if (blocked || blockedThread) {
         return COMMENT_STATUS.BLOCKED;
     } 
+
+    if (reviewFlowEnabled) {
+        return COMMENT_STATUS.TO_REVIEW;
+    }
     
     if (gotApprovalFlow) {
         const status = approvalStatus.toUpperCase();

package/content-types/comment.js

@@ -48,10 +48,6 @@ module.exports = {
       target: 'plugin::users-permissions.user',
       configurable: false,
     },
-    authorType: {
-      type: 'string',
-      configurable: false
-    },
     authorId: {
       type: 'string',
       configurable: false

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "strapi-plugin-comments",
-  "version": "2.0.0-beta.6",
+  "version": "2.0.0",
   "description": "Strapi - Comments plugin",
   "strapi": {
     "name": "comments",
-    "description": "Comments & audience engagement",
+    "displayName": "Comments",
+    "description": "Powerful Strapi based comments moderation tool for you and your users",
     "kind": "plugin"
   },
   "scripts": {
+    "publish": "npm publish --tag latest",
     "test:unit": "jest --verbose --coverage"
   },
   "repository": {
@@ -15,14 +17,16 @@
     "url": "https://github.com/VirtusLab-Open-Source/strapi-plugin-comments"
   },
   "dependencies": {
-    "@strapi/utils": "^4.0.5",
+    "@strapi/utils": "^4.0.7",
+    "@strapi/plugin-graphql": "^4.0.7",
     "bad-words": "^3.0.4"
   },
   "devDependencies": {
     "codecov": "^3.7.2",
     "jest": "^26.0.1",
     "jest-cli": "^26.0.1",
-    "jest-styled-components": "^7.0.2"
+    "jest-styled-components": "^7.0.2",
+    "koa": "2.13.3"
   },
   "peerDependencies": {
     "@strapi/strapi": "4.x"

package/server/config/index.js

@@ -7,5 +7,10 @@ module.exports = {
     entryLabel: {
       '*': ['Title', 'title', 'Name', 'name', 'Subject', 'subject']
     },
+    reportReasons: {
+      'BAD_LANGUAGE': 'BAD_LANGUAGE',
+      'DISCRIMINATION': 'DISCRIMINATION',
+      'OTHER': 'OTHER',
+    },
   }
 };

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,16 +15,7 @@ module.exports = {
     const { relation } = parseParams(params);
     try {
       return this.getService('common')
-        .findAllFlat({
-          query: {
-            ...query,
-            $or: [{ removed: { $null: true } }, { removed: false }],
-            related: relation,
-          },
-          populate: {
-            threadOf: true,
-          },
-        });
+        .findAllFlat(flatInput(relation, query));
     } catch (e) {
       throwError(ctx, e);
     }
@@ -36,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) {
@@ -97,14 +82,19 @@ module.exports = {
   },
 
   async removeComment(ctx) {
-    const { params: { relationId, commentId }, query: { authorId } } = ctx;
-    if (authorId) {
+    const { 
+      params: { relationId, commentId }, 
+      query: { authorId },
+      state: { user },
+    } = ctx;
+    if (authorId || user?.id) {
       try {
         return await this.getService()
           .markAsRemoved(
-            relationId,
             commentId,
+            relationId,
             authorId,
+            user
           );
       } catch (e) {
         if (!e.isBoom) {

package/server/controllers/utils/__tests__/functions.test.js

@@ -1,6 +1,6 @@
-const PluginError = require('../../../services/utils/error');
+const PluginError = require('../../../utils/error');
 const ctx = require('koa/lib/context');
-const { parseParams, throwError } = require('../functions');
+const { throwError } = require('../functions');
 
 jest.mock
 

package/server/controllers/utils/parsers.js

@@ -0,0 +1,19 @@
+'use strict'
+
+module.exports = {
+    flatInput(relation, query) {
+        return {
+            query: {
+              ...query,
+              $or: [{ removed: { $null: true } }, { removed: false }],
+              related: relation,
+            },
+            populate: {
+              threadOf: {
+                populate: { authorUser: 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,25 @@
+'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, ctx) {
+			const { input } = args;
+			const { state: { user } = {} } = ctx;
+			const { commentId, relation, ...body } = input;
+			try {
+				return await getPluginService('client')
+					.reportAbuse(commentId, relation, body, user);
+			} catch(e) {
+				throw new Error(e);
+			}
+		},
+	};
+}

package/server/graphql/mutations/createComment.js

@@ -0,0 +1,25 @@
+'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, ctx) {
+			const { input } = args;
+			const { state: { user } = {} } = ctx;
+			const { relation, ...body } = input;
+			try {
+				return await getPluginService('client')
+					.create(relation, body, user);
+			} catch(e) {
+				throw new Error(e);
+			}
+		},
+	};
+}

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,25 @@
+'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, ctx) {
+			const { input } = args;
+			const { state: { user } = {} } = ctx;
+			const { id, relation, author } = input;
+			try {
+				return await getPluginService('client')
+					.markAsRemoved(id, relation, author?.id, user);
+			} catch(e) {
+				throw new Error(e);
+			}
+		},
+	};
+}

package/server/graphql/mutations/updateComment.js

@@ -0,0 +1,25 @@
+'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, ctx) {
+			const { input } = args;
+			const { state: { user } = {} } = ctx;
+			const { id, relation, ...body } = input;
+			try {
+				return await getPluginService('client')
+					.update(id, relation, body, user);
+			} catch(e) {
+				throw new Error(e);
+			}
+		},
+	};
+}

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);
+			}
+    },
+  });
+};

package/server/graphql/resolvers-config.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const { getPluginService } = require("../utils/functions");
+
+module.exports = () => {
+	const auth = getPluginService('common').getConfig('gql.auth', false);
+	return {
+		'Query.findAllFlat': { auth },
+		'Query.findAllInHierarchy': { auth },
+		'Mutation.createComment': { auth },
+		'Mutation.updateComment': { auth },
+		'Mutation.removeComment': { auth },
+		'Mutation.createAbuseReport': { auth },
+	};
+};

package/server/graphql/types/comment-author.js

@@ -0,0 +1,9 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "CommentAuthor",
+  definition(t) {
+    t.id("id")
+    t.nonNull.string("name")
+    t.string("email")
+    t.string("avatar")
+  }
+})

package/server/graphql/types/comment-nested.js

@@ -0,0 +1,16 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "CommentNested",
+  definition(t) {
+    t.id("id")
+    t.nonNull.string("content")
+    t.boolean("blocked")
+    t.boolean("blockedThread")
+    t.string("approvalStatus")
+    t.boolean("removed")
+    t.field("threadOf", { type: 'CommentSingle' })
+    t.list.field("children", { type: 'CommentNested' })
+    t.field("author", { type: 'CommentAuthor' })
+    t.string("createdAt")
+    t.string("updatedAt")
+  }
+})

package/server/graphql/types/comment.js

@@ -0,0 +1,15 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "CommentSingle",
+  definition(t) {
+    t.id("id")
+    t.nonNull.string("content")
+    t.boolean("blocked")
+    t.boolean("blockedThread")
+    t.boolean("removed")
+    t.string("approvalStatus")
+    t.field("threadOf", { type: 'CommentSingle' })
+    t.field("author", { type: 'CommentAuthor' })
+    t.string("createdAt")
+    t.string("updatedAt")
+  }
+})

package/server/graphql/types/create-comment-author.js

@@ -0,0 +1,9 @@
+module.exports = ({ nexus }) => nexus.inputObjectType({
+  name: "CreateCommentAuthor",
+  definition(t) {
+    t.nonNull.id("id")
+    t.nonNull.string("name")
+    t.string("email")
+    t.string("avatar")
+  }
+})

package/server/graphql/types/create-comment.js

@@ -0,0 +1,9 @@
+module.exports = ({ nexus }) => nexus.inputObjectType({
+  name: "CreateComment",
+  definition(t) {
+    t.nonNull.string("content")
+    t.nonNull.string("relation")
+    t.id("threadOf")
+    t.field("author", { type: 'CreateCommentAuthor' })
+  }
+})

package/server/graphql/types/create-report.js

@@ -0,0 +1,9 @@
+module.exports = ({ nexus }) => nexus.inputObjectType({
+  name: "CreateReport",
+  definition(t) {
+    t.id("commentId")
+    t.nonNull.string("relation")
+    t.nonNull.string("content")
+    t.field("reason", { type: 'ReportReason' })
+  }
+})

package/server/graphql/types/id.js

@@ -0,0 +1,24 @@
+const { isNumber, parseInt } = require('lodash');
+const { Kind } = require('graphql');
+
+module.exports = ({ nexus }) => nexus.scalarType({
+  name: "Id",
+  asNexusMethod: 'id',
+  description: 'Id as string or int',
+  parseValue(value) {
+    const parsedValue = parseInt(value);
+    if (isNumber(parsedValue)) {
+      return parsedValue;
+    }
+    return value;
+  },
+  serialize(value) {
+    return value;
+  },
+  parseLiteral(ast) {
+    if ([Kind.INT, Kind.STRING].includes(ast.kind)) {
+      return ast.value;
+    }
+    return null
+  },
+})

package/server/graphql/types/identify-comment-author.js

@@ -0,0 +1,6 @@
+module.exports = ({ nexus }) => nexus.inputObjectType({
+  name: "IdentifyCommentAuthor",
+  definition(t) {
+    t.nonNull.id("id")
+  }
+})

package/server/graphql/types/index.js

@@ -0,0 +1,16 @@
+const typesFactories = [
+	require('./id'),
+	require('./comment'),
+	require('./comment-nested'),
+	require('./comment-author'),
+	require('./create-comment'),
+	require('./create-comment-author'),
+	require('./update-comment'),
+	require('./remove-comment'),
+	require('./identify-comment-author'),
+	require('./report'),
+	require('./report-reason'),
+	require('./create-report'),
+];
+
+module.exports = context => typesFactories.map(factory => factory(context));

package/server/graphql/types/remove-comment.js

@@ -0,0 +1,8 @@
+module.exports = ({ nexus }) => nexus.inputObjectType({
+  name: "RemoveComment",
+  definition(t) {
+    t.id("id")
+    t.nonNull.string("relation")
+    t.field("author", { type: 'IdentifyCommentAuthor' })
+  }
+})

package/server/graphql/types/report-reason.js

@@ -0,0 +1,10 @@
+const { getPluginService } = require("../../utils/functions");
+
+
+module.exports = ({ nexus }) => nexus.enumType({
+  name: "ReportReason",
+  description: 'Reason of abuse report',
+  members: {
+    ...getPluginService('common').getConfig('reportReasons', {})
+  },
+})