Merge pull request #6107 from Countly/tsconfig_types

First addition of typescript types to core files

Author: ArtursKadikis

.gitignore

@@ -44,4 +44,5 @@ log/
 log/supervisord/
 plugins/plugins.json.*
 .sdk
-dump
+dump
+dist/

api/lib/countly.common.js

@@ -3,8 +3,16 @@
 * @module "api/lib/countly.common"
 */
 
+/**
+ * @typedef {import('moment-timezone')} MomentTimezone
+ */
+
 /** @lends module:api/lib/countly.common */
 var countlyCommon = {},
+    /**
+     * Reference to momentjs
+     * @type {MomentTimezone} moment
+     */
     moment = require('moment-timezone'),
     underscore = require('underscore');
 
@@ -17,8 +25,8 @@ var _period = "hour",
 
 /**
 * Returns array with unique ticks for period
-* @param {moment} startTimestamp - start of period
-* @param {moment} endTimestamp - end of period
+* @param {MomentTimezone} startTimestamp - start of period
+* @param {MomentTimezone} endTimestamp - end of period
 * @returns {array} unique array ticks for period
 **/
 /*function getTicksBetween(startTimestamp, endTimestamp) {
@@ -46,8 +54,8 @@ var _period = "hour",
 
 /**
 * Returns array with more generalized unique ticks for period
-* @param {moment} startTimestamp - start of period
-* @param {moment} endTimestamp - end of period
+* @param {MomentTimezone} startTimestamp - start of period
+* @param {MomentTimezone} endTimestamp - end of period
 * @returns {array} unique array ticks for period
 **/
 /*function getTicksCheckBetween(startTimestamp, endTimestamp) {
@@ -355,7 +363,7 @@ function fixTimestampToMilliseconds(ts) {
 
 /**
 * Returns a period object used by all time related data calculation functions
-* @param {moment} prmPeriod period to be calculated (optional)
+* @param {MomentTimezone} prmPeriod period to be calculated (optional)
 * @param {string} bucket  - daily or monthly. If bucket is set, period will be modified to fit full months or days
 * @returns {timeObject} time object
 **/

api/utils/common.js

@@ -3,6 +3,11 @@
 * @module api/utils/requestProcessor
 */
 
+/**
+ * @typedef {import('../../types/requestProcessor').Params} Params
+ * @typedef {import('../../types/common').TimeObject} TimeObject
+ */
+
 const Promise = require('bluebird');
 const url = require('url');
 const common = require('./common.js');
@@ -65,7 +70,7 @@ const reloadConfig = function() {
 /**
  * Default request processing handler, which requires request context to operate. Check tcp_example.js
  * @static
- * @param {params} params - for request context. Minimum needed properties listed
+ * @param {Params} params - for request context. Minimum needed properties listed
  * @param {object} params.req - Request object, should not be empty and should contain listed params
  * @param {string} params.req.url - Endpoint URL that you are calling. May contain query string.
  * @param {object} params.req.body - Parsed JSON object with data (same name params will overwrite query string if anything provided there)
@@ -103,9 +108,9 @@ const processRequest = (params) => {
         paths = urlParts.pathname.split("/");
     /**
      * Main request processing object containing all information shared through all the parts of the same request
-     * @typedef params
-     * @type {object}
-     * @global
+     * typedef params
+     * type {object}
+     * global
      * @property {string} href - full URL href
      * @property {http.ServerResponse} res - The HTTP response object
      * @property {http.IncomingMessage} req - The HTTP request object
@@ -182,7 +187,7 @@ const processRequest = (params) => {
      * @property {Object} [member.permission.d[app_id].allowed] - Object containing allowed delete permissions for the app
      * @property {Object} member.eventList - Object containing event collections with replaced app names
      * @property {Object} member.viewList - Object containing view collections with replaced app names
-     * @property {timeObject} time - Time object for the request
+     * @property {TimeObject} time - Time object for the request
      * @property {string} request_hash - Hash of the request data
      * @property {string} [previous_session] - ID of the user's previous session
      * @property {number} [previous_session_start] - Start timestamp of the user's previous session
@@ -3747,7 +3752,7 @@ function processUser(params, initiator, done, try_times) {
 /**
  * Function to fetch app user from db
  * @param  {object} params - params object
- * @returns {promise} - user
+ * @returns {Promise} - user
  */
 const fetchAppUser = (params) => {
     return new Promise((resolve) => {

api/utils/requestProcessor.js

@@ -25,7 +25,8 @@
     "mocha": "10.8.2",
     "nyc": "17.1.0",
     "should": "13.2.3",
-    "supertest": "7.1.0"
+    "supertest": "7.1.0",
+    "typescript": "^5.8.2"
   },
   "scripts": {
     "test": "grunt --verbose"

package-lock.json

@@ -0,0 +1,23 @@
+// to set it up, you need to add typescript:
+// npm i typescript --save-dev
+//
+// to run the summary check, call:
+// npx tsc
+{
+    "include": [
+        //"plugins/push/**/*.ts",
+        //"plugins/push/**/*.js"
+        "api/utils/common.js",
+        "api/utils/requestProcessor.js"
+    ],
+    "exclude": [
+        "node_modules"
+    ],
+    "compilerOptions": {
+        "outDir": "dist", // we're not building the app. but still necessary for, reasons...
+        "allowJs": true,
+        "checkJs": true,
+        "resolveJsonModule": true,
+        "strict": true
+    }
+}

package.json

@@ -0,0 +1,32 @@
+import { Moment } from "moment-timezone";
+
+export interface TimeObject {   
+    /** Momentjs instance for request's time in app's timezone */
+    now: Moment;
+    /** Momentjs instance for request's time in UTC */
+    nowUTC: Moment;
+    /** Momentjs instance for current time in app's timezone */
+    nowWithoutTimestamp: Moment;
+    /** Request's seconds timestamp */
+    timestamp: number;
+    /** Request's milliseconds timestamp */
+    mstimestamp: number;
+    /** Year of request time in app's timezone in YYYY format */
+    yearly: string;
+    /** Month of request time in app's timezone in YYYY.M format */
+    monthly: string;
+    /** Date of request time in app's timezone in YYYY.M.D format */
+    daily: string;
+    /** Hour of request time in app's timezone in YYYY.M.D.H format */
+    hourly: string;
+    /** Week of request time in app's timezone as result day of the year, divided by 7 */
+    weekly: number;
+    /** Week of request time in app's timezone according to ISO standard */
+    weeklyISO: number;
+    /** Month of request time in app's timezone in format M */
+    month: string;
+    /** Day of request time in app's timezone in format D */
+    day: string;
+    /** Hour of request time in app's timezone in format H */
+    hour: string;
+}