strapi-plugin-comments 2.1.0-beta.1 → 2.1.0

package/README.md

@@ -32,6 +32,19 @@
 
 A plugin for [Strapi Headless CMS](https://github.com/strapi/strapi) that provides end to end comments feature with their moderation panel, bad words filtering, abuse reporting and much more.
 
+### Table of Contents
+
+1. [✨ Features](#-features)
+2. [⏳ Installation](#-installation)
+3. [🖐 Requirements](#-requirements)
+4. [🔧 Configuration](#-configuration)
+   - [Settings page](#in-v203-and-newer)
+   - [Plugin file](#in-v202-and-older--default-configuration-state-for-v203-and-newer)
+5. [🕸️ Public API - REST](#%EF%B8%8F-public-rest-api-specification)
+6. [🕸️ Public API - GraphQL](#%EF%B8%8F-public-graphql-specification)
+7. [🤝 Contributing](#-contributing)
+8. [👨‍💻 Community support](#-community-support)
+
 ## ✨ Features
 
 - **Comments Public REST + GraphQL API:** Elegant, entirely customizable and a fully extensible admin panel.
@@ -48,13 +61,23 @@ A plugin for [Strapi Headless CMS](https://github.com/strapi/strapi) that provid
 
 ## ⏳ Installation
 
+### Via Strapi Markerplace
+
+As a ✅ **verified** plugin by Strapi team we're available on the [**Strapi Marketplace**](https://market.strapi.io/plugins/strapi-plugin-comments) as well as **In-App Marketplace** where you can follow the installation instructions.
+
+<div style="margin: 20px 0" align="center">
+  <img style="width: 100%; height: auto;" src="public/assets/marketplace.png" alt="Strapi In-App Marketplace" />
+</div>
+
+### Via command line
+
 (Use **yarn** to install this plugin within your Strapi project (recommended). [Install yarn with these docs](https://yarnpkg.com/lang/en/docs/install/).)
 
 ```bash
 yarn add strapi-plugin-comments@latest
 ```
 
-After successful installation you've to build a fresh package that includes plugin UI. To archive that simply use:
+After successful installation you've to re-build your Strapi instance. To archive that simply use:
 
 ```bash
 yarn build
@@ -69,7 +92,9 @@ yarn develop --watch-admin
 
 The **Comments** plugin should appear in the **Plugins** section of Strapi sidebar after you run app again.
 
-Enjoy 🎉
+As a next step you must configure your the plugin by the way you want to. See [**Configuration**](#🔧-configuration) section.
+
+All done. Enjoy 🎉
 
 ### Working in development mode
 
@@ -107,7 +132,7 @@ In our minimum support we're following [official Node.js releases timelines](htt
 
 **Supported Strapi versions**:
 
-- Strapi v4.1.2 (recently tested)
+- Strapi v4.1.7 (recently tested)
 - Strapi v4.x
 
 > This plugin is designed for **Strapi v4** and is not working with v3.x. To get version for **Strapi v3** install version [v1.x](https://github.com/VirtusLab-Open-Source/strapi-plugin-comments/tree/strapi-v3).
@@ -116,14 +141,22 @@ In our minimum support we're following [official Node.js releases timelines](htt
 
 ## 🔧 Configuration
 
-### In `v2.0.3` and newest
+To start your journey with **Comments plugin** you must first setup it using the dedicated Settings page (`v2.0.3` and newer) or for any version, put your configuration in `config/plugins.js`. Anyway we're recommending the click-through option where your configuration is going to be properly validated.
+
+### In `v2.0.3` and newer
 
 Version `2.0.3` introduce the intuitive **Settings** page which you can easly access via `Strapi Settings -> Section: Comments Plugin -> Configuration`. On dedicated page you will be able to setup all crucial properties which drives the plugin and customize each individual collection for which **Comments plugin** should be enabled.
 
+On the dedicated page, you will be able to set up all crucial properties which drive the plugin and customize each individual collection for which **Comments plugin** should be enabled.
+
+<div style="margin: 20px 0" align="center">
+  <img style="width: 100%; height: auto;" src="public/assets/configuration.png" alt="Plugin configuration" />
+</div>
+
 > _Note_
 > Default configuration for your plugin is fetched from `config/plugins.js` or directly from the plugin itself. If you would like to customize the default state to which you might revert, please follow the next section.
 
-### In `v2.0.2` and older + default configuration state for `v2.0.3` and newest
+### In `v2.0.2` and older + default configuration state for `v2.0.3` and newer
 
 To setup amend default plugin configuration we recommend to put following snippet as part of `config/plugins.js` or `config/<env>/plugins.js` file. If the file does not exist yet, you have to create it manually. If you've got already configurations for other plugins stores by this way, use just the `comments` part within exising `plugins` item.
 
@@ -154,6 +187,7 @@ module.exports = ({ env }) => ({
 
 ### Properties
 
+- `enabledCollections` - list of Collection and Single Types for which plugin should be enabled in format like `'api::<collection name>.<content type name>'`. By default it's empty and none comments are not enabled for any of type in Strapi.
 - `badWords` - Enabled support for [bad words filtering](https://www.npmjs.com/package/bad-words). Can be turned off or overwritten using [options reference](https://www.npmjs.com/package/bad-words#constructor). Default value: `true`.
 - `moderatorRoles` - Optional list of names of roles. Users with those roles will be notified by email when a new abuse report is created. This feature requires a built-in [Strapi email plugin](https://docs.strapi.io/developer-docs/latest/plugins/email.html) configured.
 - `approvalFlow` - list of Content Types which are supporting approval flow. Values must be in format like `'api::<collection name>.<content type name>'`. For not included, posted comments are going to be immediately visible.
@@ -276,6 +310,7 @@ Return a hierarchical tree structure of comments for specified instance of Conte
 
 #### Strapi REST API properties support:
 
+- [field selection](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.html#field-selection)
 - [sorting](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.html#sorting)
 
 ### Get Comments (flat structure)
@@ -317,6 +352,7 @@ Return a flat structure of comments for specified instance of Content Type like
 #### Strapi REST API properties support:
 
 - [filtering](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest/filtering-locale-publication.html#filtering)
+- [field selection](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest/populating-fields.html#field-selection)
 - [sorting](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.html#sorting)
 - [pagination](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.html#pagination)
 

package/admin/src/components/Avatar/index.d.ts

@@ -0,0 +1,12 @@
+declare const UserAvatar: {
+    ({ avatar, name }: {
+        avatar: any;
+        name: any;
+    }): any;
+    propTypes: {
+        avatar: any;
+        name: any;
+    };
+};
+export default UserAvatar;
+//# sourceMappingURL=index.d.ts.map

package/admin/src/components/Avatar/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const react_1 = __importDefault(require("react"));
+const prop_types_1 = __importDefault(require("prop-types"));
+const lodash_1 = require("lodash");
+const Avatar_1 = require("@strapi/design-system/Avatar");
+const utils_1 = require("../../utils");
+const UserAvatar = ({ avatar, name }) => {
+    if (avatar) {
+        let image = avatar;
+        if ((0, lodash_1.isObject)(avatar)) {
+            image = avatar?.formats?.thumbnail.url || avatar.url;
+        }
+        return react_1.default.createElement(Avatar_1.Avatar, { src: image, alt: name });
+    }
+    return react_1.default.createElement(Avatar_1.Initials, null, (0, utils_1.renderInitials)(name));
+};
+UserAvatar.propTypes = {
+    avatar: prop_types_1.default.oneOfType(prop_types_1.default.string, prop_types_1.default.object).isRequired,
+    name: prop_types_1.default.string,
+};
+exports.default = UserAvatar;
+//# sourceMappingURL=index.js.map

package/admin/src/components/DiscussionThreadItemFooter/index.js

@@ -6,11 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const react_1 = __importDefault(require("react"));
 const prop_types_1 = __importDefault(require("prop-types"));
 const react_intl_1 = require("react-intl");
-const Avatar_1 = require("@strapi/design-system/Avatar");
 const Box_1 = require("@strapi/design-system/Box");
 const Typography_1 = require("@strapi/design-system/Typography");
-const utils_1 = require("../../utils");
 const styles_1 = require("./styles");
+const Avatar_1 = __importDefault(require("../Avatar"));
 const DiscussionThreadItemFooter = ({ children, author, createdAt, updatedAt, }) => {
     const { formatDate } = (0, react_intl_1.useIntl)();
     const dateTime = formatDate(updatedAt || createdAt, {
@@ -20,7 +19,7 @@ const DiscussionThreadItemFooter = ({ children, author, createdAt, updatedAt, })
     const { name, avatar } = author;
     return (react_1.default.createElement(styles_1.DiscussionThreadItemFooterStyled, { as: Box_1.Box, paddingTop: 2, direction: "row" },
         react_1.default.createElement(styles_1.DiscussionThreadItemFooterMeta, { size: 3, horizontal: true },
-            avatar ? (react_1.default.createElement(Avatar_1.Avatar, { src: avatar, alt: name })) : (react_1.default.createElement(Avatar_1.Initials, null, (0, utils_1.renderInitials)(name))),
+            react_1.default.createElement(Avatar_1.default, { avatar: avatar, name: name }),
             react_1.default.createElement(Typography_1.Typography, { variant: "pi", fontWeight: "bold", textColor: "neutral800" }, name),
             react_1.default.createElement(Typography_1.Typography, { variant: "pi", textColor: "neutral600" }, dateTime)),
         children));
@@ -30,7 +29,7 @@ DiscussionThreadItemFooter.propTypes = {
         id: prop_types_1.default.oneOfType(prop_types_1.default.string, prop_types_1.default.number).isRequired,
         name: prop_types_1.default.string.isRequired,
         email: prop_types_1.default.string,
-        avatar: prop_types_1.default.string,
+        avatar: prop_types_1.default.oneOfType(prop_types_1.default.string, prop_types_1.default.object),
     }).isRequired,
     createdAt: prop_types_1.default.string.isRequired,
     updatedAt: prop_types_1.default.string,

package/admin/src/pages/Discover/components/DiscoverTableRow/index.js

@@ -31,7 +31,6 @@ const prop_types_1 = __importDefault(require("prop-types"));
 const react_intl_1 = require("react-intl");
 const react_query_1 = require("react-query");
 const lodash_1 = require("lodash");
-const Avatar_1 = require("@strapi/design-system/Avatar");
 const Flex_1 = require("@strapi/design-system/Flex");
 const IconButton_1 = require("@strapi/design-system/IconButton");
 const Link_1 = require("@strapi/design-system/Link");
@@ -49,6 +48,7 @@ const DiscussionThreadItemApprovalFlowActions_1 = __importDefault(require("../..
 const StatusBadge_1 = __importDefault(require("../../../../components/StatusBadge"));
 const styles_2 = require("../../../../components/IconButton/styles");
 const DiscussionThreadItemReviewAction_1 = __importDefault(require("../../../../components/DiscussionThreadItemReviewAction"));
+const Avatar_1 = __importDefault(require("../../../../components/Avatar"));
 const DiscoverTableRow = ({ config, item, allowedActions: { canModerate, canAccessReports, canReviewReports }, onClick, }) => {
     const { id, reports } = item;
     const [blockButtonsDisabled, setBlockButtonsDisabled] = (0, react_1.useState)(false);
@@ -128,7 +128,7 @@ const DiscoverTableRow = ({ config, item, allowedActions: { canModerate, canAcce
                 item.id)),
         react_1.default.createElement(Table_1.Td, null,
             react_1.default.createElement(Stack_1.Stack, { size: 2, horizontal: true },
-                item.author?.avatar ? (react_1.default.createElement(Avatar_1.Avatar, { src: item.author?.avatar, alt: item.author.name })) : (react_1.default.createElement(Avatar_1.Initials, null, (0, utils_1.renderInitials)(item.author.name))),
+                react_1.default.createElement(Avatar_1.default, { avatar: item.author?.avatar, name: item.author.name }),
                 react_1.default.createElement(Typography_1.Typography, { textColor: "neutral800", variant: "pi" }, item.author.name))),
         react_1.default.createElement(Table_1.Td, { style: { maxWidth: "30vw" } },
             react_1.default.createElement(Typography_1.Typography, { textColor: "neutral800", ellipsis: true }, item.content)),

package/admin/src/translations/fr.json

@@ -1 +1,132 @@
-{}
+{
+  "plugin.name": "Commentaires",
+  "plugin.section": "Plugin de commentaires",
+  "plugin.section.item": "Configuration",
+  "common.button.back": "Retour",
+  "nav.header.moderation": "Modération",
+  "nav.header.settings": "Paramètres",
+  "nav.item.updates": "Mises à jour",
+  "nav.item.discover": "Découvrir",
+  "nav.item.reports": "Rapports",
+  "nav.item.settings": "Paramètres",
+  "page.common.item.status.OPEN": "Ouvert",
+  "page.common.item.status.PENDING": "En attente",
+  "page.common.item.status.BLOCKED": "Bloqué",
+  "page.common.item.status.APPROVED": "Approuvé",
+  "page.common.item.status.TO_REVIEW": "À examiner ({count, number})",
+  "page.common.item.status.REJECTED": "Rejeté",
+  "page.common.item.status.REMOVED": "Retiré par l'auteur",
+  "page.updates.header": "Mises à jour récentes",
+  "page.discover.header": "Découvrir les threads",
+  "page.discover.header.count": "entrées trouvées",
+  "page.discover.table.header.id": "ID",
+  "page.discover.table.header.author": "Auteur",
+  "page.discover.table.header.message": "Message",
+  "page.discover.table.header.thread": "Thread de",
+  "page.discover.table.header.entry": "Entrée",
+  "page.discover.table.header.lastUpdate": "Dernière mise à jour",
+  "page.discover.table.header.status": "Status",
+  "page.discover.table.header.actions": "Actions",
+  "page.discover.table.cell.thread": "Commentaire #{id}",
+  "page.discover.table.action.display": "Afficher",
+  "page.discover.table.action.reports": "Rapports",
+  "page.discover.table.empty": "Vous n'avez pas de encore de commentaires.",
+  "page.discover.table.empty.search": "Aucun commentaire ne correspond à votre recherche.",
+  "page.discover.table.filters": "Filtrage",
+  "page.discover.table.reports.review": "Consultation des rapports",
+  "page.details.header": "Panel de discussion",
+  "page.details.header.description": "Exploration et gestion de discussions relatives à l'entité",
+  "page.details.panel.discussion": "Discussion",
+  "page.details.panel.discussion.nav.drilldown": "Exploration",
+  "page.details.panel.discussion.nav.back": "Retour en haut",
+  "page.details.panel.discussion.warnings.reports.description": "rapports ouverts",
+  "page.details.panel.discussion.warnings.reports.review": "consultation",
+  "page.details.panel.discussion.warnings.reports.dialog.list": "Rapports",
+  "page.details.panel.discussion.warnings.reports.dialog.header": "Modération : Examiner les rapports ouverts",
+  "page.details.panel.discussion.warnings.reports.dialog.reason": "Raison",
+  "page.details.panel.discussion.warnings.reports.dialog.reason.BAD_LANGUAGE": "Langage inapproprié",
+  "page.details.panel.discussion.warnings.reports.dialog.reason.DISCRIMINATION": "Discrimination",
+  "page.details.panel.discussion.warnings.reports.dialog.reason.OTHER": "Autre",
+  "page.details.panel.discussion.warnings.reports.dialog.content": "Contenu",
+  "page.details.panel.discussion.warnings.reports.dialog.createdAt": "Date de création",
+  "page.details.panel.discussion.warnings.reports.dialog.status": "Status",
+  "page.details.panel.discussion.warnings.reports.dialog.status.OPEN": "Ouvert",
+  "page.details.panel.discussion.warnings.reports.dialog.status.RESOLVED": "Résolu",
+  "page.details.panel.discussion.warnings.reports.dialog.actions": "Actions",
+  "page.details.panel.discussion.warnings.reports.dialog.actions.resolve": "Résoudre",
+  "page.details.panel.discussion.warnings.reports.dialog.confirmation.success": "Le rapport ouvert a été résolu",
+  "page.details.panel.discussion.status.blocked": "Bloqué",
+  "page.details.panel.entity": "Détails de l'entité",
+  "page.details.panel.status": "La discussion est",
+  "page.details.panel.status.open": "Ouvert",
+  "page.details.panel.status.blocked": "Bloqué",
+  "page.details.panel.status.pending": "En attente",
+  "page.details.panel.loading": "Récupération de l'entité...",
+  "page.details.actions.comment.block": "Bloquer le commentaire",
+  "page.details.actions.comment.block.confirmation.header": "Modération : Bloquer le commentaire",
+  "page.details.actions.comment.block.confirmation.description": "Voulez-vous vraiment bloquer ce commentaire ?",
+  "page.details.actions.comment.block.confirmation.button.confirm": "Oui, bloqué le",
+  "page.details.actions.comment.block.confirmation.success": "Le commentaire a été bloqué",
+  "page.details.actions.comment.unblock": "Débloquer le commentaire",
+  "page.details.actions.comment.unblock.confirmation.success": "Le commentaire a été débloqué",
+  "page.details.actions.comment.reports.review": "Consulter",
+  "page.details.actions.thread.block": "Bloquer le thread",
+  "page.details.actions.thread.block.confirmation.header": "Moderation: Bloquer le thread",
+  "page.details.actions.thread.block.confirmation.description": "Voulez-vous vraiment bloquer tout le thread ? Aucune autre discussion ne sera autorisée.",
+  "page.details.actions.thread.block.confirmation.button.confirm": "Oui, bloqué le",
+  "page.details.actions.thread.block.confirmation.success": "Le thread a été bloqué",
+  "page.details.actions.thread.unblock": "Débloquer le thread",
+  "page.details.actions.thread.unblock.confirmation.success": "Le thread a été débloqué",
+  "page.details.actions.comment.approve.confirmation.success": "Le commentaire a été apprové",
+  "page.details.actions.comment.reject.confirmation.success": "Le commentaire a été rejeté",
+  "page.details.filters.label": "Voir",
+  "page.details.filters.removed.visibility": "Afficher les commentaires supprimés",
+  "page.coming.soon": "Attendez pour ce qui va bientôt arriver...",
+  "page.settings": "Paramètres",
+  "page.settings.header.title": "Commentaires",
+  "page.settings.header.description": "Configurez vos capacités de modération des commentaires",
+  "page.settings.actions.submit": "Enregistrer",
+  "page.settings.actions.restore": "Restaurer les paramètres par défaut",
+  "page.settings.actions.restart": "Redémarrer Strapi",
+  "page.settings.section.general": "Configuration générale",
+  "page.settings.section.additional": "Configuration supplémentaire",
+  "page.settings.section.restore": "Restaurer les paramètres par défaut",
+  "page.settings.section.restore.subtitle": "Suppression de tous les paramètres appliqués et retour aux paramètres par défaut du plugin. Utilisez-les raisonnablement",
+  "page.settings.form.enabledCollections.label": "Activer les commentaires uniquement pour",
+  "page.settings.form.enabledCollections.placeholder": "Sélectionnez une ou plusieurs collections",
+  "page.settings.form.enabledCollections.hint": "Si aucun n'est sélectionné, tous les types de contenu sont activés",
+  "page.settings.form.contentTypesSettings.label": "Types de contenu",
+  "page.settings.form.contentTypesSettings.tooltip": "Configuration personnalisée par type de contenu",
+  "page.settings.form.moderatorRoles.label": "Envoyer des notifications importantes à",
+  "page.settings.form.moderatorRoles.placeholder": "Sélectionnez un ou plusieurs rôles",
+  "page.settings.form.moderatorRoles.hint": "Rôles qui vont être notifiés par le plugin sur les actions significatives à effectuer",
+  "page.settings.form.badWords.label": "Filtrage des gros mots",
+  "page.settings.form.badWords.hint": "Si activé, chaque message / mise à jour de commentaire va être vérifié contre les gros mots",
+  "page.settings.form.gqlAuth.label": "Autorisation des requêtes GraphQL",
+  "page.settings.form.gqlAuth.hint": "Si elle est activée, les requêtes et mutations de l'API GraphQL ne peuvent être déclenchées que par les utilisateurs Strapi authentifiés. Sinon, l'API reste ouverte.",
+  "page.settings.form.approvalFlow.label": "Flux de validation",
+  "page.settings.form.approvalFlow.hint": "Les commentaires associés au type de contenu \"{nom}\" vont être soumis à un flux de vérification manuel",
+  "page.settings.form.entryLabel.label": "Champs de titre",
+  "page.settings.form.entryLabel.placeholder": "Sélectionnez au moins un champ ou laissez vide pour appliquer les valeurs par défaut",
+  "page.settings.form.entryLabel.hint": "Si vous laissez vide, le rendu du titre sera le suivant : \"Title\", \"Subject\" & \"Name\"",
+  "page.settings.actions.restore.confirmation.header": "Restaurer la configuration par défaut",
+  "page.settings.actions.restore.confirmation.description": "Vous êtes sur le point de restaurer la configuration du plugin à ses valeurs par défaut. Cela pourrait avoir un impact destructeur sur le contenu déjà collecté. Voulez-vous vraiment continuer ?",
+  "page.settings.actions.restore.confirmation.button.confirm": "Oui, je veux restaurer",
+  "page.settings.actions.restart.alert.title": "Strapi requiert un redémarrage",
+  "page.settings.actions.restart.alert.description": "Vous avez effectué un changement de configuration qui nécessite que votre application Strapi soit redémarrée pour prendre effet dans le schéma GraphQL. Faites-le manuellement ou en utilisant le déclencheur ci-dessous.",
+  "page.settings.actions.restart.alert.close": "Abandonner",
+  "page.settings.notification.fetch.error": "Impossible de récupérer la configuration. Nouvelle tentative en cours...",
+  "page.settings.notification.submit.success": "La configuration a été enregistrée avec succès",
+  "page.settings.notification.submit.error": "Échec de la sauvegarde de la configuration. Veuillez rééssayer plus tard.",
+  "page.settings.notification.restore.success": "La configuration a été restaurée avec succès",
+  "page.settings.notification.restore.error": "Impossible de restaurer la configuration. Veuillez rééssayer plus tard.",
+  "page.settings.notification.restart.success": "L'application a été redémarrée avec succès",
+  "page.settings.notification.restart.error": "Le redémarrage de votre application a échoué. Essayez de le faire manuellement.",
+  "page.settings.loading": "Récupération de la configuration...",
+  "compontents.confirmation.dialog.header": "Confirmation",
+  "compontents.confirmation.dialog.description": "Voulez-vous vraiment effectuer cette action ?",
+  "compontents.confirmation.dialog.button.confirm": "Oui, je le veux",
+  "compontents.confirmation.dialog.button.cancel": "Annuler",
+  "compontents.toogle.enabled": "Activé",
+  "compontents.toogle.disabled": "Désactivé"
+}