strapi-plugin-comments 2.0.5 → 2.0.6

package/README.md

@@ -84,7 +84,7 @@ In our minimum support we're following [official Node.js releases timelines](htt
 
 **Supported Strapi versions**:
 
-- Strapi v4.0.8 (recently tested)
+- Strapi v4.1.0 (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).
@@ -109,6 +109,8 @@ To setup amend default plugin configuration we recommend to put following snippe
     module.exports = ({ env }) => ({
         //...
         comments: {
+          enabled: true,
+          config: {
             badWords: false,
             moderatorRoles: ["Authenticated"],
             approvalFlow: ['api::page.page'],
@@ -122,6 +124,7 @@ To setup amend default plugin configuration we recommend to put following snippe
             gql: { 
               // ...
             },
+          },
         },
         //...
     });
@@ -144,8 +147,8 @@ All you need to do is to install and enable `@strapi/plugin-graphql` for you ins
 ```json
   {
     // ...
-    gql: {
-      auth: true, // Default: false
+    "gql": {
+      "auth": true, // Default: false
     },
     // ...
   }
@@ -226,10 +229,10 @@ Return a hierarchical tree structure of comments for specified instance of Conte
 [
     {
         // -- Comment Model fields ---,
-        children: [
+        "children": [
             {
                 // -- Comment Model fields ---,
-                children: [
+                "children": [
                     // ...
                 ]
             },
@@ -255,7 +258,8 @@ Return a flat structure of comments for specified instance of Content Type like
 **Example response body**
 
 ```json
-[
+{
+  "data": [
     {
         // -- Comment Model fields ---
     },
@@ -263,7 +267,13 @@ Return a flat structure of comments for specified instance of Content Type like
         // -- Comment Model fields ---
     },
     // ...
-]
+  ],
+  "meta": {
+    "pagination": {
+      // payload based on Strapi REST Pagination specification
+    }
+  }
+}
 ```
 
 **Possible response codes**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-comments",
-  "version": "2.0.5",
+  "version": "2.0.6",
   "description": "Strapi - Comments plugin",
   "strapi": {
     "name": "comments",
@@ -18,8 +18,8 @@
     "url": "https://github.com/VirtusLab-Open-Source/strapi-plugin-comments"
   },
   "dependencies": {
-    "@strapi/utils": "^4.0.8",
-    "@strapi/plugin-graphql": "^4.0.8",
+    "@strapi/utils": "^4.1.0",
+    "@strapi/plugin-graphql": "^4.1.0",
     "bad-words": "^3.0.4"
   },
   "devDependencies": {

package/server/graphql/queries/findAllFlat.js

@@ -10,7 +10,7 @@ module.exports = ({ strapi, nexus }) => {
 	const { args } = getService('internals');
 
 	return {
-		type: nonNull(list('CommentSingle')),
+		type: 'ResponseFindAll',
 		args: {
 			relation: nonNull(stringArg()),
 			filters: getPluginService('gql').buildContentTypeFilters(contentType),

package/server/graphql/types/index.js

@@ -11,6 +11,9 @@ const typesFactories = [
 	require('./report'),
 	require('./report-reason'),
 	require('./create-report'),
+	require('./response-pagination'),
+	require('./response-meta'),
+	require('./response-find-all'),
 ];
 
 module.exports = context => typesFactories.map(factory => factory(context));

package/server/graphql/types/response-find-all.js

@@ -0,0 +1,7 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "ResponseFindAll",
+  definition(t) {
+    t.list.field("data", { type: 'CommentSingle' })
+    t.field("meta", { type: 'ResponseMeta' })
+  }
+})

package/server/graphql/types/response-meta.js

@@ -0,0 +1,6 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "ResponseMeta",
+  definition(t) {
+    t.field("pagination", { type: 'ResponsePagination' })
+  }
+})

package/server/graphql/types/response-pagination.js

@@ -0,0 +1,11 @@
+module.exports = ({ nexus }) => nexus.objectType({
+  name: "ResponsePagination",
+  definition(t) {
+    t.int('page')
+    t.int('pageSize')
+    t.int('pageCount')
+    t.int('total')
+    t.int('start')
+    t.int('limit')
+  }
+})

package/server/services/common.js

@@ -68,12 +68,35 @@ module.exports = ({ strapi }) => ({
             };
         }
 
+        let meta = {};
         if (pagination && isObject(pagination)) {
-            const { page = 1, pageSize = 10 } = pagination;
+            const parsedPagination = Object.keys(pagination).reduce((prev, curr) => ({
+                ...prev,
+                [curr]: parseInt(pagination[curr]),
+            }), {});
+            const { page, pageSize = 10, limit, start = 0 } = parsedPagination
+            const paginationByPage = !isNil(page);
+
             queryExtension = {
                 ...queryExtension,
-                offset: (page - 1) * pageSize,
-                limit: pageSize,
+                offset: paginationByPage ? (page - 1) * pageSize : start,
+                limit: paginationByPage ? pageSize : limit,
+            };
+
+            const metaPagination = paginationByPage ? {
+                pagination: {
+                    page,
+                    pageSize,
+                },
+            } : {
+                pagination: {
+                    start,
+                    limit,
+                },
+            };
+
+            meta = {
+                ...metaPagination,
             };
         }
         
@@ -89,6 +112,26 @@ module.exports = ({ strapi }) => ({
             ...queryExtension,
         });
 
+        if (pagination?.withCount && (pagination.withCount === 'true' || pagination.withCount === true)) {
+            const total = await strapi.db.query(getModelUid('comment'))
+                .count({
+                    where: {
+                        ...query,
+                    }
+                });
+            const pageCount = Math.floor(total / meta.pagination.pageSize);
+            meta = {
+                ...meta,
+                pagination: {
+                    ...meta.pagination,
+                    pageCount: !isNil(meta.pagination.page) ? 
+                        total % meta.pagination.pageSize === 0 ? pageCount : pageCount + 1 : 
+                        undefined,
+                    total,
+                },
+            };
+        }
+
         const entriesWithThreads = await Promise.all(entries.map(async _ => {
             const [nestedEntries, count] = await strapi.db.query(getModelUid('comment'))
                 .findWithCount({ 
@@ -112,9 +155,15 @@ module.exports = ({ strapi }) => ({
             });
 
         if (relatedEntities.filter(_ => _).length > 0) {
-            return result.map(_ => this.mergeRelatedEntityTo(_, relatedEntities));
+            return {
+                data: result.map(_ => this.mergeRelatedEntityTo(_, relatedEntities)),
+                meta,
+            };     
         }
-        return result;    
+        return {
+            data: result,
+            meta,
+        };    
     },
 
     // Find comments and create relations tree structure
@@ -125,7 +174,7 @@ module.exports = ({ strapi }) => ({
         startingFromId = null,
         dropBlockedThreads = false,
     }, relatedEntity) {
-        const entities = await this.findAllFlat({ query, populate, sort }, relatedEntity);
+        const entities = await this.findAllFlat({ query, populate, sort }, relatedEntity)?.data;
         return buildNestedStructure(entities, startingFromId, 'threadOf', dropBlockedThreads, false);
     },