Moved to ts (#6593)

* Moved to ts

* Fixed type check

* Removed js suffixes

* Migrated to ts

* Fixed ts.

* Fixed type check

* Installed missing d ts

src/node/db/API.ts

@@ -20,7 +20,7 @@
  */
 
 const Changeset = require('../../static/js/Changeset');
-const ChatMessage = require('../../static/js/ChatMessage');
+import ChatMessage from '../../static/js/ChatMessage';
 const CustomError = require('../utils/customError');
 const padManager = require('./PadManager');
 const padMessageHandler = require('../handler/PadMessageHandler');

src/node/db/AuthorManager.ts

@@ -21,8 +21,8 @@
 
 const db = require('./DB');
 const CustomError = require('../utils/customError');
-const hooks = require('../../static/js/pluginfw/hooks.js');
-const {randomString, padutils: {warnDeprecated}} = require('../../static/js/pad_utils');
+const hooks = require('../../static/js/pluginfw/hooks');
+import padutils, {randomString} from "../../static/js/pad_utils";
 
 exports.getColorPalette = () => [
   '#ffc7c7',
@@ -169,7 +169,7 @@ exports.getAuthorId = async (token: string, user: object) => {
  * @param {String} token The token
  */
 exports.getAuthor4Token = async (token: string) => {
-  warnDeprecated(
+  padutils.warnDeprecated(
       'AuthorManager.getAuthor4Token() is deprecated; use AuthorManager.getAuthorId() instead');
   return await getAuthor4Token(token);
 };

src/node/db/GroupManager.ts

@@ -20,7 +20,7 @@
  */
 
 const CustomError = require('../utils/customError');
-const randomString = require('../../static/js/pad_utils').randomString;
+import {randomString} from "../../static/js/pad_utils";
 const db = require('./DB');
 const padManager = require('./PadManager');
 const sessionManager = require('./SessionManager');

src/node/db/Pad.ts

@@ -7,10 +7,10 @@ import {MapArrayType} from "../types/MapType";
  * The pad object, defined with joose
  */
 
-const AttributeMap = require('../../static/js/AttributeMap');
+import AttributeMap from '../../static/js/AttributeMap';
 const Changeset = require('../../static/js/Changeset');
-const ChatMessage = require('../../static/js/ChatMessage');
-const AttributePool = require('../../static/js/AttributePool');
+import ChatMessage from '../../static/js/ChatMessage';
+import AttributePool from '../../static/js/AttributePool';
 const Stream = require('../utils/Stream');
 const assert = require('assert').strict;
 const db = require('./DB');
@@ -23,7 +23,7 @@ const CustomError = require('../utils/customError');
 const readOnlyManager = require('./ReadOnlyManager');
 const randomString = require('../utils/randomstring');
 const hooks = require('../../static/js/pluginfw/hooks');
-const {padutils: {warnDeprecated}} = require('../../static/js/pad_utils');
+import pad_utils from "../../static/js/pad_utils";
 const promises = require('../utils/promises');
 
 /**
@@ -40,7 +40,7 @@ exports.cleanText = (txt:string): string => txt.replace(/\r\n/g, '\n')
 class Pad {
   private db: Database;
   private atext: AText;
-  private pool: APool;
+  private pool: AttributePool;
   private head: number;
     private chatHead: number;
     private publicStatus: boolean;
@@ -126,11 +126,11 @@ class Pad {
         pad: this,
         authorId,
         get author() {
-          warnDeprecated(`${hook} hook author context is deprecated; use authorId instead`);
+          pad_utils.warnDeprecated(`${hook} hook author context is deprecated; use authorId instead`);
           return this.authorId;
         },
         set author(authorId) {
-          warnDeprecated(`${hook} hook author context is deprecated; use authorId instead`);
+          pad_utils.warnDeprecated(`${hook} hook author context is deprecated; use authorId instead`);
           this.authorId = authorId;
         },
         ...this.head === 0 ? {} : {
@@ -330,7 +330,7 @@ class Pad {
    * @param {?number} [time] - Message timestamp (milliseconds since epoch). Deprecated; use
    *     `msgOrText.time` instead.
    */
-  async appendChatMessage(msgOrText: string|typeof ChatMessage, authorId = null, time = null) {
+  async appendChatMessage(msgOrText: string| ChatMessage, authorId = null, time = null) {
     const msg =
           msgOrText instanceof ChatMessage ? msgOrText : new ChatMessage(msgOrText, authorId, time);
     this.chatHead++;
@@ -437,11 +437,11 @@ class Pad {
     // let the plugins know the pad was copied
     await hooks.aCallAll('padCopy', {
       get originalPad() {
-        warnDeprecated('padCopy originalPad context property is deprecated; use srcPad instead');
+        pad_utils.warnDeprecated('padCopy originalPad context property is deprecated; use srcPad instead');
         return this.srcPad;
       },
       get destinationID() {
-        warnDeprecated(
+        pad_utils.warnDeprecated(
             'padCopy destinationID context property is deprecated; use dstPad.id instead');
         return this.dstPad.id;
       },
@@ -538,11 +538,11 @@ class Pad {
 
     await hooks.aCallAll('padCopy', {
       get originalPad() {
-        warnDeprecated('padCopy originalPad context property is deprecated; use srcPad instead');
+        pad_utils.warnDeprecated('padCopy originalPad context property is deprecated; use srcPad instead');
         return this.srcPad;
       },
       get destinationID() {
-        warnDeprecated(
+        pad_utils.warnDeprecated(
             'padCopy destinationID context property is deprecated; use dstPad.id instead');
         return this.dstPad.id;
       },
@@ -603,7 +603,7 @@ class Pad {
     p.push(padManager.removePad(padID));
     p.push(hooks.aCallAll('padRemove', {
       get padID() {
-        warnDeprecated('padRemove padID context property is deprecated; use pad.id instead');
+        pad_utils.warnDeprecated('padRemove padID context property is deprecated; use pad.id instead');
         return this.pad.id;
       },
       pad: this,

src/node/db/SecurityManager.ts

@@ -22,7 +22,7 @@
 import {UserSettingsObject} from "../types/UserSettingsObject";
 
 const authorManager = require('./AuthorManager');
-const hooks = require('../../static/js/pluginfw/hooks.js');
+const hooks = require('../../static/js/pluginfw/hooks');
 const padManager = require('./PadManager');
 const readOnlyManager = require('./ReadOnlyManager');
 const sessionManager = require('./SessionManager');
@@ -30,7 +30,7 @@ const settings = require('../utils/Settings');
 const webaccess = require('../hooks/express/webaccess');
 const log4js = require('log4js');
 const authLogger = log4js.getLogger('auth');
-const {padutils} = require('../../static/js/pad_utils');
+import padutils from '../../static/js/pad_utils'
 
 const DENY = Object.freeze({accessStatus: 'deny'});
 

src/node/eejs/index.ts

@@ -22,7 +22,7 @@
 
 const ejs = require('ejs');
 const fs = require('fs');
-const hooks = require('../../static/js/pluginfw/hooks.js');
+const hooks = require('../../static/js/pluginfw/hooks');
 const path = require('path');
 const resolve = require('resolve');
 const settings = require('../utils/Settings');

src/node/handler/ImportHandler.ts

@@ -31,7 +31,7 @@ import os from 'os';
 const importHtml = require('../utils/ImportHtml');
 const importEtherpad = require('../utils/ImportEtherpad');
 import log4js from 'log4js';
-const hooks = require('../../static/js/pluginfw/hooks.js');
+const hooks = require('../../static/js/pluginfw/hooks');
 
 const logger = log4js.getLogger('ImportHandler');
 

src/node/handler/PadMessageHandler.ts

@@ -21,28 +21,29 @@
 
 import {MapArrayType} from "../types/MapType";
 
-const AttributeMap = require('../../static/js/AttributeMap');
+import AttributeMap from '../../static/js/AttributeMap';
 const padManager = require('../db/PadManager');
 const Changeset = require('../../static/js/Changeset');
-const ChatMessage = require('../../static/js/ChatMessage');
-const AttributePool = require('../../static/js/AttributePool');
+import ChatMessage from '../../static/js/ChatMessage';
+import AttributePool from '../../static/js/AttributePool';
 const AttributeManager = require('../../static/js/AttributeManager');
 const authorManager = require('../db/AuthorManager');
-const {padutils} = require('../../static/js/pad_utils');
+import padutils from '../../static/js/pad_utils';
 const readOnlyManager = require('../db/ReadOnlyManager');
 const settings = require('../utils/Settings');
 const securityManager = require('../db/SecurityManager');
-const plugins = require('../../static/js/pluginfw/plugin_defs.js');
+const plugins = require('../../static/js/pluginfw/plugin_defs');
 import log4js from 'log4js';
 const messageLogger = log4js.getLogger('message');
 const accessLogger = log4js.getLogger('access');
-const hooks = require('../../static/js/pluginfw/hooks.js');
+const hooks = require('../../static/js/pluginfw/hooks');
 const stats = require('../stats')
 const assert = require('assert').strict;
 import {RateLimiterMemory} from 'rate-limiter-flexible';
 import {ChangesetRequest, PadUserInfo, SocketClientRequest} from "../types/SocketClientRequest";
 import {APool, AText, PadAuthor, PadType} from "../types/PadType";
 import {ChangeSet} from "../types/ChangeSet";
+import {ChatMessageMessage, ClientReadyMessage, ClientSaveRevisionMessage, ClientSuggestUserName, ClientUserChangesMessage, ClientVarMessage, CustomMessage, UserNewInfoMessage} from "../../static/js/types/SocketIOMessage";
 const webaccess = require('../hooks/express/webaccess');
 const { checkValidRev } = require('../utils/checkValidRev');
 
@@ -214,7 +215,7 @@ exports.handleDisconnect = async (socket:any) => {
  * @param socket the socket.io Socket object for the client
  * @param message the message from the client
  */
-exports.handleMessage = async (socket:any, message:typeof ChatMessage) => {
+exports.handleMessage = async (socket:any, message: ClientVarMessage) => {
   const env = process.env.NODE_ENV || 'development';
 
   if (env === 'production') {
@@ -348,15 +349,15 @@ exports.handleMessage = async (socket:any, message:typeof ChatMessage) => {
               stats.counter('pendingEdits').inc();
               await padChannels.enqueue(thisSession.padId, {socket, message});
               break;
-            case 'USERINFO_UPDATE': await handleUserInfoUpdate(socket, message); break;
-            case 'CHAT_MESSAGE': await handleChatMessage(socket, message); break;
+            case 'USERINFO_UPDATE': await handleUserInfoUpdate(socket, message as unknown as UserNewInfoMessage); break;
+            case 'CHAT_MESSAGE': await handleChatMessage(socket, message as unknown as ChatMessageMessage); break;
             case 'GET_CHAT_MESSAGES': await handleGetChatMessages(socket, message); break;
-            case 'SAVE_REVISION': await handleSaveRevisionMessage(socket, message); break;
+            case 'SAVE_REVISION': await handleSaveRevisionMessage(socket, message as unknown as ClientSaveRevisionMessage); break;
             case 'CLIENT_MESSAGE': {
               const {type} = message.data.payload;
               try {
                 switch (type) {
-                  case 'suggestUserName': handleSuggestUserName(socket, message); break;
+                  case 'suggestUserName': handleSuggestUserName(socket, message as unknown as ClientSuggestUserName); break;
                   default: throw new Error('unknown message type');
                 }
               } catch (err) {
@@ -384,7 +385,7 @@ exports.handleMessage = async (socket:any, message:typeof ChatMessage) => {
  * @param socket the socket.io Socket object for the client
  * @param message the message from the client
  */
-const handleSaveRevisionMessage = async (socket:any, message: string) => {
+const handleSaveRevisionMessage = async (socket:any, message: ClientSaveRevisionMessage) => {
   const {padId, author: authorId} = sessioninfos[socket.id];
   const pad = await padManager.getPad(padId, null, authorId);
   await pad.addSavedRevision(pad.head, authorId);
@@ -397,7 +398,7 @@ const handleSaveRevisionMessage = async (socket:any, message: string) => {
  * @param msg {Object} the message we're sending
  * @param sessionID {string} the socketIO session to which we're sending this message
  */
-exports.handleCustomObjectMessage = (msg: typeof ChatMessage, sessionID: string) => {
+exports.handleCustomObjectMessage = (msg: CustomMessage, sessionID: string) => {
   if (msg.data.type === 'CUSTOM') {
     if (sessionID) {
       // a sessionID is targeted: directly to this sessionID
@@ -432,7 +433,7 @@ exports.handleCustomMessage = (padID: string, msgString:string) => {
  * @param socket the socket.io Socket object for the client
  * @param message the message from the client
  */
-const handleChatMessage = async (socket:any, message: typeof ChatMessage) => {
+const handleChatMessage = async (socket:any, message: ChatMessageMessage) => {
   const chatMessage = ChatMessage.fromObject(message.data.message);
   const {padId, author: authorId} = sessioninfos[socket.id];
   // Don't trust the user-supplied values.
@@ -452,7 +453,7 @@ const handleChatMessage = async (socket:any, message: typeof ChatMessage) => {
  * @param {string} [padId] - The destination pad ID. Deprecated; pass a chat message
  *     object as the first argument and the destination pad ID as the second argument instead.
  */
-exports.sendChatMessageToPadClients = async (mt: typeof ChatMessage|number, puId: string, text:string|null = null, padId:string|null = null) => {
+exports.sendChatMessageToPadClients = async (mt: ChatMessage|number, puId: string, text:string|null = null, padId:string|null = null) => {
   const message = mt instanceof ChatMessage ? mt : new ChatMessage(text, puId, mt);
   padId = mt instanceof ChatMessage ? puId : padId;
   const pad = await padManager.getPad(padId, null, message.authorId);
@@ -499,7 +500,7 @@ const handleGetChatMessages = async (socket:any, {data: {start, end}}:any) => {
  * @param socket the socket.io Socket object for the client
  * @param message the message from the client
  */
-const handleSuggestUserName = (socket:any, message: typeof ChatMessage) => {
+const handleSuggestUserName = (socket:any, message: ClientSuggestUserName) => {
   const {newName, unnamedId} = message.data.payload;
   if (newName == null) throw new Error('missing newName');
   if (unnamedId == null) throw new Error('missing unnamedId');
@@ -519,7 +520,7 @@ const handleSuggestUserName = (socket:any, message: typeof ChatMessage) => {
  * @param socket the socket.io Socket object for the client
  * @param message the message from the client
  */
-const handleUserInfoUpdate = async (socket:any, {data: {userInfo: {name, colorId}}}: PadUserInfo) => {
+const handleUserInfoUpdate = async (socket:any, {data: {userInfo: {name, colorId}}}: UserNewInfoMessage) => {
   if (colorId == null) throw new Error('missing colorId');
   if (!name) name = null;
   const session = sessioninfos[socket.id];
@@ -567,7 +568,9 @@ const handleUserInfoUpdate = async (socket:any, {data: {userInfo: {name, colorId
  * @param socket the socket.io Socket object for the client
  * @param message the message from the client
  */
-const handleUserChanges = async (socket:any, message: typeof ChatMessage) => {
+const handleUserChanges = async (socket:any, message: {
+  data: ClientUserChangesMessage
+}) => {
   // This one's no longer pending, as we're gonna process it now
   stats.counter('pendingEdits').dec();
 
@@ -738,7 +741,7 @@ exports.updatePadClients = async (pad: PadType) => {
 /**
  * Copied from the Etherpad Source Code. Don't know what this method does excatly...
  */
-const _correctMarkersInPad = (atext: AText, apool: APool) => {
+const _correctMarkersInPad = (atext: AText, apool: AttributePool) => {
   const text = atext.text;
 
   // collect char positions of line markers (e.g. bullets) in new atext
@@ -785,7 +788,7 @@ const _correctMarkersInPad = (atext: AText, apool: APool) => {
  * @param socket the socket.io Socket object for the client
  * @param message the message from the client
  */
-const handleClientReady = async (socket:any, message: typeof ChatMessage) => {
+const handleClientReady = async (socket:any, message: ClientReadyMessage) => {
   const sessionInfo = sessioninfos[socket.id];
   if (sessionInfo == null) throw new Error('client disconnected');
   assert(sessionInfo.author);
@@ -793,8 +796,9 @@ const handleClientReady = async (socket:any, message: typeof ChatMessage) => {
   await hooks.aCallAll('clientReady', message); // Deprecated due to awkward context.
 
   let {colorId: authorColorId, name: authorName} = message.userInfo || {};
-  if (authorColorId && !/^#(?:[0-9A-F]{3}){1,2}$/i.test(authorColorId)) {
+  if (authorColorId && !/^#(?:[0-9A-F]{3}){1,2}$/i.test(authorColorId as string)) {
     messageLogger.warn(`Ignoring invalid colorId in CLIENT_READY message: ${authorColorId}`);
+    // @ts-ignore
     authorColorId = null;
   }
   await Promise.all([
@@ -872,7 +876,7 @@ const handleClientReady = async (socket:any, message: typeof ChatMessage) => {
     const revisionsNeeded = [];
     const changesets:MapArrayType<any> = {};
 
-    let startNum = message.client_rev + 1;
+    let startNum = message.client_rev! + 1;
     let endNum = pad.getHeadRevisionNumber() + 1;
 
     const headNum = pad.getHeadRevisionNumber();

src/node/hooks/i18n.ts

@@ -7,7 +7,7 @@ const languages = require('languages4translatewiki');
 const fs = require('fs');
 const path = require('path');
 const _ = require('underscore');
-const pluginDefs = require('../../static/js/pluginfw/plugin_defs.js');
+const pluginDefs = require('../../static/js/pluginfw/plugin_defs');
 const existsSync = require('../utils/path_exists');
 const settings = require('../utils/Settings');
 

src/node/utils/ExportHelper.ts

@@ -19,7 +19,8 @@
  * limitations under the License.
  */
 
-const AttributeMap = require('../../static/js/AttributeMap');
+import AttributeMap from '../../static/js/AttributeMap';
+import AttributePool from "../../static/js/AttributePool";
 const Changeset = require('../../static/js/Changeset');
 const { checkValidRev } = require('./checkValidRev');
 
@@ -51,7 +52,7 @@ type LineModel = {
   [id:string]:string|number|LineModel
 }
 
-exports._analyzeLine = (text:string, aline: LineModel, apool: Function) => {
+exports._analyzeLine = (text:string, aline: LineModel, apool: AttributePool) => {
   const line: LineModel = {};
 
   // identify list

src/node/utils/ExportHtml.ts

@@ -27,7 +27,7 @@ const hooks = require('../../static/js/pluginfw/hooks');
 const eejs = require('../eejs');
 const _analyzeLine = require('./ExportHelper')._analyzeLine;
 const _encodeWhitespace = require('./ExportHelper')._encodeWhitespace;
-const padutils = require('../../static/js/pad_utils').padutils;
+import padutils from "../../static/js/pad_utils";
 
 const getPadHTML = async (pad: PadType, revNum: string) => {
   let atext = pad.atext;

src/node/utils/ImportEtherpad.ts

@@ -18,7 +18,7 @@ import {APool} from "../types/PadType";
  * limitations under the License.
  */
 
-const AttributePool = require('../../static/js/AttributePool');
+import AttributePool from '../../static/js/AttributePool';
 const {Pad} = require('../db/Pad');
 const Stream = require('./Stream');
 const authorManager = require('../db/AuthorManager');
@@ -61,7 +61,7 @@ exports.setPadRaw = async (padId: string, r: string, authorId = '') => {
   try {
     const processRecord = async (key:string, value: null|{
       padIDs: string|Record<string, unknown>,
-      pool: APool
+      pool: AttributePool
     }) => {
       if (!value) return;
       const keyParts = key.split(':');

src/node/utils/padDiff.ts

@@ -3,7 +3,7 @@
 import {PadAuthor, PadType} from "../types/PadType";
 import {MapArrayType} from "../types/MapType";
 
-const AttributeMap = require('../../static/js/AttributeMap');
+import AttributeMap from '../../static/js/AttributeMap';
 const Changeset = require('../../static/js/Changeset');
 const attributes = require('../../static/js/attributes');
 const exportHtml = require('./ExportHtml');