Merge branch 'develop' into Gsoc'24-duplixx-Event-Attendance

.coderabbit.yaml

@@ -13,5 +13,6 @@ reviews:
     drafts: false
     base_branches:
       - develop
+      - main
 chat:
-  auto_reply: true
+  auto_reply: true

.eslintrc.json

@@ -60,7 +60,9 @@
     "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
     "@typescript-eslint/no-non-null-assertion": "error",
     "@typescript-eslint/no-var-requires": "error",
-    "@typescript-eslint/ban-types": "error",
+    "@typescript-eslint/no-unsafe-function-type": "error",
+    "@typescript-eslint/no-wrapper-object-types": "error",
+    "@typescript-eslint/no-empty-object-type": "error",
     "@typescript-eslint/no-duplicate-enum-values": "error",
     "@typescript-eslint/array-type": "error",
     "@typescript-eslint/consistent-type-assertions": "error",

.github/ISSUE_TEMPLATE/bug-report.md

@@ -31,4 +31,6 @@ If applicable, add screenshots to help explain your problem.
 Add any other context or screenshots about the feature request here.
 
 **Potential internship candidates**
-Please read this if you are planning to apply for a Palisadoes Foundation internship https://github.com/PalisadoesFoundation/talawa/issues/359
+
+Please read this if you are planning to apply for a Palisadoes Foundation internship 
+- https://github.com/PalisadoesFoundation/talawa/issues/359

.github/ISSUE_TEMPLATE/feature-request.md

@@ -23,4 +23,6 @@ A clear and concise description of approach to be followed.
 Add any other context or screenshots about the feature request here.
 
 **Potential internship candidates**
-Please read this if you are planning to apply for a Palisadoes Foundation internship https://github.com/PalisadoesFoundation/talawa/issues/359
+
+Please read this if you are planning to apply for a Palisadoes Foundation internship 
+- https://github.com/PalisadoesFoundation/talawa/issues/359

.github/dependabot.yaml

@@ -7,12 +7,12 @@ updates:
     directory: "/"
     # Schedule automated updates to run weekly
     schedule:
-      interval: "weekly"
+      interval: "monthly"
     # Labels to apply to Dependabot PRs
     labels:
       - "dependencies"
     # Specify the target branch for PRs
     target-branch: "develop"
     # Customize commit message prefix
     commit-message:
-      prefix: "chore(deps):"
+      prefix: "chore(deps):"

.github/workflows/check-tsdoc.js

@@ -0,0 +1,68 @@
+import fs from 'fs/promises'; // Import fs.promises for async operations
+import path from 'path';
+
+// List of files to skip
+const filesToSkip = [
+    'index.tsx', 
+    'EventActionItems.tsx',
+    'OrgPostCard.tsx',
+    'UsersTableItem.tsx',
+    'FundCampaignPledge.tsx'
+];
+
+// Recursively find all .tsx files, excluding files listed in filesToSkip
+async function findTsxFiles(dir) {
+  let results = [];
+  try {
+    const list = await fs.readdir(dir);
+    for (const file of list) {
+      const filePath = path.join(dir, file);
+      const stat = await fs.stat(filePath);
+      if (stat.isDirectory()) {
+        results = results.concat(await findTsxFiles(filePath));
+      } else if (
+        filePath.endsWith('.tsx') &&
+        !filePath.endsWith('.test.tsx') &&
+        !filesToSkip.includes(path.relative(dir, filePath))
+      ) {
+        results.push(filePath);
+      }
+    }
+  } catch (err) {
+    console.error(`Error reading directory ${dir}: ${err.message}`);
+  }
+  return results;
+}
+
+// Check if a file contains at least one TSDoc comment
+async function containsTsDocComment(filePath) {
+  try {
+    const content = await fs.readFile(filePath, 'utf8');
+    return /\/\*\*[\s\S]*?\*\//.test(content);
+  } catch (err) {
+    console.error(`Error reading file ${filePath}: ${err.message}`);
+    return false;
+  }
+}
+
+// Main function to run the validation
+async function run() {
+  const dir = process.argv[2] || './src'; // Allow directory path as a command-line argument
+  const files = await findTsxFiles(dir);
+  const filesWithoutTsDoc = [];
+
+  for (const file of files) {
+    if (!await containsTsDocComment(file)) {
+      filesWithoutTsDoc.push(file);
+    }
+  }
+
+  if (filesWithoutTsDoc.length > 0) {
+    filesWithoutTsDoc.forEach(file => {
+      console.error(`No TSDoc comment found in file: ${file}`);
+    });
+    process.exit(1);
+  }
+}
+
+run();

.github/workflows/codeql-codescan.yml

@@ -20,7 +20,8 @@ on:
       - '**'   
 jobs:
   CodeQL:
-    name: Analyse code with codeQL on push
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    name: Analyse Code With CodeQL
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false

.github/workflows/compare_translations.py

@@ -88,6 +88,31 @@ def compare_translations(default_translation,
             errors.append(error_msg)
     return errors
 
+def flatten_json(nested_json, parent_key=""):
+    """
+    Flattens a nested JSON, concatenating keys to represent the hierarchy.
+
+    Args:
+        nested_json (dict): The JSON object to flatten.
+        parent_key (str): The base key for recursion (used to track key hierarchy).
+
+    Returns:
+        dict: A flattened dictionary with concatenated keys.
+    """
+    flat_dict = {}
+
+    for key, value in nested_json.items():
+        # Create the new key by concatenating parent and current key
+        new_key = f"{parent_key}.{key}" if parent_key else key
+
+        if isinstance(value, dict):
+            # Recursively flatten the nested dictionary
+            flat_dict.update(flatten_json(value, new_key))
+        else:
+            # Assign the value to the flattened key
+            flat_dict[new_key] = value
+
+    return flat_dict
 
 def load_translation(filepath):
     """Load translation from a file.
@@ -104,7 +129,8 @@ def load_translation(filepath):
             if not content.strip():
                 raise ValueError(f"File {filepath} is empty.")
             translation = json.loads(content)
-        return translation
+            flattened_translation = flatten_json(translation)
+        return flattened_translation
     except json.JSONDecodeError as e:
         raise ValueError(f"Error decoding JSON from file {filepath}: {e}")
 
@@ -170,7 +196,7 @@ def main():
         "--directory",
         type=str,
         nargs="?",
-        default=os.path.join(os.getcwd(), "locales"),
+        default=os.path.join(os.getcwd(), "public/locales"),
         help="Directory containing translation files(relative to the root directory).",
     )
     args = parser.parse_args()

.github/workflows/eslint_disable_check.py

@@ -36,9 +36,15 @@ def has_eslint_disable(file_path):
     Returns:
         bool: True if eslint-disable statement is found, False otherwise.
     """
-    with open(file_path, 'r') as file:
-        content = file.read()
-        return re.search(r'//\s*eslint-disable', content)
+    eslint_disable_pattern = re.compile(r'//\s*eslint-disable(?:-next-line|-line)?', re.IGNORECASE)
+
+    try:
+        with open(file_path, 'r', encoding='utf-8') as file:
+            content = file.read()
+            return bool(eslint_disable_pattern.search(content))
+    except Exception as e:
+        print(f"Error reading file {file_path}: {e}")
+        return False
 
 def check_eslint(directory):
     """
@@ -72,7 +78,6 @@ def arg_parser_resolver():
 
     Returns:
         result: Parsed argument object
-
     """
     parser = argparse.ArgumentParser()
     parser.add_argument(
@@ -98,7 +103,6 @@ def main():
     Raises:
         SystemExit: If an error occurs during execution.
     """
-
     args = arg_parser_resolver()
 
     if not os.path.exists(args.directory):

.github/workflows/pull-request.yml

@@ -30,15 +30,15 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '20.x'
+          node-version: '22.x'
 
       - name: Install Dependencies
         run: npm install
 
       - name: Count number of lines
         run: |
           chmod +x ./.github/workflows/countline.py
-          ./.github/workflows/countline.py --lines 600 --exclude_files src/screens/LoginPage/LoginPage.tsx src/GraphQl/Queries/Queries.ts src/screens/OrgList/OrgList.tsx src/GraphQl/Mutations/mutations.ts src/components/EventListCard/EventListCardModals.tsx
+          ./.github/workflows/countline.py --lines 600 --exclude_files src/screens/LoginPage/LoginPage.tsx src/GraphQl/Queries/Queries.ts src/screens/OrgList/OrgList.tsx src/GraphQl/Mutations/mutations.ts src/components/EventListCard/EventListCardModals.tsx src/screens/ManageTag/ManageTag.tsx
 
       - name: Get changed TypeScript files
         id: changed-files
@@ -56,8 +56,11 @@ jobs:
         if: steps.changed-files.outputs.only_changed != 'true'
         env: 
           CHANGED_FILES: ${{ steps.changed_files.outputs.all_changed_files }}
-        run: npx eslint ${CHANGED_FILES} 
+        run: npx eslint ${CHANGED_FILES} && python .github/workflows/eslint_disable_check.py
 
+      - name: Check for TSDoc comments
+        run: npm run check-tsdoc # Run the TSDoc check script
+
       - name: Check for localStorage Usage
         run: |
           chmod +x scripts/githooks/check-localstorage-usage.js
@@ -76,8 +79,9 @@ jobs:
           echo "Error: Source and Target Branches are the same. Please ensure they are different."
           exit 1
 
-  Check-Unauthorized-Changes:
-    name: Checks if no unauthorized files are changed
+  Check-Sensitive-Files:
+    if: ${{ github.actor != 'dependabot[bot]' }}
+    name: Checks if sensitive files have been changed without authorization
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
@@ -107,6 +111,14 @@ jobs:
             LICENSE
             setup.ts
             .coderabbit.yaml
+            CODE_OF_CONDUCT.md
+            CODE_STYLE.md
+            CONTRIBUTING.md
+            DOCUMENTATION.md
+            INSTALLATION.md
+            ISSUE_GUIDELINES.md
+            PR_GUIDELINES.md
+            README.md
             
       - name: List all changed unauthorized files
         if: steps.changed-unauth-files.outputs.any_changed == 'true' || steps.changed-unauth-files.outputs.any_deleted == 'true'
@@ -119,6 +131,7 @@ jobs:
           exit 1
 
   Count-Changed-Files:
+    if: ${{ github.actor != 'dependabot[bot]' }}
     name: Checks if number of files changed is acceptable
     runs-on: ubuntu-latest
     steps:
@@ -173,7 +186,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '20.x'
+          node-version: '22.x'
 
       - name: Install Dependencies
         run: npm install
@@ -209,6 +222,7 @@ jobs:
           min_coverage: 95.0
 
   Graphql-Inspector:
+    if: ${{ github.actor != 'dependabot[bot]' }}
     name: Runs Introspection on the GitHub talawa-api repo on the schema.graphql file
     runs-on: ubuntu-latest
     steps:
@@ -218,7 +232,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '20.x'
+          node-version: '22.x'
 
       - name: resolve dependency
         run: npm install -g @graphql-inspector/cli
@@ -236,6 +250,7 @@ jobs:
         run: graphql-inspector validate './src/GraphQl/**/*.ts' './talawa-api/schema.graphql'
 
   Check-Target-Branch:
+    if: ${{ github.actor != 'dependabot[bot]' }}
     name: Check Target Branch
     runs-on: ubuntu-latest
     steps: