start working on telegram integration

.gitignore

@@ -1,3 +1,6 @@
 node_modules
 .env
-build
+# The build folder stores the compiled files and will not be pushed to the repository
+build
+# The storage folder stores log-in credentials and should not be pushed to the repository
+storage 

package.json

@@ -2,10 +2,24 @@
   "name": "flerekommunik",
   "version": "1.0.0",
   "description": "FlereKommunik is a project that aims to remove the need to install an app for each communication service you use. It does this by providing a simple, easy to use interface that allows you to access all of your accounts in one, simple place.",
-  "main": "index.js",
+  "main": "./build/index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "run": "node .",
+    "build-run": "tsc && node ."
   },
-  "author": "",
+  "author": "StellaraUmbrix",
-  "license": "ISC"
+  "license": "DBAJ",
+  "dependencies": {
+    "@nodegui/nodegui": "^0.70.0",
+    "dotenv": "^16.4.6",
+    "jsonc": "^2.0.0",
+    "tdl": "^8.0.1",
+    "telegram": "^2.26.8",
+    "typescript": "^5.7.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.1"
+  }
 }

src/telegram/telegram.ts

@@ -0,0 +1,110 @@
+import * as tdl from 'tdl';
+import dotenv from 'dotenv';
+import { jsonc } from 'jsonc';
+import fs from 'fs';
+import { getTdjson } from 'prebuilt-tdlib';
+tdl.configure({ tdjson: getTdjson() });
+
+/** Creates a Client instance to use to communicate with the Telegram API. 
+ * @param appid The app id of the Telegram app.
+ * @param apphash The app hash of the Telegram app.
+ * @returns A tuple containing a boolean and the client instance if successful, or a boolean and an error message if unsuccessful.
+*/
+function _createClient(appid? : number, apphash? : string) {
+    // Check if the app(id/hash) are either in the dotenv, the jsonc file or the arguments
+    if (!appid || !apphash) {
+        dotenv.config();
+        const jsoncFile = jsonc.parse(fs.readFileSync('config.jsonc', 'utf-8'));
+        appid = appid || process.env.APP_ID || jsoncFile.APP_ID;
+        apphash = apphash || process.env.APP_HASH || jsoncFile.APP_HASH;
+    }
+    // If the app(id/hash) are not found, throw an error
+    if (!appid || !apphash) {
+        return [false, 'AppHashOrIDNotFound'];
+    }
+    // Create the client
+    const client = tdl.createClient({
+        apiId: appid,
+        apiHash: apphash,
+        tdlibParameters: {
+            // TODO: Change parameters to allow secret chats and device info.
+            // at the moment, trying to pass anything throws an error.
+        }
+        
+    }).on('error', (err) => { // Just in case an invalid app(id/hash) is provided or Telegram's servers are on fire
+        return [false, err];
+    });
+    return [true, client];
+}
+
+/**
+ * Logs in to the Telegram API.
+ * @returns A tuple containing a boolean and the client instance if successful, or a boolean and an error message if unsuccessful.
+ */
+module.exports._login = async function () {
+    const [success, client] = _createClient();
+    if (!success || typeof client !== 'object') {
+        return [false, client];
+    }
+    await client.login(); // Temp: Prompt the terminal for the phone number and the code
+    const me = await client.invoke({_: 'getMe' });
+    console.log('Logged in as ', me);
+    return [true, client];
+};
+
+/**
+ * Logs out of the Telegram API. This also closes the client instance.
+ * @param client The client instance to log out of.
+ * @returns A boolean indicating whether the logout was successful, or an error message if unsuccessful.
+ */
+module.exports._destroy = async function (client : tdl.Client) {
+    try {
+        await client.close();
+        return true;
+    } catch (err) {
+        return err;
+    }
+};
+
+// Helper functions
+
+/** Returns the logged in user's information.
+ * @param client The client instance to get the information from.
+ * @returns An object containing the user's information, or an error message if unsuccessful.
+*/
+module.exports.getMe = async function (client : tdl.Client) {
+    try {
+        const me = await client.invoke({_: 'getMe' });
+        return me;
+    } catch (err) {
+        return err;
+    }
+};
+
+/** Returns the user's information based on the user id.
+ * @param client The client instance to get the information from.
+ * @param userId The id of the user to get the information of.
+ * @returns An object containing the user's information, or an error message if unsuccessful.
+*/
+module.exports.getUser = async function (client : tdl.Client, userId : number) {
+    try {
+        const user = await client.invoke({_: 'getUser', user_id:userId });
+        return user;
+    } catch (err) {
+        return err;
+    }
+};
+
+/** Returns the chat's information based on the chat id.
+ * @param client The client instance to get the information from.
+ * @param chatId The id of the chat to get the information of.
+ * @returns An object containing the chat's information, or an error message if unsuccessful.
+*/
+module.exports.getChat = async function (client : tdl.Client, chatId : number) {
+    try {
+        const chat = await client.invoke({_: 'getChat', chat_id:chatId });
+        return chat;
+    } catch (err) {
+        return err;
+    }
+};

src/types.ts

@@ -0,0 +1,4 @@
+interface Message {
+    platform: string;
+    
+}

tsconfig.json

@@ -0,0 +1,110 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "rootDir": "./src/",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* 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. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    //"outFile": "./index.js",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./build",                                   /* Specify an output folder for all emitted files. */
+    "removeComments": true,                           /* Disable emitting comments. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}