Convert JS to TS (commits 7-13 of PR435) - attempt#2 (lnp2pBot#585)

* util/index: convert js to ts

The languageModel & fiatModel interface created to type-check
the data and ensure that it conforms to
the expected structure and format.
This can help you avoid errors and bugs when
working with the data in your code.
This commit enables resolveJsonModule to import module
with '.json' extension.

Co-authored-by: webwarrior <[email protected]>

* jobs: convert js to ts

The --downlevelIteration flag is a TypeScript compiler
option that enables support for iterating over new
concepts like Map, Set, or Generator in older JavaScript
runtimes. By default, TypeScript targets ES3, which does
not support these features. If you use a for...of loop or
a spread operator on an iterable object, you may get an error.
Use Date instead of Date.toISOString cause paid_at has type
Date and during the conversion from js to ts,
we got compilation errors.

Co-authored-by: webwarrior <[email protected]>

* bot/start: fixing types & import/exports

Co-authored-by: webwarrior <[email protected]>

* bot/validation: convert js to ts

Using null instead of a boolean/undefined type is better.

* lnurl/lnurl-pay: convert js to ts

I had to change the '|', otherwise typescript would
complain this error msg:
```
The '|' operator is not allowed for boolean types.
Consider using '||' instead.
```

Co-authored-by: webwarrior <[email protected]>

* refactor: correcting a bad practice

* refactor: there's no need for isInt()

* bot: fix bugs in validations.ts

Fix bugs in validations.ts introduced in d36a6b7 when porting
to TypeScript.

* bot,util: fix bug in validateAdmin

Fixed bug in validateAdmin that would throw an error when
community is null even though null value is valid in this case.

* bot: fix date comparison in isValidInvoice

Don't convert dates to strings in isValidInvoice.

* WIP: added some debug logging

Added debug logging for case when `Invoice expiry is too short`
error is encountered.

* WIP: more debug logging

Added debug logging of message that caused error when taking
dispute in community.

* bot,util,locales,tests: don't use objects in locales

Don't use object properties inside locales, as it doesn't work
and leads to parse errors.

---------

Co-authored-by: Mehrshad <[email protected]>

Author: webwarrior-ws

bot/modules/dispute/messages.js

@@ -1,4 +1,8 @@
-const { getDisputeChannel, getDetailedOrder, sanitizeMD } = require('../../../util');
+const {
+  getDisputeChannel,
+  getDetailedOrder,
+  sanitizeMD,
+} = require('../../../util');
 const { logger } = require('../../../logger');
 
 exports.beginDispute = async (ctx, initiator, order, buyer, seller) => {
@@ -91,25 +95,25 @@ exports.disputeData = async (
     // Fix Issue 543: Escape underscores in usernames
     const escapedInitiatorUsername = sanitizeMD(initiatorUser.username);
     const escapedCounterPartyUsername = sanitizeMD(counterPartyUser.username);
-    
-    await ctx.telegram.sendMessage(
-      solver.tg_id,
-      ctx.i18n.t('dispute_started_channel', {
-        initiatorUser: { ...initiatorUser, username: escapedInitiatorUsername },
-        initiatorTgId: initiatorUser.tg_id,
-        counterPartyUser: { ...counterPartyUser, username: escapedCounterPartyUsername },
-        counterPartyUserTgId: counterPartyUser.tg_id,
-        buyer,
-        seller,
-        buyerDisputes,
-        sellerDisputes,
-        detailedOrder,
-        type,
-        sellerToken: order.seller_dispute_token,
-        buyerToken: order.buyer_dispute_token,
-      }),
-      { parse_mode: 'MarkdownV2' }
-    );
+
+    const message = ctx.i18n.t('dispute_started_channel', {
+      initiatorUser: escapedInitiatorUsername,
+      initiatorTgId: initiatorUser.tg_id,
+      counterPartyUser: escapedCounterPartyUsername,
+      counterPartyUserTgId: counterPartyUser.tg_id,
+      buyer,
+      seller,
+      buyerDisputes,
+      sellerDisputes,
+      detailedOrder,
+      type,
+      sellerToken: order.seller_dispute_token,
+      buyerToken: order.buyer_dispute_token,
+    });
+    console.log(`Contens of message:\n${message}`);
+    await ctx.telegram.sendMessage(solver.tg_id, message, {
+      parse_mode: 'MarkdownV2',
+    });
     // message to both parties letting them know the dispute
     // has been taken by a solver
     await ctx.telegram.sendMessage(

bot/start.ts

@@ -4,18 +4,17 @@ import { Message } from 'typegram'
 import { UserDocument } from '../models/user'
 import { FilterQuery } from 'mongoose';
 const OrderEvents = require('./modules/events/orders');
-
-const { limit } = require('@grammyjs/ratelimiter');
+import { limit } from "@grammyjs/ratelimiter"
 const schedule = require('node-schedule');
-const {
+import {
   Order,
   User,
   PendingPayment,
   Community,
   Dispute,
   Config,
-} = require('../models');
-const { getCurrenciesWithPrice, deleteOrderFromChannel, removeAtSymbol } = require('../util');
+} from '../models';
+import { getCurrenciesWithPrice, deleteOrderFromChannel, removeAtSymbol } from '../util';
 const {
   commandArgsMiddleware,
   stageMiddleware,
@@ -55,32 +54,34 @@ const {
   validateLightningAddress,
 } = require('./validations');
 import * as messages from './messages';
-const {
+import {
   attemptPendingPayments,
   cancelOrders,
   deleteOrders,
   calculateEarnings,
   attemptCommunitiesPendingPayments,
   deleteCommunity,
   nodeInfo,
-} = require('../jobs');
-const { logger } = require('../logger');
+} from '../jobs';
+import { logger } from "../logger";
+import { ICommunity, IUsernameId } from '../models/community';
+
 export interface MainContext extends Context {
   match: Array<string> | null;
   i18n: I18nContext;
   user: UserDocument;
   admin: UserDocument;
 }
 
-interface OrderQuery {
+export interface OrderQuery {
   status?: string;
   buyer_id?: string;
   seller_id?: string;
 }
 
 const askForConfirmation = async (user: UserDocument, command: string) => {
   try {
-    let orders = [];
+    let orders: any[] = [];
     if (command === '/cancel') {
       const where: FilterQuery<OrderQuery> = {
         $and: [
@@ -133,6 +134,7 @@ const askForConfirmation = async (user: UserDocument, command: string) => {
     return orders;
   } catch (error) {
     logger.error(error);
+    return null;
   }
 };
 
@@ -145,7 +147,7 @@ has the same condition.
 The problem mentioned above is similar to this issue:
 https://github.com/telegraf/telegraf/issues/1319#issuecomment-766360594
 */
-const ctxUpdateAssertMsg = "ctx.update.message.text is not available.";
+export const ctxUpdateAssertMsg = "ctx.update.message.text is not available.";
 
 const initialize = (botToken: string, options: Partial<Telegraf.Options<MainContext>>): Telegraf<MainContext> => {
   const i18n = new I18n({
@@ -215,7 +217,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
       const [val] = await validateParams(ctx, 2, '\\<_on/off_\\>');
       if (!val) return;
       let config = await Config.findOne();
-      if (!config) {
+      if (config === null) {
         config = new Config();
       }
       config.maintenance = false;
@@ -262,11 +264,11 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
         throw new Error(ctxUpdateAssertMsg);
       }
       const params = ctx.update.message.text.split(' ');
-      const [command, orderId] = params.filter((el) => el);
+      const [command, orderId] = params.filter((el: string) => el);
 
       if (!orderId) {
         const orders = await askForConfirmation(ctx.user, command);
-        if (!orders.length) return await ctx.reply(`${command} <order Id>`);
+        if (orders === null || orders.length === 0) return await ctx.reply(`${command} <order Id>`);
 
         return await messages.showConfirmationButtons(ctx, orders, command);
       } else if (!(await validateObjectId(ctx, orderId))) {
@@ -325,7 +327,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
       if (!(await validateObjectId(ctx, orderId))) return;
       const order = await Order.findOne({ _id: orderId });
 
-      if (!order) return;
+      if (order === null) return;
 
       // We look for a dispute for this order
       const dispute = await Dispute.findOne({ order_id: order._id });
@@ -367,10 +369,11 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
 
       order.status = 'CANCELED_BY_ADMIN';
       order.canceled_by = ctx.admin._id;
-      const buyer = await User.findOne({ _id: order.buyer_id });
-      const seller = await User.findOne({ _id: order.seller_id });
       await order.save();
       OrderEvents.orderUpdated(order);
+      const buyer = await User.findOne({ _id: order.buyer_id });
+      const seller = await User.findOne({ _id: order.seller_id });
+      if (buyer === null || seller === null) throw Error("buyer and/or seller were not found in DB");
       // we sent a private message to the admin
       await messages.successCancelOrderMessage(ctx, ctx.admin, order, ctx.i18n);
       // we sent a private message to the seller
@@ -390,11 +393,11 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
         throw new Error(ctxUpdateAssertMsg);
       }
       const params = ctx.update.message.text.split(' ');
-      const [command, orderId] = params.filter((el) => el);
+      const [command, orderId] = params.filter((el: string) => el);
 
       if (!orderId) {
         const orders = await askForConfirmation(ctx.user, command);
-        if (!orders.length) return await ctx.reply(`${command}  <order Id>`);
+        if (orders === null || orders.length === 0) return await ctx.reply(`${command}  <order Id>`);
 
         return await messages.showConfirmationButtons(ctx, orders, command);
       } else if (!(await validateObjectId(ctx, orderId))) {
@@ -445,7 +448,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
         await order.save();
         OrderEvents.orderUpdated(order);
         // We delete the messages related to that order from the channel
-        await deleteOrderFromChannel(order, bot.telegram);
+        await deleteOrderFromChannel(order, bot.telegram as any);
       }
       // we sent a private message to the user
       await messages.successCancelAllOrdersMessage(ctx);
@@ -462,7 +465,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
       if (!(await validateObjectId(ctx, orderId))) return;
 
       const order = await Order.findOne({ _id: orderId });
-      if (!order) return;
+      if (order === null) return;
 
        // Check if the order status is already PAID_HOLD_INVOICE
       if (order.status === 'PAID_HOLD_INVOICE') {
@@ -498,10 +501,11 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
       }
 
       order.status = 'COMPLETED_BY_ADMIN';
-      const buyer = await User.findOne({ _id: order.buyer_id });
-      const seller = await User.findOne({ _id: order.seller_id });
       await order.save();
       OrderEvents.orderUpdated(order);
+      const buyer = await User.findOne({ _id: order.buyer_id });
+      const seller = await User.findOne({ _id: order.seller_id });
+      if (buyer === null || seller === null) throw Error("buyer and/or seller were not found in DB");
       // we sent a private message to the admin
       await messages.successCompleteOrderMessage(ctx, order);
       // we sent a private message to the seller
@@ -525,11 +529,11 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
       if (!(await validateObjectId(ctx, orderId))) return;
       const order = await Order.findOne({ _id: orderId });
 
-      if (!order) return;
+      if (order === null) return;
 
       const buyer = await User.findOne({ _id: order.buyer_id });
       const seller = await User.findOne({ _id: order.seller_id });
-
+      if (buyer === null || seller === null) throw Error("buyer and/or seller were not found in DB");
       await messages.checkOrderMessage(ctx, order, buyer, seller);
     } catch (error) {
       logger.error(error);
@@ -543,7 +547,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
       if (!(await validateObjectId(ctx, orderId))) return;
       const order = await Order.findOne({ _id: orderId });
 
-      if (!order) return;
+      if (order === null) return;
       if (!order.hash) return;
 
       const invoice = await getInvoice({ hash: order.hash });
@@ -567,7 +571,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
 
       const order = await Order.findOne({ hash });
 
-      if (!order) return;
+      if (order === null) return;
       await subscribeInvoice(bot, hash, true);
       ctx.reply(`hash resubscribed`);
     } catch (error: any) {
@@ -606,11 +610,11 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
         throw new Error(ctxUpdateAssertMsg);
       }
       const params = ctx.update.message.text.split(' ');
-      const [command, orderId] = params.filter((el) => el);
+      const [command, orderId] = params.filter((el: string) => el);
 
       if (!orderId) {
         const orders = await askForConfirmation(ctx.user, command);
-        if (!orders.length) return await ctx.reply(`${command} <order Id>`);
+        if (orders === null || orders.length === 0) return await ctx.reply(`${command} <order Id>`);
 
         return await messages.showConfirmationButtons(ctx, orders, command);
       } else if (!(await validateObjectId(ctx, orderId))) {
@@ -637,7 +641,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
       const user = await User.findOne({
         $or: [{ username }, { tg_id: username }],
       });
-      if (!user) {
+      if (user === null) {
         await messages.notFoundUserMessage(ctx);
         return;
       }
@@ -648,6 +652,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
           const community = await Community.findById(
             ctx.admin.default_community_id
           );
+          if (community === null) throw Error("Community was not found in DB");
           community.banned_users.push({
             id: user._id,
             username: user.username,
@@ -680,7 +685,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
       const user = await User.findOne({
         $or: [{ username }, { tg_id: username }],
       });
-      if (!user) {
+      if (user === null) {
         await messages.notFoundUserMessage(ctx);
         return;
       }
@@ -691,8 +696,9 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
           const community = await Community.findById(
             ctx.admin.default_community_id
           );
-          community.banned_users = community.banned_users.filter(
-            (el: any) => el.id !== user.id
+          if (community === null) throw Error("Community was not found in DB");
+          community.banned_users = community.banned_users.toObject().filter(
+            (el: IUsernameId) => el.id !== user.id
           );
           await community.save();
         } else {
@@ -739,7 +745,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
     try {
       const command = '/setinvoice';
       const orders = await askForConfirmation(ctx.user, command);
-      if (!orders.length) return await ctx.reply(ctx.i18n.t('setinvoice_no_response'));
+      if (orders === null || !orders.length) return await ctx.reply(ctx.i18n.t('setinvoice_no_response'));
 
       return await messages.showConfirmationButtons(ctx, orders, command);
     } catch (error) {
@@ -859,6 +865,7 @@ const initialize = (botToken: string, options: Partial<Telegraf.Options<MainCont
   bot.command('info', userMiddleware, async (ctx: MainContext) => {
     try {
       const config = await Config.findOne({});
+      if (config === null) throw Error("Config was not found in DB");
       await messages.showInfoMessage(ctx, ctx.user, config);
     } catch (error) {
       logger.error(error);