ozon-grabber 0.1.5 → 1.0.0

package/README.md

@@ -1,140 +1,54 @@
-# Ozon Orders History CLI
+# ozon-grabber
 
-A CLI utility that exports Ozon order history from a browser session where the user is already logged in.
+CLI that scans your Ozon orders/returns via a real Chrome session and submits the parsed data to a SQLite-backed service.
 
-The tool opens order pages by template:
-`https://www.ozon.ru/my/orderdetails/?order=<userId>-<orderNumber>&selectedTab=archive`
-and iterates order numbers in ascending order until it hits a missing or in-progress order.
+The CLI launches Chrome through [chrome-devtools-mcp](https://www.npmjs.com/package/chrome-devtools-mcp), navigates the order/return pages it has access to, dumps each page's HTML, parses it locally with `jsdom`, and POSTs the result to a configurable backend (the companion service in [ozon-orders-history_v2/backend](https://github.com/isachivka/ozon-orders-history_v2/tree/main/backend)).
 
-## Installation & Run
+## Quick start
 
-### Using npx (recommended)
-
-You can run the tool without local installation:
 ```bash
-npx ozon-grabber start --user-id <userId> --start-order 0001
-```
-
-### Local installation
+# 1. log in once — Chrome opens, log in to Ozon, press Ctrl+C
+npx ozon-grabber login
 
-```bash
-cd cli
-npm install
-npm run build
-node dist/index.js start --user-id <userId> --start-order 0001
-```
-
-## Requirements
-
-- Node.js 20+
-- Chrome/Chromium running with the remote debugging port `9222` enabled
-- The user is already authenticated in Ozon in that browser
-
-Example Chrome launch (macOS):
-```bash
-/Applications/Google\ Chrome\ Beta.app/Contents/MacOS/Google\ Chrome\ Beta \
-  --remote-debugging-port=9222 --user-data-dir=/tmp/chrome-beta-mcp
+# 2. scan orders. user-id and backend-url are picked up from env;
+#    --start-order is fetched from the backend (auto-resume).
+npx ozon-grabber start --verbose
 
+# 3. scan returns
+npx ozon-grabber start --returns --verbose
 ```
 
-## Publication to npm
+## Configuration
 
-1.  **Login to npm** (if not already):
-    ```bash
-    npm login
-    ```
-2.  **Verify build**:
-    ```bash
-    npm run build
-    ```
-3.  **Publish**:
-    ```bash
-    npm publish --access public
-    ```
-
-## Run examples
+Set these once in your shell profile (e.g. `~/.zshrc`):
 
 ```bash
-# Start from order 0001
-npx ozon-grabber start --user-id 30588125 --start-order 0001
+export OZON_USER_ID=12345678
+export OZON_BACKEND_URL=http://localhost:3000           # or your remote service
 ```
 
-Or with a limited number of orders:
-```bash
-npx ozon-grabber start --user-id 30588125 --start-order 0001 --max-orders 5
-```
+Both can also be passed as flags (`--user-id`, `--backend-url`) — flags override env.
 
-Enable backend upload and start from the backend-provided order id:
-```bash
-npx ozon-grabber start --user-id 30588125 --backend
-```
-When backend upload is enabled, each order is submitted immediately after parsing (fail-fast on upload errors).
-
-Fetch the next order id from the backend:
-```bash
-npx ozon-grabber backend-next
-```
-This command uses the backend configuration options listed below.
-
-## Parameters
-
-Required:
-- `--user-id <string>`: user identifier (e.g., `30588125`)
-Optional:
-- `--start-order <string>`: starting order number (e.g., `0001`); required when backend is disabled
-- `--backend`: enable backend upload and backend-based start order resolution
-
-Options:
-- `--verbose`: verbose navigation and parsing logs
-- `--max-orders <n>`: limit the number of orders to scan (debugging)
-- `--page-load-timeout-ms <ms>`: how long to wait for order page widgets before declaring a missing order (default: `20000`)
-- `--output <path>`: output file path; if the extension is `.csv`, CSV is used, otherwise JSON
-- `--backend-url <url>`: backend base URL (env: `BACKEND_URL`, default: `http://localhost:3015`)
-- `--backend-api-key <token>`: backend API key (env: `BACKEND_API_KEY`, default: `local-dev`)
-
-## Output format (JSON)
-
-```json
-{
-  "userId": "30588125",
-  "startOrder": "0001",
-  "scannedOrders": 3,
-  "stopReason": "in-progress",
-  "stopOrderNumber": "0004",
-  "orders": [
-    {
-      "orderId": "30588125-0001",
-      "orderNumber": "0001",
-      "orderDate": "2026-01-09",
-      "items": [
-        {
-          "title": "...",
-          "price": "...",
-          "imageUrl": "..."
-        }
-      ]
-    }
-  ]
-}
-```
+## Flags
 
-`stopReason` can be:
-- `in-progress` - shipment widget text indicates the order is still in progress
-- `missing` - neither the shipment widget nor the order title appeared after the load wait
-- `max-orders` - `--max-orders` limit reached
+| Flag | Default | Purpose |
+|---|---|---|
+| `--user-id` | `$OZON_USER_ID` | Ozon account id (required if env unset) |
+| `--start-order` | from `GET /scan-state/<user-id>` | Where to begin. Omit to resume |
+| `--max-orders` | unlimited | Cap how many to scan in this run |
+| `--returns` | `false` | Scan returns (`/my/returnDetails`) instead of orders |
+| `--output <path>` | stdout | Where to write the JSON summary |
+| `--backend-url` | `$OZON_BACKEND_URL` or `http://localhost:3000` | Submit URL |
+| `--backend` / `--no-backend` | `true` | Submit POST per parsed result (or skip with `--no-backend`) |
+| `--user-data-dir` | `./chrome-profile` | Chrome profile directory (cookies + login persisted here) |
+| `--verbose` | `false` | Per-order log lines |
 
-## How it works
+## Notes
 
-- Connects to an already-open browser via `chrome-devtools-mcp`.
-- Reuses a single tab and navigates to each order URL.
-- Parses items inside `data-widget="shipmentWidget"`.
-- Reads the order header from `data-widget="titleWithTimer"` and parses `orderDate` in `YYYY-MM-DD` (UTC).
-- Waits for `shipmentWidget` or `titleWithTimer` before declaring a missing order (logs show wait duration in verbose mode).
-- Stops at the first in-progress or missing order.
-- When backend upload is enabled, submits items per order using `orderNumber` as the backend `orderId` plus the `userId` field.
-- The backend also downloads each item's `imageUrl`, stores it under `backend/photos/`, and replaces the stored value with that relative path; use `POST /photos/download` to refresh older rows that still reference remote URLs.
+- The Chrome profile (`chrome-profile/` by default) carries your Ozon cookies. Don't share it.
+- First navigation can hit the Ozon anti-bot challenge — the CLI auto-retries `Navigation timeout` up to three times.
+- `--no-backend` outputs JSON to `--output` (or stdout) and skips submission. Useful for offline parsing.
 
-## Common issues
+## License
 
-- No data / empty results: make sure you're logged in to Ozon in the same browser.
-- DevTools connection error: ensure Chrome is started with `--remote-debugging-port=9222`.
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }