strapi-plugin-comments 2.0.0-beta.4 → 2.0.0-rc.1

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

package/server/graphql/resolvers-config.js

@@ -0,0 +1,10 @@
+'use strict'
+
+module.exports = ({ }) => ({
+	'Query.findAllFlat': { auth: false },
+	'Query.findAllInHierarchy': { auth: false },
+	'Mutation.createComment': { auth: false },
+	'Mutation.updateComment': { auth: false },
+	'Mutation.removeComment': { auth: false },
+	'Mutation.createAbuseReport': { auth: false },
+});

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

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

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.field("threadOf", { type: 'CommentSingle' })
+    t.list.field("children", { type: 'CommentNested' })
+    t.field("authorUser", { type: 'CommentAuthorUser' })
+    t.field("author", { type: 'CommentAuthor' })
+    t.string("createdAt")
+    t.string("updatedAt")
+  }
+})

package/server/graphql/types/comment.js

@@ -0,0 +1,16 @@
+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("authorUser", { type: 'CommentAuthorUser' })
+    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.string("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.string("id")
+  }
+})

package/server/graphql/types/index.js

@@ -0,0 +1,17 @@
+const typesFactories = [
+	require('./id'),
+	require('./comment'),
+	require('./comment-nested'),
+	require('./comment-author'),
+	require('./comment-author-user'),
+	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', {})
+  },
+})

package/server/graphql/types/report.js

@@ -0,0 +1,11 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "Report",
+  definition(t) {
+    t.id("id")
+    t.nonNull.string("content")
+    t.field("reason", { type: 'ReportReason' })
+    t.field("related", { type: 'CommentSingle' })
+    t.string("createdAt")
+    t.string("updatedAt")
+  }
+})

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

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

package/server/register.js

@@ -1,5 +1,7 @@
 'use strict';
 
 module.exports = ({ strapi }) => {
-  // registeration phase
+  if (strapi.plugin('graphql')) {
+    require('./graphql')({ strapi });
+  }
 };