open-vtop 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ashman Singh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# Open-VTOP
+
+An open-source VTOP client with automatic session management.
+
+## Features
+
+- 🚀 **Automatic Session Initialization**: VTOP session cookies and CSRF tokens are automatically established when the server starts
+- 🔄 **Background Processing**: Session setup happens in the background, no need to hit any endpoints first
+- 📊 **Session Monitoring**: Check session status in real-time via the web interface
+
+## Getting Started
+
+### Installation
+
+```bash
+npm install
+```
+
+### Development
+
+```bash
+npm run dev
+```
+
+Then open http://localhost:3000
+
+### Production
+
+```bash
+npm run build
+npm start
+```
+
+## How It Works
+
+When the server starts, it automatically:
+
+1. **Establishes cookies** - Gets `SERVERID` and `JSESSIONID` cookies from VTOP
+2. **Retrieves CSRF token** - Extracts the `_csrf` token from `/vtop/openPage`
+3. **Completes prelogin setup** - POSTs to `/vtop/prelogin/setup` with flag=VTOP
+4. **Maintains session state** - Stores cookies and tokens for subsequent requests
+
+All of this happens in the background using Node.js's native fetch API.
+
+## API Endpoints
+
+- `GET /api/session/status` - View current session status (cookies, CSRF, etc.)
+- `POST /api/session/refresh` - Manually refresh the VTOP session
+
+## Session Manager
+
+The session manager (`src/session-manager.ts`) is a singleton that:
+- Initializes automatically on server startup
+- Stores cookies and CSRF tokens
+- Can be imported and used by other modules
+- Supports manual refresh when needed
+
+```typescript
+import { sessionManager } from "./session-manager.js";
+
+// Check if initialized
+const isReady = sessionManager.isInitialized();
+
+// Get CSRF token
+const csrf = sessionManager.getCsrf();
+
+// Get cookies as header string
+const cookies = sessionManager.getCookies();
+
+// Manually refresh
+await sessionManager.refresh();
+```