✨ [issue-12][developerdao.com-264] Add GeneralQuery to get news_ticker (#13)

- add Markup component
- update Seeding to allow Public quering

Author: andriishupta

cms/package.json

@@ -12,7 +12,8 @@
     "strapi": "strapi"
   },
   "devDependencies": {
-    "@faker-js/faker": "^7.3.0"
+    "@faker-js/faker": "^7.3.0",
+    "lodash.merge": "^4.6.2"
   },
   "dependencies": {
     "@strapi/plugin-graphql": "4.2.2",

cms/src/_seed/constants.js

@@ -1,5 +1,6 @@
 module.exports = {
   SEED_USERNAME: 'seed_user',
+  DEFAULT_PUBLIC_ROLE_ID: 2, // Auth user - 1, Public - 2 - this is by default
   APPLICATION_COLLECTION_TYPE_UIDS: [
     'api::contributor.contributor',
     'api::partner.partner',

cms/src/_seed/general.js

@@ -0,0 +1,32 @@
+/**
+ * @param {Strapi} strapi
+ * @returns {Promise<void>}
+ */
+const fillGeneralData = async (strapi) => {
+  console.log('filling general data...')
+
+  let generalObject = await strapi.entityService.findMany('api::general.general', {})
+
+  if (!generalObject) {
+    generalObject = await strapi.entityService.create('api::general.general', {
+      data: {
+        publishedAt: new Date().toISOString()
+      }
+    })
+  }
+
+  await strapi.entityService.update('api::general.general', generalObject.id, {
+    data: {
+      news_ticker: {
+        name: 'news_ticker',
+        content: '# markdown content'
+      }
+    }
+  })
+
+  console.log('general data has been filled successfully!')
+}
+
+module.exports = {
+  fillGeneralData,
+}

cms/src/_seed/helpers.js

@@ -1,5 +1,6 @@
-const { APPLICATION_COLLECTION_TYPE_UIDS } = require('./constants');
+const { APPLICATION_COLLECTION_TYPE_UIDS, DEFAULT_PUBLIC_ROLE_ID, } = require('./constants');
 const { statSync } = require('fs');
+const merge = require('lodash.merge')
 
 /**
  * @param {Strapi} strapi
@@ -58,8 +59,16 @@ const uploadFile = async (strapi, {
   data,
   file,
 }) => {
-  const { refId, ref, field } = data
-  const { name, path, type } = file
+  const {
+    refId,
+    ref,
+    field
+  } = data
+  const {
+    name,
+    path,
+    type
+  } = file
 
   const fileStat = statSync(path);
 
@@ -80,10 +89,78 @@ const uploadFile = async (strapi, {
   return uploadedFile
 }
 
+/**
+ * @param {Strapi} strapi
+ */
+const updateStrapiPublicRole = async (strapi,) => {
+  const roleService = strapi.plugin('users-permissions').service('role')
+
+  const publicRoleSettings = await roleService.findOne(DEFAULT_PUBLIC_ROLE_ID)
+  const overridePermissions = {
+    'api::contributor': {
+      controllers: {
+        contributor: {
+          find: {
+            enabled: true,
+          },
+          findOne: {
+            enabled: true,
+          },
+        }
+      }
+    },
+    'api::general': {
+      controllers: {
+        general: {
+          find: {
+            enabled: true,
+          },
+        }
+      }
+    },
+    'api::home-page': {
+      controllers: {
+        'home-page': {
+          find: {
+            enabled: true,
+          },
+        }
+      }
+    },
+    'api::partner': {
+      controllers: {
+        partner: {
+          find: {
+            enabled: true,
+          },
+          findOne: {
+            enabled: true,
+          },
+        }
+      }
+    },
+    'api::project': {
+      controllers: {
+        project: {
+          find: {
+            enabled: true,
+          },
+          findOne: {
+            enabled: true,
+          },
+        }
+      }
+    },
+  }
+
+  await roleService.updateRole(DEFAULT_PUBLIC_ROLE_ID, merge({ ...publicRoleSettings }, { permissions: overridePermissions }))
+}
+
 module.exports = {
   ensureSQLite,
   randomBoolean,
   clearData,
   sampleSize,
   uploadFile,
+  updateStrapiPublicRole,
 }

cms/src/_seed/index.js

@@ -1,8 +1,9 @@
 const { seedUserExists, generateUserData } = require('./user');
-const { clearData } = require('./helpers');
+const { clearData, updateStrapiPublicRole } = require('./helpers');
 const { generatePartnerData } = require('./partner');
 const { generateProjectAndContributorData } = require('./project-and-contributor');
 const { fillHomePage } = require('./pages');
+const { fillGeneralData } = require('./general');
 
 /**
  * @param {Strapi} strapi
@@ -36,14 +37,18 @@ const generateSeedData = async (strapi) => {
     throw new Error(e)
   })
 
-  // Pages
+  // Single Types
   await Promise.all([
     fillHomePage(strapi),
+    fillGeneralData(strapi),
   ]).catch(e => {
     console.error('error during generating page data! Stopping the application...')
     throw new Error(e)
   })
 
+  console.log('updating Public role to access pages and data')
+  await updateStrapiPublicRole(strapi)
+
   console.log('generating seed data has been finished successfully!')
 }
 

cms/src/api/general/content-types/general/schema.json

@@ -0,0 +1,20 @@
+{
+  "kind": "singleType",
+  "collectionName": "generals",
+  "info": {
+    "singularName": "general",
+    "pluralName": "generals",
+    "displayName": "General"
+  },
+  "options": {
+    "draftAndPublish": true
+  },
+  "pluginOptions": {},
+  "attributes": {
+    "news_ticker": {
+      "type": "component",
+      "repeatable": false,
+      "component": "general.markup"
+    }
+  }
+}

cms/src/api/general/controllers/general.js

@@ -0,0 +1,9 @@
+'use strict';
+
+/**
+ *  general controller
+ */
+
+const { createCoreController } = require('@strapi/strapi').factories;
+
+module.exports = createCoreController('api::general.general');

cms/src/api/general/routes/general.js

@@ -0,0 +1,9 @@
+'use strict';
+
+/**
+ * general router.
+ */
+
+const { createCoreRouter } = require('@strapi/strapi').factories;
+
+module.exports = createCoreRouter('api::general.general');

cms/src/api/general/services/general.js

@@ -0,0 +1,9 @@
+'use strict';
+
+/**
+ * general service.
+ */
+
+const { createCoreService } = require('@strapi/strapi').factories;
+
+module.exports = createCoreService('api::general.general');

cms/src/components/general/markup.json

@@ -0,0 +1,18 @@
+{
+  "collectionName": "components_general_markups",
+  "info": {
+    "displayName": "Markup",
+    "icon": "align-justify"
+  },
+  "options": {},
+  "attributes": {
+    "name": {
+      "type": "string",
+      "required": true
+    },
+    "content": {
+      "type": "richtext",
+      "required": true
+    }
+  }
+}