🧬 TamperCell

Modern TypeScript libraries for enhanced Tampermonkey development

TamperCell is a collection of powerful, type-safe libraries designed specifically for Tampermonkey userscripts. Built with TypeScript and modern web standards, it provides essential utilities for web automation, debugging, and Next.js application monitoring.

📦 Available Libraries

Library	Description	Documentation
🔍 Next Observer	Smart Next.js application state detection with comprehensive readiness checks and route change monitoring	📖 Docs
🖥️ Custom Console	Advanced console viewer with object inspection, filtering, and JavaScript execution	📖 Docs

🚀 Quick Start

CDN Usage (Recommended)

All libraries are available via CDN for easy integration with Tampermonkey:

// ==UserScript==
// @name         My Enhanced Script
// @version      1.0.0
// @match        https://example.com/*
// @require      https://cdn.jsdelivr.net/gh/ruriazz/tampercell@latest/dist/next-observer/main.min.js
// @require      https://cdn.jsdelivr.net/gh/ruriazz/tampercell@latest/dist/custom-console/main.min.js
// @grant        none
// ==/UserScript==

Basic Example

(function () {
  'use strict';

  const style = document.createElement('link');
  style.rel = 'stylesheet';
  style.href = 'https://cdn.jsdelivr.net/gh/ruriazz/tampercell@latest/dist/custom-console/main.min.css';

  // Initialize libraries with route change detection
  style.onload = window.CustomConsole;
  window.NextObserver({
      routeChangeDetection: true,
      debug: true
  });

  document.head.appendChild(style);

  // Listen for Next.js ready event
  window.addEventListener('nextjs:ready', () => {
      console.log('🚀 Next.js is ready!');
      // Your initialization code here...
  });

  // Listen for route changes
  window.addEventListener('nextjs:route:before-change', (event) => {
      console.log('🔄 Route changing:', event.detail.from, '→', event.detail.to);
  });

  window.addEventListener('nextjs:route:after-load', (event) => {
      console.log('✅ Route loaded:', event.detail.route);
  });
})();

Documentation

For comprehensive documentation and guides, please refer to:

• Next Observer Documentation - Smart Next.js application detection
  • Route Change Detection Guide - Monitor client-side navigation
• Custom Console Documentation - Advanced debugging console
• API Reference - Complete TypeScript type definitions
• Examples & Tutorials - Real-world usage examples and best practices

🛠️ Development

Prerequisites

• Node.js 16+
• npm or yarn

Setup

git clone https://github.com/ruriazz/tampercell.git
cd tampercell
npm install

Build

npm run build

Project Structure

tampercell/
├── src/                  # Source code
│   ├── custom-console/   # Custom Console library
│   └── next-observer/    # Next Observer library
├── types/                # TypeScript type definitions
├── docs/                 # Documentation
├── dist/                 # Built files
└── README.md            # This file

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please read CONTRIBUTING.md for detailed guidelines on contributing to this project.

🔒 Security

Security is important to us. If you discover a security vulnerability, please see our Security Policy for responsible disclosure guidelines.

📋 Changelog

See CHANGELOG.md for a detailed history of changes and new features.

💬 Support

• Documentation: Check the docs/ folder for comprehensive guides
• Issues: Report bugs or request features via GitHub Issues
• Discussions: Ask questions in GitHub Discussions
• Examples: Find usage patterns in examples documentation

🌟 Show Your Support

If TamperCell helps you in your projects, please consider:

• ⭐ Starring this repository
• 🐛 Reporting bugs or suggesting features
• 📖 Contributing to documentation
• 💻 Contributing code improvements
• 💰 Sponsoring the project

📊 Project Stats

📜 License

This project is licensed under the ISC License - see the LICENSE file for details.

🙏 Acknowledgments

• Built with TypeScript for type safety and better developer experience
• Bundled with Rollup for optimal output and multiple format support
• Designed specifically for Tampermonkey userscript ecosystem
• Inspired by the need for better debugging and monitoring tools in web automation

---

_{Built with ❤️ for the Tampermonkey community}