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

package/admin/src/translations/en.json

@@ -1,35 +1,75 @@
 {
     "plugin.name": "Comments",
-    "components.Search.placeholder": "Search for an entry...",
-    "list.header.title": "Comments",
-    "list.header.description": "{count, plural, =0 {All available} one {# new comment} other {# new comments}}",
-    "list.content.empty": "Nothing found, lift your search criteria and try again",
-    "list.item.header.blocked": "This comment has been blocked",
-    "list.item.header.blocked.thread": "This comment and thread have been blocked",
-    "list.item.header.removed": "This comment and thread have been removed by author",
-    "list.item.indication.new": "New comment",
-    "list.item.indication.abuse": "Abuse reported",
-    "list.item.threads.drilldown": "Drilldown",
-    "list.item.threads.count": "{count, plural, =0 {There is no threads} one {# thread} other {# threads}}",
-    "list.item.header.abuse": "{count, plural, =0 {Nothing reported} one {# report waits for review} other {# reports waits for review}}",
-    "list.item.moderation.button.comment.restore": "Restore comment",
-    "list.item.moderation.button.comment.hide": "Hide comment",
-    "list.item.moderation.button.thread.restore": "Restore thread",
-    "list.item.moderation.button.thread.hide": "Hide thread",
-    "moderation.header.title": "Moderation",
-    "moderation.header.description": "Discussion thread",
-    "moderation.content.empty": "Choose a comment to start moderating",
-    "popup.reports.header": "Review - Abuse reports",
-    "popup.reports.item.header.date": "Issue date",
-    "popup.reports.item.header.reason": "Reason",
-    "popup.reports.item.header.message": "Message",
-    "popup.reports.item.reason.other": "Other",
-    "popup.reports.item.reason.discrimination": "Discrimination",
-    "popup.reports.item.reason.bad_language": "Bad language used",
-    "popup.reports.item.button": "Resolve",
-    "popup.reports.footer.actions": "Moderator actions:",
-    "popup.reports.empty": "All good, no issues reported",
-    "notification.comment.visibility": "Comment visibility has been changed",
-    "notification.thread.visibility": "Comment thread visibility has been changed",
-    "notification.abuse-report.resolution": "Abuse report has been resolved"
-}
+    "common.button.back": "Go back",
+    "nav.header.moderation": "Moderation",
+    "nav.header.settings": "Settings",
+    "nav.item.updates": "Updates",
+    "nav.item.discover": "Discover",
+    "nav.item.reports": "Reports",
+    "nav.item.settings": "Settings",
+    "page.updates.header": "Recent updates",
+    "page.discover.header": "Discover threads",
+    "page.discover.header.count": "entries found",
+    "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.action.display": "Display",
+    "page.discover.table.action.reports": "Reports",
+    "page.discover.table.empty": "You don't have any comments yet.",
+    "page.discover.table.empty.search": "No comments match the search.",
+    "page.discover.table.filters": "Filtering",
+    "page.discover.table.reports.review": "Review reports",
+    "page.details.header": "Discussion panel",
+    "page.details.header.description": "Drilldown and manage discussion related to the entity",
+    "page.details.panel.discussion": "Discussion",
+    "page.details.panel.discussion.nav.drilldown": "Drilldown",
+    "page.details.panel.discussion.nav.back": "Go top",
+    "page.details.panel.discussion.warnings.reports.description": "open reports",
+    "page.details.panel.discussion.warnings.reports.review": "Review",
+    "page.details.panel.discussion.warnings.reports.dialog.list": "Reports",
+    "page.details.panel.discussion.warnings.reports.dialog.header": "Moderation: Review open reports",
+    "page.details.panel.discussion.warnings.reports.dialog.reason": "Reason",
+    "page.details.panel.discussion.warnings.reports.dialog.reason.BAD_LANGUAGE": "Bad language",
+    "page.details.panel.discussion.warnings.reports.dialog.reason.DISCRIMINATION": "Discrimination",
+    "page.details.panel.discussion.warnings.reports.dialog.reason.OTHER": "Other",
+    "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.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.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.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?",
+    "page.details.actions.comment.block.confirmation.button.confirm": "Yes, block it",
+    "page.details.actions.comment.block.confirmation.success": "Comment has been blocked",
+    "page.details.actions.comment.unblock": "Unblock comment",
+    "page.details.actions.comment.unblock.confirmation.success": "Comment has been unblocked",
+    "page.details.actions.comment.reports.review": "Review",
+    "page.details.actions.thread.block": "Block thread",
+    "page.details.actions.thread.block.confirmation.header": "Moderation: Block thread",
+    "page.details.actions.thread.block.confirmation.description": "Do you really want to block whole thread? No further discussions are going to be allowed.",
+    "page.details.actions.thread.block.confirmation.button.confirm": "Yes, block it",
+    "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.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?",
+    "compontents.confirmation.dialog.button.confirm": "Yes, I do",
+    "compontents.confirmation.dialog.button.cancel": "Cancel"
+}

package/admin/src/translations/fr.json

@@ -0,0 +1 @@
+{}

package/admin/src/utils/axiosInstance.js

@@ -0,0 +1,35 @@
+import axios from 'axios';
+import { auth } from '@strapi/helper-plugin';
+
+const instance = axios.create({
+  baseURL: process.env.STRAPI_ADMIN_BACKEND_URL,
+});
+
+instance.interceptors.request.use(
+  async config => {
+    config.headers = {
+      Authorization: `Bearer ${auth.getToken()}`,
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+    };
+
+    return config;
+  },
+  error => {
+    Promise.reject(error);
+  }
+);
+
+instance.interceptors.response.use(
+  response => response,
+  error => {
+    if (error.response?.status === 401) {
+      auth.clearAppStorage();
+      window.location.reload();
+    }
+
+    throw error;
+  }
+);
+
+export default instance;

package/admin/src/utils/constants.js

@@ -0,0 +1,28 @@
+export const APPROVAL_STATUS = {
+  PENDING: "PENDING",
+  APPROVED: "APPROVED",
+  REJECTED: "REJECTED",
+};
+
+export const REPORT_STATUS = {
+  'RESOLVED': 'RESOLVED',
+  'OPEN': 'OPEN',
+};
+
+export const REPORT_REASON = {
+  'BAD_LANGUAGE': 'BAD_LANGUAGE',
+  'DISCRIMINATION': 'DISCRIMINATION',
+  'OTHER': 'OTHER',
+};
+
+export const COMMENT_STATUS = {
+  'BLOCKED': 'BLOCKED',
+  'OPEN': 'OPEN',
+  '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+/),
+};

package/admin/src/utils/getApiUrl.js

@@ -0,0 +1,5 @@
+import pluginId from '../pluginId';
+
+const getApiURL = endPoint => `/${pluginId}/${endPoint}`;
+
+export default getApiURL;

package/admin/src/utils/getMessage.js

@@ -0,0 +1,21 @@
+
+import { useIntl } from 'react-intl';
+import { isString } from 'lodash';
+
+import pluginId from '../pluginId';
+
+const getMessage = (input, defaultMessage, inPluginScope = true) => {
+    const { formatMessage } = useIntl();
+    let formattedId = ''
+    if (isString(input)) {
+        formattedId = input;
+    } else {
+        formattedId = input?.id;
+    }
+    return formatMessage({
+        id: `${inPluginScope ? pluginId : 'app.components'}.${formattedId}`,
+        defaultMessage,
+    }, input?.props || undefined)
+};
+
+export default getMessage;

package/admin/src/utils/getRelatedGroups.js

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

package/admin/src/utils/getUrl.js

@@ -0,0 +1,5 @@
+import pluginId from '../pluginId';
+
+const getUrl = (path = '') => `/plugins/${pluginId}/${path}`;
+
+export default getUrl;

package/admin/src/utils/handleAPIError.js

@@ -0,0 +1,15 @@
+
+const handleAPIError = (err = null, toggleNotification = null) => {
+    toggleNotification({
+        type: 'warning',
+        message: 'app.components.notification.error',
+    });
+
+    if (err) {
+        throw err;
+    } else {
+        throw new Error('error');
+    }
+}
+
+export default handleAPIError;

package/admin/src/utils/index.js

@@ -0,0 +1,6 @@
+export { default as axiosInstance } from './axiosInstance';
+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';

package/codecov.yml

@@ -1,3 +1,4 @@
 comment:
   branches:
-    - master
+    - master
+    - feat/strapi-v4

package/content-types/comment.js

@@ -0,0 +1,97 @@
+/**
+ * Comments Collection Type
+ */
+
+module.exports = {
+  info: {
+    tableName: 'plugin-comments-comments',
+    singularName: 'comment',
+    pluralName: 'comments',
+    displayName: 'Comment',
+    description: 'Comment content type',
+    kind: 'collectionType',
+  },
+  options: {
+    draftAndPublish: false,
+  },
+  pluginOptions: {
+    'content-manager': {
+      visible: false
+    },
+    'content-type-builder': {
+      visible: false
+    }
+  },
+  attributes: {
+    content: {
+      type: 'text',
+      configurable: false,
+      required: true
+    },
+    blocked: {
+      type: 'boolean',
+      default: false,
+      configurable: false
+    },
+    blockedThread: {
+      type: 'boolean',
+      default: false,
+      configurable: false
+    },
+    blockReason: {
+      type: 'string',
+      configurable: false
+    },
+    authorUser: {
+      type: 'relation',
+      relation: 'oneToOne',
+      target: 'plugin::users-permissions.user',
+      configurable: false,
+    },
+    authorType: {
+      type: 'string',
+      configurable: false
+    },
+    authorId: {
+      type: 'string',
+      configurable: false
+    },
+    authorName: {
+      type: 'string',
+      configurable: false
+    },
+    authorEmail: {
+      type: 'email',
+      configurable: false
+    },
+    authorAvatar: {
+      type: 'string',
+      configurable: false
+    },
+    removed: {
+      type: 'boolean',
+      configurable: false
+    },
+    approvalStatus: {
+      type: 'string',
+      configurable: false
+    },
+    related: {
+      type: 'string',
+      configurable: false
+    },
+    reports: {
+      type: 'relation',
+      relation: 'oneToMany',
+      target: 'plugin::comments.comment-report',
+      mappedBy: 'related',
+      configurable: false,
+    },
+    threadOf: {
+      type: 'relation',
+      relation: 'oneToOne',
+      target: 'plugin::comments.comment',
+      configurable: false,
+    },
+  },
+};

package/content-types/index.js

@@ -0,0 +1,11 @@
+const CommentCT = require('./comment');
+const ReportCT = require('./report');
+
+module.exports = {
+  'comment': {
+    schema: CommentCT,
+  },
+  'comment-report': {
+    schema: ReportCT,
+  }, 
+};

package/content-types/report.js

@@ -0,0 +1,54 @@
+/**
+ * Comments Collection Type
+ */
+
+ module.exports = {
+  info: {
+    tableName: 'plugin-comments-reports',
+    singularName: 'comment-report',
+    pluralName: 'comment-reports',
+    displayName: 'Reports',
+    description: 'Reports content type',
+    kind: 'collectionType',
+  },
+  options: {
+    draftAndPublish: false,
+  },
+  pluginOptions: {
+    'content-manager': {
+      visible: false
+    },
+    'content-type-builder': {
+      visible: false
+    }
+  },
+  attributes: {
+    content: {
+      type: 'text',
+      configurable: false
+    },
+    reason: {
+      type: 'enumeration',
+      enum: [
+        'BAD_LANGUAGE',
+        'DISCRIMINATION',
+        'OTHER'
+      ],
+      default: 'OTHER',
+      configurable: false,
+      required: true
+    },
+    resolved: {
+      type: 'boolean',
+      default: false,
+      configurable: false
+    },
+    related: {
+      type: 'relation',
+      relation: 'manyToOne',
+      target: 'plugin::comments.comment',
+      inversedBy: 'reports',
+      configurable: false,
+    },
+  },
+};

package/package.json

@@ -1,41 +1,27 @@
 {
   "name": "strapi-plugin-comments",
-  "version": "1.0.2",
+  "version": "2.0.0-beta.3",
   "description": "Strapi - Comments plugin",
   "strapi": {
-    "name": "Comments",
-    "icon": "comments",
-    "description": "Comments & audience engagement"
+    "name": "comments",
+    "description": "Comments & audience engagement",
+    "kind": "plugin"
+  },
+  "scripts": {
+    "test:unit": "jest --verbose --coverage"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/VirtusLab-Open-Source/strapi-plugin-comments"
   },
-  "scripts": {
-    "test:unit": "jest --verbose --coverage"
-  },
   "dependencies": {
-    "bad-words": "^3.0.3",
-    "lodash": "^4.17.11",
-    "react": "^16.9.0",
-    "react-dom": "^16.9.0",
-    "react-intl": "4.5.0",
-    "react-redux": "^7.0.2",
-    "react-router": "^5.0.0",
-    "react-router-dom": "^5.0.0",
-    "reactstrap": "8.4.1",
-    "redux-saga": "^0.16.0",
-    "request": "^2.83.0",
-    "strapi-helper-plugin": "3.6.8",
-    "strapi-utils": "3.6.8",
-    "uuid": "^3.1.0"
+    "bad-words": "^3.0.4"
   },
   "devDependencies": {
-    "koa": "^2.8.0",
+    "codecov": "^3.7.2",
     "jest": "^26.0.1",
     "jest-cli": "^26.0.1",
-    "jest-styled-components": "^7.0.2",
-    "codecov": "^3.7.2"
+    "jest-styled-components": "^7.0.2"
   },
   "author": {
     "name": "VirtusLab // Mateusz Ziarko",
@@ -55,7 +41,7 @@
     }
   ],
   "engines": {
-    "node": ">=10.16.0",
+    "node": ">=12.x. <=16.x.x",
     "npm": ">=6.0.0"
   },
   "keywords": ["strapi", "plugin", "comments"],

package/server/bootstrap.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = ({ strapi }) => {
+  // bootstrap phase
+};

package/server/config/index.js

@@ -0,0 +1,10 @@
+'use strict';
+
+module.exports = {
+  default: {
+    entryLabel: {
+      '*': ['Title', 'title', 'Name', 'name', 'Subject', 'subject']
+    }
+  },
+  validator() {},
+};

package/server/controllers/admin.js

@@ -0,0 +1,134 @@
+'use strict';
+
+const { getPluginService } = require('./../utils/functions');
+const { parseParams, throwError } = require('./utils/functions');
+const _ = require('lodash');
+
+module.exports = {
+
+  getService(name = 'admin') {
+    return getPluginService(name);
+  },
+
+  async findAll(ctx) {
+    return this.getService()
+      .findAll(ctx.query);
+  },
+
+  async findOne(ctx) {
+    const { params = {} } = ctx;
+    const { id } = parseParams(params);
+    try {
+      return await this.getService()
+        .findOneAndThread(id);
+    } catch (e) {
+      throwError(ctx, e);
+    }
+  },
+
+  async blockComment(ctx) {
+    const { params = {} } = ctx;
+    const { id } = parseParams(params);
+    try {
+      return await this.getService()
+        .blockComment(id, true);
+    } catch (e) {
+      throwError(ctx, e);
+    }
+  },
+
+  async unblockComment(ctx) {
+    const { params = {} } = ctx;
+    const { id } = parseParams(params);
+    try {
+      return await this.getService()
+        .blockComment(id, false);
+    } catch (e) {
+      throwError(ctx, e);
+    }
+  },
+
+  async blockCommentThread(ctx) {
+    const { params = {} } = ctx;
+    const { id } = parseParams(params);
+    try {
+      return await this.getService()
+        .blockCommentThread(id, true);
+    } catch (e) {
+      throwError(ctx, e);
+    }
+  },
+
+  async unblockCommentThread(ctx) {
+    const { params = {} } = ctx;
+    const { id } = parseParams(params);
+    try {
+      return await this.getService()
+        .blockCommentThread(id, false);
+    } catch (e) {
+      throwError(ctx, e);
+    }
+  },
+
+  async resolveAbuseReport(ctx) {
+    const { params = {} } = ctx;
+    const { id: commentId, reportId } = parseParams(params);
+    try {
+      return await this.getService()
+        .resolveAbuseReport(reportId, commentId);
+    } catch (e) {
+      throwError(ctx, e);
+    }
+  },
+
+  async approveComment(ctx) {
+    const { id } = parseParams(ctx.params || {});
+    try {
+      return await this.getService()
+        .approveComment(id);
+    } catch (e) {
+      throwError(ctx, e);
+    }
+  },
+
+  async rejectComment(ctx) {
+    const { id } = parseParams(ctx.params || {});
+    try {
+      return await this.getService()
+        .rejectComment(id);
+    } catch (e) {
+      throwError(ctx, e);
+    }
+  },
+
+  async config() {
+    try {
+      return await this.getService().config();
+    } catch (e) {
+      throwError(ctx, e);
+    }
+  },
+
+  getContentsTypes() {
+    return Object.entries(strapi.contentTypes)
+      .filter(([, contentType]) => (
+        contentType.associations || []).some(_ => _.plugin === 'comments' && _.collection === 'comment'),
+      )
+      .reduce((acc, [, contentType]) => [
+          ...acc,
+          { key: contentType.globalName, value: contentType.collectionName }],
+        [],
+      );
+  },
+
+  async contentTypeName(ctx) {
+    const { params: { contentTypeName } } = ctx;
+    try {
+      const result = await this.getService()
+        .contentTypeName(contentTypeName);
+      return { list: result };
+    } catch (e) {
+      throwError(ctx, e);
+    }
+  },
+};