Merge pull request #74 from ScrapeGraphAI/remove-js

Refactor documentation and remove JavaScript SDK

Author: VinciGit00

.agent/README.md

@@ -1,17 +1,16 @@
 # ScrapeGraphAI SDK Documentation
 
-Welcome to the ScrapeGraphAI SDK documentation hub. This directory contains comprehensive documentation for understanding, developing, and maintaining the official Python and JavaScript SDKs for the ScrapeGraph AI API.
+Welcome to the ScrapeGraphAI SDK documentation hub. This directory contains comprehensive documentation for understanding, developing, and maintaining the official Python SDK for the ScrapeGraph AI API.
 
 ## 📚 Available Documentation
 
 ### System Documentation (`system/`)
 
 #### [Project Architecture](./system/project_architecture.md)
 Complete SDK architecture documentation including:
-- **Monorepo Structure** - How Python and JavaScript SDKs are organized
+- **Repository Structure** - How the Python SDK is organized
 - **Python SDK Architecture** - Client structure, async/sync support, models
-- **JavaScript SDK Architecture** - Function-based API, async design
-- **API Endpoints Coverage** - All supported endpoints across SDKs
+- **API Endpoints Coverage** - All supported endpoints
 - **Authentication** - API key management and security
 - **Testing Strategy** - Unit tests, integration tests, CI/CD
 - **Release Process** - Semantic versioning and publishing
@@ -33,11 +32,9 @@ Complete SDK architecture documentation including:
 1. **Read First:**
    - [Main README](../README.md) - Project overview and features
    - [Python SDK README](../scrapegraph-py/README.md) - Python SDK guide
-   - [JavaScript SDK README](../scrapegraph-js/README.md) - JavaScript SDK guide
 
-2. **Choose Your SDK:**
+2. **Set Up Development Environment:**
 
-   **Python SDK:**
    ```bash
    cd scrapegraph-py
 
@@ -52,35 +49,16 @@ Complete SDK architecture documentation including:
    pre-commit install
    ```
 
-   **JavaScript SDK:**
-   ```bash
-   cd scrapegraph-js
-
-   # Install dependencies
-   npm install
-
-   # Run tests
-   npm test
-   ```
-
 3. **Run Tests:**
 
-   **Python:**
    ```bash
    cd scrapegraph-py
    pytest tests/ -v
    ```
 
-   **JavaScript:**
-   ```bash
-   cd scrapegraph-js
-   npm test
-   ```
-
 4. **Explore the Codebase:**
    - **Python**: `scrapegraph_py/client.py` - Sync client, `scrapegraph_py/async_client.py` - Async client
-   - **JavaScript**: `src/` directory - Individual endpoint modules
-   - **Examples**: `scrapegraph-py/examples/` and `scrapegraph-js/examples/`
+   - **Examples**: `scrapegraph-py/examples/`
 
 ---
 
@@ -90,26 +68,21 @@ Complete SDK architecture documentation including:
 
 **...how to add a new endpoint:**
 - Read: Python SDK - `scrapegraph_py/client.py`, `scrapegraph_py/async_client.py`
-- Read: JavaScript SDK - Create new file in `src/`
 - Examples: Look at existing endpoint implementations
 
 **...how authentication works:**
 - Read: Python SDK - `scrapegraph_py/client.py` (initialization)
-- Read: JavaScript SDK - Each function accepts `apiKey` parameter
-- Both SDKs support `SGAI_API_KEY` environment variable
+- The SDK supports `SGAI_API_KEY` environment variable
 
 **...how error handling works:**
 - Read: Python SDK - `scrapegraph_py/exceptions.py`
-- Read: JavaScript SDK - Try/catch blocks in each endpoint
 
 **...how testing works:**
 - Read: Python SDK - `tests/` directory, `pytest.ini`
-- Read: JavaScript SDK - `test/` directory
 - Run: Follow test commands in README
 
 **...how releases work:**
 - Read: Python SDK - `.releaserc.yml` (semantic-release config)
-- Read: JavaScript SDK - `.releaserc` (semantic-release config)
 - GitHub Actions: `.github/workflows/` for automated releases
 
 ---
@@ -118,7 +91,6 @@ Complete SDK architecture documentation including:
 
 ### Running Tests
 
-**Python SDK:**
 ```bash
 cd scrapegraph-py
 
@@ -132,20 +104,8 @@ pytest tests/test_smartscraper.py -v
 pytest --cov=scrapegraph_py --cov-report=html tests/
 ```
 
-**JavaScript SDK:**
-```bash
-cd scrapegraph-js
-
-# Run all tests
-npm test
-
-# Run specific test
-node test/test_smartscraper.js
-```
-
 ### Code Quality
 
-**Python SDK:**
 ```bash
 cd scrapegraph-py
 
@@ -166,20 +126,8 @@ make format
 make lint
 ```
 
-**JavaScript SDK:**
-```bash
-cd scrapegraph-js
-
-# Format code
-npm run format
-
-# Lint code
-npm run lint
-```
-
 ### Building & Publishing
 
-**Python SDK:**
 ```bash
 cd scrapegraph-py
 
@@ -190,35 +138,23 @@ python -m build
 twine upload dist/*
 ```
 
-**JavaScript SDK:**
-```bash
-cd scrapegraph-js
-
-# Build package (if needed)
-npm run build
-
-# Publish to npm (automated via GitHub Actions)
-npm publish
-```
-
 ---
 
 ## 📊 SDK Endpoint Reference
 
-Both SDKs support the following endpoints:
-
-| Endpoint | Python SDK | JavaScript SDK | Purpose |
-|----------|-----------|----------------|---------|
-| SmartScraper | ✅ | ✅ | AI-powered data extraction |
-| SearchScraper | ✅ | ✅ | Multi-website search extraction |
-| Markdownify | ✅ | ✅ | HTML to Markdown conversion |
-| Sitemap | ❌ | ✅ | Sitemap URL extraction |
-| SmartCrawler | ✅ | ✅ | Sitemap generation & crawling |
-| AgenticScraper | ✅ | ✅ | Browser automation |
-| Scrape | ✅ | ✅ | Basic HTML extraction |
-| Scheduled Jobs | ✅ | ✅ | Cron-based job scheduling |
-| Credits | ✅ | ✅ | Credit balance management |
-| Feedback | ✅ | ✅ | Rating and feedback |
+The SDK supports the following endpoints:
+
+| Endpoint | Python SDK | Purpose |
+|----------|-----------|---------|
+| SmartScraper | ✅ | AI-powered data extraction |
+| SearchScraper | ✅ | Multi-website search extraction |
+| Markdownify | ✅ | HTML to Markdown conversion |
+| SmartCrawler | ✅ | Sitemap generation & crawling |
+| AgenticScraper | ✅ | Browser automation |
+| Scrape | ✅ | Basic HTML extraction |
+| Scheduled Jobs | ✅ | Cron-based job scheduling |
+| Credits | ✅ | Credit balance management |
+| Feedback | ✅ | Rating and feedback |
 
 ---
 
@@ -251,31 +187,6 @@ Both SDKs support the following endpoints:
 - `Makefile` - Common development tasks
 - `.releaserc.yml` - Semantic-release configuration
 
-### JavaScript SDK
-
-**Entry Points:**
-- `index.js` - Main package entry
-- `src/` - Individual endpoint modules
-  - `smartScraper.js`
-  - `searchScraper.js`
-  - `crawl.js`
-  - `markdownify.js`
-  - `sitemap.js`
-  - `agenticScraper.js`
-  - `scrape.js`
-  - `scheduledJobs.js`
-  - `credits.js`
-  - `feedback.js`
-  - `schema.js`
-
-**Utilities:**
-- `src/utils/` - Helper functions
-
-**Configuration:**
-- `package.json` - Package metadata and scripts
-- `eslint.config.js` - ESLint configuration
-- `.prettierrc.json` - Prettier configuration
-
 ---
 
 ## 🧪 Testing
@@ -292,16 +203,6 @@ scrapegraph-py/tests/
 └── conftest.py                # Pytest fixtures
 ```
 
-### JavaScript SDK Test Structure
-
-```
-scrapegraph-js/test/
-├── test_smartscraper.js
-├── test_searchscraper.js
-├── test_crawl.js
-└── test_*.js
-```
-
 ### Writing Tests
 
 **Python Example:**
@@ -318,24 +219,6 @@ def test_smartscraper_basic():
     assert response.request_id is not None
 ```
 
-**JavaScript Example:**
-```javascript
-import { smartScraper } from 'scrapegraph-js';
-
-(async () => {
-  try {
-    const response = await smartScraper(
-      'test-key',
-      'https://example.com',
-      'Extract title'
-    );
-    console.log('Success:', response.result);
-  } catch (error) {
-    console.error('Error:', error);
-  }
-})();
-```
-
 ---
 
 ## 🚨 Troubleshooting
@@ -352,14 +235,6 @@ import { smartScraper } from 'scrapegraph-js';
   uv sync
   ```
 
-**Issue: Module not found in JavaScript SDK**
-- **Cause:** Dependencies not installed
-- **Solution:**
-  ```bash
-  cd scrapegraph-js
-  npm install
-  ```
-
 **Issue: API key errors**
 - **Cause:** Invalid or missing API key
 - **Solution:**
@@ -382,18 +257,14 @@ import { smartScraper } from 'scrapegraph-js';
 ### Official Docs
 - [ScrapeGraph AI API Documentation](https://docs.scrapegraphai.com)
 - [Python SDK Documentation](https://docs.scrapegraphai.com/sdks/python)
-- [JavaScript SDK Documentation](https://docs.scrapegraphai.com/sdks/javascript)
 
 ### Package Repositories
 - [PyPI - scrapegraph-py](https://pypi.org/project/scrapegraph-py/)
-- [npm - scrapegraph-js](https://www.npmjs.com/package/scrapegraph-js)
 
 ### Development Tools
 - [pytest Documentation](https://docs.pytest.org/)
 - [Pydantic Documentation](https://docs.pydantic.dev/)
 - [uv Documentation](https://docs.astral.sh/uv/)
-- [ESLint Documentation](https://eslint.org/docs/latest/)
-- [Prettier Documentation](https://prettier.io/docs/en/)
 
 ---
 
@@ -426,12 +297,6 @@ import { smartScraper } from 'scrapegraph-js';
 - **Type hints** - Use Pydantic models and type annotations
 - **Docstrings** - Document public functions and classes
 
-**JavaScript SDK:**
-- **Prettier** - Code formatting
-- **ESLint** - Linting
-- **JSDoc** - Function documentation
-- **Async/await** - Use promises for all async operations
-
 ### Commit Message Format
 
 Follow [Conventional Commits](https://www.conventionalcommits.org/):
@@ -479,7 +344,7 @@ This enables automated semantic versioning and changelog generation.
 
 ## 📅 Release Process
 
-Both SDKs use **semantic-release** for automated versioning and publishing:
+The SDK uses **semantic-release** for automated versioning and publishing:
 
 ### Release Workflow
 
@@ -488,10 +353,10 @@ Both SDKs use **semantic-release** for automated versioning and publishing:
 3. **Merge to main** - Pull request approved and merged
 4. **Automated release** - GitHub Actions:
    - Determines version bump (major/minor/patch)
-   - Updates version in `package.json` / `pyproject.toml`
+   - Updates version in `pyproject.toml`
    - Generates CHANGELOG.md
    - Creates GitHub release
-   - Publishes to npm / PyPI
+   - Publishes to PyPI
 
 ### Version Bumping Rules
 
@@ -505,7 +370,6 @@ Both SDKs use **semantic-release** for automated versioning and publishing:
 
 - [Main README](../README.md) - Project overview
 - [Python SDK README](../scrapegraph-py/README.md) - Python guide
-- [JavaScript SDK README](../scrapegraph-js/README.md) - JavaScript guide
 - [Cookbook](../cookbook/) - Usage examples
 - [API Documentation](https://docs.scrapegraphai.com) - Full API docs
 
@@ -515,7 +379,7 @@ Both SDKs use **semantic-release** for automated versioning and publishing:
 
 For questions or issues:
 1. Check this documentation first
-2. Review SDK-specific READMEs
+2. Review SDK-specific README
 3. Search existing GitHub issues
 4. Create a new issue with:
    - SDK version