strapi-plugin-comments 2.0.10 → 2.1.0

package/types/contentTypes.d.ts

@@ -0,0 +1,48 @@
+import { OnlyStrings, StrapiUser, StringMap } from "strapi-typed";
+export declare type Id = number | string;
+export declare type Comment<TAuthor = CommentAuthor> = {
+    id: Id;
+    content: string;
+    author?: TAuthor;
+    children?: Array<Comment>;
+    reports?: Array<CommentReport>;
+    threadOf: Comment | number | null;
+    gotThread?: boolean;
+    related?: any;
+    blocked?: boolean;
+    blockedThread?: boolean;
+    itemsInTread?: number;
+    approvalStatus?: CommentApprovalStatus | null;
+    firstThreadItemId?: Id;
+    threadFirstItemId?: Id;
+} & CommentAuthorPartial;
+export declare type CommentModelKeys = OnlyStrings<keyof Comment>;
+declare type CommentApprovalStatus = "PENDING" | "APPROVED" | "REJECTED";
+export declare type CommentAuthor = {
+    id: Id;
+    name?: string;
+    email?: string;
+    avatar?: string | object;
+};
+export declare type CommentAuthorPartial = {
+    authorId?: Id;
+    authorName?: string;
+    authorEmail?: string;
+    authorAvatar?: string;
+    authorUser?: StrapiUser;
+};
+export declare type CommentAuthorResolved<TExtension = StringMap<unknown>> = CommentAuthor & TExtension;
+export declare type CommentReport = {
+    id: Id;
+    related: Comment | Id;
+    reason: any;
+    content: string;
+    resolved: boolean;
+};
+export declare type RelatedEntity = {
+    id: Id;
+    uid: string;
+    requireCommentsApproval?: boolean;
+};
+export {};
+//# sourceMappingURL=contentTypes.d.ts.map

package/types/contentTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=contentTypes.js.map

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn test:unit

package/LICENSE.md

@@ -1,7 +0,0 @@
-Copyright (c) 2021 VirtusLab Sp. z o.o. & Strapi Solutions.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/__mocks__/initSetup.js

@@ -1,108 +0,0 @@
-const { get, set, isEmpty } = require('lodash');
-
-module.exports = (config = {}, toStore = false, database = {}) => {
-  const dbConfig = toStore ? {
-    plugin: {
-      comments: {
-        config: { ...config },
-      },
-    },
-  }: {};
-
-  let mock = {
-    db: {
-      query: (uid) => {
-        const [handler, rest] = uid.split('::');
-        const [collection] = rest.split('.');
-        const values = get(mock.db, `${handler}.${collection}.records`, []);
-        return {
-          findOne: async () => new Promise(resolve => resolve(values[0])),
-          findMany: async () => new Promise(resolve => resolve(values)),
-          findWithCount: async () => new Promise(resolve => resolve([values, values.length])),
-          count: async () => new Promise(resolve => resolve(values.length)),
-          create: async (value) => new Promise(resolve => resolve(value)), 
-          update: async (value) => new Promise(resolve => resolve(value)), 
-          delete: async (value) => new Promise(resolve => resolve(value)),
-        };
-      },
-      ...dbConfig,
-    },
-    getRef: function() {
-      return this;
-    },
-    plugin: function(name) {
-      return this.plugins[name];
-    },
-    store: async function(storeProps) {
-      const { type, name } = storeProps; // { type: 'plugin', name: 'comments' }
-
-      const mockedStore = {
-        get: async function(props) { // { key: 'config' }
-          const { key } = props;
-          return new Promise(resolve => resolve(get(mock.db, `${type}.${name}.${key}`, undefined)));
-        },
-        set: async function(props) { // { key: 'config', value: {...} }
-          const { key, value } = props;
-          set(mock.db, `${type}.${name}.${key}`, value);
-          return this.get(key);
-        },
-        delete: async function(props) { // { key: 'config' }
-          const { key } = props;
-          set(mock.db, `${type}.${name}.${key}`, undefined);
-          return new Promise(resolve => resolve(true));
-        },
-      };
-
-      return new Promise(resolve => resolve(mockedStore));
-    },
-    plugins: {
-      comments: {
-        service: function(name) {
-            return this.services[name]({ strapi: mock.getRef() });
-        },
-        package: require('../package.json'),
-        services: {
-          common: require('../server/services/common'),
-          client: require('../server/services/client'),
-          admin: require('../server/services/admin'),
-        },
-        contentTypes: {
-          comment: {
-            ...require('../content-types/comment'),
-            uid: 'plugins::comments.comment',
-          },
-          'comment-report': {
-            ...require('../content-types/report'),
-            uid: 'plugins::comments.comment-report'
-          },
-        }
-      }
-    },
-    config: {
-      get: function(prop = '') {
-        return get(this.plugins, prop.replace('plugin.', ''));
-      },
-      set: function(prop = '', value) {
-        return set(this.plugins, prop.replace('plugin.', ''), value);
-      },
-      plugins: {
-        comments: {
-          approvalFlow: ['api::blog-post.blog-post'],
-          entryLabel: {
-            'api::blog-post.blog-post': ['alternative_subject'],
-          },
-          ...(toStore ? {} : config)
-        }
-      }
-    }
-  };
-
-  if (!isEmpty(database)) {
-    Object.keys(database).forEach((uid) => {
-      const [handler, collection] = uid.split('::');
-      set(mock.db, `${handler}.${collection}.records`, database[uid]);
-    });
-  }
-
-  return mock;
-};

package/jest.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  name: 'Unit test',
-  testMatch: ['**/__tests__/?(*.)+(spec|test).js'],
-  transform: {},
-  coverageDirectory: "./coverage/",
-  collectCoverage: true,
-};

package/server/controllers/utils/__tests__/functions.test.js

@@ -1,43 +0,0 @@
-const PluginError = require('../../../utils/error');
-const ctx = require('koa/lib/context');
-const { throwError } = require('../functions');
-
-jest.mock
-
-describe('Test Comments controller functions utils', () => {
-  
-  describe('Errors serialization', () => {
-    test('Should throw error PluginError', () => {
-      try {
-        throw new PluginError(400, 'Error message', {
-          content: {
-            param: 'Parameter value'
-          }
-        });
-      } catch (e) {
-        expect(e).toBeInstanceOf(PluginError);
-        expect(e).toHaveProperty('status', 400);
-        expect(e).toHaveProperty('name', 'Strapi:Plugin:Comments');
-        expect(e).toHaveProperty('message', 'Error message');
-        expect(e).toHaveProperty('payload');
-        expect(e.payload).toEqual(expect.objectContaining({
-          content: {
-            param: 'Parameter value'
-          }
-        }));
-
-        try {
-          throwError(ctx, e);
-        } catch (eFinal) {
-          const stringifiedError = eFinal.toString();
-          expect(stringifiedError.includes('BadRequestError')).toEqual(true);
-          expect(stringifiedError.includes('Strapi:Plugin:Comments')).toEqual(true);
-          expect(stringifiedError.includes('Error message')).toEqual(true);
-          expect(stringifiedError.includes('Strapi:Plugin:Comments')).toEqual(true);
-          expect(stringifiedError.includes('content')).toEqual(true);
-          expect(stringifiedError.includes('Parameter value')).toEqual(true);
-        }
-      }
-    });
-  });
-});

package/server/controllers/utils/__tests__/parsers.test.js

@@ -1,94 +0,0 @@
-const { flatInput } = require('../parsers');
-
-jest.mock
-
-describe('Test Comments controller parsers utils', () => {
-  
-  describe('Flat Input properties', () => {
-    const relation = 'api::test.relation';
-    const filters = {
-      content: {
-        '$eq': 'Test'
-      }
-    };
-    const sort = {
-      createdAt: 'desc'
-    };
-    const pagination = {
-      page: 3,
-      pageSize: 5,
-    };
-
-    test('Should contain default property \'populate\'', () => {
-      expect(flatInput()).toHaveProperty(['populate', 'threadOf', 'populate', 'authorUser'], true);
-    });
-
-    test('Should assign relation to \'query\'', () => {
-      expect(flatInput(relation)).toHaveProperty(['query', 'related'], relation);
-    });
-
-    test('Should assign filters to \'query\'', () => {
-      const result = flatInput(relation, filters);
-      expect(result).toHaveProperty(['query', 'content', '$eq'], filters.content['$eq']);
-    });
-
-    test('Should assign not allow to overwrite \'removed\' in $or operator', () => {
-      const overwrittenOrOperator = {
-        $or: [{ removed: true }, { removed: false }, { removed: null }]
-      };
-      const result = flatInput(relation, overwrittenOrOperator);
-      expect(result).toHaveProperty(['query', '$or', 0, 'removed', '$null'], true);
-      expect(result).toHaveProperty(['query', '$or', 1, 'removed'], false);
-    });
-
-    test('Should assign sort', () => {
-      const result = flatInput(relation, filters, sort);
-      expect(result).toHaveProperty(['sort', 'createdAt'], sort.createdAt);
-    });
-
-    test('Should assign pagination', () => {
-      const result = flatInput(relation, filters, sort, pagination);
-      expect(result).toHaveProperty(['pagination', 'page'], pagination.page);
-      expect(result).toHaveProperty(['pagination', 'pageSize'], pagination.pageSize);
-    });
-
-    test('Should build complex output', () => {
-      const day = 24 * 60 * 60 * 1000;
-      const now = Date.now().toString();
-      const oneDayBefore = new Date(Date.now().valueOf() - day).toString();
-      const complexFilters = {
-        '$or': [{
-          createdAt: {
-            '$lte':  oneDayBefore
-          }
-        }, {
-          createdAt: {
-            '$eq':  now
-          }
-        }],
-        content: {
-          '$contains': 'Test'
-        }
-      };
-
-      const complexSort = [{
-        createdAt: 'desc'
-      }, {
-        title: 'asc'
-      }];
-
-      const result = flatInput(relation, complexFilters, complexSort, pagination);
-
-      expect(result).toHaveProperty(['query', 'related'], relation);
-      expect(result).toHaveProperty(['query', '$or', 0, 'createdAt', '$lte'], oneDayBefore);
-      expect(result).toHaveProperty(['query', '$or', 1, 'createdAt', '$eq'], now);
-      expect(result).toHaveProperty(['query', '$or', 2, 'removed', '$null'], true);
-      expect(result).toHaveProperty(['query', '$or', 3, 'removed'], false);
-      expect(result).toHaveProperty(['query', 'content', '$contains'], complexFilters.content['$contains']);
-      expect(result).toHaveProperty(['sort', 0, 'createdAt'], complexSort[0].createdAt);
-      expect(result).toHaveProperty(['sort', 1, 'title'], complexSort[1].title);
-      expect(result).toHaveProperty(['pagination', 'page'], pagination.page);
-      expect(result).toHaveProperty(['pagination', 'pageSize'], pagination.pageSize);
-    });
-  });
-});