feat(tsc): add tsconfig to allow tsc to run

Author: stafyniaksacha

.eslintignore

@@ -0,0 +1,2 @@
+types
+tests

.eslintrc.js

@@ -1,11 +1,18 @@
 module.exports = {
   parser: '@typescript-eslint/parser',
-  extends: ['eslint:recommended', 'google', 'prettier'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    'plugin:jsdoc/recommended',
+    'google',
+    'prettier',
+  ],
   env: {
     node: true,
     jest: true,
   },
   parserOptions: {
+    project: './tsconfig.json',
     ecmaFeatures: {
       experimentalObjectRestSpread: true,
       impliedStrict: true,
@@ -19,5 +26,41 @@ module.exports = {
     indent: ['error', 2, { SwitchCase: 1 }],
     'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
     'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    // jsdoc
+    'require-jsdoc': 'off',
+    'valid-jsdoc': 'off',
+    'jsdoc/require-param-description': 'off',
+    'jsdoc/require-returns': 'off',
+    'jsdoc/require-returns-description': 'off',
+    'jsdoc/no-undefined-types': [
+      'warn',
+      {
+        definedTypes: ['never'],
+      },
+    ],
+
+    // JS requirements
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+
+    // TODO
+    '@typescript-eslint/no-unsafe-return': 'off',
+    '@typescript-eslint/no-unsafe-argument': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {},
+    },
+    jsdoc: {
+      // mode: 'typescript',
+      tagNamePreference: {
+        param: 'param',
+        returns: 'return',
+      },
+    },
   },
 };

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

lib/cache/index.js

@@ -1,4 +1,8 @@
-// @ts-check
+/**
+ * @typedef {import('strapi-middleware-cache').CacheStore} CacheStore
+ * @typedef {import('strapi-middleware-cache').MiddlewareCacheConfig} MiddlewareCacheConfig
+ * @typedef {import('strapi-middleware-cache').Logger} Logger
+ */
 
 const mapValues = require('lodash/mapValues');
 
@@ -14,15 +18,29 @@ function createStore(options, logger) {
 
   return mapValues(
     {
+      /**
+       * @param {string} key
+       */
       async get(key) {
         return deserialize(await store.get(key));
       },
+      /**
+       * @param {string} key
+       * @param {any} val
+       * @param {number=} maxAge
+       */
       async set(key, val, maxAge = options.maxAge) {
         return await store.set(key, serialize(val), maxAge);
       },
+      /**
+       * @param {string} key
+       */
       async peek(key) {
         return deserialize(await store.peek(key));
       },
+      /**
+       * @param {string} key
+       */
       async del(key) {
         await store.del(key);
       },
@@ -34,13 +52,17 @@ function createStore(options, logger) {
       },
     },
     (fn) =>
+      /**
+       * @param  {any[]} args
+       */
       async (...args) => {
         try {
           if (!store.ready) {
             logger.warn('the store is not ready');
             return null;
           }
           return await Promise.race([
+            // @ts-ignore
             fn(...args),
             rejectAfterTimeout(options.cacheTimeout),
           ]);

lib/cache/stores/mem.js

@@ -1,13 +1,16 @@
-// @ts-check
+/**
+ * @typedef {import('strapi-middleware-cache').Logger} Logger
+ * @typedef {import('strapi-middleware-cache').MiddlewareCacheConfig} MiddlewareCacheConfig
+ * @typedef {import('strapi-middleware-cache').InternalCacheStore} InternalCacheStore
+ */
 
 const LRU = require('lru-cache');
 
 /**
  * @param {MiddlewareCacheConfig} options
- * @param {Logger} logger
  * @return {InternalCacheStore}
  */
-function createMemStore(options, logger) {
+function createMemStore(options) {
   const cache = new LRU({ max: options.max, maxAge: options.maxAge });
 
   return {

lib/cache/stores/redis.js

@@ -1,4 +1,8 @@
-// @ts-check
+/**
+ * @typedef {import('strapi-middleware-cache').Logger} Logger
+ * @typedef {import('strapi-middleware-cache').MiddlewareCacheConfig} MiddlewareCacheConfig
+ * @typedef {import('strapi-middleware-cache').InternalCacheStore} InternalCacheStore
+ */
 
 const Redis = require('ioredis');
 const lru = require('redis-lru');
@@ -9,7 +13,13 @@ const lru = require('redis-lru');
  * @return {InternalCacheStore}
  */
 function createRedisStore(options, logger) {
+  /**
+   * @param {string} key
+   */
   const prefix = (key) => `strapi-middleware-cache:${key}`;
+  /**
+   * @param {string} key
+   */
   const unprefix = (key) => key.replace(/^strapi-middleware-cache:/, '');
 
   const client = new Redis(options.redisConfig);
@@ -28,7 +38,7 @@ function createRedisStore(options, logger) {
     logger.error(`redis connection failed`, error);
   });
 
-  client.on('reconnecting', (e) => {
+  client.on('reconnecting', () => {
     reconnected = true;
   });
 

lib/index.js

@@ -1,4 +1,7 @@
-// @ts-check
+/**
+ * @typedef {import('strapi-middleware-cache').MiddlewareCache} MiddlewareCache
+ * @typedef {import('strapi-middleware-cache').UserMiddlewareCacheConfig} UserMiddlewareCacheConfig
+ */
 
 const createStore = require('./cache');
 
@@ -52,7 +55,11 @@ const Cache = (strapi) => {
 
       // --- Populate Koa Context with cache entry point
       if (options.withKoaContext) {
-        strapi.app.use((ctx, next) => {
+        /**
+         * @param {any} ctx
+         * @param {() => void} next
+         */
+        const injectInKoaContext = (ctx, next) => {
           if (ctx.middleware) {
             ctx.middleware.cache = {
               store,
@@ -67,7 +74,9 @@ const Cache = (strapi) => {
           }
 
           return next();
-        });
+        };
+
+        strapi.app.use(injectInKoaContext);
       }
 
       // --- Populate Strapi Middleware with cache entry point

lib/utils/createClearCache.js

@@ -1,3 +1,12 @@
+/**
+ * @typedef {import('strapi-middleware-cache').CacheStore} CacheStore
+ * @typedef {import('strapi-middleware-cache').MiddlewareCacheConfig} MiddlewareCacheConfig
+ * @typedef {import('strapi-middleware-cache').GetCacheConfigByUidFn} GetCacheConfigByUidFn
+ * @typedef {import('strapi-middleware-cache').ClearCacheFn} ClearCacheFn
+ * @typedef {import('strapi-middleware-cache').ModelCacheConfig} ModelCacheConfig
+ * @typedef {import('strapi-middleware-cache').ModelCacheParams} ModelCacheParams
+ */
+
 const getCacheConfRegExp = require('./getCacheConfRegExp');
 const getRelatedModelsUid = require('./getRelatedModelsUid');
 
@@ -32,7 +41,14 @@ function createClearCache(store, options, getCacheConfigByUid) {
       }
     }
 
+    /**
+     * @param {string} key
+     */
     const shouldDel = (key) => regExps.find((r) => r.test(key));
+
+    /**
+     * @param {string} key
+     */
     const del = (key) => store.del(key);
 
     await Promise.all(keys.filter(shouldDel).map(del));

lib/utils/createGetCacheConfig.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef {import('strapi-middleware-cache').MiddlewareCacheConfig} MiddlewareCacheConfig
+ * @typedef {import('strapi-middleware-cache').GetCacheConfigFn} GetCacheConfigFn
+ * @typedef {import('strapi-middleware-cache').ModelCacheConfig} ModelCacheConfig
+ * @typedef {import('strapi-middleware-cache').ModelCacheParams} ModelCacheParams
+ */
+
 /**
  * @param {MiddlewareCacheConfig} options
  * @return {GetCacheConfigFn}
@@ -6,9 +13,9 @@ function createGetCacheConfig(options) {
   /**
    * Get related ModelCacheConfig
    *
-   * @param {ModelCacheConfig} model
-   * @param {ModelCacheParams} plugin
-   * @return {ModelCacheConfig}
+   * @param {string} model
+   * @param {string=} plugin
+   * @return {ModelCacheConfig | undefined}
    */
   return function getCacheConfig(model, plugin) {
     return options.models.find((cacheConf) => {

lib/utils/createGetCacheConfigByUid.js

@@ -1,3 +1,9 @@
+/**
+ * @typedef {import('strapi-middleware-cache').GetCacheConfigFn} GetCacheConfigFn
+ * @typedef {import('strapi-middleware-cache').GetCacheConfigByUidFn} GetCacheConfigByUidFn
+ * @typedef {import('strapi-middleware-cache').ModelCacheConfig} ModelCacheConfig
+ */
+
 const resolveModelUidRegex = /^(application|plugins)::([^.]+).([a-z-]+)$/;
 
 /**
@@ -13,7 +19,7 @@ function createGetCacheConfigByUid(getCacheConfig) {
    * - plugins::users-permissions.user
    *
    * @param {string} uid
-   * @return {ModelCacheConfig}
+   * @return {ModelCacheConfig | undefined}
    */
   return function getCacheConfigByUid(uid) {
     const [, type, plugin, model] = resolveModelUidRegex.exec(uid) || [];

lib/utils/createLogger.js

@@ -1,14 +1,34 @@
+/**
+ * @typedef {import('strapi-middleware-cache').MiddlewareCacheConfig} MiddlewareCacheConfig
+ * @typedef {import('strapi-middleware-cache').Logger} Logger
+ */
+
 /**
  * @param {MiddlewareCacheConfig} options
- * @return {Logger}
  */
 function createLogger(options) {
   return {
+    /**
+     * @param {string} msg
+     */
     info: (msg) => options.logs && strapi.log.info(`[cache] ${msg}`),
+    /**
+     * @param {string} msg
+     */
     debug: (msg) => options.logs && strapi.log.debug(`[cache] ${msg}`),
+    /**
+     * @param {string} msg
+     * @param {any[]} rest
+     */
     warn: (msg, ...rest) =>
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
       options.logs && strapi.log.warn(`[cache] ${msg}`, ...rest),
+    /**
+     * @param {string} msg
+     * @param {any[]} rest
+     */
     error: (msg, ...rest) =>
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
       options.logs && strapi.log.error(`[cache] ${msg}`, ...rest),
   };
 }

lib/utils/createPurge.js

@@ -1,3 +1,10 @@
+/**
+ * @typedef {import('strapi-middleware-cache').ClearCacheFn} ClearCacheFn
+ * @typedef {import('strapi-middleware-cache').PurgeFn} PurgeFn
+ * @typedef {import('strapi-middleware-cache').ModelCacheConfig} ModelCacheConfig
+ * @typedef {import('koa').Middleware} Middleware
+ */
+
 /**
  * @param {ClearCacheFn} clearCache
  * @return {PurgeFn}
@@ -7,7 +14,7 @@ function createPurge(clearCache) {
    * Creates a Koa middleware that busts the cache of a given model
    *
    * @param {ModelCacheConfig} cacheConf
-   * @return {KoaRouteMiddleware}
+   * @return {Middleware}
    */
   return function purge(cacheConf) {
     return async function purgeMiddleware(ctx, next) {

lib/utils/createPurgeAdmin.js

@@ -1,9 +1,20 @@
+/**
+ * @typedef {import('strapi-middleware-cache').ClearCacheFn} ClearCacheFn
+ * @typedef {import('strapi-middleware-cache').GetCacheConfigByUidFn} GetCacheConfigByUidFn
+ * @typedef {import('strapi-middleware-cache').PurgeAdminFn} PurgeAdminFn
+ * @typedef {import('koa').Context} Context
+ */
+
 /**
  * @param {ClearCacheFn} clearCache
  * @param {GetCacheConfigByUidFn} getCacheConfigByUid
  * @return {PurgeAdminFn}
  */
 function createPurgeAdmin(clearCache, getCacheConfigByUid) {
+  /**
+   * @param {Context} ctx
+   * @param {() => void | Promise<void>} next
+   */
   return async function purgeAdmin(ctx, next) {
     // uid:
     // - application::sport.sport

lib/utils/createRecv.js

@@ -1,3 +1,12 @@
+/**
+ * @typedef {import('strapi-middleware-cache').CacheStore} CacheStore
+ * @typedef {import('strapi-middleware-cache').MiddlewareCacheConfig} MiddlewareCacheConfig
+ * @typedef {import('strapi-middleware-cache').Logger} Logger
+ * @typedef {import('strapi-middleware-cache').RecvFn} RecvFn
+ * @typedef {import('strapi-middleware-cache').ModelCacheConfig} ModelCacheConfig
+ * @typedef {import('koa').Middleware} Middleware
+ */
+
 const chalk = require('chalk');
 const crypto = require('crypto');
 const generateCacheKey = require('./generateCacheKey');
@@ -13,7 +22,7 @@ function createRecv(store, options, logger) {
    * Creates a Koa middleware that receive cachable requests of a given model
    *
    * @param {ModelCacheConfig} cacheConf
-   * @return {KoaRouteMiddleware}
+   * @return {Middleware}
    */
   return function recv(cacheConf) {
     return async function recvMiddleware(ctx, next) {

lib/utils/createRouter.js

@@ -1,6 +1,12 @@
 const Router = require('koa-router');
 const chalk = require('chalk');
 
+/**
+ * @typedef {import('strapi-middleware-cache').MiddlewareCacheConfig} MiddlewareCacheConfig
+ * @typedef {import('strapi-middleware-cache').Logger} Logger
+ * @typedef {import('strapi-middleware-cache').CacheMiddlewares} CacheMiddlewares
+ */
+
 const routeExists = require('./routeExists');
 
 const routeParamNameRegex = /:([^/]+)/g;