peekaleet 1.0.1

package/CONTRIBUTIONS.MD

@@ -0,0 +1,67 @@
+#  Contributing to PeekALeet
+
+First off, thank you for considering contributing to **PeekALeet**!  
+Your time and effort help improve the project for everyone.
+
+This document outlines how to contribute effectively and maintain the quality and architecture of the project.
+
+---
+
+##  Project Philosophy
+
+PeekALeet is designed to:
+
+- Use a **single GraphQL request**
+- Remain lightweight
+- Avoid unnecessary dependencies
+- Stay backend-friendly
+- Keep public profile support only
+- Maintain performance efficiency
+
+Please respect this architecture when contributing.
+
+---
+
+#  How to Contribute
+
+## 1. Fork the Repository
+
+Click the **Fork** button at the top-right of the GitHub repository.
+
+---
+
+## 2️. Clone Your Fork
+
+```bash
+git clone https://github.com/your-username/PeekALeet.git
+cd PeekALeet
+```
+## 3. Create a feature branch
+```bash
+git checkout -b feature/your-feature-name
+```
+
+## 4. Commit Changes
+```bash
+git commit -m "Add: TypeScript support"
+```
+## 5. Raise a PR
+```bash
+git push origin feature/your-feature-name
+```
+
+# Architectural Rules
+
+These are important:
+
+❗ Do NOT convert to multiple GraphQL calls
+
+❗ Do NOT add scraping logic
+
+❗ Do NOT introduce authentication dependencies
+
+❗ Keep it public-profile only
+
+❗ Maintain single-request efficiency
+
+Performance is a **core** principle of this project.

package/README.MD

@@ -0,0 +1,62 @@
+#  PeekALeet
+
+> Lightweight Node.js utility for fetching public LeetCode user data using a single optimized GraphQL request.
+
+PeekALeet consolidates profile details, contest history, problem statistics, streak data, and recent submissions into **one efficient API call** — reducing latency and eliminating redundant network requests.
+
+---
+
+##  Why PeekALeet?
+
+Most implementations fetch LeetCode data using multiple HTTP calls.  
+PeekALeet uses **one consolidated GraphQL query** to retrieve everything at once.
+
+### Benefits
+
+-  Single request → lower latency
+-  Reduced network overhead
+-  Clean class-based architecture
+-  Easy backend integration
+-  Selective data loading
+-  No authentication required (public profiles only)
+
+---
+
+##  Installation
+
+```bash
+npm install peekaleet
+```
+## Basic Usage
+```javascript
+const PeekALeet = require("peekaleet");
+
+async function example() {
+  const user = new PeekALeet("leetcode_username");
+
+  await user.load({
+    totalCount: true,
+    topicwise: true,
+    recent: true,
+    contest: true,
+    streak: true
+  });
+
+  console.log("Profile:", user.profile);
+  console.log("Total Solved:", user.totalCount);
+  console.log("Streak:", user.streak);
+}
+
+example();
+```
+## Option Configurations
+```json
+await user.load({
+  totalCount: true,
+  topicwise: true,
+  recent: false,
+  contest: true,
+  streak: true
+});
+```
+---

package/index.js

@@ -0,0 +1,125 @@
+const axios = require("axios");
+
+class PeekALeet {
+  constructor(username) {
+    this.username = username;
+
+    this.profile = null;
+    this.totalCount = null;
+    this.topicwise = null;
+    this.recent = null;
+    this.streak = null;
+    this.contest = null;
+
+    this.endpoint = "https://leetcode.com/graphql/";
+  }
+
+  async load(options = {}) {
+    const query = `
+      query fullUserData($username: String!, $limit: Int!) {
+
+        matchedUser(username: $username) {
+          username
+          githubUrl
+          twitterUrl
+          linkedinUrl
+
+          profile {
+            ranking
+            userAvatar
+            realName
+            aboutMe
+            school
+            countryName
+            company
+            jobTitle
+            reputation
+          }
+
+          userCalendar {
+            streak
+          }
+
+          tagProblemCounts {
+            advanced { tagName problemsSolved }
+            intermediate { tagName problemsSolved }
+            fundamental { tagName problemsSolved }
+          }
+
+          languageProblemCount {
+            problemsSolved
+          }
+        }
+
+        recentAcSubmissionList(username: $username, limit: $limit) {
+          id
+          title
+          titleSlug
+          timestamp
+        }
+
+        userContestRankingHistory(username: $username) {
+          ranking
+          rating
+          contest {
+            title
+            startTime
+          }
+        }
+      }
+    `;
+
+    const res = await axios.post(
+      this.endpoint,
+      {
+        query,
+        variables: {
+          username: this.username,
+          limit: 15
+        }
+      },
+      {
+        headers: { "Content-Type": "application/json" }
+      }
+    );
+
+    const data = res.data.data;
+
+    if (!data || !data.matchedUser) {
+      throw new Error("User not found");
+    }
+
+    const user = data.matchedUser;
+
+    this.profile = user;
+
+    if (options.streak) {
+      this.streak = user.userCalendar?.streak || 0;
+    }
+
+    if (options.topicwise) {
+      this.topicwise = user.tagProblemCounts;
+    }
+
+    if (options.totalCount) {
+      this.totalCount = user.languageProblemCount.reduce(
+        (sum, lang) => sum + lang.problemsSolved,
+        0
+      );
+    }
+
+    if (options.recent) {
+      this.recent = data.recentAcSubmissionList;
+    }
+
+    if (options.contest) {
+      this.contest = data.userContestRankingHistory.map(item => ({
+        title: item.contest.title,
+        ranking: item.ranking,
+        rating: item.rating
+      }));
+    }
+  }
+}
+
+module.exports = PeekALeet;

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "peekaleet",
+  "version": "1.0.1",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ajdeevs/peekaleet.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/ajdeevs/peekaleet/issues"
+  },
+  "homepage": "https://github.com/ajdeevs/peekaleet#readme",
+  "dependencies": {
+    "axios": "^1.13.4"
+  }
+}