strapi-plugin-comments 2.0.1 → 2.0.2

package/README.md

@@ -37,10 +37,10 @@ A plugin for [Strapi Headless CMS](https://github.com/strapi/strapi) that provid
 
 - **Comments Public REST + GraphQL API:** Elegant, entirely customizable and a fully extensible admin panel.
 - **Strapi & generic users:** Support for built-in & also generic non-Strapi users that might be the comments authors.
-- **Any Content Type relation:** Comments can by linked to any of your Content Types by default. Simply, you're controlling it.
+- **Any Content Type relation:** Comments can be linked to any of your Content Types by default. Simply, you're controlling it.
 - **Moderation Panel:** Search & Filter through the bucket with your auditory comments. Manage them by blocking single ones or full threads. All in combined list & hierarchical tree view of threads.
-- **Automated Bad Words filtering:** By detault end users are not allowed to post abusing comments where bad words have been used.
-- **Abuse Reporting & Reviewing:** Don't allow inferior language, react to reports from your community, send email notifiactions about abuse reports
+- **Automated Bad Words filtering:** By default end users are not allowed to post abusing comments where bad words have been used.
+- **Abuse Reporting & Reviewing:** Don't allow inferior language, react to reports from your community, send email notifications about issued reports
 
 ## ⚙️ Versions
 
@@ -203,7 +203,7 @@ Feature / Capability focused permissions:
 
 `GET <host>/api/comments/api::<collection name>.<content type name>:<entity id>`
 
-Return a hierarchical tree structure of comments for specified instance of Content Type like for example `Page` with `ID: 1`
+Return a hierarchical tree structure of comments for specified instance of Content Type like for example `Page` with `ID: 1`.
 
 **Example URL**: `https://localhost:1337/comments/api::page.page:1`
 
@@ -226,6 +226,8 @@ Return a hierarchical tree structure of comments for specified instance of Conte
     // ...
 ]
 ```
+#### Strapi REST API properties support:
+- [sorting](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest/sort-pagination.html#sorting)
 
 ### Get Comments (flat structure)
 
@@ -255,6 +257,11 @@ Return a flat structure of comments for specified instance of Content Type like
 - `200` - Successful. Response with list of comments (can be empty)
 - `400` - Bad Request. Requested list for not valid / not existing Content Type
 
+#### Strapi REST API properties support:
+- [filtering](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest/filtering-locale-publication.html#filtering)
+- [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)
+
 ### Post a Comment
 
 *GraphQL equivalent: [Public GraphQL API -> Post a Comments](#post-a-comment-1)*
@@ -460,6 +467,9 @@ query {
   }
 ```
 
+#### Strapi GraphQL API properties support:
+- [sorting](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/graphql-api.html#sorting)
+
 ### Get Comments (flat structure)
 
 *REST API equivalent: [Public REST API -> Get Comments (flat structure)](#get-comments-flat-structure)*
@@ -516,6 +526,11 @@ query {
 }
 ```
 
+#### Strapi GraphQL API properties support:
+- [filtering](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/graphql-api.html#filters)
+- [sorting](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/graphql-api.html#sorting)
+- [pagination](https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/graphql-api.html#pagination)
+
 ### Post a Comment
 
 *REST API equivalent: [Public REST API -> Post a Comment](#post-a-comment)*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-comments",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Strapi - Comments plugin",
   "strapi": {
     "name": "comments",

package/server/controllers/client.js

@@ -11,23 +11,23 @@ module.exports = {
   },
 
   async findAllFlat(ctx) {
-    const { params = {}, query } = ctx;
+    const { params = {}, query, sort, pagination } = ctx;
     const { relation } = parseParams(params);
     try {
       return this.getService('common')
-        .findAllFlat(flatInput(relation, query));
+        .findAllFlat(flatInput(relation, query, sort, pagination));
     } catch (e) {
       throwError(ctx, e);
     }
   },
 
   async findAllInHierarchy(ctx) {
-    const { params = {}, query } = ctx;
+    const { params = {}, query, sort } = ctx;
     const { relation } = parseParams(params);
     try {
       return await this.getService('common')
         .findAllInHierarchy({
-          ...flatInput(relation, query),
+          ...flatInput(relation, query, sort),
           dropBlockedThreads: true,
         });
     } catch (e) {

package/server/controllers/utils/parsers.js

@@ -1,7 +1,7 @@
 'use strict'
 
 module.exports = {
-    flatInput(relation, query) {
+    flatInput(relation, query, sort, pagination) {
         return {
             query: {
               ...query,
@@ -13,6 +13,8 @@ module.exports = {
                 populate: { authorUser: true },
               },
             },
+            pagination,
+            sort,
           };
     },
   

package/server/graphql/queries/findAllFlat.js

@@ -18,11 +18,13 @@ module.exports = ({ strapi, nexus }) => {
 			sort: args.SortArg,
 		},
 		async resolve(obj, args) {
-			const { relation, filters } = args;
+			const { relation, filters, sort, pagination } = args;
 			return await getPluginService('common')
 				.findAllFlat(flatInput(
 					relation, 
-					getPluginService('gql').graphQLFiltersToStrapiQuery(filters, contentType)
+					getPluginService('gql').graphQLFiltersToStrapiQuery(filters, contentType),
+					sort,
+					pagination
 				), undefined);
 		},
 	};

package/server/graphql/queries/findAllInHierarchy.js

@@ -13,16 +13,16 @@ module.exports = ({ strapi, nexus }) => {
 		type: nonNull(list('CommentNested')),
 		args: {
 			relation: nonNull(stringArg()),
-			// filters: filtersArg,
 			sort: args.SortArg,
 		},
 		async resolve(obj, args) {
-			const { relation, filters } = args;
+			const { relation, filters, sort } = args;
 			return await getPluginService('common')
 				.findAllInHierarchy({
 					...flatInput(
 						relation, 
-						getPluginService('gql').graphQLFiltersToStrapiQuery(filters, contentType)
+						getPluginService('gql').graphQLFiltersToStrapiQuery(filters, contentType),
+						sort
 					),
 					dropBlockedThreads: true,
 				});

package/server/services/common.js

@@ -1,7 +1,8 @@
 'use strict';
 
 const BadWordsFilter = require('bad-words');
-const { isArray, isNumber, isObject, isNil, first, parseInt } = require('lodash');
+const { isArray, isNumber, isObject, isNil, isString, first, parseInt, set } = require('lodash');
+const { REGEX } = require('../utils/constants');
 const PluginError = require('./../utils/error');
 const {
     getModelUid,
@@ -27,12 +28,39 @@ module.exports = ({ strapi }) => ({
     },
 
     // Find comments in the flat structure
-    async findAllFlat({ query = {}, populate = {} }, relatedEntity = null) {
+    async findAllFlat({ 
+        query = {}, 
+        populate = {}, 
+        sort, 
+        pagination }, relatedEntity = null) {
 
         const defaultPopulate = {
             authorUser: true,
         };
 
+        let queryExtension = {};
+
+        if (sort && (isString(sort) || isArray(sort))) {
+            queryExtension = {
+                ...queryExtension,
+                orderBy: (isString(sort) ? [sort] : sort)
+                .map(_ => REGEX.sorting.test(_) ? _ : `${_}:asc`)
+                .reduce((prev, curr) => {
+                    const [type = 'asc', ...parts] = curr.split(':').reverse();
+                    return { ...set(prev, parts.reverse().join('.'), type) };
+                }, {})
+            };
+        }
+
+        if (pagination && isObject(pagination)) {
+            const { page = 1, pageSize = 10 } = pagination;
+            queryExtension = {
+                ...queryExtension,
+                offset: (page - 1) * pageSize,
+                limit: pageSize,
+            };
+        }
+        
         const entries = await strapi.db.query(getModelUid('comment'))
         .findMany({
             where: {
@@ -42,6 +70,7 @@ module.exports = ({ strapi }) => ({
                 ...defaultPopulate,
                 ...populate,
             },
+            ...queryExtension,
         });
 
         const entriesWithThreads = await Promise.all(entries.map(async _ => {
@@ -76,10 +105,11 @@ module.exports = ({ strapi }) => ({
     async findAllInHierarchy ({
         query,
         populate = {},
+        sort,
         startingFromId = null,
         dropBlockedThreads = false,
     }, relatedEntity) {
-        const entities = await this.findAllFlat({ query, populate }, relatedEntity);
+        const entities = await this.findAllFlat({ query, populate, sort }, relatedEntity);
         return buildNestedStructure(entities, startingFromId, 'threadOf', dropBlockedThreads, false);
     },
 
@@ -116,7 +146,7 @@ module.exports = ({ strapi }) => ({
             Object.entries(data)
             .map(async ([relatedUid, relatedStringIds]) => 
                 strapi.db.query(relatedUid).findMany({ 
-                    where: { id: Array.from(new Set(relatedStringIds)) } 
+                    where: { id: Array.from(new Set(relatedStringIds)) },
                 }).then(relatedEntities => relatedEntities.map(_ => 
                     ({
                         ..._,

package/server/utils/constants.js

@@ -8,6 +8,7 @@ const REGEX = {
   uid: /^(?<type>[a-z0-9-]+)\:{2}(?<api>[a-z0-9-]+)\.{1}(?<contentType>[a-z0-9-]+)$/i,
   relatedUid: /^(?<uid>[a-z0-9-]+\:{2}[a-z0-9-]+\.[a-z0-9-]+)\:{1}(?<id>[a-z0-9-]+)$/i,
   email: /\S+@\S+\.\S+/,
+  sorting: /^(?<path>[a-z0-9-_\:\.]+)\:+(asc|desc)$/i
 };
 
 module.exports = {

package/.circleci/config.yml

@@ -1,48 +0,0 @@
-version: 2.1
-orbs:
-  codecov: codecov/codecov@1.1.1
-jobs:
-  build-and-test:
-    environment:
-      CODECOV_TOKEN: 02e2d4e8-88c4-4e5d-99da-a9a2888634c6
-    docker:
-      - image: circleci/node:14.17.3
-    working_directory: ~/repo
-    steps:
-      - checkout
-      - run:
-          name: set GIT name and email
-          command: |
-            git config --global -l
-            git config --global user.email "$GIT_COMMITTER_EMAIL"
-            git config --global user.name "$GIT_COMMITTER_NAME"
-            git config --global -l
-      - restore_cache:
-          keys:
-            # when lock file changes, use increasingly general patterns to restore cache
-            - strapi-plugin-comments-v2-{{ checksum "yarn.lock" }}
-            - strapi-plugin-comments-
-      - run:
-          name: Echo versions
-          command: |
-            node --version
-            yarn --version
-      - run:
-          name: Install
-          command: |
-            yarn install
-      - run:
-          name: Test
-          command: |
-            yarn test:unit
-      - codecov/upload:
-          flags: unittest
-          file:
-      - save_cache:
-          paths:
-            - ./node_modules
-          key: strapi-plugin-comments-v2-{{ checksum "yarn.lock" }}
-workflows:
-    build-and-test:
-      jobs:
-        - build-and-test

package/.eslintrc

@@ -1,35 +0,0 @@
-{
-  "parserOptions": {
-    "jsx": true,
-    "useJSXTextNode": true,
-    "sourceType": "module"
-  },
-  "plugins": ["react-hooks", "import"],
-  "rules": {
-    "no-console": "warn",
-    "curly": "warn",
-    "prefer-template": "warn",
-
-    "react-hooks/rules-of-hooks": "error",
-    "react-hooks/exhaustive-deps": "error",
-
-    "import/no-default-export": "warn",
-    "import/newline-after-import": "warn",
-    "import/order": [
-      "warn",
-      {
-        "newlines-between": "always",
-        "alphabetize": { "order": "asc" },
-        "pathGroupsExcludedImportTypes": ["builtin"],
-        "groups": [
-          "builtin",
-          "external",
-          "internal",
-          "parent",
-          "sibling",
-          "index"
-        ]
-      }
-    ]
-  }
-}

package/.github/pull_request_template.md

@@ -1,13 +0,0 @@
-## Ticket
-
-https://github.com/VirtusLab/strapi-plugin-comments/issues/-<your-ticket-#>
-
-## Summary
-
-What does this PR do/solve? 
-
-> PRs should be as small as they need to be, if this section starts becoming a novel you should _seriously_ consider breaking it up into multiple PRs
-
-## Test Plan
-
-How are you testing the work you're submitting?

package/.nvmrc

@@ -1 +0,0 @@
-v14.17.3

package/codecov.yml

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