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

package/server/graphql/types/comment-author.ts

@@ -0,0 +1,12 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.objectType({
+    name: "CommentAuthor",
+    definition(t: INexusType) {
+      t.id("id");
+      t.nonNull.string("name");
+      t.string("email");
+      t.string("avatar");
+    },
+  });

package/server/graphql/types/comment-nested.ts

@@ -0,0 +1,19 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.objectType({
+    name: "CommentNested",
+    definition(t: INexusType) {
+      t.id("id");
+      t.nonNull.string("content");
+      t.boolean("blocked");
+      t.boolean("blockedThread");
+      t.string("approvalStatus");
+      t.boolean("removed");
+      t.field("threadOf", { type: "CommentSingle" });
+      t.list.field("children", { type: "CommentNested" });
+      t.field("author", { type: "CommentAuthor" });
+      t.string("createdAt");
+      t.string("updatedAt");
+    },
+  });

package/server/graphql/types/comment.ts

@@ -0,0 +1,18 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.objectType({
+    name: "CommentSingle",
+    definition(t: INexusType) {
+      t.id("id");
+      t.nonNull.string("content");
+      t.boolean("blocked");
+      t.boolean("blockedThread");
+      t.boolean("removed");
+      t.string("approvalStatus");
+      t.field("threadOf", { type: "CommentSingle" });
+      t.field("author", { type: "CommentAuthor" });
+      t.string("createdAt");
+      t.string("updatedAt");
+    },
+  });

package/server/graphql/types/create-comment-author.ts

@@ -0,0 +1,12 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.inputObjectType({
+    name: "CreateCommentAuthor",
+    definition(t: INexusType) {
+      t.nonNull.id("id");
+      t.nonNull.string("name");
+      t.string("email");
+      t.string("avatar");
+    },
+  });

package/server/graphql/types/create-comment.ts

@@ -0,0 +1,12 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.inputObjectType({
+    name: "CreateComment",
+    definition(t: INexusType) {
+      t.nonNull.string("content");
+      t.nonNull.string("relation");
+      t.id("threadOf");
+      t.field("author", { type: "CreateCommentAuthor" });
+    },
+  });

package/server/graphql/types/create-report.ts

@@ -0,0 +1,12 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.inputObjectType({
+    name: "CreateReport",
+    definition(t: INexusType) {
+      t.id("commentId");
+      t.nonNull.string("relation");
+      t.nonNull.string("content");
+      t.field("reason", { type: "ReportReason" });
+    },
+  });

package/server/graphql/types/id.ts

@@ -0,0 +1,28 @@
+import { Primitive } from "strapi-typed";
+import { NexusAst, StrapiGraphQLContext } from "../../../types";
+
+const { isNumber, parseInt } = require("lodash");
+const { Kind } = require("graphql");
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.scalarType({
+    name: "Id",
+    asNexusMethod: "id",
+    description: "Id as string or int",
+    parseValue(value: Primitive) {
+      const parsedValue = parseInt(value);
+      if (isNumber(parsedValue)) {
+        return parsedValue;
+      }
+      return value;
+    },
+    serialize(value: Primitive) {
+      return value;
+    },
+    parseLiteral(ast: NexusAst) {
+      if ([Kind.INT, Kind.STRING].includes(ast.kind)) {
+        return ast.value;
+      }
+      return null;
+    },
+  });

package/server/graphql/types/identify-comment-author.ts

@@ -0,0 +1,9 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.inputObjectType({
+    name: "IdentifyCommentAuthor",
+    definition(t: INexusType) {
+      t.nonNull.id("id");
+    },
+  });

package/server/graphql/types/index.ts

@@ -0,0 +1,38 @@
+import { StrapiGraphQLContext } from "../../../types";
+
+import Id from "./id";
+import Comment from "./comment";
+import CommentNested from "./comment-nested";
+import CommentAuthor from "./comment-author";
+import CreateComment from "./create-comment";
+import CreateCommentAuthor from "./create-comment-author";
+import UpdateComment from "./update-comment";
+import RemoveComment from "./remove-comment";
+import IdentifyCommentAuthor from "./identify-comment-author";
+import Report from "./report";
+import ReportReason from "./report-reason";
+import CreateReport from "./create-report";
+import ResponsePagination from "./response-pagination";
+import ResponseMeta from "./response-meta";
+import ResponseFindAll from "./response-find-all";
+
+const typesFactories = [
+  Id,
+  Comment,
+  CommentNested,
+  CommentAuthor,
+  CreateComment,
+  CreateCommentAuthor,
+  UpdateComment,
+  RemoveComment,
+  IdentifyCommentAuthor,
+  Report,
+  ReportReason,
+  CreateReport,
+  ResponsePagination,
+  ResponseMeta,
+  ResponseFindAll,
+];
+
+export = (context: StrapiGraphQLContext) =>
+  typesFactories.map((factory) => factory(context));

package/server/graphql/types/remove-comment.ts

@@ -0,0 +1,11 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.inputObjectType({
+    name: "RemoveComment",
+    definition(t: INexusType) {
+      t.id("id");
+      t.nonNull.string("relation");
+      t.field("author", { type: "IdentifyCommentAuthor" });
+    },
+  });

package/server/graphql/types/report-reason.ts

@@ -0,0 +1,12 @@
+import { StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus, config }: StrapiGraphQLContext) => {
+  const { reportReasons } = config;
+  return nexus.enumType({
+    name: "ReportReason",
+    description: "Reason of abuse report",
+    members: {
+      ...reportReasons,
+    },
+  });
+};

package/server/graphql/types/report.ts

@@ -0,0 +1,14 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.objectType({
+    name: "Report",
+    definition(t: INexusType) {
+      t.id("id");
+      t.nonNull.string("content");
+      t.field("reason", { type: "ReportReason" });
+      t.field("related", { type: "CommentSingle" });
+      t.string("createdAt");
+      t.string("updatedAt");
+    },
+  });

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

@@ -0,0 +1,10 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.objectType({
+    name: "ResponseFindAll",
+    definition(t: INexusType) {
+      t.list.field("data", { type: "CommentSingle" });
+      t.field("meta", { type: "ResponseMeta" });
+    },
+  });

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

@@ -0,0 +1,9 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.objectType({
+    name: "ResponseMeta",
+    definition(t: INexusType) {
+      t.field("pagination", { type: "ResponsePagination" });
+    },
+  });

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

@@ -0,0 +1,14 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.objectType({
+    name: "ResponsePagination",
+    definition(t: INexusType) {
+      t.int("page");
+      t.int("pageSize");
+      t.int("pageCount");
+      t.int("total");
+      t.int("start");
+      t.int("limit");
+    },
+  });

package/server/graphql/types/update-comment.ts

@@ -0,0 +1,12 @@
+import { INexusType, StrapiGraphQLContext } from "../../../types";
+
+export = ({ nexus }: StrapiGraphQLContext) =>
+  nexus.inputObjectType({
+    name: "UpdateComment",
+    definition(t: INexusType) {
+      t.id("id");
+      t.nonNull.string("content");
+      t.nonNull.string("relation");
+      t.field("author", { type: "IdentifyCommentAuthor" });
+    },
+  });

package/server/index.ts

@@ -0,0 +1,20 @@
+import register from "./register";
+import bootstrap from "./bootstrap";
+import destroy from "./destroy";
+import config from "./config";
+import controllers from "./controllers";
+import routes from "./routes";
+import services from "./services";
+
+export default {
+  register,
+  bootstrap,
+  destroy,
+  config,
+  controllers,
+  routes,
+  services,
+  contentTypes: {},
+  policies: {},
+  middlewares: {},
+};

package/server/register.ts

@@ -0,0 +1,3 @@
+export = () => {
+  // register phase
+};

package/server/routes/admin.ts

@@ -0,0 +1,118 @@
+import { StrapiRoute } from "strapi-typed";
+
+const routes: StrapiRoute[] = [
+  {
+    method: "GET",
+    path: "/moderate/config",
+    handler: "admin.config",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "GET",
+    path: "/moderate/all",
+    handler: "admin.findAll",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "GET",
+    path: "/moderate/single/:id",
+    handler: "admin.findOne",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "PATCH",
+    path: "/moderate/single/:id/approve",
+    handler: "admin.approveComment",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "PATCH",
+    path: "/moderate/single/:id/reject",
+    handler: "admin.rejectComment",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "PATCH",
+    path: "/moderate/single/:id/block",
+    handler: "admin.blockComment",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "PATCH",
+    path: "/moderate/single/:id/unblock",
+    handler: "admin.unblockComment",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "PATCH",
+    path: "/moderate/single/:id/report/:reportId/resolve",
+    handler: "admin.resolveAbuseReport",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "PATCH",
+    path: "/moderate/thread/:id/block",
+    handler: "admin.blockCommentThread",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "PATCH",
+    path: "/moderate/thread/:id/unblock",
+    handler: "admin.unblockCommentThread",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "GET",
+    path: "/settings/config",
+    handler: "admin.settingsConfig",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "PUT",
+    path: "/settings/config",
+    handler: "admin.settingsUpdateConfig",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "DELETE",
+    path: "/settings/config",
+    handler: "admin.settingsRestoreConfig",
+    config: {
+      policies: [],
+    },
+  },
+  {
+    method: "GET",
+    path: "/settings/restart",
+    handler: "admin.settingsRestart",
+    config: {
+      policies: [],
+    },
+  },
+];
+
+export default routes;

package/server/routes/client.ts

@@ -0,0 +1,95 @@
+import { StrapiRoute } from "strapi-typed";
+
+const routes: StrapiRoute[] = [
+  {
+    method: "GET",
+    path: "/:relation",
+    handler: "client.findAllInHierarchy",
+    config: {
+      policies: [],
+      description:
+        "Find all comments related to configured Collection / Single Type and return them in a nested structure",
+      tag: {
+        plugin: "comments",
+        name: "Comments",
+        actionType: "find",
+      },
+    },
+  },
+  {
+    method: "POST",
+    path: "/:relation",
+    handler: "client.post",
+    config: {
+      policies: [],
+      description: "Post a comment against configured Collection / Single Type",
+      tag: {
+        plugin: "comments",
+        name: "Comments",
+        actionType: "create",
+      },
+    },
+  },
+  {
+    method: "GET",
+    path: "/:relation/flat",
+    handler: "client.findAllFlat",
+    config: {
+      policies: [],
+      description:
+        "Find all comments related to configured Collection / Single Type and return them in a flat structure for further processing",
+      tag: {
+        plugin: "comments",
+        name: "Comments",
+        actionType: "find",
+      },
+    },
+  },
+  {
+    method: "PUT",
+    path: "/:relation/comment/:commentId",
+    handler: "client.put",
+    config: {
+      policies: [],
+      description:
+        "Update comment related to configured Collection / Single Type if user is the author",
+      tag: {
+        plugin: "comments",
+        name: "Comments",
+        actionType: "update",
+      },
+    },
+  },
+  {
+    method: "POST",
+    path: "/:relation/comment/:commentId/report-abuse",
+    handler: "client.reportAbuse",
+    config: {
+      policies: [],
+      description:
+        "Report an abuse against comment for configured Collection / Single Type",
+      tag: {
+        plugin: "comments",
+        name: "Comments",
+        actionType: "create",
+      },
+    },
+  },
+  {
+    method: "DELETE",
+    path: "/:relation/comment/:commentId",
+    handler: "client.removeComment",
+    config: {
+      policies: [],
+      description:
+        "Remove comment related to configured Collection / Single Type if user is the author",
+      tag: {
+        plugin: "comments",
+        name: "Comments",
+        actionType: "delete",
+      },
+    },
+  },
+];
+
+export default routes;

package/server/routes/index.ts

@@ -0,0 +1,25 @@
+import { StrapiRoute } from "strapi-typed";
+import clientRoutes from "./client";
+import adminRoutes from "./admin";
+
+type PluginRoutes = {
+  [key: string]: PluginScopeRoutes;
+};
+
+type PluginScopeRoutes = {
+  type: string;
+  routes: Array<StrapiRoute>;
+};
+
+const routes: PluginRoutes = {
+  "content-api": {
+    type: "content-api",
+    routes: clientRoutes,
+  },
+  admin: {
+    type: "admin",
+    routes: adminRoutes,
+  },
+};
+
+export default routes;