Merge pull request #6355 from Countly/feat/type-improvements

type improvements

Author: kanwarujjaval

api/utils/common.js

@@ -6,14 +6,14 @@
  * @typedef {import('../../types/requestProcessor').Params} Params
  * @typedef {import('../../types/common').TimeObject} TimeObject
  * @typedef {import('mongodb').ObjectId} ObjectId
- * typedef {import('moment-timezone').Moment} MomentTimezone
+ * @typedef {import('moment-timezone').Moment} MomentTimezone
  */
 
 /** @lends module:api/utils/common **/
-/** @type(import('../../types/common').Common) */
+/** @type {import('../../types/common').Common} */
 const common = {};
 
-/** @type(import('moment-timezone')) */
+/** @type {import('moment-timezone')} */
 const moment = require('moment-timezone');
 const crypto = require('crypto');
 const logger = require('./log.js');
@@ -3465,5 +3465,5 @@ common.trimWhitespaceStartEnd = function(value) {
     return value;
 };
 
-/** @type(import('../../types/common').Common) */
+/** @type {import('../../types/common').Common} */
 module.exports = common;

api/utils/localization.js

@@ -3,7 +3,7 @@
 * @module api/utils/localization
 */
 
-/** @type(import('../../types/localization').Locale) */
+/** @type {import('../../types/localization').Locale} */
 var locale = {},
     fs = require('fs'),
     path = require('path'),
@@ -91,5 +91,5 @@ locale.getProperties = function(lang, callback) {
     }
 };
 
-/** @type(import('../../types/localization').Locale) */
+/** @type {import('../../types/localization').Locale} */
 module.exports = locale;

tsconfig.json

@@ -2,24 +2,47 @@
 // npm i typescript --save-dev
 //
 // to run the summary check, call:
-// npx tsc
+// npx tsc --checkJs --noEmit
 {
-    "include": [
-        //"plugins/push/**/*.ts",
-        //"plugins/push/**/*.js"
-        "api/utils/common.js",
-        "api/utils/localization.js",
-        "api/lib/countly.common.js",
-        "api/utils/requestProcessor.js"
-    ],
-    "exclude": [
-        "node_modules"
+    // Explicitly specify which files to include in compilation
+    "files": [
+        "types/global.d.ts",        // Global type declarations for legacy compatibility
+        "types/common.d.ts",        // Common utility functions type definitions
+        "types/requestProcessor.d.ts", // Request processor type definitions
+        "types/localization.d.ts",  // Localization module type definitions
+        "types/log.d.ts",           // Logging module type definitions
+        "types/config.d.ts",        // Configuration type definitions
+        "types/pluginManager.d.ts", // Plugin manager type definitions
+        "types/utils.d.ts",         // Utility functions type definitions
+        "types/batcher.d.ts",       // Database batcher type definitions
+        "types/rights.d.ts",        // Rights validation type definitions
+        "types/events.d.ts",        // Events processing type definitions
+        "types/usage.d.ts",         // Usage processing type definitions
+        "api/utils/localization.js" // Include JS file for type checking
     ],
     "compilerOptions": {
-        "outDir": "dist", // we're not building the app. but still necessary for, reasons...
-        "allowJs": true,
-        "checkJs": true,
-        "resolveJsonModule": true,
-        "strict": true
+        // Language and Environment
+        "target": "ES2022",                    // Set the JavaScript language version for emitted JavaScript
+        "lib": ["ES2022", "DOM"],             // Specify a set of bundled library declaration files
+
+        // Modules
+        "moduleResolution": "Node",            // Specify how TypeScript looks up a file from a given module specifier
+        "baseUrl": ".",                        // Specify the base directory to resolve non-relative module names
+        "paths": {                             // Specify a set of entries that re-map imports to additional lookup locations
+            "@countly/*": ["./api/*"],         // Map @countly imports to api directory
+            "@plugins/*": ["./plugins/*"],     // Map @plugins imports to plugins directory
+            "@frontend/*": ["./frontend/*"]    // Map @frontend imports to frontend directory
+        },
+        "resolveJsonModule": true,             // Enable importing .json files
+
+        // JavaScript Support
+        "allowJs": true,                       // Allow JavaScript files to be a part of your program
+
+        // Interop Constraints
+        "esModuleInterop": true,               // Emit additional JavaScript to ease support for importing CommonJS modules
+        "forceConsistentCasingInFileNames": true, // Ensure that casing is correct in imports
+
+        // Completeness
+        "typeRoots": ["./types", "./node_modules/@types"] // Specify multiple folders that act like './node_modules/@types'
     }
 }