make codes type-safe

apps/app/src/server/models/obsolete-page.js

@@ -84,7 +84,7 @@ export const populateDataToShowRevision = (page, userPublicFields, shouldExclude
 };
 /* eslint-enable object-curly-newline, object-property-newline */
 
-
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 export const getPageSchema = (crowi) => {
   let pageEvent;
 

apps/app/src/server/models/slack-app-integration.js

@@ -38,8 +38,10 @@ class SlackAppIntegration {
     let generateTokens;
 
     // get salt strings
-    const saltForGtoP = this.crowi.configManager.getConfig('slackbot:withProxy:saltForGtoP');
-    const saltForPtoG = this.crowi.configManager.getConfig('slackbot:withProxy:saltForPtoG');
+    /** @type {import('~/server/crowi').default} Crowi instance */
+    const crowi = this.crowi;
+    const saltForGtoP = crowi.configManager.getConfig('slackbot:withProxy:saltForGtoP');
+    const saltForPtoG = crowi.configManager.getConfig('slackbot:withProxy:saltForPtoG');
 
     do {
       generateTokens = this.generateAccessTokens(saltForGtoP, saltForPtoG);
@@ -55,6 +57,7 @@ class SlackAppIntegration {
 
 }
 
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 const factory = (crowi) => {
   const modelExists = getModelSafely('SlackAppIntegration');
   if (modelExists != null) {

apps/app/src/server/routes/apiv3/attachment.js

@@ -132,6 +132,7 @@ const {
  *            description: temporary URL cached
  *            example: "https://example.com/attachment/5e0734e072560e001761fa67"
  */
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
   const loginRequired = require('../../middlewares/login-required')(crowi, true);
   const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);

apps/app/src/server/routes/apiv3/import.js

@@ -54,7 +54,7 @@ const router = express.Router();
  *            type: boolean
  *            description: whether the current importing job exists or not
  */
-
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 export default function route(crowi) {
   const { growiBridgeService, socketIoService } = crowi;
   const importService = getImportService(crowi);

apps/app/src/server/routes/apiv3/index.js

@@ -21,6 +21,7 @@ const router = express.Router();
 const routerForAdmin = express.Router();
 const routerForAuth = express.Router();
 
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi, app) => {
   const isInstalled = crowi.configManager.getConfig('app:installed');
   const minPasswordLength = crowi.configManager.getConfig('app:minPasswordLength');

apps/app/src/server/routes/apiv3/markdown-setting.js

@@ -82,6 +82,7 @@ const validator = {
  *              description: attr whitelist
  */
 
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
   const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);
   const adminRequired = require('../../middlewares/admin-required')(crowi);

apps/app/src/server/routes/apiv3/notification-setting.js

@@ -86,6 +86,7 @@ const validator = {
  *              type: string
  *              description: trigger events for notify
  */
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
   const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);
   const adminRequired = require('../../middlewares/admin-required')(crowi);

apps/app/src/server/routes/apiv3/pages/index.js

@@ -57,7 +57,7 @@ const LIMIT_FOR_MULTIPLE_PAGE_OP = 20;
  *            description: Count of tagged pages
  *            example: 3
  */
-
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
   const loginRequired = require('../../../middlewares/login-required')(crowi, true);
   const loginRequiredStrictly = require('../../../middlewares/login-required')(crowi);

apps/app/src/server/routes/apiv3/personal-setting.js

@@ -66,6 +66,7 @@ const router = express.Router();
  *          accountId:
  *            type: string
  */
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
   const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);
   const addActivity = generateAddActivityMiddleware(crowi);

apps/app/src/server/routes/apiv3/revisions.js

@@ -18,6 +18,7 @@ const router = express.Router();
 
 const MIGRATION_FILE_NAME = '20211227060705-revision-path-to-page-id-schema-migration--fixed-7549';
 
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
   const certifySharedPage = require('../../middlewares/certify-shared-page')(crowi);
   const loginRequired = require('../../middlewares/login-required')(crowi, true);

apps/app/src/server/routes/apiv3/share-links.js

@@ -20,6 +20,7 @@ const validator = {};
 
 const today = new Date();
 
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
   const loginRequired = require('../../middlewares/login-required')(crowi);
   const adminRequired = require('../../middlewares/admin-required')(crowi);

apps/app/src/server/routes/apiv3/slack-integration-legacy-settings.js

@@ -41,6 +41,7 @@ const validator = {
  *            type: string
  *            description: OAuth access token
  */
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
   const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);
   const adminRequired = require('../../middlewares/admin-required')(crowi);

apps/app/src/server/routes/apiv3/slack-integration-settings.js

@@ -45,7 +45,7 @@ const router = express.Router();
  *            type: string
  */
 
-
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
   const loginRequiredStrictly = require('../../middlewares/login-required')(crowi);
   const adminRequired = require('../../middlewares/admin-required')(crowi);

apps/app/src/server/routes/apiv3/staffs.js

@@ -21,6 +21,7 @@ const compareFunction = function(a, b) {
   return a.order - b.order;
 };
 
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
 
   router.get('/', async(req, res) => {

apps/app/src/server/util/importer.js

@@ -1,4 +1,5 @@
 import Esa from 'esa-node';
+
 import loggerFactory from '~/utils/logger';
 
 const logger = loggerFactory('growi:util:importer');
@@ -9,6 +10,7 @@ const logger = loggerFactory('growi:util:importer');
 
 /* eslint-disable no-use-before-define */
 
+/** @param {import('~/server/crowi').default} crowi Crowi instance */
 module.exports = (crowi) => {
   const createGrowiPages = require('./createGrowiPagesFromImports')(crowi);
   const restQiitaAPIService = crowi.getRestQiitaAPIService();